ExecIrXformable Class Reference

An abstract schema that provides an animation interface for an animatable coordinate space. More...

#include <xformable.h>

Inheritance diagram for ExecIrXformable:

Public Member Functions
	ExecIrXformable (const UsdPrim &prim=UsdPrim())
	Construct a ExecIrXformable on UsdPrim prim .
	ExecIrXformable (const UsdSchemaBase &schemaObj)
	Construct a ExecIrXformable on the prim held by schemaObj .
virtual EXECIR_API	~ExecIrXformable ()
	Destructor.
EXECIR_API UsdAttribute	GetRestTxAttr () 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	GetRestTyAttr () const
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	GetRestTzAttr () const
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	GetRestRxAttr () const
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	GetRestRyAttr () const
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	GetRestRzAttr () const
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	GetRestSpaceAttr () const
	A local-to-world space transform representing the position of this object before any posing has happened.
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	GetDefaultTxAttr () const
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.
EXECIR_API UsdAttribute	GetDefaultTyAttr () 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	GetDefaultTzAttr () const
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	GetDefaultRxAttr () 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	GetDefaultRyAttr () 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	GetDefaultRzAttr () 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	GetDefaultSpaceAttr () const
	A local-to-world space transform representing the "zero" position for posing.
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	GetPosedSpaceAttr () 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
	Default space as computed by the controller network.
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	GetAvarsTxAttr () 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	GetAvarsTyAttr () const
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	GetAvarsTzAttr () const
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	GetAvarsRxAttr () 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	GetAvarsRyAttr () const
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 UsdAttribute	GetAvarsRzAttr () 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	GetAvarsRspinAttr () const
	The rotation avar that gets zeroed out when solving for rotation values.
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	GetAvarsRotationOrderAttr () const
	The rotation order for computing the posed space from the scalar rotate avars.
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 Create.
EXECIR_API UsdAttribute	GetAvarsDefaultSpaceAttr () const
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	GetAvarsUnitScaleFactorAttr () const
	Size of a canonical unit.
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 Create.
EXECIR_API UsdAttribute	GetParentSpaceAttr () 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.
EXECIR_API UsdAttribute	GetParentDefaultSpaceAttr () const
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 Create.
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	Construct a UsdTyped on UsdPrim prim .
	UsdTyped (const UsdSchemaBase &schemaObj)
	Construct a UsdTyped on the prim held by schemaObj .
virtual USD_API	~UsdTyped ()
	Destructor.
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.
bool	IsAPISchema () const
	Returns whether this is an API schema or not.
bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.
bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim.
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema.
virtual USD_API	~UsdSchemaBase ()
	Destructor.
UsdPrim	GetPrim () const
	Return this schema object's held prim.
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.
USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
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 classes.
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.
Static Public Member Functions inherited from UsdTyped
static USD_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 classes.
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdTyped holding the prim adhering to this schema at path on stage.
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
EXECIR_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
Protected Member Functions inherited from UsdTyped
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.
Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const
const TfType &	_GetType () const
USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Detailed Description

An abstract schema that provides an animation interface for an animatable coordinate space.

Warning

The functionality provided by this schema is very limited, subject to change, and not yet ready for production use.

ExecIrXformable defines scalar avars that produce rest and default spaces that are meant to be fed into a controller that computes a posed space that feeds back into the IrXformable posed space attribute. In this way, ExecIrXformables act as the interface for a controller network, providing the input avars where animation is authored and the resulting computed outputs that can be used to drive model posing.

Spaces

Rest Space: A local-to-world space transform representing the position of the transformable object "at rest," generally meaning before any posing has happened. This can be thought of as a "bind pose" for deformation. Deformations use the local difference between restSpace and posedSpace to deform the model. Note that rest space is always orthonormalized.

Default Space: A local-to-world space transform that represents the "zero" position for posing. This may be different from the rest pose in order to provide default scaling for a character, to make variants, or to set a more natural starting place for animation controls. The default space is passed to controllers to be used as the 'start pose'.

Posed Space: The final world space transform, after posing. This is generally the computed result of some set of controllers that define the pose (IK, FK, etc.).

Connecting to controllers

The intended use is for an ExecIrXformable to be posed by one or more ExecIrControllers that compute its posed space. One or more ExecIrControllers connect to one or more of the avars in the 'avars' namespace, compute a posed space, and then supply that to the 'posed:space' attribute. Note that without an external controller, the avars under the 'avars:' namespace don't do anything. In that case, the ExecIrXformable will fall back to following the parent's posed space (including the local rest and default offsets).

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in ExecIrTokens. So to set an attribute to the value "rightHanded", use ExecIrTokens->rightHanded as the value.

Definition at line 89 of file xformable.h.

Constructor & Destructor Documentation

ExecIrXformable() [1/2]

ExecIrXformable ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a ExecIrXformable on UsdPrim prim .

Equivalent to ExecIrXformable::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 101 of file xformable.h.

ExecIrXformable() [2/2]

ExecIrXformable ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a ExecIrXformable on the prim held by schemaObj .

Should be preferred over ExecIrXformable(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 109 of file xformable.h.

~ExecIrXformable()

virtual EXECIR_API ~ExecIrXformable ( )

virtual

Destructor.

Member Function Documentation

_GetSchemaKind()

EXECIR_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

Reimplemented from UsdSchemaBase.

CreateAvarsDefaultSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsRotationOrderAttr()

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 Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsRspinAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsRxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsRyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsRzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsTxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsTyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsTzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateAvarsUnitScaleFactorAttr()

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 Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultRxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultRyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultRzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultTxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultTyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateDefaultTzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateParentDefaultSpaceAttr()

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 Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateParentSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreatePosedDefaultSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreatePosedSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestRxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestRyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestRzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestSpaceAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestTxAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestTyAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

CreateRestTzAttr()

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.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

Get()

static EXECIR_API ExecIrXformable Get ( const UsdStagePtr & stage, const SdfPath & path )

static

Return a ExecIrXformable holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

ExecIrXformable(stage->GetPrimAtPath(path));

GetAvarsDefaultSpaceAttr()

EXECIR_API UsdAttribute GetAvarsDefaultSpaceAttr

(

)

const

Declaration	matrix4d avars:defaultSpace = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetAvarsRotationOrderAttr()

EXECIR_API UsdAttribute GetAvarsRotationOrderAttr

(

)

const

The rotation order for computing the posed space from the scalar rotate avars.

Note that this does not affect the rotation order for rest or default space.

Declaration	token avars:rotationOrder = "XYZ"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	XYZ, XZY, YXZ, YZX, ZXY, ZYX

GetAvarsRspinAttr()

EXECIR_API UsdAttribute GetAvarsRspinAttr

(

)

const

The rotation avar that gets zeroed out when solving for rotation values.

Declaration	double avars:rspin = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsRxAttr()

EXECIR_API UsdAttribute GetAvarsRxAttr

(

)

const

Declaration	double avars:rx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsRyAttr()

EXECIR_API UsdAttribute GetAvarsRyAttr

(

)

const

Declaration	double avars:ry = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsRzAttr()

EXECIR_API UsdAttribute GetAvarsRzAttr

(

)

const

Declaration	double avars:rz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsTxAttr()

EXECIR_API UsdAttribute GetAvarsTxAttr

(

)

const

Declaration	double avars:tx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsTyAttr()

EXECIR_API UsdAttribute GetAvarsTyAttr

(

)

const

Declaration	double avars:ty = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsTzAttr()

EXECIR_API UsdAttribute GetAvarsTzAttr

(

)

const

Declaration	double avars:tz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetAvarsUnitScaleFactorAttr()

EXECIR_API UsdAttribute GetAvarsUnitScaleFactorAttr

(

)

const

Size of a canonical unit.

This value is used by various controllers to preserve scale independence. For example, translating by 1.0 will move this far in world space.

Declaration	double avars:unitScaleFactor = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultRxAttr()

EXECIR_API UsdAttribute GetDefaultRxAttr

(

)

const

Declaration	double default:rx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultRyAttr()

EXECIR_API UsdAttribute GetDefaultRyAttr

(

)

const

Declaration	double default:ry = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultRzAttr()

EXECIR_API UsdAttribute GetDefaultRzAttr

(

)

const

Declaration	double default:rz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultSpaceAttr()

EXECIR_API UsdAttribute GetDefaultSpaceAttr

(

)

const

A local-to-world space transform representing the "zero" position for posing.

This may be different from rest space in order to provide default scaling for a character, to make variants, or to set a more natural starting place for animation controls. Combines the effect of the local transform defined by the 'default:' scalars with the rest space offset.

Declaration	matrix4d default:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetDefaultTxAttr()

EXECIR_API UsdAttribute GetDefaultTxAttr

(

)

const

Declaration	double default:tx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultTyAttr()

EXECIR_API UsdAttribute GetDefaultTyAttr

(

)

const

Declaration	double default:ty = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetDefaultTzAttr()

EXECIR_API UsdAttribute GetDefaultTzAttr

(

)

const

Declaration	double default:tz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetParentDefaultSpaceAttr()

EXECIR_API UsdAttribute GetParentDefaultSpaceAttr

(

)

const

Declaration	matrix4d parent:defaultSpace = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetParentSpaceAttr()

EXECIR_API UsdAttribute GetParentSpaceAttr

(

)

const

Declaration	matrix4d parent:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetPosedDefaultSpaceAttr()

EXECIR_API UsdAttribute GetPosedDefaultSpaceAttr

(

)

const

Default space as computed by the controller network.

This is almost always identical to 'default:space', except for unusual cases where the control network wants to affect the default space (as in re-rooting).

Declaration	matrix4d posed:defaultSpace = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetPosedSpaceAttr()

EXECIR_API UsdAttribute GetPosedSpaceAttr

(

)

const

Declaration	matrix4d posed:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetRestRxAttr()

EXECIR_API UsdAttribute GetRestRxAttr

(

)

const

Declaration	double rest:rx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetRestRyAttr()

EXECIR_API UsdAttribute GetRestRyAttr

(

)

const

Declaration	double rest:ry = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetRestRzAttr()

EXECIR_API UsdAttribute GetRestRzAttr

(

)

const

Declaration	double rest:rz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetRestSpaceAttr()

EXECIR_API UsdAttribute GetRestSpaceAttr

(

)

const

A local-to-world space transform representing the position of this object before any posing has happened.

The value combines the effect of the scalar 'rest:' attributes to yield a local transform. Rest space inherits from the nearest ExecIrXformable or UsdGeomXformable namespace ancestor.

Declaration	matrix4d rest:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

GetRestTxAttr()

EXECIR_API UsdAttribute GetRestTxAttr

(

)

const

Declaration	double rest:tx = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetRestTyAttr()

EXECIR_API UsdAttribute GetRestTyAttr

(

)

const

Declaration	double rest:ty = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetRestTzAttr()

EXECIR_API UsdAttribute GetRestTzAttr

(

)

const

Declaration	double rest:tz = 0
C++ Type	double
Usd Type	SdfValueTypeNames->Double

GetSchemaAttributeNames()

static EXECIR_API const TfTokenVector & GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Symbol Documentation

UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 148 of file xformable.h.

Member Data Documentation

schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped

static

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaKind

Definition at line 95 of file xformable.h.

---

The documentation for this class was generated from the following file:

• pxr/exec/execIr/xformable.h