CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

csJoystickEventHelper Class Reference

Helper class to conveniently deal with joystick events. More...

#include <csutil/event.h>

List of all members.

Static Public Member Functions

static int GetAxis (const iEvent *event, uint)
 Retrieve any axis (basis 1) value.
static uint GetButton (const iEvent *event)
 Retrieve button number.
static bool GetEventData (const iEvent *event, csJoystickEventData &data)
 Retrieve event data.
static uint32 GetModifiers (const iEvent *event)
 Retrieve modifiers bitmask.
static void GetModifiers (const iEvent *event, csKeyModifiers &modifiers)
 Retrieve modifier flags.
static uint GetNumAxes (const iEvent *)
 Retrieve number of axes.
static uint GetNumber (const iEvent *event)
 Retrieve joystick number (1, 2, ...).
static int GetX (const iEvent *event)
 Retrieve axis 0 value.
static int GetY (const iEvent *event)
 Retrieve axis 1 value.


Detailed Description

Helper class to conveniently deal with joystick events.

Definition at line 128 of file event.h.


Member Function Documentation

static int csJoystickEventHelper::GetAxis const iEvent event,
uint 
[static]
 

Retrieve any axis (basis 1) value.

Referenced by GetX(), and GetY().

static uint csJoystickEventHelper::GetButton const iEvent event  )  [static]
 

Retrieve button number.

static bool csJoystickEventHelper::GetEventData const iEvent event,
csJoystickEventData data
[static]
 

Retrieve event data.

static uint32 csJoystickEventHelper::GetModifiers const iEvent event  )  [inline, static]
 

Retrieve modifiers bitmask.

Definition at line 149 of file event.h.

References csKeyEventHelper::GetModifiers(), and csKeyEventHelper::GetModifiersBits().

static void csJoystickEventHelper::GetModifiers const iEvent event,
csKeyModifiers modifiers
[inline, static]
 

Retrieve modifier flags.

Definition at line 146 of file event.h.

References csKeyEventHelper::GetModifiers().

static uint csJoystickEventHelper::GetNumAxes const iEvent  )  [static]
 

Retrieve number of axes.

static uint csJoystickEventHelper::GetNumber const iEvent event  )  [static]
 

Retrieve joystick number (1, 2, ...).

static int csJoystickEventHelper::GetX const iEvent event  )  [inline, static]
 

Retrieve axis 0 value.

Definition at line 134 of file event.h.

References GetAxis().

static int csJoystickEventHelper::GetY const iEvent event  )  [inline, static]
 

Retrieve axis 1 value.

Definition at line 137 of file event.h.

References GetAxis().


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