org.mini2Dx.core.input.deadzone

Class AxialDeadZone

java.lang.Object

org.mini2Dx.core.input.deadzone.AxialDeadZone

All Implemented Interfaces:

DeadZone

public class AxialDeadZone
extends java.lang.Object
implements DeadZone

Implements an axis-based dead zone - suitable for tile-based games. See Doing Thumbstick Dead Zones Right.

Constructor Summary

Constructors

Constructor and Description
AxialDeadZone()

Method Summary

Modifier and Type	Method and Description
DeadZone	copy() Creates a copy of this DeadZone
float	getDeadZone() Returns the dead zone threshold
float	getX() Returns the x axis value with the dead zone applied
float	getY() Returns the y axis value with the dead zone applied
void	setDeadZone(float deadZone) Sets the dead zone threshold
void	updateX(float x) Updates the x axis value
void	updateY(float y) Updates the y axis value

Methods inherited from class java.lang.Object

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

Constructor Detail

AxialDeadZone

public AxialDeadZone()

Method Detail

updateX

public void updateX(float x)

Description copied from interface: DeadZone

Updates the x axis value

Specified by:

updateX in interface DeadZone

Parameters:

x - The x axis value

updateY

public void updateY(float y)

Description copied from interface: DeadZone

Updates the y axis value

Specified by:

updateY in interface DeadZone

Parameters:

y - The y axis value

getX

public float getX()

Description copied from interface: DeadZone

Returns the x axis value with the dead zone applied

Specified by:

getX in interface DeadZone

Returns:

getY

public float getY()

Description copied from interface: DeadZone

Returns the y axis value with the dead zone applied

Specified by:

getY in interface DeadZone

Returns:

getDeadZone

public float getDeadZone()

Description copied from interface: DeadZone

Returns the dead zone threshold

Specified by:

getDeadZone in interface DeadZone

Returns:

The threshold - defaults to 0.25f

setDeadZone

public void setDeadZone(float deadZone)

Description copied from interface: DeadZone

Sets the dead zone threshold

Specified by:

setDeadZone in interface DeadZone

Parameters:

deadZone - The threshold

copy

public DeadZone copy()

Description copied from interface: DeadZone

Creates a copy of this DeadZone

Specified by:

copy in interface DeadZone

Returns:

A new DeadZone instance