de.gurkenlabs.litiengine.input

Class Gamepad

java.lang.Object

de.gurkenlabs.litiengine.input.Gamepad

All Implemented Interfaces:

GamepadEvents, IUpdateable

public final class Gamepad
extends java.lang.Object
implements GamepadEvents, IUpdateable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gamepad.Axis
static class	Gamepad.Buttons
static class	Gamepad.DPad
static class	Gamepad.Xbox

Nested classes/interfaces inherited from interface de.gurkenlabs.litiengine.input.GamepadEvents

GamepadEvents.GamepadPollListener, GamepadEvents.GamepadPressedListener, GamepadEvents.GamepadReleasedListener

Method Summary

Modifier and Type	Method and Description
void	clearEventListeners() Removes all registered event listeners from the Gamepad instance.
protected static net.java.games.input.Component.Identifier	get(java.lang.String name)
float	getAxisDeadzone()
int	getIndex()
java.lang.String	getName()
protected float	getPollData(net.java.games.input.Component.Identifier identifier)
float	getPollData(java.lang.String component)
float	getTriggerDeadzone()
boolean	isPressed(java.lang.String gamepadComponent) Determines whether the specified Gamepad component is currently pressed.
void	onPoll(GamepadEvents.GamepadPollListener listener) Adds the specified gamepad poll listener to receive events when any component has been polled.
void	onPoll(java.lang.String identifier, GamepadEvents.GamepadPollListener listener) Adds the specified gamepad poll listener to receive events when the component with the defined identifier has been polled.
void	onPressed(GamepadEvents.GamepadPressedListener listener) Adds the specified gamepad pressed listener to receive events when any component has been pressed.
void	onPressed(java.lang.String identifier, GamepadEvents.GamepadPressedListener listener) Adds the specified gamepad pressed listener to receive events when the component with the defined identifier has been pressed.
void	onReleased(GamepadEvents.GamepadReleasedListener listener) Adds the specified gamepad released listener to receive events when any component has been released.
void	onReleased(java.lang.String identifier, GamepadEvents.GamepadReleasedListener listener) Adds the specified gamepad released listener to receive events when the component with the defined identifier has been released.
void	removePollListener(GamepadEvents.GamepadPollListener listener) Unregister the specified poll listener from gamepad events.
void	removePollListener(java.lang.String identifier, GamepadEvents.GamepadPollListener listener) Unregister the specified poll listener from gamepad events.
void	removePressedListener(GamepadEvents.GamepadPressedListener listener) Unregister the specified pressed listener from gamepad events.
void	removePressedListener(java.lang.String identifier, GamepadEvents.GamepadPressedListener listener) Unregister the specified pressed listener from gamepad events.
void	removeReleasedListener(GamepadEvents.GamepadReleasedListener listener) Unregister the specified released listener from gamepad events.
void	removeReleasedListener(java.lang.String identifier, GamepadEvents.GamepadReleasedListener listener) Unregister the specified released listener from gamepad events.
void	setAxisDeadzone(float gamepadAxisDeadzone)
void	setTriggerDeadzone(float gamepadTriggerDeadzone)
java.lang.String	toString()
void	update() This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class java.lang.Object

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

Method Detail

getIndex

public int getIndex()

getName

public java.lang.String getName()

getPollData

public float getPollData(java.lang.String component)

getAxisDeadzone

public float getAxisDeadzone()

getTriggerDeadzone

public float getTriggerDeadzone()

onPoll

public void onPoll(java.lang.String identifier,
                   GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad poll listener to receive events when the component with the defined identifier has been polled.

Specified by:

onPoll in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

listener - The listener to add.

removePollListener

public void removePollListener(java.lang.String identifier,
                               GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Unregister the specified poll listener from gamepad events.

Specified by:

removePollListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onPressed

public void onPressed(java.lang.String identifier,
                      GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad pressed listener to receive events when the component with the defined identifier has been pressed.

Specified by:

onPressed in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

listener - The listener to add.

removePressedListener

public void removePressedListener(java.lang.String identifier,
                                  GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified pressed listener from gamepad events.

Specified by:

removePressedListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onReleased

public void onReleased(java.lang.String identifier,
                       GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad released listener to receive events when the component with the defined identifier has been released.

Specified by:

onReleased in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

listener - The listener to add.

removeReleasedListener

public void removeReleasedListener(java.lang.String identifier,
                                   GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified released listener from gamepad events.

Specified by:

removeReleasedListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onPoll

public void onPoll(GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad poll listener to receive events when any component has been polled.

Specified by:

onPoll in interface GamepadEvents

Parameters:

listener - The listener to add.

removePollListener

public void removePollListener(GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Unregister the specified poll listener from gamepad events.

Specified by:

removePollListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

onPressed

public void onPressed(GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad pressed listener to receive events when any component has been pressed.

Specified by:

onPressed in interface GamepadEvents

Parameters:

listener - The listener to add.

removePressedListener

public void removePressedListener(GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified pressed listener from gamepad events.

Specified by:

removePressedListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

onReleased

public void onReleased(GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad released listener to receive events when any component has been released.

Specified by:

onReleased in interface GamepadEvents

Parameters:

listener - The listener to add.

removeReleasedListener

public void removeReleasedListener(GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified released listener from gamepad events.

Specified by:

removeReleasedListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

clearEventListeners

public void clearEventListeners()

Description copied from interface: GamepadEvents

Removes all registered event listeners from the Gamepad instance.

Specified by:

clearEventListeners in interface GamepadEvents

isPressed

public boolean isPressed(java.lang.String gamepadComponent)

Description copied from interface: GamepadEvents

Determines whether the specified Gamepad component is currently pressed. This is useful for button type components.

Specified by:

isPressed in interface GamepadEvents

Parameters:

gamepadComponent - The component to check against.

Returns:

True if the component is pressed, otherwise false.

See Also:

Gamepad.Buttons, Gamepad.Xbox

setAxisDeadzone

public void setAxisDeadzone(float gamepadAxisDeadzone)

setTriggerDeadzone

public void setTriggerDeadzone(float gamepadTriggerDeadzone)

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

ClientConfiguration.setMaxFps(int)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPollData

protected float getPollData(net.java.games.input.Component.Identifier identifier)

get

protected static final net.java.games.input.Component.Identifier get(java.lang.String name)