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 &engine, Producer &&produce, Initialiser &&initialise, Cleaner &&clean, Merger &&merge)
	Constructeur. Plus de détails...

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

C3D_API void	initialise (MaterialType type)
	Initialise le matériau par défaut. Plus de détails...

C3D_API void	cleanup ()
	Met tous les éléments à nettoyer. Plus de détails...

C3D_API void	clear ()
	Supprime le matériau par défaut, vide la collection. Plus de détails...

C3D_API void	update ()
	Met à jour le tampon de passes. Plus de détails...

C3D_API MaterialSPtr	add (Key const &name, MaterialSPtr element)
	Retire un élément à partir d'un nom. Plus de détails...

C3D_API MaterialSPtr	add (Key const &name, MaterialType type)
	Crée un élément. Plus de détails...

C3D_API void	getNames (castor::StringArray &names)
	Remplit la liste des noms de tous les matériaux. Plus de détails...

C3D_API bool	write (castor::TextFile &file) const
	Ecrit les matériaux dans un fichier texte. Plus de détails...

C3D_API bool	read (castor::Path const &path)
	Lit les matériaux à partir d'un fichier. Plus de détails...

MaterialSPtr	getDefaultMaterial () const
	Récupère le matériau par défaut. Plus de détails...

PassBuffer const &	getPassBuffer () const

Fonctions membres publiques hérités de castor3d::CacheBase< Material, castor::String >
	CacheBase (Engine &engine, Producer &&produce, Initialiser &&initialise, Cleaner &&clean, Merger &&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 () const

ElementPtr	create (Key const &name, Parameters &&... parameters)
	Crée un élément. Plus de détails...

ElementPtr	add (Key const &name, ElementPtr element)
	Retire un élément à partir d'un nom. Plus de détails...

ElementPtr	add (Key const &name, Parameters &&... parameters)
	Crée un élément. Plus de détails...

void	remove (Key const &name)
	Retire un élément à partir d'un nom. Plus de détails...

void	mergeInto (MyCacheType &destination)

void	forEach (FuncType func) const
	Applique une fonction à tous les éléments de ce cache. Plus de détails...

void	forEach (FuncType func)
	Applique une fonction à tous les éléments de ce cache. Plus de détails...

uint32_t	getObjectCount () const

Engine *	getEngine () const

castor::String const &	getObjectTypeName () const

bool	has (Key const &name) const

ElementPtr	find (Key const &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

std::shared_ptr< PassBuffer >	m_passBuffer

Attributs protégés hérités de castor3d::CacheBase< Material, castor::String >
Engine &	m_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 &	engine,
		Producer &&	produce,
		Initialiser &&	initialise,
		Cleaner &&	clean,
		Merger &&	merge
	)

inline

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	produce	Le créateur d'objet.
[in]	initialise	L'initialiseur d'objet.
[in]	clean	Le nettoyeur d'objet.
[in]	merge	Le fusionneur de collection d'objets.

◆ ~Cache()

castor3d::Cache< Material, castor::String >::~Cache ( )

inline

Destructeur.

Références C3D_API.

Documentation des fonctions membres

◆ add() [1/2]

C3D_API MaterialSPtr castor3d::Cache< Material, castor::String >::add	(	Key const &	name,
		MaterialSPtr	element
	)

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

Paramètres

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

◆ add() [2/2]

C3D_API MaterialSPtr castor3d::Cache< Material, castor::String >::add	(	Key const &	name,
		MaterialType	type
	)

Crée un élément.

Paramètres

[in]	name	Le nom d'élément.
[in]	type	Le type de matéeiau.

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

◆ cleanup()

C3D_API void castor3d::Cache< Material, castor::String >::cleanup ( )

Met tous les éléments à nettoyer.

◆ 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 & names )

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

Paramètres

[out] names La liste de noms

◆ getPassBuffer()

PassBuffer const& castor3d::Cache< Material, castor::String >::getPassBuffer ( ) const

inline

Renvoie: Le tampon de passes.

◆ initialise()

C3D_API void castor3d::Cache< Material, castor::String >::initialise ( MaterialType type )

Initialise le matériau par défaut.

◆ read()

C3D_API bool castor3d::Cache< Material, castor::String >::read ( castor::Path const & path )

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

Paramètres

[in] path Le chemin d'accès au fichier.

Renvoie: true si tout s'est bien passé.

◆ update()

C3D_API void castor3d::Cache< Material, castor::String >::update ( )

Met à jour le tampon de passes.

◆ write()

C3D_API bool castor3d::Cache< Material, castor::String >::write ( castor::TextFile & file ) const

Ecrit les matériaux dans un fichier texte.

Paramètres

[out] file Le 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

◆ m_passBuffer

std::shared_ptr< PassBuffer > castor3d::Cache< Material, castor::String >::m_passBuffer

protected

Le tampon de passes.

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Cache/MaterialCache.hpp

Types publics

Fonctions membres publiques

Attributs protégés

Description détaillée

template<> class castor3d::Cache< Material, castor::String >

Documentation des définitions de type membres

◆ Cleaner

◆ Collection

◆ Element

◆ ElementPtr

◆ Initialiser

◆ Key

◆ Merger

◆ MyCacheTraits

◆ MyCacheType

◆ Producer

Documentation des constructeurs et destructeur

◆ Cache()

◆ ~Cache()

Documentation des fonctions membres

◆ add() [1/2]

◆ add() [2/2]

◆ cleanup()

◆ clear()

◆ getDefaultMaterial()

◆ getNames()

◆ getPassBuffer()

◆ initialise()

◆ read()

◆ update()

◆ write()

Documentation des données membres

◆ m_defaultMaterial

◆ m_passBuffer

template<>
class castor3d::Cache< Material, castor::String >