org.mini2Dx.ui.controller

Class Xbox360UiInput

java.lang.Object

org.mini2Dx.core.controller.xbox360.Xbox360ControllerAdapter

org.mini2Dx.ui.controller.Xbox360UiInput

All Implemented Interfaces:

MdxControllerListener, Xbox360ControllerListener, ControllerUiInput<Xbox360Button>

public class Xbox360UiInput
extends Xbox360ControllerAdapter
implements ControllerUiInput<Xbox360Button>

Xbox360Controller implementation of ControllerUiInput

Constructor Summary

Constructors

Constructor and Description
Xbox360UiInput(UiContainer uiContainer)

Method Summary

Modifier and Type	Method and Description
boolean	buttonDown(Xbox360Controller controller, Xbox360Button button) Called when a button is pressed down
boolean	buttonUp(Xbox360Controller controller, Xbox360Button button) Called when a button is released
void	disable() Disables this controller input for the UiContainer
void	dispose() Cleans up and de-registers this instance from the associated UiContainer
void	enable() Enables this controller input for the UiContainer
boolean	equals(java.lang.Object obj)
Xbox360Button	getActionButton() Returns the button used to trigger Actionable instances
java.lang.String	getId() Returns the unique id of this ControllerUiInput
int	hashCode()
boolean	isEnabled() Returns if the controller input is enabled for the UiContainer
boolean	leftStickXMoved(Xbox360Controller controller, float value) Called when left stick moves along its X axis
boolean	leftStickYMoved(Xbox360Controller controller, float value) Called when left stick moves along its Y axis
void	setActionButton(Xbox360Button actionButton) Sets the button used for triggering Actionable instances
void	setDebug(boolean debug)
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.controller.xbox360.Xbox360ControllerAdapter

disconnected, leftTriggerMoved, rightStickXMoved, rightStickYMoved, rightTriggerMoved

Methods inherited from class java.lang.Object

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

Constructor Detail

Xbox360UiInput

public Xbox360UiInput(UiContainer uiContainer)

Method Detail

update

public void update(float delta)

Description copied from interface: ControllerUiInput

Updates the input for repeating presses

Specified by:

update in interface ControllerUiInput<Xbox360Button>

Parameters:

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

leftStickXMoved

public boolean leftStickXMoved(Xbox360Controller controller,
                               float value)

Description copied from interface: Xbox360ControllerListener

Called when left stick moves along its X axis

Specified by:

leftStickXMoved in interface Xbox360ControllerListener

Overrides:

leftStickXMoved in class Xbox360ControllerAdapter

Parameters:

controller - The controller 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 controller instance to correct this)

Returns:

True if this event should not propagate to other listeners

leftStickYMoved

public boolean leftStickYMoved(Xbox360Controller controller,
                               float value)

Description copied from interface: Xbox360ControllerListener

Called when left stick moves along its Y axis

Specified by:

leftStickYMoved in interface Xbox360ControllerListener

Overrides:

leftStickYMoved in class Xbox360ControllerAdapter

Parameters:

controller - The controller 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 controller instance to correct this)

Returns:

True if this event should not propagate to other listeners

buttonDown

public boolean buttonDown(Xbox360Controller controller,
                          Xbox360Button button)

Description copied from interface: Xbox360ControllerListener

Called when a button is pressed down

Specified by:

buttonDown in interface Xbox360ControllerListener

Overrides:

buttonDown in class Xbox360ControllerAdapter

Parameters:

controller - The controller 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(Xbox360Controller controller,
                        Xbox360Button button)

Description copied from interface: Xbox360ControllerListener

Called when a button is released

Specified by:

buttonUp in interface Xbox360ControllerListener

Overrides:

buttonUp in class Xbox360ControllerAdapter

Parameters:

controller - The controller 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: ControllerUiInput

Returns if the controller input is enabled for the UiContainer

Specified by:

isEnabled in interface ControllerUiInput<Xbox360Button>

Returns:

True if enabled (enabled by default)

enable

public void enable()

Description copied from interface: ControllerUiInput

Enables this controller input for the UiContainer

Specified by:

enable in interface ControllerUiInput<Xbox360Button>

disable

public void disable()

Description copied from interface: ControllerUiInput

Disables this controller input for the UiContainer

Specified by:

disable in interface ControllerUiInput<Xbox360Button>

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

setDebug

public void setDebug(boolean debug)

getActionButton

public Xbox360Button getActionButton()

Description copied from interface: ControllerUiInput

Returns the button used to trigger Actionable instances

Specified by:

getActionButton in interface ControllerUiInput<Xbox360Button>

Returns:

setActionButton

public void setActionButton(Xbox360Button actionButton)

Description copied from interface: ControllerUiInput

Sets the button used for triggering Actionable instances

Specified by:

setActionButton in interface ControllerUiInput<Xbox360Button>

dispose

public void dispose()

Description copied from interface: ControllerUiInput

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

Specified by:

dispose in interface ControllerUiInput<Xbox360Button>

getId

public java.lang.String getId()

Description copied from interface: ControllerUiInput

Returns the unique id of this ControllerUiInput

Specified by:

getId in interface ControllerUiInput<Xbox360Button>

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