Package com.csse3200.game.input

Class InputComponent

java.lang.Object
com.csse3200.game.components.Component
com.csse3200.game.input.InputComponent
All Implemented Interfaces:
com.badlogic.gdx.input.GestureDetector.GestureListener, com.badlogic.gdx.InputProcessor
Direct Known Subclasses:
ArrowKeysPlayerInputComponent, BaseTerminalInputComponent, InputDecorator, KeyboardPlayerInputComponent, ShopInteractComponent, TouchPlayerInputComponent
public abstract class InputComponent extends Component implements com.badlogic.gdx.InputProcessor, com.badlogic.gdx.input.GestureDetector.GestureListener
An InputComponent that supports keyboard and touch input and touch gestures. By default an InputComponent does not handle any input events.

Subclasses of InputComponent should override relevant methods to handle input. Ensure the priority is set in the subclass' constructor.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    priority
    The priority that the input handler is visited in by InputService.

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

    enabled, entity, prio

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    InputComponent()
    Sets priority to the default value;
    protected
    InputComponent(int priority)
    Sets input handler priority to a given value.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    create()
    Called when the entity is created and registered.
    void
    dispose()
    Called when the component is disposed.
    boolean
    fling(float velocityX, float velocityY, int button)
     
    int
    getPriority()
     
    protected boolean
    isPauseable()
    Returns True as this component is pausable.
    boolean
    keyDown(int keycode)
    Handles key down events from the game engine.
    protected abstract boolean
    keyPressed(int keycode)
    An abstract method to be implemented by subclasses for specific key down events.
    protected abstract boolean
    keyReleased(int keycode)
    An abstract method to be implemented by subclasses for specific key down events.
    boolean
    keyTyped(char character)
     
    boolean
    keyUp(int keycode)
    Handles the key up events from the game engine.
    boolean
    longPress(float x, float y)
     
    boolean
    mouseMoved(int screenX, int screenY)
     
    boolean
    pan(float x, float y, float deltaX, float deltaY)
     
    boolean
    panStop(float x, float y, int pointer, int button)
     
    boolean
    pinch(com.badlogic.gdx.math.Vector2 initialPointer1, com.badlogic.gdx.math.Vector2 initialPointer2, com.badlogic.gdx.math.Vector2 pointer1, com.badlogic.gdx.math.Vector2 pointer2)
     
    void
    pinchStop()
     
    boolean
    pinchStopHandled()
    Wrapper for pinch stop that can be overridden.
    boolean
    scrolled(float amountX, float amountY)
     
    void
    setPriority(int priority)
     
    boolean
    tap(float x, float y, int count, int button)
     
    boolean
    touchDown(float x, float y, int pointer, int button)
     
    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)
     
    boolean
    zoom(float initialDistance, float distance)
     

    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

  • Field Details

    • priority

      protected int priority
      The priority that the input handler is visited in by InputService.

  • Constructor Details

    • InputComponent

      protected InputComponent()
      Sets priority to the default value;

    • InputComponent

      protected InputComponent(int priority)
      Sets input handler priority to a given value.
      Parameters:
      priority - input handler's priority

  • Method Details

    • create

      public void create()
      Description copied from class: Component
      Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.
      Overrides:
      create in class Component

    • setPriority

      public void setPriority(int priority)

    • getPriority

      public int getPriority()

    • dispose

      public void dispose()
      Description copied from class: Component
      Called when the component is disposed. Dispose of any internal resources here.
      Overrides:
      dispose in class Component

    • isPauseable

      protected boolean isPauseable()
      Returns True as this component is pausable.
      Returns:
      True if the component is not pauseable, False if it is

    • keyDown

      public boolean keyDown(int keycode)
      Handles key down events from the game engine. This is final to ensure the logic is inherited by all children while delegating specific key handling to the keyPressed(int) method.
      Specified by:
      keyDown in interface com.badlogic.gdx.InputProcessor
      Parameters:
      keycode - one of the constants in Input.Keys
      Returns:
      true if the even was handled, false otherwise

    • keyPressed

      protected abstract boolean keyPressed(int keycode)
      An abstract method to be implemented by subclasses for specific key down events. This method is called by the keyDown(int) method.
      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
      See Also:
      • InputProcessor.keyTyped(char)

    • keyUp

      public boolean keyUp(int keycode)
      Handles the key up events from the game engine. This is final to ensure that the logic is inherited by all the children while delegating specific key handling to the keyReleased(int) method.
      Specified by:
      keyUp in interface com.badlogic.gdx.InputProcessor
      Parameters:
      keycode - one of the constants in Input.Keys
      Returns:
      true if the even was handled, false otherwise

    • keyReleased

      protected abstract boolean keyReleased(int keycode)
      An abstract method to be implemented by subclasses for specific key down events. This method is called by the keyUp(int) method.
      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
      See Also:
      • InputProcessor.mouseMoved(int, int)

    • scrolled

      public boolean scrolled(float amountX, float amountY)
      Specified by:
      scrolled in interface com.badlogic.gdx.InputProcessor
      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
      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
      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
      See Also:
      • InputProcessor.touchUp(int, int, int, int)

    • fling

      public boolean fling(float velocityX, float velocityY, int button)
      Specified by:
      fling in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.fling(float, float, int)

    • longPress

      public boolean longPress(float x, float y)
      Specified by:
      longPress in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.longPress(float, float)

    • pan

      public boolean pan(float x, float y, float deltaX, float deltaY)
      Specified by:
      pan in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.pan(float, float, float, float)

    • panStop

      public boolean panStop(float x, float y, int pointer, int button)
      Specified by:
      panStop in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.panStop(float, float, int, int)

    • pinch

      public boolean pinch(com.badlogic.gdx.math.Vector2 initialPointer1, com.badlogic.gdx.math.Vector2 initialPointer2, com.badlogic.gdx.math.Vector2 pointer1, com.badlogic.gdx.math.Vector2 pointer2)
      Specified by:
      pinch in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.pinch(Vector2, Vector2, Vector2, Vector2)

    • pinchStop

      public void pinchStop()
      Specified by:
      pinchStop in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.pinchStop()

    • pinchStopHandled

      public boolean pinchStopHandled()
      Wrapper for pinch stop that can be overridden. This was created because the pinchStop() doesn't have a return value.
      Returns:
      whether the input was processed

    • tap

      public boolean tap(float x, float y, int count, int button)
      Specified by:
      tap in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.tap(float, float, int, int)

    • touchDown

      public boolean touchDown(float x, float y, int pointer, int button)
      Specified by:
      touchDown in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.touchDown(float, float, int, int)

    • zoom

      public boolean zoom(float initialDistance, float distance)
      Specified by:
      zoom in interface com.badlogic.gdx.input.GestureDetector.GestureListener
      See Also:
      • GestureDetector.GestureListener.zoom(float, float)