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`.

Public Member Functions inherited from TfSingleton< HdSceneIndexNameRegistry >
void	DeleteInstance ()=delete

Static Public Member Functions
static HD_API HdSceneIndexNameRegistry &	GetInstance ()
	Returns the singleton-instance of this registry.

Static Public Member Functions inherited from TfSingleton< HdSceneIndexNameRegistry >
static HdSceneIndexNameRegistry &	GetInstance ()
	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 265 of file sceneIndex.h.

Member Function Documentation

static HD_API HdSceneIndexNameRegistry & GetInstance ( )

inlinestatic

Returns the singleton-instance of this registry.

Definition at line 277 of file sceneIndex.h.

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

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

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

Returns the names of all registered scene indexes.

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

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

friend

Definition at line 254 of file sceneIndex.h.

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