This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cone.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_CONE_H
8#define USDGEOM_GENERATED_CONE_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// CONE //
34// -------------------------------------------------------------------------- //
35
51{
52public:
56 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
57
62 explicit UsdGeomCone(const UsdPrim& prim=UsdPrim())
63 : UsdGeomGprim(prim)
64 {
65 }
66
70 explicit UsdGeomCone(const UsdSchemaBase& schemaObj)
71 : UsdGeomGprim(schemaObj)
72 {
73 }
74
76 USDGEOM_API
77 virtual ~UsdGeomCone();
78
82 USDGEOM_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 USDGEOM_API
96 static UsdGeomCone
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
121 USDGEOM_API
122 static UsdGeomCone
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 // RADIUS
172 // --------------------------------------------------------------------- //
183 USDGEOM_API
185
191 USDGEOM_API
192 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
193
194public:
195 // --------------------------------------------------------------------- //
196 // AXIS
197 // --------------------------------------------------------------------- //
207 USDGEOM_API
209
215 USDGEOM_API
216 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
217
218public:
219 // --------------------------------------------------------------------- //
220 // EXTENT
221 // --------------------------------------------------------------------- //
230 USDGEOM_API
232
238 USDGEOM_API
239 UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
240
241public:
242 // ===================================================================== //
243 // Feel free to add custom code below this line, it will be preserved by
244 // the code generator.
245 //
246 // Just remember to:
247 // - Close the class declaration with };
248 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
249 // - Close the include guard with #endif
250 // ===================================================================== //
251 // --(BEGIN CUSTOM CODE)--
252
264 USDGEOM_API
265 static bool ComputeExtent(double height, double radius, const TfToken& axis,
266 VtVec3fArray* extent);
267
270 USDGEOM_API
271 static bool ComputeExtent(double height, double radius, const TfToken& axis,
272 const GfMatrix4d& transform, VtVec3fArray* extent);
273};
274
275PXR_NAMESPACE_CLOSE_SCOPE
276
277#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 cone, centered at the origin, whose spine is along the specified axis,...
Definition: cone.h:51
UsdGeomCone(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCone on UsdPrim prim .
Definition: cone.h:62
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 UsdGeomCone Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDGEOM_API ~UsdGeomCone()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: cone.h:56
UsdGeomCone(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCone on the prim held by schemaObj .
Definition: cone.h:70
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 cone 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...
static USDGEOM_API UsdGeomCone Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomCone holding the prim adhering to this schema at path on stage.
USDGEOM_API UsdAttribute GetAxisAttr() const
The axis along which the spine of the cone is aligned.
USDGEOM_API UsdAttribute GetHeightAttr() const
The length of the cone'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 GetRadiusAttr() const
The radius of the cone.
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is re-defined on Cone 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.
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