All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
capsule.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_CAPSULE_H
8#define USDGEOM_GENERATED_CAPSULE_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// CAPSULE //
34// -------------------------------------------------------------------------- //
35
51{
52public:
56 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
57
62 explicit UsdGeomCapsule(const UsdPrim& prim=UsdPrim())
63 : UsdGeomGprim(prim)
64 {
65 }
66
70 explicit UsdGeomCapsule(const UsdSchemaBase& schemaObj)
71 : UsdGeomGprim(schemaObj)
72 {
73 }
74
76 USDGEOM_API
77 virtual ~UsdGeomCapsule();
78
82 USDGEOM_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 USDGEOM_API
96 static UsdGeomCapsule
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
121 USDGEOM_API
122 static UsdGeomCapsule
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 // --------------------------------------------------------------------- //
159 USDGEOM_API
161
167 USDGEOM_API
168 UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
169
170public:
171 // --------------------------------------------------------------------- //
172 // RADIUS
173 // --------------------------------------------------------------------- //
184 USDGEOM_API
186
192 USDGEOM_API
193 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194
195public:
196 // --------------------------------------------------------------------- //
197 // AXIS
198 // --------------------------------------------------------------------- //
208 USDGEOM_API
210
216 USDGEOM_API
217 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
218
219public:
220 // --------------------------------------------------------------------- //
221 // EXTENT
222 // --------------------------------------------------------------------- //
231 USDGEOM_API
233
239 USDGEOM_API
240 UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
241
242public:
243 // ===================================================================== //
244 // Feel free to add custom code below this line, it will be preserved by
245 // the code generator.
246 //
247 // Just remember to:
248 // - Close the class declaration with };
249 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
250 // - Close the include guard with #endif
251 // ===================================================================== //
252 // --(BEGIN CUSTOM CODE)--
253
265 USDGEOM_API
266 static bool ComputeExtent(double height, double radius, const TfToken& axis,
267 VtVec3fArray* extent);
268
271 USDGEOM_API
272 static bool ComputeExtent(double height, double radius, const TfToken& axis,
273 const GfMatrix4d& transform, VtVec3fArray* extent);
274};
275
276PXR_NAMESPACE_CLOSE_SCOPE
277
278#endif
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:71
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
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:160
Defines a primitive capsule, i.e.
Definition: capsule.h:51
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 UsdGeomCapsule Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: capsule.h:56
virtual USDGEOM_API ~UsdGeomCapsule()
Destructor.
static USDGEOM_API UsdGeomCapsule Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCapsule holding the prim adhering to this schema at path on stage.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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.
static USDGEOM_API bool ComputeExtent(double height, double radius, const TfToken &axis, const GfMatrix4d &transform, VtVec3fArray *extent)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USDGEOM_API bool ComputeExtent(double height, double radius, const TfToken &axis, VtVec3fArray *extent)
Compute the extent for the capsule defined by the height, radius, and axis.
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...
UsdGeomCapsule(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCapsule on the prim held by schemaObj .
Definition: capsule.h:70
USDGEOM_API UsdAttribute GetAxisAttr() const
The axis along which the spine of the capsule is aligned.
USDGEOM_API UsdAttribute GetHeightAttr() const
The length of the capsule's spine along the specified axis excluding the size of the two half spheres...
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 GetRadiusAttr() const
The radius of the capsule.
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Capsule only to provide a fallback value.
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.
UsdGeomCapsule(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCapsule on UsdPrim prim .
Definition: capsule.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