org.mini2Dx.ui.gamepad

Class XboxUiInput

java.lang.Object

org.mini2Dx.core.input.xbox.XboxGamePadAdapter

org.mini2Dx.ui.gamepad.XboxUiInput

All Implemented Interfaces:

XboxGamePadListener, GamePadUiInput<XboxButton>

public class XboxUiInput
extends XboxGamePadAdapter
implements GamePadUiInput<XboxButton>

XboxGamePad implementation of GamePadUiInput

Constructor Summary

Constructors

Constructor and Description
XboxUiInput(UiContainer uiContainer)

Method Summary

Modifier and Type	Method and Description
boolean	buttonDown(XboxGamePad controller, XboxButton button) Called when a button is pressed down
boolean	buttonUp(XboxGamePad controller, XboxButton button) Called when a button is released
void	disable() Disables this gamepad input for the UiContainer
void	dispose() Cleans up and de-registers this instance from the associated UiContainer
void	enable() Enables this gamepad input for the UiContainer
boolean	equals(java.lang.Object obj)
XboxButton	getActionButton() Returns the button used to trigger Actionable instances
java.lang.String	getId() Returns the unique id of this GamePadUiInput
int	hashCode()
boolean	isEnabled() Returns if the gamepad input is enabled for the UiContainer
boolean	isNavigateWithDPad() Returns if UiNavigation events should be triggered by the D-PAD
boolean	leftStickXMoved(XboxGamePad controller, float value) Called when left stick moves along its X axis
boolean	leftStickYMoved(XboxGamePad controller, float value) Called when left stick moves along its Y axis
void	setActionButton(XboxButton actionButton) Sets the button used for triggering Actionable instances
void	setDebug(boolean debug)
void	setNavigateWithDPad(boolean navigateWithDPad) Sets if UiNavigation events should be triggered by the D-PAD
void	setStickRepeatTimer(float stickRepeatTimer) Sets the amount of time in seconds before the left stick is considered repeating a navigation direction
void	setStickThreshold(float stickThreshold) Sets the threshold for stick values before the input is considered as a navigation direction press
void	update(float delta) Updates the input for repeating presses

Methods inherited from class org.mini2Dx.core.input.xbox.XboxGamePadAdapter

connected, disconnected, leftTriggerMoved, rightStickXMoved, rightStickYMoved, rightTriggerMoved

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XboxUiInput

public XboxUiInput(UiContainer uiContainer)

Method Detail

update

public void update(float delta)

Description copied from interface: GamePadUiInput

Updates the input for repeating presses

Specified by:

update in interface GamePadUiInput<XboxButton>

Parameters:

delta - The time since the last frame (in seconds)

leftStickXMoved

public boolean leftStickXMoved(XboxGamePad controller,
                               float value)

Description copied from interface: XboxGamePadListener

Called when left stick moves along its X axis

Specified by:

leftStickXMoved in interface XboxGamePadListener

Overrides:

leftStickXMoved in class XboxGamePadAdapter

Parameters:

controller - The gamepad that this event came from

value - ~-1f at left, ~0f at center, ~1f at right (values may never be accurate due to dead zones, apply a DeadZone to the gamepad instance to correct this)

Returns:

True if this event should not propagate to other listeners

leftStickYMoved

public boolean leftStickYMoved(XboxGamePad controller,
                               float value)

Description copied from interface: XboxGamePadListener

Called when left stick moves along its Y axis

Specified by:

leftStickYMoved in interface XboxGamePadListener

Overrides:

leftStickYMoved in class XboxGamePadAdapter

Parameters:

controller - The gamepad that this event came from

value - ~-1f at top, ~0f at center, ~1f at bottom (values may never be accurate due to dead zones, apply a DeadZone to the gamepad instance to correct this)

Returns:

True if this event should not propagate to other listeners

buttonDown

public boolean buttonDown(XboxGamePad controller,
                          XboxButton button)

Description copied from interface: XboxGamePadListener

Called when a button is pressed down

Specified by:

buttonDown in interface XboxGamePadListener

Overrides:

buttonDown in class XboxGamePadAdapter

Parameters:

controller - The gamePad that this event came from

button - The button that was pressed

Returns:

True if this event should not propagate to other listeners

buttonUp

public boolean buttonUp(XboxGamePad controller,
                        XboxButton button)

Description copied from interface: XboxGamePadListener

Called when a button is released

Specified by:

buttonUp in interface XboxGamePadListener

Overrides:

buttonUp in class XboxGamePadAdapter

Parameters:

controller - The gamepad that this event came from

button - The button that was released

Returns:

True if this event should not propagate to other listeners

isEnabled

public boolean isEnabled()

Description copied from interface: GamePadUiInput

Returns if the gamepad input is enabled for the UiContainer

Specified by:

isEnabled in interface GamePadUiInput<XboxButton>

Returns:

True if enabled (enabled by default)

enable

public void enable()

Description copied from interface: GamePadUiInput

Enables this gamepad input for the UiContainer

Specified by:

enable in interface GamePadUiInput<XboxButton>

disable

public void disable()

Description copied from interface: GamePadUiInput

Disables this gamepad input for the UiContainer

Specified by:

disable in interface GamePadUiInput<XboxButton>

setStickRepeatTimer

public void setStickRepeatTimer(float stickRepeatTimer)

Sets the amount of time in seconds before the left stick is considered repeating a navigation direction

Parameters:

stickRepeatTimer - Default value is 0.25 seconds

setStickThreshold

public void setStickThreshold(float stickThreshold)

Sets the threshold for stick values before the input is considered as a navigation direction press

Parameters:

stickThreshold - Default value is 0.25

isNavigateWithDPad

public boolean isNavigateWithDPad()

Returns if UiNavigation events should be triggered by the D-PAD

Returns:

False by default

setNavigateWithDPad

public void setNavigateWithDPad(boolean navigateWithDPad)

Sets if UiNavigation events should be triggered by the D-PAD

Parameters:

navigateWithDPad - True if events should be triggered

setDebug

public void setDebug(boolean debug)

getActionButton

public XboxButton getActionButton()

Description copied from interface: GamePadUiInput

Returns the button used to trigger Actionable instances

Specified by:

getActionButton in interface GamePadUiInput<XboxButton>

Returns:

setActionButton

public void setActionButton(XboxButton actionButton)

Description copied from interface: GamePadUiInput

Sets the button used for triggering Actionable instances

Specified by:

setActionButton in interface GamePadUiInput<XboxButton>

dispose

public void dispose()

Description copied from interface: GamePadUiInput

Cleans up and de-registers this instance from the associated UiContainer

Specified by:

dispose in interface GamePadUiInput<XboxButton>

getId

public java.lang.String getId()

Description copied from interface: GamePadUiInput

Returns the unique id of this GamePadUiInput

Specified by:

getId in interface GamePadUiInput<XboxButton>

Returns:

A non-null String

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object