Cache de BillboardList. Plus de détails...

Graphe d'héritage de castor3d::ObjectCache< BillboardList, castor::String >:

Graphe de collaboration de castor3d::ObjectCache< BillboardList, castor::String >:

[légende]

Types publics
using	MyObjectCache = ObjectCacheBase< BillboardList, castor::String >

using	MyObjectCacheTraits = typename MyObjectCacheType::MyObjectCacheTraits

using	Element = typename MyObjectCacheType::Element

using	Key = typename MyObjectCacheType::Key

using	Collection = typename MyObjectCacheType::Collection

using	LockType = typename MyObjectCacheType::LockType

using	ElementPtr = typename MyObjectCacheType::ElementPtr

using	Producer = typename MyObjectCacheType::Producer

using	Initialiser = typename MyObjectCacheType::Initialiser

using	Cleaner = typename MyObjectCacheType::Cleaner

using	Merger = typename MyObjectCacheType::Merger

using	Attacher = typename MyObjectCacheType::Attacher

using	Detacher = typename MyObjectCacheType::Detacher

Types publics hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
using	OnChangedFunction = std::function< void() >

using	OnChanged = castor::Signal< OnChangedFunction >

Fonctions membres publiques
C3D_API	ObjectCache (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...

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

C3D_API void	registerPass (SceneRenderPass const &renderPass)

C3D_API void	unregisterPass (SceneRenderPass const *renderPass, uint32_t instanceMult)

C3D_API void	initialise (RenderDevice const &device)
	Initialise les pools d'UBO. Plus de détails...

C3D_API void	cleanup (RenderDevice const &device)
	Nettoie les pools d'UBO. Plus de détails...

C3D_API void	clear ()
	Vide la collection. Plus de détails...

C3D_API void	update (CpuUpdater &updater)
	Met à jour la passe de rendu, au niveau CPU. Plus de détails...

C3D_API ElementPtr	add (Key const &name, SceneNode &parent)
	Crée un nouvel objet et l'ajoute à la collection. Plus de détails...

C3D_API void	add (ElementPtr element)
	Ajoute un objet existant. Plus de détails...

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

BillboardUboPools &	getUboPools () const

Fonctions membres publiques hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
	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...

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)

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

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...

Membres hérités additionnels
Attributs publics hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
OnChanged	onChanged

Types protégés hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
using	MyObjectCacheType = ObjectCacheBase< BillboardList, castor::String >

using	MyObjectCacheTraits = ObjectCacheTraits< BillboardList, castor::String >

using	Element = BillboardList

using	Key = castor::String

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 hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
void	doReportCreation (castor::String const &name)

void	doReportDuplicate (castor::String const &name)

void	doReportNull ()

Attributs protégés hérités de castor3d::ObjectCacheBase< BillboardList, castor::String >
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

Description détaillée

template<>
class castor3d::ObjectCache< BillboardList, castor::String >

Cache de BillboardList.

Auteur: Sylvain DOREMUS

Date: 24/04/2018

Version: 0.11.0

Documentation des définitions de type membres

◆ Attacher

using castor3d::ObjectCache< BillboardList, castor::String >::Attacher = typename MyObjectCacheType::Attacher

◆ Cleaner

using castor3d::ObjectCache< BillboardList, castor::String >::Cleaner = typename MyObjectCacheType::Cleaner

◆ Collection

using castor3d::ObjectCache< BillboardList, castor::String >::Collection = typename MyObjectCacheType::Collection

◆ Detacher

using castor3d::ObjectCache< BillboardList, castor::String >::Detacher = typename MyObjectCacheType::Detacher

◆ Element

using castor3d::ObjectCache< BillboardList, castor::String >::Element = typename MyObjectCacheType::Element

◆ ElementPtr

using castor3d::ObjectCache< BillboardList, castor::String >::ElementPtr = typename MyObjectCacheType::ElementPtr

◆ Initialiser

using castor3d::ObjectCache< BillboardList, castor::String >::Initialiser = typename MyObjectCacheType::Initialiser

◆ Key

using castor3d::ObjectCache< BillboardList, castor::String >::Key = typename MyObjectCacheType::Key

◆ LockType

using castor3d::ObjectCache< BillboardList, castor::String >::LockType = typename MyObjectCacheType::LockType

◆ Merger

using castor3d::ObjectCache< BillboardList, castor::String >::Merger = typename MyObjectCacheType::Merger

◆ MyObjectCache

using castor3d::ObjectCache< BillboardList, castor::String >::MyObjectCache = ObjectCacheBase< BillboardList, castor::String >

◆ MyObjectCacheTraits

using castor3d::ObjectCache< BillboardList, castor::String >::MyObjectCacheTraits = typename MyObjectCacheType::MyObjectCacheTraits

◆ Producer

using castor3d::ObjectCache< BillboardList, castor::String >::Producer = typename MyObjectCacheType::Producer

Documentation des constructeurs et destructeur

◆ ObjectCache()

C3D_API castor3d::ObjectCache< BillboardList, castor::String >::ObjectCache	(	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.

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).

◆ ~ObjectCache()

C3D_API castor3d::ObjectCache< BillboardList, castor::String >::~ObjectCache ( )

Destructeur.

Documentation des fonctions membres

◆ add() [1/2]

C3D_API ElementPtr castor3d::ObjectCache< BillboardList, castor::String >::add	(	Key const &	name,
		SceneNode &	parent
	)

Crée un nouvel objet et l'ajoute à la collection.

Paramètres

[in]	name	Le nom d'objet.
[in]	parent	Le noeud de scène parent.

Renvoie: L'objet créé.

◆ add() [2/2]

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::add ( ElementPtr element )

Ajoute un objet existant.

Paramètres

[in] element L'objet.

◆ cleanup()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::cleanup ( RenderDevice const & device )

Nettoie les pools d'UBO.

Paramètres

[in] device Le device GPU.

◆ clear()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::clear ( )

Vide la collection.

◆ getUboPools()

BillboardUboPools& castor3d::ObjectCache< BillboardList, castor::String >::getUboPools ( ) const

inline

◆ initialise()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::initialise ( RenderDevice const & device )

Initialise les pools d'UBO.

Paramètres

[in] device Le device GPU.

◆ registerPass()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::registerPass ( SceneRenderPass const & renderPass )

◆ remove()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::remove ( Key const & name )

Retire un objet à partir d'un nom.

Paramètres

[in] name Le nom d'objet.

◆ unregisterPass()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::unregisterPass	(	SceneRenderPass const *	renderPass,
		uint32_t	instanceMult
	)

◆ update()

C3D_API void castor3d::ObjectCache< BillboardList, castor::String >::update ( CpuUpdater & updater )

Met à jour la passe de rendu, au niveau CPU.

Paramètres

[in,out] updater Les données d'update.

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

Cache/BillboardCache.hpp

Types publics

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

template<> class castor3d::ObjectCache< BillboardList, castor::String >

Documentation des définitions de type membres

◆ Attacher

◆ Cleaner

◆ Collection

◆ Detacher

◆ Element

◆ ElementPtr

◆ Initialiser

◆ Key

◆ LockType

◆ Merger

◆ MyObjectCache

◆ MyObjectCacheTraits

◆ Producer

Documentation des constructeurs et destructeur

◆ ObjectCache()

◆ ~ObjectCache()

Documentation des fonctions membres

◆ add() [1/2]

◆ add() [2/2]

◆ cleanup()

◆ clear()

◆ getUboPools()

◆ initialise()

◆ registerPass()

◆ remove()

◆ unregisterPass()

◆ update()

template<>
class castor3d::ObjectCache< BillboardList, castor::String >