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

Référence de la classe Glissiere

#include <Glissiere.h>

Graphe d'héritage de la classe Glissiere

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

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

Description détaillée

Cette classe permet de fabriquer une glissiere.


Membres publics

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

 ~Glissiere (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.

Spécificités des glissieres
Fonctions spécifiques au fonctionement des glissieres

void setAnchor (double *position)
 N'a pas d'effet.

void getAnchor (double *position, bool voisins=false) const
 Donne le centre de la glissière.

void setAxis (double *axis)
 Ajuste l'axe de la glissiere.

void getAxis (double *axis) const
 Donne l'axe de la glissiere.

void setForce (double force)
 Impose une force.

void setVel (double vel)
 Impose une vitesse.

void getExtension (double *extension) const
 Donne l'extension.

void getExtensionRate (double *rate) const
 Donne la variation de l'extension.

Documentation des contructeurs et destructeurs

Glissiere (  Container *    _container,
GD_Objet *    _objet1 = 0,
GD_Objet *    _objet2 = 0
) 
 

Instancie une glissiere.

Paramètres:
_container est un pointeur vers le conteneur de cette glissiere.
_objet1 est le premier objet à lier.
_objet2 est le second objet à lier.

~Glissiere (  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 setAnchor (  double *    position ) 
 

Cette methode n'a pas d'effet sur une glissière.

void getAnchor (  double *    position,
bool    voisins = false
)  const
 

Cette methode s'utilise de la meme manière que getPosition. Cependant elle offre en plus la possibilité d'obtenir les coordonnées relatives des objets reliés.

Paramètres:
position matrice (1 ligne)(3 colonnes) que la fonction rempliera avec les coordonnées cartésiennes du centre de la glissière.
voisins si cette valeur vaut true il faut passer une matrice 3*(1 ligne)(3 colonnes) en premier paramètre.

void setAxis (  double *    axis ) 
 

Cette methode permet d'ajuster l'axe de la glissiere.

Paramètres:
axis matrice (1 ligne)(3 colonnes) définissant l'axe.

void getAxis (  double *    axis )  const
 

Cette methode permet d'obtenir l'axe de la glissiere.

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

void setForce (  double    force ) 
 

Cette methode permet d'imposer une force, et ainsi d'activer le "moteur" de la glissiere. 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 linéaire pour le "moteur".

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

void getExtension (  double *    extension )  const
 

Cette methode donne l'extension entre les deux objets reliés par la glissiere. Cette longueur vaut zero dans la configuration initiale des deux objets. Lorsque l'axe de la glissiere est modifié, la position courante des objets reliés est prise en compte pour remettre à zero la longueur.

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

void getExtensionRate (  double *    rate )  const
 

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

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

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 :