Corresponds to UsdSkelBindingAPI. More...

#include <bindingSchema.h>

Inheritance diagram for UsdSkelImagingBindingSchema:

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 HdPathDataSourceHandle	GetAnimationSource () const
	Note that in UsdSkel, the animation comes from the animationSource on the Skeleton (which also carries the topology of the skeleton as joints).

USDSKELIMAGING_API HdPathDataSourceHandle	GetSkeleton () const

USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetJoints () const

USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetBlendShapes () const
	This is not inherited according to the UsdSkel spec.

USDSKELIMAGING_API HdPathArrayDataSourceHandle	GetBlendShapeTargets () const
	This is not inherited according to the UsdSkel spec.

USDSKELIMAGING_API HdBoolDataSourceHandle	GetHasSkelRoot () const
	Is this prim a descendant of a SkelRoot? Does not correspond to Usd attribute and is actually populated by the SkelRoot and not the SkelBinding.

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 &	GetAnimationSourceLocator ()
	Prim-level relative data source locator to locate animationSource.

static USDSKELIMAGING_API const HdDataSourceLocator &	GetSkeletonLocator ()
	Prim-level relative data source locator to locate skeleton.

static USDSKELIMAGING_API const HdDataSourceLocator &	GetJointsLocator ()
	Prim-level relative data source locator to locate joints.

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

static USDSKELIMAGING_API const HdDataSourceLocator &	GetBlendShapeTargetsLocator ()
	Prim-level relative data source locator to locate blendShapeTargets.

static USDSKELIMAGING_API const HdDataSourceLocator &	GetHasSkelRootLocator ()
	Prim-level relative data source locator to locate hasSkelRoot.

Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdPathDataSourceHandle &animationSource, const HdPathDataSourceHandle &skeleton, const HdTokenArrayDataSourceHandle &joints, const HdTokenArrayDataSourceHandle &blendShapes, const HdPathArrayDataSourceHandle &blendShapeTargets, const HdBoolDataSourceHandle &hasSkelRoot)

Schema retrieval
	UsdSkelImagingBindingSchema (HdContainerDataSourceHandle container)

static USDSKELIMAGING_API UsdSkelImagingBindingSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
	Retrieves a container data source with the schema's default name token "skelBinding" from the parent container and constructs a UsdSkelImagingBindingSchema 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

Corresponds to UsdSkelBindingAPI.

Definition at line 58 of file bindingSchema.h.

Constructor & Destructor Documentation

◆ UsdSkelImagingBindingSchema()

UsdSkelImagingBindingSchema ( HdContainerDataSourceHandle container )

inline

Definition at line 64 of file bindingSchema.h.

Member Function Documentation

◆ BuildRetained()

static USDSKELIMAGING_API HdContainerDataSourceHandle BuildRetained	(	const HdPathDataSourceHandle &	animationSource,
		const HdPathDataSourceHandle &	skeleton,
		const HdTokenArrayDataSourceHandle &	joints,
		const HdTokenArrayDataSourceHandle &	blendShapes,
		const HdPathArrayDataSourceHandle &	blendShapeTargets,
		const HdBoolDataSourceHandle &	hasSkelRoot
	)

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.

◆ GetAnimationSource()

USDSKELIMAGING_API HdPathDataSourceHandle GetAnimationSource ( ) const

Note that in UsdSkel, the animation comes from the animationSource on the Skeleton (which also carries the topology of the skeleton as joints).

This animationSource is either authored on the Skeleton directly (and UsdSkelBindingAPI is applied) or inherited from an ancestor of Skeleton (that has UsdSkelBindingAPI applied).

◆ GetAnimationSourceLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetAnimationSourceLocator ( )

static

Prim-level relative data source locator to locate animationSource.

◆ GetBlendShapes()

USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetBlendShapes ( ) const

This is not inherited according to the UsdSkel spec.

◆ GetBlendShapesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapesLocator ( )

static

Prim-level relative data source locator to locate blendShapes.

◆ GetBlendShapeTargets()

USDSKELIMAGING_API HdPathArrayDataSourceHandle GetBlendShapeTargets ( ) const

This is not inherited according to the UsdSkel spec.

◆ GetBlendShapeTargetsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBlendShapeTargetsLocator ( )

static

Prim-level relative data source locator to locate blendShapeTargets.

◆ 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 UsdSkelImagingBindingSchema GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

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

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

◆ GetHasSkelRoot()

USDSKELIMAGING_API HdBoolDataSourceHandle GetHasSkelRoot ( ) const

Is this prim a descendant of a SkelRoot? Does not correspond to Usd attribute and is actually populated by the SkelRoot and not the SkelBinding.

◆ GetHasSkelRootLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetHasSkelRootLocator ( )

static

Prim-level relative data source locator to locate hasSkelRoot.

◆ GetJointsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetJointsLocator ( )

static

Prim-level relative data source locator to locate joints.

◆ GetSchemaToken()

static USDSKELIMAGING_API const TfToken & GetSchemaToken ( )

static

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

◆ GetSkeletonLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetSkeletonLocator ( )

static

Prim-level relative data source locator to locate skeleton.

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

pxr/usdImaging/usdSkelImaging/bindingSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdSkelImagingBindingSchema()

Member Function Documentation

◆ BuildRetained()

◆ GetAnimationSource()

◆ GetAnimationSourceLocator()

◆ GetBlendShapes()

◆ GetBlendShapesLocator()

◆ GetBlendShapeTargets()

◆ GetBlendShapeTargetsLocator()

◆ GetDefaultLocator()

◆ GetFromParent()

◆ GetHasSkelRoot()

◆ GetHasSkelRootLocator()

◆ GetJointsLocator()

◆ GetSchemaToken()

◆ GetSkeletonLocator()