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...

struct	Vertex
	Contient les données spécifiques de sommet pour un TextOverlay. Plus de détails...

Fonctions membres publiques
	DECLARE_VECTOR (Vertex, Vertex)

	DECLARE_MAP (char32_t, Castor::Position, GlyphPosition)

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

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

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

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

virtual C3D_API bool	IsChanged () const

FontTextureSPtr	GetFontTexture () const

VertexArray const &	GetTextVertex () const
	Récupère le tampon de sommets du panneau. 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_caption)
	Définit le texte de l'incrustation. Plus de détails...

void	SetCaption (Castor::OutputStream const &p_caption)
	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...

eHALIGN	GetHAlign () const
	Récupère l'alignement horizontal. Plus de détails...

eVALIGN	GetVAlign () const
	Récupère l'alignement vertical. Plus de détails...

void	SetHAlign (eHALIGN p_align)
	Définit l'alignement horizontal. Plus de détails...

void	SetVAlign (eVALIGN p_align)
	Définit l'alignement vertical. Plus de détails...

void	SetTexturingMode (eTEXT_TEXTURING_MODE p_mode)
	Définit le mode de mappage de texture du texte. Plus de détails...

Fonctions membres publiques hérités de Castor3D::OverlayCategory
	DECLARE_VECTOR (Vertex, Vertex)

C3D_API	OverlayCategory (eOVERLAY_TYPE p_type)
	Constructeur. Plus de détails...

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

C3D_API void	Update ()
	Met à jour la position, taille... Plus de détails...

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

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

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

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

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

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

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

C3D_API bool	IsSizeChanged () const

C3D_API bool	IsPositionChanged () const

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

void	SetSize (Castor::Point2d const &p_size)
	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	GetIndex () const
	Récupère l'indice. Plus de détails...

int	GetLevel () const
	Récupère le niveau. 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	SetOrder (int p_index, int p_level)
	Définit l'ordre de l'incrustation. 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 C3D_API OverlayCategorySPtr	Create ()
	Fonction de création utilisée par la fabrique. Plus de détails...

Attributs protégés
VertexArray	m_arrayVtx
	Les données du tampon de sommets. Plus de détails...

Castor::String	m_currentCaption
	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...

FontTextureWPtr	m_fontTexture
	La texture associée à la police de l'incrustation. Plus de détails...

eTEXT_WRAPPING_MODE	m_wrappingMode { eTEXT_WRAPPING_MODE_NONE }
	Le mode de découpe du texte. Plus de détails...

eHALIGN	m_hAlign { eHALIGN_LEFT }
	L'alignement horizontal du texte. Plus de détails...

eVALIGN	m_vAlign { eVALIGN_CENTER }
	L'alignement vertical du texte. Plus de détails...

bool	m_textChanged { true }
	Dit si le texte (contenu, mode de découpe, alignements) a changé. Plus de détails...

uint32_t	m_tabSize { 4 }
	La taille (en espaces) du caractère de tabulation. Plus de détails...

uint32_t	m_connection { 0 }
	La connexion au signal de notification de changement de la texture. Plus de détails...

eTEXT_TEXTURING_MODE	m_texturingMode { eTEXT_TEXTURING_MODE_TEXT }
	Le mode de mappage de texture du texte. Plus de détails...

TextureCoordsArray	m_arrayTextTexture
	Les données du tampon de coordonnées de texture 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_position
	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_pxPosition
	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_visible
	La visibilité Plus de détails...

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

int	m_index
	L'index de l'overlay. Plus de détails...

int	m_level
	Le niveau de l'overlay. Plus de détails...

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

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

bool	m_sizeChanged
	Dit si les dimensions de cette incrustation ont changé. Plus de détails...

bool	m_positionChanged
	Dit si la position de cette incrustation a changé. Plus de détails...

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

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::OverlayCategory
Castor::Point2d	DoGetTotalSize () const

virtual void	DoUpdatePosition ()
	Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue. Plus de détails...

virtual void	DoUpdateSize ()
	Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue. 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

C3D_API Castor3D::TextOverlay::TextOverlay ( )

Constructeur.

virtual C3D_API Castor3D::TextOverlay::~TextOverlay ( )

virtual

Destructeur.

Documentation des fonctions membres

static C3D_API OverlayCategorySPtr Castor3D::TextOverlay::Create ( )

static

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

Renvoie: Un overlay

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

Castor3D::TextOverlay::DECLARE_VECTOR	(	Vertex	,
		Vertex
	)

Référencé par SetTexturingMode().

Voici le graphe des appelants de cette fonction :

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

inline

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

Renvoie: La valeur

Références m_currentCaption.

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

inline

Récupère le nom de la police.

Renvoie: La valeur.

Références GetFontTexture().

Voici le graphe d'appel pour cette fonction :

FontTextureSPtr Castor3D::TextOverlay::GetFontTexture ( ) const

inline

Renvoie: La FontTexture.

Références m_fontTexture.

Référencé par GetFontName().

Voici le graphe des appelants de cette fonction :

eHALIGN Castor3D::TextOverlay::GetHAlign ( ) const

inline

Récupère l'alignement horizontal.

Renvoie: La valeur

Références m_hAlign.

VertexArray const& Castor3D::TextOverlay::GetTextVertex ( ) const

inline

Récupère le tampon de sommets du panneau.

Renvoie: Le tampon

Références m_arrayVtx.

eVALIGN Castor3D::TextOverlay::GetVAlign ( ) const

inline

Récupère l'alignement vertical.

Renvoie: La valeur

Références m_vAlign.

virtual C3D_API bool Castor3D::TextOverlay::IsChanged ( ) const

inlinevirtual

Renvoie: true si cette incrustation a changé.

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

Références m_textChanged.

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

inline

Définit le texte de l'incrustation.

Paramètres

[in] p_caption La nouvelle valeur

Références m_currentCaption, et m_textChanged.

Référencé par SetCaption().

Voici le graphe des appelants de cette fonction :

void Castor3D::TextOverlay::SetCaption ( Castor::OutputStream const & p_caption )

inline

Définit le texte de l'incrustation.

Paramètres

[in] p_caption La nouvelle valeur

Références SetCaption().

Voici le graphe d'appel pour cette fonction :

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

Définit la police du texte.

Paramètres

[in] p_strFont La nouvelle valeur

void Castor3D::TextOverlay::SetHAlign ( eHALIGN p_align )

inline

Définit l'alignement horizontal.

Paramètres

[in] p_align La nouvelle valeur

Références m_hAlign, et m_textChanged.

void Castor3D::TextOverlay::SetTexturingMode ( eTEXT_TEXTURING_MODE p_mode )

inline

Définit le mode de mappage de texture du texte.

Paramètres

[in] p_mode La nouvelle valeur.

Références DECLARE_VECTOR(), Castor3D::OverlayCategory::m_position, Castor3D::OverlayCategory::m_size, m_textChanged, et m_texturingMode.

Voici le graphe d'appel pour cette fonction :

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

Références m_textChanged, et m_wrappingMode.

void Castor3D::TextOverlay::SetVAlign ( eVALIGN p_align )

inline

Définit l'alignement vertical.

Paramètres

[in] p_align La nouvelle valeur

Références m_textChanged, et m_vAlign.

Documentation des données membres

TextureCoordsArray Castor3D::TextOverlay::m_arrayTextTexture

protected

Les données du tampon de coordonnées de texture du texte.

VertexArray Castor3D::TextOverlay::m_arrayVtx

protected

Les données du tampon de sommets.

Référencé par GetTextVertex().

uint32_t Castor3D::TextOverlay::m_connection { 0 }

protected

La connexion au signal de notification de changement de la texture.

Castor::String Castor3D::TextOverlay::m_currentCaption

protected

Le texte courant de l'incrustation.

Référencé par GetCaption(), et SetCaption().

FontTextureWPtr Castor3D::TextOverlay::m_fontTexture

protected

La texture associée à la police de l'incrustation.

Référencé par GetFontTexture().

eHALIGN Castor3D::TextOverlay::m_hAlign { eHALIGN_LEFT }

protected

L'alignement horizontal du texte.

Référencé par GetHAlign(), et SetHAlign().

Castor::String Castor3D::TextOverlay::m_previousCaption

protected

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

uint32_t Castor3D::TextOverlay::m_tabSize { 4 }

protected

La taille (en espaces) du caractère de tabulation.

bool Castor3D::TextOverlay::m_textChanged { true }

protected

Dit si le texte (contenu, mode de découpe, alignements) a changé.

Référencé par IsChanged(), SetCaption(), SetHAlign(), SetTexturingMode(), SetTextWrappingMode(), et SetVAlign().

eTEXT_TEXTURING_MODE Castor3D::TextOverlay::m_texturingMode { eTEXT_TEXTURING_MODE_TEXT }

protected

Le mode de mappage de texture du texte.

Référencé par SetTexturingMode().

eVALIGN Castor3D::TextOverlay::m_vAlign { eVALIGN_CENTER }

protected

L'alignement vertical du texte.

Référencé par GetVAlign(), et SetVAlign().

eTEXT_WRAPPING_MODE Castor3D::TextOverlay::m_wrappingMode { eTEXT_WRAPPING_MODE_NONE }

protected

Le mode de découpe du texte.

Référencé par SetTextWrappingMode().

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

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

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Attributs protégés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres