org.mini2Dx.core.input

Interface GamePad

All Known Implementing Classes:

LibgdxAdvancedGamePad, LibgdxGamePad

public interface GamePad

Common interface for gamepads/controllers/joysticks/etc.

Method Summary

Modifier and Type	Method and Description
void	addListener(GamePadListener listener) Adds a GamePadListener to listen to state changes
org.mini2Dx.gdx.math.Vector3	getAccelerometer(int accelerometerCode) Returns the current accelerometer value
float	getAccelerometerSensitivity() Returns the accelerometer sensitivity
float	getAxis(int axisCode) Returns the current value of an axis
GamePadType	getGamePadType() Returns the GamePadType
java.lang.String	getInstanceId() Returns the ID for this GamePad.
java.lang.String	getModelInfo() Returns the model information present by the hardware/driver (e.g.
int	getPlayerIndex() Returns the player assigned to this gamepad
PovState	getPov(int povCode) Returns the current value of a PoV (Dpad)
float	getVibrationStrength() Returns the strength of the vibration/rumble
boolean	isAccelerometerSupported() Returns if this gamepad has accelerometer functionality
boolean	isButtonDown(int buttonCode) Returns if a specific button is currently pressed down
boolean	isButtonUp(int buttonCode) Returns if a specific button is currently released (not pressed down)
boolean	isConnected() Returns if this GamePad is connected
boolean	isPlayerIndicesSupported() Returns if this game pad supports assigning player numbers to it
boolean	isVibrateSupported() Returns if this gamepad has vibrate/rumble functionality
boolean	isVibrating() Returns if this gamepad is currently vibrating/rumbling
void	removeListener(GamePadListener listener) Removes a GamePadListener
void	setAccelerometerSensitivity(float sensitivity) Sets the accelerometer sensitivity
void	setPlayerIndex(int playerIndex) Sets the player assigned to this gamepad
void	startVibration(float strength) Starts vibrating/rumbling the gamepad
void	stopVibration() Stops the vibrating/rumbling of the gamepad

Method Detail

getGamePadType

GamePadType getGamePadType()

Returns the GamePadType

Returns:

GamePadType.UNKNOWN if unknown

getInstanceId

java.lang.String getInstanceId()

Returns the ID for this GamePad. When supported by the driver, if multiple gamepads are connected each will have a unique instance id. Otherwise, this will fallback for to the name of the device returned by the driver. If a gamepad is unplugged and reconnected, it will have the same ID.

Returns:

The unique ID when possible, otherwise the generic ID

getModelInfo

java.lang.String getModelInfo()

Returns the model information present by the hardware/driver (e.g. Xbox One Wireless Controller)

Returns:

isConnected

boolean isConnected()

Returns if this GamePad is connected

Returns:

False if it has been disconnected/unplugged

isPlayerIndicesSupported

boolean isPlayerIndicesSupported()

Returns if this game pad supports assigning player numbers to it

Returns:

True if supported

getPlayerIndex

int getPlayerIndex()

Returns the player assigned to this gamepad

Returns:

-1 if unassigned

setPlayerIndex

void setPlayerIndex(int playerIndex)

Sets the player assigned to this gamepad

Parameters:

playerIndex - -1 if unassigned

isVibrateSupported

boolean isVibrateSupported()

Returns if this gamepad has vibrate/rumble functionality

Returns:

True if supported

isVibrating

boolean isVibrating()

Returns if this gamepad is currently vibrating/rumbling

Returns:

True if vibrating/rumbling

getVibrationStrength

float getVibrationStrength()

Returns the strength of the vibration/rumble

Returns:

-1f if not vibrating/rumbling

startVibration

void startVibration(float strength)

Starts vibrating/rumbling the gamepad

Parameters:

strength - A value between 0f and 1f

stopVibration

void stopVibration()

Stops the vibrating/rumbling of the gamepad

isButtonDown

boolean isButtonDown(int buttonCode)

Returns if a specific button is currently pressed down

Parameters:

buttonCode - The button code (Note: these may vary per platform)

Returns:

True if pressed down

isButtonUp

boolean isButtonUp(int buttonCode)

Returns if a specific button is currently released (not pressed down)

Parameters:

buttonCode - The button code (Note: these may vary per platform)

Returns:

True if released (not pressed down)

getAxis

float getAxis(int axisCode)

Returns the current value of an axis

Parameters:

axisCode - The axis code (Note: these may vary per platform)

Returns:

The value between -1.0f and 1.0f

getPov

PovState getPov(int povCode)

Returns the current value of a PoV (Dpad)

Parameters:

povCode - The PoV code (Note: these may vary per platform)

Returns:

The current PovState

isAccelerometerSupported

boolean isAccelerometerSupported()

Returns if this gamepad has accelerometer functionality

Returns:

True if supported

getAccelerometer

org.mini2Dx.gdx.math.Vector3 getAccelerometer(int accelerometerCode)

Returns the current accelerometer value

Parameters:

accelerometerCode - The accelerometer code (Note: these may vary per platform)

Returns:

The acceleromter value on 3 axis in m/s^2

getAccelerometerSensitivity

float getAccelerometerSensitivity()

Returns the accelerometer sensitivity

Returns:

The sensitivity where 0.0 is lowest, 1.0 is highest

setAccelerometerSensitivity

void setAccelerometerSensitivity(float sensitivity)

Sets the accelerometer sensitivity

Parameters:

sensitivity - The sensitivity where 0.0 is lowest, 1.0 is highest

addListener

void addListener(GamePadListener listener)

Adds a GamePadListener to listen to state changes

Parameters:

listener - The GamePadListener to add

removeListener

void removeListener(GamePadListener listener)

Removes a GamePadListener

Parameters:

listener - The GamePadListener to remove