Public Member Functions | Static Public Member Functions

# USpeedGameEngine::InputControl::Mouse Class Reference

Classe de gestion des contrôles de la souris - Win32. More...

List of all members.

## Public Member Functions

| Mouse ()
| Constructeur par défaut.
| ~Mouse ()
| Destructeur par défaut.
void | resetStates ()
| Remet à zéro l'état des contrôles et les délais.
bool | getClickState (USGE_InputControl btn)
| Retourne l'état d'un bouton de la souris.
int | getWheel ()
| Retourne la valeur de la molette de la souris.
void | resetWheel ()
| Remet la valeur actuelle de la molette de la souris à l'état initial '0'.
void | getPosition (long int *x, long int *y)
| Récupère la position du curseur de la souris et l'affecte aux données fournies.
long int | getX ()
| Récupère la position X du curseur de la souris.
long int | getY ()
| Récupère la position Y du curseur de la souris.
void | getRelativePosition (long int *x, long int *y)
| Récupère la position relative à la fenêtre du curseur de la souris et l'affecte aux données fournies.
long int | getRelativeX ()
| Récupère la position X relative à la fenêtre du curseur de la souris.
long int | getRelativeY ()
| Récupère la position Y relative à la fenêtre du curseur de la souris.
void | setPosition (long int x, long int y)
| Positionne le curseur de la souris.
void | setX (long int x)
| Détermination de la position X le curseur de la souris.
void | setY (long int y)
| Détermination de la position Y le curseur de la souris.
void | setClickDelay (unsigned int clickNum, unsigned long int msTime)
| Permet de définir le temps minimum autorisé entre chaque pression de clic.
void | setClickDelay (unsigned int clickNum, unsigned long int first, unsigned long int next)
| Permet de définir le temps minimum autorisé.
void | setClickDelayAll (unsigned long int msTime)
| Permet de définir le temps minimum autorisé entre chaque pression pour TOUTES les touches.
void | setClickDelayAll (unsigned long int first, unsigned long int next)
| Permet de définir le temps minimum autorisé pour TOUS les boutons de la souris.

## Static Public Member Functions

static void | showCursor (bool show)
| Afficher/masquer le curseur.
static bool | cursorIsVisible ()
| État du paramétrage pour l'affichage/masquage du curseur.

## Detailed Description

Classe de gestion des contrôles de la souris - Win32.

Author:
  U.Speed

## Constructor & Destructor Documentation

InputControl::Mouse::Mouse | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

InputControl::Mouse::~Mouse | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

bool InputControl::Mouse::cursorIsVisible | ( |  | ) | `[static]`

État du paramétrage pour l'affichage/masquage du curseur.

Ne prend effet que lorsque la fenêtre est active.

Author:
  U.Speed

Returns:
  bool : `true` pour rendre le curseur visible, `false` pour le rendre invisible

bool InputControl::Mouse::getClickState | ( | USGE_InputControl | btn | ) |

Retourne l'état d'un bouton de la souris.

Author:
  U.Speed

Parameters:

  | btn | USGE_InputControl : le bouton concerné

Returns:
  bool : `true` si le touche est enfoncée (et que le délai le permet)

void InputControl::Mouse::getPosition | ( | long int * | x,
|  | long int * | y |
| ) |  |  |

Récupère la position du curseur de la souris et l'affecte aux données fournies.

Les pointeurs peuvent être nuls.

Author:
  U.Speed

Parameters:

  | x | long int* : coordonnée X de la position du curseur
  | y | long int* : coordonnée Y de la position du curseur

void InputControl::Mouse::getRelativePosition | ( | long int * | x,
|  | long int * | y |
| ) |  |  |

Récupère la position relative à la fenêtre du curseur de la souris et l'affecte aux données fournies.

Les pointeurs peuvent être nuls.

Author:
  U.Speed

Parameters:

  | x | long int* : coordonnée X de la position du curseur
  | y | long int* : coordonnée Y de la position du curseur

long int InputControl::Mouse::getRelativeX | ( |  | ) |

Récupère la position X relative à la fenêtre du curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position X de la souris

long int InputControl::Mouse::getRelativeY | ( |  | ) |

Récupère la position Y relative à la fenêtre du curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position Y de la souris

int InputControl::Mouse::getWheel | ( |  | ) |

Retourne la valeur de la molette de la souris.

A chaque déplacement (unitaire ou non) de la molette vers l'avant, la valeur augmente (unitairement ou non).
A chaque déplacement (unitaire ou non) de la molette vers l'arrière, la valeur diminue (unitairement ou non).
Schéma :

Author:
  U.Speed

Returns:
  int : la rotation de la souris

long int InputControl::Mouse::getX | ( |  | ) |

Récupère la position X du curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position X de la souris

long int InputControl::Mouse::getY | ( |  | ) |

Récupère la position Y du curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position Y de la souris

void InputControl::Mouse::resetStates | ( |  | ) |

Remet à zéro l'état des contrôles et les délais.

Author:
  U.Speed

void InputControl::Mouse::resetWheel | ( |  | ) |

Remet la valeur actuelle de la molette de la souris à l'état initial '0'.

Author:
  U.Speed

void InputControl::Mouse::setClickDelay | ( | unsigned int | clickNum,
|  | unsigned long int | msTime |
| ) |  |  |

Permet de définir le temps minimum autorisé entre chaque pression de clic.

Author:
  U.Speed

See also:
  void InputControl::Mouse::setClickDelay(unsigned int clickNum, unsigned long int first, unsigned long int next)

Parameters:

  | clickNum | unsigned int : le n° du bouton concerné (> 0)
  | msTime | unsigned long int : le délai

void InputControl::Mouse::setClickDelay | ( | unsigned int | clickNum,
|  | unsigned long int | first,
|  | unsigned long int | next |
| ) |  |  |

Permet de définir le temps minimum autorisé.

- ... entre la première pression et la seconde
- ... entre la seconde pression et les suivantes

Author:
  U.Speed

Parameters:

  | clickNum | unsigned int : le n° du clic concerné (> 0)
  | first | unsigned long int : temps minimum autorisé entre la première pression et la seconde
  | next | unsigned long int : temps minimum autorisé entre la première pression et les suivantes

void InputControl::Mouse::setClickDelayAll | ( | unsigned long int | msTime | ) |

Permet de définir le temps minimum autorisé entre chaque pression pour TOUTES les touches.

Author:
  U.Speed

See also:
  void InputControl::Mouse::setClickDelayAll(unsigned long int first, unsigned long int next)

Parameters:

  | msTime | unsigned long int : le délai

void InputControl::Mouse::setClickDelayAll | ( | unsigned long int | first,
|  | unsigned long int | next |
| ) |  |  |

Permet de définir le temps minimum autorisé pour TOUS les boutons de la souris.

- "first" : entre la première pression et la seconde
- "next" : entre la seconde pression et les suivantes

Author:
  U.Speed

Parameters:

  | first | unsigned long int : temps minimum autorisé entre la première pression et la seconde
  | next | unsigned long int : temps minimum autorisé entre la première pression et les suivantes

void InputControl::Mouse::setPosition | ( | long int | x,
|  | long int | y |
| ) |  |  |

Positionne le curseur de la souris.

Author:
  U.Speed

Parameters:

  | x | long int : coordonnée X de la position du curseur
  | y | long int : coordonnée Y de la position du curseur

void InputControl::Mouse::setX | ( | long int | x | ) |

Détermination de la position X le curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position X de la souris

void InputControl::Mouse::setY | ( | long int | y | ) |

Détermination de la position Y le curseur de la souris.

Author:
  U.Speed

Returns:
  long int : la position Y de la souris

void InputControl::Mouse::showCursor | ( | bool | show | ) | `[static]`

Afficher/masquer le curseur.

Ne prend effet que lorsque la fenêtre est active.

Author:
  U.Speed

Parameters:

  | show | bool : `true` pour rendre le curseur visible, `false` pour le rendre invisible

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

- src/InputControl/Mouse.hpp
- src/InputControl/Mouse.cpp
- src/InputControl/Mouse_cursorIsVisible.cpp
- src/InputControl/Mouse_getClickState.cpp
- src/InputControl/Mouse_getPosition.cpp
- src/InputControl/Mouse_getRelativePosition.cpp
- src/InputControl/Mouse_getRelativeX.cpp
- src/InputControl/Mouse_getRelativeY.cpp
- src/InputControl/Mouse_getWheel.cpp
- src/InputControl/Mouse_getX.cpp
- src/InputControl/Mouse_getY.cpp
- src/InputControl/Mouse_resetStates.cpp
- src/InputControl/Mouse_resetWheel.cpp
- src/InputControl/Mouse_setClickDelay.cpp
- src/InputControl/Mouse_setClickDelayAll.cpp
- src/InputControl/Mouse_setPosition.cpp
- src/InputControl/Mouse_setX.cpp
- src/InputControl/Mouse_setY.cpp
- src/InputControl/Mouse_showCursor.cpp