CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iJoystickDriver Struct Reference
[Event handling]

Generic Joystick driver. More...

#include <csinput.h>

Inheritance diagram for iJoystickDriver:

iBase csJoystickDriver List of all members.

Public Methods

virtual void Reset ()=0
 Call to release all joystick buttons (when focus switches from application window, for example).

virtual int GetLastX (int number)=0
 Query last X position of joystick 'number'.

virtual int GetLastY (int number)=0
 Query last Y position of joystick 'number'.

virtual bool GetLastButton (int number, int button)=0
 Query the last known button state of joystick 'number'.

virtual void DoButton (int number, int button, bool down, int x, int y)=0
 Call this to add a 'button down/up' event to queue.

virtual void DoMotion (int number, int x, int y)=0
 Call this to add a 'moved' event to queue for joystick 'number'.


Detailed Description

Generic Joystick driver.

The joystick driver is responsible for tracking current joystick state and also for synthesizing joystick movement events. Multiple joysticks are supported; they are numbered starting at zero. Joystick button numbers start at 1. Typically, one instance of this object is available from the shared-object registry (iObjectRegistry) under the name "crystalspace.driver.input.generic.joystick".

Main creators of instances implementing this interface:

Main ways to get pointers to this interface:

Definition at line 228 of file csinput.h.


Member Function Documentation

virtual void iJoystickDriver::DoButton int    number,
int    button,
bool    down,
int    x,
int    y
[pure virtual]
 

Call this to add a 'button down/up' event to queue.

Joystick numbers start at 0. Button numbers start at 1.

Implemented in csJoystickDriver.

virtual void iJoystickDriver::DoMotion int    number,
int    x,
int    y
[pure virtual]
 

Call this to add a 'moved' event to queue for joystick 'number'.

Implemented in csJoystickDriver.

virtual bool iJoystickDriver::GetLastButton int    number,
int    button
[pure virtual]
 

Query the last known button state of joystick 'number'.

Joystick numbers start at 0. Button numbers start at 1.

Implemented in csJoystickDriver.

virtual int iJoystickDriver::GetLastX int    number [pure virtual]
 

Query last X position of joystick 'number'.

Implemented in csJoystickDriver.

virtual int iJoystickDriver::GetLastY int    number [pure virtual]
 

Query last Y position of joystick 'number'.

Implemented in csJoystickDriver.

virtual void iJoystickDriver::Reset   [pure virtual]
 

Call to release all joystick buttons (when focus switches from application window, for example).

Implemented in csJoystickDriver.

Referenced by csJoystickDriver::LostFocus().


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18