Public Member Functions | Static Public Member Functions

# USpeedGameEngine::Surface2D Class Reference

Classe d'objets 3D (modèles 3D). More...

Inheritance diagram for USpeedGameEngine::Surface2D:

List of all members.

## Public Member Functions

| ~Surface2D ()
| Destructeur par défaut.
| Surface2D ()
| Constructeur par défaut.
void | setTranslation (USGE_Float3 const &trans, bool add, bool computeSurface)
| Permet de définir la translation à effectuer sur modèle avant le rendu.
void | setTranslation (USGE_Float3 const &trans, bool add)
| Permet de définir la translation à effectuer sur modèle avant le rendu.
void | setTranslation (USGE_Float3 const &trans)
| Permet de définir la translation à effectuer sur modèle avant le rendu.
void | clear ()
| Remise à zéro de l'instance de la classe.
void | setCenter (float x, float y, bool computeSurface)
| Modification du centre/pivot de la surface.
void | setCenter (float x, float y)
| Modification du centre/pivot de la surface avec calcul automatique.
void | setSize (float x, float y, bool computeSurface)
| Modification de la taille de la surface.
void | setSize (float x, float y)
| Modification de la taille de la surface avec calcul automatique.
void | setPosition (float x, float y, bool computeSurface)
| Modification de la position de la surface.
void | setPosition (float x, float y)
| Modification de la position de la surface avec calcul automatique.
void | setTexturePart (float xStart, float yStart, float xEnd, float yEnd)
| Modifications des coordonnées de texture.
void | applyParameters ()
| Calcul et détermination de la surface à partir des paramètres fournis.
bool | loadSurface ()
| Chargement d'une surface ayant la taille de la zone de rendu (hors mouvement de caméra).

## Static Public Member Functions

static float | screenRatio ()
| Retourne valeur du rapport "largeur/hauteur" de la zone de rendu.

## Detailed Description

Classe d'objets 3D (modèles 3D).

Author:
  U.Speed

## Constructor & Destructor Documentation

Surface2D::~Surface2D | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

Surface2D::Surface2D | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

void Surface2D::applyParameters | ( |  | ) |

Calcul et détermination de la surface à partir des paramètres fournis.

Author:
  U.Speed

void Surface2D::clear | ( |  | ) |

Remise à zéro de l'instance de la classe.

Author:
  U.Speed

Reimplemented from USpeedGameEngine::Object3D.

bool Surface2D::loadSurface | ( |  | ) |

Chargement d'une surface ayant la taille de la zone de rendu (hors mouvement de caméra).

See also:
  bool Surface2D::loadPlan(float x, float y)

Author:
  U.Speed

Returns:
  bool : état du chargement

float Surface2D::screenRatio | ( |  | ) | `[static]`

Retourne valeur du rapport "largeur/hauteur" de la zone de rendu.

Author:
  U.Speed

Returns:
  float : le rapport "largeur/hauteur". Par exemple : 16/9 ou 4/3.

void Surface2D::setCenter | ( | float | x,
|  | float | y,
|  | bool | computeSurface |
| ) |  |  |

Modification du centre/pivot de la surface.

Par défaut, les valeurs sont (0.0f, 0.0f) pour que la position de l'image soit calculée à partir du coin haut-gauche.
Illustration :

Exemple : pour positionner le pivot au centre de la surface, il faut attribuer ("0.5f", "0.5f").

Author:
  U.Speed

See also:
  void Surface2D::applyParameters()

Parameters:

  | x | : décallage X (en pourcentage de la largeur) par rapport au bord gauche du centre de rotation (et de positionnement) de la surface
  | y | : décallage Y (en pourcentage de la hauteur) par rapport au bord haut du centre de rotation (et de positionnement) de la surface
  | computeSurface | bool : `true` pour que la surface soit recalculée par rapport à la profondeur

void Surface2D::setCenter | ( | float | x,
|  | float | y |
| ) |  |  |

Modification du centre/pivot de la surface avec calcul automatique.

See also:
  void Surface2D::setCenter(float x, float y, bool computeSurface)

Author:
  U.Speed

Parameters:

  | x | : décallage X par rapport au bord gauche du centre de rotation (et de positionnement) de la surface
  | y | : décallage Y par rapport au bord haut du centre de rotation (et de positionnement) de la surface

void Surface2D::setPosition | ( | float | x,
|  | float | y,
|  | bool | computeSurface |
| ) |  |  |

Modification de la position de la surface.

Par défaut, les valeurs sont (0.0f, 0.0f) pour que l'image soit placée en haut à gauche de l'écran.
Les valeurs (x, y) sont un multiple de la hauteur de l'écran. Par exemple, si x vaut 1.0f, la surface sera déplacée de (1.0f * hauteurEcran) vers la droite.
Par défaut, les valeurs sont (0.0f, 0.0f) pour que l'image soit placée en haut à gauche de l'écran.
Les valeurs (x, y) sont un multiple de la hauteur de l'écran. Par exemple, si x vaut 1.0f, la surface sera déplacée de (1.0f * hauteurEcran) vers la droite.
L'axe des Y est inversée : si vous voulez afficher l'image vers le bas de l'écran, il faut fournir une hauteur positive.
Illustration :

Author:
  U.Speed

See also:
  void Surface2D::applyParameters()

Parameters:

  | x | : position X de la surface (par rapport à l'écran).
  | y | : position Y de la surface (par rapport à l'écran).
  | computeSurface | bool : `true` pour que la surface soit recalculée par rapport à la profondeur

void Surface2D::setPosition | ( | float | x,
|  | float | y |
| ) |  |  |

Modification de la position de la surface avec calcul automatique.

See also:
  void Surface2D::setPosition(float x, float y, bool computeSurface)

Author:
  U.Speed

Parameters:

  | x | : position X de la surface (par rapport à l'écran).
  | y | : position Y de la surface (par rapport à l'écran).

void Surface2D::setSize | ( | float | width,
|  | float | height,
|  | bool | computeSurface |
| ) |  |  |

Modification de la taille de la surface.

Par défaut, les valeurs sont celles pour que la surface occupe toute la taille de l'écran.
La hauteur et la largeur de la surface fournis sont multipliés par la hauteur de l'écran.
Ainsi pour obtenir une surface de la taille de l'écran, il faut fournir les paramètres suivants :

       width  = 1.0f * Surface2D::screenRatio();
       height = 1.0f;

Illustration :

Author:
  U.Speed

See also:
  void Surface2D::applyParameters()

Parameters:

  | width | : largeur de la surface (par rapport à la hauteur de l'écran). Valeur >= 0.0f.
  | height | : hauteur de la surface (par rapport à la hauteur de l'écran). Valeur >= 0.0f.
  | computeSurface | bool : `true` pour que la surface soit recalculée par rapport à la profondeur

void Surface2D::setSize | ( | float | width,
|  | float | height |
| ) |  |  |

Modification de la taille de la surface avec calcul automatique.

See also:
  void Surface2D::setSize(float width, float height, bool computeSurface)

Author:
  U.Speed

Parameters:

  | width | : largeur de la surface (par rapport à la hauteur de l'écran). Valeur >= 0.0f.
  | height | : hauteur de la surface (par rapport à la hauteur de l'écran). Valeur >= 0.0f.

void Surface2D::setTexturePart | ( | float | xStart,
|  | float | yStart,
|  | float | xEnd,
|  | float | yEnd |
| ) |  |  |

Modifications des coordonnées de texture.

Voici comment sont interprêtées les valeurs :

A noter que toutes les valeurs sont comprises entre 0.0f et 1.0f. Par défaut, "xStart" et "yStart" valent 0.0f et "xEnd" et "yEnd" valent 1.0f.

Author:
  U.Speed

Parameters:

  | xStart | float : l'abscisse de début de l'image
  | yStart | float : l'abscisse de fin de l'image
  | xEnd | float : l'ordonnée de début de l'image
  | yEnd | float : l'ordonnée de fin de l'image

void Surface2D::setTranslation | ( | USGE_Float3 const & | trans | ) |

Permet de définir la translation à effectuer sur modèle avant le rendu.

Affectation uniquement.

Author:
  U.Speed

See also:
  void Surface2D::setTranslation(USGE_Float3 const &trans, bool add)

Parameters:

  | trans | USGE_Float3 const& : translations selon X, Y et Z

Reimplemented from USpeedGameEngine::Object3D.

void Surface2D::setTranslation | ( | USGE_Float3 const & | trans,
|  | bool | add |
| ) |  |  |

Permet de définir la translation à effectuer sur modèle avant le rendu.

Ajout ou affectation possibles.

Author:
  U.Speed

See also:
  void Surface2D::setTranslation(USGE_Float3 const &trans, bool add, bool computeSurface)

Parameters:

  | trans | USGE_Float3 const& : translations selon X, Y et Z
  | add | bool : `true` pour ajouter au lieu d'affecter

Reimplemented from USpeedGameEngine::Object3D.

void Surface2D::setTranslation | ( | USGE_Float3 const & | trans,
|  | bool | add,
|  | bool | computeSurface |
| ) |  |  |

Permet de définir la translation à effectuer sur modèle avant le rendu.

Ajout ou affectation possibles. Possibilité de décaller la surface sans devoir recalculer sa taille.

Author:
  U.Speed

See also:
  void Object3D::setTranslation(USGE_Float3 const &trans, bool add)
  void Surface2D::applyParameters()

Parameters:

  | trans | USGE_Float3 const& : translations selon X, Y et Z
  | add | bool : `true` pour ajouter au lieu d'affecter
  | computeSurface | bool : `true` pour que la taille de la surface soit recalculée par rapport à la profondeur

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

- src/Object3D/Surface2D.hpp
- src/Object3D/Surface2D.cpp
- src/Object3D/Surface2D_applyParameters.cpp
- src/Object3D/Surface2D_clear.cpp
- src/Object3D/Surface2D_loadSurface.cpp
- src/Object3D/Surface2D_screenRatio.cpp
- src/Object3D/Surface2D_setCenter.cpp
- src/Object3D/Surface2D_setPosition.cpp
- src/Object3D/Surface2D_setSize.cpp
- src/Object3D/Surface2D_setTexturePart.cpp
- src/Object3D/Surface2D_setTranslation.cpp