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
71{
72public:
77
82 explicit ExecIrXformable(const UsdPrim& prim=UsdPrim())
83 : UsdTyped(prim)
84 {
85 }
86
90 explicit ExecIrXformable(const UsdSchemaBase& schemaObj)
91 : UsdTyped(schemaObj)
92 {
93 }
94
96 EXECIR_API
98
102 EXECIR_API
103 static const TfTokenVector &
104 GetSchemaAttributeNames(bool includeInherited=true);
105
115 EXECIR_API
116 static ExecIrXformable
117 Get(const UsdStagePtr &stage, const SdfPath &path);
118
119
120protected:
124 EXECIR_API
126
127private:
128 // needs to invoke _GetStaticTfType.
129 friend class UsdSchemaRegistry;
130 EXECIR_API
131 static const TfType &_GetStaticTfType();
132
133 static bool _IsTypedSchema();
134
135 // override SchemaBase virtuals.
136 EXECIR_API
137 const TfType &_GetTfType() const override;
138
139public:
140 // --------------------------------------------------------------------- //
141 // RESTTX
142 // --------------------------------------------------------------------- //
150 EXECIR_API
152
158 EXECIR_API
159 UsdAttribute CreateRestTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
160
161public:
162 // --------------------------------------------------------------------- //
163 // RESTTY
164 // --------------------------------------------------------------------- //
172 EXECIR_API
174
180 EXECIR_API
181 UsdAttribute CreateRestTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182
183public:
184 // --------------------------------------------------------------------- //
185 // RESTTZ
186 // --------------------------------------------------------------------- //
194 EXECIR_API
196
202 EXECIR_API
203 UsdAttribute CreateRestTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204
205public:
206 // --------------------------------------------------------------------- //
207 // RESTRX
208 // --------------------------------------------------------------------- //
216 EXECIR_API
218
224 EXECIR_API
225 UsdAttribute CreateRestRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
226
227public:
228 // --------------------------------------------------------------------- //
229 // RESTRY
230 // --------------------------------------------------------------------- //
238 EXECIR_API
240
246 EXECIR_API
247 UsdAttribute CreateRestRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
248
249public:
250 // --------------------------------------------------------------------- //
251 // RESTRZ
252 // --------------------------------------------------------------------- //
260 EXECIR_API
262
268 EXECIR_API
269 UsdAttribute CreateRestRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
270
271public:
272 // --------------------------------------------------------------------- //
273 // RESTSPACE
274 // --------------------------------------------------------------------- //
282 EXECIR_API
284
290 EXECIR_API
291 UsdAttribute CreateRestSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
292
293public:
294 // --------------------------------------------------------------------- //
295 // DEFAULTTX
296 // --------------------------------------------------------------------- //
304 EXECIR_API
306
312 EXECIR_API
313 UsdAttribute CreateDefaultTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
314
315public:
316 // --------------------------------------------------------------------- //
317 // DEFAULTTY
318 // --------------------------------------------------------------------- //
326 EXECIR_API
328
334 EXECIR_API
335 UsdAttribute CreateDefaultTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
336
337public:
338 // --------------------------------------------------------------------- //
339 // DEFAULTTZ
340 // --------------------------------------------------------------------- //
348 EXECIR_API
350
356 EXECIR_API
357 UsdAttribute CreateDefaultTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
358
359public:
360 // --------------------------------------------------------------------- //
361 // DEFAULTRX
362 // --------------------------------------------------------------------- //
370 EXECIR_API
372
378 EXECIR_API
379 UsdAttribute CreateDefaultRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
380
381public:
382 // --------------------------------------------------------------------- //
383 // DEFAULTRY
384 // --------------------------------------------------------------------- //
392 EXECIR_API
394
400 EXECIR_API
401 UsdAttribute CreateDefaultRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
402
403public:
404 // --------------------------------------------------------------------- //
405 // DEFAULTRZ
406 // --------------------------------------------------------------------- //
414 EXECIR_API
416
422 EXECIR_API
423 UsdAttribute CreateDefaultRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
424
425public:
426 // --------------------------------------------------------------------- //
427 // DEFAULTSPACE
428 // --------------------------------------------------------------------- //
436 EXECIR_API
438
444 EXECIR_API
445 UsdAttribute CreateDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
446
447public:
448 // --------------------------------------------------------------------- //
449 // POSEDSPACE
450 // --------------------------------------------------------------------- //
458 EXECIR_API
460
466 EXECIR_API
467 UsdAttribute CreatePosedSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
468
469public:
470 // --------------------------------------------------------------------- //
471 // POSEDDEFAULTSPACE
472 // --------------------------------------------------------------------- //
480 EXECIR_API
482
488 EXECIR_API
489 UsdAttribute CreatePosedDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
490
491public:
492 // --------------------------------------------------------------------- //
493 // AVARSTX
494 // --------------------------------------------------------------------- //
502 EXECIR_API
504
510 EXECIR_API
511 UsdAttribute CreateAvarsTxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
512
513public:
514 // --------------------------------------------------------------------- //
515 // AVARSTY
516 // --------------------------------------------------------------------- //
524 EXECIR_API
526
532 EXECIR_API
533 UsdAttribute CreateAvarsTyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
534
535public:
536 // --------------------------------------------------------------------- //
537 // AVARSTZ
538 // --------------------------------------------------------------------- //
546 EXECIR_API
548
554 EXECIR_API
555 UsdAttribute CreateAvarsTzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
556
557public:
558 // --------------------------------------------------------------------- //
559 // AVARSRX
560 // --------------------------------------------------------------------- //
568 EXECIR_API
570
576 EXECIR_API
577 UsdAttribute CreateAvarsRxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
578
579public:
580 // --------------------------------------------------------------------- //
581 // AVARSRY
582 // --------------------------------------------------------------------- //
590 EXECIR_API
592
598 EXECIR_API
599 UsdAttribute CreateAvarsRyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
600
601public:
602 // --------------------------------------------------------------------- //
603 // AVARSRZ
604 // --------------------------------------------------------------------- //
612 EXECIR_API
614
620 EXECIR_API
621 UsdAttribute CreateAvarsRzAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
622
623public:
624 // --------------------------------------------------------------------- //
625 // AVARSRSPIN
626 // --------------------------------------------------------------------- //
634 EXECIR_API
636
642 EXECIR_API
643 UsdAttribute CreateAvarsRspinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
644
645public:
646 // --------------------------------------------------------------------- //
647 // AVARSROTATIONORDER
648 // --------------------------------------------------------------------- //
657 EXECIR_API
659
665 EXECIR_API
666 UsdAttribute CreateAvarsRotationOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
667
668public:
669 // --------------------------------------------------------------------- //
670 // AVARSDEFAULTSPACE
671 // --------------------------------------------------------------------- //
679 EXECIR_API
681
687 EXECIR_API
688 UsdAttribute CreateAvarsDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
689
690public:
691 // --------------------------------------------------------------------- //
692 // AVARSUNITSCALEFACTOR
693 // --------------------------------------------------------------------- //
701 EXECIR_API
703
709 EXECIR_API
710 UsdAttribute CreateAvarsUnitScaleFactorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
711
712public:
713 // --------------------------------------------------------------------- //
714 // PARENTSPACE
715 // --------------------------------------------------------------------- //
723 EXECIR_API
725
731 EXECIR_API
732 UsdAttribute CreateParentSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
733
734public:
735 // --------------------------------------------------------------------- //
736 // PARENTDEFAULTSPACE
737 // --------------------------------------------------------------------- //
745 EXECIR_API
747
753 EXECIR_API
754 UsdAttribute CreateParentDefaultSpaceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
755
756public:
757 // ===================================================================== //
758 // Feel free to add custom code below this line, it will be preserved by
759 // the code generator.
760 //
761 // Just remember to:
762 // - Close the class declaration with };
763 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
764 // - Close the include guard with #endif
765 // ===================================================================== //
766 // --(BEGIN CUSTOM CODE)--
767};
768
769PXR_NAMESPACE_CLOSE_SCOPE
770
771#endif
An abstract schema that provides an animation interface for an animatable coordinate space.
Definition xformable.h:71
EXECIR_API UsdAttribute GetDefaultSpaceAttr() const
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:76
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
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
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
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:90
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
ExecIrXformable(const UsdPrim &prim=UsdPrim())
Construct a ExecIrXformable on UsdPrim prim .
Definition xformable.h:82
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
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