Ocean::Rendering::ObjectRefManager Class Reference

This class implements a rendering object reference manager. More...

#include <ObjectRef.h>

Inheritance diagram for Ocean::Rendering::ObjectRefManager:

Public Member Functions
bool	hasEngineObject (const std::string &engine, const bool writeObjectToLog) const
	Tests whether this manager holds still some objects of a specific rendering engine.

Protected Types
using	NameMap = std::unordered_multimap< std::string, ObjectId >
	Definition of a multimap mapping object names to object ids.
using	ObjectMap = std::unordered_map< ObjectId, ObjectRef >
	Definition of a map mapping object ids to object references.

Protected Member Functions
	~ObjectRefManager ()
	Destructs the manager.
ObjectRef	object (const ObjectId objectId) const
	Returns an object by a given object id.
ObjectRef	object (const std::string &name) const
	Returns the first object specified by a given name.
ObjectRefs	objects (const std::string &name) const
	Returns all objects specified by a given name.
ObjectRef	registerObject (Object *object)
	Registers a new object.
void	changeRegisteredObject (ObjectId objectId, const std::string &oldName, const std::string &newName)
	Changes the name of a registered object.
void	unregisterObject (const Object *object)
	Unregisters an object.
Protected Member Functions inherited from Ocean::Singleton< ObjectRefManager >
	Singleton ()=default
	Default constructor.

Protected Attributes
ObjectMap	objectMap_
	Map holding all object references.
NameMap	nameMap_
	Map mapping object names to object pointers.
Lock	lock_
	Lock for the object map.

Friends
class	Singleton< ObjectRefManager >
class	Ocean::ObjectRef< Object >
class	Engine
class	Factory
class	Object

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Singleton< ObjectRefManager >
static ObjectRefManager &	get ()
	Returns a reference to the unique object.

Detailed Description

This class implements a rendering object reference manager.

Member Typedef Documentation

NameMap

using Ocean::Rendering::ObjectRefManager::NameMap = std::unordered_multimap<std::string, ObjectId>

protected

Definition of a multimap mapping object names to object ids.

ObjectMap

using Ocean::Rendering::ObjectRefManager::ObjectMap = std::unordered_map<ObjectId, ObjectRef>

protected

Definition of a map mapping object ids to object references.

Constructor & Destructor Documentation

~ObjectRefManager()

Ocean::Rendering::ObjectRefManager::~ObjectRefManager ( )

protected

Destructs the manager.

Member Function Documentation

changeRegisteredObject()

void Ocean::Rendering::ObjectRefManager::changeRegisteredObject ( ObjectId  objectId, const std::string &  oldName, const std::string &  newName  )

protected

Changes the name of a registered object.

Parameters

objectId	Id of the object to change
oldName	Old object name
newName	New object name

hasEngineObject()

bool Ocean::Rendering::ObjectRefManager::hasEngineObject	(	const std::string &	engine,
		const bool	writeObjectToLog
	)		const

Tests whether this manager holds still some objects of a specific rendering engine.

Parameters

engine	Name of the engine to test
writeObjectToLog	True, to write all engine objects to the log

Returns

True, if so

object() [1/2]

ObjectRef Ocean::Rendering::ObjectRefManager::object ( const ObjectId  objectId ) const

protected

Returns an object by a given object id.

If the object does not exist an empty reference is returned.

Parameters

objectId

Id of the object to return

Returns

Object reference of the requested object

See also

Engine::object().

object() [2/2]

ObjectRef Ocean::Rendering::ObjectRefManager::object ( const std::string &  name ) const

protected

Returns the first object specified by a given name.

If the object does not exist an empty reference is returned.

Parameters

name	The name of the object

Returns

Object reference of the requested object

See also

Engine::object().

objects()

ObjectRefs Ocean::Rendering::ObjectRefManager::objects ( const std::string &  name ) const

protected

Returns all objects specified by a given name.

Parameters

name	The name of the objects to return

Returns

Specified objects

See also

Engine::objects().

registerObject()

ObjectRef Ocean::Rendering::ObjectRefManager::registerObject ( Object *  object )

protected

Registers a new object.

Parameters

object

The object to manage, must be valid

Returns

Object reference

unregisterObject()

void Ocean::Rendering::ObjectRefManager::unregisterObject ( const Object *  object )

protected

Unregisters an object.

Friends And Related Symbol Documentation

Engine

friend class Engine

friend

Factory

friend class Factory

friend

Object

friend class Object

friend

Ocean::ObjectRef< Object >

friend class Ocean::ObjectRef< Object >

friend

Singleton< ObjectRefManager >

friend class Singleton< ObjectRefManager >

friend

Field Documentation

lock_

Lock Ocean::Rendering::ObjectRefManager::lock_

mutableprotected

Lock for the object map.

nameMap_

NameMap Ocean::Rendering::ObjectRefManager::nameMap_

protected

Map mapping object names to object pointers.

objectMap_

ObjectMap Ocean::Rendering::ObjectRefManager::objectMap_

protected

Map holding all object references.

---

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

• rendering/ObjectRef.h