Loading...
Searching...
No Matches
jointScope.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef EXECIR_GENERATED_JOINTSCOPE_H
8#define EXECIR_GENERATED_JOINTSCOPE_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/exec/execIr/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// IRJOINTSCOPE //
34// -------------------------------------------------------------------------- //
35
51{
52public:
57
62 explicit ExecIrJointScope(const UsdPrim& prim=UsdPrim())
63 : ExecIrXformable(prim)
64 {
65 }
66
70 explicit ExecIrJointScope(const UsdSchemaBase& schemaObj)
71 : ExecIrXformable(schemaObj)
72 {
73 }
74
76 EXECIR_API
78
82 EXECIR_API
83 static const TfTokenVector &
84 GetSchemaAttributeNames(bool includeInherited=true);
85
95 EXECIR_API
96 static ExecIrJointScope
97 Get(const UsdStagePtr &stage, const SdfPath &path);
98
121 EXECIR_API
122 static ExecIrJointScope
123 Define(const UsdStagePtr &stage, const SdfPath &path);
124
125protected:
129 EXECIR_API
131
132private:
133 // needs to invoke _GetStaticTfType.
134 friend class UsdSchemaRegistry;
135 EXECIR_API
136 static const TfType &_GetStaticTfType();
137
138 static bool _IsTypedSchema();
139
140 // override SchemaBase virtuals.
141 EXECIR_API
142 const TfType &_GetTfType() const override;
143
144public:
145 // --------------------------------------------------------------------- //
146 // GUIDELENGTH
147 // --------------------------------------------------------------------- //
155 EXECIR_API
157
163 EXECIR_API
164 UsdAttribute CreateGuideLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165
166public:
167 // --------------------------------------------------------------------- //
168 // GUIDEDISPLAYCOLOR
169 // --------------------------------------------------------------------- //
177 EXECIR_API
179
185 EXECIR_API
186 UsdAttribute CreateGuideDisplayColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187
188public:
189 // --------------------------------------------------------------------- //
190 // GUIDEDISPLAYOPACITY
191 // --------------------------------------------------------------------- //
199 EXECIR_API
201
207 EXECIR_API
208 UsdAttribute CreateGuideDisplayOpacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209
210public:
211 // ===================================================================== //
212 // Feel free to add custom code below this line, it will be preserved by
213 // the code generator.
214 //
215 // Just remember to:
216 // - Close the class declaration with };
217 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
218 // - Close the include guard with #endif
219 // ===================================================================== //
220 // --(BEGIN CUSTOM CODE)--
221};
222
223PXR_NAMESPACE_CLOSE_SCOPE
224
225#endif
A concrete typed schema that represents the joint of an armature-based model.
Definition jointScope.h:51
static EXECIR_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...
ExecIrJointScope(const UsdSchemaBase &schemaObj)
Construct a ExecIrJointScope on the prim held by schemaObj .
Definition jointScope.h:70
EXECIR_API UsdAttribute CreateGuideDisplayColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGuideDisplayColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
EXECIR_API UsdAttribute GetGuideDisplayOpacityAttr() const
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition jointScope.h:56
EXECIR_API UsdAttribute GetGuideLengthAttr() const
static EXECIR_API ExecIrJointScope Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
EXECIR_API UsdAttribute CreateGuideDisplayOpacityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGuideDisplayOpacityAttr(), and also Create vs Get Property Methods for when to use Get vs Crea...
static EXECIR_API ExecIrJointScope Get(const UsdStagePtr &stage, const SdfPath &path)
Return a ExecIrJointScope holding the prim adhering to this schema at path on stage.
EXECIR_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
EXECIR_API UsdAttribute GetGuideDisplayColorAttr() const
virtual EXECIR_API ~ExecIrJointScope()
Destructor.
ExecIrJointScope(const UsdPrim &prim=UsdPrim())
Construct a ExecIrJointScope on UsdPrim prim .
Definition jointScope.h:62
EXECIR_API UsdAttribute CreateGuideLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGuideLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
An abstract schema that provides an animation interface for an animatable coordinate space.
Definition xformable.h:71
Contains an asset path and optional evaluated and resolved paths.
Definition assetPath.h:79
A path value used to locate objects in layers or scenegraphs.
Definition path.h:281
TfType represents a dynamic runtime type.
Definition type.h:48
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition attribute.h:183
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition prim.h:117
The base class for all schema types in Usd.
Definition schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition value.h:90
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition common.h:112
@ ConcreteTyped
Represents a concrete typed schema.
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:440