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

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

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

using	MyObjectCacheTraits = typename MyObjectCacheType::MyObjectCacheTraits

using	Element = typename MyObjectCacheType::Element

using	Key = typename MyObjectCacheType::Key

using	Collection = typename MyObjectCacheType::Collection

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< Light, castor::String >
using	OnChangedFunction = std::function< void() >

using	OnChanged = castor::Signal< OnChangedFunction >

Fonctions membres publiques
C3D_API	ObjectCache (Engine &engine, Scene &p_scene, SceneNodeSPtr p_rootNode, SceneNodeSPtr p_rootCameraNode, SceneNodeSPtr p_rootObjectNode, Producer &&p_produce, Initialiser &&p_initialise=Initialiser{}, Cleaner &&p_clean=Cleaner{}, Merger &&p_merge=Merger{}, Attacher &&p_attach=Attacher{}, Detacher &&p_detach=Detacher{})
	Constructeur. Plus de détails...

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

C3D_API void	initialise ()
	Initialise la texture de lumières. Plus de détails...

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

C3D_API ElementPtr	add (Key const &p_name, ElementPtr p_element)
	Ajoute un objet. Plus de détails...

C3D_API ElementPtr	add (Key const &p_name, SceneNodeSPtr p_parent, LightType p_type)
	Crée un objet. Plus de détails...

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

C3D_API void	update ()
	Met à jour les sources lumineuses modifiées. Plus de détails...

C3D_API void	updateLightsTexture (Camera const &camera) const
	Met à jour la texture de sources lumineuses. Plus de détails...

C3D_API void	bindLights () const
	Active la texture de sources lumineuses. Plus de détails...

C3D_API void	unbindLights () const
	Désactive la texture de sources lumineuses. Plus de détails...

uint32_t	getLightsCount (LightType p_type) const
	Récupère le nombre de lumières du type donné. Plus de détails...

LightsArray	getLights (LightType p_type) const
	Récupère les lumières du type donné. Plus de détails...

Fonctions membres publiques hérités de castor3d::ObjectCacheBase< Light, castor::String >
	ObjectCacheBase (Engine &engine, Scene &p_scene, SceneNodeSPtr p_rootNode, SceneNodeSPtr p_rootCameraNode, SceneNodeSPtr p_rootObjectNode, Producer &&p_produce, Initialiser &&p_initialise=Initialiser{}, Cleaner &&p_clean=Cleaner{}, Merger &&p_merge=Merger{}, Attacher &&p_attach=Attacher{}, Detacher &&p_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 &p_name, ElementPtr p_element)
	Ajoute un objet. Plus de détails...

ElementPtr	add (Key const &p_name, SceneNodeSPtr p_parent, Parameters &&... p_parameters)
	Crée un objet. Plus de détails...

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

void	mergeInto (MyObjectCacheType &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

Scene *	getScene () 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 ()
	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< Light, castor::String >
OnChanged	onChanged

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

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

using	Element = Light

using	Key = castor::String

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

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 >

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

Cache de Light.

Auteur: Sylvain DOREMUS

Date: 29/01/2016

Version: 0.8.0

Documentation des définitions de type membres

◆ Attacher

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

◆ Cleaner

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

◆ Collection

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

◆ Detacher

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

◆ Element

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

◆ ElementPtr

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

◆ Initialiser

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

◆ Key

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

◆ Merger

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

◆ MyObjectCache

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

◆ MyObjectCacheTraits

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

◆ Producer

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

Documentation des constructeurs et destructeur

◆ ObjectCache()

C3D_API castor3d::ObjectCache< Light, castor::String >::ObjectCache	(	Engine &	engine,
		Scene &	p_scene,
		SceneNodeSPtr	p_rootNode,
		SceneNodeSPtr	p_rootCameraNode,
		SceneNodeSPtr	p_rootObjectNode,
		Producer &&	p_produce,
		Initialiser &&	p_initialise = `Initialiser{}`,
		Cleaner &&	p_clean = `Cleaner{}`,
		Merger &&	p_merge = `Merger{}`,
		Attacher &&	p_attach = `Attacher{}`,
		Detacher &&	p_detach = `Detacher{}`
	)

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	p_scene	La scène.
[in]	p_rootNode	Le noeud racine.
[in]	p_rootCameraNode	Le noeud racine des caméras.
[in]	p_rootObjectNode	Le noeud racine des objets.
[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.
[in]	p_attach	L'attacheur d'objet (à un noeud de scène).
[in]	p_detach	Le détacheur d'objet (d'un noeud de scène).

◆ ~ObjectCache()

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

Destructeur.

Documentation des fonctions membres

◆ add() [1/2]

C3D_API ElementPtr castor3d::ObjectCache< Light, castor::String >::add	(	Key const &	p_name,
		ElementPtr	p_element
	)

Ajoute un objet.

Paramètres

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

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

◆ add() [2/2]

C3D_API ElementPtr castor3d::ObjectCache< Light, castor::String >::add	(	Key const &	p_name,
		SceneNodeSPtr	p_parent,
		LightType	p_type
	)

Crée un objet.

Paramètres

[in]	p_name	Le nom d'objet.
[in]	p_parent	Le noeud de scène parent.
[in]	p_type	Le type de source lumineuse.

Renvoie: L'objet créé.

◆ bindLights()

C3D_API void castor3d::ObjectCache< Light, castor::String >::bindLights ( ) const

Active la texture de sources lumineuses.

◆ cleanup()

C3D_API void castor3d::ObjectCache< Light, castor::String >::cleanup ( )

Met tous les éléments à nettoyer.

◆ getLights()

LightsArray castor3d::ObjectCache< Light, castor::String >::getLights ( LightType p_type ) const

inline

Récupère les lumières du type donné.

Paramètres

[in] p_type Le type de lumière.

Renvoie: Les lumières.

◆ getLightsCount()

uint32_t castor3d::ObjectCache< Light, castor::String >::getLightsCount ( LightType p_type ) const

inline

Récupère le nombre de lumières du type donné.

Paramètres

[in] p_type Le type de lumière.

Renvoie: Le compte.

◆ initialise()

C3D_API void castor3d::ObjectCache< Light, castor::String >::initialise ( )

Initialise la texture de lumières.

◆ remove()

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

Retire un objet à partir d'un nom.

Paramètres

[in] p_name Le nom d'objet.

◆ unbindLights()

C3D_API void castor3d::ObjectCache< Light, castor::String >::unbindLights ( ) const

Désactive la texture de sources lumineuses.

◆ update()

C3D_API void castor3d::ObjectCache< Light, castor::String >::update ( )

Met à jour les sources lumineuses modifiées.

◆ updateLightsTexture()

C3D_API void castor3d::ObjectCache< Light, castor::String >::updateLightsTexture ( Camera const & camera ) const

Met à jour la texture de sources lumineuses.

Paramètres

[in] camera La caméra utilisée pour déterminer si une source lumineuse est applicable ou pas.

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

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

Types publics

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

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

Documentation des définitions de type membres

◆ Attacher

◆ Cleaner

◆ Collection

◆ Detacher

◆ Element

◆ ElementPtr

◆ Initialiser

◆ Key

◆ Merger

◆ MyObjectCache

◆ MyObjectCacheTraits

◆ Producer

Documentation des constructeurs et destructeur

◆ ObjectCache()

◆ ~ObjectCache()

Documentation des fonctions membres

◆ add() [1/2]

◆ add() [2/2]

◆ bindLights()

◆ cleanup()

◆ getLights()

◆ getLightsCount()

◆ initialise()

◆ remove()

◆ unbindLights()

◆ update()

◆ updateLightsTexture()

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