Loading...
Searching...
No Matches
xformable.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_XFORMABLE_H
8#define EXECIR_GENERATED_XFORMABLE_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/exec/execIr/api.h"
14#include "pxr/usd/usd/typed.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// IRXFORMABLE //
34// -------------------------------------------------------------------------- //
35
90{
91public:
96
101 explicit ExecIrXformable(const UsdPrim& prim=UsdPrim())
102 : UsdTyped(prim)
103 {
104 }
105
109 explicit ExecIrXformable(const UsdSchemaBase& schemaObj)
110 : UsdTyped(schemaObj)
111 {
112 }
113
115 EXECIR_API
117
121 EXECIR_API
122 static const TfTokenVector &
123 GetSchemaAttributeNames(bool includeInherited=true);
124
134 EXECIR_API
135 static ExecIrXformable
136 Get(const UsdStagePtr &stage, const SdfPath &path);
137
138
139protected:
143 EXECIR_API
145
146private:
147 // needs to invoke _GetStaticTfType.
148 friend class UsdSchemaRegistry;
149 EXECIR_API
150 static const TfType &_GetStaticTfType();
151
152 static bool _IsTypedSchema();
153
154 // override SchemaBase virtuals.
155 EXECIR_API
156 const TfType &_GetTfType() const override;
157
158public:
159 // --------------------------------------------------------------------- //
160 // RESTTX
161 // --------------------------------------------------------------------- //
169 EXECIR_API
171
177 EXECIR_API
178 UsdAttribute CreateRestTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179
180public:
181 // --------------------------------------------------------------------- //
182 // RESTTY
183 // --------------------------------------------------------------------- //
191 EXECIR_API
193
199 EXECIR_API
200 UsdAttribute CreateRestTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
201
202public:
203 // --------------------------------------------------------------------- //
204 // RESTTZ
205 // --------------------------------------------------------------------- //
213 EXECIR_API
215
221 EXECIR_API
222 UsdAttribute CreateRestTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
223
224public:
225 // --------------------------------------------------------------------- //
226 // RESTRX
227 // --------------------------------------------------------------------- //
235 EXECIR_API
237
243 EXECIR_API
244 UsdAttribute CreateRestRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
245
246public:
247 // --------------------------------------------------------------------- //
248 // RESTRY
249 // --------------------------------------------------------------------- //
257 EXECIR_API
259
265 EXECIR_API
266 UsdAttribute CreateRestRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
267
268public:
269 // --------------------------------------------------------------------- //
270 // RESTRZ
271 // --------------------------------------------------------------------- //
279 EXECIR_API
281
287 EXECIR_API
288 UsdAttribute CreateRestRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
289
290public:
291 // --------------------------------------------------------------------- //
292 // RESTSPACE
293 // --------------------------------------------------------------------- //
308 EXECIR_API
310
316 EXECIR_API
317 UsdAttribute CreateRestSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
318
319public:
320 // --------------------------------------------------------------------- //
321 // DEFAULTTX
322 // --------------------------------------------------------------------- //
330 EXECIR_API
332
338 EXECIR_API
339 UsdAttribute CreateDefaultTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
340
341public:
342 // --------------------------------------------------------------------- //
343 // DEFAULTTY
344 // --------------------------------------------------------------------- //
352 EXECIR_API
354
360 EXECIR_API
361 UsdAttribute CreateDefaultTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
362
363public:
364 // --------------------------------------------------------------------- //
365 // DEFAULTTZ
366 // --------------------------------------------------------------------- //
374 EXECIR_API
376
382 EXECIR_API
383 UsdAttribute CreateDefaultTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
384
385public:
386 // --------------------------------------------------------------------- //
387 // DEFAULTRX
388 // --------------------------------------------------------------------- //
396 EXECIR_API
398
404 EXECIR_API
405 UsdAttribute CreateDefaultRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
406
407public:
408 // --------------------------------------------------------------------- //
409 // DEFAULTRY
410 // --------------------------------------------------------------------- //
418 EXECIR_API
420
426 EXECIR_API
427 UsdAttribute CreateDefaultRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
428
429public:
430 // --------------------------------------------------------------------- //
431 // DEFAULTRZ
432 // --------------------------------------------------------------------- //
440 EXECIR_API
442
448 EXECIR_API
449 UsdAttribute CreateDefaultRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
450
451public:
452 // --------------------------------------------------------------------- //
453 // DEFAULTSPACE
454 // --------------------------------------------------------------------- //
470 EXECIR_API
472
478 EXECIR_API
479 UsdAttribute CreateDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
480
481public:
482 // --------------------------------------------------------------------- //
483 // POSEDSPACE
484 // --------------------------------------------------------------------- //
492 EXECIR_API
494
500 EXECIR_API
501 UsdAttribute CreatePosedSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
502
503public:
504 // --------------------------------------------------------------------- //
505 // POSEDDEFAULTSPACE
506 // --------------------------------------------------------------------- //
520 EXECIR_API
522
528 EXECIR_API
529 UsdAttribute CreatePosedDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
530
531public:
532 // --------------------------------------------------------------------- //
533 // AVARSTX
534 // --------------------------------------------------------------------- //
542 EXECIR_API
544
550 EXECIR_API
551 UsdAttribute CreateAvarsTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
552
553public:
554 // --------------------------------------------------------------------- //
555 // AVARSTY
556 // --------------------------------------------------------------------- //
564 EXECIR_API
566
572 EXECIR_API
573 UsdAttribute CreateAvarsTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
574
575public:
576 // --------------------------------------------------------------------- //
577 // AVARSTZ
578 // --------------------------------------------------------------------- //
586 EXECIR_API
588
594 EXECIR_API
595 UsdAttribute CreateAvarsTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
596
597public:
598 // --------------------------------------------------------------------- //
599 // AVARSRX
600 // --------------------------------------------------------------------- //
608 EXECIR_API
610
616 EXECIR_API
617 UsdAttribute CreateAvarsRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
618
619public:
620 // --------------------------------------------------------------------- //
621 // AVARSRY
622 // --------------------------------------------------------------------- //
630 EXECIR_API
632
638 EXECIR_API
639 UsdAttribute CreateAvarsRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
640
641public:
642 // --------------------------------------------------------------------- //
643 // AVARSRZ
644 // --------------------------------------------------------------------- //
652 EXECIR_API
654
660 EXECIR_API
661 UsdAttribute CreateAvarsRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
662
663public:
664 // --------------------------------------------------------------------- //
665 // AVARSRSPIN
666 // --------------------------------------------------------------------- //
676 EXECIR_API
678
684 EXECIR_API
685 UsdAttribute CreateAvarsRspinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
686
687public:
688 // --------------------------------------------------------------------- //
689 // AVARSROTATIONORDER
690 // --------------------------------------------------------------------- //
705 EXECIR_API
707
713 EXECIR_API
714 UsdAttribute CreateAvarsRotationOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
715
716public:
717 // --------------------------------------------------------------------- //
718 // AVARSDEFAULTSPACE
719 // --------------------------------------------------------------------- //
727 EXECIR_API
729
735 EXECIR_API
736 UsdAttribute CreateAvarsDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
737
738public:
739 // --------------------------------------------------------------------- //
740 // AVARSUNITSCALEFACTOR
741 // --------------------------------------------------------------------- //
754 EXECIR_API
756
762 EXECIR_API
763 UsdAttribute CreateAvarsUnitScaleFactorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
764
765public:
766 // --------------------------------------------------------------------- //
767 // PARENTSPACE
768 // --------------------------------------------------------------------- //
776 EXECIR_API
778
784 EXECIR_API
785 UsdAttribute CreateParentSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
786
787public:
788 // --------------------------------------------------------------------- //
789 // PARENTDEFAULTSPACE
790 // --------------------------------------------------------------------- //
798 EXECIR_API
800
806 EXECIR_API
807 UsdAttribute CreateParentDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
808
809public:
810 // ===================================================================== //
811 // Feel free to add custom code below this line, it will be preserved by
812 // the code generator.
813 //
814 // Just remember to:
815 // - Close the class declaration with };
816 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
817 // - Close the include guard with #endif
818 // ===================================================================== //
819 // --(BEGIN CUSTOM CODE)--
820};
821
822PXR_NAMESPACE_CLOSE_SCOPE
823
824#endif
An abstract schema that provides an animation interface for an animatable coordinate space.
Definition xformable.h:90
EXECIR_API UsdAttribute GetDefaultSpaceAttr() const
A local-to-world space transform representing the "zero" position for posing.
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 GetRestRyAttr() const
EXECIR_API UsdAttribute CreateAvarsRotationOrderAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsRotationOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Creat...
EXECIR_API UsdAttribute GetParentSpaceAttr() const
EXECIR_API UsdAttribute CreateAvarsRzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsRzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetAvarsTzAttr() const
EXECIR_API UsdAttribute GetRestRxAttr() const
EXECIR_API UsdAttribute GetDefaultRxAttr() const
EXECIR_API UsdAttribute CreateDefaultTyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultTyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateDefaultTxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultTxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual EXECIR_API ~ExecIrXformable()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition xformable.h:95
EXECIR_API UsdAttribute CreateDefaultTzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultTzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetAvarsDefaultSpaceAttr() const
EXECIR_API UsdAttribute GetRestTyAttr() const
EXECIR_API UsdAttribute GetPosedSpaceAttr() const
EXECIR_API UsdAttribute CreateRestTxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestTxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetDefaultTxAttr() const
EXECIR_API UsdAttribute GetAvarsRspinAttr() const
The rotation avar that gets zeroed out when solving for rotation values.
EXECIR_API UsdAttribute CreatePosedSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPosedSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetPosedDefaultSpaceAttr() const
Default space as computed by the controller network.
EXECIR_API UsdAttribute CreateParentSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParentSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static EXECIR_API ExecIrXformable Get(const UsdStagePtr &stage, const SdfPath &path)
Return a ExecIrXformable holding the prim adhering to this schema at path on stage.
EXECIR_API UsdAttribute GetDefaultTzAttr() const
EXECIR_API UsdAttribute CreateAvarsRxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsRxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsTzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsTzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateRestRyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestRyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsUnitScaleFactorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsUnitScaleFactorAttr(), and also Create vs Get Property Methods for when to use Get vs Cre...
EXECIR_API UsdAttribute GetDefaultTyAttr() const
EXECIR_API UsdAttribute GetAvarsRotationOrderAttr() const
The rotation order for computing the posed space from the scalar rotate avars.
EXECIR_API UsdAttribute CreateRestSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetParentDefaultSpaceAttr() const
ExecIrXformable(const UsdSchemaBase &schemaObj)
Construct a ExecIrXformable on the prim held by schemaObj .
Definition xformable.h:109
EXECIR_API UsdAttribute CreateParentDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParentDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Creat...
EXECIR_API UsdAttribute GetRestTzAttr() const
EXECIR_API UsdAttribute GetAvarsRxAttr() const
EXECIR_API UsdAttribute GetRestTxAttr() const
EXECIR_API UsdAttribute CreateAvarsTxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsTxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
EXECIR_API UsdAttribute CreateRestTyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestTyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsTyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsTyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateRestRxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestRxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateRestTzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestTzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetAvarsUnitScaleFactorAttr() const
Size of a canonical unit.
ExecIrXformable(const UsdPrim &prim=UsdPrim())
Construct a ExecIrXformable on UsdPrim prim .
Definition xformable.h:101
EXECIR_API UsdAttribute GetAvarsRyAttr() const
EXECIR_API UsdAttribute GetAvarsTxAttr() const
EXECIR_API UsdAttribute GetRestRzAttr() const
EXECIR_API UsdAttribute GetAvarsRzAttr() const
EXECIR_API UsdAttribute CreateDefaultRyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultRyAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreatePosedDefaultSpaceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPosedDefaultSpaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
EXECIR_API UsdAttribute GetRestSpaceAttr() const
A local-to-world space transform representing the position of this object before any posing has happe...
EXECIR_API UsdAttribute GetDefaultRzAttr() const
EXECIR_API UsdAttribute CreateDefaultRxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultRxAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsRspinAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsRspinAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateRestRzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRestRzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute CreateAvarsRyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAvarsRyAttr(), 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 GetDefaultRyAttr() const
EXECIR_API UsdAttribute CreateDefaultRzAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDefaultRzAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
EXECIR_API UsdAttribute GetAvarsTyAttr() 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...
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition typed.h:45
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
@ AbstractTyped
Represents a non-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