Classe de base pour un cache d'éléments de scène. Plus de détails...

Graphe d'héritage de castor3d::ObjectCacheBase< ElementType, KeyType >:

[légende]

Graphe de collaboration de castor3d::ObjectCacheBase< ElementType, KeyType >:

[légende]

Types publics
using	OnChangedFunction = std::function< void() >

using	OnChanged = castor::Signal< OnChangedFunction >

Fonctions membres publiques
	ObjectCacheBase (Engine &engine, Scene &scene, SceneNodeSPtr rootNode, SceneNodeSPtr rootCameraNode, SceneNodeSPtr rootObjectNode, Producer &&produce, Initialiser &&initialise=Initialiser{}, Cleaner &&clean=Cleaner{}, Merger &&merge=Merger{}, Attacher &&attach=Attacher{}, Detacher &&detach=Detacher{})
	Constructeur. Plus de détails...

	~ObjectCacheBase ()
	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	add (Key const &name, ElementPtr element)
	Ajoute un objet. Plus de détails...

template<typename ... Parameters>
ElementPtr	add (Key const &name, SceneNode &parent, Parameters &&... parameters)
	Crée un objet. Plus de détails...

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

void	mergeInto (MyObjectCacheType &destination)

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

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

uint32_t	getObjectCount () const

Scene *	getScene () 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 ()
	Renvoie un itérateur sur le premier élément de la collection. Plus de détails...

auto	begin () const
	Renvoie un itérateur constant sur le premier élément de la collection. Plus de détails...

auto	end ()
	Renvoie un itérateur sur l'après dernier élément de la collection. Plus de détails...

auto	end () const
	Renvoie un itérateur constant sur l'après dernier élément de la collection. Plus de détails...

Attributs publics
OnChanged	onChanged

Types protégés
using	MyObjectCacheType = ObjectCacheBase< ElementType, KeyType >

using	MyObjectCacheTraits = ObjectCacheTraits< ElementType, KeyType >

using	Element = ElementType

using	Key = KeyType

using	Collection = castor::Collection< Element, Key >

using	LockType = std::unique_lock< Collection >

using	ElementPtr = std::shared_ptr< Element >

using	Producer = typename MyObjectCacheTraits::Producer

using	Merger = typename MyObjectCacheTraits::Merger

using	Initialiser = ElementInitialiser< Element >

using	Cleaner = ElementCleaner< Element >

using	Attacher = ElementAttacher< Element >

using	Detacher = ElementDetacher< Element >

Fonctions membres protégées
void	doReportCreation (castor::String const &name)

void	doReportDuplicate (castor::String const &name)

void	doReportNull ()

Attributs protégés
Engine &	m_engine

Scene &	m_scene

SceneNodeWPtr	m_rootNode

SceneNodeWPtr	m_rootCameraNode

SceneNodeWPtr	m_rootObjectNode

Collection	m_elements

Producer	m_produce

Initialiser	m_initialise

Cleaner	m_clean

Merger	m_merge

Attacher	m_attach

Detacher	m_detach

Amis
class	Scene

Description détaillée

template<typename ElementType, typename KeyType>
class castor3d::ObjectCacheBase< ElementType, KeyType >

Classe de base pour un cache d'éléments de scène.

Documentation des définitions de type membres

◆ Attacher

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Attacher = ElementAttacher< Element >

protected

◆ Cleaner

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Cleaner = ElementCleaner< Element >

protected

◆ Collection

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Collection = castor::Collection< Element, Key >

protected

◆ Detacher

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Detacher = ElementDetacher< Element >

protected

◆ Element

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Element = ElementType

protected

◆ ElementPtr

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::ElementPtr = std::shared_ptr< Element >

protected

◆ Initialiser

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Initialiser = ElementInitialiser< Element >

protected

◆ Key

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Key = KeyType

protected

◆ LockType

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::LockType = std::unique_lock< Collection >

protected

◆ Merger

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Merger = typename MyObjectCacheTraits::Merger

protected

◆ MyObjectCacheTraits

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::MyObjectCacheTraits = ObjectCacheTraits< ElementType, KeyType >

protected

◆ MyObjectCacheType

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::MyObjectCacheType = ObjectCacheBase< ElementType, KeyType >

protected

◆ OnChanged

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::OnChanged = castor::Signal < OnChangedFunction >

◆ OnChangedFunction

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::OnChangedFunction = std::function< void() >

◆ Producer

template<typename ElementType, typename KeyType>

using castor3d::ObjectCacheBase< ElementType, KeyType >::Producer = typename MyObjectCacheTraits::Producer

protected

Documentation des constructeurs et destructeur

◆ ObjectCacheBase()

template<typename ElementType, typename KeyType>

castor3d::ObjectCacheBase< ElementType, KeyType >::ObjectCacheBase	(	Engine &	engine,
		Scene &	scene,
		SceneNodeSPtr	rootNode,
		SceneNodeSPtr	rootCameraNode,
		SceneNodeSPtr	rootObjectNode,
		Producer &&	produce,
		Initialiser &&	initialise = `Initialiser{}`,
		Cleaner &&	clean = `Cleaner{}`,
		Merger &&	merge = `Merger{}`,
		Attacher &&	attach = `Attacher{}`,
		Detacher &&	detach = `Detacher{}`
	)

inline

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	scene	La scène.
[in]	rootNode	Le noeud racine.
[in]	rootCameraNode	Le noeud racine des caméras.
[in]	rootObjectNode	Le noeud racine des objets.
[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.
[in]	attach	L'attacheur d'objet (à un noeud de scène).
[in]	detach	Le détacheur d'objet (d'un noeud de scène).

◆ ~ObjectCacheBase()

template<typename ElementType, typename KeyType>

castor3d::ObjectCacheBase< ElementType, KeyType >::~ObjectCacheBase ( )

inline

Destructeur.

Documentation des fonctions membres

◆ add() [1/2]

template<typename ElementType, typename KeyType>

ElementPtr castor3d::ObjectCacheBase< ElementType, KeyType >::add	(	Key const &	name,
		ElementPtr	element
	)

inline

Ajoute un objet.

Paramètres

[in]	name	Le nom d'objet.
[in]	element	L'objet.

Renvoie: L'objet ajouté, ou celui existant.

◆ add() [2/2]

template<typename ElementType, typename KeyType>

template<typename ... Parameters>

ElementPtr castor3d::ObjectCacheBase< ElementType, KeyType >::add	(	Key const &	name,
		SceneNode &	parent,
		Parameters &&...	parameters
	)

inline

Crée un objet.

Paramètres

[in]	name	Le nom d'objet.
[in]	parent	Le noeud de scène parent.
[in]	parameters	Les autres paramètres de construction.

Renvoie: L'objet créé.

◆ begin() [1/2]

template<typename ElementType, typename KeyType>

auto castor3d::ObjectCacheBase< ElementType, KeyType >::begin ( )

inline

Renvoie un itérateur sur le premier élément de la collection.

Renvoie: L'itérateur

◆ begin() [2/2]

template<typename ElementType, typename KeyType>

auto castor3d::ObjectCacheBase< ElementType, KeyType >::begin ( ) const

inline

Renvoie un itérateur constant sur le premier élément de la collection.

Renvoie: L'itérateur

◆ cleanup()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::cleanup ( )

inline

Met tous les éléments à nettoyer.

◆ clear()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::clear ( )

inline

Vide la collection.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto().

Voici le graphe des appelants de cette fonction :

◆ doReportCreation()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::doReportCreation ( castor::String const & name )

inlineprotected

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

Voici le graphe des appelants de cette fonction :

◆ doReportDuplicate()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::doReportDuplicate ( castor::String const & name )

inlineprotected

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

Voici le graphe des appelants de cette fonction :

◆ doReportNull()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::doReportNull ( )

inlineprotected

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

Voici le graphe des appelants de cette fonction :

◆ end() [1/2]

template<typename ElementType, typename KeyType>

auto castor3d::ObjectCacheBase< ElementType, KeyType >::end ( )

inline

Renvoie un itérateur sur l'après dernier élément de la collection.

Renvoie: L'itérateur

◆ end() [2/2]

template<typename ElementType, typename KeyType>

auto castor3d::ObjectCacheBase< ElementType, KeyType >::end ( ) const

inline

Renvoie un itérateur constant sur l'après dernier élément de la collection.

Renvoie: L'itérateur

◆ find()

template<typename ElementType, typename KeyType>

ElementPtr castor3d::ObjectCacheBase< ElementType, KeyType >::find ( Key const & name ) const

inline

Cherche un élément par son nom.

Paramètres

[in] name Le nom d'objet.

Renvoie: L'élément trouvé, nullptr si non trouvé.

◆ forEach() [1/2]

template<typename ElementType, typename KeyType>

template<typename FuncType >

void castor3d::ObjectCacheBase< ElementType, KeyType >::forEach ( FuncType func ) const

inline

Applique une fonction à tous les éléments de ce cache.

Paramètres

[in] func La fonction.

◆ forEach() [2/2]

template<typename ElementType, typename KeyType>

template<typename FuncType >

void castor3d::ObjectCacheBase< ElementType, KeyType >::forEach ( FuncType func )

inline

Applique une fonction à tous les éléments de ce cache.

Paramètres

[in] func La fonction.

◆ getEngine()

template<typename ElementType, typename KeyType>

Engine* castor3d::ObjectCacheBase< ElementType, KeyType >::getEngine ( ) const

inline

Renvoie: L'Engine.

◆ getObjectCount()

template<typename ElementType, typename KeyType>

uint32_t castor3d::ObjectCacheBase< ElementType, KeyType >::getObjectCount ( ) const

inline

Renvoie: Le nombre d'objets

◆ getObjectTypeName()

template<typename ElementType, typename KeyType>

castor::String const& castor3d::ObjectCacheBase< ElementType, KeyType >::getObjectTypeName ( ) const

inline

Renvoie: L'Engine.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::doReportCreation(), castor3d::ObjectCacheBase< BillboardList, castor::String >::doReportDuplicate(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::doReportNull().

Voici le graphe des appelants de cette fonction :

◆ getScene()

template<typename ElementType, typename KeyType>

Scene* castor3d::ObjectCacheBase< ElementType, KeyType >::getScene ( ) const

inline

Renvoie: L'Engine.

◆ has()

template<typename ElementType, typename KeyType>

bool castor3d::ObjectCacheBase< ElementType, KeyType >::has ( Key const & name ) const

inline

Paramètres

[in] name Le nom d'objet.

Renvoie: true Si un élément avec le nom donné existe.

◆ isEmpty()

template<typename ElementType, typename KeyType>

bool castor3d::ObjectCacheBase< ElementType, KeyType >::isEmpty ( ) const

inline

Renvoie: true si le cache est vide.

◆ lock()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::lock ( ) const

inline

Locke le mutex de la collection.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add(), castor3d::ObjectCacheBase< BillboardList, castor::String >::cleanup(), castor3d::ObjectCacheBase< BillboardList, castor::String >::forEach(), castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::remove().

Voici le graphe des appelants de cette fonction :

◆ mergeInto()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::mergeInto ( MyObjectCacheType & destination )

inline

Renvoie: Met les éléments de ce cache dans ceux de celui donné.

Paramètres

[out] destination Le cache de destination.

◆ remove()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::remove ( Key const & name )

inline

Retire un objet à partir d'un nom.

Paramètres

[in] name Le nom d'objet.

◆ unlock()

template<typename ElementType, typename KeyType>

void castor3d::ObjectCacheBase< ElementType, KeyType >::unlock ( ) const

inline

Délocke le mutex de la collection.

Documentation des fonctions amies et associées

◆ Scene

template<typename ElementType, typename KeyType>

friend class Scene

friend

Documentation des données membres

◆ m_attach

template<typename ElementType, typename KeyType>

Attacher castor3d::ObjectCacheBase< ElementType, KeyType >::m_attach

protected

L'attacheur d'objet.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

◆ m_clean

template<typename ElementType, typename KeyType>

Cleaner castor3d::ObjectCacheBase< ElementType, KeyType >::m_clean

protected

Le nettoyeur d'éléments.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::cleanup().

◆ m_detach

template<typename ElementType, typename KeyType>

Detacher castor3d::ObjectCacheBase< ElementType, KeyType >::m_detach

protected

Le détacheur d'objet.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::cleanup(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::remove().

◆ m_elements

template<typename ElementType, typename KeyType>

Collection castor3d::ObjectCacheBase< ElementType, KeyType >::m_elements

mutableprotected

La collection d'éléments.

◆ m_engine

template<typename ElementType, typename KeyType>

Engine& castor3d::ObjectCacheBase< ElementType, KeyType >::m_engine

protected

Le moteur.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::getEngine().

◆ m_initialise

template<typename ElementType, typename KeyType>

Initialiser castor3d::ObjectCacheBase< ElementType, KeyType >::m_initialise

protected

L'initaliseur d'éléments.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

◆ m_merge

template<typename ElementType, typename KeyType>

Merger castor3d::ObjectCacheBase< ElementType, KeyType >::m_merge

protected

Le fusionneur de collection d'objets.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto().

◆ m_produce

template<typename ElementType, typename KeyType>

Producer castor3d::ObjectCacheBase< ElementType, KeyType >::m_produce

protected

Le créateur d'éléments.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

◆ m_rootCameraNode

template<typename ElementType, typename KeyType>

SceneNodeWPtr castor3d::ObjectCacheBase< ElementType, KeyType >::m_rootCameraNode

protected

Le noeud père de tous les noeuds de caméra.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto().

◆ m_rootNode

template<typename ElementType, typename KeyType>

SceneNodeWPtr castor3d::ObjectCacheBase< ElementType, KeyType >::m_rootNode

protected

Le noeud père de tous les noeuds de la scène.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add().

◆ m_rootObjectNode

template<typename ElementType, typename KeyType>

SceneNodeWPtr castor3d::ObjectCacheBase< ElementType, KeyType >::m_rootObjectNode

protected

Le noeud père de tous les noeuds d'objet.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto().

◆ m_scene

template<typename ElementType, typename KeyType>

Scene& castor3d::ObjectCacheBase< ElementType, KeyType >::m_scene

protected

L'attacheur d'objet.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::getScene().

◆ onChanged

template<typename ElementType, typename KeyType>

OnChanged castor3d::ObjectCacheBase< ElementType, KeyType >::onChanged

Le signal émis lorsque le contenu a changé.

Référencé par castor3d::ObjectCacheBase< BillboardList, castor::String >::add(), castor3d::ObjectCacheBase< BillboardList, castor::String >::cleanup(), castor3d::ObjectCacheBase< BillboardList, castor::String >::mergeInto(), et castor3d::ObjectCacheBase< BillboardList, castor::String >::remove().

La documentation de cette classe a été générée à partir des fichiers suivants :

Cache/CacheModule.hpp
Cache/ObjectCacheBase.hpp

Types publics

Fonctions membres publiques

Attributs publics

Types protégés

Fonctions membres protégées

Attributs protégés

Amis

Description détaillée

template<typename ElementType, typename KeyType> class castor3d::ObjectCacheBase< ElementType, KeyType >

Documentation des définitions de type membres

◆ Attacher

◆ Cleaner

◆ Collection

◆ Detacher

◆ Element

◆ ElementPtr

◆ Initialiser

◆ Key

◆ LockType

◆ Merger

◆ MyObjectCacheTraits

◆ MyObjectCacheType

◆ OnChanged

◆ OnChangedFunction

◆ Producer

Documentation des constructeurs et destructeur

◆ ObjectCacheBase()

◆ ~ObjectCacheBase()

Documentation des fonctions membres

◆ add() [1/2]

◆ add() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cleanup()

◆ clear()

◆ doReportCreation()

◆ doReportDuplicate()

◆ doReportNull()

◆ end() [1/2]

◆ end() [2/2]

◆ find()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ getEngine()

◆ getObjectCount()

◆ getObjectTypeName()

◆ getScene()

◆ has()

◆ isEmpty()

◆ lock()

◆ mergeInto()

◆ remove()

◆ unlock()

Documentation des fonctions amies et associées

◆ Scene

Documentation des données membres

◆ m_attach

◆ m_clean

◆ m_detach

◆ m_elements

◆ m_engine

◆ m_initialise

◆ m_merge

◆ m_produce

◆ m_rootCameraNode

◆ m_rootNode

◆ m_rootObjectNode

◆ m_scene

◆ onChanged

template<typename ElementType, typename KeyType>
class castor3d::ObjectCacheBase< ElementType, KeyType >