The joystick device, this is the joystick manager.
More...
#include <ceJoystick.h>
List of all members.
Public Member Functions |
| virtual int | GetNumSupported (void) const =0 |
| | Queries the joystick driver for the number of joysticks it supports.
|
| virtual int | IsJoyButtonPressed (const int joyid=0x0, const int button=0x0) const =0 |
| | Check whether a button is pressed, at any given time.
|
| virtual int | IsJoyButtonReleased (const int joyid=0x0, const int button=0x0) const =0 |
| | Check whether a button is released, at any given time.
|
| virtual int | GetJoyPosition (const int joyid, unsigned int *get_x, unsigned int *get_y, unsigned int *get_z=NULL) const =0 |
| | undocumented.
|
| virtual unsigned int | GetJoyXPosition (const int joyid=0x0) const =0 |
| | undocumented.
|
| virtual unsigned int | GetJoyYPosition (const int joyid=0x0) const =0 |
| | undocumented.
|
| virtual unsigned int | GetJoyZPosition (const int joyid=0x0) const =0 |
| | undocumented.
|
| virtual void | SetJoystickEvent (IJoystickEvent *Event) const =0 |
| | Set the joystick event.
|
| virtual IJoystickEvent * | GetJoystickEvent (void) const =0 |
| | Retrieves the joystick event.
|
| virtual EInputDevice | GetDeviceType (void) const =0 |
| | Retrieves the device type.
|
| virtual char * | GetDeviceName (void) const =0 |
| | Retrieves the device name.
|
| virtual int | GetDeviceCount (void) const =0 |
| | Retrieves the device count.
|
| virtual int | IsDevicePresent (const int id=0x0) const =0 |
| | Check whether a device is present, at any given time.
|
| virtual void | Update (const int async=TRUE)=0 |
| | Update status of only this device.
|
Detailed Description
The joystick device, this is the joystick manager.
- See also:
- IJoystickEvent
- Todo:
- Methods:
- AttachJoystickEvent(IJoystickEvent *Event) : short(index)
- DetachJoystickEvent(IJoystickEvent *Event)
- GetJoystickEvent(const short index)
Member Function Documentation
| virtual int GetNumSupported |
( |
void |
|
) |
const [pure virtual] |
Queries the joystick driver for the number of joysticks it supports.
- Returns:
- The number of joysticks supported by the current driver or zero if no driver is installed.
| virtual int IsJoyButtonPressed |
( |
const int |
joyid = 0x0, |
|
|
const int |
button = 0x0 | |
|
) |
| | const [pure virtual] |
Check whether a button is pressed, at any given time.
- Parameters:
-
| joyid | The joystick id. |
| button | The button to check. |
- Returns:
- If the button is pressed, the return is a TRUE value or if the button is released, the return is a FALSE value.
- See also:
- IsJoyButtonReleased
| virtual int IsJoyButtonReleased |
( |
const int |
joyid = 0x0, |
|
|
const int |
button = 0x0 | |
|
) |
| | const [pure virtual] |
Check whether a button is released, at any given time.
- Parameters:
-
| joyid | The joystick id. |
| button | The button to check. |
- Returns:
- If the button is released, the return is a TRUE value or if the button is pressed, the return is a FALSE value.
- See also:
- IsJoyButtonPressed
| virtual int GetJoyPosition |
( |
const int |
joyid, |
|
|
unsigned int * |
get_x, |
|
|
unsigned int * |
get_y, |
|
|
unsigned int * |
get_z = NULL | |
|
) |
| | const [pure virtual] |
undocumented.
- Parameters:
-
| joyid | The joystick id. |
| get_x | undocumented. |
| get_y | undocumented. |
| get_z | undocumented. |
- Returns:
- undocumented.
| virtual unsigned int GetJoyXPosition |
( |
const int |
joyid = 0x0 |
) |
const [pure virtual] |
undocumented.
- Parameters:
-
- Returns:
- undocumented.
| virtual unsigned int GetJoyYPosition |
( |
const int |
joyid = 0x0 |
) |
const [pure virtual] |
undocumented.
- Parameters:
-
- Returns:
- undocumented.
| virtual unsigned int GetJoyZPosition |
( |
const int |
joyid = 0x0 |
) |
const [pure virtual] |
undocumented.
- Parameters:
-
- Returns:
- undocumented.
| virtual void SetJoystickEvent |
( |
IJoystickEvent * |
Event |
) |
const [pure virtual] |
Set the joystick event.
- Parameters:
-
| Event | Pointer to joystick event. |
| virtual IJoystickEvent* GetJoystickEvent |
( |
void |
|
) |
const [pure virtual] |
Retrieves the joystick event.
- Returns:
- The joystick event.
| virtual EInputDevice GetDeviceType |
( |
void |
|
) |
const [pure virtual, inherited] |
Retrieves the device type.
- Returns:
- The device type.
| virtual char* GetDeviceName |
( |
void |
|
) |
const [pure virtual, inherited] |
Retrieves the device name.
- Returns:
- The device name.
| virtual int GetDeviceCount |
( |
void |
|
) |
const [pure virtual, inherited] |
Retrieves the device count.
- Returns:
- The number of devices attached.
| virtual int IsDevicePresent |
( |
const int |
id = 0x0 |
) |
const [pure virtual, inherited] |
Check whether a device is present, at any given time.
- Returns:
- If this succeeds, the return is a TRUE value or if this fails, the return is a FALSE value.
| virtual void Update |
( |
const int |
async = TRUE |
) |
[pure virtual, inherited] |
Update status of only this device.
- Parameters:
-
| async | Ignore this parameter. |
The documentation for this class was generated from the following file:
