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

#include <skeletonAdapter.h>

+ Inheritance diagram for UsdSkelImagingSkeletonAdapter:

Public Types

using BaseAdapter = UsdImagingPrimAdapter
 

Public Member Functions

 UsdSkelImagingSkeletonAdapter ()
 
virtual USDSKELIMAGING_API ~UsdSkelImagingSkeletonAdapter ()
 
USDSKELIMAGING_API SdfPath Populate (const UsdPrim &prim, UsdImagingIndexProxy *index, const UsdImagingInstancerContext *instancerContext=nullptr) override
 
USDSKELIMAGING_API bool IsSupported (const UsdImagingIndexProxy *index) const override
 Returns true if the adapter can be populated into the target index. More...
 
Parallel Setup and Resolve
USDSKELIMAGING_API void TrackVariability (const UsdPrim &prim, const SdfPath &cachePath, HdDirtyBits *timeVaryingBits, const UsdImagingInstancerContext *instancerContext=nullptr) const override
 Thread Safe. More...
 
USDSKELIMAGING_API void UpdateForTime (const UsdPrim &prim, const SdfPath &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, const UsdImagingInstancerContext *instancerContext=nullptr) const override
 Thread Safe. More...
 
Change Processing API (public)
USDSKELIMAGING_API HdDirtyBits ProcessPropertyChange (const UsdPrim &prim, const SdfPath &cachePath, const TfToken &propertyName) override
 
USDSKELIMAGING_API void ProcessPrimResync (SdfPath const &primPath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void ProcessPrimRemoval (SdfPath const &primPath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkDirty (const UsdPrim &prim, const SdfPath &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkRefineLevelDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkReprDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkCullStyleDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkRenderTagDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkTransformDirty (const UsdPrim &prim, const SdfPath &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkVisibilityDirty (const UsdPrim &prim, const SdfPath &cachePath, UsdImagingIndexProxy *index) override
 
USDSKELIMAGING_API void MarkMaterialDirty (const UsdPrim &prim, const SdfPath &cachePath, UsdImagingIndexProxy *index) override
 
Computation API
USDSKELIMAGING_API void InvokeComputation (SdfPath const &computationPath, HdExtComputationContext *context) override
 
Non-virtual public API
USDSKELIMAGING_API void RegisterSkelBinding (UsdSkelBinding const &binding)
 
Virtual public API
USDSKELIMAGING_API PxOsdSubdivTags GetSubdivTags (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
 Get the subdiv tags for this prim. More...
 
- Public Member Functions inherited from UsdImagingPrimAdapter
virtual USDIMAGING_API HdDirtyBits ProcessPrimChange (UsdPrim const &prim, SdfPath const &cachePath, TfTokenVector const &changedFields)
 
virtual USDIMAGING_API void MarkWindowPolicyDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
 
virtual USDIMAGING_API
std::vector< VtArray< TfToken > > 
GetInstanceCategories (UsdPrim const &prim)
 Return an array of the categories used by each instance. More...
 
virtual USDIMAGING_API size_t SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, GfMatrix4d *sampleValues)
 
virtual USDIMAGING_API size_t SamplePrimvar (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, VtValue *sampleValues)
 
virtual USDIMAGING_API GfMatrix4d GetRelativeInstancerTransform (SdfPath const &instancerPath, SdfPath const &protoInstancerPath, UsdTimeCode time) const
 
virtual USDIMAGING_API SdfPath GetScenePrimPath (SdfPath const &cachePath, int instanceIndex, HdInstancerContext *instancerCtx) const
 
virtual USDIMAGING_API bool PopulateSelection (HdSelection::HighlightMode const &highlightMode, SdfPath const &cachePath, UsdPrim const &usdPrim, int const hydraInstanceIndex, VtIntArray const &parentInstanceIndices, HdSelectionSharedPtr const &result) const
 
virtual USDIMAGING_API
HdTextureResource::ID 
GetTextureResourceID (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time, size_t salt) const
 
virtual USDIMAGING_API
HdTextureResourceSharedPtr 
GetTextureResource (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const
 
virtual USDIMAGING_API
HdVolumeFieldDescriptorVector 
GetVolumeFieldDescriptors (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const
 
USDIMAGING_API GfMatrix4d GetRootTransform () const
 The root transform provided by the delegate. More...
 
USDIMAGING_API void SetDelegate (UsdImagingDelegate *delegate)
 A thread-local XformCache provided by the delegate. More...
 
USDIMAGING_API bool IsChildPath (SdfPath const &path) const
 The root transform provided by the delegate. More...
 
USDIMAGING_API bool GetVisible (UsdPrim const &prim, UsdTimeCode time) const
 
USDIMAGING_API TfToken GetPurpose (UsdPrim const &prim, UsdImagingInstancerContext const *instancerContext) const
 
USDIMAGING_API TfToken GetInheritablePurpose (UsdPrim const &prim) const
 
USDIMAGING_API GfMatrix4d GetTransform (UsdPrim const &prim, UsdTimeCode time, bool ignoreRootTransform=false) const
 
virtual USDIMAGING_API size_t SampleTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, GfMatrix4d *sampleValues)
 Samples the transform for the given prim. More...
 
USDIMAGING_API SdfPath GetMaterialUsdPath (UsdPrim const &prim) const
 
USDIMAGING_API TfToken GetModelDrawMode (UsdPrim const &prim)
 
USDIMAGING_API VtArray
< VtIntArray > 
GetPerPrototypeIndices (UsdPrim const &prim, UsdTimeCode time) const
 
 UsdImagingPrimAdapter ()
 
virtual USDIMAGING_API ~UsdImagingPrimAdapter ()
 
virtual USDIMAGING_API bool ShouldCullChildren () const
 
virtual USDIMAGING_API bool IsInstancerAdapter () const
 
virtual USDIMAGING_API bool CanPopulateMaster () const
 

Change Processing API (protected)

void _RemovePrim (const SdfPath &cachePath, UsdImagingIndexProxy *index) override
 

Detailed Description

Definition at line 50 of file skeletonAdapter.h.

Member Typedef Documentation

Constructor & Destructor Documentation

UsdSkelImagingSkeletonAdapter::UsdSkelImagingSkeletonAdapter ( )
inline

Definition at line 54 of file skeletonAdapter.h.

virtual USDSKELIMAGING_API UsdSkelImagingSkeletonAdapter::~UsdSkelImagingSkeletonAdapter ( )
virtual

Member Function Documentation

void UsdSkelImagingSkeletonAdapter::_RemovePrim ( const SdfPath cachePath,
UsdImagingIndexProxy index 
)
overrideprotectedvirtual

Skeleton -> Skinned Prim(s) state (Populated via UsdSkelImagingSkelRootAdapter::Populate)

Implements UsdImagingPrimAdapter.

USDSKELIMAGING_API PxOsdSubdivTags UsdSkelImagingSkeletonAdapter::GetSubdivTags ( UsdPrim const usdPrim,
SdfPath const cachePath,
UsdTimeCode  time 
) const
overridevirtual

Get the subdiv tags for this prim.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::InvokeComputation ( SdfPath const computationPath,
HdExtComputationContext context 
)
overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API bool UsdSkelImagingSkeletonAdapter::IsSupported ( const UsdImagingIndexProxy index) const
overridevirtual

Returns true if the adapter can be populated into the target index.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkCullStyleDirty ( UsdPrim const prim,
SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkDirty ( const UsdPrim prim,
const SdfPath cachePath,
HdDirtyBits  dirty,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Implements UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkMaterialDirty ( const UsdPrim prim,
const SdfPath cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkRefineLevelDirty ( UsdPrim const prim,
SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkRenderTagDirty ( UsdPrim const prim,
SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkReprDirty ( UsdPrim const prim,
SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkTransformDirty ( const UsdPrim prim,
const SdfPath cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::MarkVisibilityDirty ( const UsdPrim prim,
const SdfPath cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

changedFields contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim.

The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API SdfPath UsdSkelImagingSkeletonAdapter::Populate ( const UsdPrim prim,
UsdImagingIndexProxy index,
const UsdImagingInstancerContext instancerContext = nullptr 
)
overridevirtual

Called to populate the RenderIndex for this UsdPrim. The adapter is expected to create one or more prims in the render index using the given proxy.

Implements UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::ProcessPrimRemoval ( SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

Removes all associated Rprims and dependencies from the render index without scheduling them for repopulation.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::ProcessPrimResync ( SdfPath const cachePath,
UsdImagingIndexProxy index 
)
overridevirtual

When a PrimResync event occurs, the prim may have been deleted entirely, adapter plug-ins should override this method to free any per-prim state that was accumulated in the adapter.

Reimplemented from UsdImagingPrimAdapter.

USDSKELIMAGING_API HdDirtyBits UsdSkelImagingSkeletonAdapter::ProcessPropertyChange ( const UsdPrim prim,
const SdfPath cachePath,
const TfToken propertyName 
)
overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

Implements UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::RegisterSkelBinding ( UsdSkelBinding const binding)
USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::TrackVariability ( const UsdPrim prim,
const SdfPath cachePath,
HdDirtyBits timeVaryingBits,
const UsdImagingInstancerContext instancerContext = nullptr 
) const
overridevirtual

Thread Safe.

Implements UsdImagingPrimAdapter.

USDSKELIMAGING_API void UsdSkelImagingSkeletonAdapter::UpdateForTime ( const UsdPrim prim,
const SdfPath cachePath,
UsdTimeCode  time,
HdDirtyBits  requestedBits,
const UsdImagingInstancerContext instancerContext = nullptr 
) const
overridevirtual

Thread Safe.

Implements UsdImagingPrimAdapter.


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