wiiremotej.event
Class WRButtonEvent

java.lang.Object
  extended by java.util.EventObject
      extended by wiiremotej.event.WREvent
          extended by wiiremotej.event.WRButtonEvent
All Implemented Interfaces:
java.io.Serializable

public class WRButtonEvent
extends WREvent

Button event for Nintendo (R) Wii Remote (TM). Contains information about which buttons are currently pressed in this event.

See Also:
Serialized Form

Field Summary
static int A
          Constant representing the A button of the Wii Remote.
static int B
          Constant representing the B button of the Wii Remote.
static int DOWN
          Constant representing the down button of the Wii Remote.
static int HOME
          Constant representing the home button of the Wii Remote.
static int LEFT
          Constant representing the left button of the Wii Remote.
static int MINUS
          Constant representing the minus button of the Wii Remote.
static int ONE
          Constant representing the one button of the Wii Remote.
static int PLUS
          Constant representing the plus button of the Wii Remote.
static int RIGHT
          Constant representing the right button of the Wii Remote.
static int TWO
          Constant representing the two button of the Wii Remote.
static int UP
          Constant representing the up button of the Wii Remote.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
WRButtonEvent(WiiRemote source, byte[] data, WRButtonEvent lastEvent)
          Creates a new WRButtonEvent from the given input data array.
WRButtonEvent(WiiRemote source, int buttonsPressed, WRButtonEvent lastEvent)
          Creates a new WRButtonEvent from the given the given buttonsPressed mask.
 
Method Summary
 boolean isAnyPressed(int buttonMask)
          Returns true if any of the given buttons are pressed; otherwise false.
 boolean isOnlyPressed(int buttonMask)
          Returns true if all of the given buttons are pressed and no others are; otherwise false.
 boolean isPressed(int buttonMask)
          Returns true if all of the given buttons are pressed; otherwise false.
 boolean wasOnlyPressed(int buttonMask)
          Returns true if all of the given buttons were pressed and no others are; otherwise false.
 boolean wasPressed(int buttonMask)
          Returns true if all of the given buttons were pressed; otherwise false.
 boolean wasReleased(int buttonMask)
          Returns true if one of the given buttons was released; otherwise false.
 
Methods inherited from class wiiremotej.event.WREvent
getSource
 
Methods inherited from class java.util.EventObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TWO

public static final int TWO
Constant representing the two button of the Wii Remote.

See Also:
Constant Field Values

ONE

public static final int ONE
Constant representing the one button of the Wii Remote.

See Also:
Constant Field Values

B

public static final int B
Constant representing the B button of the Wii Remote.

See Also:
Constant Field Values

A

public static final int A
Constant representing the A button of the Wii Remote.

See Also:
Constant Field Values

MINUS

public static final int MINUS
Constant representing the minus button of the Wii Remote.

See Also:
Constant Field Values

HOME

public static final int HOME
Constant representing the home button of the Wii Remote.

See Also:
Constant Field Values

LEFT

public static final int LEFT
Constant representing the left button of the Wii Remote.

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
Constant representing the right button of the Wii Remote.

See Also:
Constant Field Values

DOWN

public static final int DOWN
Constant representing the down button of the Wii Remote.

See Also:
Constant Field Values

UP

public static final int UP
Constant representing the up button of the Wii Remote.

See Also:
Constant Field Values

PLUS

public static final int PLUS
Constant representing the plus button of the Wii Remote.

See Also:
Constant Field Values
Constructor Detail

WRButtonEvent

public WRButtonEvent(WiiRemote source,
                     byte[] data,
                     WRButtonEvent lastEvent)
Creates a new WRButtonEvent from the given input data array. This array contains ALL of the bits directly from Wii Remote input (including HID header).

Parameters:
source - the WiiRemote triggering this event.
data - the byte data to process for button presses.
lastEvent - the last button event received. Used to calculate wasPressed and wasReleased information.

WRButtonEvent

public WRButtonEvent(WiiRemote source,
                     int buttonsPressed,
                     WRButtonEvent lastEvent)
Creates a new WRButtonEvent from the given the given buttonsPressed mask.

Parameters:
source - the WiiRemote triggering this event.
buttonsPressed - the buttonsPressed mask for this event (i.e. the sum of all the depressed buttons).
lastEvent - the last button event received. Used to calculate wasPressed and wasReleased information.
Method Detail

isPressed

public boolean isPressed(int buttonMask)
Returns true if all of the given buttons are pressed; otherwise false. "isPressed" means that the buttons are currently depressed; they may have just been depressed this event, or they may have been depressed previously. Buttons are specified using the field constants in this class.

Parameters:
buttonMask - the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
Returns:
true if the given buttons are pressed; otherwise false.

isOnlyPressed

public boolean isOnlyPressed(int buttonMask)
Returns true if all of the given buttons are pressed and no others are; otherwise false. "isPressed" means that the buttons are currently depressed; they may have just been depressed this event, or they may have been depressed previously. Buttons are specified using the field constants in this class.

Parameters:
buttonMask - the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
Returns:
true if the given buttons are pressed and no others are; otherwise false.

isAnyPressed

public boolean isAnyPressed(int buttonMask)
Returns true if any of the given buttons are pressed; otherwise false. "isPressed" means that the buttons are currently depressed; they may have just been depressed this event, or they may have been depressed previously. Buttons are specified using the field constants in this class. If the button mask contains only one button, this method is the same as isPressed(buttonMask).

Parameters:
buttonMask - the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
Returns:
true if any of the given buttons are pressed; otherwise false.

wasPressed

public boolean wasPressed(int buttonMask)
Returns true if all of the given buttons were pressed; otherwise false. "wasPressed" means that the buttons were not depressed before, and were just depressed this event. Buttons are specified using the field constants in this class.

Parameters:
buttonMask - the button(s) to check if was pressed. You may specify either a single button or a button mask (multiple buttons added together). If you use a button mask (i.e. multiple buttons), then this method returns true when the buttons described by button are depressed (isPressed(buttonMask) returns true) and at least one of the buttons was just depressed (i.e. it was previously not depressed).
Returns:
true if the given buttons were pressed; otherwise false.

wasOnlyPressed

public boolean wasOnlyPressed(int buttonMask)
Returns true if all of the given buttons were pressed and no others are; otherwise false. "wasPressed" means that the buttons were not depressed before, and were just depressed this event. Buttons are specified using the field constants in this class.

Parameters:
buttonMask - the button(s) to check if was pressed. You may specify either a single button or a button mask (multiple buttons added together). If you use a button mask (i.e. multiple buttons), then this method returns true when the buttons described by button are depressed (isOnlyPressed(buttonMask) returns true) and at least one of the buttons was just depressed (i.e. it was previously not depressed).
Returns:
true if the given buttons were pressed and no others are; otherwise false.

wasReleased

public boolean wasReleased(int buttonMask)
Returns true if one of the given buttons was released; otherwise false. "wasReleased" means that the buttons were previously depressed, and that at least one was just released this event. Buttons are specified using the field constants in this class.

Parameters:
buttonMask - the button(s) to check if was released. You may specify either a single button or a button mask (multiple buttons added together). If you use a button mask, (i.e. multiple buttons), then this method returns true when all buttons were depressed previously (isPressed(buttonMask) returned true last event), and at least one of them has been released ((isPressed(buttonMask) now returns false).
Returns:
true if the given buttons were released; otherwise false.