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

#include <OverlayCache.hpp>

Graphe d'héritage de castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >:

[légende]

Graphe de collaboration de castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >:

[légende]

Types publics
using	ElementT = castor3d::Overlay

using	ElementKeyT = String

using	ElementCacheTraitsT = castor3d::OverlayCacheTraits

using	ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, 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

using	iterator = castor::Map< ElementT, ElementKeyT >::iterator

using	const_iterator = castor::Map< ElementT, ElementKeyT >::const_iterator

using	OverlayCategories = castor::Vector< castor3d::OverlayCategoryRPtr >

Types publics hérités de castor::ResourceCacheBaseT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >
using	ElementT

using	ElementKeyT

using	ElementCacheTraitsT

using	ElementCacheBaseT

using	ElementCacheT

using	ElementPtrT

using	ElementObsT

using	ElementContT

using	ElementInitialiserT

using	ElementCleanerT

using	ElementMergerT

Fonctions membres publiques
	CU_DeclareMap (ElementKeyT, castor3d::FontTextureUPtr, FontTextureStr)

C3D_API	ResourceCacheT (castor3d::Engine &engine)
	Constructeur.

C3D_API void	clear () noexcept
	Vide les listes d'incrustations.

C3D_API void	cleanup ()
	Nettoie les incrustations.

C3D_API void	initialise (castor3d::Overlay &overlay)

C3D_API void	cleanup (castor3d::Overlay &overlay)

C3D_API void	upload (castor3d::UploadData &uploader)

C3D_API castor3d::FontTextureRPtr	getFontTexture (String const &name)
	Récupère une FontTexture, à partir d'un nom de police.

C3D_API castor3d::FontTextureRPtr	createFontTexture (castor::FontResPtr font)
	Crée une FontTexture, à partir d'une police.

Itération.
auto const &	getCategories () const noexcept

Accesseurs.
castor3d::OverlayFactory const &	getOverlayFactory () const noexcept

castor3d::OverlayFactory &	getFactory () noexcept

castor3d::Engine &	getEngine () const noexcept

Fonctions membres publiques hérités de castor::ResourceCacheBaseT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >
	ResourceCacheBaseT (ResourceCacheBaseT const &)=delete

	ResourceCacheBaseT (ResourceCacheBaseT &&) noexcept=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT const &)=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT &&) noexcept=delete

void	cleanup () noexcept
	Met tous les éléments à nettoyer.

void	clear () noexcept
	Vide la collection.

ElementPtrT	create (ElementKeyT const &name, ParametersT &&... parameters) const
	Crée un élément.

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

ElementObsT	tryAdd (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Ajoute un élément, construict sur place.

ElementObsT	tryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Ajoute un élément.

ElementObsT	tryAddNoLock (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Ajoute un élément, construict sur place.

ElementObsT	add (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Version journalisante de tryAdd.

ElementObsT	add (ElementKeyT const &name, ParametersT &&... parameters)
	Version journalisante de tryAdd.

ElementObsT	addNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Version journalisante de tryAdd.

ElementObsT	addNoLock (ElementKeyT const &name, ParametersT &&... parameters)
	Version journalisante de tryAdd.

ElementPtrT	tryRemove (ElementKeyT const &name, bool cleanup=false) noexcept
	Retire un élément à partir d'un nom.

ElementPtrT	tryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Retire un élément à partir d'un nom.

ElementPtrT	remove (ElementKeyT const &name, bool cleanup=false) noexcept
	Version journalisante de tryAdd.

ElementPtrT	removeNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Version journalisante de tryAdd.

void	rename (ElementKeyT const &oldName, ElementKeyT const &newName)
	Renomme une ressource.

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

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

ElementObsT	find (ElementKeyT const &name) const
	Version journalisante de tryAdd.

ElementObsT	findNoLock (ElementKeyT const &name) const
	Version journalisante de tryAdd.

void	mergeInto (ElementCacheBaseT &destination)
	Met les éléments de ce cache dans ceux de celui donné.

void	forEach (FuncType func) const

void	forEach (FuncType func)

uint32_t	getObjectCount () const noexcept

uint32_t	getObjectCountNoLock () const noexcept

String const &	getObjectTypeName () const noexcept

bool	has (ElementKeyT const &name) const noexcept

bool	hasNoLock (ElementKeyT const &name) const noexcept

bool	isEmpty () const noexcept

bool	isEmptyNoLock () const noexcept

void	lock () const

void	unlock () const noexcept

auto	begin () noexcept

auto	begin () const noexcept

auto	end () noexcept

auto	end () const noexcept

void	reportCreation (String const &name) const

void	reportAdded (String const &name) const

void	reportDuplicate (String const &name) const

void	reportNull () const

void	reportUnknown (String const &name) const

Membres hérités additionnels
Types protégés hérités de castor::ResourceCacheBaseT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >
using	MutexT

Fonctions membres protégées hérités de castor::ResourceCacheBaseT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >
void	doCleanupNoLock () const noexcept

void	doClearNoLock () noexcept

ElementPtrT	doCreateT (ElementKeyT const &name, ParametersT &&... parameters) const

ElementObsT	doTryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doTryAddNoLockT (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)

ElementObsT	doAddNoLockT (ElementKeyT const &name, ParametersT &&... parameters)

ElementPtrT	doTryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept

ElementObsT	doTryFindNoLock (ElementKeyT const &name) const noexcept

	ResourceCacheBaseT (LoggerInstance &logger, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{})

virtual	~ResourceCacheBaseT () noexcept=default

Attributs protégés hérités de castor::ResourceCacheBaseT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >
LoggerInstance &	m_logger

CheckedMutexT< MutexT >	m_mutex

ElementContT	m_resources

ElementInitialiserT	m_initialise

ElementCleanerT	m_clean

ElementMergerT	m_merge

Description détaillée

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

Documentation des définitions de type membres

◆ const_iterator

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::const_iterator = castor::Map< ElementT, ElementKeyT >::const_iterator

◆ ElementCacheT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

◆ ElementCacheTraitsT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCacheTraitsT = castor3d::OverlayCacheTraits

◆ ElementCleanerT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

◆ ElementContT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementContT = typename ElementCacheT::ElementContT

◆ ElementInitialiserT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

◆ ElementKeyT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementKeyT = String

◆ ElementMergerT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementMergerT = typename ElementCacheT::ElementMergerT

◆ ElementObsT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementObsT = typename ElementCacheT::ElementObsT

◆ ElementPtrT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementPtrT = typename ElementCacheT::ElementPtrT

◆ ElementT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementT = castor3d::Overlay

◆ iterator

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::iterator = castor::Map< ElementT, ElementKeyT >::iterator

◆ OverlayCategories

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::OverlayCategories = castor::Vector< castor3d::OverlayCategoryRPtr >

Documentation des constructeurs et destructeur

◆ ResourceCacheT()

C3D_API castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ResourceCacheT ( castor3d::Engine & engine )

explicit

Constructeur.

Paramètres

[in] engine Le moteur.

Documentation des fonctions membres

◆ cleanup() [1/2]

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::cleanup ( )

Nettoie les incrustations.

◆ cleanup() [2/2]

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::cleanup ( castor3d::Overlay & overlay )

◆ clear()

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::clear ( )

noexcept

Vide les listes d'incrustations.

◆ createFontTexture()

C3D_API castor3d::FontTextureRPtr castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::createFontTexture ( castor::FontResPtr font )

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

Paramètres

[in] font La police.

Renvoie: La FontTexture créée.

◆ CU_DeclareMap()

castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::CU_DeclareMap	(	ElementKeyT	,
		castor3d::FontTextureUPtr	,
		FontTextureStr	)

◆ getCategories()

auto const & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getCategories ( ) const

inlinenoexcept

◆ getEngine()

castor3d::Engine & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getEngine ( ) const

inlinenoexcept

◆ getFactory()

castor3d::OverlayFactory & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getFactory ( )

inlinenoexcept

◆ getFontTexture()

C3D_API castor3d::FontTextureRPtr castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getFontTexture ( String const & name )

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

Paramètres

[in] name Le nom de la police.

Renvoie: La FontTexture si elle exite, nullptr sinon.

◆ getOverlayFactory()

castor3d::OverlayFactory const & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getOverlayFactory ( ) const

inlinenoexcept

◆ initialise()

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::initialise ( castor3d::Overlay & overlay )

◆ upload()

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::upload ( castor3d::UploadData & uploader )

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

Castor3D/Cache/OverlayCache.hpp

Types publics

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ const_iterator

◆ ElementCacheT

◆ ElementCacheTraitsT

◆ ElementCleanerT

◆ ElementContT

◆ ElementInitialiserT

◆ ElementKeyT

◆ ElementMergerT

◆ ElementObsT

◆ ElementPtrT

◆ ElementT

◆ iterator

◆ OverlayCategories

Documentation des constructeurs et destructeur

◆ ResourceCacheT()

Documentation des fonctions membres

◆ cleanup() [1/2]

◆ cleanup() [2/2]

◆ clear()

◆ createFontTexture()

◆ CU_DeclareMap()

◆ getCategories()

◆ getEngine()

◆ getFactory()

◆ getFontTexture()

◆ getOverlayFactory()

◆ initialise()

◆ upload()