com.krab.lazy

Class Input

java.lang.Object

com.krab.lazy.Input

public class Input
extends java.lang.Object

Static wrapper for a utility class that keeps track of all currently pressed keys to simplify the code for complex keyboard interaction, because Processing doesn't offer that. Ask it for individual key states using chars or keyCodes and see if the key was pressed this frame, whether it is now down or whether it was just released. Also includes two simple mouse position functions. Mouse events are considered well-supported by Processing so there is no alternative offered here.

Constructor Summary

Constructors

Constructor and Description
Input()

Method Summary

Modifier and Type	Method and Description
static void	debugPrintKeyEvents(boolean shouldDebugKeys) Prints all newly received key events to console when this is set to true until manually set to false.
static java.util.List<java.lang.String>	getAllDownChars() Gets all currently pressed chars as lowercase strings in a list.
static java.util.List<java.lang.Integer>	getAllDownCodes() Gets all currently pressed keys as integer keyCodes in a list.
static KeyState	getChar(java.lang.Character key) Get the current keyboard button state by using its char value.
static KeyState	getCode(int keyCode) Get the current keyboard button state by using its keyCode value.
static processing.core.PVector	mouseDelta() Gets the difference between current frame mouse position and previous frame mouse position as a PVector.
static processing.core.PVector	mousePos() Get the current mouseX and mouseY as a PVector.
static processing.core.PVector	mousePosLastFrame() Get pmouseX and pmouseY as a PVector describing the last frame's mouse position.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Input

public Input()

Method Detail

getChar

public static KeyState getChar(java.lang.Character key)

Get the current keyboard button state by using its char value. Meant to be used like getChar('n').down

Parameters:

key - char representation of the key

Returns:

current state of the keyboard button

getCode

public static KeyState getCode(int keyCode)

Get the current keyboard button state by using its keyCode value. Meant to be used like getCode(LEFT).down

Parameters:

keyCode - keyCode representation of the key

Returns:

current state of the keyboard button

getAllDownChars

public static java.util.List<java.lang.String> getAllDownChars()

Gets all currently pressed chars as lowercase strings in a list. Does not include special keys for which key == CODED is true like CTRL and DELETE. The list is sorted in alphabetical order.

Returns:

list of all currently pressed chars as lowercase strings in a list

See Also:

processing key reference page, Processing keyCode reference

getAllDownCodes

public static java.util.List<java.lang.Integer> getAllDownCodes()

Gets all currently pressed keys as integer keyCodes in a list. Includes all standard chars as well as special keys like CTRL and DELETE, which you can compare with processing constants or com.jogamp.newt.event.KeyEvent int constants. The list is sorted in natural ascending order.

Returns:

list of all currently pressed keys as integer keyCodes

See Also:

processing keyCode reference page

debugPrintKeyEvents

public static void debugPrintKeyEvents(boolean shouldDebugKeys)

Prints all newly received key events to console when this is set to true until manually set to false. False by default to not clutter the console.

Parameters:

shouldDebugKeys - should the InputWatcher print all the key events it receives to console?

mousePos

public static processing.core.PVector mousePos()

Get the current mouseX and mouseY as a PVector.

Returns:

a PVector with the current mouse position

mousePosLastFrame

public static processing.core.PVector mousePosLastFrame()

Get pmouseX and pmouseY as a PVector describing the last frame's mouse position. This vector plus mouseDelta() should equal the current mousePos()

Returns:

a PVector with the previous frame's mouse position

mouseDelta

public static processing.core.PVector mouseDelta()

Gets the difference between current frame mouse position and previous frame mouse position as a PVector. This is equivalent to new PVector(app.mouseX - app.pmouseX, app.mouseY - app.pmouseY);

Returns:

a PVector with the difference between the last known mouse position and the current one