Castor3D  ..
Types publics | Fonctions membres publiques | Attributs protégés | Liste de tous les membres
Référence du modèle de la classe Castor3D::Cache< Material, Castor::String >

Collection de matériaux, avec des fonctions additionnelles. Plus de détails...

+ Graphe d'héritage de Castor3D::Cache< Material, Castor::String >:
+ Graphe de collaboration de Castor3D::Cache< Material, Castor::String >:

Types publics

using MyCacheType = CacheBase< Material, Castor::String >
 
using MyCacheTraits = typename MyCacheType::MyCacheTraits
 
using Element = typename MyCacheType::Element
 
using Key = typename MyCacheType::Key
 
using Collection = typename MyCacheType::Collection
 
using ElementPtr = typename MyCacheType::ElementPtr
 
using Producer = typename MyCacheType::Producer
 
using Initialiser = typename MyCacheType::Initialiser
 
using Cleaner = typename MyCacheType::Cleaner
 
using Merger = typename MyCacheType::Merger
 
- Types publics hérités de Castor3D::CacheBase< Material, Castor::String >
using MyCacheType = CacheBase< Material, Castor::String >
 
using MyCacheTraits = CacheTraits< Material, Castor::String >
 
using Element = Material
 
using Key = Castor::String
 
using Collection = Castor::Collection< Element, Key >
 
using ElementPtr = std::shared_ptr< Element >
 
using Producer = typename MyCacheTraits::Producer
 
using Merger = typename MyCacheTraits::Merger
 
using Initialiser = ElementInitialiser< Element >
 
using Cleaner = ElementCleaner< Element >
 

Fonctions membres publiques

 Cache (Engine &p_engine, Producer &&p_produce, Initialiser &&p_initialise, Cleaner &&p_clean, Merger &&p_merge)
 Constructeur. Plus de détails...
 
 ~Cache ()
 Destructeur. Plus de détails...
 
C3D_API void Initialise ()
 
C3D_API void Clear ()
 Supprime le matériau par défaut, vide la collection. Plus de détails...
 
C3D_API void GetNames (Castor::StringArray &p_names)
 Remplit la liste des noms de tous les matériaux. Plus de détails...
 
C3D_API bool Write (Castor::TextFile &p_file) const
 Ecrit les matériaux dans un fichier texte. Plus de détails...
 
C3D_API bool Read (Castor::TextFile &p_file)
 Lit les matériaux à partir d'un fichier texte. Plus de détails...
 
MaterialSPtr GetDefaultMaterial () const
 Récupère le matériau par défaut. Plus de détails...
 
- Fonctions membres publiques hérités de Castor3D::CacheBase< Material, Castor::String >
 CacheBase (Engine &p_engine, Producer &&p_produce, Initialiser &&p_initialise, Cleaner &&p_clean, Merger &&p_merge)
 Constructeur. Plus de détails...
 
 ~CacheBase ()
 Destructeur. Plus de détails...
 
void Cleanup ()
 Met tous les éléments à nettoyer. Plus de détails...
 
void Clear ()
 Vide la collection. Plus de détails...
 
bool IsEmpty ()
 
ElementPtr Create (Key const &p_name, Parameters &&... p_parameters)
 Crée un élément. Plus de détails...
 
ElementPtr Add (Key const &p_name, ElementPtr p_element)
 Retire un élément à partir d'un nom. Plus de détails...
 
ElementPtr Add (Key const &p_name, Parameters &&... p_parameters)
 Crée un élément. Plus de détails...
 
void Remove (Key const &p_name)
 Retire un élément à partir d'un nom. Plus de détails...
 
void MergeInto (MyCacheType &p_destination)
 
void ForEach (FuncType p_func) const
 Applique une fonction à tous les éléments de ce cache. Plus de détails...
 
void ForEach (FuncType p_func)
 Applique une fonction à tous les éléments de ce cache. Plus de détails...
 
uint32_t GetObjectCount () const
 
EngineGetEngine () const
 
Castor::String const & GetObjectTypeName () const
 
bool Has (Key const &p_name) const
 
ElementPtr 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...
 
auto begin ()
 
auto begin () const
 
auto end ()
 
auto end () const
 

Attributs protégés

MaterialSPtr m_defaultMaterial
 
- Attributs protégés hérités de Castor3D::CacheBase< Material, Castor::String >
Enginem_engine
 
Collection m_elements
 
Producer m_produce
 
Initialiser m_initialise
 
Cleaner m_clean
 
Merger m_merge
 

Description détaillée

template<>
class Castor3D::Cache< Material, Castor::String >

Collection de matériaux, avec des fonctions additionnelles.

Auteur
Sylvain DOREMUS
Date
09/02/2010
Version
0.1

Documentation des définitions de type membres

◆ Cleaner

using Castor3D::Cache< Material, Castor::String >::Cleaner = typename MyCacheType::Cleaner

◆ Collection

using Castor3D::Cache< Material, Castor::String >::Collection = typename MyCacheType::Collection

◆ Element

using Castor3D::Cache< Material, Castor::String >::Element = typename MyCacheType::Element

◆ ElementPtr

using Castor3D::Cache< Material, Castor::String >::ElementPtr = typename MyCacheType::ElementPtr

◆ Initialiser

using Castor3D::Cache< Material, Castor::String >::Initialiser = typename MyCacheType::Initialiser

◆ Key

using Castor3D::Cache< Material, Castor::String >::Key = typename MyCacheType::Key

◆ Merger

using Castor3D::Cache< Material, Castor::String >::Merger = typename MyCacheType::Merger

◆ MyCacheTraits

using Castor3D::Cache< Material, Castor::String >::MyCacheTraits = typename MyCacheType::MyCacheTraits

◆ MyCacheType

using Castor3D::Cache< Material, Castor::String >::MyCacheType = CacheBase< Material, Castor::String >

◆ Producer

using Castor3D::Cache< Material, Castor::String >::Producer = typename MyCacheType::Producer

Documentation des constructeurs et destructeur

◆ Cache()

Castor3D::Cache< Material, Castor::String >::Cache ( Engine p_engine,
Producer &&  p_produce,
Initialiser &&  p_initialise,
Cleaner &&  p_clean,
Merger &&  p_merge 
)
inline

Constructeur.

Paramètres
[in]p_engineLe moteur.
[in]p_produceLe créateur d'objet.
[in]p_initialiseL'initialiseur d'objet.
[in]p_cleanLe nettoyeur d'objet.
[in]p_mergeLe fusionneur de collection d'objets.

◆ ~Cache()

Castor3D::Cache< Material, Castor::String >::~Cache ( )
inline

Destructeur.

Références C3D_API.

Documentation des fonctions membres

◆ Clear()

C3D_API void Castor3D::Cache< Material, Castor::String >::Clear ( )

Supprime le matériau par défaut, vide la collection.

◆ GetDefaultMaterial()

MaterialSPtr Castor3D::Cache< Material, Castor::String >::GetDefaultMaterial ( ) const
inline

Récupère le matériau par défaut.

◆ GetNames()

C3D_API void Castor3D::Cache< Material, Castor::String >::GetNames ( Castor::StringArray &  p_names)

Remplit la liste des noms de tous les matériaux.

Paramètres
[out]p_namesLa liste de noms

◆ Initialise()

C3D_API void Castor3D::Cache< Material, Castor::String >::Initialise ( )

◆ Read()

C3D_API bool Castor3D::Cache< Material, Castor::String >::Read ( Castor::TextFile &  p_file)

Lit les matériaux à partir d'un fichier texte.

Paramètres
[in]p_fileLe fichier
Renvoie
true si tout s'est bien passé

◆ Write()

C3D_API bool Castor3D::Cache< Material, Castor::String >::Write ( Castor::TextFile &  p_file) const

Ecrit les matériaux dans un fichier texte.

Paramètres
[out]p_fileLe fichier
Renvoie
true si tout s'est bien passé

Documentation des données membres

◆ m_defaultMaterial

MaterialSPtr Castor3D::Cache< Material, Castor::String >::m_defaultMaterial
protected

Le matériau par défaut


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