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

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

Graphe de collaboration de Castor3D::TextOverlay:

Classes
class	TextWriter
	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 std::unique_ptr< OverlayCategory::TextWriter >	CreateTextWriter (Castor::String const &p_tabs) override
	Crée un OverlayCategory spécifique à la LightCategory. Plus de détails...

C3D_API void	SetFont (Castor::String const &p_value)
	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_value)
	Définit le texte de l'incrustation. Plus de détails...

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

TextWrappingMode	GetTextWrappingMode () const

void	SetTextWrappingMode (TextWrappingMode p_value)
	Définit le mode de découpe du texte. Plus de détails...

HAlign	GetHAlign () const

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

VAlign	GetVAlign () const

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

TextTexturingMode	GetTexturingMode () const

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

TextLineSpacingMode	GetLineSpacingMode () const

void	SetLineSpacingMode (TextLineSpacingMode p_value)
	Définit le mode d'espacement des lignes. Plus de détails...

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

C3D_API	OverlayCategory (OverlayType 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_material)
	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...

OverlayType	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

Castor::String	m_currentCaption

Castor::String	m_previousCaption

FontTextureWPtr	m_fontTexture

TextWrappingMode	m_wrappingMode { TextWrappingMode::eNone }

TextLineSpacingMode	m_lineSpacingMode { TextLineSpacingMode::eOwnHeight }

HAlign	m_hAlign { HAlign::eLeft }

VAlign	m_vAlign { VAlign::eCenter }

bool	m_textChanged { true }

uint32_t	m_tabSize { 4 }

FontTexture::OnChanged::connection	m_connection

TextTexturingMode	m_texturingMode { TextTexturingMode::eText }

TextureCoordsArray	m_arrayTextTexture

Attributs protégés hérités de Castor3D::OverlayCategory
Overlay *	m_pOverlay { nullptr }
	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 { true }
	La visibilité Plus de détails...

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

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

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

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

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

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

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

Castor::Point4d	m_uv { 0.0, 0.0, 1.0, 1.0 }
	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

◆ TextOverlay()

C3D_API Castor3D::TextOverlay::TextOverlay ( )

Constructeur.

◆ ~TextOverlay()

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

virtual

Destructeur.

Documentation des fonctions membres

◆ Create()

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

static

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

Renvoie: Un overlay

◆ CreateTextWriter()

C3D_API std::unique_ptr< OverlayCategory::TextWriter > Castor3D::TextOverlay::CreateTextWriter ( Castor::String const & p_tabs )

inlineoverridevirtual

Crée un OverlayCategory spécifique à la LightCategory.

Paramètres

[in] p_tabs Le niveau d'intentation actuel.

Renvoie: Le TextLoader.

Implémente Castor3D::OverlayCategory.

Références C3D_API, et SetFont().

Voici le graphe d'appel pour cette fonction :

◆ DECLARE_MAP()

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

◆ DECLARE_VECTOR()

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

Référencé par SetLineSpacingMode().

Voici le graphe des appelants de cette fonction :

◆ GetCaption()

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

inline

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

Renvoie: La valeur

Références m_currentCaption.

◆ GetFontName()

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 :

◆ GetFontTexture()

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 :

◆ GetHAlign()

HAlign Castor3D::TextOverlay::GetHAlign ( ) const

inline

Renvoie: L'alignement horizontal.

Références m_hAlign.

◆ GetLineSpacingMode()

TextLineSpacingMode Castor3D::TextOverlay::GetLineSpacingMode ( ) const

inline

Renvoie: Le mode d'espacement des lignes.

Références m_lineSpacingMode.

◆ GetTexturingMode()

TextTexturingMode Castor3D::TextOverlay::GetTexturingMode ( ) const

inline

Renvoie: Le mode de mappage de texture du texte.

Références m_texturingMode.

◆ GetTextVertex()

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

inline

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

Renvoie: Le tampon

Références m_arrayVtx.

◆ GetTextWrappingMode()

TextWrappingMode Castor3D::TextOverlay::GetTextWrappingMode ( ) const

inline

Renvoie: Le mode de découpe du texte.

Références m_wrappingMode.

◆ GetVAlign()

VAlign Castor3D::TextOverlay::GetVAlign ( ) const

inline

Renvoie: L'alignement vertical.

Références m_vAlign.

◆ IsChanged()

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.

◆ SetCaption() [1/2]

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

inline

Définit le texte de l'incrustation.

Paramètres

[in] p_value La nouvelle valeur

Références m_currentCaption, et m_textChanged.

Référencé par SetCaption().

Voici le graphe des appelants de cette fonction :

◆ SetCaption() [2/2]

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

inline

Définit le texte de l'incrustation.

Paramètres

[in] p_value La nouvelle valeur

Références SetCaption().

Voici le graphe d'appel pour cette fonction :

◆ SetFont()

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

Définit la police du texte.

Paramètres

[in] p_value La nouvelle valeur

Référencé par CreateTextWriter().

Voici le graphe des appelants de cette fonction :

◆ SetHAlign()

void Castor3D::TextOverlay::SetHAlign ( HAlign p_value )

inline

Définit l'alignement horizontal.

Paramètres

[in] p_value La nouvelle valeur

Références m_hAlign, et m_textChanged.

◆ SetLineSpacingMode()

void Castor3D::TextOverlay::SetLineSpacingMode ( TextLineSpacingMode p_value )

inline

Définit le mode d'espacement des lignes.

Paramètres

[in] p_value La nouvelle valeur.

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

Voici le graphe d'appel pour cette fonction :

◆ SetTexturingMode()

void Castor3D::TextOverlay::SetTexturingMode ( TextTexturingMode p_value )

inline

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

Paramètres

[in] p_value La nouvelle valeur.

Références m_textChanged, et m_texturingMode.

◆ SetTextWrappingMode()

void Castor3D::TextOverlay::SetTextWrappingMode ( TextWrappingMode p_value )

inline

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

Paramètres

[in] p_value La nouvelle valeur

Références m_textChanged, et m_wrappingMode.

◆ SetVAlign()

void Castor3D::TextOverlay::SetVAlign ( VAlign p_value )

inline

Définit l'alignement vertical.

Paramètres

[in] p_value La nouvelle valeur

Références m_textChanged, et m_vAlign.

Documentation des données membres

◆ m_arrayTextTexture

TextureCoordsArray Castor3D::TextOverlay::m_arrayTextTexture

protected

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

◆ m_arrayVtx

VertexArray Castor3D::TextOverlay::m_arrayVtx

protected

Les données du tampon de sommets.

Référencé par GetTextVertex().

◆ m_connection

FontTexture::OnChanged::connection Castor3D::TextOverlay::m_connection

protected

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

◆ m_currentCaption

Castor::String Castor3D::TextOverlay::m_currentCaption

protected

Le texte courant de l'incrustation.

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

◆ m_fontTexture

FontTextureWPtr Castor3D::TextOverlay::m_fontTexture

protected

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

Référencé par GetFontTexture().

◆ m_hAlign

HAlign Castor3D::TextOverlay::m_hAlign { HAlign::eLeft }

protected

L'alignement horizontal du texte.

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

◆ m_lineSpacingMode

TextLineSpacingMode Castor3D::TextOverlay::m_lineSpacingMode { TextLineSpacingMode::eOwnHeight }

protected

Le mode d'espacement des lignes.

Référencé par GetLineSpacingMode(), et SetLineSpacingMode().

◆ m_previousCaption

Castor::String Castor3D::TextOverlay::m_previousCaption

protected

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

◆ m_tabSize

uint32_t Castor3D::TextOverlay::m_tabSize { 4 }

protected

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

◆ m_textChanged

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(), SetLineSpacingMode(), SetTexturingMode(), SetTextWrappingMode(), et SetVAlign().

◆ m_texturingMode

TextTexturingMode Castor3D::TextOverlay::m_texturingMode { TextTexturingMode::eText }

protected

Le mode de mappage de texture du texte.

Référencé par GetTexturingMode(), et SetTexturingMode().

◆ m_vAlign

VAlign Castor3D::TextOverlay::m_vAlign { VAlign::eCenter }

protected

L'alignement vertical du texte.

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

◆ m_wrappingMode

TextWrappingMode Castor3D::TextOverlay::m_wrappingMode { TextWrappingMode::eNone }

protected

Le mode de découpe du texte.

Référencé par GetTextWrappingMode(), et SetTextWrappingMode().

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Overlay/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

◆ TextOverlay()

◆ ~TextOverlay()

Documentation des fonctions membres

◆ Create()

◆ CreateTextWriter()

◆ DECLARE_MAP()

◆ DECLARE_VECTOR()

◆ GetCaption()

◆ GetFontName()

◆ GetFontTexture()

◆ GetHAlign()

◆ GetLineSpacingMode()

◆ GetTexturingMode()

◆ GetTextVertex()

◆ GetTextWrappingMode()

◆ GetVAlign()

◆ IsChanged()

◆ SetCaption() [1/2]

◆ SetCaption() [2/2]

◆ SetFont()

◆ SetHAlign()

◆ SetLineSpacingMode()

◆ SetTexturingMode()

◆ SetTextWrappingMode()

◆ SetVAlign()

Documentation des données membres

◆ m_arrayTextTexture

◆ m_arrayVtx

◆ m_connection

◆ m_currentCaption

◆ m_fontTexture

◆ m_hAlign

◆ m_lineSpacingMode

◆ m_previousCaption

◆ m_tabSize

◆ m_textChanged

◆ m_texturingMode

◆ m_vAlign

◆ m_wrappingMode