Référence de la classe castor::Font

#include <Font.hpp>

Graphe d'héritage de castor::Font:

Graphe de collaboration de castor::Font:

Classes
class	BinaryLoader
	Loader de Font. Plus de détails...
struct	SFontImpl
	Structure utilisée pour charger des glyphes à la demande. Plus de détails...

Fonctions membres publiques
	CU_DeclareVector (Glyph, Glyph)
CU_API	Font (String const &name, uint32_t height)
	Constructeur.
CU_API	Font (String const &name, uint32_t height, Path const &path)
	Constructeur.
virtual CU_API	~Font () noexcept=default
	Destructeur.
CU_API void	loadGlyph (char32_t c)
	Charge le glyphe voulu.
CU_API TextMetrics	getTextMetrics (std::u32string const &v, uint32_t maxWidth, bool splitLines) const
	Récupère les métriques du texte donné.
bool	hasGlyphAt (char32_t c) const
	Dit si la police a déjà chargé la glyphe voulue.
Glyph const &	getGlyphAt (char32_t c) const
	Récupère la glyphe du caractère voulu.
Glyph &	getGlyphAt (char32_t c)
	Récupère la glyphe du caractère voulu.
Glyph const &	operator[] (char32_t c) const
	Récupère la glyphe du caractère voulu.
Glyph &	operator[] (char32_t c)
	Récupère la glyphe du caractère voulu.
uint32_t	getHeight () const noexcept
	Récupère la hauteur de la police.
uint32_t	getMaxHeight () const noexcept
	Récupère la hauteur maximale des glyphes.
Point2i	getMaxRange () const noexcept
	Récupère la hauteur maximale des glyphes.
uint32_t	getMaxWidth () const noexcept
	Récupère la largeur maximale des glyphes.
void	setGlyphLoader (castor::RawUniquePtr< SFontImpl > loader) noexcept
	Définit le chargeur de glyphes.
bool	hasGlyphLoader () const noexcept
	Dit si la police a un loader de glyphes.
SFontImpl &	getGlyphLoader () const noexcept
	Définit le loader de glyphes.
auto	begin () noexcept
	Récupère un itérateur sur la première glyphe.
auto	begin () const noexcept
	Récupère un itérateur sur la première glyphe.
auto	end () noexcept
	Récupère un itérateur sur la fin du tableau de glyphes.
auto	end () const noexcept
	Récupère un itérateur sur la fin du tableau de glyphes.
void	setFaceName (String name) noexcept
	Définit le nom de la police.
String const &	getFaceName () const noexcept
	Récupère le nom de la police.
Path const &	getFilePath () const noexcept
	Récupère le chemin du fichier de la police.
void	initialise () const noexcept
void	cleanup () const noexcept
bool	isSerialisable () const noexcept
void	setSerialisable (bool v) noexcept
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Membres hérités additionnels
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des constructeurs et destructeur

Font() [1/2]

CU_API castor::Font::Font	(	String const &	name,
		uint32_t	height )

Constructeur.

Paramètres

[in]	name	Le nom de la police
[in]	height	La hauteur des caractères de la police

Font() [2/2]

CU_API castor::Font::Font	(	String const &	name,
		uint32_t	height,
		Path const &	path )

Constructeur.

Paramètres

[in]	path	Le chemin d'accès au fichier contenant la police
[in]	name	Le nom de la police
[in]	height	La hauteur des caractères de la police

~Font()

virtual CU_API castor::Font::~Font ( )

virtualdefaultnoexcept

Destructeur.

Remarques

Virtual pour permettre l'utilisation en tant que ResourceT.

Documentation des fonctions membres

begin() [1/2]

auto castor::Font::begin ( ) const

inlinenoexcept

Récupère un itérateur sur la première glyphe.

Renvoie

L'itérateur

begin() [2/2]

auto castor::Font::begin ( )

inlinenoexcept

Récupère un itérateur sur la première glyphe.

Renvoie

L'itérateur

cleanup()

void castor::Font::cleanup ( ) const

inlinenoexcept

CU_DeclareVector()

castor::Font::CU_DeclareVector	(	Glyph	,
		Glyph	)

end() [1/2]

auto castor::Font::end ( ) const

inlinenoexcept

Récupère un itérateur sur la fin du tableau de glyphes.

Renvoie

L'itérateur

end() [2/2]

auto castor::Font::end ( )

inlinenoexcept

Récupère un itérateur sur la fin du tableau de glyphes.

Renvoie

L'itérateur

getFaceName()

String const & castor::Font::getFaceName ( ) const

inlinenoexcept

Récupère le nom de la police.

Renvoie

La valeur

getFilePath()

Path const & castor::Font::getFilePath ( ) const

inlinenoexcept

Récupère le chemin du fichier de la police.

Renvoie

La valeur.

getGlyphAt() [1/2]

Glyph & castor::Font::getGlyphAt ( char32_t c )

inline

Récupère la glyphe du caractère voulu.

Paramètres

[in]

c

Le caractère voulu

Renvoie

Une référence sur la glyphe

getGlyphAt() [2/2]

Glyph const & castor::Font::getGlyphAt ( char32_t c ) const

inline

Récupère la glyphe du caractère voulu.

Paramètres

[in]

c

Le caractère voulu

Renvoie

Une référence constante sur la glyphe

getGlyphLoader()

SFontImpl & castor::Font::getGlyphLoader ( ) const

inlinenoexcept

Définit le loader de glyphes.

Renvoie

Le loader

getHeight()

uint32_t castor::Font::getHeight ( ) const

inlinenoexcept

Récupère la hauteur de la police.

Renvoie

La hauteur de la police

getMaxHeight()

uint32_t castor::Font::getMaxHeight ( ) const

inlinenoexcept

Récupère la hauteur maximale des glyphes.

Renvoie

La hauteur maximale des glyphes

getMaxRange()

Point2i castor::Font::getMaxRange ( ) const

inlinenoexcept

Récupère la hauteur maximale des glyphes.

Renvoie

La hauteur maximale des glyphes

getMaxWidth()

uint32_t castor::Font::getMaxWidth ( ) const

inlinenoexcept

Récupère la largeur maximale des glyphes.

Renvoie

La largeur maximale des glyphes

getTextMetrics()

CU_API TextMetrics castor::Font::getTextMetrics	(	std::u32string const &	v,
		uint32_t	maxWidth,
		bool	splitLines ) const

Récupère les métriques du texte donné.

Paramètres

[in]	v	Le texte.
[in]	maxWidth	La largeur maximale, si splitLines vaut true.
[in]	splitLines	true pour découper les lignes en fonction de maxWidth.

hasGlyphAt()

bool castor::Font::hasGlyphAt ( char32_t c ) const

inline

Dit si la police a déjà chargé la glyphe voulue.

Paramètres

[in]

c

Le caractère.

Renvoie

false si elle n'est pas chargée.

Référencé par operator[](), et operator[]().

Voici le graphe des appelants de cette fonction :

hasGlyphLoader()

bool castor::Font::hasGlyphLoader ( ) const

inlinenoexcept

Dit si la police a un loader de glyphes.

Renvoie

Le statut

initialise()

void castor::Font::initialise ( ) const

inlinenoexcept

isSerialisable()

bool castor::Font::isSerialisable ( ) const

inlinenoexcept

loadGlyph()

CU_API void castor::Font::loadGlyph

(

char32_t

c

)

Charge le glyphe voulu.

Paramètres

[in]

c

Le caractère.

operator[]() [1/2]

Glyph & castor::Font::operator[] ( char32_t c )

inline

Récupère la glyphe du caractère voulu.

Paramètres

[in]

c

Le caractère voulu

Renvoie

Une référence sur la glyphe

Références CU_Ensure, et hasGlyphAt().

Voici le graphe d'appel pour cette fonction :

operator[]() [2/2]

Glyph const & castor::Font::operator[] ( char32_t c ) const

inline

Récupère la glyphe du caractère voulu.

Paramètres

[in]

c

Le caractère voulu

Renvoie

Une référence sur la glyphe

Références CU_Ensure, et hasGlyphAt().

Voici le graphe d'appel pour cette fonction :

setFaceName()

void castor::Font::setFaceName ( String name )

inlinenoexcept

Définit le nom de la police.

Paramètres

[in]

name

La valeur

setGlyphLoader()

void castor::Font::setGlyphLoader ( castor::RawUniquePtr< SFontImpl > loader )

inlinenoexcept

Définit le chargeur de glyphes.

Paramètres

[in]

loader

La valeur

setSerialisable()

void castor::Font::setSerialisable ( bool v )

inlinenoexcept

---

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

• CastorUtils/Graphics/Font.hpp