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
52{
53public:
58
63 explicit ExecIrJointScope(const UsdPrim& prim=UsdPrim())
64 : ExecIrXformable(prim)
65 {
66 }
67
71 explicit ExecIrJointScope(const UsdSchemaBase& schemaObj)
72 : ExecIrXformable(schemaObj)
73 {
74 }
75
77 EXECIR_API
79
83 EXECIR_API
84 static const TfTokenVector &
85 GetSchemaAttributeNames(bool includeInherited=true);
86
96 EXECIR_API
97 static ExecIrJointScope
98 Get(const UsdStagePtr &stage, const SdfPath &path);
99
122 EXECIR_API
123 static ExecIrJointScope
124 Define(const UsdStagePtr &stage, const SdfPath &path);
125
126protected:
130 EXECIR_API
132
133private:
134 // needs to invoke _GetStaticTfType.
135 friend class UsdSchemaRegistry;
136 EXECIR_API
137 static const TfType &_GetStaticTfType();
138
139 static bool _IsTypedSchema();
140
141 // override SchemaBase virtuals.
142 EXECIR_API
143 const TfType &_GetTfType() const override;
144
145public:
146 // --------------------------------------------------------------------- //
147 // GUIDELENGTH
148 // --------------------------------------------------------------------- //
156 EXECIR_API
158
164 EXECIR_API
165 UsdAttribute CreateGuideLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
166
167public:
168 // --------------------------------------------------------------------- //
169 // GUIDEDISPLAYCOLOR
170 // --------------------------------------------------------------------- //
178 EXECIR_API
180
186 EXECIR_API
187 UsdAttribute CreateGuideDisplayColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188
189public:
190 // --------------------------------------------------------------------- //
191 // GUIDEDISPLAYOPACITY
192 // --------------------------------------------------------------------- //
200 EXECIR_API
202
208 EXECIR_API
209 UsdAttribute CreateGuideDisplayOpacityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210
211public:
212 // ===================================================================== //
213 // Feel free to add custom code below this line, it will be preserved by
214 // the code generator.
215 //
216 // Just remember to:
217 // - Close the class declaration with };
218 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
219 // - Close the include guard with #endif
220 // ===================================================================== //
221 // --(BEGIN CUSTOM CODE)--
222};
223
224PXR_NAMESPACE_CLOSE_SCOPE
225
226#endif
A concrete typed schema that represents the joint of an armature-based model.
Definition jointScope.h:52
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:71
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:57
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:63
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:90
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