org.mini2Dx.ui.gamepad

Class PS4UiInput

java.lang.Object

org.mini2Dx.core.input.ps4.PS4GamePadAdapter

org.mini2Dx.ui.gamepad.PS4UiInput

All Implemented Interfaces:

MappedGamePadListener, PS4GamePadListener, GamePadUiInput<PS4Button>

public class PS4UiInput
extends PS4GamePadAdapter
implements GamePadUiInput<PS4Button>

PS4GamePad implementation of GamePadUiInput

Constructor Summary

Constructors

Constructor and Description
PS4UiInput(UiContainer uiContainer)

Method Summary

Modifier and Type	Method and Description
boolean	buttonDown(PS4GamePad controller, PS4Button button)
boolean	buttonUp(PS4GamePad controller, PS4Button button)
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)
PS4Button	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(PS4GamePad controller, float value)
boolean	leftStickYMoved(PS4GamePad controller, float value)
void	setActionButton(PS4Button 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.input.ps4.PS4GamePadAdapter

connected, disconnected, l2Moved, r2Moved, rightStickXMoved, rightStickYMoved

Methods inherited from class java.lang.Object

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

Constructor Detail

PS4UiInput

public PS4UiInput(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<PS4Button>

Parameters:

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

leftStickXMoved

public boolean leftStickXMoved(PS4GamePad controller,
                               float value)

Specified by:

leftStickXMoved in interface PS4GamePadListener

Overrides:

leftStickXMoved in class PS4GamePadAdapter

leftStickYMoved

public boolean leftStickYMoved(PS4GamePad controller,
                               float value)

Specified by:

leftStickYMoved in interface PS4GamePadListener

Overrides:

leftStickYMoved in class PS4GamePadAdapter

buttonDown

public boolean buttonDown(PS4GamePad controller,
                          PS4Button button)

Specified by:

buttonDown in interface PS4GamePadListener

Overrides:

buttonDown in class PS4GamePadAdapter

buttonUp

public boolean buttonUp(PS4GamePad controller,
                        PS4Button button)

Specified by:

buttonUp in interface PS4GamePadListener

Overrides:

buttonUp in class PS4GamePadAdapter

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

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

disable

public void disable()

Description copied from interface: GamePadUiInput

Disables this gamepad input for the UiContainer

Specified by:

disable in interface GamePadUiInput<PS4Button>

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 PS4Button getActionButton()

Description copied from interface: GamePadUiInput

Returns the button used to trigger Actionable instances

Specified by:

getActionButton in interface GamePadUiInput<PS4Button>

Returns:

setActionButton

public void setActionButton(PS4Button actionButton)

Description copied from interface: GamePadUiInput

Sets the button used for triggering Actionable instances

Specified by:

setActionButton in interface GamePadUiInput<PS4Button>

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

getId

public java.lang.String getId()

Description copied from interface: GamePadUiInput

Returns the unique id of this GamePadUiInput

Specified by:

getId in interface GamePadUiInput<PS4Button>

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