Loading...
Searching...
No Matches
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 SdfPathGetAnimationSource () const
 skelAnimation targeted by the skeleton.
 
const VtArray< SdfPath > & GetInstancerPaths () const
 Paths to instancers instancing this prim - not including ones outside the skel root.
 
const UsdSkelImagingAnimationSchemaGetAnimationSchema () const
 Schema from skelAnimation at GetAnimationSource().
 
HdMatrixDataSourceHandle GetSkelLocalToCommonSpace () const
 Transfrom to go from local space of skeleton prim to common space (as defined by UsdSkelImagingDataSourceXformResolver).
 
HdMatrix4fArrayDataSourceHandle GetSkinningTransforms ()
 Skinning transforms.
 
std::shared_ptr< UsdSkelImagingSkelDataGetSkelData ()
 (Non-animated) skel data computed from this skeleton and the parts of skelAnimation relating to the topology/remapping.
 
std::shared_ptr< UsdSkelImagingSkelGuideDataGetSkelGuideData ()
 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 HdDataSourceLocatorSetGetDependendendOnDataSourceLocators ()
 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 63 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.

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

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

◆ 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 76 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 82 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.

◆ 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: