Public Types | Public Member Functions | Public Attributes | Protected Member Functions

wit::InputEvent Class Reference

#include <wit/event.h>

List of all members.

Public Types

enum  Type {
  Joystick, Analog, Motion, Pointer,
  PointerLeave, ButtonPress, ButtonRelease, User = 256
}

Public Member Functions

int type () const

Public Attributes

Controller controllerType
unsigned short controllerNumber

Protected Member Functions

 InputEvent (int type, Controller ctype, unsigned short id)

Detailed Description

This is the base class for all events generated by controllers. It is not intended to be instantiated directly.

WIT supports the Wii Remote and the Nunchuk, Classic Controller, and Guitar Hero 3 attachments, as well as GameCube controllers and the Balance Board. If additional controller types are introduced, new values of the Controller enum will be added.

Definition at line 32 of file event.h.


Member Enumeration Documentation

enum wit::Event::Type [inherited]
Enumerator:
Joystick 

The event was generated by changing the position of an analog joystick.

Analog 

The event was generated by changing the pressure on an analog button.

Motion 

The event was generated by the motion sensor of a Wii Remote or Nunchuk.

Pointer 

The event was generated by the infrared sensor of a Wii Remote.

PointerLeave 

The event was generated by the pointer moving out of a hotspot.

ButtonPress 

The event was generated by pressing a non-analog button or by fully depressing an analog button.

ButtonRelease 

The event was generated by releasing a non-analog button or by releasing a fully-depressed analog button,

User 

Base value for user-defined events.

Definition at line 12 of file event.h.


Constructor & Destructor Documentation

wit::InputEvent::InputEvent ( int  type,
Controller  ctype,
unsigned short  id 
) [protected]

Constructs an input event with the specified type for the specified controller.

Note that this constructor has protected visibility: the InputEvent class cannot be cannot be instantiated directly, only subclassed.

Definition at line 66 of file event.cpp.


Member Function Documentation

int wit::Event::type (  ) const [inherited]

Returns the type of the event.

Definition at line 30 of file event.cpp.


Member Data Documentation

Indicates which controller generated the event, generally numbered 0 to 3 for Wii Remotes and their accessories and numbered 4 to 7 for GameCube controllers.

Distinguishing between attached accessories can be done by reading the controllerType variable.

Definition at line 35 of file event.h.

Indicates which type of controller generated the event.

Definition at line 34 of file event.h.


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