|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
wiiremotej.event.WREvent
wiiremotej.event.WRExtensionEvent
wiiremotej.event.WRGuitarExtensionEvent
public class WRGuitarExtensionEvent
Classic controller extension event for Nintendo (R) Wii Remote (TM). Contains data from the classic controller extension. Be aware that if buttons are held when the controller is first connected (or the remote is turned on while the controller is plugged in), calibration data may be inaccurate.
Field Summary | |
---|---|
static int |
BLUE
Constant representing the blue button on the Guitar (equivalent to Classic Controller Y). |
static int |
GREEN
Constant representing the green button on the Guitar (equivalent to Classic Controller A). |
static int |
MINUS
Constant representing the minus button of the Guitar. |
static int |
ORANGE
Constant representing the orange button on the Guitar (equivalent to Classic Controller left Z). |
static int |
PLUS
Constant representing the plus button of the Guitar. |
static int |
RED
Constant representing the red button on the Guitar (equivalent to Classic Controller B). |
static int |
STRUM_DOWN
Constant representing strumming down on the Guitar (equivalent to Classic Controller D-pad down). |
static int |
STRUM_UP
Constant representing strumming up on the Guitar (equivalent to Classic Controller D-pad up). |
static int |
YELLOW
Constant representing the yellow button on the Guitar (equivalent to Classic Controller X). |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
WRGuitarExtensionEvent(WiiRemote source,
AnalogStickData analogStickData,
AnalogStickData rightAnalogStickData,
int buttonsPressed,
double whammyBar,
WRGuitarExtensionEvent lastEvent)
Creates a new WRClassicControllerExtensionEvent from the given settings. |
|
WRGuitarExtensionEvent(WiiRemote source,
byte[] input,
int offset,
WRGuitarExtensionEvent lastEvent)
Creates a new WRGuitarExtensionEvent from an array of input data from the Wii Remote. |
Method Summary | |
---|---|
static WRGuitarExtensionEvent |
createBlankEvent()
Returns a WRClassicControllerExtensionEvent with all the values cleared. |
AnalogStickData |
getAnalogStickData()
Returns AnalogStickData representing the current state of the analog stick on the guitar. |
double |
getWhammyBar()
Returns the amount the whammy bar is pushed. |
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 |
---|
public static final int STRUM_UP
public static final int YELLOW
public static final int GREEN
public static final int BLUE
public static final int RED
public static final int ORANGE
public static final int PLUS
public static final int MINUS
public static final int STRUM_DOWN
Constructor Detail |
---|
public WRGuitarExtensionEvent(WiiRemote source, byte[] input, int offset, WRGuitarExtensionEvent lastEvent)
source
- the WiiRemote triggering this event.input
- data received from the extension port.offset
- the position of the first byte of extension data in the array.lastEvent
- the last received WRGuitarExtensionEvent. Used for button-press information.public WRGuitarExtensionEvent(WiiRemote source, AnalogStickData analogStickData, AnalogStickData rightAnalogStickData, int buttonsPressed, double whammyBar, WRGuitarExtensionEvent lastEvent)
source
- the WiiRemote triggering this event.analogStickData
- analog stick data for the left analog stick.rightAnalogStickData
- analog stick data for the right analog stick.buttonsPressed
- the buttonsPressed mask for this event (i.e. the sum of all the depressed buttons).whammyBar
- how much the whammy bar is pushedlastEvent
- the last received WRClassicControllerExtensionEvent. Used for wasPressed and wasReleased information.Method Detail |
---|
public static WRGuitarExtensionEvent createBlankEvent()
public AnalogStickData getAnalogStickData()
public double getWhammyBar()
isPressed(int buttonMask)
public boolean isPressed(int buttonMask)
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.
buttonMask
- the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
true
if the given buttons are pressed; otherwise false
.public boolean isOnlyPressed(int buttonMask)
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.
buttonMask
- the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
true
if the given buttons are pressed and no others are; otherwise false
.public boolean isAnyPressed(int buttonMask)
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).
buttonMask
- the button(s) to check if is pressed. You may specify either a single button or a button mask (multiple buttons added together).
true
if any of the given buttons are pressed; otherwise false
.public boolean wasPressed(int buttonMask)
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.
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).
true
if the given buttons were pressed; otherwise false
.public boolean wasOnlyPressed(int buttonMask)
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.
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).
true
if the given buttons were pressed and no others are; otherwise false
.public boolean wasReleased(int buttonMask)
true
if one of the given buttons was released; otherwise false
. "wasReleased" means that the buttons were previously
depressed, but that at least one was just released this event.
Buttons are specified using the field constants in this class.
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
).
true
if the given buttons were released; otherwise false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |