UsdSkelAnimation Class Reference

#include <animation.h>

Inheritance diagram for UsdSkelAnimation:

Public Member Functions
	UsdSkelAnimation (const UsdPrim &prim=UsdPrim())
	UsdSkelAnimation (const UsdSchemaBase &schemaObj)
virtual USDSKEL_API	~UsdSkelAnimation ()
	Destructor. More...
USDSKEL_API UsdAttribute	GetJointsAttr () const
USDSKEL_API UsdAttribute	CreateJointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute	GetTranslationsAttr () const
USDSKEL_API UsdAttribute	CreateTranslationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute	GetRotationsAttr () const
USDSKEL_API UsdAttribute	CreateRotationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute	GetScalesAttr () const
USDSKEL_API UsdAttribute	CreateScalesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute	GetBlendShapesAttr () const
USDSKEL_API UsdAttribute	CreateBlendShapesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API UsdAttribute	GetBlendShapeWeightsAttr () const
USDSKEL_API UsdAttribute	CreateBlendShapeWeightsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDSKEL_API bool	GetTransforms (VtMatrix4dArray *xforms, UsdTimeCode time=UsdTimeCode::Default()) const
USDSKEL_API bool	SetTransforms (const VtMatrix4dArray &xforms, UsdTimeCode time=UsdTimeCode::Default()) const
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdTyped ()
	Destructor. More...
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDSKEL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDSKEL_API UsdSkelAnimation	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDSKEL_API UsdSkelAnimation	Define (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDSKEL_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
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

Describes a skel animation, where joint animation is stored in a vectorized form.

See the extended Skel Animation documentation for more information.

Definition at line 62 of file animation.h.

Constructor & Destructor Documentation

UsdSkelAnimation::UsdSkelAnimation ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

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

Definition at line 74 of file animation.h.

UsdSkelAnimation::UsdSkelAnimation ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a UsdSkelAnimation on the prim held by schemaObj . Should be preferred over UsdSkelAnimation(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 82 of file animation.h.

virtual USDSKEL_API UsdSkelAnimation::~UsdSkelAnimation ( )

virtual

Destructor.

Member Function Documentation

USDSKEL_API UsdSchemaKind UsdSkelAnimation::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdTyped.

Reimplemented in UsdSkelPackedJointAnimation.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateBlendShapesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetBlendShapesAttr(), and also Usd_Create_Or_Get_Property 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.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateBlendShapeWeightsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetBlendShapeWeightsAttr(), and also Usd_Create_Or_Get_Property 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.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateJointsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetJointsAttr(), and also Usd_Create_Or_Get_Property 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.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateRotationsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetRotationsAttr(), and also Usd_Create_Or_Get_Property 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.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateScalesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetScalesAttr(), and also Usd_Create_Or_Get_Property 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.

USDSKEL_API UsdAttribute UsdSkelAnimation::CreateTranslationsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetTranslationsAttr(), and also Usd_Create_Or_Get_Property 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.

static USDSKEL_API UsdSkelAnimation UsdSkelAnimation::Define ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDSKEL_API UsdSkelAnimation UsdSkelAnimation::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a UsdSkelAnimation 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:

UsdSkelAnimation(stage->GetPrimAtPath(path));

USDSKEL_API UsdAttribute UsdSkelAnimation::GetBlendShapesAttr

(

)

const

Array of tokens identifying which blend shapes this animation's data applies to. The tokens for blendShapes correspond to the tokens set in the skel:blendShapes binding property of the UsdSkelBindingAPI.

Declaration	uniform token[] blendShapes
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray
Variability	SdfVariabilityUniform

USDSKEL_API UsdAttribute UsdSkelAnimation::GetBlendShapeWeightsAttr

(

)

const

Array of weight values for each blend shape. Each weight value is associated with the corresponding blend shape identified within the blendShapes token array, and therefore must have the same length as *blendShapes.

Declaration	float[] blendShapeWeights
C++ Type	VtArray<float>
Usd Type	SdfValueTypeNames->FloatArray

USDSKEL_API UsdAttribute UsdSkelAnimation::GetJointsAttr

(

)

const

Array of tokens identifying which joints this animation's data applies to. The tokens for joints correspond to the tokens of Skeleton primitives. The order of the joints as listed here may vary from the order of joints on the Skeleton itself.

Declaration	uniform token[] joints
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray
Variability	SdfVariabilityUniform

USDSKEL_API UsdAttribute UsdSkelAnimation::GetRotationsAttr

(

)

const

Joint-local unit quaternion rotations of all affected joints, in 32-bit precision. Array length should match the size of the joints attribute.

Declaration	quatf[] rotations
C++ Type	VtArray<GfQuatf>
Usd Type	SdfValueTypeNames->QuatfArray

USDSKEL_API UsdAttribute UsdSkelAnimation::GetScalesAttr

(

)

const

Joint-local scales of all affected joints, in 16 bit precision. Array length should match the size of the joints attribute.

Declaration	half3[] scales
C++ Type	VtArray<GfVec3h>
Usd Type	SdfValueTypeNames->Half3Array

static USDSKEL_API const TfTokenVector& UsdSkelAnimation::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.

USDSKEL_API bool UsdSkelAnimation::GetTransforms	(	VtMatrix4dArray *	xforms,
		UsdTimeCode	time = UsdTimeCode::Default()
	)		const

Convenience method for querying resolved transforms at time. Note that it is more efficient to query transforms through UsdSkelAnimQuery or UsdSkelSkeletonQuery.

USDSKEL_API UsdAttribute UsdSkelAnimation::GetTranslationsAttr

(

)

const

Joint-local translations of all affected joints. Array length should match the size of the joints attribute.

Declaration	float3[] translations
C++ Type	VtArray<GfVec3f>
Usd Type	SdfValueTypeNames->Float3Array

USDSKEL_API bool UsdSkelAnimation::SetTransforms	(	const VtMatrix4dArray &	xforms,
		UsdTimeCode	time = UsdTimeCode::Default()
	)		const

Convenience method for setting an array of transforms. The given transforms must be orthogonal.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 146 of file animation.h.

Member Data Documentation

const UsdSchemaKind UsdSkelAnimation::schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also

UsdSchemaKind

Definition at line 68 of file animation.h.

---

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

• pxr/usd/usdSkel/animation.h