HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdSkelImagingDataSourceResolvedPointsBasedPrim Class Reference

#include <dataSourceResolvedPointsBasedPrim.h>

+ Inheritance diagram for UsdSkelImagingDataSourceResolvedPointsBasedPrim:

Public Member Functions

 HD_DECLARE_DATASOURCE (UsdSkelImagingDataSourceResolvedPointsBasedPrim)
 
USDSKELIMAGING_API ~UsdSkelImagingDataSourceResolvedPointsBasedPrim ()
 
USDSKELIMAGING_API TfTokenVector GetNames () override
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
Get (const TfToken &name) override
 
const SdfPathGetPrimPath () const
 Path of prim in input scene (and for prim this data source is for). More...
 
const SdfPathGetSkeletonPath () const
 Path of bound skeleton. More...
 
const VtArray< SdfPath > & GetBlendShapeTargetPaths () const
 Paths to BlendShape prims. More...
 
const VtArray< SdfPath > & GetInstancerPaths () const
 
const HdPrimvarsSchemaGetPrimvars () const
 Primvars of prim in the input scene. More...
 
const
UsdSkelImagingResolvedSkeletonSchema
GetResolvedSkeletonSchema ()
 Resolved skeleton of prim in the input scene. More...
 
USDSKELIMAGING_API
HdMatrix4fArrayDataSourceHandle 
GetSkinningTransforms ()
 
USDSKELIMAGING_API
HdMatrix3fArrayDataSourceHandle 
GetSkinningScaleTransforms ()
 Only valid if GetSkinningMethod() == UsdSkelTokens->dualQuaternion. More...
 
USDSKELIMAGING_API
HdVec4fArrayDataSourceHandle 
GetSkinningDualQuats ()
 Only valid if GetSkinningMethod() == UsdSkelTokens->dualQuaternion. More...
 
USDSKELIMAGING_API
HdFloatArrayDataSourceHandle 
GetBlendShapeWeights ()
 
USDSKELIMAGING_API
HdMatrixDataSourceHandle 
GetCommonSpaceToPrimLocal () const
 
USDSKELIMAGING_API
HdSampledDataSourceHandle 
GetPoints ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetGeomBindTransform ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetHasConstantInfluences ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetNumInfluencesPerComponent ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetInfluences ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetBlendShapeOffsets ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetBlendShapeOffsetRanges ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetNumBlendShapeOffsetRanges ()
 
USDSKELIMAGING_API
HdSampledDataSourceHandle 
GetNormals () const
 
USDSKELIMAGING_API
HdSampledDataSourceHandle 
GetFaceVertexIndices ()
 
USDSKELIMAGING_API
HdDataSourceBaseHandle 
GetHasFaceVaryingNormals ()
 
USDSKELIMAGING_API
std::shared_ptr
< UsdSkelImagingBlendShapeData
GetBlendShapeData ()
 Blend shape data computed from primvars, skel bindings and skeleton. More...
 
USDSKELIMAGING_API
std::shared_ptr
< UsdSkelImagingJointInfluencesData
GetJointInfluencesData ()
 Joint influences data computed from primvars. More...
 
const TfTokenGetSkinningMethod () const
 Skinning method computed from corresponding primvar. More...
 
bool HasExtComputations () const
 
bool HasNormalsExtComputations () const
 Should the normals for this primvar be given by an ext computation. More...
 
USDSKELIMAGING_API bool ProcessDirtyLocators (const TfToken &dirtiedPrimType, const HdDataSourceLocatorSet &dirtyLocators, HdSceneIndexObserver::DirtiedPrimEntries *entries)
 
- Public Member Functions inherited from HdContainerDataSource
 HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)
 
- Public Member Functions inherited from HdDataSourceBase
virtual HD_API ~HdDataSourceBase ()=0
 

Static Public Member Functions

static USDSKELIMAGING_API Handle New (HdSceneIndexBaseRefPtr const &sceneIndex, SdfPath primPath, HdContainerDataSourceHandle primSource)
 
static USDSKELIMAGING_API
const HdDataSourceLocatorSet
GetDependendendOnDataSourceLocators ()
 
- Static Public Member Functions inherited from HdContainerDataSource
static HD_API
HdDataSourceBaseHandle 
Get (const Handle &container, const HdDataSourceLocator &locator)
 

Detailed Description

A prim data source providing resolved data for a points based prim (mesh, basisCurves, points) deformed by a skeleton. As a data source, it populates the HdExtComputationPrimvarsSchema for points and possibly for normals and removes points and normals from the HdPrimvarsSchema.

Used by the UsdSkelImagingPointsResolvingSceneIndex in conjunction with the UsdSkelImagingDataSourceResolvedExtComputationPrim.

Definition at line 39 of file dataSourceResolvedPointsBasedPrim.h.

Constructor & Destructor Documentation

USDSKELIMAGING_API UsdSkelImagingDataSourceResolvedPointsBasedPrim::~UsdSkelImagingDataSourceResolvedPointsBasedPrim ( )

Member Function Documentation

USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::Get ( const TfToken name)
overridevirtual

Returns the child datasource of the given name. This call is expected to be threadsafe.

Implements HdContainerDataSource.

USDSKELIMAGING_API std::shared_ptr<UsdSkelImagingBlendShapeData> UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetBlendShapeData ( )

Blend shape data computed from primvars, skel bindings and skeleton.

USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetBlendShapeOffsetRanges ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetBlendShapeOffsets ( )
const VtArray<SdfPath>& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetBlendShapeTargetPaths ( ) const
inline

Paths to BlendShape prims.

Definition at line 78 of file dataSourceResolvedPointsBasedPrim.h.

USDSKELIMAGING_API HdFloatArrayDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetBlendShapeWeights ( )
USDSKELIMAGING_API HdMatrixDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetCommonSpaceToPrimLocal ( ) const

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

static USDSKELIMAGING_API const HdDataSourceLocatorSet& UsdSkelImagingDataSourceResolvedPointsBasedPrim::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).

USDSKELIMAGING_API HdSampledDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetFaceVertexIndices ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetGeomBindTransform ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetHasConstantInfluences ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetHasFaceVaryingNormals ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetInfluences ( )
const VtArray<SdfPath>& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetInstancerPaths ( ) const
inline

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

See UsdSkelImagingDataSourceXformResolver for details.

Definition at line 87 of file dataSourceResolvedPointsBasedPrim.h.

USDSKELIMAGING_API std::shared_ptr<UsdSkelImagingJointInfluencesData> UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetJointInfluencesData ( )

Joint influences data computed from primvars.

USDSKELIMAGING_API TfTokenVector UsdSkelImagingDataSourceResolvedPointsBasedPrim::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.

USDSKELIMAGING_API HdSampledDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetNormals ( ) const
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetNumBlendShapeOffsetRanges ( )
USDSKELIMAGING_API HdDataSourceBaseHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetNumInfluencesPerComponent ( )
USDSKELIMAGING_API HdSampledDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetPoints ( )
const SdfPath& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetPrimPath ( ) const
inline

Path of prim in input scene (and for prim this data source is for).

Definition at line 72 of file dataSourceResolvedPointsBasedPrim.h.

const HdPrimvarsSchema& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetPrimvars ( ) const
inline

Primvars of prim in the input scene.

Definition at line 92 of file dataSourceResolvedPointsBasedPrim.h.

const UsdSkelImagingResolvedSkeletonSchema& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetResolvedSkeletonSchema ( )
inline

Resolved skeleton of prim in the input scene.

Definition at line 95 of file dataSourceResolvedPointsBasedPrim.h.

const SdfPath& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetSkeletonPath ( ) const
inline

Path of bound skeleton.

Definition at line 75 of file dataSourceResolvedPointsBasedPrim.h.

USDSKELIMAGING_API HdVec4fArrayDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetSkinningDualQuats ( )

Only valid if GetSkinningMethod() == UsdSkelTokens->dualQuaternion.

const TfToken& UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetSkinningMethod ( ) const
inline

Skinning method computed from corresponding primvar.

Definition at line 161 of file dataSourceResolvedPointsBasedPrim.h.

USDSKELIMAGING_API HdMatrix3fArrayDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetSkinningScaleTransforms ( )

Only valid if GetSkinningMethod() == UsdSkelTokens->dualQuaternion.

USDSKELIMAGING_API HdMatrix4fArrayDataSourceHandle UsdSkelImagingDataSourceResolvedPointsBasedPrim::GetSkinningTransforms ( )
bool UsdSkelImagingDataSourceResolvedPointsBasedPrim::HasExtComputations ( ) const

Should the points for this primvar be given by an ext computation or from the primvars schema.

bool UsdSkelImagingDataSourceResolvedPointsBasedPrim::HasNormalsExtComputations ( ) const

Should the normals for this primvar be given by an ext computation.

UsdSkelImagingDataSourceResolvedPointsBasedPrim::HD_DECLARE_DATASOURCE ( UsdSkelImagingDataSourceResolvedPointsBasedPrim  )
static USDSKELIMAGING_API Handle UsdSkelImagingDataSourceResolvedPointsBasedPrim::New ( HdSceneIndexBaseRefPtr const &  sceneIndex,
SdfPath  primPath,
HdContainerDataSourceHandle  primSource 
)
static

C'tor.

Note that it takes the data source for the prim at primPath in the given sceneIndex. This is for performance: the client probably already retrieved this data source so we want to avoid looking it up again here.

Returns a nullptr if there the prim in the input scene does not bind a skeleton.

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

Dirty internal structures in response to dirty locators for the target (resolved) skeleton prim (dirtiedPrimType = "skeleton"), a targeted skelBlendShape prim (dirtiedPrimType = "skelBlendShape") or the prim in the input scene itself (any other dirtiedPrimType). 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: