Référence de la classe Castor3D::OverlayManager

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 Castor::Collection< Overlay, Castor::String >::TObjPtrMapIt	iterator
typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapConstIt	const_iterator
typedef std::set< OverlayCategorySPtr, OverlayCategorySort >	OverlayCategorySet
Types publics hérités de Castor3D::Manager< Castor::String, Overlay, Engine, ResourceManagerEngineGetter >
typedef Castor::Collection< Overlay, Castor::String >	Collection

Fonctions membres publiques
	DECLARE_MAP (Castor::String, FontTextureSPtr, FontTextureStr)
C3D_API	OverlayManager (Engine &p_engine)
	Constructeur. Plus de détails...
C3D_API	~OverlayManager ()
	Destructeur. Plus de détails...
C3D_API void	Clear ()
	Vide les listes d'incrustations. Plus de détails...
C3D_API void	Cleanup ()
	Nettoie les incrustations. Plus de détails...
C3D_API void	Remove (Castor::String const &p_name)
	Enlève une incrustation des listes. Plus de détails...
C3D_API OverlaySPtr	Create (Castor::String const &p_name, eOVERLAY_TYPE p_type, OverlaySPtr p_parent, SceneSPtr p_scene)
	Crée un overlay. Plus de détails...
C3D_API PanelOverlaySPtr	CreatePanel (Castor::String const &p_name, Castor::Point2d const &p_position, Castor::Point2d const &p_size, MaterialSPtr p_material, OverlaySPtr p_parent=nullptr)
	Crée une incrustation panneau. Plus de détails...
C3D_API PanelOverlaySPtr	CreatePanel (Castor::String const &p_name, Castor::Position const &p_position, Castor::Size const &p_size, MaterialSPtr p_material, OverlaySPtr p_parent=nullptr)
	Crée une incrustation panneau. Plus de détails...
C3D_API BorderPanelOverlaySPtr	CreateBorderPanel (Castor::String const &p_name, Castor::Point2d const &p_position, Castor::Point2d const &p_size, MaterialSPtr p_material, Castor::Point4d const &p_bordersSize, MaterialSPtr p_bordersMaterial, OverlaySPtr p_parent=nullptr)
	Crée une incrustation panneau borduré. Plus de détails...
C3D_API BorderPanelOverlaySPtr	CreateBorderPanel (Castor::String const &p_name, Castor::Position const &p_position, Castor::Size const &p_size, MaterialSPtr p_material, Castor::Rectangle const &p_bordersSize, MaterialSPtr p_bordersMaterial, OverlaySPtr p_parent=nullptr)
C3D_API TextOverlaySPtr	CreateText (Castor::String const &p_name, Castor::Point2d const &p_position, Castor::Point2d const &p_size, MaterialSPtr p_material, Castor::FontSPtr p_font, OverlaySPtr p_parent=nullptr)
	Crée une incrustation texte. Plus de détails...
C3D_API TextOverlaySPtr	CreateText (Castor::String const &p_name, Castor::Position const &p_position, Castor::Size const &p_size, MaterialSPtr p_material, Castor::FontSPtr p_font, OverlaySPtr p_parent=nullptr)
	Crée une incrustation panneau. Plus de détails...
C3D_API void	UpdateRenderer ()
	Initialise ou nettoie l'OverlayRenderer, selon le statut du rendu. Plus de détails...
C3D_API void	Update ()
	Met à jour les incrustations. Plus de détails...
C3D_API void	Render (Scene const &p_scene, Castor::Size const &p_size)
	Fonction de rendu des overlays visibles. Plus de détails...
C3D_API bool	Write (Castor::TextFile &p_file) const
	Ecrit les overlays dans un fichier texte. Plus de détails...
C3D_API bool	Read (Castor::TextFile &p_file)
	Lit les overlays à partir d'un fichier texte. Plus de détails...
C3D_API bool	Save (Castor::BinaryFile &p_file) const
	Ecrit les overlays dans un fichier binaire. Plus de détails...
C3D_API bool	Load (Castor::BinaryFile &p_file)
	Lit les overlays à partir d'un fichier binaire. Plus de détails...
C3D_API FontTextureSPtr	GetFontTexture (Castor::String const &p_name)
	Récupère une FontTexture, à partir d'un nom de police. Plus de détails...
C3D_API FontTextureSPtr	CreateFontTexture (Castor::FontSPtr p_font)
	Crée une FontTexture, à partir d'une police. Plus de détails...
OverlayRendererSPtr	GetRenderer () const
	Récupère le renderer d'incrustation. Plus de détails...
OverlayCategorySet::iterator	begin ()
	Récupère un itérateur sur la première incrustation. Plus de détails...
OverlayCategorySet::const_iterator	begin () const
	Récupère un itérateur sur la première incrustation. Plus de détails...
OverlayCategorySet::iterator	end ()
	Récupère un itérateur sur après la dernière incrustation. Plus de détails...
OverlayCategorySet::const_iterator	end () const
	Récupère un itérateur sur après la dernière incrustation. Plus de détails...
OverlayFactory const &	GetOverlayFactory () const
	Récupère la fabrique d'Overlay. Plus de détails...
OverlayFactory &	GetFactory ()
	Récupère la fabrique d'Overlay. Plus de détails...
Fonctions membres publiques hérités de Castor3D::Manager< Castor::String, Overlay, Engine, ResourceManagerEngineGetter >
void	Cleanup ()
	Met tous les éléments à nettoyer. Plus de détails...
void	Clear ()
	Vide la collection. Plus de détails...
bool	IsEmpty ()
void	Insert (Castor::String const &p_name, std::shared_ptr< Overlay > p_element)
	Retire un objet à partir d'un nom. Plus de détails...
void	Remove (Castor::String const &p_name)
	Retire un objet à partir d'un nom. Plus de détails...
void	SetRenderSystem (RenderSystem *p_renderSystem)
RenderSystem *	SetRenderSystem () const
Engine *	GetEngine () const
Castor::String const &	GetObjectTypeName () const
bool	Has (Castor::String const &p_name) const
std::shared_ptr< Overlay >	Find (Castor::String 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...
Collection::TObjPtrMapIt	begin ()
	Renvoie un itérateur sur le premier élément de la collection. Plus de détails...
Collection::TObjPtrMapConstIt	begin () const
	Renvoie un itérateur constant sur le premier élément de la collection. Plus de détails...
Collection::TObjPtrMapIt	end ()
	Renvoie un itérateur sur l'après dernier élément de la collection. Plus de détails...
Collection::TObjPtrMapConstIt	end () const
	Renvoie un itérateur constant sur l'après dernier élément de la collection. Plus de détails...
std::shared_ptr< Overlay >	Create (Castor::String const &p_name, Parameters &&...p_params)
	Crée un objet. Plus de détails...

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::ResourceManager< Castor::String, Overlay >
	ResourceManager (Engine &p_owner)
	Constructeur. Plus de détails...
	~ResourceManager ()
	Destructeur. Plus de détails...
Fonctions membres protégées hérités de Castor3D::Manager< Castor::String, Overlay, Engine, ResourceManagerEngineGetter >
	Manager (Engine &p_owner)
	Constructeur. Plus de détails...
	~Manager ()
	Destructeur. Plus de détails...
Attributs protégés hérités de Castor3D::Manager< Castor::String, Overlay, Engine, ResourceManagerEngineGetter >
RenderSystem *	m_renderSystem
	Le RenderSystem. Plus de détails...
Collection	m_elements
	La collection d'éléments. 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 Castor::Collection< Overlay, Castor::String >::TObjPtrMapConstIt Castor3D::OverlayManager::const_iterator

typedef Castor::Collection< Overlay, Castor::String >::TObjPtrMapIt Castor3D::OverlayManager::iterator

typedef std::set< OverlayCategorySPtr, OverlayCategorySort > Castor3D::OverlayManager::OverlayCategorySet

Documentation des constructeurs et destructeur

C3D_API Castor3D::OverlayManager::OverlayManager

(

Engine &

p_engine

)

Constructeur.

C3D_API Castor3D::OverlayManager::~OverlayManager

(

)

Destructeur.

Documentation des fonctions membres

OverlayCategorySet::iterator Castor3D::OverlayManager::begin ( )

inline

Récupère un itérateur sur la première incrustation.

Renvoie

La valeur

OverlayCategorySet::const_iterator Castor3D::OverlayManager::begin ( ) const

inline

Récupère un itérateur sur la première incrustation.

Renvoie

La valeur

C3D_API void Castor3D::OverlayManager::Cleanup

(

)

Nettoie les incrustations.

C3D_API void Castor3D::OverlayManager::Clear

(

)

Vide les listes d'incrustations.

C3D_API OverlaySPtr Castor3D::OverlayManager::Create	(	Castor::String const &	p_name,
		eOVERLAY_TYPE	p_type,
		OverlaySPtr	p_parent,
		SceneSPtr	p_scene
	)

Crée un overlay.

Remarques

Si un overlay avec le même nom existe déjà, aucune création n'est faite, l'existant est retourné

Paramètres

[in]	p_type	Le type d'overlay
[in]	p_name	Le nom voulu pour l'overlay
[in]	p_parent	L'overlay parent, nullptr si aucun
[in]	p_scene	La scène contenant l'overlay

Renvoie

L'overlay

C3D_API BorderPanelOverlaySPtr Castor3D::OverlayManager::CreateBorderPanel	(	Castor::String const &	p_name,
		Castor::Point2d const &	p_position,
		Castor::Point2d const &	p_size,
		MaterialSPtr	p_material,
		Castor::Point4d const &	p_bordersSize,
		MaterialSPtr	p_bordersMaterial,
		OverlaySPtr	p_parent = nullptr
	)

Crée une incrustation panneau borduré.

Remarques

Poste l'évènement d'initialisation au moteur.

Paramètres

[in]	p_name	Le nom de l'incrustation.
[in]	p_position	La position relative au parent, ou à l'écran, si pas de parent.
[in]	p_size	La taille relative au parent, ou à l'écran, si pas de parent.
[in]	p_material	Le matériau de l'incrustation.
[in]	p_bordersSize	Les dimensions des bords de l'incrustation.
[in]	p_bordersMaterial	Le matériau des bordures de l'incrustation.
[in]	p_parent	L'incrustation parente.

Renvoie

L'incrustation ainsi créée.

C3D_API BorderPanelOverlaySPtr Castor3D::OverlayManager::CreateBorderPanel	(	Castor::String const &	p_name,
		Castor::Position const &	p_position,
		Castor::Size const &	p_size,
		MaterialSPtr	p_material,
		Castor::Rectangle const &	p_bordersSize,
		MaterialSPtr	p_bordersMaterial,
		OverlaySPtr	p_parent = nullptr
	)

C3D_API FontTextureSPtr Castor3D::OverlayManager::CreateFontTexture

(

Castor::FontSPtr

p_font

)

Crée une FontTexture, à partir d'une police.

Paramètres

[in]

p_font

La police.

Renvoie

La FontTexture créée.

C3D_API PanelOverlaySPtr Castor3D::OverlayManager::CreatePanel	(	Castor::String const &	p_name,
		Castor::Point2d const &	p_position,
		Castor::Point2d const &	p_size,
		MaterialSPtr	p_material,
		OverlaySPtr	p_parent = nullptr
	)

Crée une incrustation panneau.

Remarques

Poste l'évènement d'initialisation au moteur.

Paramètres

[in]	p_name	Le nom de l'incrustation.
[in]	p_position	La position relative au parent, ou à l'écran, si pas de parent.
[in]	p_size	La taille relative au parent, ou à l'écran, si pas de parent.
[in]	p_material	Le matériau de l'incrustation.
[in]	p_parent	L'incrustation parente.

Renvoie

L'incrustation ainsi créée.

C3D_API PanelOverlaySPtr Castor3D::OverlayManager::CreatePanel	(	Castor::String const &	p_name,
		Castor::Position const &	p_position,
		Castor::Size const &	p_size,
		MaterialSPtr	p_material,
		OverlaySPtr	p_parent = nullptr
	)

Crée une incrustation panneau.

Remarques

Poste l'évènement d'initialisation au moteur.

Paramètres

[in]	p_name	Le nom de l'incrustation.
[in]	p_position	La position en pixels, dans le parent, ou l'écran, si pas de parent.
[in]	p_size	La taille absolue, en pixels.
[in]	p_material	Le matériau de l'incrustation.
[in]	p_parent	L'incrustation parente.

Renvoie

L'incrustation ainsi créée.

C3D_API TextOverlaySPtr Castor3D::OverlayManager::CreateText	(	Castor::String const &	p_name,
		Castor::Point2d const &	p_position,
		Castor::Point2d const &	p_size,
		MaterialSPtr	p_material,
		Castor::FontSPtr	p_font,
		OverlaySPtr	p_parent = nullptr
	)

Crée une incrustation texte.

Remarques

Poste l'évènement d'initialisation au moteur.

Paramètres

[in]	p_name	Le nom de l'incrustation.
[in]	p_position	La position relative au parent, ou à l'écran, si pas de parent.
[in]	p_size	La taille relative au parent, ou à l'écran, si pas de parent.
[in]	p_material	Le matériau de l'incrustation.
[in]	p_font	La police utilisée pour afficher le texte.
[in]	p_parent	L'incrustation parente.

Renvoie

L'incrustation ainsi créée.

C3D_API TextOverlaySPtr Castor3D::OverlayManager::CreateText	(	Castor::String const &	p_name,
		Castor::Position const &	p_position,
		Castor::Size const &	p_size,
		MaterialSPtr	p_material,
		Castor::FontSPtr	p_font,
		OverlaySPtr	p_parent = nullptr
	)

Crée une incrustation panneau.

Remarques

Poste l'évènement d'initialisation au moteur.

Paramètres

[in]	p_name	Le nom de l'incrustation.
[in]	p_position	La position en pixels, dans le parent, ou l'écran, si pas de parent.
[in]	p_size	La taille absolue, en pixels.
[in]	p_material	Le matériau de l'incrustation.
[in]	p_font	La police utilisée pour afficher le texte.
[in]	p_parent	L'incrustation parente.

Renvoie

L'incrustation ainsi créée.

Castor3D::OverlayManager::DECLARE_MAP	(	Castor::String	,
		FontTextureSPtr	,
		FontTextureStr
	)

OverlayCategorySet::iterator Castor3D::OverlayManager::end ( )

inline

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

Renvoie

La valeur

OverlayCategorySet::const_iterator Castor3D::OverlayManager::end ( ) const

inline

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

Renvoie

La valeur

OverlayFactory& Castor3D::OverlayManager::GetFactory ( )

inline

Récupère la fabrique d'Overlay.

Renvoie

La fabrique

C3D_API FontTextureSPtr Castor3D::OverlayManager::GetFontTexture

(

Castor::String const &

p_name

)

Récupère une FontTexture, à partir d'un nom de police.

Paramètres

[in]

p_name

Le nom de la police.

Renvoie

La FontTexture si elle exite, nullptr sinon.

OverlayFactory const& Castor3D::OverlayManager::GetOverlayFactory ( ) const

inline

Récupère la fabrique d'Overlay.

Renvoie

La fabrique

OverlayRendererSPtr Castor3D::OverlayManager::GetRenderer ( ) const

inline

Récupère le renderer d'incrustation.

Renvoie

Le renderer d'incrustation

C3D_API bool Castor3D::OverlayManager::Load

(

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é

C3D_API bool Castor3D::OverlayManager::Read

(

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é

C3D_API void Castor3D::OverlayManager::Remove

(

Castor::String const &

p_name

)

Enlève une incrustation des listes.

Paramètres

[in]

p_name

Le nom de l'incrustation.

C3D_API void Castor3D::OverlayManager::Render	(	Scene const &	p_scene,
		Castor::Size const &	p_size
	)

Fonction de rendu des overlays visibles.

Paramètres

[in]	p_scene	La scène rendue, pour afficher ses overlays en plus des globaux
[in]	p_size	Les dimensions de la cible du rendu

C3D_API bool Castor3D::OverlayManager::Save

(

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é

C3D_API void Castor3D::OverlayManager::Update

(

)

Met à jour les incrustations.

C3D_API void Castor3D::OverlayManager::UpdateRenderer

(

)

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

C3D_API bool Castor3D::OverlayManager::Write

(

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:/software/Castor3D/source/Core/Castor3D/Src/OverlayManager.hpp