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
69{
70public:
75
80 explicit ExecIrFkController(const UsdPrim& prim=UsdPrim())
81 : ExecIrController(prim)
82 {
83 }
84
88 explicit ExecIrFkController(const UsdSchemaBase& schemaObj)
89 : ExecIrController(schemaObj)
90 {
91 }
92
94 EXECIR_API
96
100 EXECIR_API
101 static const TfTokenVector &
102 GetSchemaAttributeNames(bool includeInherited=true);
103
113 EXECIR_API
114 static ExecIrFkController
115 Get(const UsdStagePtr &stage, const SdfPath &path);
116
139 EXECIR_API
140 static ExecIrFkController
141 Define(const UsdStagePtr &stage, const SdfPath &path);
142
143protected:
147 EXECIR_API
149
150private:
151 // needs to invoke _GetStaticTfType.
152 friend class UsdSchemaRegistry;
153 EXECIR_API
154 static const TfType &_GetStaticTfType();
155
156 static bool _IsTypedSchema();
157
158 // override SchemaBase virtuals.
159 EXECIR_API
160 const TfType &_GetTfType() const override;
161
162public:
163 // --------------------------------------------------------------------- //
164 // PARENTINSPACE
165 // --------------------------------------------------------------------- //
176 EXECIR_API
178
184 EXECIR_API
185 UsdAttribute CreateParentInSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186
187public:
188 // --------------------------------------------------------------------- //
189 // PARENTINDEFAULTSPACE
190 // --------------------------------------------------------------------- //
201 EXECIR_API
203
209 EXECIR_API
210 UsdAttribute CreateParentInDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211
212public:
213 // --------------------------------------------------------------------- //
214 // OUTSPACE
215 // --------------------------------------------------------------------- //
226 EXECIR_API
228
234 EXECIR_API
235 UsdAttribute CreateOutSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236
237public:
238 // --------------------------------------------------------------------- //
239 // OUTDEFAULTSPACE
240 // --------------------------------------------------------------------- //
250 EXECIR_API
252
258 EXECIR_API
259 UsdAttribute CreateOutDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
260
261public:
262 // --------------------------------------------------------------------- //
263 // INDEFAULTSPACE
264 // --------------------------------------------------------------------- //
275 EXECIR_API
277
283 EXECIR_API
284 UsdAttribute CreateInDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285
286public:
287 // --------------------------------------------------------------------- //
288 // INTX
289 // --------------------------------------------------------------------- //
297 EXECIR_API
299
305 EXECIR_API
306 UsdAttribute CreateInTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
307
308public:
309 // --------------------------------------------------------------------- //
310 // INTY
311 // --------------------------------------------------------------------- //
319 EXECIR_API
321
327 EXECIR_API
328 UsdAttribute CreateInTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
329
330public:
331 // --------------------------------------------------------------------- //
332 // INTZ
333 // --------------------------------------------------------------------- //
341 EXECIR_API
343
349 EXECIR_API
350 UsdAttribute CreateInTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
351
352public:
353 // --------------------------------------------------------------------- //
354 // INRX
355 // --------------------------------------------------------------------- //
363 EXECIR_API
365
371 EXECIR_API
372 UsdAttribute CreateInRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
373
374public:
375 // --------------------------------------------------------------------- //
376 // INRY
377 // --------------------------------------------------------------------- //
385 EXECIR_API
387
393 EXECIR_API
394 UsdAttribute CreateInRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
395
396public:
397 // --------------------------------------------------------------------- //
398 // INRZ
399 // --------------------------------------------------------------------- //
407 EXECIR_API
409
415 EXECIR_API
416 UsdAttribute CreateInRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
417
418public:
419 // --------------------------------------------------------------------- //
420 // INRSPIN
421 // --------------------------------------------------------------------- //
432 EXECIR_API
434
440 EXECIR_API
441 UsdAttribute CreateInRspinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
442
443public:
444 // --------------------------------------------------------------------- //
445 // INROTATIONORDER
446 // --------------------------------------------------------------------- //
455 EXECIR_API
457
463 EXECIR_API
464 UsdAttribute CreateInRotationOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
465
466public:
467 // ===================================================================== //
468 // Feel free to add custom code below this line, it will be preserved by
469 // the code generator.
470 //
471 // Just remember to:
472 // - Close the class declaration with };
473 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
474 // - Close the include guard with #endif
475 // ===================================================================== //
476 // --(BEGIN CUSTOM CODE)--
477};
478
479PXR_NAMESPACE_CLOSE_SCOPE
480
481#endif
An abstract schema that represents an invertible controller.
Definition controller.h:51
A simple invertible controller that computes a forward kinematic transform.
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
The rotation attribute that gets zeroed out when solving for rotation values.
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
If the FK controller has a parent controller, this attribute takes the parent's posed space as input.
EXECIR_API UsdAttribute GetOutDefaultSpaceAttr() const
Passes through the value of the 'in:defaultSpace' attribute.
virtual EXECIR_API ~ExecIrFkController()
Destructor.
EXECIR_API UsdAttribute GetOutSpaceAttr() const
A 4x4 matrix that represents the computed output space produced by the controller.
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
A local-to-world space transform representing the "zero" position for posing.
EXECIR_API UsdAttribute GetParentInDefaultSpaceAttr() const
If the FK controller has a parent controller, this attribute takes the parent's default space as inpu...
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
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