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