All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cylinder_1.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDGEOM_GENERATED_CYLINDER_1_H
8#define USDGEOM_GENERATED_CYLINDER_1_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdGeom/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// CYLINDER_1 //
34// -------------------------------------------------------------------------- //
35
51{
52public:
56 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
57
62 explicit UsdGeomCylinder_1(const UsdPrim& prim=UsdPrim())
63 : UsdGeomGprim(prim)
64 {
65 }
66
70 explicit UsdGeomCylinder_1(const UsdSchemaBase& schemaObj)
71 : UsdGeomGprim(schemaObj)
72 {
73 }
74
76 USDGEOM_API
78
82 USDGEOM_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 USDGEOM_API
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
121 USDGEOM_API
122 static UsdGeomCylinder_1
123 Define(const UsdStagePtr &stage, const SdfPath &path);
124
125protected:
129 USDGEOM_API
131
132private:
133 // needs to invoke _GetStaticTfType.
134 friend class UsdSchemaRegistry;
135 USDGEOM_API
136 static const TfType &_GetStaticTfType();
137
138 static bool _IsTypedSchema();
139
140 // override SchemaBase virtuals.
141 USDGEOM_API
142 const TfType &_GetTfType() const override;
143
144public:
145 // --------------------------------------------------------------------- //
146 // HEIGHT
147 // --------------------------------------------------------------------- //
158 USDGEOM_API
160
166 USDGEOM_API
167 UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168
169public:
170 // --------------------------------------------------------------------- //
171 // RADIUSTOP
172 // --------------------------------------------------------------------- //
184 USDGEOM_API
186
192 USDGEOM_API
193 UsdAttribute CreateRadiusTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194
195public:
196 // --------------------------------------------------------------------- //
197 // RADIUSBOTTOM
198 // --------------------------------------------------------------------- //
210 USDGEOM_API
212
218 USDGEOM_API
219 UsdAttribute CreateRadiusBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220
221public:
222 // --------------------------------------------------------------------- //
223 // AXIS
224 // --------------------------------------------------------------------- //
234 USDGEOM_API
236
242 USDGEOM_API
243 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
244
245public:
246 // --------------------------------------------------------------------- //
247 // EXTENT
248 // --------------------------------------------------------------------- //
257 USDGEOM_API
259
265 USDGEOM_API
266 UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
267
268public:
269 // ===================================================================== //
270 // Feel free to add custom code below this line, it will be preserved by
271 // the code generator.
272 //
273 // Just remember to:
274 // - Close the class declaration with };
275 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
276 // - Close the include guard with #endif
277 // ===================================================================== //
278 // --(BEGIN CUSTOM CODE)--
279
292 USDGEOM_API
293 static bool ComputeExtent(double height, double radiusTop,
294 double radiusBottom, const TfToken& axis, VtVec3fArray* extent);
295
298 USDGEOM_API
299 static bool ComputeExtent(double height, double radiusTop,
300 double radiusBottom, const TfToken& axis,
301 const GfMatrix4d& transform, VtVec3fArray* extent);
302};
303
304PXR_NAMESPACE_CLOSE_SCOPE
305
306#endif
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:71
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:73
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
TfType represents a dynamic runtime type.
Definition: type.h:48
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:167
Defines a primitive cylinder with closed ends, centered at the origin, whose spine is along the speci...
Definition: cylinder_1.h:51
USDGEOM_API UsdAttribute CreateRadiusBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusBottomAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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_1 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 UsdAttribute CreateRadiusTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusTopAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: cylinder_1.h:56
USDGEOM_API UsdAttribute GetRadiusTopAttr() const
The radius of the top of the cylinder - i.e.
static USDGEOM_API UsdGeomCylinder_1 Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCylinder_1 holding the prim adhering to this schema at path on stage.
virtual USDGEOM_API ~UsdGeomCylinder_1()
Destructor.
USDGEOM_API UsdAttribute GetRadiusBottomAttr() const
The radius of the bottom of the cylinder - i.e.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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 GetAxisAttr() const
The axis along which the spine of the cylinder is aligned.
USDGEOM_API UsdAttribute GetHeightAttr() const
The length of the cylinder's spine along the specified axis.
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.
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Cylinder only to provide a fallback value.
static USDGEOM_API bool ComputeExtent(double height, double radiusTop, double radiusBottom, const TfToken &axis, VtVec3fArray *extent)
Compute the extent for the cylinder defined by the height, radiusTop, radiusBottom,...
static USDGEOM_API bool ComputeExtent(double height, double radiusTop, double radiusBottom, const TfToken &axis, const GfMatrix4d &transform, VtVec3fArray *extent)
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdGeomCylinder_1(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCylinder_1 on the prim held by schemaObj .
Definition: cylinder_1.h:70
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.
UsdGeomCylinder_1(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCylinder_1 on UsdPrim prim .
Definition: cylinder_1.h:62
Base class for all geometric primitives.
Definition: gprim.h:50
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440