net.stemkoski.bagel

Class Input

java.lang.Object

net.stemkoski.bagel.Input

public class Input
extends java.lang.Object

A structure for storing and updating the state of hardware input devices (keyboard and mouse). Handles key down/press/up events, mouse down/up events, and mouse position.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.ArrayList<java.lang.String>	keyDownList
(package private) java.util.ArrayList<java.lang.String>	keyDownQueue
(package private) java.util.ArrayList<java.lang.String>	keyPressedList
(package private) java.util.ArrayList<java.lang.String>	keyUpList
(package private) java.util.ArrayList<java.lang.String>	keyUpQueue
(package private) boolean	mouseButtonDown
(package private) boolean	mouseButtonDownQueue
(package private) boolean	mouseButtonUp
(package private) boolean	mouseButtonUpQueue
(package private) double	mouseX
(package private) double	mouseY

Constructor Summary

Constructors

Constructor and Description
Input(javafx.scene.Scene listeningScene) Initialize object and activate event listeners.

Method Summary

Modifier and Type	Method and Description
Vector2	getMousePosition() Return current position of mouse on game canvas.
boolean	isClicked(Sprite sprite) Determine if (any) mouse button has recently been pressed while mouse cursor position is contained with bounding area of a sprite.
boolean	isKeyDown(java.lang.String keyName) Determine if key has been pressed / moved to down position (a discrete action).
boolean	isKeyPressed(java.lang.String keyName) Determine if key is currently being pressed / held down (a continuous action).
boolean	isKeyUp(java.lang.String keyName) Determine if key has been released / returned to up position (a discrete action).
boolean	isMouseButtonDown() Determine if (any) mouse button has been pressed / moved to down position.
boolean	isMouseButtonUp() Determine if (any) mouse button has been released / returned to up position.
(package private) void	update() Update state information for keyboard and mouse.

Methods inherited from class java.lang.Object

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

Field Detail

keyDownQueue

java.util.ArrayList<java.lang.String> keyDownQueue

keyUpQueue

java.util.ArrayList<java.lang.String> keyUpQueue

keyDownList

java.util.ArrayList<java.lang.String> keyDownList

keyPressedList

java.util.ArrayList<java.lang.String> keyPressedList

keyUpList

java.util.ArrayList<java.lang.String> keyUpList

mouseButtonDownQueue

boolean mouseButtonDownQueue

mouseButtonUpQueue

boolean mouseButtonUpQueue

mouseButtonDown

boolean mouseButtonDown

mouseButtonUp

boolean mouseButtonUp

mouseX

double mouseX

mouseY

double mouseY

Constructor Detail

Input

Input(javafx.scene.Scene listeningScene)

Initialize object and activate event listeners.

Parameters:

listeningScene - the window Scene that has focus during the game

Method Detail

isKeyDown

public boolean isKeyDown(java.lang.String keyName)

Determine if key has been pressed / moved to down position (a discrete action).

Parameters:

keyName - name of corresponding key (examples: "LEFT", "A", "DIGIT1", "SPACE", "SHIFT")

Returns:

true if key was just pressed

isKeyPressed

public boolean isKeyPressed(java.lang.String keyName)

Determine if key is currently being pressed / held down (a continuous action).

Parameters:

keyName - name of corresponding key (examples: "LEFT", "A", "DIGIT1", "SPACE", "SHIFT")

Returns:

true if key is currently pressed

isKeyUp

public boolean isKeyUp(java.lang.String keyName)

Determine if key has been released / returned to up position (a discrete action).

Parameters:

keyName - name of corresponding key (examples: "LEFT", "A", "DIGIT1", "SPACE", "SHIFT")

Returns:

true if key was just released

getMousePosition

public Vector2 getMousePosition()

Return current position of mouse on game canvas.

Returns:

current position of mouse

isMouseButtonDown

public boolean isMouseButtonDown()

Determine if (any) mouse button has been pressed / moved to down position.

Returns:

true if mouse button was just pressed

isMouseButtonUp

public boolean isMouseButtonUp()

Determine if (any) mouse button has been released / returned to up position.

Returns:

true if mouse button was just released

isClicked

public boolean isClicked(Sprite sprite)

Determine if (any) mouse button has recently been pressed while mouse cursor position is contained with bounding area of a sprite.

Parameters:

sprite - Sprite to check if clicked by mouse

Returns:

true if the mouse has clicked on the sprite

update

void update()

Update state information for keyboard and mouse. Automatically called by Game class during the game loop.