com.jme3.input.event

Class MouseButtonEvent

java.lang.Object

com.jme3.input.event.InputEvent

com.jme3.input.event.MouseButtonEvent

public class MouseButtonEvent
extends InputEvent

Mouse button press/release event.

Field Summary

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

consumed, time

Constructor Summary

Constructors

Constructor and Description
MouseButtonEvent(int btnIndex, boolean pressed, int x, int y)

Method Summary

Modifier and Type	Method and Description
int	getButtonIndex() Returns the mouse button index.
int	getX() The X coordinate of the mouse when the event was generated.
int	getY() The Y coordinate of the mouse when the event was generated.
boolean	isPressed() Returns true if the mouse button was pressed, false if it was released.
boolean	isReleased() Returns true if the mouse button was released, false if it was pressed.
java.lang.String	toString()

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, wait, wait, wait

Constructor Detail

MouseButtonEvent

public MouseButtonEvent(int btnIndex,
                        boolean pressed,
                        int x,
                        int y)

Method Detail

getButtonIndex

public int getButtonIndex()

Returns the mouse button index.

See constants in MouseInput.

Returns:

the mouse button index.

isPressed

public boolean isPressed()

Returns true if the mouse button was pressed, false if it was released.

Returns:

true if the mouse button was pressed, false if it was released.

isReleased

public boolean isReleased()

Returns true if the mouse button was released, false if it was pressed.

Returns:

true if the mouse button was released, false if it was pressed.

getX

public int getX()

The X coordinate of the mouse when the event was generated.

Returns:

X coordinate of the mouse when the event was generated.

getY

public int getY()

The Y coordinate of the mouse when the event was generated.

Returns:

Y coordinate of the mouse when the event was generated.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object