API Schema adapter for UsdSkel's SkelBindingAPI. More...

#include <bindingAPIAdapter.h>

Inheritance diagram for UsdSkelImagingBindingAPIAdapter:

Public Types
using	BaseAdapter = UsdImagingAPISchemaAdapter

Public Member Functions
USDSKELIMAGING_API HdContainerDataSourceHandle	GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, const UsdImagingDataSourceStageGlobals &stageGlobals) override
	Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary prim (empty `subprim` value) or a specific subprim.

USDSKELIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
	Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet describing which data sources should be flagged as dirty.

Public Member Functions inherited from UsdImagingAPISchemaAdapter
virtual USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim, TfToken const &appliedInstanceName)
	Called to determine whether an API schema defines additional child hydra prims beyond the primary hydra prim representing the USD prim on which the API schema is applied.

virtual USDIMAGING_API TfToken	GetImagingSubprimType (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName)
	Called to determine whether an API schema specifies the hydra type of a given prim previously defined by a call to GetImagingSubprims.

virtual USDIMAGING_API HdContainerDataSourceHandle	GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, const UsdImagingDataSourceStageGlobals &stageGlobals)
	Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary prim (empty `subprim` value) or a specific subprim.

virtual USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType)
	Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet describing which data sources should be flagged as dirty.

Detailed Description

API Schema adapter for UsdSkel's SkelBindingAPI.

Definition at line 21 of file bindingAPIAdapter.h.

Member Typedef Documentation

◆ BaseAdapter

using BaseAdapter = UsdImagingAPISchemaAdapter

Definition at line 24 of file bindingAPIAdapter.h.

Member Function Documentation

◆ GetImagingSubprimData()

USDSKELIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData	(	UsdPrim const &	prim,
		TfToken const &	subprim,
		TfToken const &	appliedInstanceName,
		const UsdImagingDataSourceStageGlobals &	stageGlobals
	)

overridevirtual

Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary prim (empty subprim value) or a specific subprim.

The non-null results of the prim adapter and each applied API schema adapter are overlaid (in application order).

Ideally, data sources within this container are lazily evaluated to avoid doing work until some consumes the data.

Reimplemented from UsdImagingAPISchemaAdapter.

◆ InvalidateImagingSubprim()

USDSKELIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim	(	UsdPrim const &	prim,
		TfToken const &	subprim,
		TfToken const &	appliedInstanceName,
		TfTokenVector const &	properties,
		UsdImagingPropertyInvalidationType	invalidationType
	)

overridevirtual

Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet describing which data sources should be flagged as dirty.