RenderEngineManager Class Reference

Collection of render-engines. This provides access to all the render-engines available at runtime. RenderEngine objects should not be access directly, but instead via the RenderEngineManager to maintain a flexible render-engine agnostic design. More...

#include <RenderEngineManager.hh>

Public Member Functions
	RenderEngineManager ()
	Constructor. More...
	~RenderEngineManager ()
	Deconstructor. More...
RenderEngine *	Engine (const std::string &_name) const
	Get the render-engine with the given name. If the no render-engine is registered under the given name, NULL will be returned. More...
RenderEngine *	EngineAt (unsigned int _index) const
	Get the render-engine at the given index. If the no render-engine is exists at the given index, NULL will be returned. More...
unsigned int	EngineCount () const
	Get the number of available render-engines. More...
bool	HasEngine (const std::string &_name) const
	Determine if a render-engine with the given name is avaiable. More...
void	RegisterEngine (const std::string &_name, RenderEngine *_engine)
	Register a new render-engine under the given name. If the given name is already in use, the render-engine will not be registered. More...
void	UnregisterEngine (const std::string &_name)
	Unregister a render-engine registered under the given name. If the no render-engine is registered under the given name no work will be done. More...
void	UnregisterEngine (RenderEngine *_engine)
	Unregister the given render-engine. If the given render-engine is not currently registered, no work will be done. More...
void	UnregisterEngineAt (unsigned int _index)
	Unregister a render-engine at the given index. If the no render-engine is registered at the given index, no work will be done. More...

Detailed Description

Collection of render-engines. This provides access to all the render-engines available at runtime. RenderEngine objects should not be access directly, but instead via the RenderEngineManager to maintain a flexible render-engine agnostic design.

ignition/rendering/RenderEngineManager.hh

Constructor & Destructor Documentation

RenderEngineManager()

RenderEngineManager

(

)

Constructor.

~RenderEngineManager()

~RenderEngineManager

(

)

Deconstructor.

Member Function Documentation

Engine()

RenderEngine* Engine

(

const std::string &

_name

)

const

Get the render-engine with the given name. If the no render-engine is registered under the given name, NULL will be returned.

Parameters

EngineAt()

RenderEngine* EngineAt

(

unsigned int

_index

)

const

Get the render-engine at the given index. If the no render-engine is exists at the given index, NULL will be returned.

Parameters

[in]

_index

Index of the desired render-engine

Returns

The specified render-engine

EngineCount()

unsigned int EngineCount

(

)

const

Get the number of available render-engines.

Returns

the number of available render-engines

HasEngine()

bool HasEngine

(

const std::string &

_name

)

const

Determine if a render-engine with the given name is avaiable.

Parameters

[in]

_name

Name of the desired render-engine

Returns

True if the specified render-engine is available

RegisterEngine()

void RegisterEngine	(	const std::string &	_name,
		RenderEngine *	_engine
	)

Register a new render-engine under the given name. If the given name is already in use, the render-engine will not be registered.

Parameters

[in]	_name	Name the render-engine will be registered under
[in]	_engine	Render-engine to be registered

UnregisterEngine() [1/2]

void UnregisterEngine

(

const std::string &

_name

)

Unregister a render-engine registered under the given name. If the no render-engine is registered under the given name no work will be done.

Parameters

[in]

_name

Name of the render-engine to unregister

UnregisterEngine() [2/2]

void UnregisterEngine

(

RenderEngine *

_engine

)

Unregister the given render-engine. If the given render-engine is not currently registered, no work will be done.

Parameters

[in]

_engine

Render-engine to unregister

UnregisterEngineAt()

void UnregisterEngineAt

(

unsigned int

_index

)

Unregister a render-engine at the given index. If the no render-engine is registered at the given index, no work will be done.

Parameters

[in]

_index

Index of the render-engine to unregister

---

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

• RenderEngineManager.hh