com.jme3.input

Class DefaultJoystickAxis

java.lang.Object

com.jme3.input.DefaultJoystickAxis

All Implemented Interfaces:

JoystickAxis

Direct Known Subclasses:

AndroidSensorJoyInput.AndroidSensorJoystickAxis

public class DefaultJoystickAxis
extends java.lang.Object
implements JoystickAxis

Default implementation of the JoystickAxis interface.

Field Summary

Fields inherited from interface com.jme3.input.JoystickAxis

LEFT_TRIGGER, POV_X, POV_Y, RIGHT_TRIGGER, X_AXIS, Y_AXIS, Z_AXIS, Z_ROTATION

Constructor Summary

Constructors

Constructor and Description
DefaultJoystickAxis(InputManager inputManager, Joystick parent, int axisIndex, java.lang.String name, java.lang.String logicalId, boolean isAnalog, boolean isRelative, float deadZone) Creates a new joystick axis instance.

Method Summary

Modifier and Type	Method and Description
void	assignAxis(java.lang.String positiveMapping, java.lang.String negativeMapping) Assign the mappings to receive events from the given joystick axis.
int	getAxisId() Returns the axisId of this joystick axis.
float	getDeadZone() Returns the suggested dead zone for this axis.
Joystick	getJoystick() Returns the joystick to which this axis object belongs.
java.lang.String	getLogicalId() Returns the logical identifier of this joystick axis.
java.lang.String	getName() Returns the name of this joystick.
boolean	isAnalog() Returns true if this is an analog axis, meaning the values are a continuous range instead of 1, 0, and -1.
boolean	isRelative() Returns true if this axis presents relative values.
void	setDeadZone(float f) Sets/overrides the dead zone for this axis.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJoystickAxis

public DefaultJoystickAxis(InputManager inputManager,
                           Joystick parent,
                           int axisIndex,
                           java.lang.String name,
                           java.lang.String logicalId,
                           boolean isAnalog,
                           boolean isRelative,
                           float deadZone)

Creates a new joystick axis instance. Only used internally.

Parameters:

inputManager - (alias created)

parent - (alias created)

axisIndex - index for the new axis

name - name for the new axis

logicalId - logical identifier for the new axis

isAnalog - true→continuous range, false→discrete values

isRelative - true→presents relative values

deadZone - the radius of the dead zone

Method Detail

assignAxis

public void assignAxis(java.lang.String positiveMapping,
                       java.lang.String negativeMapping)

Assign the mappings to receive events from the given joystick axis.

Specified by:

assignAxis in interface JoystickAxis

Parameters:

positiveMapping - The mapping to receive events when the axis is negative

negativeMapping - The mapping to receive events when the axis is positive

getJoystick

public Joystick getJoystick()

Returns the joystick to which this axis object belongs.

Specified by:

getJoystick in interface JoystickAxis

Returns:

the pre-existing instance

getName

public java.lang.String getName()

Returns the name of this joystick.

Specified by:

getName in interface JoystickAxis

Returns:

the name of this joystick.

getLogicalId

public java.lang.String getLogicalId()

Returns the logical identifier of this joystick axis.

Specified by:

getLogicalId in interface JoystickAxis

Returns:

the logical identifier of this joystick.

getAxisId

public int getAxisId()

Returns the axisId of this joystick axis.

Specified by:

getAxisId in interface JoystickAxis

Returns:

the axisId of this joystick axis.

isAnalog

public boolean isAnalog()

Returns true if this is an analog axis, meaning the values are a continuous range instead of 1, 0, and -1.

Specified by:

isAnalog in interface JoystickAxis

Returns:

true if analog, otherwise false

isRelative

public boolean isRelative()

Returns true if this axis presents relative values.

Specified by:

isRelative in interface JoystickAxis

Returns:

true if relative, otherwise false

getDeadZone

public float getDeadZone()

Returns the suggested dead zone for this axis. Values less than this can be safely ignored.

Specified by:

getDeadZone in interface JoystickAxis

Returns:

the radius of the dead zone

setDeadZone

public void setDeadZone(float f)

Sets/overrides the dead zone for this axis. This indicates that values within +/- deadZone should be ignored.

Parameters:

f - the desired radius

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object