com.jme3.input

Interface JoystickAxis

All Known Implementing Classes:

AndroidSensorJoyInput.AndroidSensorJoystickAxis, DefaultJoystickAxis

public interface JoystickAxis

Represents a single axis of a Joystick.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEFT_TRIGGER
static java.lang.String	POV_X
static java.lang.String	POV_Y
static java.lang.String	RIGHT_TRIGGER
static java.lang.String	X_AXIS
static java.lang.String	Y_AXIS
static java.lang.String	Z_AXIS
static java.lang.String	Z_ROTATION

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 unique axisId of this joystick axis within a given InputManager context.
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.

Field Detail

X_AXIS

static final java.lang.String X_AXIS

See Also:

Constant Field Values

Y_AXIS

static final java.lang.String Y_AXIS

See Also:

Constant Field Values

Z_AXIS

static final java.lang.String Z_AXIS

See Also:

Constant Field Values

Z_ROTATION

static final java.lang.String Z_ROTATION

See Also:

Constant Field Values

LEFT_TRIGGER

static final java.lang.String LEFT_TRIGGER

See Also:

Constant Field Values

RIGHT_TRIGGER

static final java.lang.String RIGHT_TRIGGER

See Also:

Constant Field Values

POV_X

static final java.lang.String POV_X

See Also:

Constant Field Values

POV_Y

static final java.lang.String POV_Y

See Also:

Constant Field Values

Method Detail

assignAxis

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

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

Parameters:

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

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

getJoystick

Joystick getJoystick()

Returns the joystick to which this axis object belongs.

Returns:

the pre-existing instance

getName

java.lang.String getName()

Returns the name of this joystick.

Returns:

the name of this joystick.

getLogicalId

java.lang.String getLogicalId()

Returns the logical identifier of this joystick axis.

Returns:

the logical identifier of this joystick.

getAxisId

int getAxisId()

Returns the unique axisId of this joystick axis within a given InputManager context.

Returns:

the axisId of this joystick axis.

isAnalog

boolean isAnalog()

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

Returns:

true if analog, otherwise false

isRelative

boolean isRelative()

Returns true if this axis presents relative values.

Returns:

true if relative, otherwise false

getDeadZone

float getDeadZone()

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

Returns:

the radius of the dead zone