Référence de la classe castor3d::Overlay

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

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

Graphe de collaboration de castor3d::Overlay:

Classes
class	TextWriter
	Overlay loader. Plus de détails...

Types publics
using	iterator = OverlayPtrArray::iterator
using	const_iterator = OverlayPtrArray::const_iterator

Fonctions membres publiques
C3D_API	Overlay (Engine &engine, OverlayType p_type)
	Constructeur. Plus de détails...
C3D_API	Overlay (Engine &engine, OverlayType p_type, SceneSPtr p_scene, OverlaySPtr p_parent)
virtual C3D_API	~Overlay ()
	Destructeur. Plus de détails...
virtual C3D_API void	render (castor::Size const &p_size)
	Dessine l'incrustation. Plus de détails...
C3D_API void	addChild (OverlaySPtr p_overlay)
	Ajoute un enfant à l'incrustation. Plus de détails...
C3D_API uint32_t	getChildrenCount (int p_level) const
	Récupère le compte des enfants du niveau donné Plus de détails...
C3D_API PanelOverlaySPtr	getPanelOverlay () const
	Récupère la l'incrustation panneau. Plus de détails...
C3D_API BorderPanelOverlaySPtr	getBorderPanelOverlay () const
	Récupère la l'incrustation panneau borduré. Plus de détails...
C3D_API TextOverlaySPtr	getTextOverlay () const
	Récupère la l'incrustation texte. Plus de détails...
C3D_API bool	isVisible () const
	Récupère le statut de visibilité Plus de détails...
OverlayCategorySPtr	getCategory () const
	Récupère la categorie d'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...
bool	isSizeChanged () const
bool	isPositionChanged () const
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...
OverlayType	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	getIndex () const
	Récupère l'indice. Plus de détails...
int	getLevel () const
	Récupère le niveau. Plus de détails...
uint32_t	getChildrenCount () 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...
void	setVisible (bool val)
	Définit le statut de visibilité Plus de détails...
void	setOrder (int p_index, int p_level)
	Définit l'ordre de l'incrustation. Plus de détails...
void	setMaterial (MaterialSPtr p_material)
	Définit le matériau. Plus de détails...
void	setPosition (castor::Point2d const &p_position)
	Définit la position relative de l'incrustation. Plus de détails...
void	setSize (castor::Point2d const &p_size)
	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_name)
	Définit le nom de l'incrustation. Plus de détails...

Attributs protégés
castor::String	m_name
	Le nom de l'incrustation. Plus de détails...
OverlayWPtr	m_parent
	L'incrustation parente, s'il y en a. Plus de détails...
OverlayPtrArray	m_overlays
	Les enfants. Plus de détails...
OverlayCategorySPtr	m_category
	La catégorie de l'incrustation. Plus de détails...
SceneWPtr	m_scene
	La scène parente. Plus de détails...
RenderSystem *	m_renderSystem
	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

const_iterator

using castor3d::Overlay::const_iterator = OverlayPtrArray::const_iterator

iterator

using castor3d::Overlay::iterator = OverlayPtrArray::iterator

Documentation des constructeurs et destructeur

Overlay() [1/2]

C3D_API castor3d::Overlay::Overlay	(	Engine &	engine,
		OverlayType	p_type
	)

Constructeur.

Paramètres

[in]	engine	Le moteur
[in]	p_type	Le type de l'incrustation

Overlay() [2/2]

C3D_API castor3d::Overlay::Overlay	(	Engine &	engine,
		OverlayType	p_type,
		SceneSPtr	p_scene,
		OverlaySPtr	p_parent
	)

~Overlay()

virtual C3D_API castor3d::Overlay::~Overlay ( )

virtual

Destructeur.

Documentation des fonctions membres

addChild()

C3D_API void castor3d::Overlay::addChild

(

OverlaySPtr

p_overlay

)

Ajoute un enfant à l'incrustation.

Paramètres

[in]

p_overlay

L'incrustation enfant

Renvoie

true si tout s'est bien passé

begin() [1/2]

iterator castor3d::Overlay::begin ( )

inline

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

Renvoie

La valeur

Références m_overlays.

begin() [2/2]

const_iterator castor3d::Overlay::begin ( ) const

inline

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

Renvoie

La valeur

Références m_overlays.

end() [1/2]

iterator castor3d::Overlay::end ( )

inline

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

Renvoie

La valeur

Références m_overlays.

end() [2/2]

const_iterator castor3d::Overlay::end ( ) const

inline

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

Renvoie

La valeur

Références m_overlays.

getAbsolutePosition() [1/2]

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

Références m_category.

getAbsolutePosition() [2/2]

castor::Point2d castor3d::Overlay::getAbsolutePosition ( ) const

inline

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

Renvoie

La position

Références m_category.

getAbsoluteSize() [1/2]

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

Références m_category.

getAbsoluteSize() [2/2]

castor::Point2d castor3d::Overlay::getAbsoluteSize ( ) const

inline

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

Renvoie

La taille

Références m_category.

getBorderPanelOverlay()

C3D_API BorderPanelOverlaySPtr castor3d::Overlay::getBorderPanelOverlay

(

)

const

Récupère la l'incrustation panneau borduré.

Renvoie

La catégorie.

getCategory()

OverlayCategorySPtr castor3d::Overlay::getCategory ( ) const

inline

Récupère la categorie d'incrustation.

Renvoie

La catégorie.

Références m_category.

getChildrenCount() [1/2]

C3D_API uint32_t castor3d::Overlay::getChildrenCount

(

int

p_level

)

const

Récupère le compte des enfants du niveau donné

Paramètres

[in]

p_level

Le niveau voulu

Renvoie

Le compte

getChildrenCount() [2/2]

uint32_t castor3d::Overlay::getChildrenCount ( ) const

inline

Récupère le nombre d'enfants.

Renvoie

La valeur

Références m_overlays.

getIndex()

int castor3d::Overlay::getIndex ( ) const

inline

Récupère l'indice.

Renvoie

La valeur

Références m_category.

getLevel()

int castor3d::Overlay::getLevel ( ) const

inline

Récupère le niveau.

Renvoie

La valeur

Références m_category.

getMaterial()

MaterialSPtr castor3d::Overlay::getMaterial ( ) const

inline

Récupère le matériau.

Renvoie

La valeur

Références m_category.

getName()

castor::String const& castor3d::Overlay::getName ( ) const

inline

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

Renvoie

La valeur

Références m_name.

getPanelOverlay()

C3D_API PanelOverlaySPtr castor3d::Overlay::getPanelOverlay

(

)

const

Récupère la l'incrustation panneau.

Renvoie

La catégorie.

getParent()

OverlaySPtr castor3d::Overlay::getParent ( ) const

inline

Récupère l'incrustation parente.

Renvoie

La valeur

Références m_parent.

getPixelPosition() [1/2]

castor::Position const& castor3d::Overlay::getPixelPosition ( ) const

inline

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

Renvoie

La valeur

Références m_category.

getPixelPosition() [2/2]

castor::Position& castor3d::Overlay::getPixelPosition ( )

inline

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

Renvoie

La valeur

Références m_category.

getPixelSize() [1/2]

castor::Size const& castor3d::Overlay::getPixelSize ( ) const

inline

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

Renvoie

La valeur

Références m_category.

getPixelSize() [2/2]

castor::Size& castor3d::Overlay::getPixelSize ( )

inline

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

Renvoie

La valeur

Références m_category.

getPosition() [1/2]

castor::Point2d const& castor3d::Overlay::getPosition ( ) const

inline

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

Renvoie

La valeur

Références m_category.

getPosition() [2/2]

castor::Point2d& castor3d::Overlay::getPosition ( )

inline

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

Renvoie

La valeur

Références m_category.

getScene()

SceneSPtr castor3d::Overlay::getScene ( ) const

inline

Récupère la scène parente.

Renvoie

La valeur

Références m_scene.

getSize() [1/2]

castor::Point2d const& castor3d::Overlay::getSize ( ) const

inline

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

Renvoie

La valeur

Références m_category.

getSize() [2/2]

castor::Point2d& castor3d::Overlay::getSize ( )

inline

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

Renvoie

La valeur

Références m_category.

getTextOverlay()

C3D_API TextOverlaySPtr castor3d::Overlay::getTextOverlay

(

)

const

Récupère la l'incrustation texte.

Renvoie

La catégorie.

getType()

OverlayType castor3d::Overlay::getType ( ) const

inline

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

Renvoie

La valeur

Références m_category.

isPositionChanged()

bool castor3d::Overlay::isPositionChanged ( ) const

inline

Renvoie

true si la position de cette incrustation ou d'un de ses parents a changé.

Références m_category.

isSizeChanged()

bool castor3d::Overlay::isSizeChanged ( ) const

inline

Renvoie

true si les dimensions de cette incrustation ou d'un de ses parents ont changé.

Références m_category.

isVisible()

C3D_API bool castor3d::Overlay::isVisible

(

)

const

Récupère le statut de visibilité

Renvoie

La valeur

render()

virtual C3D_API 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

setMaterial()

void castor3d::Overlay::setMaterial ( MaterialSPtr  p_material )

inline

Définit le matériau.

Paramètres

[in]

p_material

La nouvelle valeur

Références m_category.

setName()

void castor3d::Overlay::setName ( castor::String const &  p_name )

inline

Définit le nom de l'incrustation.

Paramètres

[in]

p_name

Le nouveau nom

Références m_name.

setOrder()

void castor3d::Overlay::setOrder ( int  p_index, int  p_level  )

inline

Définit l'ordre de l'incrustation.

Paramètres

[in]	p_index	Le nouvel indice
[in]	p_level	Le nouveau niveau

Références m_category.

setPixelPosition()

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

Références m_category.

setPixelSize()

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

Références m_category.

setPosition()

void castor3d::Overlay::setPosition ( castor::Point2d const &  p_position )

inline

Définit la position relative de l'incrustation.

Paramètres

[in]

p_position

La nouvelle position

Références m_category.

setSize()

void castor3d::Overlay::setSize ( castor::Point2d const &  p_size )

inline

Définit les dimensions relatives de l'incrustation.

Paramètres

[in]

p_size

Les nouvelles dimensions

Références m_category.

setVisible()

void castor3d::Overlay::setVisible ( bool  val )

inline

Définit le statut de visibilité

Paramètres

[in]

val

La nouvelle valeur

Références m_category.

Documentation des données membres

m_category

OverlayCategorySPtr castor3d::Overlay::m_category

protected

La catégorie de l'incrustation.

Référencé par getAbsolutePosition(), getAbsoluteSize(), getCategory(), getIndex(), getLevel(), getMaterial(), getPixelPosition(), getPixelSize(), getPosition(), getSize(), getType(), isPositionChanged(), isSizeChanged(), setMaterial(), setOrder(), setPixelPosition(), setPixelSize(), setPosition(), setSize(), et setVisible().

m_name

castor::String castor3d::Overlay::m_name

protected

Le nom de l'incrustation.

Référencé par getName(), et setName().

m_overlays

OverlayPtrArray castor3d::Overlay::m_overlays

protected

Les enfants.

Référencé par begin(), end(), et getChildrenCount().

m_parent

OverlayWPtr castor3d::Overlay::m_parent

protected

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

Référencé par getParent().

m_renderSystem

RenderSystem* castor3d::Overlay::m_renderSystem

protected

Le système de rendu.

m_scene

SceneWPtr castor3d::Overlay::m_scene

protected

La scène parente.

Référencé par getScene().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Overlay/Overlay.hpp