cylinder.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USDGEOM_GENERATED_CYLINDER_H
25 #define USDGEOM_GENERATED_CYLINDER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
31 #include "pxr/usd/usdGeom/gprim.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdGeom/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // CYLINDER //
51 // -------------------------------------------------------------------------- //
52 
67 {
68 public:
73 
78  explicit UsdGeomCylinder(const UsdPrim& prim=UsdPrim())
79  : UsdGeomGprim(prim)
80  {
81  }
82 
86  explicit UsdGeomCylinder(const UsdSchemaBase& schemaObj)
87  : UsdGeomGprim(schemaObj)
88  {
89  }
90 
92  USDGEOM_API
93  virtual ~UsdGeomCylinder();
94 
98  USDGEOM_API
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
111  USDGEOM_API
112  static UsdGeomCylinder
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
137  USDGEOM_API
138  static UsdGeomCylinder
139  Define(const UsdStagePtr &stage, const SdfPath &path);
140 
141 protected:
145  USDGEOM_API
146  UsdSchemaKind _GetSchemaKind() const override;
147 
148 private:
149  // needs to invoke _GetStaticTfType.
150  friend class UsdSchemaRegistry;
151  USDGEOM_API
152  static const TfType &_GetStaticTfType();
153 
154  static bool _IsTypedSchema();
155 
156  // override SchemaBase virtuals.
157  USDGEOM_API
158  const TfType &_GetTfType() const override;
159 
160 public:
161  // --------------------------------------------------------------------- //
162  // HEIGHT
163  // --------------------------------------------------------------------- //
174  USDGEOM_API
175  UsdAttribute GetHeightAttr() const;
176 
182  USDGEOM_API
183  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
184 
185 public:
186  // --------------------------------------------------------------------- //
187  // RADIUS
188  // --------------------------------------------------------------------- //
199  USDGEOM_API
200  UsdAttribute GetRadiusAttr() const;
201 
207  USDGEOM_API
208  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209 
210 public:
211  // --------------------------------------------------------------------- //
212  // AXIS
213  // --------------------------------------------------------------------- //
223  USDGEOM_API
224  UsdAttribute GetAxisAttr() const;
225 
231  USDGEOM_API
232  UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // EXTENT
237  // --------------------------------------------------------------------- //
246  USDGEOM_API
247  UsdAttribute GetExtentAttr() const;
248 
254  USDGEOM_API
255  UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
256 
257 public:
258  // ===================================================================== //
259  // Feel free to add custom code below this line, it will be preserved by
260  // the code generator.
261  //
262  // Just remember to:
263  // - Close the class declaration with };
264  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
265  // - Close the include guard with #endif
266  // ===================================================================== //
267  // --(BEGIN CUSTOM CODE)--
268 
280  USDGEOM_API
281  static bool ComputeExtent(double height, double radius, const TfToken& axis,
282  VtVec3fArray* extent);
283 
286  USDGEOM_API
287  static bool ComputeExtent(double height, double radius, const TfToken& axis,
288  const GfMatrix4d& transform, VtVec3fArray* extent);
289 };
290 
291 #define USDGEOM_CYLINDER_API_VERSION 1
292 
293 PXR_NAMESPACE_CLOSE_SCOPE
294 
295 #endif // USDGEOM_GENERATED_CYLINDER_H
static USDGEOM_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
USDGEOM_API UsdAttribute GetHeightAttr() const
The size of the cylinder's spine along the specified axis.
USDGEOM_API UsdAttribute GetAxisAttr() const
The axis along which the spine of the cylinder is aligned.
UsdGeomCylinder(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCylinder on the prim held by schemaObj .
Definition: cylinder.h:86
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDGEOM_API UsdAttribute CreateExtentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetExtentAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDGEOM_API UsdGeomCylinder Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCylinder holding the prim adhering to this schema at path on stage.
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Cylinder only to provide a fallback value.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: cylinder.h:72
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
UsdGeomCylinder(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCylinder on UsdPrim prim .
Definition: cylinder.h:78
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
virtual USDGEOM_API ~UsdGeomCylinder()
Destructor.
USDGEOM_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
Base class for all geometric primitives.
Definition: gprim.h:66
static USDGEOM_API bool ComputeExtent(double height, double radius, const TfToken &axis, VtVec3fArray *extent)
Compute the extent for the cylinder defined by the height, radius, and axis.
Defines a primitive cylinder with closed ends, centered at the origin, whose spine is along the speci...
Definition: cylinder.h:66
USDGEOM_API UsdAttribute CreateAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAxisAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDGEOM_API UsdAttribute GetRadiusAttr() const
The radius of the cylinder.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDGEOM_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
static USDGEOM_API UsdGeomCylinder Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...