La classe d'incrustation. Plus de détails...

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

Graphe de collaboration de Castor3D::Overlay:

Classes
class	BinaryParser

class	TextLoader
	Overlay loader. Plus de détails...

Fonctions membres publiques
	Overlay (Engine *p_pEngine, eOVERLAY_TYPE p_eType)
	Constructeur. Plus de détails...

	Overlay (Engine *p_pEngine, eOVERLAY_TYPE p_eType, SceneSPtr p_pScene, OverlaySPtr p_pParent)

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

virtual void	Render (Castor::Size const &p_size)
	Dessine l'incrustation. Plus de détails...

bool	AddChild (OverlaySPtr p_pOverlay, int p_iZIndex)
	Ajoute un enfant à l'incrustation. Plus de détails...

void	Initialise ()
	Initialise l'incrustation. Plus de détails...

Castor::Position	GetAbsolutePosition (Castor::Size const &p_size) const
	Récupère la position absolue de l'incrustation, en pixels. Plus de détails...

Castor::Size	GetAbsoluteSize (Castor::Size const &p_size) const
	Récupère la taille absolue de l'incrustation, en pixels. Plus de détails...

Castor::Point2d	GetAbsolutePosition () const
	Récupère la position absolue de l'incrustation. Plus de détails...

Castor::Point2d	GetAbsoluteSize () const
	Récupère la taille absolue de l'incrustation. Plus de détails...

Engine *	GetEngine ()
	Récupère le moteur. Plus de détails...

Castor::String const &	GetName () const
	Récupère le nom de l'incrustation. Plus de détails...

Castor::Point2d const &	GetPosition () const
	Récupère la position de l'incrustation. Plus de détails...

Castor::Point2d const &	GetSize () const
	Récupère la taille de l'incrustation. Plus de détails...

Castor::Position const &	GetPixelPosition () const
	Récupère la position de l'incrustation. Plus de détails...

Castor::Size const &	GetPixelSize () const
	Récupère la taille de l'incrustation. Plus de détails...

bool	IsVisible () const
	Récupère le statut de visibilité Plus de détails...

eOVERLAY_TYPE	GetType () const
	Récupère le type de l'incrustation. Plus de détails...

OverlaySPtr	GetParent () const
	Récupère l'incrustation parente. Plus de détails...

MaterialSPtr	GetMaterial () const
	Récupère le matériau. Plus de détails...

Castor::Point2d &	GetPosition ()
	Récupère la position de l'incrustation. Plus de détails...

Castor::Point2d &	GetSize ()
	Récupère la taille de l'incrustation. Plus de détails...

Castor::Position &	GetPixelPosition ()
	Récupère la position de l'incrustation. Plus de détails...

Castor::Size &	GetPixelSize ()
	Récupère la taille de l'incrustation. Plus de détails...

SceneSPtr	GetScene () const
	Récupère la scène parente. Plus de détails...

int	GetZIndex () const
	Récupère le Z index. Plus de détails...

uint32_t	GetChildsCount () const
	Récupère le nombre d'enfants. Plus de détails...

iterator	Begin ()
	Récupère un itérateur sur le premier enfant. Plus de détails...

const_iterator	Begin () const
	Récupère un itérateur sur le premier enfant. Plus de détails...

iterator	End ()
	Récupère un itérateur sur après le dernier enfant. Plus de détails...

const_iterator	End () const
	Récupère un itérateur sur après le dernier enfant. Plus de détails...

OverlayCategorySPtr	GetOverlayCategory () const
	Récupère la catégorie de l'overlay. Plus de détails...

void	SetVisible (bool val)
	Définit le statut de visibilité Plus de détails...

void	SetZIndex (int p_iZIndex)
	Définit le Z index. Plus de détails...

void	SetMaterial (MaterialSPtr p_pMaterial)
	Définit le matériau. Plus de détails...

void	SetPosition (Castor::Point2d const &p_ptPosition)
	Définit la position relative de l'incrustation. Plus de détails...

void	SetSize (Castor::Point2d const &p_ptSize)
	Définit les dimensions relatives de l'incrustation. Plus de détails...

void	SetPixelPosition (Castor::Position const &p_position)
	Définit la position relative de l'incrustation. Plus de détails...

void	SetPixelSize (Castor::Size const &p_size)
	Définit les dimensions relatives de l'incrustation. Plus de détails...

void	SetName (Castor::String const &p_strName)
	Définit le nom de l'incrustation. Plus de détails...

Types protégés
typedef OverlayPtrIntMap::iterator	iterator

typedef OverlayPtrIntMap::const_iterator	const_iterator

Attributs protégés
Castor::String	m_strName
	Le nom de l'incrustation. Plus de détails...

OverlayWPtr	m_pParent
	L'incrustation parente, s'il y en a. Plus de détails...

OverlayPtrIntMap	m_mapOverlays
	Les enfants. Plus de détails...

OverlayCategorySPtr	m_pOverlayCategory
	La catégorie de l'incrustation. Plus de détails...

SceneWPtr	m_pScene
	La scène parente. Plus de détails...

OverlayPtrArray	m_arrayOverlays
	Les enfants. Plus de détails...

OverlayFactory &	m_factory
	La fabrique. Plus de détails...

Engine *	m_pEngine
	Le moteur. Plus de détails...

RenderSystem *	m_pRenderSystem
	Le système de rendu. Plus de détails...

Description détaillée

La classe d'incrustation.

Auteur: Sylvain DOREMUS

Date: 25/08/2010

Remarques: Une incrustation est un élément 2D qui est affiché en premier plan

Documentation des définitions de type membres

typedef OverlayPtrIntMap::const_iterator Castor3D::Overlay::const_iterator

protected

typedef OverlayPtrIntMap::iterator Castor3D::Overlay::iterator

protected

Documentation des constructeurs et destructeur

Castor3D::Overlay::Overlay	(	Engine *	p_pEngine,
		eOVERLAY_TYPE	p_eType
	)

Constructeur.

Paramètres

[in]	p_pEngine	Le moteur
[in]	p_eType	Le type de l'incrustation

Castor3D::Overlay::Overlay	(	Engine *	p_pEngine,
		eOVERLAY_TYPE	p_eType,
		SceneSPtr	p_pScene,
		OverlaySPtr	p_pParent
	)

virtual Castor3D::Overlay::~Overlay ( )

virtual

Destructeur.

Documentation des fonctions membres

bool Castor3D::Overlay::AddChild	(	OverlaySPtr	p_pOverlay,
		int	p_iZIndex
	)

Ajoute un enfant à l'incrustation.

Paramètres

[in]	p_pOverlay	L'incrustation enfant
[in]	p_iZIndex	Le Z index souhaité pour l'enfant

Renvoie: true si tout s'est bien passé

iterator Castor3D::Overlay::Begin ( )

inline

Récupère un itérateur sur le premier enfant.

Renvoie: La valeur

const_iterator Castor3D::Overlay::Begin ( ) const

inline

Récupère un itérateur sur le premier enfant.

Renvoie: La valeur

iterator Castor3D::Overlay::End ( )

inline

Récupère un itérateur sur après le dernier enfant.

Renvoie: La valeur

const_iterator Castor3D::Overlay::End ( ) const

inline

Récupère un itérateur sur après le dernier enfant.

Renvoie: La valeur

Castor::Position Castor3D::Overlay::GetAbsolutePosition ( Castor::Size const & p_size ) const

inline

Récupère la position absolue de l'incrustation, en pixels.

Paramètres

[in] p_size La taille de l'écran

Renvoie: La position

Castor::Point2d Castor3D::Overlay::GetAbsolutePosition ( ) const

inline

Récupère la position absolue de l'incrustation.

Renvoie: La position

Castor::Size Castor3D::Overlay::GetAbsoluteSize ( Castor::Size const & p_size ) const

inline

Récupère la taille absolue de l'incrustation, en pixels.

Paramètres

[in] p_size La taille de l'écran

Renvoie: La taille

Castor::Point2d Castor3D::Overlay::GetAbsoluteSize ( ) const

inline

Récupère la taille absolue de l'incrustation.

Renvoie: La taille

uint32_t Castor3D::Overlay::GetChildsCount ( ) const

inline

Récupère le nombre d'enfants.

Renvoie: La valeur

Engine* Castor3D::Overlay::GetEngine ( )

inline

Récupère le moteur.

Renvoie: La valeur

MaterialSPtr Castor3D::Overlay::GetMaterial ( ) const

inline

Récupère le matériau.

Renvoie: La valeur

Castor::String const& Castor3D::Overlay::GetName ( ) const

inline

Récupère le nom de l'incrustation.

Renvoie: La valeur

OverlayCategorySPtr Castor3D::Overlay::GetOverlayCategory ( ) const

inline

Récupère la catégorie de l'overlay.

Renvoie: La valeur

OverlaySPtr Castor3D::Overlay::GetParent ( ) const

inline

Récupère l'incrustation parente.

Renvoie: La valeur

Castor::Position const& Castor3D::Overlay::GetPixelPosition ( ) const

inline

Récupère la position de l'incrustation.

Renvoie: La valeur

Castor::Position& Castor3D::Overlay::GetPixelPosition ( )

inline

Récupère la position de l'incrustation.

Renvoie: La valeur

Castor::Size const& Castor3D::Overlay::GetPixelSize ( ) const

inline

Récupère la taille de l'incrustation.

Renvoie: La valeur

Castor::Size& Castor3D::Overlay::GetPixelSize ( )

inline

Récupère la taille de l'incrustation.

Renvoie: La valeur

Castor::Point2d const& Castor3D::Overlay::GetPosition ( ) const

inline

Récupère la position de l'incrustation.

Renvoie: La valeur

Castor::Point2d& Castor3D::Overlay::GetPosition ( )

inline

Récupère la position de l'incrustation.

Renvoie: La valeur

SceneSPtr Castor3D::Overlay::GetScene ( ) const

inline

Récupère la scène parente.

Renvoie: La valeur

Castor::Point2d const& Castor3D::Overlay::GetSize ( ) const

inline

Récupère la taille de l'incrustation.

Renvoie: La valeur

Castor::Point2d& Castor3D::Overlay::GetSize ( )

inline

Récupère la taille de l'incrustation.

Renvoie: La valeur

eOVERLAY_TYPE Castor3D::Overlay::GetType ( ) const

inline

Récupère le type de l'incrustation.

Renvoie: La valeur

int Castor3D::Overlay::GetZIndex ( ) const

inline

Récupère le Z index.

Renvoie: La valeur

void Castor3D::Overlay::Initialise ( )

Initialise l'incrustation.

Remarques: Vérifie le matériau utilisé, ajoute un shader automatique si besoin est
Initialise la partie rendu.

bool Castor3D::Overlay::IsVisible ( ) const

inline

Récupère le statut de visibilité

Renvoie: La valeur

virtual void Castor3D::Overlay::Render ( Castor::Size const & p_size )

virtual

Dessine l'incrustation.

Paramètres

[in] p_size Les dimensions de la cible du rendu

void Castor3D::Overlay::SetMaterial ( MaterialSPtr p_pMaterial )

inline

Définit le matériau.

Paramètres

[in] p_pMaterial La nouvelle valeur

void Castor3D::Overlay::SetName ( Castor::String const & p_strName )

inline

Définit le nom de l'incrustation.

Paramètres

[in] p_strName Le nouveau nom

void Castor3D::Overlay::SetPixelPosition ( Castor::Position const & p_position )

inline

Définit la position relative de l'incrustation.

Paramètres

[in] p_position La nouvelle position

void Castor3D::Overlay::SetPixelSize ( Castor::Size const & p_size )

inline

Définit les dimensions relatives de l'incrustation.

Paramètres

[in] p_size Les nouvelles dimensions

void Castor3D::Overlay::SetPosition ( Castor::Point2d const & p_ptPosition )

inline

Définit la position relative de l'incrustation.

Paramètres

[in] p_ptPosition La nouvelle position

void Castor3D::Overlay::SetSize ( Castor::Point2d const & p_ptSize )

inline

Définit les dimensions relatives de l'incrustation.

Paramètres

[in] p_ptSize Les nouvelles dimensions

void Castor3D::Overlay::SetVisible ( bool val )

inline

Définit le statut de visibilité

Paramètres

[in] val La nouvelle valeur

void Castor3D::Overlay::SetZIndex ( int p_iZIndex )

inline

Définit le Z index.

Paramètres

[in] p_iZIndex La nouvelle valeur

Documentation des données membres

OverlayPtrArray Castor3D::Overlay::m_arrayOverlays

mutableprotected

Les enfants.

OverlayFactory& Castor3D::Overlay::m_factory

protected

La fabrique.

OverlayPtrIntMap Castor3D::Overlay::m_mapOverlays

protected

Les enfants.

Engine* Castor3D::Overlay::m_pEngine

protected

Le moteur.

OverlayCategorySPtr Castor3D::Overlay::m_pOverlayCategory

protected

La catégorie de l'incrustation.

OverlayWPtr Castor3D::Overlay::m_pParent

protected

L'incrustation parente, s'il y en a.

RenderSystem* Castor3D::Overlay::m_pRenderSystem

protected

Le système de rendu.

SceneWPtr Castor3D::Overlay::m_pScene

protected

La scène parente.

Castor::String Castor3D::Overlay::m_strName

protected

Le nom de l'incrustation.

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

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

Classes

Fonctions membres publiques

Types protégés

Attributs protégés

Description détaillée

Documentation des définitions de type membres

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres