Castor3D 0.12.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Liste de tous les membres
Référence du modèle de la classe castor3d::CacheViewT< CacheT, EventT >

#include <CacheView.hpp>

Graphe d'héritage de castor3d::CacheViewT< CacheT, EventT >:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::CacheViewT< CacheT, EventT >:
Collaboration graph
[légende]

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. Plus de détails...
 
 ~CacheViewT ()=default
 Destructeur. Plus de détails...
 
void clear ()
 Supprime du cache les éléments créés via cette vue. Plus de détails...
 
template<typename ... ParametersT>
ElementObsT add (ElementKeyT const &name, ParametersT &&... params)
 Crée un élément avec les informations données. Plus de détails...
 
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. Plus de détails...
 
bool tryAdd (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
 Ajoute un élément déjà créé. Plus de détails...
 
ElementObsT add (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
 Ajoute un élément déjà créé. Plus de détails...
 
bool isEmpty () const
 
bool has (ElementKeyT const &name) const
 
ElementObsT tryFind (ElementKeyT const &name) const
 Cherche un élément par son nom. Plus de détails...
 
ElementObsT find (ElementKeyT const &name) const
 Cherche un élément par son nom. Plus de détails...
 
ElementObsT tryRemove (ElementKeyT const &name)
 Retire un élément à partir d'un nom. Plus de détails...
 
void remove (ElementKeyT const &name)
 Retire un objet à partir d'un nom. Plus de détails...
 
Itération.
auto begin ()
 
auto begin () const
 
auto end ()
 
auto end () const
 

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 &){} 
)
inline

Constructeur.

Paramètres
[in]nameThe view name.
[in]initialiseL'initialiseur d'objet.
[in]cleanLe nettoyeur d'objet.
[in]cacheThe viewed cache.

◆ ~CacheViewT()

template<typename CacheT , EventType EventT>
castor3d::CacheViewT< CacheT, EventT >::~CacheViewT ( )
default

Destructeur.

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 
)
inline

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

Paramètres
[in]nameLe nom d'élément.
[in]elementL'élément.
[in]initialiseDit 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 
)
inline

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

.=

Paramètres
[in]nameLe nom de l'élément.
[in]paramsLes 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 ( )
inline

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
inline

Cherche un élément par son nom.

Paramètres
[in]nameLe nom d'objet.
Renvoie
L'élément trouvé, nullptr si non trouvé.

◆ has()

template<typename CacheT , EventType EventT>
bool castor3d::CacheViewT< CacheT, EventT >::has ( ElementKeyT const &  name) const
inline
Paramètres
[in]nameLe 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
inline
Renvoie
true si la vue est vide.

◆ remove()

template<typename CacheT , EventType EventT>
void castor3d::CacheViewT< CacheT, EventT >::remove ( ElementKeyT const &  name)
inline

Retire un objet à partir d'un nom.

Paramètres
[in]nameLe 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 
)
inline

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

.=

Paramètres
[in]nameLe nom de l'élément.
[out]createdReçoit l'élement créé s'il l'a été.
[in]initialiseDit si l'élément doit être initialisé après sa création.
[in]paramsLes 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 
)
inline

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

Paramètres
[in]nameLe nom d'élément.
[in]elementL'élément.
[in]initialiseDit 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
inline

Cherche un élément par son nom.

Paramètres
[in]nameLe nom d'objet.
Renvoie
L'élément trouvé, nullptr si non trouvé.

◆ tryRemove()

template<typename CacheT , EventType EventT>
ElementObsT castor3d::CacheViewT< CacheT, EventT >::tryRemove ( ElementKeyT const &  name)
inline

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

Paramètres
[in]nameLe nom d'élément.

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