#include <skeletonSchema.h>

Inheritance diagram for UsdSkelImagingSkeletonSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetJoints () const
	Determines topology of skeleton. More...

USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetJointNames () const

USDSKELIMAGING_API HdMatrixArrayDataSourceHandle	GetBindTransforms () const
	Determines topology of skeleton. More...

USDSKELIMAGING_API HdMatrixArrayDataSourceHandle	GetRestTransforms () const
	These are local rest transforms. More...

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

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

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

Schema construction
static USDSKELIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdTokenArrayDataSourceHandle &joints, const HdTokenArrayDataSourceHandle &jointNames, const HdMatrixArrayDataSourceHandle &bindTransforms, const HdMatrixArrayDataSourceHandle &restTransforms)

Schema retrieval
	UsdSkelImagingSkeletonSchema (HdContainerDataSourceHandle container)

static USDSKELIMAGING_API UsdSkelImagingSkeletonSchema	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 50 of file skeletonSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingSkeletonSchema::UsdSkelImagingSkeletonSchema ( HdContainerDataSourceHandle container )

inline

Retrieves a container data source with the schema's default name token "skeleton" from the parent container and constructs a UsdSkelImagingSkeletonSchema 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 56 of file skeletonSchema.h.

Member Function Documentation

static USDSKELIMAGING_API HdContainerDataSourceHandle UsdSkelImagingSkeletonSchema::BuildRetained	(	const HdTokenArrayDataSourceHandle &	joints,
		const HdTokenArrayDataSourceHandle &	jointNames,
		const HdMatrixArrayDataSourceHandle &	bindTransforms,
		const HdMatrixArrayDataSourceHandle &	restTransforms
	)

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 HdMatrixArrayDataSourceHandle UsdSkelImagingSkeletonSchema::GetBindTransforms ( ) const

Determines topology of skeleton.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingSkeletonSchema::GetBindTransformsLocator ( )

static

Prim-level relative data source locator to locate bindTransforms.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingSkeletonSchema::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 UsdSkelImagingSkeletonSchema UsdSkelImagingSkeletonSchema::GetFromParent ( const HdContainerDataSourceHandle & fromParentContainer )

static

Retrieves a container data source with the schema's default name token "skeleton" from the parent container and constructs a UsdSkelImagingSkeletonSchema 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 UsdSkelImagingSkeletonSchema::GetJointNames ( ) const

Here for completeness but ignored for posing the geometry. See Skeleton.jointNames in usdSkel/schema for uses.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingSkeletonSchema::GetJointNamesLocator ( )

static

Prim-level relative data source locator to locate jointNames.

USDSKELIMAGING_API HdTokenArrayDataSourceHandle UsdSkelImagingSkeletonSchema::GetJoints ( ) const

Determines topology of skeleton.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingSkeletonSchema::GetJointsLocator ( )

static

Prim-level relative data source locator to locate joints.

USDSKELIMAGING_API HdMatrixArrayDataSourceHandle UsdSkelImagingSkeletonSchema::GetRestTransforms ( ) const

These are local rest transforms.

static USDSKELIMAGING_API const HdDataSourceLocator& UsdSkelImagingSkeletonSchema::GetRestTransformsLocator ( )

static

Prim-level relative data source locator to locate restTransforms.

static USDSKELIMAGING_API const TfToken& UsdSkelImagingSkeletonSchema::GetSchemaToken ( )

static

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

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

pxr/usdImaging/usdSkelImaging/skeletonSchema.h

Classes

Public Member Functions

Static Public Member Functions

Schema retrieval

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation