Loading...
Searching...
No Matches
fkController.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_FKCONTROLLER_H
8#define EXECIR_GENERATED_FKCONTROLLER_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// IRFKCONTROLLER //
34// -------------------------------------------------------------------------- //
35
56{
57public:
62
67 explicit ExecIrFkController(const UsdPrim& prim=UsdPrim())
68 : ExecIrIrController(prim)
69 {
70 }
71
75 explicit ExecIrFkController(const UsdSchemaBase& schemaObj)
76 : ExecIrIrController(schemaObj)
77 {
78 }
79
81 EXECIR_API
83
87 EXECIR_API
88 static const TfTokenVector &
89 GetSchemaAttributeNames(bool includeInherited=true);
90
100 EXECIR_API
101 static ExecIrFkController
102 Get(const UsdStagePtr &stage, const SdfPath &path);
103
126 EXECIR_API
127 static ExecIrFkController
128 Define(const UsdStagePtr &stage, const SdfPath &path);
129
130protected:
134 EXECIR_API
136
137private:
138 // needs to invoke _GetStaticTfType.
139 friend class UsdSchemaRegistry;
140 EXECIR_API
141 static const TfType &_GetStaticTfType();
142
143 static bool _IsTypedSchema();
144
145 // override SchemaBase virtuals.
146 EXECIR_API
147 const TfType &_GetTfType() const override;
148
149public:
150 // --------------------------------------------------------------------- //
151 // PARENTINSPACE
152 // --------------------------------------------------------------------- //
160 EXECIR_API
162
168 EXECIR_API
169 UsdAttribute CreateParentInSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
170
171public:
172 // --------------------------------------------------------------------- //
173 // PARENTINDEFAULTSPACE
174 // --------------------------------------------------------------------- //
182 EXECIR_API
184
190 EXECIR_API
191 UsdAttribute CreateParentInDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192
193public:
194 // --------------------------------------------------------------------- //
195 // OUTSPACE
196 // --------------------------------------------------------------------- //
204 EXECIR_API
206
212 EXECIR_API
213 UsdAttribute CreateOutSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
214
215public:
216 // --------------------------------------------------------------------- //
217 // OUTDEFAULTSPACE
218 // --------------------------------------------------------------------- //
226 EXECIR_API
228
234 EXECIR_API
235 UsdAttribute CreateOutDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236
237public:
238 // --------------------------------------------------------------------- //
239 // INDEFAULTSPACE
240 // --------------------------------------------------------------------- //
248 EXECIR_API
250
256 EXECIR_API
257 UsdAttribute CreateInDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
258
259public:
260 // --------------------------------------------------------------------- //
261 // INTX
262 // --------------------------------------------------------------------- //
270 EXECIR_API
272
278 EXECIR_API
279 UsdAttribute CreateInTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
280
281public:
282 // --------------------------------------------------------------------- //
283 // INTY
284 // --------------------------------------------------------------------- //
292 EXECIR_API
294
300 EXECIR_API
301 UsdAttribute CreateInTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
302
303public:
304 // --------------------------------------------------------------------- //
305 // INTZ
306 // --------------------------------------------------------------------- //
314 EXECIR_API
316
322 EXECIR_API
323 UsdAttribute CreateInTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
324
325public:
326 // --------------------------------------------------------------------- //
327 // INRX
328 // --------------------------------------------------------------------- //
336 EXECIR_API
338
344 EXECIR_API
345 UsdAttribute CreateInRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
346
347public:
348 // --------------------------------------------------------------------- //
349 // INRY
350 // --------------------------------------------------------------------- //
358 EXECIR_API
360
366 EXECIR_API
367 UsdAttribute CreateInRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
368
369public:
370 // --------------------------------------------------------------------- //
371 // INRZ
372 // --------------------------------------------------------------------- //
380 EXECIR_API
382
388 EXECIR_API
389 UsdAttribute CreateInRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
390
391public:
392 // --------------------------------------------------------------------- //
393 // INRSPIN
394 // --------------------------------------------------------------------- //
402 EXECIR_API
404
410 EXECIR_API
411 UsdAttribute CreateInRspinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
412
413public:
414 // --------------------------------------------------------------------- //
415 // INROTATIONORDER
416 // --------------------------------------------------------------------- //
425 EXECIR_API
427
433 EXECIR_API
434 UsdAttribute CreateInRotationOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
435
436public:
437 // ===================================================================== //
438 // Feel free to add custom code below this line, it will be preserved by
439 // the code generator.
440 //
441 // Just remember to:
442 // - Close the class declaration with };
443 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
444 // - Close the include guard with #endif
445 // ===================================================================== //
446 // --(BEGIN CUSTOM CODE)--
447};
448
449PXR_NAMESPACE_CLOSE_SCOPE
450
451#endif
A simple invertible FK controller.
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...
EXECIR_API UsdAttribute CreateOutSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOutSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateInTxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInTxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetInRxAttr() const
ExecIrFkController(const UsdSchemaBase &schemaObj)
Construct a ExecIrFkController on the prim held by schemaObj .
EXECIR_API UsdAttribute CreateParentInDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParentInDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Cre...
EXECIR_API UsdAttribute CreateInRyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInRyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetInRspinAttr() const
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
ExecIrFkController(const UsdPrim &prim=UsdPrim())
Construct a ExecIrFkController on UsdPrim prim .
EXECIR_API UsdAttribute GetInRotationOrderAttr() const
EXECIR_API UsdAttribute CreateInRxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInRxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateInRspinAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInRspinAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateInTyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInTyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static EXECIR_API ExecIrFkController 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 GetInRyAttr() const
static EXECIR_API ExecIrFkController Get(const UsdStagePtr &stage, const SdfPath &path)
Return a ExecIrFkController holding the prim adhering to this schema at path on stage.
EXECIR_API UsdAttribute GetInTxAttr() const
EXECIR_API UsdAttribute CreateInRzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInRzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetInTyAttr() const
EXECIR_API UsdAttribute GetParentInSpaceAttr() const
EXECIR_API UsdAttribute GetOutDefaultSpaceAttr() const
virtual EXECIR_API ~ExecIrFkController()
Destructor.
EXECIR_API UsdAttribute GetOutSpaceAttr() const
EXECIR_API UsdAttribute CreateInTzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInTzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetInRzAttr() const
EXECIR_API UsdAttribute GetInDefaultSpaceAttr() const
EXECIR_API UsdAttribute GetParentInDefaultSpaceAttr() const
EXECIR_API UsdAttribute CreateOutDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetOutDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateParentInSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParentInSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
EXECIR_API UsdAttribute CreateInRotationOrderAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInRotationOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateInDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetInTzAttr() const
An abstract schema that represents an invertible controller.
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