Plugin adds a scene index that declares hdprman-specific dependencies to trigger the necessary invalidation. More...

Inheritance diagram for HdPrman_DependencySceneIndexPlugin:

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.

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

Plugin adds a scene index that declares hdprman-specific dependencies to trigger the necessary invalidation.

It currently declares 2 dependencies: (a -> b to be read as "a depends on b")

Volume -> Volume Field Binding This declaration registers the volumeFieldBinding data source locator of a volume prim to be invalidated if any of the targeted volume fields changes. That is, if, e.g., the filePath of a volume field changes, then the volume using that volume field will be dirtied so that HdPrmanVolume will update which 3d textures it will use.
Light -> Light Filter This declaration registers the light data source locator of a light prim to be invalidated if any locator of a targeted light filter changes.

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.

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