#include <animationSchema.h>

Inheritance diagram for UsdSkelImagingAnimationSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetJoints () const

USDSKELIMAGING_API HdVec3fArrayDataSourceHandle	GetTranslations () const

USDSKELIMAGING_API HdQuatfArrayDataSourceHandle	GetRotations () const

USDSKELIMAGING_API HdVec3hArrayDataSourceHandle	GetScales () const

USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetBlendShapes () const

USDSKELIMAGING_API HdFloatArrayDataSourceHandle	GetBlendShapeWeights () const

Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)

HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...

HD_API bool	IsDefined () const

	operator bool () const

Static Public Member Functions
Schema location
static USDSKELIMAGING_API const TfToken &	GetSchemaToken ()

static USDSKELIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()

Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetJointsLocator ()
	Prim-level relative data source locator to locate joints. More...

static USDSKELIMAGING_API const HdDataSourceLocator &	GetTranslationsLocator ()
	Prim-level relative data source locator to locate translations. More...

static USDSKELIMAGING_API const HdDataSourceLocator &	GetRotationsLocator ()
	Prim-level relative data source locator to locate rotations. More...

static USDSKELIMAGING_API const HdDataSourceLocator &	GetScalesLocator ()
	Prim-level relative data source locator to locate scales. More...

static USDSKELIMAGING_API const HdDataSourceLocator &	GetBlendShapesLocator ()
	Prim-level relative data source locator to locate blendShapes. More...

static USDSKELIMAGING_API const HdDataSourceLocator &	GetBlendShapeWeightsLocator ()
	Prim-level relative data source locator to locate blendShapeWeights. More...

Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdTokenArrayDataSourceHandle &joints, const HdVec3fArrayDataSourceHandle &translations, const HdQuatfArrayDataSourceHandle &rotations, const HdVec3hArrayDataSourceHandle &scales, const HdTokenArrayDataSourceHandle &blendShapes, const HdFloatArrayDataSourceHandle &blendShapeWeights)

Schema retrieval
	UsdSkelImagingAnimationSchema (HdContainerDataSourceHandle container)

static USDSKELIMAGING_API UsdSkelImagingAnimationSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource

Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const

Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 52 of file animationSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingAnimationSchema::UsdSkelImagingAnimationSchema ( HdContainerDataSourceHandle container )

inline

Retrieves a container data source with the schema's default name token "skelAnimation" from the parent container and constructs a UsdSkelImagingAnimationSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 58 of file animationSchema.h.

Member Function Documentation

static USDSKELIMAGING_API HdContainerDataSourceHandle UsdSkelImagingAnimationSchema::BuildRetained	(	const HdTokenArrayDataSourceHandle &	joints,
		const HdVec3fArrayDataSourceHandle &	translations,
		const HdQuatfArrayDataSourceHandle &	rotations,
		const HdVec3hArrayDataSourceHandle &	scales,
		const HdTokenArrayDataSourceHandle &	blendShapes,
		const HdFloatArrayDataSourceHandle &	blendShapeWeights
	)

static

Deprecated:: Use Builder instead.

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

USDSKELIMAGING_API HdTokenArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetBlendShapes ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetBlendShapesLocator ( )

static

Prim-level relative data source locator to locate blendShapes.

USDSKELIMAGING_API HdFloatArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetBlendShapeWeights ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetBlendShapeWeightsLocator ( )

static

Prim-level relative data source locator to locate blendShapeWeights.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static USDSKELIMAGING_API UsdSkelImagingAnimationSchema UsdSkelImagingAnimationSchema::GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

Retrieves a container data source with the schema's default name token "skelAnimation" from the parent container and constructs a UsdSkelImagingAnimationSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDSKELIMAGING_API HdTokenArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetJoints ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetJointsLocator ( )

static

Prim-level relative data source locator to locate joints.

USDSKELIMAGING_API HdQuatfArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetRotations ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetRotationsLocator ( )

static

Prim-level relative data source locator to locate rotations.

USDSKELIMAGING_API HdVec3hArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetScales ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetScalesLocator ( )

static

Prim-level relative data source locator to locate scales.

static USDSKELIMAGING_API const TfToken& UsdSkelImagingAnimationSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

USDSKELIMAGING_API HdVec3fArrayDataSourceHandle UsdSkelImagingAnimationSchema::GetTranslations ( ) const

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingAnimationSchema::GetTranslationsLocator ( )

static

Prim-level relative data source locator to locate translations.

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

pxr/usdImaging/usdSkelImaging/animationSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation