Loading...
Searching...
No Matches
cone.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_CONE_H
25#define USDGEOM_GENERATED_CONE_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/usdGeom/api.h"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// CONE //
51// -------------------------------------------------------------------------- //
52
68{
69public:
73 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
74
79 explicit UsdGeomCone(const UsdPrim& prim=UsdPrim())
80 : UsdGeomGprim(prim)
81 {
82 }
83
87 explicit UsdGeomCone(const UsdSchemaBase& schemaObj)
88 : UsdGeomGprim(schemaObj)
89 {
90 }
91
93 USDGEOM_API
94 virtual ~UsdGeomCone();
95
99 USDGEOM_API
100 static const TfTokenVector &
101 GetSchemaAttributeNames(bool includeInherited=true);
102
112 USDGEOM_API
113 static UsdGeomCone
114 Get(const UsdStagePtr &stage, const SdfPath &path);
115
138 USDGEOM_API
139 static UsdGeomCone
140 Define(const UsdStagePtr &stage, const SdfPath &path);
141
142protected:
146 USDGEOM_API
148
149private:
150 // needs to invoke _GetStaticTfType.
151 friend class UsdSchemaRegistry;
152 USDGEOM_API
153 static const TfType &_GetStaticTfType();
154
155 static bool _IsTypedSchema();
156
157 // override SchemaBase virtuals.
158 USDGEOM_API
159 const TfType &_GetTfType() const override;
160
161public:
162 // --------------------------------------------------------------------- //
163 // HEIGHT
164 // --------------------------------------------------------------------- //
175 USDGEOM_API
177
183 USDGEOM_API
184 UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185
186public:
187 // --------------------------------------------------------------------- //
188 // RADIUS
189 // --------------------------------------------------------------------- //
200 USDGEOM_API
202
208 USDGEOM_API
209 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210
211public:
212 // --------------------------------------------------------------------- //
213 // AXIS
214 // --------------------------------------------------------------------- //
224 USDGEOM_API
226
232 USDGEOM_API
233 UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
234
235public:
236 // --------------------------------------------------------------------- //
237 // EXTENT
238 // --------------------------------------------------------------------- //
247 USDGEOM_API
249
255 USDGEOM_API
256 UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257
258public:
259 // ===================================================================== //
260 // Feel free to add custom code below this line, it will be preserved by
261 // the code generator.
262 //
263 // Just remember to:
264 // - Close the class declaration with };
265 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
266 // - Close the include guard with #endif
267 // ===================================================================== //
268 // --(BEGIN CUSTOM CODE)--
269
281 USDGEOM_API
282 static bool ComputeExtent(double height, double radius, const TfToken& axis,
283 VtVec3fArray* extent);
284
287 USDGEOM_API
288 static bool ComputeExtent(double height, double radius, const TfToken& axis,
289 const GfMatrix4d& transform, VtVec3fArray* extent);
290};
291
292PXR_NAMESPACE_CLOSE_SCOPE
293
294#endif
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
Defines a primitive cone, centered at the origin, whose spine is along the specified axis,...
Definition: cone.h:68
UsdGeomCone(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomCone on UsdPrim prim .
Definition: cone.h:79
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:73
UsdGeomCone(const UsdSchemaBase &schemaObj)
Construct a UsdGeomCone on the prim held by schemaObj .
Definition: cone.h:87
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:67
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
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:165
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
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:457