Loading...
Searching...
No Matches
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
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"
40
41#include "pxr/base/tf/token.h"
42#include "pxr/base/tf/type.h"
43
44PXR_NAMESPACE_OPEN_SCOPE
45
46class SdfAssetPath;
47
48// -------------------------------------------------------------------------- //
49// SKELROOT //
50// -------------------------------------------------------------------------- //
51
64{
65public:
69 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
70
75 explicit UsdSkelRoot(const UsdPrim& prim=UsdPrim())
76 : UsdGeomBoundable(prim)
77 {
78 }
79
83 explicit UsdSkelRoot(const UsdSchemaBase& schemaObj)
84 : UsdGeomBoundable(schemaObj)
85 {
86 }
87
89 USDSKEL_API
90 virtual ~UsdSkelRoot();
91
95 USDSKEL_API
96 static const TfTokenVector &
97 GetSchemaAttributeNames(bool includeInherited=true);
98
108 USDSKEL_API
109 static UsdSkelRoot
110 Get(const UsdStagePtr &stage, const SdfPath &path);
111
134 USDSKEL_API
135 static UsdSkelRoot
136 Define(const UsdStagePtr &stage, const SdfPath &path);
137
138protected:
142 USDSKEL_API
144
145private:
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
157public:
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
171 USDSKEL_API
172 static UsdSkelRoot Find(const UsdPrim& prim);
173};
174
175PXR_NAMESPACE_CLOSE_SCOPE
176
177#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
TfType represents a dynamic runtime type.
Definition: type.h:65
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:83
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Boundable prim type used to identify a scope beneath which skeletally-posed primitives are defined.
Definition: root.h:64
UsdSkelRoot(const UsdSchemaBase &schemaObj)
Construct a UsdSkelRoot on the prim held by schemaObj .
Definition: root.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...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: root.h:69
virtual USDSKEL_API ~UsdSkelRoot()
Destructor.
USDSKEL_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdSkelRoot(const UsdPrim &prim=UsdPrim())
Construct a UsdSkelRoot on UsdPrim prim .
Definition: root.h:75
static USDSKEL_API UsdSkelRoot Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
static USDSKEL_API UsdSkelRoot Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdSkelRoot holding the prim adhering to this schema at path on stage.
static USDSKEL_API UsdSkelRoot Find(const UsdPrim &prim)
Returns the skel root at or above prim, or an invalid schema object if no ancestor prim is defined ...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457