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

Graphe d'héritage de Castor3D::OverlayManager:

Graphe de collaboration de Castor3D::OverlayManager:

Types publics
typedef OverlayCollectionIt	iterator

typedef OverlayCollectionConstIt	const_iterator

Fonctions membres publiques
	OverlayManager (Engine *p_pEngine)
	Constructeur. Plus de détails...

virtual	~OverlayManager ()
	Destructeur. Plus de détails...

void	ClearOverlays ()
	Vide les listes d'incrustations. Plus de détails...

void	AddOverlay (Castor::String const &p_strName, OverlaySPtr p_pOverlay, OverlaySPtr p_pParent)
	Ajoute une incrustation aux listes, selon son nom. Plus de détails...

void	AddOverlay (int p_iZIndex, OverlaySPtr p_pOverlay)
	Ajoute une incrustation aux listes, selon son z-index. Plus de détails...

bool	HasOverlay (int p_iZIndex)
	V�rifie si une incrustation existe au z-index donn� Plus de détails...

OverlaySPtr	GetOverlay (Castor::String const &p_strName)
	R�cup�re l'incrustation avec le nom donn� Plus de détails...

OverlaySPtr	GetOverlay (int p_iZIndex)
	R�cup�re l'incrustation au z-index donn� Plus de détails...

bool	HasOverlay (Castor::String const &p_strName)
	V�rifie si une incrustation avec le nom donn� existe. Plus de détails...

bool	WriteOverlays (Castor::TextFile &p_file) const
	Ecrit les overlays dans un fichier texte. Plus de détails...

bool	ReadOverlays (Castor::TextFile &p_file)
	Lit les overlays � partir d'un fichier texte. Plus de détails...

bool	SaveOverlays (Castor::BinaryFile &p_file) const
	Ecrit les overlays dans un fichier binaire. Plus de détails...

bool	LoadOverlays (Castor::BinaryFile &p_file)
	Lit les overlays � partir d'un fichier binaire. Plus de détails...

void	Update ()
	Initialise ou nettoie l'OverlayRenderer, selon le statut du rendu. Plus de détails...

OverlayRendererSPtr	GetRenderer () const
	R�cup�re le renderer d'incrustation. Plus de détails...

OverlayPtrIntMap::iterator	Begin ()
	R�cup�re un it�rateur sur la premi�re incrustation. Plus de détails...

OverlayPtrIntMap::const_iterator	Begin () const
	R�cup�re un it�rateur sur la premi�re incrustation. Plus de détails...

OverlayPtrIntMap::reverse_iterator	RBegin ()
	R�cup�re un it�rateur sur la premi�re incrustation. Plus de détails...

OverlayPtrIntMap::const_reverse_iterator	RBegin () const
	R�cup�re un it�rateur sur la premi�re incrustation. Plus de détails...

OverlayPtrIntMap::iterator	End ()
	R�cup�re un it�rateur sur apr�s la derni�re incrustation. Plus de détails...

OverlayPtrIntMap::const_iterator	End () const
	R�cup�re un it�rateur sur apr�s la derni�re incrustation. Plus de détails...

OverlayPtrIntMap::reverse_iterator	REnd ()
	R�cup�re un it�rateur sur apr�s la derni�re incrustation. Plus de détails...

OverlayPtrIntMap::const_reverse_iterator	REnd () const
	R�cup�re un it�rateur sur apr�s la derni�re incrustation. Plus de détails...

void	BeginRendering (Castor::Size const &p_size)
	Commence le rendu des incrustations. Plus de détails...

void	EndRendering ()
	Termine le rendu des incrustations. Plus de détails...

Description détaillée

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

Auteur: Sylvain DOREMUS

Date: 09/02/2010

Version: 0.1

Documentation des définitions de type membres

typedef OverlayCollectionConstIt Castor3D::OverlayManager::const_iterator

typedef OverlayCollectionIt Castor3D::OverlayManager::iterator

Documentation des constructeurs et destructeur

Castor3D::OverlayManager::OverlayManager ( Engine * p_pEngine )

Constructeur.

virtual Castor3D::OverlayManager::~OverlayManager ( )

virtual

Destructeur.

Documentation des fonctions membres

void Castor3D::OverlayManager::AddOverlay	(	Castor::String const &	p_strName,
		OverlaySPtr	p_pOverlay,
		OverlaySPtr	p_pParent
	)

Ajoute une incrustation aux listes, selon son nom.

Paramètres

[in]	p_strName	Le nom
[in]	p_pOverlay	L'incrustation
[in]	p_pParent	L'incrustation parente

void Castor3D::OverlayManager::AddOverlay	(	int	p_iZIndex,
		OverlaySPtr	p_pOverlay
	)

Ajoute une incrustation aux listes, selon son z-index.

Paramètres

[in]	p_iZIndex	Le z-index voulu
[in]	p_pOverlay	L'incrustation

OverlayPtrIntMap::iterator Castor3D::OverlayManager::Begin ( )

inline

R�cup�re un it�rateur sur la premi�re incrustation.

Renvoie: La valeur

OverlayPtrIntMap::const_iterator Castor3D::OverlayManager::Begin ( ) const

inline

R�cup�re un it�rateur sur la premi�re incrustation.

Renvoie: La valeur

void Castor3D::OverlayManager::BeginRendering ( Castor::Size const & p_size )

Commence le rendu des incrustations.

Paramètres

[in] p_size La taille de la fen�tre de rendu

void Castor3D::OverlayManager::ClearOverlays ( )

Vide les listes d'incrustations.

OverlayPtrIntMap::iterator Castor3D::OverlayManager::End ( )

inline

R�cup�re un it�rateur sur apr�s la derni�re incrustation.

Renvoie: La valeur

OverlayPtrIntMap::const_iterator Castor3D::OverlayManager::End ( ) const

inline

R�cup�re un it�rateur sur apr�s la derni�re incrustation.

Renvoie: La valeur

void Castor3D::OverlayManager::EndRendering ( )

Termine le rendu des incrustations.

OverlaySPtr Castor3D::OverlayManager::GetOverlay ( Castor::String const & p_strName )

R�cup�re l'incrustation avec le nom donn�

Paramètres

[in] p_strName Le nom

Renvoie: L'incrustation, nullptr si non trouv�e

OverlaySPtr Castor3D::OverlayManager::GetOverlay ( int p_iZIndex )

R�cup�re l'incrustation au z-index donn�

Paramètres

[in] p_iZIndex Le z-index

Renvoie: L'incrustation, nullptr si non trouv�e

OverlayRendererSPtr Castor3D::OverlayManager::GetRenderer ( ) const

inline

R�cup�re le renderer d'incrustation.

Renvoie: Le renderer d'incrustation

bool Castor3D::OverlayManager::HasOverlay ( int p_iZIndex )

V�rifie si une incrustation existe au z-index donn�

Paramètres

[in] p_iZIndex Le z-index

Renvoie: true si un overlayest d�fini au z-index donn�

bool Castor3D::OverlayManager::HasOverlay ( Castor::String const & p_strName )

V�rifie si une incrustation avec le nom donn� existe.

Paramètres

[in] p_strName Le nom

Renvoie: true Si une incrustation est d�fini avec le nom donn�

bool Castor3D::OverlayManager::LoadOverlays ( Castor::BinaryFile & p_file )

Lit les overlays � partir d'un fichier binaire.

Paramètres

[in] p_file Le fichier

Renvoie: true si tout s'est bien pass�

OverlayPtrIntMap::reverse_iterator Castor3D::OverlayManager::RBegin ( )

inline

R�cup�re un it�rateur sur la premi�re incrustation.

Renvoie: La valeur

OverlayPtrIntMap::const_reverse_iterator Castor3D::OverlayManager::RBegin ( ) const

inline

R�cup�re un it�rateur sur la premi�re incrustation.

Renvoie: La valeur

bool Castor3D::OverlayManager::ReadOverlays ( Castor::TextFile & p_file )

Lit les overlays � partir d'un fichier texte.

Paramètres

[in] p_file Le fichier

Renvoie: true si tout s'est bien pass�

OverlayPtrIntMap::reverse_iterator Castor3D::OverlayManager::REnd ( )

inline

R�cup�re un it�rateur sur apr�s la derni�re incrustation.

Renvoie: La valeur

OverlayPtrIntMap::const_reverse_iterator Castor3D::OverlayManager::REnd ( ) const

inline

R�cup�re un it�rateur sur apr�s la derni�re incrustation.

Renvoie: La valeur

bool Castor3D::OverlayManager::SaveOverlays ( Castor::BinaryFile & p_file ) const

Ecrit les overlays dans un fichier binaire.

Paramètres

[out] p_file Le fichier

Renvoie: true si tout s'est bien pass�

void Castor3D::OverlayManager::Update ( )

Initialise ou nettoie l'OverlayRenderer, selon le statut du rendu.

bool Castor3D::OverlayManager::WriteOverlays ( Castor::TextFile & p_file ) const

Ecrit les overlays dans un fichier texte.

Paramètres

[out] p_file Le fichier

Renvoie: true si tout s'est bien pass�

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

Y:/projets/Castor3D/source/Core/Castor3D/Src/OverlayManager.hpp

Types publics

Fonctions membres publiques

Description détaillée

Documentation des définitions de type membres

Documentation des constructeurs et destructeur

Documentation des fonctions membres