All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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  UsdSchemaType _GetSchemaType() 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  // --------------------------------------------------------------------- //
173  USDGEOM_API
174  UsdAttribute GetHeightAttr() const;
175 
181  USDGEOM_API
182  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
183 
184 public:
185  // --------------------------------------------------------------------- //
186  // RADIUS
187  // --------------------------------------------------------------------- //
197  USDGEOM_API
198  UsdAttribute GetRadiusAttr() const;
199 
205  USDGEOM_API
206  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
207 
208 public:
209  // --------------------------------------------------------------------- //
210  // AXIS
211  // --------------------------------------------------------------------- //
219  USDGEOM_API
220  UsdAttribute GetAxisAttr() const;
221 
227  USDGEOM_API
228  UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
229 
230 public:
231  // --------------------------------------------------------------------- //
232  // EXTENT
233  // --------------------------------------------------------------------- //
241  USDGEOM_API
242  UsdAttribute GetExtentAttr() const;
243 
249  USDGEOM_API
250  UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
251 
252 public:
253  // ===================================================================== //
254  // Feel free to add custom code below this line, it will be preserved by
255  // the code generator.
256  //
257  // Just remember to:
258  // - Close the class declaration with };
259  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
260  // - Close the include guard with #endif
261  // ===================================================================== //
262  // --(BEGIN CUSTOM CODE)--
263 
275  USDGEOM_API
276  static bool ComputeExtent(double height, double radius, const TfToken& axis,
277  VtVec3fArray* extent);
278 
281  USDGEOM_API
282  static bool ComputeExtent(double height, double radius, const TfToken& axis,
283  const GfMatrix4d& transform, VtVec3fArray* extent);
284 };
285 
286 #define USDGEOM_CYLINDER_API_VERSION 1
287 
288 PXR_NAMESPACE_CLOSE_SCOPE
289 
290 #endif // USDGEOM_GENERATED_CYLINDER_H
USDGEOM_API UsdAttribute GetAxisAttr() const
The axis along which the spine of the cylinder is aligned.
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...
UsdGeomCylinder(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCylinder on the prim held by schemaObj .
Definition: cylinder.h:86
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...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
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...
Represents a concrete typed schema.
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.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
USDGEOM_API UsdAttribute GetRadiusAttr() const
The radius of the cylinder.
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
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Cylinder only to provide a fallback value.
virtual USDGEOM_API ~UsdGeomCylinder()
Destructor.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
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...
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...
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
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: cylinder.h:72
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...
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDGEOM_API UsdAttribute GetHeightAttr() const
The size of the cylinder&#39;s spine along the specified axis.