UsdSkelImagingResolvingSceneIndexPlugin Class Reference

Registers scene indices to resolve the Skeleton prim and points-based prim skinned by a Skeleton prim. More...

#include <resolvingSceneIndexPlugin.h>

Inheritance diagram for UsdSkelImagingResolvingSceneIndexPlugin:

Public Member Functions
USDSKELIMAGING_API HdSceneIndexBaseRefPtr	AppendSceneIndex (HdSceneIndexBaseRefPtr const &inputScene) override
	Override by client. Similar to HdSceneIndexPlugin::AppendSceneIndex.
USDSKELIMAGING_API HdContainerDataSourceHandle	FlattenedDataSourceProviders () override
	Clients can register additional HdFlattenedDataSourceProvider's that UsdImagingCreateSceneIndices will pass to the flattening scene index.
USDSKELIMAGING_API TfTokenVector	InstanceDataSourceNames () override
	Clients can register additional names used by the (native) instance aggregation scene index when grouping instances.
USDSKELIMAGING_API TfTokenVector	ProxyPathTranslationDataSourceNames () override
	Clients can register additional names of prim-level data sources that should receive path-translation for any path-valued data sources that point at instance proxies to point to corresponding prototypes.
virtual HdSceneIndexBaseRefPtr	AppendSceneIndex (HdSceneIndexBaseRefPtr const &inputScene)=0
	Override by client. Similar to HdSceneIndexPlugin::AppendSceneIndex.
virtual USDIMAGING_API HdContainerDataSourceHandle	FlattenedDataSourceProviders ()
	Clients can register additional HdFlattenedDataSourceProvider's that UsdImagingCreateSceneIndices will pass to the flattening scene index.
virtual USDIMAGING_API TfTokenVector	InstanceDataSourceNames ()
	Clients can register additional names used by the (native) instance aggregation scene index when grouping instances.
virtual USDIMAGING_API TfTokenVector	ProxyPathTranslationDataSourceNames ()
	Clients can register additional names of prim-level data sources that should receive path-translation for any path-valued data sources that point at instance proxies to point to corresponding prototypes.

Additional Inherited Members
Static Public Member Functions inherited from UsdImagingSceneIndexPlugin
template<typename T >
static void	Define ()
	Call within TF_REGISTRY_FUNCTION(UsdImagingSceneIndexPlugin) to ensure that UsdImaging can instantiate the client's subclass of UsdImagingSceneIndexPlugin.
static std::vector< UsdImagingSceneIndexPluginUniquePtr >	GetAllSceneIndexPlugins ()
	Get an instance of each registered UsdImagingSceneIndexPlugin.

Detailed Description

Registers scene indices to resolve the Skeleton prim and points-based prim skinned by a Skeleton prim.

Definition at line 22 of file resolvingSceneIndexPlugin.h.

Member Function Documentation

AppendSceneIndex()

USDSKELIMAGING_API HdSceneIndexBaseRefPtr AppendSceneIndex ( HdSceneIndexBaseRefPtr const &  inputScene )

overridevirtual

Override by client. Similar to HdSceneIndexPlugin::AppendSceneIndex.

Implements UsdImagingSceneIndexPlugin.

FlattenedDataSourceProviders()

USDSKELIMAGING_API HdContainerDataSourceHandle FlattenedDataSourceProviders ( )

overridevirtual

Clients can register additional HdFlattenedDataSourceProvider's that UsdImagingCreateSceneIndices will pass to the flattening scene index.

Clients can use HdMakeDataSourceContainingFlattenedDataSourceProvider::Make to create the values of the container data source.

Reimplemented from UsdImagingSceneIndexPlugin.

InstanceDataSourceNames()

USDSKELIMAGING_API TfTokenVector InstanceDataSourceNames ( )

overridevirtual

Clients can register additional names used by the (native) instance aggregation scene index when grouping instances.

For example, two instances with different material bindings cannot be aggregated together and instantiated by the same instancer.

UsdImagingCreateSceneIndices knows about several such bindings already. Here, clients can add additional data sources that should be expected by the aggregation scene index. These data sources are identified by their name in the prim-level container data source.

Reimplemented from UsdImagingSceneIndexPlugin.

ProxyPathTranslationDataSourceNames()

USDSKELIMAGING_API TfTokenVector ProxyPathTranslationDataSourceNames ( )

overridevirtual

Clients can register additional names of prim-level data sources that should receive path-translation for any path-valued data sources that point at instance proxies to point to corresponding prototypes.

Reimplemented from UsdImagingSceneIndexPlugin.

---

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

• pxr/usdImaging/usdSkelImaging/resolvingSceneIndexPlugin.h