#include <CacheView.hpp>

Graphe d'héritage de castor3d::CacheViewT< CacheT, EventT >:

Graphe de collaboration de castor3d::CacheViewT< CacheT, EventT >:

Types publics
using	ElementCacheT = CacheT

using	ElementT = typename ElementCacheT::ElementT

using	ElementKeyT = typename ElementCacheT::ElementKeyT

using	ElementCacheTraitsT = typename ElementCacheT::ElementCacheTraitsT

using	ElementPtrT = typename ElementCacheT::ElementPtrT

using	ElementObsT = typename ElementCacheT::ElementObsT

using	ElementContT = typename ElementCacheT::ElementContT

using	ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

using	ElementCleanerT = typename ElementCacheT::ElementCleanerT

using	ElementMergerT = typename ElementCacheT::ElementMergerT

Fonctions membres publiques
	CacheViewT (castor::String const &name, ElementCacheT &cache, ElementInitialiserT initialise=[](ElementObsT const &){}, ElementCleanerT clean=[](ElementObsT const &){})
	Constructeur.

void	clear ()
	Supprime du cache les éléments créés via cette vue.

template<typename ... ParametersT>
ElementObsT	add (ElementKeyT const &name, ParametersT &&... params)
	Crée un élément avec les informations données.

template<typename ... ParametersT>
ElementObsT	tryAdd (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... params)
	Crée ou récupère un élément avec les informations données.

bool	tryAdd (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Ajoute un élément déjà créé.

ElementObsT	add (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Ajoute un élément déjà créé.

bool	isEmpty () const

bool	has (ElementKeyT const &name) const

ElementObsT	tryFind (ElementKeyT const &name) const
	Cherche un élément par son nom.

ElementObsT	find (ElementKeyT const &name) const
	Cherche un élément par son nom.

ElementPtrT	tryRemove (ElementKeyT const &name)
	Retire un élément à partir d'un nom.

ElementPtrT	remove (ElementKeyT const &name)
	Retire un objet à partir d'un nom.

auto &	getCache () const

Itération.
auto	begin ()

auto	begin () const

auto	end ()

auto	end () const

Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.

T const &	getName () const noexcept
	Récupère le nom.

void	rename (T name) noexcept

Membres hérités additionnels
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Description détaillée

template<typename CacheT, EventType EventT>
class castor3d::CacheViewT< CacheT, EventT >

Vue sur un cache de ressources.

Remarques: Permet de supprimer tous les éléments créés via la vue et uniquement ceux là.

Documentation des définitions de type membres

◆ ElementCacheT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementCacheT = CacheT

◆ ElementCacheTraitsT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementCacheTraitsT = typename ElementCacheT::ElementCacheTraitsT

◆ ElementCleanerT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

◆ ElementContT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementContT = typename ElementCacheT::ElementContT

◆ ElementInitialiserT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

◆ ElementKeyT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementKeyT = typename ElementCacheT::ElementKeyT

◆ ElementMergerT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementMergerT = typename ElementCacheT::ElementMergerT

◆ ElementObsT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementObsT = typename ElementCacheT::ElementObsT

◆ ElementPtrT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementPtrT = typename ElementCacheT::ElementPtrT

◆ ElementT

template<typename CacheT , EventType EventT>

using castor3d::CacheViewT< CacheT, EventT >::ElementT = typename ElementCacheT::ElementT

Documentation des constructeurs et destructeur

◆ CacheViewT()

template<typename CacheT , EventType EventT>

castor3d::CacheViewT< CacheT, EventT >::CacheViewT	(	castor::String const &	name,
		ElementCacheT &	cache,
		ElementInitialiserT	initialise = [](ElementObsT const &){},
		ElementCleanerT	clean = [](ElementObsT const &){} )

Constructeur.

Paramètres

[in]	name	The view name.
[in]	initialise	L'initialiseur d'objet.
[in]	clean	Le nettoyeur d'objet.
[in]	cache	The viewed cache.

Documentation des fonctions membres

◆ add() [1/2]

template<typename CacheT , EventType EventT>

ElementObsT castor3d::CacheViewT< CacheT, EventT >::add	(	ElementKeyT const &	name,
		ElementPtrT &	element,
		bool	initialise = false )

Ajoute un élément déjà créé.

Paramètres

[in]	name	Le nom d'élément.
[in]	element	L'élément.
[in]	initialise	Dit si l'élément doit être initialisé après sa création.

◆ add() [2/2]

template<typename CacheT , EventType EventT>

template<typename ... ParametersT>

ElementObsT castor3d::CacheViewT< CacheT, EventT >::add	(	ElementKeyT const &	name,
		ParametersT &&...	params )

Crée un élément avec les informations données.

.=

Paramètres

[in]	name	Le nom de l'élément.
[in]	params	Les paramètres transmis au cache vu.

Renvoie: L'élément créé.

◆ begin() [1/2]

template<typename CacheT , EventType EventT>

auto castor3d::CacheViewT< CacheT, EventT >::begin ( )

inline

◆ begin() [2/2]

template<typename CacheT , EventType EventT>

auto castor3d::CacheViewT< CacheT, EventT >::begin ( ) const

inline

◆ clear()

template<typename CacheT , EventType EventT>

void castor3d::CacheViewT< CacheT, EventT >::clear ( )

Supprime du cache les éléments créés via cette vue.

◆ end() [1/2]

template<typename CacheT , EventType EventT>

auto castor3d::CacheViewT< CacheT, EventT >::end ( )

inline

◆ end() [2/2]

template<typename CacheT , EventType EventT>

auto castor3d::CacheViewT< CacheT, EventT >::end ( ) const

inline

◆ find()

template<typename CacheT , EventType EventT>

ElementObsT castor3d::CacheViewT< CacheT, EventT >::find ( ElementKeyT const & name ) const

Cherche un élément par son nom.

Paramètres

[in] name Le nom d'objet.

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

◆ getCache()

template<typename CacheT , EventType EventT>

auto & castor3d::CacheViewT< CacheT, EventT >::getCache ( ) const

inline

◆ has()

template<typename CacheT , EventType EventT>

bool castor3d::CacheViewT< CacheT, EventT >::has ( ElementKeyT const & name ) const

Paramètres

[in] name Le nom d'objet.

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

◆ isEmpty()

template<typename CacheT , EventType EventT>

bool castor3d::CacheViewT< CacheT, EventT >::isEmpty ( ) const

Renvoie: true si la vue est vide.

◆ remove()

template<typename CacheT , EventType EventT>

ElementPtrT castor3d::CacheViewT< CacheT, EventT >::remove ( ElementKeyT const & name )

Retire un objet à partir d'un nom.

Paramètres

[in] name Le nom d'objet.

◆ tryAdd() [1/2]

template<typename CacheT , EventType EventT>

template<typename ... ParametersT>

ElementObsT castor3d::CacheViewT< CacheT, EventT >::tryAdd	(	ElementKeyT const &	name,
		bool	initialise,
		ElementObsT &	created,
		ParametersT &&...	params )

Crée ou récupère un élément avec les informations données.

.=

Paramètres

[in]	name	Le nom de l'élément.
[out]	created	Reçoit l'élement créé s'il l'a été.
[in]	initialise	Dit si l'élément doit être initialisé après sa création.
[in]	params	Les paramètres transmis au cache vu.

Renvoie: L'élément créé ou existant.

◆ tryAdd() [2/2]

template<typename CacheT , EventType EventT>

bool castor3d::CacheViewT< CacheT, EventT >::tryAdd	(	ElementKeyT const &	name,
		ElementPtrT &	element,
		bool	initialise = false )

Ajoute un élément déjà créé.

Paramètres

[in]	name	Le nom d'élément.
[in]	element	L'élément.
[in]	initialise	Dit si l'élément doit être initialisé après sa création.

◆ tryFind()

template<typename CacheT , EventType EventT>

ElementObsT castor3d::CacheViewT< CacheT, EventT >::tryFind ( ElementKeyT const & name ) const

Cherche un élément par son nom.

Paramètres

[in] name Le nom d'objet.

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

◆ tryRemove()

template<typename CacheT , EventType EventT>

ElementPtrT castor3d::CacheViewT< CacheT, EventT >::tryRemove ( ElementKeyT const & name )

Retire un élément à partir d'un nom.

Paramètres

[in] name Le nom d'élément.

La documentation de cette classe a été générée à partir des fichiers suivants :

Castor3D/Cache/CacheModule.hpp
Castor3D/Cache/CacheView.hpp

Types publics

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ElementCacheT

◆ ElementCacheTraitsT

◆ ElementCleanerT

◆ ElementContT

◆ ElementInitialiserT

◆ ElementKeyT

◆ ElementMergerT

◆ ElementObsT

◆ ElementPtrT

◆ ElementT

Documentation des constructeurs et destructeur

◆ CacheViewT()

Documentation des fonctions membres

◆ add() [1/2]

◆ add() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ end() [1/2]

◆ end() [2/2]

◆ find()

◆ getCache()

◆ has()

◆ isEmpty()

◆ remove()

◆ tryAdd() [1/2]

◆ tryAdd() [2/2]

◆ tryFind()

◆ tryRemove()