Interface IGamepadMappings

All Known Implementing Classes:
AbstractGamepadMappings, GamepadMappings
public interface IGamepadMappings
Interface that defines an API that maps physical actions to gamepad input codes.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAxisDpadH()
    Returns the code of the horizontal dpad axis, if exists
    int
    getAxisDpadV()
    Returns the code of the vertical dpad axis, if exists
    int
    getAxisLB()
    Returns the code of the left bumper axis, used to increase the velocity.
    int
    getAxisLstickH()
    Returns the code of the left stick horizontal axis, that produces: Roll rotation in focus mode Horizontal lateral movement in free mode
    double
    getAxisLstickHSensitivity()
    Sensitivity of left stick axis.
    int
    getAxisLstickV()
    Returns the code of the left stick vertical axis, that controls the forward and backward movement
    double
    getAxisLstickVSensitivity()
    Sensitivity of left stick vertical axis
    int
    getAxisLT()
    Returns the code of the left trigger axis, used to decrease the velocity.
    double
    getAxisLTSensitivity()
    Gets the sensitivity of the left trigger.
    int
    getAxisRB()
    Returns the code of the right bumper axis, used to increase the velocity.
    int
    getAxisRstickH()
    Returns the code of the Right stick horizontal axis, that produces: Vertical rotation around focus in focus mode Vertical look rotation (pitch) in free mode
    double
    getAxisRstickHSensitivity()
    Sensitivity of pitch axis.
    int
    getAxisRstickV()
    Returns the code of the right stick vertical axis, that produces: Horizontal rotation around focus in focus mode Horizontal look rotation (yaw) in free mode
    double
    getAxisRstickVSensitivity()
    Sensitivity of right stick vertical axis.
    int
    getAxisRT()
    Returns the code of the right trigger axis, used to increase the velocity.
    double
    getAxisRTSensitivity()
    Gets the sensitivity of the right trigger.
    double
    getAxisValuePower()
    Power to apply to the linear value: val = val^pow
    int
    getButtonA()
    Returns the code of the A button
    int
    getButtonB()
    Returns the code of the B button
    int
    getButtonDpadDown()
    Returns the code of the dpad-down button
    int
    getButtonDpadLeft()
    Returns the code of the dpad-left button
    int
    getButtonDpadRight()
    Returns the code of the dpad-right button
    int
    getButtonDpadUp()
    Returns the code of the dpad-up button
    int
    getButtonLB()
    Returns the code of the LB button
    int
    getButtonLstick()
    Returns the code of the left stick button
    int
    getButtonLT()
    Returns the code of the LT button
    int
    getButtonRB()
    Returns the code of the RB button
    int
    getButtonRstick()
    Returns the code of the right stick button
    int
    getButtonRT()
    Returns the code of the RT button
    int
    getButtonSelect()
    Returns the code of the select button
    int
    getButtonStart()
    Returns the code of the start button
    int
    getButtonX()
    Returns the code of the X button
    int
    getButtonY()
    Returns the code of the Y button
    double
    getZeroPoint()
    The configured axis zero point.

  • Method Details

    • getZeroPoint

      double getZeroPoint()
      The configured axis zero point. Axis values below this value are considered zero.
      Returns:
      The zero point.

    • getAxisValuePower

      double getAxisValuePower()
      Power to apply to the linear value: val = val^pow
      Returns:
      The configured value power.

    • getAxisLstickH

      int getAxisLstickH()
      Returns the code of the left stick horizontal axis, that produces:
      • Roll rotation in focus mode
      • Horizontal lateral movement in free mode
      Returns:
      The axis code, negative if not mapped.

    • getAxisLstickHSensitivity

      double getAxisLstickHSensitivity()
      Sensitivity of left stick axis.
      Returns:
      The sensitivity.

    • getAxisRstickH

      int getAxisRstickH()
      Returns the code of the Right stick horizontal axis, that produces:
      • Vertical rotation around focus in focus mode
      • Vertical look rotation (pitch) in free mode
      Returns:
      The axis code, negative if not mapped.

    • getAxisRstickHSensitivity

      double getAxisRstickHSensitivity()
      Sensitivity of pitch axis.
      Returns:
      The sensitivity.

    • getAxisRstickV

      int getAxisRstickV()
      Returns the code of the right stick vertical axis, that produces:
      • Horizontal rotation around focus in focus mode
      • Horizontal look rotation (yaw) in free mode
      Returns:
      The axis code, negative if not mapped.

    • getAxisRstickVSensitivity

      double getAxisRstickVSensitivity()
      Sensitivity of right stick vertical axis.
      Returns:
      The sensitivity of the right stick.

    • getAxisLstickV

      int getAxisLstickV()
      Returns the code of the left stick vertical axis, that controls the forward and backward movement
      Returns:
      The axis code, negative if not mapped.

    • getAxisLstickVSensitivity

      double getAxisLstickVSensitivity()
      Sensitivity of left stick vertical axis

    • getAxisRB

      int getAxisRB()
      Returns the code of the right bumper axis, used to increase the velocity. All the range of the axis is used.
      Returns:
      The axis code, negative if not mapped.

    • getAxisLB

      int getAxisLB()
      Returns the code of the left bumper axis, used to increase the velocity. All the range of the axis is used.
      Returns:
      The axis code, negative if not mapped.

    • getAxisRT

      int getAxisRT()
      Returns the code of the right trigger axis, used to increase the velocity. All the range of the axis is used. Usually mapped to a trigger button.
      Returns:
      The axis code, negative if not mapped.

    • getAxisRTSensitivity

      double getAxisRTSensitivity()
      Gets the sensitivity of the right trigger.
      Returns:
      The sensitivity of the right trigger (RT) axis.

    • getAxisLT

      int getAxisLT()
      Returns the code of the left trigger axis, used to decrease the velocity. All the range of the axis is used. Usually mapped to a trigger button.
      Returns:
      The axis code, negative if not mapped.

    • getAxisLTSensitivity

      double getAxisLTSensitivity()
      Gets the sensitivity of the left trigger.
      Returns:
      The sensitivity of the left trigger (LT) axis.

    • getButtonY

      int getButtonY()
      Returns the code of the Y button
      Returns:
      The Y button code, negative if not mapped.

    • getButtonX

      int getButtonX()
      Returns the code of the X button
      Returns:
      The X button code, negative if not mapped.

    • getButtonA

      int getButtonA()
      Returns the code of the A button
      Returns:
      The A button code, negative if not mapped.

    • getButtonB

      int getButtonB()
      Returns the code of the B button
      Returns:
      The B button code, negative if not mapped.

    • getAxisDpadH

      int getAxisDpadH()
      Returns the code of the horizontal dpad axis, if exists
      Returns:
      Horizontal dpad axis code

    • getAxisDpadV

      int getAxisDpadV()
      Returns the code of the vertical dpad axis, if exists
      Returns:
      Vertical dpad axis code

    • getButtonDpadUp

      int getButtonDpadUp()
      Returns the code of the dpad-up button
      Returns:
      The dpad-up button code, negative if not mapped.

    • getButtonDpadDown

      int getButtonDpadDown()
      Returns the code of the dpad-down button
      Returns:
      The dpad-down button code, negative if not mapped.

    • getButtonDpadLeft

      int getButtonDpadLeft()
      Returns the code of the dpad-left button
      Returns:
      The dpad-left button code, negative if not mapped.

    • getButtonDpadRight

      int getButtonDpadRight()
      Returns the code of the dpad-right button
      Returns:
      The dpad-right button code, negative if not mapped.

    • getButtonLstick

      int getButtonLstick()
      Returns the code of the left stick button
      Returns:
      The left stick button code, negative if not mapped.

    • getButtonRstick

      int getButtonRstick()
      Returns the code of the right stick button
      Returns:
      The right stick button code, negative if not mapped.

    • getButtonStart

      int getButtonStart()
      Returns the code of the start button
      Returns:
      The start button code, negative if not mapped.

    • getButtonSelect

      int getButtonSelect()
      Returns the code of the select button
      Returns:
      The select button code, negative if not mapped.

    • getButtonRT

      int getButtonRT()
      Returns the code of the RT button
      Returns:
      The RT button code, negative if not mapped.

    • getButtonRB

      int getButtonRB()
      Returns the code of the RB button
      Returns:
      The RB button code, negative if not mapped.

    • getButtonLT

      int getButtonLT()
      Returns the code of the LT button
      Returns:
      The LT button code, negative if not mapped.

    • getButtonLB

      int getButtonLB()
      Returns the code of the LB button
      Returns:
      The LB button code, negative if not mapped.