UsdSkelImagingSkeletonSchema Class Reference

Corresponds to UsdSkelSkeleton. More...

#include <skeletonSchema.h>

Inheritance diagram for UsdSkelImagingSkeletonSchema:

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 HdTokenArrayDataSourceHandle	GetJoints () const
	Determines topology of skeleton.
USDSKELIMAGING_API HdTokenArrayDataSourceHandle	GetJointNames () const
	Here for completeness but ignored for posing the geometry.
USDSKELIMAGING_API HdMatrixArrayDataSourceHandle	GetBindTransforms () const
USDSKELIMAGING_API HdMatrixArrayDataSourceHandle	GetRestTransforms () const
	These are local rest transforms.
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 &	GetJointsLocator ()
	Prim-level relative data source locator to locate joints.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetJointNamesLocator ()
	Prim-level relative data source locator to locate jointNames.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetBindTransformsLocator ()
	Prim-level relative data source locator to locate bindTransforms.
static USDSKELIMAGING_API const HdDataSourceLocator &	GetRestTransformsLocator ()
	Prim-level relative data source locator to locate restTransforms.
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)
	Retrieves a container data source with the schema's default name token "skeleton" from the parent container and constructs a UsdSkelImagingSkeletonSchema 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 UsdSkelSkeleton.

Definition at line 52 of file skeletonSchema.h.

Constructor & Destructor Documentation

UsdSkelImagingSkeletonSchema()

UsdSkelImagingSkeletonSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 58 of file skeletonSchema.h.

Member Function Documentation

BuildRetained()

static USDSKELIMAGING_API HdContainerDataSourceHandle 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.

GetBindTransformsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetBindTransformsLocator ( )

static

Prim-level relative data source locator to locate bindTransforms.

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 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.

GetJointNames()

USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetJointNames

(

)

const

Here for completeness but ignored for posing the geometry.

See Skeleton.jointNames in usdSkel/schema for uses.

GetJointNamesLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetJointNamesLocator ( )

static

Prim-level relative data source locator to locate jointNames.

GetJoints()

USDSKELIMAGING_API HdTokenArrayDataSourceHandle GetJoints

(

)

const

Determines topology of skeleton.

GetJointsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetJointsLocator ( )

static

Prim-level relative data source locator to locate joints.

GetRestTransforms()

USDSKELIMAGING_API HdMatrixArrayDataSourceHandle GetRestTransforms

(

)

const

These are local rest transforms.

GetRestTransformsLocator()

static USDSKELIMAGING_API const HdDataSourceLocator & GetRestTransformsLocator ( )

static

Prim-level relative data source locator to locate restTransforms.

GetSchemaToken()

static USDSKELIMAGING_API const TfToken & 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