org.mini2Dx.ui.controller

Class XboxOneUiInput

java.lang.Object

org.mini2Dx.core.controller.xboxone.XboxOneControllerAdapter

org.mini2Dx.ui.controller.XboxOneUiInput

All Implemented Interfaces:

MdxControllerListener, XboxOneControllerListener, ControllerUiInput<XboxOneButton>

public class XboxOneUiInput
extends XboxOneControllerAdapter
implements ControllerUiInput<XboxOneButton>

XboxOneController implementation of ControllerUiInput

Constructor Summary

Constructors

Constructor and Description
XboxOneUiInput(UiContainer uiContainer)

Method Summary

Modifier and Type	Method and Description
boolean	buttonDown(XboxOneController controller, XboxOneButton button)
boolean	buttonUp(XboxOneController controller, XboxOneButton button)
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)
XboxOneButton	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	isNavigateWithDPad() Returns if UiNavigation events should be triggered by the D-PAD
boolean	leftStickXMoved(XboxOneController controller, float value)
boolean	leftStickYMoved(XboxOneController controller, float value)
void	setActionButton(XboxOneButton actionButton) Sets the button used for triggering Actionable instances
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.controller.xboxone.XboxOneControllerAdapter

disconnected, leftTriggerMoved, rightStickXMoved, rightStickYMoved, rightTriggerMoved

Methods inherited from class java.lang.Object

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

Constructor Detail

XboxOneUiInput

public XboxOneUiInput(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<XboxOneButton>

Parameters:

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

leftStickXMoved

public boolean leftStickXMoved(XboxOneController controller,
                               float value)

Specified by:

leftStickXMoved in interface XboxOneControllerListener

Overrides:

leftStickXMoved in class XboxOneControllerAdapter

leftStickYMoved

public boolean leftStickYMoved(XboxOneController controller,
                               float value)

Specified by:

leftStickYMoved in interface XboxOneControllerListener

Overrides:

leftStickYMoved in class XboxOneControllerAdapter

buttonDown

public boolean buttonDown(XboxOneController controller,
                          XboxOneButton button)

Specified by:

buttonDown in interface XboxOneControllerListener

Overrides:

buttonDown in class XboxOneControllerAdapter

buttonUp

public boolean buttonUp(XboxOneController controller,
                        XboxOneButton button)

Specified by:

buttonUp in interface XboxOneControllerListener

Overrides:

buttonUp in class XboxOneControllerAdapter

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<XboxOneButton>

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<XboxOneButton>

disable

public void disable()

Description copied from interface: ControllerUiInput

Disables this controller input for the UiContainer

Specified by:

disable in interface ControllerUiInput<XboxOneButton>

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

getActionButton

public XboxOneButton getActionButton()

Description copied from interface: ControllerUiInput

Returns the button used to trigger Actionable instances

Specified by:

getActionButton in interface ControllerUiInput<XboxOneButton>

Returns:

setActionButton

public void setActionButton(XboxOneButton actionButton)

Description copied from interface: ControllerUiInput

Sets the button used for triggering Actionable instances

Specified by:

setActionButton in interface ControllerUiInput<XboxOneButton>

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<XboxOneButton>

getId

public java.lang.String getId()

Description copied from interface: ControllerUiInput

Returns the unique id of this ControllerUiInput

Specified by:

getId in interface ControllerUiInput<XboxOneButton>

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