com.jme3.input.event

Class JoyAxisEvent

java.lang.Object

com.jme3.input.event.InputEvent

com.jme3.input.event.JoyAxisEvent

public class JoyAxisEvent
extends InputEvent

Joystick axis event.

Field Summary

Fields inherited from class com.jme3.input.event.InputEvent

consumed, time

Constructor Summary

Constructors

Constructor and Description
JoyAxisEvent(JoystickAxis axis, float value) Creates a new event for a joystick axis.
JoyAxisEvent(JoystickAxis axis, float value, float rawValue) Creates a new event for a joystick axis.

Method Summary

Modifier and Type	Method and Description
JoystickAxis	getAxis() Returns the JoystickAxis that triggered this event.
int	getAxisIndex() Returns the joystick axis index.
int	getJoyIndex() The joystick index.
float	getRawValue() The value of the axis before it was remapped.
float	getValue() The value of the axis.

Methods inherited from class com.jme3.input.event.InputEvent

getTime, isConsumed, setConsumed, setTime

Methods inherited from class java.lang.Object

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

Constructor Detail

JoyAxisEvent

public JoyAxisEvent(JoystickAxis axis,
                    float value)

Creates a new event for a joystick axis.

Parameters:

axis - - The axis that generated this event.

value - - The value of the axis.

JoyAxisEvent

public JoyAxisEvent(JoystickAxis axis,
                    float value,
                    float rawValue)

Creates a new event for a joystick axis.

Parameters:

axis - - The axis that generated this event.

value - - The value of the axis, after rescaling took place.

rawValue - - The original axis value before it was rescaled by JoystickCompatibilityMappings.

Method Detail

getAxis

public JoystickAxis getAxis()

Returns the JoystickAxis that triggered this event.

Returns:

the pre-existing instance

See Also:

JoystickAxis.assignAxis(java.lang.String, java.lang.String)

getAxisIndex

public int getAxisIndex()

Returns the joystick axis index.

Returns:

joystick axis index.

See Also:

JoystickAxis.assignAxis(java.lang.String, java.lang.String)

getJoyIndex

public int getJoyIndex()

The joystick index.

Returns:

joystick index.

See Also:

InputManager.getJoysticks()

getValue

public float getValue()

The value of the axis.

Returns:

value of the axis.

getRawValue

public float getRawValue()

The value of the axis before it was remapped.

Returns:

value of the axis.