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 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdSkel/api.h"
31 #include "pxr/usd/usdGeom/boundable.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdSkel/tokens.h"
35 
36 #include "pxr/usd/usdSkel/topology.h"
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 
47 PXR_NAMESPACE_OPEN_SCOPE
48 
49 class SdfAssetPath;
50 
51 // -------------------------------------------------------------------------- //
52 // SKELETON //
53 // -------------------------------------------------------------------------- //
54 
64 {
65 public:
70 
75  explicit UsdSkelSkeleton(const UsdPrim& prim=UsdPrim())
76  : UsdGeomBoundable(prim)
77  {
78  }
79 
83  explicit UsdSkelSkeleton(const UsdSchemaBase& schemaObj)
84  : UsdGeomBoundable(schemaObj)
85  {
86  }
87 
89  USDSKEL_API
90  virtual ~UsdSkelSkeleton();
91 
95  USDSKEL_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDSKEL_API
109  static UsdSkelSkeleton
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
134  USDSKEL_API
135  static UsdSkelSkeleton
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
142  USDSKEL_API
143  UsdSchemaType _GetSchemaType() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  USDSKEL_API
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
154  USDSKEL_API
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // JOINTS
160  // --------------------------------------------------------------------- //
172  USDSKEL_API
173  UsdAttribute GetJointsAttr() const;
174 
180  USDSKEL_API
181  UsdAttribute CreateJointsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182 
183 public:
184  // --------------------------------------------------------------------- //
185  // JOINTNAMES
186  // --------------------------------------------------------------------- //
195  USDSKEL_API
197 
203  USDSKEL_API
204  UsdAttribute CreateJointNamesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205 
206 public:
207  // --------------------------------------------------------------------- //
208  // BINDTRANSFORMS
209  // --------------------------------------------------------------------- //
217  USDSKEL_API
219 
225  USDSKEL_API
226  UsdAttribute CreateBindTransformsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
227 
228 public:
229  // --------------------------------------------------------------------- //
230  // RESTTRANSFORMS
231  // --------------------------------------------------------------------- //
242  USDSKEL_API
244 
250  USDSKEL_API
251  UsdAttribute CreateRestTransformsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
252 
253 public:
254  // ===================================================================== //
255  // Feel free to add custom code below this line, it will be preserved by
256  // the code generator.
257  //
258  // Just remember to:
259  // - Close the class declaration with };
260  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
261  // - Close the include guard with #endif
262  // ===================================================================== //
263  // --(BEGIN CUSTOM CODE)--
264 };
265 
266 PXR_NAMESPACE_CLOSE_SCOPE
267 
268 #endif
USDSKEL_API UsdAttribute CreateBindTransformsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBindTransformsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: skeleton.h:69
UsdSkelSkeleton(const UsdPrim &prim=UsdPrim())
Construct a UsdSkelSkeleton on UsdPrim prim .
Definition: skeleton.h:75
USDSKEL_API UsdAttribute GetJointNamesAttr() const
If authored, provides a unique name per joint.
USDSKEL_API UsdAttribute GetJointsAttr() const
An array of path tokens identifying the set of joints that make up the skeleton, and their order...
USDSKEL_API UsdAttribute CreateJointNamesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetJointNamesAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDSKEL_API UsdAttribute GetRestTransformsAttr() const
Specifies the rest-pose transforms of each joint in local space, in the ordering imposed by joints...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space, extent.
Definition: boundable.h:82
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
static USDSKEL_API UsdSkelSkeleton Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdSkelSkeleton holding the prim adhering to this schema at path on stage.
Describes a skeleton.
Definition: skeleton.h:63
USDSKEL_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
USDSKEL_API UsdAttribute CreateJointsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetJointsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDSKEL_API UsdAttribute CreateRestTransformsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestTransformsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
UsdSkelSkeleton(const UsdSchemaBase &schemaObj)
Construct a UsdSkelSkeleton on the prim held by schemaObj .
Definition: skeleton.h:83
static USDSKEL_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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
virtual USDSKEL_API ~UsdSkelSkeleton()
Destructor.
static USDSKEL_API UsdSkelSkeleton Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDSKEL_API UsdAttribute GetBindTransformsAttr() const
Specifies the bind-pose transforms of each joint in world space, in the ordering imposed by joints...