Package com.csse3200.game.input

Class InputDecorator

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.input.InputComponent

com.csse3200.game.input.InputDecorator

All Implemented Interfaces:

com.badlogic.gdx.input.GestureDetector.GestureListener, com.badlogic.gdx.InputProcessor

public class InputDecorator
extends InputComponent

Generic class to wrap an InputProcessor so that it acts like an InputComponent. This was initially created to wrap the stage in, but can be used for any class that implements InputProcessor.

Field Summary

Fields inherited from class com.csse3200.game.input.InputComponent

priority

Fields inherited from class com.csse3200.game.components.Component

enabled, entity, prio

Constructor Summary

Constructors

Constructor	Description
InputDecorator(com.badlogic.gdx.InputProcessor inputProcessor, int priority)

Method Summary

Modifier and Type	Method	Description
boolean	keyPressed(int keycode)	An abstract method to be implemented by subclasses for specific key down events.
boolean	keyReleased(int keycode)	An abstract method to be implemented by subclasses for specific key down events.
boolean	keyTyped(char character)
boolean	mouseMoved(int screenX, int screenY)
boolean	scrolled(float amountX, float amountY)
boolean	touchDown(int screenX, int screenY, int pointer, int button)
boolean	touchDragged(int screenX, int screenY, int pointer)
boolean	touchUp(int screenX, int screenY, int pointer, int button)

Methods inherited from class com.csse3200.game.input.InputComponent

create, dispose, fling, getPriority, isPauseable, keyDown, keyUp, longPress, pan, panStop, pinch, pinchStop, pinchStopHandled, setPriority, tap, touchDown, zoom

Methods inherited from class com.csse3200.game.components.Component

earlyUpdate, getEntity, getPrio, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

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

Constructor Details

InputDecorator

public InputDecorator(com.badlogic.gdx.InputProcessor inputProcessor,
 int priority)

Method Details

keyPressed

public boolean keyPressed(int keycode)

Description copied from class: InputComponent

An abstract method to be implemented by subclasses for specific key down events. This method is called by the InputComponent.keyDown(int) method.

Specified by:

keyPressed in class InputComponent

Parameters:

keycode - The key code of the key that was pressed.

Returns:

true if the even was handled, false otherwise

keyTyped

public boolean keyTyped(char character)

Specified by:

keyTyped in interface com.badlogic.gdx.InputProcessor

Overrides:

keyTyped in class InputComponent

See Also:

• InputProcessor.keyTyped(char)

keyReleased

public boolean keyReleased(int keycode)

Description copied from class: InputComponent

An abstract method to be implemented by subclasses for specific key down events. This method is called by the InputComponent.keyUp(int) method.

Specified by:

keyReleased in class InputComponent

Parameters:

keycode - The key code of the key that was pressed.

Returns:

True if the even was handled, false otherwise

mouseMoved

public boolean mouseMoved(int screenX,
 int screenY)

Specified by:

mouseMoved in interface com.badlogic.gdx.InputProcessor

Overrides:

mouseMoved in class InputComponent

See Also:

• InputProcessor.mouseMoved(int, int)

scrolled

public boolean scrolled(float amountX,
 float amountY)

Specified by:

scrolled in interface com.badlogic.gdx.InputProcessor

Overrides:

scrolled in class InputComponent

See Also:

• InputProcessor.scrolled(float, float)

touchDown

public boolean touchDown(int screenX,
 int screenY,
 int pointer,
 int button)

Specified by:

touchDown in interface com.badlogic.gdx.InputProcessor

Overrides:

touchDown in class InputComponent

See Also:

• InputProcessor.touchDown(int, int, int, int)

touchDragged

public boolean touchDragged(int screenX,
 int screenY,
 int pointer)

Specified by:

touchDragged in interface com.badlogic.gdx.InputProcessor

Overrides:

touchDragged in class InputComponent

See Also:

• InputProcessor.touchDragged(int, int, int)

touchUp

public boolean touchUp(int screenX,
 int screenY,
 int pointer,
 int button)

Specified by:

touchUp in interface com.badlogic.gdx.InputProcessor

Overrides:

touchUp in class InputComponent

See Also:

• InputProcessor.touchUp(int, int, int, int)