Ocean::Rendering::Manager Class Reference

This class manages all scene graphs. More...

#include <Manager.h>

Inheritance diagram for Ocean::Rendering::Manager:

Data Structures
class	EngineInformation
	Class holding engine information. More...

Public Types
using	EngineNames = std::vector< std::string >
	Definition of a vector holding engine names.

Public Member Functions
EngineRef	engine (const std::string &engine=std::string(), const Engine::GraphicAPI graphicAPI=Engine::API_DEFAULT)
	Returns a render engine of a specific scene graph.
EngineNames	engines ()
	Returns all names of registered engines.
Engine::GraphicAPI	supportedGraphicAPI (const std::string &engine)
	Returns the graphic API supported by a specified engine.
void	release ()
	Releases all registered rendering engines.

Private Types
using	EngineMap = std::multimap< unsigned int, EngineInformation >
	Definition of a map mapping rendering engine priorities to engine information objects.

Private Member Functions
virtual	~Manager ()
	Destructs the manager.
void	registerEngine (const std::string &engineName, const Engine::CreateCallback &callback, const Engine::GraphicAPI graphicAPI, const unsigned int priority)
	Registers a new render engine.
bool	unregisterEngine (const std::string &engine)
	Unregisters a render engine.
void	onRemoveEngine (const Engine *engine)
	Callback function to inform this manager that an engine is not in use anymore.

Private Attributes
EngineMap	engineMap_
	Registered engines.
Lock	lock_
	Manager lock.

Friends
class	Engine
class	Singleton< Manager >

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Singleton< Manager >
static Manager &	get ()
	Returns a reference to the unique object.
Protected Member Functions inherited from Ocean::Singleton< Manager >
	Singleton ()=default
	Default constructor.

Detailed Description

This class manages all scene graphs.

Use this manager to receive a specific render engine.

Member Typedef Documentation

EngineMap

using Ocean::Rendering::Manager::EngineMap = std::multimap<unsigned int, EngineInformation>

private

Definition of a map mapping rendering engine priorities to engine information objects.

EngineNames

using Ocean::Rendering::Manager::EngineNames = std::vector<std::string>

Definition of a vector holding engine names.

Constructor & Destructor Documentation

~Manager()

virtual Ocean::Rendering::Manager::~Manager ( )

privatevirtual

Destructs the manager.

Member Function Documentation

engine()

EngineRef Ocean::Rendering::Manager::engine	(	const std::string &	engine = std::string(),
		const Engine::GraphicAPI	graphicAPI = Engine::API_DEFAULT
	)

Returns a render engine of a specific scene graph.

If no engine name is specified one of the registered engines is returned.

Parameters

engine	Name of the engine to return
graphicAPI	Preferred graphic API used for rendering, however there is no guarantee for this API

Returns

Specified render engine

engines()

EngineNames Ocean::Rendering::Manager::engines

(

)

Returns all names of registered engines.

Returns

Engine names

onRemoveEngine()

void Ocean::Rendering::Manager::onRemoveEngine ( const Engine *  engine )

private

Callback function to inform this manager that an engine is not in use anymore.

Parameters

engine

Engine which is out of use

registerEngine()

void Ocean::Rendering::Manager::registerEngine ( const std::string &  engineName, const Engine::CreateCallback &  callback, const Engine::GraphicAPI  graphicAPI, const unsigned int  priority  )

private

Registers a new render engine.

Parameters

engineName	Name of the render engine
callback	Callback function which will create the engine object requested
graphicAPI	Graphic API supported by the engine
priority	Priority of this engine, if a default engine is requested the engine with higher priority will be retuned

release()

void Ocean::Rendering::Manager::release

(

)

Releases all registered rendering engines.

supportedGraphicAPI()

Engine::GraphicAPI Ocean::Rendering::Manager::supportedGraphicAPI

(

const std::string &

engine

)

Returns the graphic API supported by a specified engine.

Parameters

engine

Name of the engine to return the graphic API for

Returns

Supported graphic API, default api if the engine is unknown

unregisterEngine()

bool Ocean::Rendering::Manager::unregisterEngine ( const std::string &  engine )

private

Unregisters a render engine.

Parameters

engine

Name of the render engine to unregister

Returns

True, if succeeded

Friends And Related Symbol Documentation

Engine

friend class Engine

friend

Singleton< Manager >

friend class Singleton< Manager >

friend

Field Documentation

engineMap_

EngineMap Ocean::Rendering::Manager::engineMap_

private

Registered engines.

lock_

Lock Ocean::Rendering::Manager::lock_

private

Manager lock.

---

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

• rendering/Manager.h