HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
skeleton.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 USDSKEL_GENERATED_SKELETON_H
25 #define USDSKEL_GENERATED_SKELETON_H
26 
27 /// \file usdSkel/skeleton.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdSkel/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdSkel/tokens.h"
35 
37 
38 #include "pxr/base/vt/value.h"
39 
40 #include "pxr/base/gf/vec3d.h"
41 #include "pxr/base/gf/vec3f.h"
42 #include "pxr/base/gf/matrix4d.h"
43 
44 #include "pxr/base/tf/token.h"
45 #include "pxr/base/tf/type.h"
46 
48 
49 class SdfAssetPath;
50 
51 // -------------------------------------------------------------------------- //
52 // SKELETON //
53 // -------------------------------------------------------------------------- //
54 
55 /// \class UsdSkelSkeleton
56 ///
57 /// Describes a skeleton.
58 ///
59 /// See the extended \ref UsdSkel_Skeleton "Skeleton Schema" documentation for
60 /// more information.
61 ///
62 ///
64 {
65 public:
66  /// Compile time constant representing what kind of schema this class is.
67  ///
68  /// \sa UsdSchemaKind
70 
71  /// Construct a UsdSkelSkeleton on UsdPrim \p prim .
72  /// Equivalent to UsdSkelSkeleton::Get(prim.GetStage(), prim.GetPath())
73  /// for a \em valid \p prim, but will not immediately throw an error for
74  /// an invalid \p prim
75  explicit UsdSkelSkeleton(const UsdPrim& prim=UsdPrim())
76  : UsdGeomBoundable(prim)
77  {
78  }
79 
80  /// Construct a UsdSkelSkeleton on the prim held by \p schemaObj .
81  /// Should be preferred over UsdSkelSkeleton(schemaObj.GetPrim()),
82  /// as it preserves SchemaBase state.
83  explicit UsdSkelSkeleton(const UsdSchemaBase& schemaObj)
84  : UsdGeomBoundable(schemaObj)
85  {
86  }
87 
88  /// Destructor.
90  virtual ~UsdSkelSkeleton();
91 
92  /// Return a vector of names of all pre-declared attributes for this schema
93  /// class and all its ancestor classes. Does not include attributes that
94  /// may be authored by custom/extended methods of the schemas involved.
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
99  /// Return a UsdSkelSkeleton holding the prim adhering to this
100  /// schema at \p path on \p stage. If no prim exists at \p path on
101  /// \p stage, or if the prim at that path does not adhere to this schema,
102  /// return an invalid schema object. This is shorthand for the following:
103  ///
104  /// \code
105  /// UsdSkelSkeleton(stage->GetPrimAtPath(path));
106  /// \endcode
107  ///
109  static UsdSkelSkeleton
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
113  /// is defined (according to UsdPrim::IsDefined()) on this stage.
114  ///
115  /// If a prim adhering to this schema at \p path is already defined on this
116  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
117  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
118  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
119  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
120  /// current EditTarget for any nonexistent, or existing but not \a Defined
121  /// ancestors.
122  ///
123  /// The given \a path must be an absolute prim path that does not contain
124  /// any variant selections.
125  ///
126  /// If it is impossible to author any of the necessary PrimSpecs, (for
127  /// example, in case \a path cannot map to the current UsdEditTarget's
128  /// namespace) issue an error and return an invalid \a UsdPrim.
129  ///
130  /// Note that this method may return a defined prim whose typeName does not
131  /// specify this schema class, in case a stronger typeName opinion overrides
132  /// the opinion at the current EditTarget.
133  ///
135  static UsdSkelSkeleton
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
139  /// Returns the kind of schema this class belongs to.
140  ///
141  /// \sa UsdSchemaKind
143  UsdSchemaKind _GetSchemaKind() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // JOINTS
160  // --------------------------------------------------------------------- //
161  /// An array of path tokens identifying the set of joints that make
162  /// up the skeleton, and their order. Each token in the array must be valid
163  /// when parsed as an SdfPath. The parent-child relationships of the
164  /// corresponding paths determine the parent-child relationships of each
165  /// joint. It is not required that the name at the end of each path be
166  /// unique, but rather only that the paths themselves be unique.
167  ///
168  /// | ||
169  /// | -- | -- |
170  /// | Declaration | `uniform token[] joints` |
171  /// | C++ Type | VtArray<TfToken> |
172  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->TokenArray |
173  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
175  UsdAttribute GetJointsAttr() const;
176 
177  /// See GetJointsAttr(), and also
178  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
179  /// If specified, author \p defaultValue as the attribute's default,
180  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
181  /// the default for \p writeSparsely is \c false.
183  UsdAttribute CreateJointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
184 
185 public:
186  // --------------------------------------------------------------------- //
187  // JOINTNAMES
188  // --------------------------------------------------------------------- //
189  /// If authored, provides a unique name per joint. This may be
190  /// optionally set to provide better names when translating to DCC apps
191  /// that require unique joint names.
192  ///
193  /// | ||
194  /// | -- | -- |
195  /// | Declaration | `uniform token[] jointNames` |
196  /// | C++ Type | VtArray<TfToken> |
197  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->TokenArray |
198  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
201 
202  /// See GetJointNamesAttr(), and also
203  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
204  /// If specified, author \p defaultValue as the attribute's default,
205  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
206  /// the default for \p writeSparsely is \c false.
208  UsdAttribute CreateJointNamesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209 
210 public:
211  // --------------------------------------------------------------------- //
212  // BINDTRANSFORMS
213  // --------------------------------------------------------------------- //
214  /// Specifies the bind-pose transforms of each joint in
215  /// **world space**, in the ordering imposed by *joints*.
216  ///
217  /// | ||
218  /// | -- | -- |
219  /// | Declaration | `uniform matrix4d[] bindTransforms` |
220  /// | C++ Type | VtArray<GfMatrix4d> |
221  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Matrix4dArray |
222  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
225 
226  /// See GetBindTransformsAttr(), and also
227  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
228  /// If specified, author \p defaultValue as the attribute's default,
229  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
230  /// the default for \p writeSparsely is \c false.
232  UsdAttribute CreateBindTransformsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // RESTTRANSFORMS
237  // --------------------------------------------------------------------- //
238  /// Specifies the rest-pose transforms of each joint in
239  /// **local space**, in the ordering imposed by *joints*. This provides
240  /// fallback values for joint transforms when a Skeleton either has no
241  /// bound animation source, or when that animation source only contains
242  /// animation for a subset of a Skeleton's joints.
243  ///
244  /// | ||
245  /// | -- | -- |
246  /// | Declaration | `uniform matrix4d[] restTransforms` |
247  /// | C++ Type | VtArray<GfMatrix4d> |
248  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Matrix4dArray |
249  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
252 
253  /// See GetRestTransformsAttr(), and also
254  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
255  /// If specified, author \p defaultValue as the attribute's default,
256  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
257  /// the default for \p writeSparsely is \c false.
259  UsdAttribute CreateRestTransformsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
260 
261 public:
262  // ===================================================================== //
263  // Feel free to add custom code below this line, it will be preserved by
264  // the code generator.
265  //
266  // Just remember to:
267  // - Close the class declaration with };
268  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
269  // - Close the include guard with #endif
270  // ===================================================================== //
271  // --(BEGIN CUSTOM CODE)--
272 };
273 
275 
276 #endif
UsdSkelSkeleton(const UsdSchemaBase &schemaObj)
Definition: skeleton.h:83
USDSKEL_API UsdAttribute CreateJointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
static USDSKEL_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
USDSKEL_API UsdAttribute GetJointsAttr() const
static USDSKEL_API UsdSkelSkeleton Get(const UsdStagePtr &stage, const SdfPath &path)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
USDSKEL_API UsdAttribute CreateJointNamesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute CreateBindTransformsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
virtual USDSKEL_API ~UsdSkelSkeleton()
Destructor.
UsdSchemaKind
Definition: common.h:127
USDSKEL_API UsdAttribute GetJointNamesAttr() const
USDSKEL_API UsdAttribute CreateRestTransformsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
#define USDSKEL_API
Definition: api.h:40
Definition: path.h:290
static USDSKEL_API UsdSkelSkeleton Define(const UsdStagePtr &stage, const SdfPath &path)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
USDSKEL_API UsdSchemaKind _GetSchemaKind() const override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
UsdSkelSkeleton(const UsdPrim &prim=UsdPrim())
Definition: skeleton.h:75
static const UsdSchemaKind schemaKind
Definition: skeleton.h:69
USDSKEL_API UsdAttribute GetRestTransformsAttr() const
Definition: value.h:166
USDSKEL_API UsdAttribute GetBindTransformsAttr() const