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

#include <sceneIndexPlugin.h>

+ Inheritance diagram for HdGpSceneIndexPlugin:

Public Member Functions

HDGP_API HdGpSceneIndexPlugin ()
 
- 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
 
- Public Member Functions inherited from HfPluginBase
virtual HF_API ~HfPluginBase ()
 

Static Public Member Functions

static const
HdSceneIndexPluginRegistry::InsertionPhase 		GetInsertionPhase ()
 

Protected Member Functions

HdSceneIndexBaseRefPtr _AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs) override
 
bool _IsEnabled (const HdContainerDataSourceHandle &inputArgs) const override
 
- Protected Member Functions inherited from HdSceneIndexPlugin
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

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

Definition at line 27 of file sceneIndexPlugin.h.

Constructor & Destructor Documentation

HDGP_API HdGpSceneIndexPlugin::HdGpSceneIndexPlugin ( )

Member Function Documentation

HdSceneIndexBaseRefPtr HdGpSceneIndexPlugin::_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 HdGpSceneIndexPlugin::_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 HdGpSceneIndexPlugin::GetInsertionPhase ( )
inlinestatic

Definition at line 31 of file sceneIndexPlugin.h.

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