Classe de base pour un gestionnaire d'éléments. Plus de détails...

Graphe d'héritage de Castor3D::Manager< Key, Elem, Owner, EngineGetter >:

Graphe de collaboration de Castor3D::Manager< Key, Elem, Owner, EngineGetter >:

Types publics
typedef Castor::Collection< Elem, Key >	Collection

Fonctions membres publiques
void	Cleanup ()
	Met tous les éléments à nettoyer. Plus de détails...

void	Clear ()
	Vide la collection. Plus de détails...

bool	IsEmpty ()

void	Insert (Key const &p_name, std::shared_ptr< Elem > p_element)
	Retire un objet à partir d'un nom. Plus de détails...

void	Remove (Key const &p_name)
	Retire un objet à partir d'un nom. Plus de détails...

void	SetRenderSystem (RenderSystem *p_renderSystem)

RenderSystem *	SetRenderSystem () const

Engine *	GetEngine () const

Castor::String const &	GetObjectTypeName () const

bool	Has (Key const &p_name) const

std::shared_ptr< Elem >	Find (Key const &p_name) const
	Cherche un élément par son nom. Plus de détails...

void	lock () const
	Locke le mutex de la collection. Plus de détails...

void	unlock () const
	Délocke le mutex de la collection. Plus de détails...

Collection::TObjPtrMapIt	begin ()
	Renvoie un itérateur sur le premier élément de la collection. Plus de détails...

Collection::TObjPtrMapConstIt	begin () const
	Renvoie un itérateur constant sur le premier élément de la collection. Plus de détails...

Collection::TObjPtrMapIt	end ()
	Renvoie un itérateur sur l'après dernier élément de la collection. Plus de détails...

Collection::TObjPtrMapConstIt	end () const
	Renvoie un itérateur constant sur l'après dernier élément de la collection. Plus de détails...

template<typename... Parameters>
std::shared_ptr< Elem >	Create (Key const &p_name, Parameters &&...p_params)
	Crée un objet. Plus de détails...

Fonctions membres protégées
	Manager (Owner &p_owner)
	Constructeur. Plus de détails...

	~Manager ()
	Destructeur. Plus de détails...

Attributs protégés
RenderSystem *	m_renderSystem
	Le RenderSystem. Plus de détails...

Collection	m_elements
	La collection d'éléments. Plus de détails...

Description détaillée

template<typename Key, typename Elem, typename Owner, typename EngineGetter>
class Castor3D::Manager< Key, Elem, Owner, EngineGetter >

Classe de base pour un gestionnaire d'éléments.

Auteur: Sylvain DOREMUS

Date: 13/10/2015

Version: 0.8.0

Documentation des définitions de type membres

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

typedef Castor::Collection< Elem, Key > Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Collection

Documentation des constructeurs et destructeur

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Manager ( Owner & p_owner )

inlineprotected

Constructeur.

Paramètres

[in] p_owner Le propriétaire.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Castor3D::Manager< Key, Elem, Owner, EngineGetter >::~Manager ( )

inlineprotected

Destructeur.

Documentation des fonctions membres

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Collection::TObjPtrMapIt Castor3D::Manager< Key, Elem, Owner, EngineGetter >::begin ( )

inline

Renvoie un itérateur sur le premier élément de la collection.

Renvoie: L'itérateur

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Collection::TObjPtrMapConstIt Castor3D::Manager< Key, Elem, Owner, EngineGetter >::begin ( ) const

inline

Renvoie un itérateur constant sur le premier élément de la collection.

Renvoie: L'itérateur

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Cleanup ( void )

inline

Met tous les éléments à nettoyer.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Clear ( )

inline

Vide la collection.

Référencé par Castor3D::ObjectManager< Castor::String, AnimatedObjectGroup >::MergeInto().

Voici le graphe des appelants de cette fonction :

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

template<typename... Parameters>

std::shared_ptr< Elem > Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Create	(	Key const &	p_name,
		Parameters &&...	p_params
	)

inline

Crée un objet.

Paramètres

[in]	p_name	Le nom d'objet.
[in]	p_params	Les autres paramètres de construction.

Renvoie: L'objet créé.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Collection::TObjPtrMapIt Castor3D::Manager< Key, Elem, Owner, EngineGetter >::end ( )

inline

Renvoie un itérateur sur l'après dernier élément de la collection.

Renvoie: L'itérateur

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Collection::TObjPtrMapConstIt Castor3D::Manager< Key, Elem, Owner, EngineGetter >::end ( ) const

inline

Renvoie un itérateur constant sur l'après dernier élément de la collection.

Renvoie: L'itérateur

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

std::shared_ptr< Elem > Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Find ( Key const & p_name ) const

inline

Cherche un élément par son nom.

Paramètres

[in] p_name Le nom d'objet.

Renvoie: L'élément trouvé, nullptr si non trouvé.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Engine* Castor3D::Manager< Key, Elem, Owner, EngineGetter >::GetEngine ( ) const

inline

Renvoie: L'Engine.

Référencé par Castor3D::ObjectManagerEngineGetter::Get().

Voici le graphe des appelants de cette fonction :

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Castor::String const& Castor3D::Manager< Key, Elem, Owner, EngineGetter >::GetObjectTypeName ( ) const

inline

Renvoie: L'Engine.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

bool Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Has ( Key const & p_name ) const

inline

Paramètres

[in] p_name Le nom d'objet.

Renvoie: true Si un élément avec le nom donné existe.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Insert	(	Key const &	p_name,
		std::shared_ptr< Elem >	p_element
	)

inline

Retire un objet à partir d'un nom.

Paramètres

[in]	p_name	Le nom d'élément.
[in]	p_element	L'élément.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

bool Castor3D::Manager< Key, Elem, Owner, EngineGetter >::IsEmpty ( )

inline

Renvoie: true si le gestionnaire est vide.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::lock ( ) const

inline

Locke le mutex de la collection.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::Remove ( Key const & p_name )

inline

Retire un objet à partir d'un nom.

Paramètres

[in] p_name Le nom d'objet.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::SetRenderSystem ( RenderSystem * p_renderSystem )

inline

Paramètres

[in] p_renderSystem Le RenderSystem.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

RenderSystem* Castor3D::Manager< Key, Elem, Owner, EngineGetter >::SetRenderSystem ( ) const

inline

Renvoie: Le RenderSystem.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

void Castor3D::Manager< Key, Elem, Owner, EngineGetter >::unlock ( ) const

inline

Délocke le mutex de la collection.

Documentation des données membres

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

Collection Castor3D::Manager< Key, Elem, Owner, EngineGetter >::m_elements

mutableprotected

La collection d'éléments.

template<typename Key, typename Elem, typename Owner, typename EngineGetter>

RenderSystem* Castor3D::Manager< Key, Elem, Owner, EngineGetter >::m_renderSystem

protected

Le RenderSystem.

La documentation de cette classe a été générée à partir du fichier suivant :

Y:/software/Castor3D/source/Core/Castor3D/Src/Manager.hpp

Types publics

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

template<typename Key, typename Elem, typename Owner, typename EngineGetter> class Castor3D::Manager< Key, Elem, Owner, EngineGetter >

Documentation des définitions de type membres

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres

template<typename Key, typename Elem, typename Owner, typename EngineGetter>
class Castor3D::Manager< Key, Elem, Owner, EngineGetter >