UsdSkelImagingDataSourceResolvedSkeletonPrim Class Reference

A data source providing data for the UsdSkelImagingResolvedSkeletonSchema and for drawing the guide as a mesh. More...

#include <dataSourceResolvedSkeletonPrim.h>

Inheritance diagram for UsdSkelImagingDataSourceResolvedSkeletonPrim:

Public Member Functions
	HD_DECLARE_DATASOURCE (UsdSkelImagingDataSourceResolvedSkeletonPrim)
USDSKELIMAGING_API TfTokenVector	GetNames () override
	Returns the list of names for which Get(...) is expected to return a non-null value.
USDSKELIMAGING_API HdDataSourceBaseHandle	Get (const TfToken &name) override
	Returns the child datasource of the given name.
const SdfPath &	GetAnimationSource () const
	skelAnimation targeted by the skeleton.
const VtArray< SdfPath > &	GetInstanceAnimationSources () const
const VtArray< SdfPath > &	GetInstancerPaths () const
	Paths to instancers instancing this prim - not including ones outside the skel root.
const UsdSkelImagingAnimationSchema &	GetAnimationSchema () const
	Schema from skelAnimation at GetAnimationSource().
const VtArray< UsdSkelImagingAnimationSchema > &	GetInstanceAnimationSchemas () const
const VtArray< SdfPath >	GetResolvedAnimationSources () const
	Get the resolved animationSchema(s)/animationSource(s) bound to this skeleton.
const VtArray< UsdSkelImagingAnimationSchema >	GetResolvedAnimationSchemas () const
HdMatrixDataSourceHandle	GetSkelLocalToCommonSpace () const
	Transfrom to go from local space of skeleton prim to common space (as defined by UsdSkelImagingDataSourceXformResolver).
HdMatrix4fArrayDataSourceHandle	GetSkinningTransforms ()
	Skinning transforms.
HdTokenArrayDataSourceHandle	GetBlendShapes () const
	BlendShapes.
HdFloatArrayDataSourceHandle	GetBlendShapeWeights () const
	BlendShape weights.
HdVec2iArrayDataSourceHandle	GetBlendShapeRanges () const
	BlendShape ranges.
std::shared_ptr< UsdSkelImagingSkelData >	GetSkelData ()
	(Non-animated) skel data computed from this skeleton and the parts of skelAnimation relating to the topology/remapping.
std::shared_ptr< UsdSkelImagingSkelGuideData >	GetSkelGuideData ()
	Some of the (non-animated) data to compute the points and topology for the mesh guide.
USDSKELIMAGING_API bool	ProcessDirtyLocators (const TfToken &dirtiedPrimType, const HdDataSourceLocatorSet &dirtyLocators, HdSceneIndexObserver::DirtiedPrimEntries *entries)
	Dirty internal structures in response to dirty locators for skeleton prim (dirtiedPrimType = "skeleton") or the targeted skelAnimaton prim (dirtiedPrimType = "skelAnimation").
Public Member Functions inherited from HdContainerDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)
virtual TfTokenVector	GetNames ()=0
	Returns the list of names for which Get(...) is expected to return a non-null value.
virtual HdDataSourceBaseHandle	Get (const TfToken &name)=0
	Returns the child datasource of the given name.

Static Public Member Functions
static const HdDataSourceLocatorSet &	GetDependendendOnDataSourceLocators ()
	Data source locators (on this prim) that this prim depends on.
Static Public Member Functions inherited from HdContainerDataSource
static HD_API HdDataSourceBaseHandle	Get (const Handle &container, const HdDataSourceLocator &locator)
	A convenience function: given container, return the descendant identified by locator, which may be at any depth.

Detailed Description

A data source providing data for the UsdSkelImagingResolvedSkeletonSchema and for drawing the guide as a mesh.

Used by skeleton resolving scene index.

Definition at line 30 of file dataSourceResolvedSkeletonPrim.h.

Member Function Documentation

Get()

USDSKELIMAGING_API HdDataSourceBaseHandle Get ( const TfToken &  name )

overridevirtual

Returns the child datasource of the given name.

This call is expected to be threadsafe.

Implements HdContainerDataSource.

GetAnimationSchema()

const UsdSkelImagingAnimationSchema & GetAnimationSchema ( ) const

inline

Schema from skelAnimation at GetAnimationSource().

Definition at line 67 of file dataSourceResolvedSkeletonPrim.h.

GetAnimationSource()

const SdfPath & GetAnimationSource ( ) const

inline

skelAnimation targeted by the skeleton.

Used to track dependency of this prim on the skelAnimation.

Definition at line 49 of file dataSourceResolvedSkeletonPrim.h.

GetBlendShapeRanges()

HdVec2iArrayDataSourceHandle GetBlendShapeRanges

(

)

const

BlendShape ranges.

If UsdImagingIsUsdSkelGLInstancingEnabled() is true, We will concatenate all the blendShapes and blendShapeWeights from instance animation sources and they might be of different sizes so we need to provide ranges in order to restore them downstream.

GetBlendShapes()

HdTokenArrayDataSourceHandle GetBlendShapes

(

)

const

BlendShapes.

Same logic as skinning transforms

GetBlendShapeWeights()

HdFloatArrayDataSourceHandle GetBlendShapeWeights

(

)

const

BlendShape weights.

Same logic as skinning transforms

GetDependendendOnDataSourceLocators()

static const HdDataSourceLocatorSet & GetDependendendOnDataSourceLocators ( )

static

Data source locators (on this prim) that this prim depends on.

That is, if the input scene sends a dirty entry for this prim path with dirty locators intersecting these data source locators, we need to call ProcessDirtyLocators.

(Similar to dependendedOnDataSourceLocator in HdDependencySchema).

GetInstanceAnimationSchemas()

const VtArray< UsdSkelImagingAnimationSchema > & GetInstanceAnimationSchemas ( ) const

inline

Definition at line 72 of file dataSourceResolvedSkeletonPrim.h.

GetInstanceAnimationSources()

const VtArray< SdfPath > & GetInstanceAnimationSources ( ) const

inline

Definition at line 53 of file dataSourceResolvedSkeletonPrim.h.

GetInstancerPaths()

const VtArray< SdfPath > & GetInstancerPaths ( ) const

inline

Paths to instancers instancing this prim - not including ones outside the skel root.

See UsdSkelImagingDataSourceXformResolver for details.

Definition at line 62 of file dataSourceResolvedSkeletonPrim.h.

GetNames()

USDSKELIMAGING_API TfTokenVector GetNames ( )

overridevirtual

Returns the list of names for which Get(...) is expected to return a non-null value.

This call is expected to be threadsafe.

Implements HdContainerDataSource.

GetResolvedAnimationSources()

const VtArray< SdfPath > GetResolvedAnimationSources

(

)

const

Get the resolved animationSchema(s)/animationSource(s) bound to this skeleton.

If UsdImagingIsUsdSkelGLInstancingEnabled() is false, always return GetAnimationSchema()/GetAnimationSource(), otherwise return GetInstanceAnimationSchemas()/GetInstanceAnimationSources() when there's no bound animationSource.

GetSkelData()

std::shared_ptr< UsdSkelImagingSkelData > GetSkelData ( )

inline

(Non-animated) skel data computed from this skeleton and the parts of skelAnimation relating to the topology/remapping.

Definition at line 115 of file dataSourceResolvedSkeletonPrim.h.

GetSkelGuideData()

std::shared_ptr< UsdSkelImagingSkelGuideData > GetSkelGuideData ( )

inline

Some of the (non-animated) data to compute the points and topology for the mesh guide.

Definition at line 121 of file dataSourceResolvedSkeletonPrim.h.

GetSkelLocalToCommonSpace()

HdMatrixDataSourceHandle GetSkelLocalToCommonSpace

(

)

const

Transfrom to go from local space of skeleton prim to common space (as defined by UsdSkelImagingDataSourceXformResolver).

GetSkinningTransforms()

HdMatrix4fArrayDataSourceHandle GetSkinningTransforms

(

)

Skinning transforms.

If UsdImagingIsUsdSkelGLInstancingEnabled() is true, this will concatinate all the instanceAnimationSource if there is no bound AnimationSource.

ProcessDirtyLocators()

USDSKELIMAGING_API bool ProcessDirtyLocators	(	const TfToken &	dirtiedPrimType,
		const HdDataSourceLocatorSet &	dirtyLocators,
		HdSceneIndexObserver::DirtiedPrimEntries *	entries
	)

Dirty internal structures in response to dirty locators for skeleton prim (dirtiedPrimType = "skeleton") or the targeted skelAnimaton prim (dirtiedPrimType = "skelAnimation").

Fills dirtied prim entries with affected locators for this prim or returns true to indicate that we could not dirty this data source and need to refetch it.

---

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

• pxr/usdImaging/usdSkelImaging/dataSourceResolvedSkeletonPrim.h