HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 /// \file usdGeom/cone.h
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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // CONE //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdGeomCone
54 ///
55 /// Defines a primitive cone, centered at the origin, whose spine
56 /// is along the specified \em axis, with the apex of the cone pointing
57 /// in the direction of the positive axis.
58 ///
59 /// The fallback values for Cube, Sphere, Cone, and Cylinder are set so that
60 /// they all pack into the same volume/bounds.
61 ///
62 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
63 /// that are text/tokens, the actual token is published and defined in \ref UsdGeomTokens.
64 /// So to set an attribute to the value "rightHanded", use UsdGeomTokens->rightHanded
65 /// as the value.
66 ///
67 class UsdGeomCone : public UsdGeomGprim
68 {
69 public:
70  /// Compile time constant representing what kind of schema this class is.
71  ///
72  /// \sa UsdSchemaKind
74 
75  /// Construct a UsdGeomCone on UsdPrim \p prim .
76  /// Equivalent to UsdGeomCone::Get(prim.GetStage(), prim.GetPath())
77  /// for a \em valid \p prim, but will not immediately throw an error for
78  /// an invalid \p prim
79  explicit UsdGeomCone(const UsdPrim& prim=UsdPrim())
80  : UsdGeomGprim(prim)
81  {
82  }
83 
84  /// Construct a UsdGeomCone on the prim held by \p schemaObj .
85  /// Should be preferred over UsdGeomCone(schemaObj.GetPrim()),
86  /// as it preserves SchemaBase state.
87  explicit UsdGeomCone(const UsdSchemaBase& schemaObj)
88  : UsdGeomGprim(schemaObj)
89  {
90  }
91 
92  /// Destructor.
94  virtual ~UsdGeomCone();
95 
96  /// Return a vector of names of all pre-declared attributes for this schema
97  /// class and all its ancestor classes. Does not include attributes that
98  /// may be authored by custom/extended methods of the schemas involved.
100  static const TfTokenVector &
101  GetSchemaAttributeNames(bool includeInherited=true);
102 
103  /// Return a UsdGeomCone holding the prim adhering to this
104  /// schema at \p path on \p stage. If no prim exists at \p path on
105  /// \p stage, or if the prim at that path does not adhere to this schema,
106  /// return an invalid schema object. This is shorthand for the following:
107  ///
108  /// \code
109  /// UsdGeomCone(stage->GetPrimAtPath(path));
110  /// \endcode
111  ///
113  static UsdGeomCone
114  Get(const UsdStagePtr &stage, const SdfPath &path);
115 
116  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
117  /// is defined (according to UsdPrim::IsDefined()) on this stage.
118  ///
119  /// If a prim adhering to this schema at \p path is already defined on this
120  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
121  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
122  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
123  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
124  /// current EditTarget for any nonexistent, or existing but not \a Defined
125  /// ancestors.
126  ///
127  /// The given \a path must be an absolute prim path that does not contain
128  /// any variant selections.
129  ///
130  /// If it is impossible to author any of the necessary PrimSpecs, (for
131  /// example, in case \a path cannot map to the current UsdEditTarget's
132  /// namespace) issue an error and return an invalid \a UsdPrim.
133  ///
134  /// Note that this method may return a defined prim whose typeName does not
135  /// specify this schema class, in case a stronger typeName opinion overrides
136  /// the opinion at the current EditTarget.
137  ///
139  static UsdGeomCone
140  Define(const UsdStagePtr &stage, const SdfPath &path);
141 
142 protected:
143  /// Returns the kind of schema this class belongs to.
144  ///
145  /// \sa UsdSchemaKind
147  UsdSchemaKind _GetSchemaKind() const override;
148 
149 private:
150  // needs to invoke _GetStaticTfType.
151  friend class UsdSchemaRegistry;
153  static const TfType &_GetStaticTfType();
154 
155  static bool _IsTypedSchema();
156 
157  // override SchemaBase virtuals.
159  const TfType &_GetTfType() const override;
160 
161 public:
162  // --------------------------------------------------------------------- //
163  // HEIGHT
164  // --------------------------------------------------------------------- //
165  /// The size of the cone's spine along the specified
166  /// \em axis. If you author \em height you must also author \em extent.
167  ///
168  /// \sa GetExtentAttr()
169  ///
170  /// | ||
171  /// | -- | -- |
172  /// | Declaration | `double height = 2` |
173  /// | C++ Type | double |
174  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Double |
176  UsdAttribute GetHeightAttr() const;
177 
178  /// See GetHeightAttr(), and also
179  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
180  /// If specified, author \p defaultValue as the attribute's default,
181  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
182  /// the default for \p writeSparsely is \c false.
184  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
185 
186 public:
187  // --------------------------------------------------------------------- //
188  // RADIUS
189  // --------------------------------------------------------------------- //
190  /// The radius of the cone. If you
191  /// author \em radius you must also author \em extent.
192  ///
193  /// \sa GetExtentAttr()
194  ///
195  /// | ||
196  /// | -- | -- |
197  /// | Declaration | `double radius = 1` |
198  /// | C++ Type | double |
199  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Double |
201  UsdAttribute GetRadiusAttr() const;
202 
203  /// See GetRadiusAttr(), and also
204  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
205  /// If specified, author \p defaultValue as the attribute's default,
206  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
207  /// the default for \p writeSparsely is \c false.
209  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210 
211 public:
212  // --------------------------------------------------------------------- //
213  // AXIS
214  // --------------------------------------------------------------------- //
215  /// The axis along which the spine of the cone is aligned
216  ///
217  /// | ||
218  /// | -- | -- |
219  /// | Declaration | `uniform token axis = "Z"` |
220  /// | C++ Type | TfToken |
221  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
222  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
223  /// | \ref UsdGeomTokens "Allowed Values" | X, Y, Z |
225  UsdAttribute GetAxisAttr() const;
226 
227  /// See GetAxisAttr(), and also
228  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
229  /// If specified, author \p defaultValue as the attribute's default,
230  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
231  /// the default for \p writeSparsely is \c false.
233  UsdAttribute CreateAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
234 
235 public:
236  // --------------------------------------------------------------------- //
237  // EXTENT
238  // --------------------------------------------------------------------- //
239  /// Extent is re-defined on Cone only to provide a fallback
240  /// value. \sa UsdGeomGprim::GetExtentAttr().
241  ///
242  /// | ||
243  /// | -- | -- |
244  /// | Declaration | `float3[] extent = [(-1, -1, -1), (1, 1, 1)]` |
245  /// | C++ Type | VtArray<GfVec3f> |
246  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float3Array |
248  UsdAttribute GetExtentAttr() const;
249 
250  /// See GetExtentAttr(), and also
251  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
252  /// If specified, author \p defaultValue as the attribute's default,
253  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
254  /// the default for \p writeSparsely is \c false.
256  UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
257 
258 public:
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 
270  /// Compute the extent for the cone defined by the height, radius, and
271  /// axis.
272  ///
273  /// \return true upon success, false if unable to calculate extent.
274  ///
275  /// On success, extent will contain an approximate axis-aligned bounding
276  /// box of the cone defined by the height, radius, and axis.
277  ///
278  /// This function is to provide easy authoring of extent for usd authoring
279  /// tools, hence it is static and acts outside a specific prim (as in
280  /// attribute based methods).
282  static bool ComputeExtent(double height, double radius, const TfToken& axis,
283  VtVec3fArray* extent);
284 
285  /// \overload
286  /// Computes the extent as if the matrix \p transform was first applied.
288  static bool ComputeExtent(double height, double radius, const TfToken& axis,
289  const GfMatrix4d& transform, VtVec3fArray* extent);
290 };
291 
293 
294 #endif
GLint GLenum GLsizei GLsizei GLsizei GLsizei extent
Definition: glew.h:15877
UsdGeomCone(const UsdPrim &prim=UsdPrim())
Definition: cone.h:79
static USDGEOM_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
USDGEOM_API UsdAttribute GetExtentAttr() const
USDGEOM_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute GetRadiusAttr() const
USDGEOM_API UsdAttribute GetAxisAttr() const
GLuint GLenum GLenum transform
Definition: glew.h:15055
UsdSchemaKind
Definition: common.h:127
Definition: token.h:87
static const UsdSchemaKind schemaKind
Definition: cone.h:73
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:290
USDGEOM_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLint GLsizei GLsizei height
Definition: glcorearb.h:103
USDGEOM_API UsdAttribute CreateExtentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute CreateAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdGeomCone(const UsdSchemaBase &schemaObj)
Definition: cone.h:87
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
virtual USDGEOM_API ~UsdGeomCone()
Destructor.
static USDGEOM_API bool ComputeExtent(double height, double radius, const TfToken &axis, VtVec3fArray *extent)
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
#define USDGEOM_API
Definition: api.h:40
static USDGEOM_API UsdGeomCone Get(const UsdStagePtr &stage, const SdfPath &path)
Definition: value.h:166
static USDGEOM_API UsdGeomCone Define(const UsdStagePtr &stage, const SdfPath &path)
USDGEOM_API UsdAttribute GetHeightAttr() const