|
PulpCore | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object pulpcore.Input
public final class Input
The Input class provides an easy way to check the state of the keyboard keys, the mouse buttons, and the mouse location.
Mouse buttons and keyboard keys are both treated as "virtual keys". Virtual keys have four states: UP, DOWN, PRESSED, and RELEASED. The states only change when polled, which occurs before each call to Scene.update().
State | Description |
UP | The key is up. |
DOWN | The key is down. |
PRESSED | The key was pressed since the last poll. |
RELEASED | The key was released since the last poll. |
If a key was both pressed and released between polls, the key state will be PRESSED, and on the next poll the key state will be RELEASED.
Field Summary | |
---|---|
static int |
CURSOR_CROSSHAIR
|
static int |
CURSOR_DEFAULT
|
static int |
CURSOR_E_RESIZE
|
static int |
CURSOR_HAND
|
static int |
CURSOR_MOVE
|
static int |
CURSOR_N_RESIZE
|
static int |
CURSOR_NE_RESIZE
|
static int |
CURSOR_NW_RESIZE
|
static int |
CURSOR_OFF
|
static int |
CURSOR_S_RESIZE
|
static int |
CURSOR_SE_RESIZE
|
static int |
CURSOR_SW_RESIZE
|
static int |
CURSOR_TEXT
|
static int |
CURSOR_W_RESIZE
|
static int |
CURSOR_WAIT
|
static int |
DOWN
The virtual key state indicating that a key is down. |
static int |
KEY_0
|
static int |
KEY_1
|
static int |
KEY_2
|
static int |
KEY_3
|
static int |
KEY_4
|
static int |
KEY_5
|
static int |
KEY_6
|
static int |
KEY_7
|
static int |
KEY_8
|
static int |
KEY_9
|
static int |
KEY_A
|
static int |
KEY_ADD
|
static int |
KEY_B
|
static int |
KEY_BACK_QUOTE
|
static int |
KEY_BACK_SLASH
|
static int |
KEY_BACK_SPACE
|
static int |
KEY_C
|
static int |
KEY_CAPS_LOCK
|
static int |
KEY_CLOSE_BRACKET
|
static int |
KEY_COMMA
|
static int |
KEY_D
|
static int |
KEY_DECIMAL
|
static int |
KEY_DELETE
|
static int |
KEY_DIVIDE
|
static int |
KEY_DOUBLE_MOUSE_BUTTON_1
|
static int |
KEY_DOUBLE_MOUSE_BUTTON_2
|
static int |
KEY_DOUBLE_MOUSE_BUTTON_3
|
static int |
KEY_DOWN
|
static int |
KEY_E
|
static int |
KEY_END
|
static int |
KEY_ENTER
|
static int |
KEY_EQUALS
|
static int |
KEY_ESCAPE
|
static int |
KEY_F
|
static int |
KEY_F1
|
static int |
KEY_F10
|
static int |
KEY_F11
|
static int |
KEY_F12
|
static int |
KEY_F13
|
static int |
KEY_F14
|
static int |
KEY_F15
|
static int |
KEY_F16
|
static int |
KEY_F17
|
static int |
KEY_F18
|
static int |
KEY_F19
|
static int |
KEY_F2
|
static int |
KEY_F20
|
static int |
KEY_F21
|
static int |
KEY_F22
|
static int |
KEY_F23
|
static int |
KEY_F24
|
static int |
KEY_F3
|
static int |
KEY_F4
|
static int |
KEY_F5
|
static int |
KEY_F6
|
static int |
KEY_F7
|
static int |
KEY_F8
|
static int |
KEY_F9
|
static int |
KEY_G
|
static int |
KEY_H
|
static int |
KEY_HOME
|
static int |
KEY_I
|
static int |
KEY_INSERT
|
static int |
KEY_J
|
static int |
KEY_K
|
static int |
KEY_L
|
static int |
KEY_LEFT
|
static int |
KEY_LEFT_ALT
|
static int |
KEY_LEFT_CONTROL
|
static int |
KEY_LEFT_META
|
static int |
KEY_LEFT_SHIFT
|
static int |
KEY_M
|
static int |
KEY_MINUS
|
static int |
KEY_MOUSE_BUTTON_1
|
static int |
KEY_MOUSE_BUTTON_2
|
static int |
KEY_MOUSE_BUTTON_3
|
static int |
KEY_MULTIPLY
|
static int |
KEY_N
|
static int |
KEY_NUM_LOCK
|
static int |
KEY_NUMPAD0
|
static int |
KEY_NUMPAD1
|
static int |
KEY_NUMPAD2
|
static int |
KEY_NUMPAD3
|
static int |
KEY_NUMPAD4
|
static int |
KEY_NUMPAD5
|
static int |
KEY_NUMPAD6
|
static int |
KEY_NUMPAD7
|
static int |
KEY_NUMPAD8
|
static int |
KEY_NUMPAD9
|
static int |
KEY_O
|
static int |
KEY_OPEN_BRACKET
|
static int |
KEY_P
|
static int |
KEY_PAGE_DOWN
|
static int |
KEY_PAGE_UP
|
static int |
KEY_PAUSE
|
static int |
KEY_PERIOD
|
static int |
KEY_PRINT_SCREEN
|
static int |
KEY_Q
|
static int |
KEY_QUOTE
|
static int |
KEY_R
|
static int |
KEY_RIGHT
|
static int |
KEY_RIGHT_ALT
|
static int |
KEY_RIGHT_CONTROL
|
static int |
KEY_RIGHT_META
|
static int |
KEY_RIGHT_SHIFT
|
static int |
KEY_S
|
static int |
KEY_SCROLL_LOCK
|
static int |
KEY_SEMICOLON
|
static int |
KEY_SEPARATOR
|
static int |
KEY_SLASH
|
static int |
KEY_SPACE
|
static int |
KEY_SUBTRACT
|
static int |
KEY_T
|
static int |
KEY_TAB
|
static int |
KEY_TRIPLE_MOUSE_BUTTON_1
|
static int |
KEY_TRIPLE_MOUSE_BUTTON_2
|
static int |
KEY_TRIPLE_MOUSE_BUTTON_3
|
static int |
KEY_U
|
static int |
KEY_UP
|
static int |
KEY_V
|
static int |
KEY_W
|
static int |
KEY_X
|
static int |
KEY_Y
|
static int |
KEY_Z
|
static int |
NUM_KEY_CODES
|
static int |
PRESSED
The virtual key state indicating that a key is pressed. |
static int |
RELEASED
The virtual key state indicating that a key is released. |
static int |
REPEATED
The virtual key state indicating that a key is repeated. |
static int |
UP
The virtual key state indicating that a key is up. |
Method Summary | |
---|---|
static int |
getCursor()
|
static int |
getMousePressX()
Gets the x location of the last mouse press. |
static int |
getMousePressY()
Gets the y location of the last mouse press. |
static int |
getMouseReleaseX()
Gets the x location of the last mouse release. |
static int |
getMouseReleaseY()
Gets the y location of the last mouse release. |
static int |
getMouseWheelRotation()
Returns the number of clicks the mouse wheel was rotated since the last poll. |
static int |
getMouseWheelX()
Gets the x location of the last mouse wheel rotation. |
static int |
getMouseWheelY()
Gets the y location of the last mouse wheel rotation. |
static int |
getMouseX()
|
static int |
getMouseY()
|
static int |
getState(int keyCode)
|
static String |
getTypedChars()
Returns the keyboard character input received since the last poll. |
static boolean |
hasKeyboardFocus()
|
static boolean |
isAltDown()
Checks if either the left ALT key or the right ALT key is currently down. |
static boolean |
isControlDown()
Checks if either the left control (CTRL) key or the right control key is currently down. |
static boolean |
isDown(int keyCode)
|
static boolean |
isDown(int[] keyCodes)
Checks a list of key codes and returns true if at least one key is down. |
static boolean |
isMetaDown()
Checks if either the left meta key or the right meta key is currently down. |
static boolean |
isMouseDown()
Returns true if the primary mouse button is down. |
static boolean |
isMouseInside()
Returns true if the mouse is inside the Stage. |
static boolean |
isMouseMoving()
|
static boolean |
isMousePressed()
Returns true if the primary mouse button is pressed. |
static boolean |
isMouseReleased()
Returns true if the primary mouse button is released. |
static boolean |
isPressed(int keyCode)
|
static boolean |
isPressed(int[] keyCodes)
Checks a list of key codes and returns true if at least one key is pressed and no other keys are down. |
static boolean |
isReleased(int keyCode)
|
static boolean |
isReleased(int[] keyCodes)
Checks a list of key codes and returns true if at least one key is released and no other keys are down. |
static boolean |
isShiftDown()
Checks if either the left shift key or the right shift key is currently down. |
static boolean |
isTyped(int keyCode)
|
static void |
requestKeyboardFocus()
|
static void |
setCursor(int cursorCode)
Sets the cursor type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int UP
getState(int)
,
Constant Field Valuespublic static final int DOWN
getState(int)
,
Constant Field Valuespublic static final int PRESSED
getState(int)
,
Constant Field Valuespublic static final int RELEASED
getState(int)
,
Constant Field Valuespublic static final int REPEATED
getState(int)
,
Constant Field Valuespublic static final int CURSOR_DEFAULT
public static final int CURSOR_OFF
public static final int CURSOR_HAND
public static final int CURSOR_CROSSHAIR
public static final int CURSOR_MOVE
public static final int CURSOR_TEXT
public static final int CURSOR_WAIT
public static final int CURSOR_N_RESIZE
public static final int CURSOR_S_RESIZE
public static final int CURSOR_W_RESIZE
public static final int CURSOR_E_RESIZE
public static final int CURSOR_NW_RESIZE
public static final int CURSOR_NE_RESIZE
public static final int CURSOR_SW_RESIZE
public static final int CURSOR_SE_RESIZE
public static final int KEY_MOUSE_BUTTON_1
public static final int KEY_MOUSE_BUTTON_2
public static final int KEY_MOUSE_BUTTON_3
public static final int KEY_BACK_SPACE
public static final int KEY_TAB
public static final int KEY_ENTER
public static final int KEY_PAUSE
public static final int KEY_CAPS_LOCK
public static final int KEY_ESCAPE
public static final int KEY_SPACE
public static final int KEY_PAGE_UP
public static final int KEY_PAGE_DOWN
public static final int KEY_END
public static final int KEY_HOME
public static final int KEY_LEFT
public static final int KEY_UP
public static final int KEY_RIGHT
public static final int KEY_DOWN
public static final int KEY_PRINT_SCREEN
public static final int KEY_INSERT
public static final int KEY_DELETE
public static final int KEY_0
public static final int KEY_1
public static final int KEY_2
public static final int KEY_3
public static final int KEY_4
public static final int KEY_5
public static final int KEY_6
public static final int KEY_7
public static final int KEY_8
public static final int KEY_9
public static final int KEY_A
public static final int KEY_B
public static final int KEY_C
public static final int KEY_D
public static final int KEY_E
public static final int KEY_F
public static final int KEY_G
public static final int KEY_H
public static final int KEY_I
public static final int KEY_J
public static final int KEY_K
public static final int KEY_L
public static final int KEY_M
public static final int KEY_N
public static final int KEY_O
public static final int KEY_P
public static final int KEY_Q
public static final int KEY_R
public static final int KEY_S
public static final int KEY_T
public static final int KEY_U
public static final int KEY_V
public static final int KEY_W
public static final int KEY_X
public static final int KEY_Y
public static final int KEY_Z
public static final int KEY_NUMPAD0
public static final int KEY_NUMPAD1
public static final int KEY_NUMPAD2
public static final int KEY_NUMPAD3
public static final int KEY_NUMPAD4
public static final int KEY_NUMPAD5
public static final int KEY_NUMPAD6
public static final int KEY_NUMPAD7
public static final int KEY_NUMPAD8
public static final int KEY_NUMPAD9
public static final int KEY_MULTIPLY
public static final int KEY_ADD
public static final int KEY_SEPARATOR
public static final int KEY_SUBTRACT
public static final int KEY_DECIMAL
public static final int KEY_DIVIDE
public static final int KEY_F1
public static final int KEY_F2
public static final int KEY_F3
public static final int KEY_F4
public static final int KEY_F5
public static final int KEY_F6
public static final int KEY_F7
public static final int KEY_F8
public static final int KEY_F9
public static final int KEY_F10
public static final int KEY_F11
public static final int KEY_F12
public static final int KEY_F13
public static final int KEY_F14
public static final int KEY_F15
public static final int KEY_F16
public static final int KEY_F17
public static final int KEY_F18
public static final int KEY_F19
public static final int KEY_F20
public static final int KEY_F21
public static final int KEY_F22
public static final int KEY_F23
public static final int KEY_F24
public static final int KEY_NUM_LOCK
public static final int KEY_SCROLL_LOCK
public static final int KEY_LEFT_SHIFT
public static final int KEY_RIGHT_SHIFT
public static final int KEY_LEFT_CONTROL
public static final int KEY_RIGHT_CONTROL
public static final int KEY_LEFT_ALT
public static final int KEY_RIGHT_ALT
public static final int KEY_SEMICOLON
public static final int KEY_EQUALS
public static final int KEY_COMMA
public static final int KEY_MINUS
public static final int KEY_PERIOD
public static final int KEY_SLASH
public static final int KEY_BACK_QUOTE
public static final int KEY_OPEN_BRACKET
public static final int KEY_BACK_SLASH
public static final int KEY_CLOSE_BRACKET
public static final int KEY_QUOTE
public static final int KEY_DOUBLE_MOUSE_BUTTON_1
public static final int KEY_DOUBLE_MOUSE_BUTTON_2
public static final int KEY_DOUBLE_MOUSE_BUTTON_3
public static final int KEY_TRIPLE_MOUSE_BUTTON_1
public static final int KEY_TRIPLE_MOUSE_BUTTON_2
public static final int KEY_TRIPLE_MOUSE_BUTTON_3
public static final int KEY_LEFT_META
public static final int KEY_RIGHT_META
public static final int NUM_KEY_CODES
Method Detail |
---|
public static void setCursor(int cursorCode)
public static int getCursor()
public static void requestKeyboardFocus()
public static boolean hasKeyboardFocus()
public static int getState(int keyCode)
public static boolean isMouseInside()
public static boolean isMouseMoving()
public static int getMouseX()
public static int getMouseY()
public static int getMousePressX()
isMousePressed()
.
public static int getMousePressY()
isMousePressed()
.
public static int getMouseReleaseX()
isMouseReleased()
.
public static int getMouseReleaseY()
isMouseReleased()
.
public static int getMouseWheelX()
getMouseWheelRotation()
.
public static int getMouseWheelY()
getMouseWheelRotation()
.
public static int getMouseWheelRotation()
For applets, mouse wheel input may not work all situations. For example, the applet must first have focus, and some browsers (notably, Safari on Mac OS X) will not allow mouse wheel input at all.
getMouseWheelX()
,
getMouseWheelY()
public static String getTypedChars()
public static boolean isDown(int keyCode)
public static boolean isPressed(int keyCode)
public static boolean isTyped(int keyCode)
public static boolean isReleased(int keyCode)
public static boolean isPressed(int[] keyCodes)
public static boolean isDown(int[] keyCodes)
public static boolean isReleased(int[] keyCodes)
public static boolean isControlDown()
public static boolean isShiftDown()
public static boolean isAltDown()
public static boolean isMetaDown()
public static boolean isMousePressed()
getMousePressX()
,
getMousePressY()
public static boolean isMouseReleased()
getMouseReleaseX()
,
getMouseReleaseY()
public static boolean isMouseDown()
getMouseX()
,
getMouseY()
|
PulpCore | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |