Public Types | Public Member Functions | Public Attributes

wit::ButtonEvent 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

 ButtonEvent (Event::Type type, Controller ctype, unsigned short id, int button=Button_None)
int type () const

Public Attributes

Button button
Controller controllerType
unsigned short controllerNumber

Detailed Description

The ButtonEvent class describes the pressing or releasing of a non-analog button.

The type() property of the object determines whether the event represents a press (Event::ButtonPress) or a release (Event::ButtonRelease).

The analog L and R buttons on the Classic Controller and GameCube controller, as well as the A and B buttons on the GameCube controller, emit button events when they are fully depressed or released from the fully-depressed state.

See also:
wit::EventHandler::buttonPressEvent(), wit::EventHandler::buttonReleaseEvent()

Definition at line 41 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::ButtonEvent::ButtonEvent ( Event::Type  type,
Controller  ctype,
unsigned short  id,
int  button = Button_None 
)

Constructs a button event with the specified type for the specified controller.

Definition at line 96 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 button was pressed or released.

Distinguishing between different controller types involves the controllerType variable.

Definition at line 45 of file event.h.

unsigned short wit::InputEvent::controllerNumber [inherited]

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: