Public Member Functions | Static Public Member Functions

# USpeedGameEngine::Animation Class Reference

Classe d'interpolation de valeurs sur une plage temporelle donnée Class for values interpolation on a given time range -. More...

List of all members.

## Public Member Functions

| ~Animation ()
| Destructeur par défaut Default destructor -.
| Animation ()
| Constructeur par défaut Default constructor -.
void | clear ()
| Remise à zéro de l'instance de la classe Resets object state by clearing all informations -.
void | addKeyFrame (USGE_KeyFrame const &keyFrame)
| Ajout d'une trame clé à la suite de celles déjà présente Adds the given frame to the end of existing frame list -.
void | addKeyFrame (USGE_KeyFrame const &keyFrame, unsigned int position)
| Ajout d'une trame clé à la position désignée Adds the given frame to the existing list at specified position -.
void | removeKeyFrame (unsigned int position)
| Retrait d'une trame clé à la position désignée Removes the frame from the list at specified position -.
void | removeAll ()
| Suppression de toutes les trames clé Removes all keyframes from list -.
unsigned long int | getKeyFramesCount ()
| Retourne le nombre de trames clé Returns the frame count -.
USGE_KeyFrame * | operator[] (const unsigned long int index)
| Récupération de la trame spécifiée Access to the specified frame -.
USGE_KeyFrame | getInfos ()
| Récupération des informations actuelles Return current informations about last interpolation -.
void | getInfos (USGE_KeyFrame &frame)
| Récupération des informations actuelles vers la trame fournie Copies current informations about last interpolation into given keyframe -.
void | start ()
| Démarrage de l'animation Starts the animation -.
void | restart ()
| Redémarrage de l'animation depuis les informations initiales Restarts the animation from initiales values -.
void | pause ()
| Arrêt (pause) de l'animation Stop (pause) the animation -.
void | stop ()
| Arrêt et retour au début de l'animation Stops and rewinds the animation -.
bool | isRunning ()
| Permet de savoir si l'animation est en cours Returns wether the animation is running or not -.
void | interpolate ()
| Lancement du calcul d'interpolation sur toutes les informations Run the interpolation using all loaded informations -.
void | loop (bool active)
| Mise en boucle de l'animation Activate or not the infinite loop for the animation -.
bool | isLooping ()
| Permet de connaître l'état de mise en boucle de l'animation Returns wether the animation loops or not -.

## Static Public Member Functions

static double | getInterpolation (unsigned long int duration, unsigned long int currentTime, double from, double to)
| Retourne la valeur actuelle en fonction du temps écoulé et de la durée de l'animation Returns current interpolated value into the given segment (from -> to) for the time range -.
static USGE_Float3 | minimizeRotations (USGE_Float3 const &from, USGE_Float3 const &to)
| Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.
static USGE_Float3 | minimizeRotations (USGE_Float3 const &from, USGE_Float3 const &to, bool moduloOnly)
| Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.
static void | minimizeRotations (USGE_Float3 const &from, USGE_Float3 const &to, bool moduloOnly, USGE_Float3 &target)
| Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.

## Detailed Description

Classe d'interpolation de valeurs sur une plage temporelle donnée Class for values interpolation on a given time range -.

Les données initiales sont écrasées lors de l'interpolation pour contenir les valeurs actuelles.
Le système de trames clé fonctionne selon le schéma suivant :
Initial values are overwritten by new interpolated values after computation.
Key-frame's system works as mentionned on following schema :

Author:
  U.Speed

## Constructor & Destructor Documentation

Animation::~Animation | ( |  | ) |

Destructeur par défaut Default destructor -.

Author:
  U.Speed

Animation::Animation | ( |  | ) |

Constructeur par défaut Default constructor -.

Author:
  U.Speed

## Member Function Documentation

void Animation::addKeyFrame | ( | USGE_KeyFrame const & | keyFrame | ) |

Ajout d'une trame clé à la suite de celles déjà présente Adds the given frame to the end of existing frame list -.

Author:
  U.Speed

Parameters:

  | keyFrame | USGE_KeyFrame const& : la trame clé à ajouter the frame to add

void Animation::addKeyFrame | ( | USGE_KeyFrame const & | keyFrame,
|  | unsigned int | position |
| ) |  |  |

Ajout d'une trame clé à la position désignée Adds the given frame to the existing list at specified position -.

!!!! PAS ENCORE IMPLÉMENTÉ !!!! !!!! NOT YET IMPLEMENTED !!!!

Author:
  U.Speed

Parameters:

  | keyFrame | USGE_KeyFrame const& : la trame clé à ajouter the frame to add
  | position | unsigned int : la position d'insertion where to add

void Animation::clear | ( |  | ) |

Remise à zéro de l'instance de la classe Resets object state by clearing all informations -.

Author:
  U.Speed

USGE_KeyFrame Animation::getInfos | ( |  | ) |

Récupération des informations actuelles Return current informations about last interpolation -.

Author:
  U.Speed

Returns:
  USGE_KeyFrame : la trame actuelle

void Animation::getInfos | ( | USGE_KeyFrame & | frame | ) |

Récupération des informations actuelles vers la trame fournie Copies current informations about last interpolation into given keyframe -.

Author:
  U.Speed

Parameters:

  | frame | USGE_KeyFrame& : la trame à charger target frame to copy into

double Animation::getInterpolation | ( | unsigned long int | duration,
|  | unsigned long int | currentTime,
|  | double | from,
|  | double | to |
| ) |  |  | `[static]`

Retourne la valeur actuelle en fonction du temps écoulé et de la durée de l'animation Returns current interpolated value into the given segment (from -> to) for the time range -.

Author:
  U.Speed

Parameters:

  | duration | unsigned long int : la durée de l'animation animation duration
  | currentTime | unsigned long int : le temps écoulé elapsed time
  | from | float : valeur initiale initial value
  | to | float : valeur finale final value

Returns:
  double : la valeur intermédiaire en fonction du temps interpolated value

unsigned long int Animation::getKeyFramesCount | ( |  | ) |

Retourne le nombre de trames clé Returns the frame count -.

Author:
  U.Speed

Returns:
  const unsigned long int : le nombre de trames frame count

void Animation::interpolate | ( |  | ) |

Lancement du calcul d'interpolation sur toutes les informations Run the interpolation using all loaded informations -.

Author:
  U.Speed

bool Animation::isLooping | ( |  | ) |

Permet de connaître l'état de mise en boucle de l'animation Returns wether the animation loops or not -.

Author:
  U.Speed

Returns:
  bool : `true` si l'animation est en boucle `true` when the animation loops

bool Animation::isRunning | ( |  | ) |

Permet de savoir si l'animation est en cours Returns wether the animation is running or not -.

Author:
  U.Speed

Returns:
  bool : `true` si l'animation est en cours `true` si l'animation est en cours `true` when the animation is running

void Animation::loop | ( | bool | active | ) |

Mise en boucle de l'animation Activate or not the infinite loop for the animation -.

Author:
  U.Speed

Parameters:

  | active | bool : `true` pour mettre l'animation en boucle `true` to activate infinite loop

void Animation::minimizeRotations | ( | USGE_Float3 const & | from,
|  | USGE_Float3 const & | to,
|  | bool | moduloOnly,
|  | USGE_Float3 & | target |
| ) |  |  | `[static]`

Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.

Modification des angles de rotation initiaux et finaux pour qu'ils soient compris entre -180 et +180°.
Le résultat est copié dans "<code>target</code>". Modification initial and final rotation's angles in order to be between -180 and +180°.
Resulting angles will copied in "<code>target</code>".

Author:
  U.Speed

See also:
  void Animation::minimizeRotations(USGE_Float3 const &from, USGE_Float3 const &to, bool moduloOnly, std::string &target)

Parameters:

  | from | USGE_Float3 const& : les angles de départ inital angles
  | to | USGE_Float3 const& : les angles de destination final angles
  | moduloOnly | bool : `true` si les angles "to" sont uniquement ramenés entre -180° et +180°. `true` to apply modulo only on "to" angles (between -180° et +180°).
  | target | USGE_Float3& : la cible du calcul computing target

Returns:
  USGE_Float3 : les nouvelles valeurs de "to" new values of "to"

USGE_Float3 Animation::minimizeRotations | ( | USGE_Float3 const & | from,
|  | USGE_Float3 const & | to |
| ) |  |  | `[static]`

Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.

Modification des angles de rotation initiaux et finaux pour qu'ils soient compris entre -180 et +180°. Modification initial and final rotation's angles in order to be between -180 and +180°.

Author:
  U.Speed

See also:
  void Animation::minimizeRotations(USGE_Float3 const &from, USGE_Float3 const &to, bool moduloOnly, std::string &target)

Parameters:

  | from | USGE_Float3 const& : les angles de départ inital angles
  | to | USGE_Float3 const& : les angles de destination les angles de destination final angles

Returns:
  USGE_Float3 : les nouvelles valeurs de "to" new values of "to"

USGE_Float3 Animation::minimizeRotations | ( | USGE_Float3 const & | from,
|  | USGE_Float3 const & | to,
|  | bool | moduloOnly |
| ) |  |  | `[static]`

Permet de minimiser les déplacements en rotation via un modulo et une modification du sens de rotation Minimize rotation moves by applying modulo and rotation orientation -.

Modification des angles de rotation initiaux et finaux pour qu'ils soient compris entre -180 et +180°. Modification initial and final rotation's angles in order to be between -180 and +180°.

Author:
  U.Speed

See also:
  void Animation::minimizeRotations(USGE_Float3 const &from, USGE_Float3 const &to, bool moduloOnly, std::string &target)

Parameters:

  | from | USGE_Float3 const& : les angles de départ inital angles
  | to | USGE_Float3 const& : les angles de destination les angles de destination final angles
  | moduloOnly | bool : `true` si les angles "to" sont uniquement ramenés entre -180° et +180°. `true` to apply modulo only on "to" angles (between -180° et +180°).

Returns:
  USGE_Float3 : les nouvelles valeurs de "to" new values of "to"

USGE_KeyFrame * Animation::operator[] | ( | const unsigned long int | index | ) |

Récupération de la trame spécifiée Access to the specified frame -.

Retourne le pointeur de la trame spécifiée afin d'avoir la possibilité de la modifier.
Cette surcharge d'opérateur ne retourne JAMAIS de pointeur nul ! Returns the pointer of the specified frame that allow user to modify it.
This operator overload will NEVER return a nul pointer !

Author:
  U.Speed

Parameters:

  | index | const unsigned long int : l'index (basé en zéro) de la trame à récupérer. the index (zero-based) of the frame to get

Returns:
  USGE_KeyFrame* : le pointeur de la trame souhaitée ou un pointeur valide d'une trame n'ayant pas de données cohérentes (JAMAIS NULL). the pointer (NEVER NULL)

void Animation::pause | ( |  | ) |

Arrêt (pause) de l'animation Stop (pause) the animation -.

Author:
  U.Speed

void Animation::removeAll | ( |  | ) |

Suppression de toutes les trames clé Removes all keyframes from list -.

Author:
  U.Speed

void Animation::removeKeyFrame | ( | unsigned int | position | ) |

Retrait d'une trame clé à la position désignée Removes the frame from the list at specified position -.

!!!! PAS ENCORE IMPLÉMENTÉ !!!! !!!! NOT YET IMPLEMENTED !!!!

Author:
  U.Speed

Parameters:

  | position | unsigned int : la position incriminée frame position

void Animation::restart | ( |  | ) |

Redémarrage de l'animation depuis les informations initiales Restarts the animation from initiales values -.

Author:
  U.Speed

See also:
  void Animation::stop()
  void Animation::start()

void Animation::start | ( |  | ) |

Démarrage de l'animation Starts the animation -.

Author:
  U.Speed

void Animation::stop | ( |  | ) |

Arrêt et retour au début de l'animation Stops and rewinds the animation -.

Author:
  U.Speed

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

- src/Animation/Animation.hpp
- src/Animation/Animation.cpp
- src/Animation/Animation_addKeyFrame.cpp
- src/Animation/Animation_clear.cpp
- src/Animation/Animation_getInfos.cpp
- src/Animation/Animation_getInterpolation.cpp
- src/Animation/Animation_getKeyFramesCount.cpp
- src/Animation/Animation_interpolate.cpp
- src/Animation/Animation_isLooping.cpp
- src/Animation/Animation_isRunning.cpp
- src/Animation/Animation_loop.cpp
- src/Animation/Animation_minimizeRotations.cpp
- src/Animation/Animation_operator.cpp
- src/Animation/Animation_pause.cpp
- src/Animation/Animation_removeAll.cpp
- src/Animation/Animation_removeKeyFrame.cpp
- src/Animation/Animation_restart.cpp
- src/Animation/Animation_start.cpp
- src/Animation/Animation_stop.cpp