HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
HdSceneIndexPlugin Class Reference

#include <sceneIndexPlugin.h>

+ Inheritance diagram for HdSceneIndexPlugin:

Public Member Functions

HD_API HdSceneIndexBaseRefPtr AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
 
- Public Member Functions inherited from HfPluginBase
virtual HF_API ~HfPluginBase ()
 

Protected Member Functions

virtual HD_API
HdSceneIndexBaseRefPtr 		_AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
 
virtual HD_API
HdSceneIndexBaseRefPtr 		_AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
 
 HdSceneIndexPlugin ()=default
 
HD_API ~HdSceneIndexPlugin () override
 
- Protected Member Functions inherited from HfPluginBase
HF_API HfPluginBase ()=default
 

Detailed Description

Definition at line 17 of file sceneIndexPlugin.h.

Constructor & Destructor Documentation

HdSceneIndexPlugin::HdSceneIndexPlugin ( )
protecteddefault
HD_API HdSceneIndexPlugin::~HdSceneIndexPlugin ( )
overrideprotected

Member Function Documentation

virtual HD_API HdSceneIndexBaseRefPtr HdSceneIndexPlugin::_AppendSceneIndex ( const HdSceneIndexBaseRefPtr &  inputScene,
const HdContainerDataSourceHandle &  inputArgs 
)
protectedvirtual

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 in HdSt_DependencySceneIndexPlugin, HdGpSceneIndexPlugin, HdsiDebuggingSceneIndexPlugin, HdSt_ImplicitSurfaceSceneIndexPlugin, HdSt_TetMeshConversionSceneIndexPlugin, HdSt_DependencyForwardingSceneIndexPlugin, HdSt_VelocityMotionResolvingSceneIndexPlugin, and HdSt_NurbsApproximatingSceneIndexPlugin.

virtual HD_API HdSceneIndexBaseRefPtr HdSceneIndexPlugin::_AppendSceneIndex ( const std::string &  renderInstanceId,
const HdSceneIndexBaseRefPtr &  inputScene,
const HdContainerDataSourceHandle &  inputArgs 
)
protectedvirtual

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.

Callers can override this method if they want to get the render instance ID in addition to the input scene and arguments. Callers should only override one of the two _AppendSceneIndex overrides: if both are overridden, only this override will be called.

HD_API HdSceneIndexBaseRefPtr HdSceneIndexPlugin::AppendSceneIndex ( const std::string &  renderInstanceId,
const HdSceneIndexBaseRefPtr &  inputScene,
const HdContainerDataSourceHandle &  inputArgs 
)
The documentation for this class was generated from the following file: