Castor3D 0.12.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Attributs publics | Types protégés | Fonctions membres protégées | Attributs protégés | Amis | Liste de tous les membres
Référence du modèle de la classe castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >

#include <ObjectCacheBase.hpp>

Graphe d'héritage de castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >:
Collaboration graph
[légende]

Types publics

using OnChangedFunction = std::function< void() >
 
using OnChanged = castor::SignalT< OnChangedFunction >
 

Fonctions membres publiques

void mergeInto (ElementObjectCacheT &destination)
 Met les éléments de ce cache dans ceux de celui donné. Plus de détails...
 
Engine * getEngine () const
 
castor::String const & getObjectTypeName () const
 

Attributs publics

OnChanged onChanged
 

Types protégés

using ElementT = ObjT
 
using ElementKeyT = KeyT
 
using ElementCacheTraitsT = TraitsT
 
using ElementCacheT = castor::ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
 
using ElementCacheBaseT = ElementCacheT
 
using ElementObjectCacheT = ObjectCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
 
using ElementPtrT = ObjectPtrT< ElementT, ElementKeyT >
 
using ElementObsT = ObjectObsT< ElementT, ElementKeyT >
 
using ElementContT = ObjectContT< ElementT, ElementKeyT >
 
using ElementInitialiserT = ObjectInitialiserT< ElementT, ElementKeyT >
 
using ElementCleanerT = ObjectCleanerT< ElementT, ElementKeyT >
 
using ElementMergerT = ObjectMergerT< ElementT, ElementKeyT >
 
using ElementAttacherT = ObjectAttacherT< ElementT, ElementKeyT >
 
using ElementDetacherT = ObjectDetacherT< ElementT, ElementKeyT >
 

Fonctions membres protégées

 ObjectCacheBaseT (Scene &scene, SceneNodeSPtr rootNode, SceneNodeSPtr rootCameraNode, SceneNodeSPtr rootObjectNode, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{}, ElementAttacherT attach=ElementAttacherT{}, ElementDetacherT detach=ElementDetacherT{})
 Constructeur. Plus de détails...
 
 ~ObjectCacheBaseT ()
 Destructeur. Plus de détails...
 

Attributs protégés

Engine & m_engine
 
SceneNodeWPtr m_rootNode
 
SceneNodeWPtr m_rootCameraNode
 
SceneNodeWPtr m_rootObjectNode
 
ElementMergerT m_merge
 
ElementAttacherT m_attach
 
ElementDetacherT m_detach
 

Amis

class Scene
 

Description détaillée

template<typename ObjT, typename KeyT, typename TraitsT>
class castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >

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

Documentation des définitions de type membres

◆ ElementAttacherT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementAttacherT = ObjectAttacherT< ElementT, ElementKeyT >
protected

◆ ElementCacheBaseT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementCacheBaseT = ElementCacheT
protected

◆ ElementCacheT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementCacheT = castor::ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
protected

◆ ElementCacheTraitsT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementCacheTraitsT = TraitsT
protected

◆ ElementCleanerT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementCleanerT = ObjectCleanerT< ElementT, ElementKeyT >
protected

◆ ElementContT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementContT = ObjectContT< ElementT, ElementKeyT >
protected

◆ ElementDetacherT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementDetacherT = ObjectDetacherT< ElementT, ElementKeyT >
protected

◆ ElementInitialiserT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementInitialiserT = ObjectInitialiserT< ElementT, ElementKeyT >
protected

◆ ElementKeyT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementKeyT = KeyT
protected

◆ ElementMergerT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementMergerT = ObjectMergerT< ElementT, ElementKeyT >
protected

◆ ElementObjectCacheT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementObjectCacheT = ObjectCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
protected

◆ ElementObsT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementObsT = ObjectObsT< ElementT, ElementKeyT >
protected

◆ ElementPtrT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementPtrT = ObjectPtrT< ElementT, ElementKeyT >
protected

◆ ElementT

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ElementT = ObjT
protected

◆ OnChanged

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::OnChanged = castor::SignalT< OnChangedFunction >

◆ OnChangedFunction

template<typename ObjT , typename KeyT , typename TraitsT >
using castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::OnChangedFunction = std::function< void() >

Documentation des constructeurs et destructeur

◆ ObjectCacheBaseT()

template<typename ObjT , typename KeyT , typename TraitsT >
castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::ObjectCacheBaseT ( Scene &  scene,
SceneNodeSPtr  rootNode,
SceneNodeSPtr  rootCameraNode,
SceneNodeSPtr  rootObjectNode,
ElementInitialiserT  initialise = ElementInitialiserT{},
ElementCleanerT  clean = ElementCleanerT{},
ElementMergerT  merge = ElementMergerT{},
ElementAttacherT  attach = ElementAttacherT{},
ElementDetacherT  detach = ElementDetacherT{} 
)
inlineprotected

Constructeur.

Paramètres
[in]sceneLa scène.
[in]rootNodeLe noeud racine.
[in]rootCameraNodeLe noeud racine des caméras.
[in]rootObjectNodeLe noeud racine des objets.
[in]initialiseL'initialiseur d'objet.
[in]cleanLe nettoyeur d'objet.
[in]mergeLe fusionneur de collection d'objets.
[in]attachL'attacheur d'objet (à un noeud de scène).
[in]detachLe détacheur d'objet (d'un noeud de scène).

◆ ~ObjectCacheBaseT()

template<typename ObjT , typename KeyT , typename TraitsT >
castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::~ObjectCacheBaseT ( )
inlineprotected

Destructeur.

Documentation des fonctions membres

◆ getEngine()

template<typename ObjT , typename KeyT , typename TraitsT >
Engine * castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::getEngine ( ) const
inline
Renvoie
L'Engine.

Références castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_engine.

◆ getObjectTypeName()

template<typename ObjT , typename KeyT , typename TraitsT >
castor::String const & castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::getObjectTypeName ( ) const
inline
Renvoie
Le nom du type des objets.

◆ mergeInto()

template<typename ObjT , typename KeyT , typename TraitsT >
void castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::mergeInto ( ElementObjectCacheT &  destination)
inline

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

Paramètres
[out]destinationLe cache de destination.

Références castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_merge, castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_rootCameraNode, castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_rootObjectNode, et castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::onChanged.

Documentation des fonctions amies et associées

◆ Scene

template<typename ObjT , typename KeyT , typename TraitsT >
friend class Scene
friend

Documentation des données membres

◆ m_attach

template<typename ObjT , typename KeyT , typename TraitsT >
ElementAttacherT castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_attach
protected

L'attacheur d'objet.

◆ m_detach

template<typename ObjT , typename KeyT , typename TraitsT >
ElementDetacherT castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_detach
protected

Le détacheur d'objet.

◆ m_engine

template<typename ObjT , typename KeyT , typename TraitsT >
Engine& castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_engine
protected

Le moteur.

Référencé par castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::getEngine().

◆ m_merge

template<typename ObjT , typename KeyT , typename TraitsT >
ElementMergerT castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_merge
protected

L'attacheur d'objet.

Référencé par castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::mergeInto().

◆ m_rootCameraNode

template<typename ObjT , typename KeyT , typename TraitsT >
SceneNodeWPtr castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_rootCameraNode
protected

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

Référencé par castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::mergeInto().

◆ m_rootNode

template<typename ObjT , typename KeyT , typename TraitsT >
SceneNodeWPtr castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_rootNode
protected

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

◆ m_rootObjectNode

template<typename ObjT , typename KeyT , typename TraitsT >
SceneNodeWPtr castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::m_rootObjectNode
protected

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

Référencé par castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::mergeInto().

◆ onChanged

template<typename ObjT , typename KeyT , typename TraitsT >
OnChanged castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::onChanged

Le signal émis lorsque le contenu a changé.

Référencé par castor3d::ObjectCacheBaseT< ObjT, KeyT, TraitsT >::mergeInto().

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Vendredi 18 Mars 2022 21:28:51 pour Castor3D par doxygen 1.9.3