Page principale   Hiérarchie des classes   Liste des composants   Liste des fichiers   Composants   Déclarations   Pages associées  

Référence de la classe Pivot

#include <Pivot.h>

Graphe d'héritage de la classe Pivot

Inheritance graph
[Légende]
Diagramme de collaboration de Pivot:

Collaboration graph
[Légende]
Liste de tous les membres

Description détaillée

Cette classe permet de fabriquer un pivot.


Spécificités des pivots

Fonctions spécifiques au fonctionement des pivots.

void setAxis (double *axis)
 Ajuste l'axe de rotation du pivot.

void getAxis (double *axis)
 Donne l'axe de rotation du pivot.

void setForce (double force)
 Impose une force.

void setVel (double vel)
 Impose une vitesse.

void getAngle (double *angle)
 Donne l'angle d'ouverture en radian.

void getAngleRate (double *rate)
 Donne la variation de l'angle d'ouverture.


Membres publics

Constructeur/Destructeur
 Pivot (Container *_container, GD_Objet *_objet1=0, GD_Objet *_objet2=0)
 Constructeur par défaut.

 ~Pivot (void)
 Destructeur.

Positionement
Fonctions relatives au positionement dans l'espace

void setPosition (double *position)
 Ajuste la position.

void getPosition (double *position)
 Donne la position.

void setRotation (double *rotation)
 Ajuste l'orientation.

void getRotation (double *rotation)
 Donne l'orientation.

void setEchelle (double *echelle)
 Ajuste les dimensions.

void getEchelle (double *echelle)
 Donne les dimensions.


Documentation des contructeurs et destructeurs

Pivot Container   _container,
GD_Objet   _objet1 = 0,
GD_Objet   _objet2 = 0
 

Instancie un pivot.

Attention:
Le pivot a par défaut son axe de rotation selon l'axe des x et son positionement à l'origine. Les methodes de parametrage (set/get Position...) devraient etre appelées aprés avoir relié les GD_Objet (sinon elles n'ont pas d'effet).
Paramètres:
_container est un pointeur vers le conteneur de ce pivot.
_objet1 est le premier objet à lier.
_objet2 est le second objet à lier.
Voir également:
manuel de ODE : http://opende.sourceforge.net/ode-latest-userguide.html#ref54

~Pivot void   
 

Destructeur


Documentation des méthodes

void setPosition double *    position [virtual]
 

Fonction permettant d'ajuster la position du GD_Objet.

Paramètres:
position matrice (1 ligne)X(3 colonnes) spécifiant les nouvelles coordonnées cartésiennes du GD_Objet

Redéfinie à partir de GD_Objet.

void getPosition double *    position [virtual]
 

Fonction permettant d'obtenir la position du GD_Objet.

Paramètres:
position matrice (1 ligne)(3 colonnes) que la fonction rempliera avec les coordonnées cartésiennes du GD_Objet.
Attention:
Cette methode donne par défaut une position située à l'origine. Elle devra donc imperativement être redéfinie dans la descendance.

Redéfinie à partir de GD_Objet.

void setRotation double *    rotation [virtual]
 

Fonction permettant d'ajuster l'orientation du GD_Objet.

Paramètres:
rotation matrice (3 lignes)(4 colonnes) spécifiant la matrice de rotation du GD_Objet

Redéfinie à partir de GD_Objet.

void getRotation double *    rotation [virtual]
 

Fonction permettant d'obtenir l'orientation du GD_Objet.

Paramètres:
rotation matrice (3 ligne3)(4 colonnes) que la fonction rempliera avec la matrice de rotation du GD_Objet.
Attention:
Cette methode donne par défaut une matrice identitée (donc une rotation nulle). Elle devra donc imperativement être redéfinie dans la descendance.

Redéfinie à partir de GD_Objet.

void setEchelle double *    echelle [virtual]
 

Fonction permettant d'ajuster les dimensions du GD_Objet.

Paramètres:
echelle est un pointeur vers un tableau de 3 doubles.

Redéfinie à partir de GD_Objet.

void getEchelle double *    echelle [virtual]
 

Fonction permettant de récupérer les dimensions du GD_Objet.

Paramètres:
echelle est un pointeur vers un tableau de 3 doubles.
Attention:
Cette methode donne par défaut une matrice remplie de 1 (donc une mise à l'echelle sans effet). Elle devra donc imperativement être redéfinie dans la descendance.

Redéfinie à partir de GD_Objet.

void setAxis double *    axis
 

Cette methode permet d'ajuster l'axe de rotation du pivot. Il faut que l'axe ai une longeur unitaire.

Paramètres:
axis matrice (1 ligne)(3 colonnes) définissant l'axe de rotation du pivot.
À Faire:
assouplir la methode en acceptant un axe de longeur quelconque.

void getAxis double *    axis
 

Cette methode permet d'obtenir l'axe de rotation du pivot.

Paramètres:
axis matrice (1 ligne)(3 colonnes) que la fonction rempliera avec un vecteur définissant l'axe de rotation du pivot.

void setForce double    force
 

Cette methode permet d'imposer une force, et ainsi d'activer le "moteur" du pivot. Si la vitesse est mise à zero ( setVel(0) ), définir la force revient à définir un coefficient de friction sur l'axe. Sinon, la force correspondra au couple maximum que le "moteur" utilisera pour atteindre la vitesse définie. Si la force est nulle, le "moteur" est éteint.

Paramètres:
force force appliquée par le "moteur" sur la liaison.
Voir également:
setVel.

void setVel double    vel
 

Cette methode permet d'imposer une vitesse angulaire pour le "moteur".

Paramètres:
vel vitesse imposée au moteur.
Voir également:
setForce.

void getAngle double *    angle
 

Cette methode donne l'angle entre les deux objets reliés par le pivot. Ce angle vaut zero dans la configuration initiale des deux objets l'un par rapport à l'autre. Lorsque le centre ou l'axe du pivot est modifié, la position courante des objets reliés est prise en compte pour remettre à zero l'angle.La valeur retournée est en radian. Elle vaut entre -pi et pi.

Paramètres:
angle est un pointeur vers la variable à affecter.
Voir également:
getAngleRate.

void getAngleRate double *    rate
 

Cette methode donne la variation de l'angle par rapport au temps.

Paramètres:
rate est un pointeur vers la variable à affecter.
Voir également:
getAngle.


La documentation associée à cette classe a été générée à partir du fichier suivant :
Cette documentation a été généré le 24 May 2003 par Doxygen version 1.3-rc3.
Pour tout renseignements :