Public Member Functions

# USpeedGameEngine::Font Class Reference

Classe des polices d'affichage graphique. More...

List of all members.

## Public Member Functions

| Font ()
| Constructeur par défaut.
| ~Font ()
| Destructeur par défaut.
bool | load (const char *filename)
| Efface la police actuelle et charge le fichier de police spécifié.
bool | load (std::string &datas, bool isContent)
| Efface la police actuelle et charge le fichier de police spécifié.
void | setSize (int size)
| Définit la taille de la police.
void | setColor (unsigned long int color)
| Définit la couleur du texte.
void | setRadianColor (unsigned long int firstColor, unsigned long int secondColor)
| Permet de définir la seconde couleur pour faire un dégradé.
void | setBorder (int theSize, unsigned long int theColor, bool drawBorderOnly)
| Définit la bordure de la police.
void | setUtf8Encoded (bool isUTF8)
| Définit si on affiche du texte en UNICODE ou en UTF-8.
bool | isLoaded ()
| Pour savoir si une police est chargée.
int | getSize ()
| Retourne la taille actuelle de la police.
void | clear ()
| Efface la police actuelle.
void | print (const char *text, Image *img)
| Effectue le rendu du texte spécifié avec la couleur spécifiée sur l'image spécifiée.
void | print (const char *text, Image *img, int *xCursor, int *yCursor)
| Effectue le rendu du texte spécifié avec la couleur spécifiée sur l'image spécifiée.
void | computeSize (const char *text, unsigned int *width, unsigned int *height)
| Calcul la taille (largeur et hauteur) du texte demandé si on fait un rendu.
unsigned int | utf8ToUnicode (const char *text, unsigned int *newIdx)
| Convertit le texte spécifié de l'UTF-8 à l'unicode caractère par caractère.

## Detailed Description

Classe des polices d'affichage graphique.

Author:
  U.Speed

## Constructor & Destructor Documentation

Font::Font | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

Font::~Font | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

void Font::clear | ( |  | ) |

Efface la police actuelle.

Author:
  U.Speed

void Font::computeSize | ( | const char * | text,
|  | unsigned int * | width,
|  | unsigned int * | height |
| ) |  |  |

Calcul la taille (largeur et hauteur) du texte demandé si on fait un rendu.

Author:
  U.Speed

Parameters:

  | text | const char* : le texte
  | width | unsigned int* : la largeur du texte rendu
  | height | unsigned int* : la hauteur du texte rendu

int Font::getSize | ( |  | ) |

Retourne la taille actuelle de la police.

Author:
  U.Speed

Returns:
  int : la taille actuelle de la police

bool Font::isLoaded | ( |  | ) |

Pour savoir si une police est chargée.

Author:
  U.Speed

Returns:
  bool : l'état
  - true : la police est chargée
  - false : pas de police chargée

bool Font::load | ( | const char * | filename | ) |

Efface la police actuelle et charge le fichier de police spécifié.

Author:
  U.Speed

Parameters:

  | filename | const char* : nom du fichier de police TTF à charger

Returns:
  bool : l'état du chargement
  - true : chargement réussi
  - false : échec lors du chargement

bool Font::load | ( | std::string & | datas,
|  | bool | isContent |
| ) |  |  |

Efface la police actuelle et charge le fichier de police spécifié.

Author:
  U.Speed

Parameters:

  | datas | std::string& : nom du fichier de police TTF à charger ou bien le contenu du fichier
  | isContent | bool : `true` si il s'agit du contenu

Returns:
  bool : l'état du chargement
  - true : chargement réussi
  - false : échec lors du chargement

void Font::print | ( | const char * | text,
|  | Image * | img |
| ) |  |  |

Effectue le rendu du texte spécifié avec la couleur spécifiée sur l'image spécifiée.

Author:
  U.Speed

See also:
  void Font::print(const char *text, Image *img, int *xCursor, int *yCursor)

Parameters:

  | text | const char* : texte à afficher
  | img | Image* : l'image sur laquelle il faut "rendre" le texte

void Font::print | ( | const char * | text,
|  | Image * | img,
|  | int * | xCursor,
|  | int * | yCursor |
| ) |  |  |

Effectue le rendu du texte spécifié avec la couleur spécifiée sur l'image spécifiée.

Author:
  U.Speed

Parameters:

  | text | const char* : texte à afficher
  | img | Image* : l'image sur laquelle il faut "rendre" le texte
  | xCursor | int* : coordonnée X où le curseur est arrivé lors de l'écriture
  | yCursor | int* : coordonnée Y où le curseur est arrivé lors de l'écriture

void Font::setBorder | ( | int | theSize,
|  | unsigned long int | theColor,
|  | bool | drawBorderOnly |
| ) |  |  |

Définit la bordure de la police.

Author:
  U.Speed

Parameters:

  | theSize | int : la taille voulue (inférieur ou égal à zéro pour ne pas tracer de bordure)
  | theColor | unsigned long int : la couleur de la bordure
  | drawBorderOnly | bool : `true` pour ne tracer que la bordure (n'a de sens que si la bordure a une taille strictement positive)

void Font::setColor | ( | unsigned long int | theColor | ) |

Définit la couleur du texte.

Author:
  U.Speed

Parameters:

  | theColor | unsigned long int : la couleur du texte (RVB)

void Font::setRadianColor | ( | unsigned long int | topColor,
|  | unsigned long int | bottomColor |
| ) |  |  |

Permet de définir la seconde couleur pour faire un dégradé.

Author:
  U.Speed

Parameters:

  | topColor | unsigned long int : la couleur du haut du texte (RVB)
  | bottomColor | unsigned long int : la couleur du bas du texte (RVB)

void Font::setSize | ( | int | size | ) |

Définit la taille de la police.

Author:
  U.Speed

Parameters:

  | size | int : la taille voulue

void Font::setUtf8Encoded | ( | bool | isUTF8 | ) |

Définit si on affiche du texte en UNICODE ou en UTF-8.

Author:
  U.Speed

Parameters:

  | isUTF8 | bool : l'état
  - true : lors de l'utilisation de "print", on convertira le texte de l'UTF-8 vers l'UNICODE
  - false : lors de l'utilisation de "print", le texte sera en l'UNICODE

unsigned int Font::utf8ToUnicode | ( | const char * | text,
|  | unsigned int * | newIdx |
| ) |  |  |

Convertit le texte spécifié de l'UTF-8 à l'unicode caractère par caractère.

Author:
  U.Speed

Parameters:

  | text | const char* : le texte UTF-8 à convertir
  | newIdx | unsigned int : l'index à partir duquel on commence à lire "text". Mis à jour après exécution pour connaître la position du prochain caractère à lire.

Returns:
  unsigned int : le caractère converti en unicode

The documentation for this class was generated from the following files:

- src/Font/Font.hpp
- src/Font/Font.cpp
- src/Font/Font_clear.cpp
- src/Font/Font_computeSize.cpp
- src/Font/Font_getSize.cpp
- src/Font/Font_isLoaded.cpp
- src/Font/Font_load.cpp
- src/Font/Font_print.cpp
- src/Font/Font_setBorder.cpp
- src/Font/Font_setColor.cpp
- src/Font/Font_setRadianColor.cpp
- src/Font/Font_setSize.cpp
- src/Font/Font_setUtf8Encoded.cpp
- src/Font/Font_utf8ToUnicode.cpp