com.jme3.input
Interface MouseInput

All Superinterfaces:
Input
All Known Implementing Classes:
AwtMouseInput, DummyMouseInput, LwjglMouseInput

public interface MouseInput
extends Input

A specific API for interfacing with the mouse.


Field Summary
static int AXIS_WHEEL
          Mouse wheel axis.
static int AXIS_X
          Mouse X axis.
static int AXIS_Y
          Mouse Y axis.
static int BUTTON_LEFT
          Left mouse button.
static int BUTTON_MIDDLE
          Middle mouse button.
static int BUTTON_RIGHT
          Right mouse button.
 
Method Summary
 int getButtonCount()
          Returns the number of buttons the mouse has.
 void setCursorVisible(boolean visible)
          Set whether the mouse cursor should be visible or not.
 void setNativeCursor(JmeCursor cursor)
          Sets the cursor to use.
 
Methods inherited from interface com.jme3.input.Input
destroy, getInputTimeNanos, initialize, isInitialized, setInputListener, update
 

Field Detail

AXIS_X

static final int AXIS_X
Mouse X axis.

See Also:
Constant Field Values

AXIS_Y

static final int AXIS_Y
Mouse Y axis.

See Also:
Constant Field Values

AXIS_WHEEL

static final int AXIS_WHEEL
Mouse wheel axis.

See Also:
Constant Field Values

BUTTON_LEFT

static final int BUTTON_LEFT
Left mouse button.

See Also:
Constant Field Values

BUTTON_RIGHT

static final int BUTTON_RIGHT
Right mouse button.

See Also:
Constant Field Values

BUTTON_MIDDLE

static final int BUTTON_MIDDLE
Middle mouse button.

See Also:
Constant Field Values
Method Detail

setCursorVisible

void setCursorVisible(boolean visible)
Set whether the mouse cursor should be visible or not.

Parameters:
visible - Whether the mouse cursor should be visible or not.

getButtonCount

int getButtonCount()
Returns the number of buttons the mouse has. Typically 3 for most mice.

Returns:
the number of buttons the mouse has.

setNativeCursor

void setNativeCursor(JmeCursor cursor)
Sets the cursor to use.

Parameters:
cursor - The cursor to use.