Fonctions membres publiques

# Référence de la classe USpeedGameEngine::Physic::PhysicState

Classe de définition d'état physique d'un object 3D. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| PhysicState ()
| Constructeur par défaut.
| ~PhysicState ()
| Destructeur par défaut.
bool | loadBox (USGE_Float3 dim)
| Chargement de l'état physique selon un modèle parallèlépipèdique.
bool | loadSphere (float radius)
| Chargement de l'état physique selon un modèle sphérique.
bool | loadCone (float radius, float height)
| Chargement de l'état physique selon un modèle cônique.
bool | loadCapsule (float radius, float height)
| Chargement de l'état physique selon un modèle de capsule.
void | unload ()
| Remise à zéro de l'état de l'objet.
void | unload (bool resetState)
| Remise à zéro de l'état de l'objet.
bool | isLoaded ()
| Permet de savoir si l'objet est chargé (valide pour une utilisation).
void | saveState ()
| Sauvegarde de l'état physique actuel.
void | saveState (bool unload)
| Sauvegarde de l'état physique actuel.
void | setPosition (USGE_Float3 position)
| Affectation de la position (x, y, z).
void | setPosition (float x, float y, float z)
| Affectation de la position (x, y, z).
void | setRotation (USGE_Float3 rotation)
| Affectation d'une rotation d'Euler selon x, y et z.
void | setRotation (float x, float y, float z)
| Affectation d'une rotation d'Euler selon x, y et z.
void | setMass (float mass)
| Définition de la masse initiale.
void | setVelocity (USGE_Float3 linear, USGE_Float3 angular)
| Définition de la vitesse initial (linéaire et angulaire).
void | getPosition (USGE_Float3 *position)
| Récupération de la position (x, y, z).
void | getPosition (float *x, float *y, float *z)
| Récupération de la position (x, y, z).
void | getRotation (USGE_Float3 *rotation)
| Récupération de la rotation d'Euler selon x, y et z.
void | getRotation (float *x, float *y, float *z)
| Récupération de la rotation d'Euler selon x, y et z.
void * | getObject ()
| Retourne le pointeur vers le "object" de l'objet physique.

## Description détaillée

Classe de définition d'état physique d'un object 3D.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Physic::PhysicState::PhysicState | ( |  | ) |

Constructeur par défaut.

Auteur:
  U.Speed

Physic::PhysicState::~PhysicState | ( |  | ) |

Destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

void * Physic::PhysicState::getObject | ( |  | ) |

Retourne le pointeur vers le "object" de l'objet physique.

Auteur:
  U.Speed

Renvoie:
  void* : le pointeur ou "0"

void Physic::PhysicState::getPosition | ( | USGE_Float3 * | position | ) |

Récupération de la position (x, y, z).

Auteur:
  U.Speed

Voir également:
  void Physic::PhysicState::getPosition(float *x, float *y, float *z)

Paramètres:

  | position | USGE_Float3 : la position

void Physic::PhysicState::getPosition | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  |

Récupération de la position (x, y, z).

Auteur:
  U.Speed

Paramètres:

  | x | float : la position selon l'axe x
  | y | float : la position selon l'axe y
  | z | float : la position selon l'axe z

void Physic::PhysicState::getRotation | ( | USGE_Float3 * | rotation | ) |

Récupération de la rotation d'Euler selon x, y et z.

Auteur:
  U.Speed

Voir également:
  void Physic::PhysicState::getRotation(float *x, float *y, float *z)

Paramètres:

  | rotation | USGE_Float3 : la rotation

void Physic::PhysicState::getRotation | ( | float * | x,
|  | float * | y,
|  | float * | z |
| ) |  |  |

Récupération de la rotation d'Euler selon x, y et z.

Auteur:
  U.Speed

Paramètres:

  | x | float : la rotation selon l'axe x
  | y | float : la rotation selon l'axe y
  | z | float : la rotation selon l'axe z

bool Physic::PhysicState::isLoaded | ( |  | ) |

Permet de savoir si l'objet est chargé (valide pour une utilisation).

Auteur:
  U.Speed

Renvoie:
  bool : `true` si l'objet est initialisé

bool Physic::PhysicState::loadBox | ( | USGE_Float3 | dim | ) |

Chargement de l'état physique selon un modèle parallèlépipèdique.

Voici une illustration :

Auteur:
  U.Speed

Voir également:
  bool Physic::PhysicState::load()

Paramètres:

  | dim | USGE_Float3 : la taille de la demi-boîte selon x, y, z

bool Physic::PhysicState::loadCapsule | ( | float | radius,
|  | float | height |
| ) |  |  |

Chargement de l'état physique selon un modèle de capsule.

Voici une illustration :

Auteur:
  U.Speed

Voir également:
  bool Physic::PhysicState::load()

Paramètres:

  | radius | float : le rayon des deux demi-sphères
  | height | float : la hauteur du cylindre entre les deux demi-sphères

bool Physic::PhysicState::loadCone | ( | float | radius,
|  | float | height |
| ) |  |  |

Chargement de l'état physique selon un modèle cônique.

Voici une illustration :

Auteur:
  U.Speed

Voir également:
  bool Physic::PhysicState::load()

Paramètres:

  | radius | float : le rayon de la base
  | height | float : la hauteur du cône

bool Physic::PhysicState::loadSphere | ( | float | radius | ) |

Chargement de l'état physique selon un modèle sphérique.

Voici une illustration :

Auteur:
  U.Speed

Voir également:
  bool Physic::PhysicState::load()

Paramètres:

  | radius | float : le rayon de la sphère

void Physic::PhysicState::saveState | ( |  | ) |

Sauvegarde de l'état physique actuel.

Ne décharge pas l'état physique via "unload".

Voir également:
  void Physic::PhysicState::saveState(bool unload)

Auteur:
  U.Speed

void Physic::PhysicState::saveState | ( | bool | unload | ) |

Sauvegarde de l'état physique actuel.

Affectation de l'état physique actuel aux informations initiales.
Cette méthode permet de récupérer l'état physique actuel de l'objet pour l'affecter à l'état initial.
De ce fait, il est possible à un objet d'être retirer (via "unload") du monde physique, puis de l'y replonger plus tard en concervant toute ou partie de ses données en rechargeant via "load".

Auteur:
  U.Speed

Paramètres:

  | unload | bool : libération de la mémoire après avoir sauvegardé l'état

void Physic::PhysicState::setMass | ( | float | m | ) |

Définition de la masse initiale.

Auteur:
  U.Speed

Paramètres:

  | m | float : la masse ("0.0f" pour un objet statique)

void Physic::PhysicState::setPosition | ( | float | x,
|  | float | y,
|  | float | z |
| ) |  |  |

Affectation de la position (x, y, z).

Auteur:
  U.Speed

Paramètres:

  | x | float : la position selon l'axe x
  | y | float : la position selon l'axe y
  | z | float : la position selon l'axe z

void Physic::PhysicState::setPosition | ( | USGE_Float3 | position | ) |

Affectation de la position (x, y, z).

Auteur:
  U.Speed

Voir également:
  void Physic::PhysicState::setPosition(float x, float y, float z)

Paramètres:

  | position | USGE_Float3 : la position

void Physic::PhysicState::setRotation | ( | float | x,
|  | float | y,
|  | float | z |
| ) |  |  |

Affectation d'une rotation d'Euler selon x, y et z.

Auteur:
  U.Speed

Paramètres:

  | x | float : la rotation selon l'axe x
  | y | float : la rotation selon l'axe y
  | z | float : la rotation selon l'axe z

void Physic::PhysicState::setRotation | ( | USGE_Float3 | rotation | ) |

Affectation d'une rotation d'Euler selon x, y et z.

Auteur:
  U.Speed

Voir également:
  void Physic::PhysicState::setRotation(float x, float y, float z)

Paramètres:

  | rotation | USGE_Float3 : la rotation

void Physic::PhysicState::setVelocity | ( | USGE_Float3 | linear,
|  | USGE_Float3 | angular |
| ) |  |  |

Définition de la vitesse initial (linéaire et angulaire).

- Vitesse linéaire : translation.
- Vitesse angulaire : rotation.
  Auteur:
    U.Speed
  Paramètres:

    | linear | USGE_Float3 : le déplacement linéaire initial
    | angular | USGE_Float3 : le déplacement angulaire initial

void Physic::PhysicState::unload | ( |  | ) |

Remise à zéro de l'état de l'objet.

Avant d'être remis à zéro, l'objet est retiré du monde physique.
L'état initial EST CONSERVÉ.

Auteur:
  U.Speed

Voir également:
  void Physic::PhysicState::unload(bool resetState)

void Physic::PhysicState::unload | ( | bool | resetState | ) |

Remise à zéro de l'état de l'objet.

Avant d'être remis à zéro, l'objet est retiré du monde physique.
L'état initial peut être conservé.

Auteur:
  U.Speed

Voir également:
  void Physic::removePhysicState(Physic::PhysicState *physicState)

Paramètres:

  | resetState | bool : `true` pour remettre à zéro l'état de l'inertie, la position, etc...

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Physic/PhysicState.hpp
- src/Physic/PhysicState.cpp
- src/Physic/PhysicState_getObject.cpp
- src/Physic/PhysicState_getPosition.cpp
- src/Physic/PhysicState_getRotation.cpp
- src/Physic/PhysicState_isLoaded.cpp
- src/Physic/PhysicState_load.cpp
- src/Physic/PhysicState_loadBox.cpp
- src/Physic/PhysicState_loadCapsule.cpp
- src/Physic/PhysicState_loadCone.cpp
- src/Physic/PhysicState_loadSphere.cpp
- src/Physic/PhysicState_saveState.cpp
- src/Physic/PhysicState_setMass.cpp
- src/Physic/PhysicState_setPosition.cpp
- src/Physic/PhysicState_setRotation.cpp
- src/Physic/PhysicState_setVelocity.cpp
- src/Physic/PhysicState_unload.cpp