#include <TextOverlay.hpp>

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

Graphe de collaboration de castor3d::TextOverlay:

[légende]

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

Fonctions membres publiques
	CU_DeclareVector (Vertex, Vertex)

	CU_DeclareMap (char32_t, castor::Position, GlyphPosition)

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

C3D_API void	accept (OverlayVisitor &visitor) const override
	Dessine l'incrustation. Plus de détails...

C3D_API void	setFont (castor::String const &value)
	Définit la police du texte. Plus de détails...

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

bool	isChanged () const override

FontTextureSPtr	getFontTexture () const

bool	isFontChanged () 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 &value)
	Définit le texte de l'incrustation. Plus de détails...

TextWrappingMode	getTextWrappingMode () const

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

HAlign	getHAlign () const

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

VAlign	getVAlign () const

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

TextTexturingMode	getTexturingMode () const

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

TextLineSpacingMode	getLineSpacingMode () const

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

Fonctions membres publiques hérités de castor3d::OverlayCategory
	CU_DeclareVector (Vertex, Vertex)

C3D_API	OverlayCategory (OverlayType type)
	Constructeur. Plus de détails...

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

C3D_API void	update (OverlayRenderer const &renderer)
	Met à jour la position, taille... Plus de détails...

virtual C3D_API void	accept (OverlayVisitor &renderer) const =0
	Dessine l'incrustation. Plus de détails...

virtual C3D_API void	setMaterial (MaterialRPtr 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 &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 &size) const
	Récupère la taille absolue de l'incrustation, en pixels. Plus de détails...

C3D_API castor::Point2f	getRenderRatio (castor::Size const &size) const

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

virtual C3D_API bool	isChanged () const

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

void	setSize (castor::Point2d const &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...

MaterialRPtr	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 *value)
	Définit l'incrustation. Plus de détails...

void	setVisible (bool value)
	Définit le statut de visibilité Plus de détails...

void	setPixelPosition (castor::Position const &value)
	Définit la position de l'incrustation. Plus de détails...

void	setPixelSize (castor::Size const &value)
	Définit la taille de l'incrustation. Plus de détails...

void	setOrder (int index, int level)
	Définit l'ordre de l'incrustation. Plus de détails...

void	setUV (castor::Point4d const &value)
	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...

Membres hérités additionnels
Fonctions membres protégées hérités de castor3d::OverlayCategory
castor::Point2d	doGetTotalSize (OverlayRenderer const &renderer) const

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

virtual void	doUpdateSize (OverlayRenderer const &renderer)
	Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue. Plus de détails...

virtual void	doUpdate (OverlayRenderer const &renderer)
	Met à jour la position, taille... Plus de détails...

virtual void	doUpdateBuffer (castor::Size const &size)=0
	Met à jour le tampon de sommets. Plus de détails...

Attributs protégés hérités de castor3d::OverlayCategory
Overlay *	m_pOverlay { nullptr }

castor::Point2d	m_position

castor::Point2d	m_ptSize

castor::Position	m_pxPosition

castor::Size	m_size

castor::Size	m_computeSize

bool	m_visible { true }

MaterialRPtr	m_pMaterial

int	m_index { 0 }

int	m_level { 0 }

castor::String	m_strMatName

OverlayType	m_type

bool	m_sizeChanged { true }

bool	m_positionChanged { true }

castor::Point4d	m_uv { 0.0, 0.0, 1.0, 1.0 }

Documentation des constructeurs et destructeur

◆ TextOverlay()

C3D_API castor3d::TextOverlay::TextOverlay ( )

Constructeur.

Documentation des fonctions membres

◆ accept()

C3D_API void castor3d::TextOverlay::accept ( OverlayVisitor & visitor ) const

overridevirtual

Dessine l'incrustation.

Implémente castor3d::OverlayCategory.

◆ create()

static C3D_API OverlayCategorySPtr castor3d::TextOverlay::create ( )

static

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

Renvoie: Un overlay

◆ CU_DeclareMap()

castor3d::TextOverlay::CU_DeclareMap	(	char32_t	,
		castor::Position	,
		GlyphPosition
	)

◆ CU_DeclareVector()

castor3d::TextOverlay::CU_DeclareVector	(	Vertex	,
		Vertex
	)

◆ getCaption()

castor::String castor3d::TextOverlay::getCaption ( ) const

inline

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

Renvoie: La valeur

◆ getFontName()

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érencé par getFontName().

Voici le graphe des appelants de cette fonction :

◆ getHAlign()

HAlign castor3d::TextOverlay::getHAlign ( ) const

inline

Renvoie: L'alignement horizontal.

◆ getLineSpacingMode()

TextLineSpacingMode castor3d::TextOverlay::getLineSpacingMode ( ) const

inline

Renvoie: Le mode d'espacement des lignes.

◆ getTexturingMode()

TextTexturingMode castor3d::TextOverlay::getTexturingMode ( ) const

inline

Renvoie: Le mode de mappage de texture du texte.

◆ getTextVertex()

VertexArray const & castor3d::TextOverlay::getTextVertex ( ) const

inline

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

Renvoie: Le tampon

◆ getTextWrappingMode()

TextWrappingMode castor3d::TextOverlay::getTextWrappingMode ( ) const

inline

Renvoie: Le mode de découpe du texte.

◆ getVAlign()

VAlign castor3d::TextOverlay::getVAlign ( ) const

inline

Renvoie: L'alignement vertical.

◆ isChanged()

bool castor3d::TextOverlay::isChanged ( ) const

inlineoverridevirtual

Renvoie: true si cette incrustation a changé.

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

◆ isFontChanged()

bool castor3d::TextOverlay::isFontChanged ( ) const

inline

Renvoie: true si la police de cette incrustation a changé.

◆ setCaption()

void castor3d::TextOverlay::setCaption ( castor::String const & value )

inline

Définit le texte de l'incrustation.

Paramètres

[in] value La nouvelle valeur

◆ setFont()

C3D_API void castor3d::TextOverlay::setFont ( castor::String const & value )

Définit la police du texte.

Paramètres

[in] value La nouvelle valeur

◆ setHAlign()

void castor3d::TextOverlay::setHAlign ( HAlign value )

inline

Définit l'alignement horizontal.

Paramètres

[in] value La nouvelle valeur

◆ setLineSpacingMode()

void castor3d::TextOverlay::setLineSpacingMode ( TextLineSpacingMode value )

inline

Définit le mode d'espacement des lignes.

Paramètres

[in] value La nouvelle valeur.

◆ setTexturingMode()

void castor3d::TextOverlay::setTexturingMode ( TextTexturingMode value )

inline

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

Paramètres

[in] value La nouvelle valeur.

◆ setTextWrappingMode()

void castor3d::TextOverlay::setTextWrappingMode ( TextWrappingMode value )

inline

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

Paramètres

[in] value La nouvelle valeur

◆ setVAlign()

void castor3d::TextOverlay::setVAlign ( VAlign value )

inline

Définit l'alignement vertical.

Paramètres

[in] value La nouvelle valeur

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

Overlay/TextOverlay.hpp

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Membres hérités additionnels

Documentation des constructeurs et destructeur

◆ TextOverlay()

Documentation des fonctions membres

◆ accept()

◆ create()

◆ CU_DeclareMap()

◆ CU_DeclareVector()

◆ getCaption()

◆ getFontName()

◆ getFontTexture()

◆ getHAlign()

◆ getLineSpacingMode()

◆ getTexturingMode()

◆ getTextVertex()

◆ getTextWrappingMode()

◆ getVAlign()

◆ isChanged()

◆ isFontChanged()

◆ setCaption()

◆ setFont()

◆ setHAlign()

◆ setLineSpacingMode()

◆ setTexturingMode()

◆ setTextWrappingMode()

◆ setVAlign()