UsdSkelImagingResolvedSkeletonSchema Class Reference

Resolved data for a skeleton and the targeted skelAnim. More...

#include <resolvedSkeletonSchema.h>

Inheritance diagram for UsdSkelImagingResolvedSkeletonSchema:

Classes
class	Builder
	Utility class for setting sparse sets of child data source fields to be filled as arguments into BuildRetained. More...

Public Member Functions
Member accessor
USDSKELIMAGING_API HdMatrixDataSourceHandle	GetSkelLocalToCommonSpace () const
	Transform to go from the local space if the skeleton prim to common space (as defined by UsdSkelImagingDataSourceXformResolver).
USDSKELIMAGING_API HdMatrix4fArrayDataSourceHandle	GetSkinningTransforms () const
	Passed to the extComputations.
USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetBlendShapes () const
	Just forwarded from the skelAnim's blendShapes.
USDSKELIMAGING_API HdFloatArrayDataSourceHandle	GetBlendShapeWeights () const
	Just forwarded from the skelAnim's blendShapeWeights.
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting.
HD_API bool	IsDefined () const
	operator bool () const
	Returns true if this schema is applied on top of a non-null container.

Static Public Member Functions
Schema location
static USDSKELIMAGING_API const TfToken &	GetSchemaToken ()
	Returns a token where the container representing this schema is found in a container by default.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
	Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.
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 &	GetSkelLocalToCommonSpaceLocator ()
	Prim-level relative data source locator to locate skelLocalToCommonSpace.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetSkinningTransformsLocator ()
	Prim-level relative data source locator to locate skinningTransforms.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetBlendShapesLocator ()
	Prim-level relative data source locator to locate blendShapes.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetBlendShapeWeightsLocator ()
	Prim-level relative data source locator to locate blendShapeWeights.
Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdMatrixDataSourceHandle &skelLocalToCommonSpace, const HdMatrix4fArrayDataSourceHandle &skinningTransforms, const HdTokenArrayDataSourceHandle &blendShapes, const HdFloatArrayDataSourceHandle &blendShapeWeights)

Schema retrieval
	UsdSkelImagingResolvedSkeletonSchema (HdContainerDataSourceHandle container)
static USDSKELIMAGING_API UsdSkelImagingResolvedSkeletonSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "resolvedSkeleton" from the parent container and constructs a UsdSkelImagingResolvedSkeletonSchema instance.

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
	Returns a datasource of the requested type for the given name: schema implementations can use this to ask for child containers, sampled values, vectors, etc.
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Resolved data for a skeleton and the targeted skelAnim.

Populated by the skeleton resolving scene index.

Definition at line 53 of file resolvedSkeletonSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingResolvedSkeletonSchema()

UsdSkelImagingResolvedSkeletonSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 59 of file resolvedSkeletonSchema.h.

Member Function Documentation

BuildRetained()

static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained ( const HdMatrixDataSourceHandle &  skelLocalToCommonSpace, const HdMatrix4fArrayDataSourceHandle &  skinningTransforms, 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.

GetBlendShapes()

USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetBlendShapes

(

)

const

Just forwarded from the skelAnim's blendShapes.

GetBlendShapesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapesLocator ( )

static

Prim-level relative data source locator to locate blendShapes.

GetBlendShapeWeights()

USDSKELIMAGING_API HdFloatArrayDataSourceHandle GetBlendShapeWeights

(

)

const

Just forwarded from the skelAnim's blendShapeWeights.

GetBlendShapeWeightsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapeWeightsLocator ( )

static

Prim-level relative data source locator to locate blendShapeWeights.

GetDefaultLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetDefaultLocator ( )

static

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

GetFromParent()

static USDSKELIMAGING_API UsdSkelImagingResolvedSkeletonSchema GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "resolvedSkeleton" from the parent container and constructs a UsdSkelImagingResolvedSkeletonSchema instance.

Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

GetSchemaToken()

static USDSKELIMAGING_API const TfToken & GetSchemaToken ( )

static

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

GetSkelLocalToCommonSpace()

USDSKELIMAGING_API HdMatrixDataSourceHandle GetSkelLocalToCommonSpace

(

)

const

Transform to go from the local space if the skeleton prim to common space (as defined by UsdSkelImagingDataSourceXformResolver).

GetSkelLocalToCommonSpaceLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetSkelLocalToCommonSpaceLocator ( )

static

Prim-level relative data source locator to locate skelLocalToCommonSpace.

GetSkinningTransforms()

USDSKELIMAGING_API HdMatrix4fArrayDataSourceHandle GetSkinningTransforms

(

)

const

Passed to the extComputations.

Computed from the following: skeleton's joints (determining the topology), and bind and rest (if needed) transforms. skelAnim's joints (determining the remapping) and translations, rotations and scales.

GetSkinningTransformsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetSkinningTransformsLocator ( )

static

Prim-level relative data source locator to locate skinningTransforms.

---

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

• pxr/usdImaging/usdSkelImaging/resolvedSkeletonSchema.h