com.jme3.input.controls

Class MouseAxisTrigger

java.lang.Object

com.jme3.input.controls.MouseAxisTrigger

All Implemented Interfaces:

Trigger

public class MouseAxisTrigger
extends java.lang.Object
implements Trigger

A MouseAxisTrigger is used as a mapping to mouse axis, a mouse axis is movement along the X axis (left/right), Y axis (up/down) and the mouse wheel (scroll up/down).

Constructor Summary

Constructors

Constructor and Description
MouseAxisTrigger(int mouseAxis, boolean negative) Create a new MouseAxisTrigger.

Method Summary

Modifier and Type	Method and Description
int	getMouseAxis()
java.lang.String	getName()
boolean	isNegative()
static int	mouseAxisHash(int mouseAxis, boolean negative)
int	triggerHashCode() Returns the hash code for the trigger.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseAxisTrigger

public MouseAxisTrigger(int mouseAxis,
                        boolean negative)

Create a new MouseAxisTrigger.

Parameters:

mouseAxis - Mouse axis. See AXIS_*** constants in MouseInput

negative - True if listen to negative axis events, false if listen to positive axis events.

Method Detail

getMouseAxis

public int getMouseAxis()

isNegative

public boolean isNegative()

getName

public java.lang.String getName()

Specified by:

getName in interface Trigger

Returns:

A user friendly name for the trigger.

mouseAxisHash

public static int mouseAxisHash(int mouseAxis,
                                boolean negative)

triggerHashCode

public int triggerHashCode()

Description copied from interface: Trigger

Returns the hash code for the trigger.

Specified by:

triggerHashCode in interface Trigger

Returns:

the hash code for the trigger.