CrystalSpace

Public API Reference

iJoystickDriver Struct Reference
[Event handling]

Generic Joystick driver. More...

#include <iutil/csinput.h>

Inheritance diagram for iJoystickDriver:

List of all members.

Public Member Functions

virtual void DoButton (uint number, int button, bool down, const int32 *axes, uint numAxes)=0
 Call this to add a 'button down/up' event to queue.
virtual void DoMotion (uint number, const int32 *axes, uint nunmAxes)=0
 Call this to add a 'moved' event to queue for joystick 'number'.
virtual int GetLast (uint number, uint axis) const =0
 Query last position on 'axis' of joystick 'number'.
virtual const int32GetLast (uint number) const =0
 Query last position on all axes of joystick 'number'.
virtual bool GetLastButton (uint number, int button) const =0
 Query the last known button state of joystick 'number'.
virtual void Reset ()=0
 Call to release all joystick buttons (when focus switches from application window, for example).

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 also start at zero. Typically, a single 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 237 of file csinput.h.


Member Function Documentation

virtual void iJoystickDriver::DoButton ( uint  number,
int  button,
bool  down,
const int32 axes,
uint  numAxes 
) [pure virtual]

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

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

virtual void iJoystickDriver::DoMotion ( uint  number,
const int32 axes,
uint  nunmAxes 
) [pure virtual]

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

virtual int iJoystickDriver::GetLast ( uint  number,
uint  axis 
) const [pure virtual]

Query last position on 'axis' of joystick 'number'.

virtual const int32* iJoystickDriver::GetLast ( uint  number  )  const [pure virtual]

Query last position on all axes of joystick 'number'.

virtual bool iJoystickDriver::GetLastButton ( uint  number,
int  button 
) const [pure virtual]

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

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

virtual void iJoystickDriver::Reset (  )  [pure virtual]

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


The documentation for this struct was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1