Collection d'incrustations, avec des fonctions additionnelles d'ajout et de suppression pour gérer les Z-Index. Plus de détails...

Graphe d'héritage de Castor3D::Cache< Overlay, Castor::String >:

Graphe de collaboration de Castor3D::Cache< Overlay, Castor::String >:

Classes
struct	OverlayCleaner

struct	OverlayInitialiser

Types publics
using	MyCacheType = CacheBase< Overlay, Castor::String >

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	Merger = typename MyCacheType::Merger

typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapIt	iterator

typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapConstIt	const_iterator

Types publics hérités de Castor3D::CacheBase< Overlay, Castor::String >
using	MyCacheType = CacheBase< Overlay, Castor::String >

using	MyCacheTraits = CacheTraits< Overlay, Castor::String >

using	Element = Overlay

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
	DECLARE_MAP (Castor::String, FontTextureSPtr, FontTextureStr)

C3D_API	Cache (Engine &p_engine, Producer &&p_produce, Initialiser &&p_initialise=Initialiser{}, Cleaner &&p_clean=Cleaner{}, Merger &&p_merge=Merger{})
	Constructeur. Plus de détails...

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

C3D_API void	Clear ()
	Vide les listes d'incrustations. Plus de détails...

C3D_API void	Cleanup ()
	Nettoie les incrustations. Plus de détails...

C3D_API void	UpdateRenderer ()
	Initialise ou nettoie l'OverlayRenderer, selon le statut du rendu. Plus de détails...

C3D_API void	Update ()
	Met à jour les incrustations. Plus de détails...

C3D_API void	Render (Scene const &p_scene, Castor::Size const &p_size)
	Fonction de rendu des overlays visibles. Plus de détails...

C3D_API bool	Write (Castor::TextFile &p_file) const
	Ecrit les overlays dans un fichier texte. Plus de détails...

C3D_API bool	Read (Castor::TextFile &p_file)
	Lit les overlays à partir d'un fichier texte. Plus de détails...

C3D_API FontTextureSPtr	GetFontTexture (Castor::String const &p_name)
	Récupère une FontTexture, à partir d'un nom de police. Plus de détails...

C3D_API FontTextureSPtr	CreateFontTexture (Castor::FontSPtr p_font)
	Crée une FontTexture, à partir d'une police. Plus de détails...

ElementPtr	Add (Key const &p_name, OverlayType p_type, SceneSPtr p_scene, OverlaySPtr p_parent)
	Crée un objet. Plus de détails...

ElementPtr	Add (Key const &p_name, ElementPtr p_element)
	Ajoute un objet déjà créé. Plus de détails...

OverlayRendererSPtr	GetRenderer () const
	Récupère le renderer d'incrustation. Plus de détails...

OverlayCategorySet::iterator	begin ()
	Récupère un itérateur sur la première incrustation. Plus de détails...

OverlayCategorySet::const_iterator	begin () const
	Récupère un itérateur sur la première incrustation. Plus de détails...

OverlayCategorySet::iterator	end ()
	Récupère un itérateur sur après la dernière incrustation. Plus de détails...

OverlayCategorySet::const_iterator	end () const
	Récupère un itérateur sur après la dernière incrustation. Plus de détails...

OverlayFactory const &	GetOverlayFactory () const
	Récupère la fabrique d'Overlay. Plus de détails...

OverlayFactory &	GetFactory ()
	Récupère la fabrique d'Overlay. Plus de détails...

Fonctions membres publiques hérités de Castor3D::CacheBase< Overlay, 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

Engine *	GetEngine () 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

Membres hérités additionnels
Attributs protégés hérités de Castor3D::CacheBase< Overlay, 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< Overlay, Castor::String >

Collection d'incrustations, avec des fonctions additionnelles d'ajout et de suppression pour gérer les Z-Index.

Auteur: Sylvain DOREMUS

Date: 09/02/2010

Version: 0.1

Documentation des définitions de type membres

◆ Collection

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

◆ const_iterator

typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapConstIt Castor3D::Cache< Overlay, Castor::String >::const_iterator

◆ Element

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

◆ ElementPtr

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

◆ iterator

typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapIt Castor3D::Cache< Overlay, Castor::String >::iterator

◆ Key

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

◆ Merger

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

◆ MyCacheType

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

◆ Producer

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

Documentation des constructeurs et destructeur

◆ Cache()

C3D_API Castor3D::Cache< Overlay, Castor::String >::Cache	(	Engine &	p_engine,
		Producer &&	p_produce,
		Initialiser &&	p_initialise = `Initialiser{}`,
		Cleaner &&	p_clean = `Cleaner{}`,
		Merger &&	p_merge = `Merger{}`
	)

Constructeur.

Paramètres

[in]	p_engine	Le moteur.
[in]	p_produce	Le créateur d'objet.
[in]	p_initialise	L'initialiseur d'objet.
[in]	p_clean	Le nettoyeur d'objet.
[in]	p_merge	Le fusionneur de collection d'objets.

◆ ~Cache()

C3D_API Castor3D::Cache< Overlay, Castor::String >::~Cache ( )

Destructeur.

Documentation des fonctions membres

◆ Add() [1/2]

ElementPtr Castor3D::Cache< Overlay, Castor::String >::Add	(	Key const &	p_name,
		OverlayType	p_type,
		SceneSPtr	p_scene,
		OverlaySPtr	p_parent
	)

inline

Crée un objet.

Paramètres

[in]	p_name	Le nom d'objet.
[in]	p_type	Le type d'incrustation.
[in]	p_scene	La scène.
[in]	p_parent	L'incrustation parente, si elle existe.

Renvoie: L'objet créé.

◆ Add() [2/2]

ElementPtr Castor3D::Cache< Overlay, Castor::String >::Add	(	Key const &	p_name,
		ElementPtr	p_element
	)

inline

Ajoute un objet déjà créé.

Paramètres

[in]	p_name	Le nom d'objet.
[in]	p_element	L'objet'.

Renvoie: L'objet.

◆ begin() [1/2]

OverlayCategorySet::iterator Castor3D::Cache< Overlay, Castor::String >::begin ( )

inline

Récupère un itérateur sur la première incrustation.

Renvoie: La valeur

◆ begin() [2/2]

OverlayCategorySet::const_iterator Castor3D::Cache< Overlay, Castor::String >::begin ( ) const

inline

Récupère un itérateur sur la première incrustation.

Renvoie: La valeur

◆ Cleanup()

C3D_API void Castor3D::Cache< Overlay, Castor::String >::Cleanup ( )

Nettoie les incrustations.

◆ Clear()

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

Vide les listes d'incrustations.

◆ CreateFontTexture()

C3D_API FontTextureSPtr Castor3D::Cache< Overlay, Castor::String >::CreateFontTexture ( Castor::FontSPtr p_font )

Crée une FontTexture, à partir d'une police.

Paramètres

[in] p_font La police.

Renvoie: La FontTexture créée.

◆ DECLARE_MAP()

Castor3D::Cache< Overlay, Castor::String >::DECLARE_MAP	(	Castor::String	,
		FontTextureSPtr	,
		FontTextureStr
	)

◆ end() [1/2]

OverlayCategorySet::iterator Castor3D::Cache< Overlay, Castor::String >::end ( )

inline

Récupère un itérateur sur après la dernière incrustation.

Renvoie: La valeur

◆ end() [2/2]

OverlayCategorySet::const_iterator Castor3D::Cache< Overlay, Castor::String >::end ( ) const

inline

Récupère un itérateur sur après la dernière incrustation.

Renvoie: La valeur

◆ GetFactory()

OverlayFactory& Castor3D::Cache< Overlay, Castor::String >::GetFactory ( )

inline

Récupère la fabrique d'Overlay.

Renvoie: La fabrique

◆ GetFontTexture()

C3D_API FontTextureSPtr Castor3D::Cache< Overlay, Castor::String >::GetFontTexture ( Castor::String const & p_name )

Récupère une FontTexture, à partir d'un nom de police.

Paramètres

[in] p_name Le nom de la police.

Renvoie: La FontTexture si elle exite, nullptr sinon.

◆ GetOverlayFactory()

OverlayFactory const& Castor3D::Cache< Overlay, Castor::String >::GetOverlayFactory ( ) const

inline

Récupère la fabrique d'Overlay.

Renvoie: La fabrique

◆ GetRenderer()

OverlayRendererSPtr Castor3D::Cache< Overlay, Castor::String >::GetRenderer ( ) const

inline

Récupère le renderer d'incrustation.

Renvoie: Le renderer d'incrustation

◆ Read()

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

Lit les overlays à partir d'un fichier texte.

Paramètres

[in] p_file Le fichier

Renvoie: true si tout s'est bien passé

◆ Render()

C3D_API void Castor3D::Cache< Overlay, Castor::String >::Render	(	Scene const &	p_scene,
		Castor::Size const &	p_size
	)

Fonction de rendu des overlays visibles.

Paramètres

[in]	p_scene	La scène rendue, pour afficher ses overlays en plus des globaux
[in]	p_size	Les dimensions de la cible du rendu

◆ Update()

C3D_API void Castor3D::Cache< Overlay, Castor::String >::Update ( )

Met à jour les incrustations.

◆ UpdateRenderer()

C3D_API void Castor3D::Cache< Overlay, Castor::String >::UpdateRenderer ( )

Initialise ou nettoie l'OverlayRenderer, selon le statut du rendu.

◆ Write()

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

Ecrit les overlays dans un fichier texte.

Paramètres

[out] p_file Le fichier

Renvoie: true si tout s'est bien passé

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Cache/OverlayCache.hpp

Classes

Types publics

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

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

Documentation des définitions de type membres

◆ Collection

◆ const_iterator

◆ Element

◆ ElementPtr

◆ iterator

◆ Key

◆ Merger

◆ MyCacheType

◆ Producer

Documentation des constructeurs et destructeur

◆ Cache()

◆ ~Cache()

Documentation des fonctions membres

◆ Add() [1/2]

◆ Add() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ Cleanup()

◆ Clear()

◆ CreateFontTexture()

◆ DECLARE_MAP()

◆ end() [1/2]

◆ end() [2/2]

◆ GetFactory()

◆ GetFontTexture()

◆ GetOverlayFactory()

◆ GetRenderer()

◆ Read()

◆ Render()

◆ Update()

◆ UpdateRenderer()

◆ Write()

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