Input (com.github.almasb:fxgl 0.2.9 API)

All Superinterfaces:

FXGLListener, UpdateEventListener, UserProfileSavable
```
public interface Input
extends UserProfileSavable, UpdateEventListener, FXGLListener
```
Allows input data queries as well as action bindings.

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addAction(UserAction action, javafx.scene.input.KeyCode key)` Bind given action to a keyboard key.
`void`	`addAction(UserAction action, javafx.scene.input.KeyCode key, InputModifier modifier)` Bind given action to a keyboard key with special modifier key.
`default void`	`addAction(UserAction action, javafx.scene.input.MouseButton button)` Bind given action to a mouse button with special modifier key.
`void`	`addAction(UserAction action, javafx.scene.input.MouseButton button, InputModifier modifier)` Bind given action to a mouse button with special modifier key.
`void`	`addInputMapping(InputMapping mapping)` Add input mapping.
`void`	`clearAll()` Clears all active actions.
`Map<UserAction,Trigger>`	`getBindings()`
`javafx.geometry.Point2D`	`getMousePositionUI()`
`javafx.geometry.Point2D`	`getMousePositionWorld()`
`default double`	`getMouseXUI()`
`default double`	`getMouseXWorld()`
`default double`	`getMouseYUI()`
`default double`	`getMouseYWorld()`
`default javafx.geometry.Point2D`	`getVectorFromMouse(javafx.geometry.Point2D gamePosition)`
`default javafx.geometry.Point2D`	`getVectorToMouse(javafx.geometry.Point2D gamePosition)`
`boolean`	`isHeld(javafx.scene.input.KeyCode key)`
`boolean`	`isHeld(javafx.scene.input.MouseButton button)`
`boolean`	`isProcessInput()`
`boolean`	`isRegisterInput()`
`default void`	`mockButtonPress(javafx.scene.input.MouseButton button)` Mocks button press event.
`default void`	`mockButtonPress(javafx.scene.input.MouseButton button, double gameX, double gameY)` Mocks button press event.
`void`	`mockButtonPress(javafx.scene.input.MouseButton button, double gameX, double gameY, InputModifier modifier)` Mocks button press event.
`default void`	`mockButtonPress(javafx.scene.input.MouseButton button, InputModifier modifier)` Mocks button press event.
`default void`	`mockButtonRelease(javafx.scene.input.MouseButton button)` Mocks button release event.
`default void`	`mockButtonRelease(javafx.scene.input.MouseButton button, double gameX, double gameY)` Mocks button release event.
`void`	`mockButtonRelease(javafx.scene.input.MouseButton button, double gameX, double gameY, InputModifier modifier)` Mocks button release event.
`default void`	`mockButtonRelease(javafx.scene.input.MouseButton button, InputModifier modifier)` Mocks button release event.
`default void`	`mockKeyPress(javafx.scene.input.KeyCode key)` Mocks key press event.
`void`	`mockKeyPress(javafx.scene.input.KeyCode key, InputModifier modifier)` Mocks key press event.
`default void`	`mockKeyRelease(javafx.scene.input.KeyCode key)` Mocks key release event.
`void`	`mockKeyRelease(javafx.scene.input.KeyCode key, InputModifier modifier)` Mocks key release event.
`default void`	`onExit()` Fired before the system is about to shut down.
`void`	`onKeyEvent(javafx.scene.input.KeyEvent event)` Called on key event.
`void`	`onMouseEvent(javafx.scene.input.MouseEvent event, Viewport viewport, double scaleRatio)` Called on mouse event.
`default void`	`onPause()` Fired on main loop paused.
`default void`	`onReset()` Fired on FXGL reset.
`default void`	`onResume()` Fired on main loop resumed.
`default boolean`	`rebind(UserAction action, javafx.scene.input.KeyCode key)` Rebinds an existing action to given key.
`boolean`	`rebind(UserAction action, javafx.scene.input.KeyCode key, InputModifier modifier)` Rebinds an existing action to given key.
`default boolean`	`rebind(UserAction action, javafx.scene.input.MouseButton button)` Rebinds an action to given mouse button.
`boolean`	`rebind(UserAction action, javafx.scene.input.MouseButton button, InputModifier modifier)` Rebinds an action to given mouse button.
`void`	`scanForUserActions(Object instance)` Given an object, scans its methods for `OnUserAction` annotation and creates UserActions from its data.
`void`	`setProcessInput(boolean process)` Setting to false will disable processing of input events.
`void`	`setRegisterInput(boolean register)` Setting to false will disable capturing of input events.

Methods inherited from interface com.almasb.fxgl.settings.UserProfileSavable
load, save

Methods inherited from interface com.almasb.fxgl.time.UpdateEventListener
onUpdateEvent

- Method Detail
  - onPause
```
default void onPause()
```
    Description copied from interface: FXGLListener
    
    Fired on main loop paused.
    
    Specified by:
    
    onPause in interface FXGLListener
  - onResume
```
default void onResume()
```
    Description copied from interface: FXGLListener
    
    Fired on main loop resumed.
    
    Specified by:
    
    onResume in interface FXGLListener
  - onReset
```
default void onReset()
```
    Description copied from interface: FXGLListener
    
    Fired on FXGL reset. This is where all resources should be freed if they are no longer used.
    
    Specified by:
    
    onReset in interface FXGLListener
  - onExit
```
default void onExit()
```
    Description copied from interface: FXGLListener
    
    Fired before the system is about to shut down. Do NOT make any asynchronous calls as they may not complete.
    
    Specified by:
    
    onExit in interface FXGLListener
  - onKeyEvent
```
void onKeyEvent(javafx.scene.input.KeyEvent event)
```
    Called on key event.
    
    Parameters:
    
    event - key event
  - onMouseEvent
```
void onMouseEvent(javafx.scene.input.MouseEvent event,
                  Viewport viewport,
                  double scaleRatio)
```
    Called on mouse event.
    
    Parameters:
    
    event - mouse event
    
    viewport - current viewport where the even occurred
    
    scaleRatio - scale ratio of the display where the event occurred
  - setRegisterInput
```
void setRegisterInput(boolean register)
```
    Setting to false will disable capturing of input events. Not captured events will not be processed.
    
    Parameters:
    
    register - true to enable, false to disable
    
    Default Value:
    
    true
  - isRegisterInput
```
boolean isRegisterInput()
```
    Returns:
    
    are input events being registered
  - setProcessInput
```
void setProcessInput(boolean process)
```
    Setting to false will disable processing of input events. The events may still be captured but they will not be processed.
    
    Parameters:
    
    process - true to enable, false to disable
    
    Default Value:
    
    true
  - isProcessInput
```
boolean isProcessInput()
```
    Returns:
    
    are input events being processed
  - isHeld
```
boolean isHeld(javafx.scene.input.KeyCode key)
```
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true iff key is currently (physically) held; mocking does not trigger this
  - isHeld
```
boolean isHeld(javafx.scene.input.MouseButton button)
```
    Parameters:
    
    button - the button to check
    
    Returns:
    
    true iff button is currently (physically) held; mocking does not trigger this
  - getBindings
```
Map<UserAction,Trigger> getBindings()
```
    Returns:
    
    registered action bindings
  - addAction
```
default void addAction(UserAction action,
                       javafx.scene.input.KeyCode key)
```
    Bind given action to a keyboard key.
    
    Parameters:
    
    action - the action to bind
    
    key - the key
    
    Throws:
    
    IllegalArgumentException - if action with same name exists or key is in use
  - addAction
```
void addAction(UserAction action,
               javafx.scene.input.KeyCode key,
               InputModifier modifier)
```
    Bind given action to a keyboard key with special modifier key.
    
    Parameters:
    
    action - the action to bind
    
    key - the key
    
    modifier - the key modifier
    
    Throws:
    
    IllegalArgumentException - if action with same name exists or key is in use
  - rebind
```
default boolean rebind(UserAction action,
                       javafx.scene.input.KeyCode key)
```
    Rebinds an existing action to given key.
    
    Parameters:
    
    action - the user action
    
    key - the key to rebind to
    
    Returns:
    
    true if rebound, false if action not found or there is another action bound to key
  - rebind
```
boolean rebind(UserAction action,
               javafx.scene.input.KeyCode key,
               InputModifier modifier)
```
    Rebinds an existing action to given key.
    
    Parameters:
    
    action - the user action
    
    key - the key to rebind to
    
    modifier - the key modifier
    
    Returns:
    
    true if rebound, false if action not found or there is another action bound to key
  - addAction
```
default void addAction(UserAction action,
                       javafx.scene.input.MouseButton button)
```
    Bind given action to a mouse button with special modifier key.
    
    Parameters:
    
    action - the action to bind
    
    button - the mouse button
    
    Throws:
    
    IllegalArgumentException - if action with same name exists or button is in use
  - addAction
```
void addAction(UserAction action,
               javafx.scene.input.MouseButton button,
               InputModifier modifier)
```
    Bind given action to a mouse button with special modifier key.
    
    Parameters:
    
    action - the action to bind
    
    button - the mouse button
    
    modifier - the button modifier
    
    Throws:
    
    IllegalArgumentException - if action with same name exists or button is in use
  - rebind
```
default boolean rebind(UserAction action,
                       javafx.scene.input.MouseButton button)
```
    Rebinds an action to given mouse button.
    
    Parameters:
    
    action - the user action
    
    button - the mouse button
    
    Returns:
    
    true if rebound, false if action not found or there is another action bound to mouse button
  - rebind
```
boolean rebind(UserAction action,
               javafx.scene.input.MouseButton button,
               InputModifier modifier)
```
    Rebinds an action to given mouse button.
    
    Parameters:
    
    action - the user action
    
    button - the mouse button
    
    modifier - the buttin modifier
    
    Returns:
    
    true if rebound, false if action not found or there is another action bound to mouse button
  - addInputMapping
```
void addInputMapping(InputMapping mapping)
```
    Add input mapping. The actual implementation needs to be specified by OnUserAction annotation.
    
    Parameters:
    
    mapping - the mapping
  - scanForUserActions
```
void scanForUserActions(Object instance)
```
    Given an object, scans its methods for OnUserAction annotation and creates UserActions from its data.
    
    Parameters:
    
    instance - the class instance to scan
  - clearAll
```
void clearAll()
```
    Clears all active actions. Releases all key presses and mouse clicks for a single frame.
  - mockKeyPress
```
default void mockKeyPress(javafx.scene.input.KeyCode key)
```
    Mocks key press event. The behavior is equivalent to user pressing and holding the key. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    key - the key to mock
  - mockKeyPress
```
void mockKeyPress(javafx.scene.input.KeyCode key,
                  InputModifier modifier)
```
    Mocks key press event. The behavior is equivalent to user pressing and holding the key with the modifier. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    key - the key to mock
    
    modifier - key modifier
  - mockKeyRelease
```
default void mockKeyRelease(javafx.scene.input.KeyCode key)
```
    Mocks key release event. The behavior is equivalent to user releasing the key. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    key - the key to mock
  - mockKeyRelease
```
void mockKeyRelease(javafx.scene.input.KeyCode key,
                    InputModifier modifier)
```
    Mocks key release event. The behavior is equivalent to user releasing the key and the modifier. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    key - the key to mock
    
    modifier - the modifier
  - mockButtonPress
```
default void mockButtonPress(javafx.scene.input.MouseButton button)
```
    Mocks button press event. The behavior is equivalent to user pressing and holding the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    button - the button to mock
  - mockButtonPress
```
default void mockButtonPress(javafx.scene.input.MouseButton button,
                             InputModifier modifier)
```
    Mocks button press event. The behavior is equivalent to user pressing and holding the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    button - the button to mock
    
    modifier - input modifier
  - mockButtonPress
```
default void mockButtonPress(javafx.scene.input.MouseButton button,
                             double gameX,
                             double gameY)
```
    Mocks button press event. The behavior is equivalent to user pressing and holding the button at x, y. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false. This does not affect mouse UI coordinates but affects game world coordinates.
    
    Parameters:
    
    button - the button to mock
    
    gameX - x in game world
    
    gameY - y in game world
  - mockButtonPress
```
void mockButtonPress(javafx.scene.input.MouseButton button,
                     double gameX,
                     double gameY,
                     InputModifier modifier)
```
    Mocks button press event. The behavior is equivalent to user pressing and holding the button and the modifier at x, y. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false. This does not affect mouse UI coordinates but affects game world coordinates.
    
    Parameters:
    
    button - the button to mock
    
    gameX - x in game world
    
    gameY - y in game world
    
    modifier - the modifier
  - mockButtonRelease
```
default void mockButtonRelease(javafx.scene.input.MouseButton button)
```
    Mocks button release event. The behavior is equivalent to user releasing the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    button - the button to mock
  - mockButtonRelease
```
default void mockButtonRelease(javafx.scene.input.MouseButton button,
                               InputModifier modifier)
```
    Mocks button release event. The behavior is equivalent to user releasing the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false.
    
    Parameters:
    
    button - the button to mock
    
    modifier - the modifier
  - mockButtonRelease
```
default void mockButtonRelease(javafx.scene.input.MouseButton button,
                               double gameX,
                               double gameY)
```
    Mocks button release event. The behavior is equivalent to user releasing the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false. This does not affect mouse UI coordinates but affects game world coordinates.
    
    Parameters:
    
    button - the button to mock
    
    gameX - x in game world
    
    gameY - y in game world
  - mockButtonRelease
```
void mockButtonRelease(javafx.scene.input.MouseButton button,
                       double gameX,
                       double gameY,
                       InputModifier modifier)
```
    Mocks button release event. The behavior is equivalent to user releasing the button. Note: the event will be processed directly even if register input is false. The event will NOT be processed if process input is false. This does not affect mouse UI coordinates but affects game world coordinates.
    
    Parameters:
    
    button - the button to mock
    
    gameX - x in game world
    
    gameY - y in game world
    
    modifier - the modifier
  - getMousePositionWorld
```
javafx.geometry.Point2D getMousePositionWorld()
```
    Returns:
    
    cursor point in game coordinate space.
  - getMouseXWorld
```
default double getMouseXWorld()
```
    Returns:
    
    cursor x in game coordinate space.
  - getMouseYWorld
```
default double getMouseYWorld()
```
    Returns:
    
    cursor y in game coordinate space.
  - getMousePositionUI
```
javafx.geometry.Point2D getMousePositionUI()
```
    Returns:
    
    cursor point in screen coordinate space.
  - getMouseXUI
```
default double getMouseXUI()
```
    Returns:
    
    cursor x in screen coordinate space.
  - getMouseYUI
```
default double getMouseYUI()
```
    Returns:
    
    cursor y in screen coordinate space.
  - getVectorToMouse
```
default javafx.geometry.Point2D getVectorToMouse(javafx.geometry.Point2D gamePosition)
```
    Parameters:
    
    gamePosition - point in game world
    
    Returns:
    
    vector from given point to mouse cursor point
  - getVectorFromMouse
```
default javafx.geometry.Point2D getVectorFromMouse(javafx.geometry.Point2D gamePosition)
```
    Parameters:
    
    gamePosition - point in game world
    
    Returns:
    
    vector from mouse cursor point to given point

Interface Input

Method Summary

Methods inherited from interface com.almasb.fxgl.settings.UserProfileSavable

Methods inherited from interface com.almasb.fxgl.time.UpdateEventListener

Method Detail

onPause

onResume

onReset

onExit

onKeyEvent

onMouseEvent

setRegisterInput

isRegisterInput

setProcessInput

isProcessInput

isHeld

isHeld

getBindings

addAction

addAction

rebind

rebind

addAction

addAction

rebind

rebind

addInputMapping

scanForUserActions

clearAll

mockKeyPress

mockKeyPress

mockKeyRelease

mockKeyRelease

mockButtonPress

mockButtonPress

mockButtonPress

mockButtonPress

mockButtonRelease

mockButtonRelease

mockButtonRelease

mockButtonRelease

getMousePositionWorld

getMouseXWorld

getMouseYWorld

getMousePositionUI

getMouseXUI

getMouseYUI

getVectorToMouse

getVectorFromMouse