HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
root.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_ROOT_H
25 #define USDSKEL_GENERATED_ROOT_H
26 
27 /// \file usdSkel/root.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 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // SKELROOT //
50 // -------------------------------------------------------------------------- //
51 
52 /// \class UsdSkelRoot
53 ///
54 /// Boundable prim type used to identify a scope beneath which
55 /// skeletally-posed primitives are defined.
56 ///
57 /// A SkelRoot must be defined at or above a skinned primitive for any skinning
58 /// behaviors in UsdSkel.
59 ///
60 /// See the extended \ref UsdSkel_SkelRoot "Skel Root Schema" documentation for
61 /// more information.
62 ///
64 {
65 public:
66  /// Compile time constant representing what kind of schema this class is.
67  ///
68  /// \sa UsdSchemaKind
70 
71  /// Construct a UsdSkelRoot on UsdPrim \p prim .
72  /// Equivalent to UsdSkelRoot::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 UsdSkelRoot(const UsdPrim& prim=UsdPrim())
76  : UsdGeomBoundable(prim)
77  {
78  }
79 
80  /// Construct a UsdSkelRoot on the prim held by \p schemaObj .
81  /// Should be preferred over UsdSkelRoot(schemaObj.GetPrim()),
82  /// as it preserves SchemaBase state.
83  explicit UsdSkelRoot(const UsdSchemaBase& schemaObj)
84  : UsdGeomBoundable(schemaObj)
85  {
86  }
87 
88  /// Destructor.
90  virtual ~UsdSkelRoot();
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 UsdSkelRoot 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  /// UsdSkelRoot(stage->GetPrimAtPath(path));
106  /// \endcode
107  ///
109  static UsdSkelRoot
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 UsdSkelRoot
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  // Feel free to add custom code below this line, it will be preserved by
160  // the code generator.
161  //
162  // Just remember to:
163  // - Close the class declaration with };
164  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
165  // - Close the include guard with #endif
166  // ===================================================================== //
167  // --(BEGIN CUSTOM CODE)--
168 
169  /// Returns the skel root at or above \p prim, or an invalid schema object
170  /// if no ancestor prim is defined as a skel root.
172  static UsdSkelRoot Find(const UsdPrim& prim);
173 };
174 
176 
177 #endif
static USDSKEL_API UsdSkelRoot Find(const UsdPrim &prim)
USDSKEL_API UsdSchemaKind _GetSchemaKind() const override
static USDSKEL_API UsdSkelRoot Define(const UsdStagePtr &stage, const SdfPath &path)
static USDSKEL_API UsdSkelRoot Get(const UsdStagePtr &stage, const SdfPath &path)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
UsdSkelRoot(const UsdSchemaBase &schemaObj)
Definition: root.h:83
static const UsdSchemaKind schemaKind
Definition: root.h:69
UsdSchemaKind
Definition: common.h:127
static USDSKEL_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
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
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
virtual USDSKEL_API ~UsdSkelRoot()
Destructor.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
UsdSkelRoot(const UsdPrim &prim=UsdPrim())
Definition: root.h:75