Loading...
Searching...
No Matches
HdSceneIndexNameRegistry Class Reference

A registry containing named instances of Hydra indexes. More...

#include <sceneIndex.h>

+ Inheritance diagram for HdSceneIndexNameRegistry:

Public Member Functions

HD_API void RegisterNamedSceneIndex (const std::string &name, HdSceneIndexBasePtr instance)
 Registers an instance of a scene index with a given name.
 
HD_API std::vector< std::string > GetRegisteredNames ()
 Returns the names of all registered scene indexes.
 
HD_API HdSceneIndexBaseRefPtr GetNamedSceneIndex (const std::string &name)
 Returns the scene index that was registered with the given name.
 

Static Public Member Functions

static HD_API HdSceneIndexNameRegistryGetInstance ()
 Returns the singleton-instance of this registry.
 
- Static Public Member Functions inherited from TfSingleton< HdSceneIndexNameRegistry >
static HdSceneIndexNameRegistryGetInstance ()
 Return a reference to an object of type T, creating it if necessary.
 
static bool CurrentlyExists ()
 Return whether or not the single object of type T is currently in existence.
 
static void SetInstanceConstructed (HdSceneIndexNameRegistry &instance)
 Indicate that the sole instance object has already been created.
 
static void DeleteInstance ()
 Destroy the sole instance object of type T, if it exists.
 

Friends

class TfSingleton< HdSceneIndexNameRegistry >
 

Detailed Description

A registry containing named instances of Hydra indexes.

Scene Indexes are not automatically registered here, and must be manually added (generally by the application).

Definition at line 266 of file sceneIndex.h.

Member Function Documentation

◆ GetInstance()

static HD_API HdSceneIndexNameRegistry & GetInstance ( )
inlinestatic

Returns the singleton-instance of this registry.

Definition at line 278 of file sceneIndex.h.

◆ GetNamedSceneIndex()

HD_API HdSceneIndexBaseRefPtr GetNamedSceneIndex ( const std::string &  name)

Returns the scene index that was registered with the given name.

◆ GetRegisteredNames()

HD_API std::vector< std::string > GetRegisteredNames ( )

Returns the names of all registered scene indexes.

◆ RegisterNamedSceneIndex()

HD_API void RegisterNamedSceneIndex ( const std::string &  name,
HdSceneIndexBasePtr  instance 
)

Registers an instance of a scene index with a given name.

Friends And Related Function Documentation

◆ TfSingleton< HdSceneIndexNameRegistry >

friend class TfSingleton< HdSceneIndexNameRegistry >
friend

Definition at line 255 of file sceneIndex.h.


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