HdGpSceneIndexPlugin provides HdSceneIndexPluginRegistry access to instantiate HdGpGenerativeProceduralResolvingSceneIndex either directly or automatically via RegisterSceneIndexForRenderer. More...

Inheritance diagram for HdGpSceneIndexPlugin:

Static Public Member Functions
static const HdSceneIndexPluginRegistry::InsertionPhase	GetInsertionPhase ()

Protected Member Functions
HdSceneIndexBaseRefPtr	_AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs) override
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

bool	_IsEnabled (const HdContainerDataSourceHandle &inputArgs) const override
	Subclasses implement this to indicate whether the plugin is enabled.

Protected Member Functions inherited from HdSceneIndexPlugin
virtual HD_API HdSceneIndexBaseRefPtr	_AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

virtual HD_API HdSceneIndexBaseRefPtr	_AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

virtual HD_API bool	_IsEnabled (const HdContainerDataSourceHandle &inputArgs) const
	Subclasses implement this to indicate whether the plugin is enabled.

Additional Inherited Members
Public Member Functions inherited from HdSceneIndexPlugin
HD_API HdSceneIndexBaseRefPtr	AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)

HD_API bool	IsEnabled (const HdContainerDataSourceHandle &inputArgs) const
	Returns true if the plugin is enabled, in the sense that it should be consulted for its contribution to the scene index chain via AppendSceneIndex.

Detailed Description

HdGpSceneIndexPlugin provides HdSceneIndexPluginRegistry access to instantiate HdGpGenerativeProceduralResolvingSceneIndex either directly or automatically via RegisterSceneIndexForRenderer.

Definition at line 27 of file sceneIndexPlugin.h.

Member Function Documentation

HdSceneIndexBaseRefPtr _AppendSceneIndex	(	const HdSceneIndexBaseRefPtr &	inputScene,
		const HdContainerDataSourceHandle &	inputArgs
	)

overrideprotectedvirtual

Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

The return value should be the final scene created – or the inputScene itself if nothing is created.

Reimplemented from HdSceneIndexPlugin.

bool _IsEnabled ( const HdContainerDataSourceHandle & inputArgs ) const

overrideprotectedvirtual

Subclasses implement this to indicate whether the plugin is enabled.

This is preferable to using env guards to gate registration and scene index instatiation in _AppendSceneIndex.

Base implementation returns true.

Reimplemented from HdSceneIndexPlugin.

static const HdSceneIndexPluginRegistry::InsertionPhase GetInsertionPhase ( )

inlinestatic

Definition at line 31 of file sceneIndexPlugin.h.

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