Une incrustation avec du texte. Plus de détails...

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

Graphe de collaboration de Castor3D::TextOverlay:

Classes
class	BinaryParser

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

Fonctions membres publiques
	DECLARE_MAP (xchar, Castor::Position, GlyphPosition)

	TextOverlay ()
	Constructeur. Plus de détails...

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

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

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

void	SetFont (Castor::String const &p_strFont)
	D�finit la police du texte. Plus de détails...

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

Castor::String const &	GetFontName () const
	R�cup�re le nom de la police. Plus de détails...

Castor::FontSPtr	GetFont () const
	R�cup�re la police. Plus de détails...

Castor::String	GetCaption () const
	R�cup�re le texte de l'incrustation. Plus de détails...

void	SetCaption (Castor::String const &p_strCaption)
	D�finit le texte de l'incrustation. Plus de détails...

void	SetTextWrappingMode (eTEXT_WRAPPING_MODE p_mode)
	D�finit le mode de d�coupe du texte. Plus de détails...

DynamicTextureSPtr	GetTexture () const
	R�cup�re la texture. Plus de détails...

Castor::Position const &	GetGlyphPosition (xchar p_char) const
	R�cup�re la position de la glyphe voulue. Plus de détails...

Fonctions membres publiques hérités de Castor3D::OverlayCategory
	OverlayCategory (eOVERLAY_TYPE p_eType)
	Constructeur. Plus de détails...

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

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

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

virtual void	UpdatePositionAndSize ()
	Met � jour la position et la tille de l'incrustation, en prenant en compte la taille en pixel et la position en pixel voulues. 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...

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

void	SetSize (Castor::Point2d const &p_ptSize)
	D�finit la taille 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::Point2d const &	GetPosition () 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...

Castor::Position const &	GetPixelPosition () const
	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::Point2d &	GetPosition ()
	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...

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

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

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

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

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

Overlay const &	GetOverlay () const
	R�cup�re l'incrustation. Plus de détails...

Overlay &	GetOverlay ()
	R�cup�re l'incrustation. Plus de détails...

void	SetOverlay (Overlay *val)
	D�finit l'incrustation. Plus de détails...

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

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

void	SetPixelSize (Castor::Size const &val)
	D�finit la taille de l'incrustation. Plus de détails...

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

void	SetRenderer (OverlayRendererSPtr p_pRenderer)
	D�finit le renderer d'incrustations. Plus de détails...

std::vector < OverlayCategory::Vertex > const &	GetVertexBuffer () const
	R�cup�re le tampon de sommets. Plus de détails...

void	SetUV (Castor::Point4d const &val)
	D�finit Les UV de l'incrustation. Plus de détails...

Castor::Point4d const &	GetUV () const
	R�cup�re Les UV de l'incrustation. Plus de détails...

Fonctions membres publiques statiques
static OverlayCategorySPtr	Create ()
	Fonction de cr�ation utilis�e par la fabrique. Plus de détails...

Fonctions membres protégées
virtual void	DoRender (OverlayRendererSPtr p_renderer)
	Dessine l'incrustation. Plus de détails...

virtual void	DoUpdate (OverlayRendererSPtr p_renderer)
	Met � jour le tampon de sommets. Plus de détails...

void	DoWriteWord (OverlayRendererSPtr p_renderer, Castor::String const &p_word, double p_wordWidth, Castor::Point2d const &p_size, Castor::Point2d &p_position)
	Ajoute un mot au tampon de sommets. Plus de détails...

Attributs protégés
Castor::String	m_strCaption
	Le texte courant de l'incrustation. Plus de détails...

Castor::String	m_previousCaption
	Le texte pr�c�dent de l'incrustation. Plus de détails...

Castor::FontWPtr	m_wpFont
	La police. Plus de détails...

SamplerWPtr	m_wpSampler
	L'�chantillonneur de la texture. Plus de détails...

DynamicTextureSPtr	m_pTexture
	La texture qui recevra les glyphes. Plus de détails...

Castor::String	m_strFontName
	Le nom de la police. Plus de détails...

GlyphPositionMap	m_glyphsPositions
	Position des glyphes. Plus de détails...

eTEXT_WRAPPING_MODE	m_wrappingMode
	Le mode de d�coupe du texte. Plus de détails...

Attributs protégés hérités de Castor3D::OverlayCategory
Overlay *	m_pOverlay
	L'incrustation. Plus de détails...

Castor::Point2d	m_ptPosition
	La position relative (au parent ou � l'�cran) Plus de détails...

Castor::Point2d	m_ptSize
	La taille relative (� l'�cran ou au parent) Plus de détails...

Castor::Position	m_position
	La position relative (� l'�cran ou au parent), en pixels. Plus de détails...

Castor::Size	m_size
	La taille absolue en pixels. Plus de détails...

bool	m_bVisible
	La visibilit� Plus de détails...

MaterialWPtr	m_pMaterial
	Le mat�riau utilis� par l'incrustation. Plus de détails...

int	m_iCurrentZIndex
	Le Z index de l'overlay. Plus de détails...

Castor::String	m_strMatName
	Le nom du mat�riau. Plus de détails...

eOVERLAY_TYPE	m_eType
	Le type de l'incrustation. Plus de détails...

OverlayRendererWPtr	m_pRenderer
	Le renderer d'incrustation. Plus de détails...

std::vector < OverlayCategory::Vertex >	m_arrayVtx
	Les donn�es du tampon de sommets. Plus de détails...

bool	m_changed
	Dit que l'incrustation a chang� et doit �tre mise � jour. Plus de détails...

Castor::Point4d	m_uv
	Les UV du panneau. Plus de détails...

Description détaillée

Une incrustation avec du texte.

Auteur: Sylvain DOREMUS

Date: 25/08/2010

Documentation des constructeurs et destructeur

Castor3D::TextOverlay::TextOverlay ( )

Constructeur.

virtual Castor3D::TextOverlay::~TextOverlay ( )

virtual

Destructeur.

Documentation des fonctions membres

void Castor3D::TextOverlay::Cleanup ( )

Nettoie l'incrustation.

static OverlayCategorySPtr Castor3D::TextOverlay::Create ( )

static

Fonction de cr�ation utilis�e par la fabrique.

Renvoie: Un overlay

Castor3D::TextOverlay::DECLARE_MAP	(	xchar	,
		Castor::Position	,
		GlyphPosition
	)

virtual void Castor3D::TextOverlay::DoRender ( OverlayRendererSPtr p_renderer )

protectedvirtual

Dessine l'incrustation.

Paramètres

[in] p_renderer Le renderer utilis� pour dessiner cette incrustation

Implémente Castor3D::OverlayCategory.

virtual void Castor3D::TextOverlay::DoUpdate ( OverlayRendererSPtr p_renderer )

protectedvirtual

Met � jour le tampon de sommets.

Paramètres

[in] p_renderer Le renderer utilis� pour dessiner cette incrustation

Implémente Castor3D::OverlayCategory.

void Castor3D::TextOverlay::DoWriteWord	(	OverlayRendererSPtr	p_renderer,
		Castor::String const &	p_word,
		double	p_wordWidth,
		Castor::Point2d const &	p_size,
		Castor::Point2d &	p_position
	)

protected

Ajoute un mot au tampon de sommets.

Paramètres

[in]	p_renderer	Le renderer utilis� pour dessiner cette incrustation
[in]	p_word	Le mot � ajouter
[in]	p_wordWidth	La largeur du mot
[in]	p_position	La position du mot
[in]	p_size	La taille de l'incrustation

Castor::String Castor3D::TextOverlay::GetCaption ( ) const

inline

R�cup�re le texte de l'incrustation.

Renvoie: La valeur

Castor::FontSPtr Castor3D::TextOverlay::GetFont ( ) const

inline

R�cup�re la police.

Renvoie: La valeur

Castor::String const& Castor3D::TextOverlay::GetFontName ( ) const

R�cup�re le nom de la police.

Renvoie: La valeur

Castor::Position const& Castor3D::TextOverlay::GetGlyphPosition ( xchar p_char ) const

R�cup�re la position de la glyphe voulue.

Paramètres

[in] p_char L'indice de la glyphe

Renvoie: La position

DynamicTextureSPtr Castor3D::TextOverlay::GetTexture ( ) const

inline

R�cup�re la texture.

Renvoie: La texture

bool Castor3D::TextOverlay::Initialise ( )

Initialise l'incrustation.

void Castor3D::TextOverlay::SetCaption ( Castor::String const & p_strCaption )

inline

D�finit le texte de l'incrustation.

Paramètres

[in] p_strCaption La nouvelle valeur

void Castor3D::TextOverlay::SetFont ( Castor::String const & p_strFont )

D�finit la police du texte.

Paramètres

[in] p_strFont La nouvelle valeur

virtual void Castor3D::TextOverlay::SetMaterial ( MaterialSPtr p_pMaterial )

virtual

D�finit le mat�riau.

Paramètres

[in] p_pMaterial La nouvelle valeur

Réimplémentée à partir de Castor3D::OverlayCategory.

void Castor3D::TextOverlay::SetTextWrappingMode ( eTEXT_WRAPPING_MODE p_mode )

inline

D�finit le mode de d�coupe du texte.

Paramètres

[in] p_mode La nouvelle valeur

Documentation des données membres

GlyphPositionMap Castor3D::TextOverlay::m_glyphsPositions

protected

Position des glyphes.

Castor::String Castor3D::TextOverlay::m_previousCaption

protected

Le texte pr�c�dent de l'incrustation.

DynamicTextureSPtr Castor3D::TextOverlay::m_pTexture

protected

La texture qui recevra les glyphes.

Castor::String Castor3D::TextOverlay::m_strCaption

protected

Le texte courant de l'incrustation.

Castor::String Castor3D::TextOverlay::m_strFontName

protected

Le nom de la police.

Castor::FontWPtr Castor3D::TextOverlay::m_wpFont

protected

La police.

SamplerWPtr Castor3D::TextOverlay::m_wpSampler

protected

L'�chantillonneur de la texture.

eTEXT_WRAPPING_MODE Castor3D::TextOverlay::m_wrappingMode

protected

Le mode de d�coupe du texte.

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

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

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres