Package heronarts.glx.event

Class MouseEvent

java.lang.Object

heronarts.glx.event.Event

heronarts.glx.event.MouseEvent

public class MouseEvent
extends Event

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MouseEvent.Action

Field Summary

Fields

Modifier and Type	Field	Description
final MouseEvent.Action	action
final int	button
static final int	BUTTON_1
static final int	BUTTON_2
static final int	BUTTON_3
static final int	BUTTON_4
static final int	BUTTON_5
static final int	BUTTON_6
static final int	BUTTON_7
static final int	BUTTON_8
static final int	BUTTON_LEFT
static final int	BUTTON_MIDDLE
static final int	BUTTON_NONE
static final int	BUTTON_RIGHT
final float	dx
final float	dy
static final double	REPEAT_CLICK_PX
static final double	REPEAT_CLICK_TIME
final float	x
final float	y

Fields inherited from class heronarts.glx.event.Event

ALT, CAPS_LOCK, COMMAND, CONTROL, glfwTime, META, modifiers, nanoTime, NONE, NUM_LOCK, SHIFT, SIBLING_REMOVED

Constructor Summary

Constructors

Constructor	Description
MouseEvent(int glfwAction, int button, float x, float y, int modifiers)
MouseEvent(MouseEvent.Action action, float x, float y, float dx, float dy, int modifiers)
MouseEvent(MouseEvent source, MouseEvent.Action action, float x, float y, float dx, float dy, int modifiers)

Method Summary

Modifier and Type	Method	Description
MouseEvent	consume()	Consume the event.
void	consumeDropMenu()	Mark this mouse press event as having been responsible for opening a drop menu.
MouseEvent	consumeScrollX()
MouseEvent	consumeScrollY()
MouseEvent.Action	getAction()
int	getButton()
int	getCount()
double	getX()
double	getY()
boolean	isButton(int button)
boolean	isDoubleClick()
boolean	isDropMenuConsumed()	Check whether mouse press was responsible for a context menu opening
boolean	isRepeat(MouseEvent that)
boolean	isScrollXConsumed()
boolean	isScrollYConsumed()
MouseEvent	setCount(int count)
String	toString()

Methods inherited from class heronarts.glx.event.Event

getModifiers, getTime, hasModifier, isAltDown, isCommand, isConsumed, isControlDown, isMetaDown, isMultiSelect, isRangeSelect, isShiftDown

Methods inherited from class java.lang.Object

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

Field Details

REPEAT_CLICK_TIME

public static final double REPEAT_CLICK_TIME

See Also:

• Constant Field Values

REPEAT_CLICK_PX

public static final double REPEAT_CLICK_PX

See Also:

• Constant Field Values

BUTTON_NONE

public static final int BUTTON_NONE

See Also:

• Constant Field Values

BUTTON_1

public static final int BUTTON_1

See Also:

• Constant Field Values

BUTTON_2

public static final int BUTTON_2

See Also:

• Constant Field Values

BUTTON_3

public static final int BUTTON_3

See Also:

• Constant Field Values

BUTTON_4

public static final int BUTTON_4

See Also:

• Constant Field Values

BUTTON_5

public static final int BUTTON_5

See Also:

• Constant Field Values

BUTTON_6

public static final int BUTTON_6

See Also:

• Constant Field Values

BUTTON_7

public static final int BUTTON_7

See Also:

• Constant Field Values

BUTTON_8

public static final int BUTTON_8

See Also:

• Constant Field Values

BUTTON_LEFT

public static final int BUTTON_LEFT

See Also:

• Constant Field Values

BUTTON_RIGHT

public static final int BUTTON_RIGHT

See Also:

• Constant Field Values

BUTTON_MIDDLE

public static final int BUTTON_MIDDLE

See Also:

• Constant Field Values

action

public final MouseEvent.Action action

button

public final int button

x

public final float x

y

public final float y

dx

public final float dx

dy

public final float dy

Constructor Details

MouseEvent

public MouseEvent(int glfwAction,
 int button,
 float x,
 float y,
 int modifiers)

MouseEvent

public MouseEvent(MouseEvent.Action action,
 float x,
 float y,
 float dx,
 float dy,
 int modifiers)

MouseEvent

public MouseEvent(MouseEvent source,
 MouseEvent.Action action,
 float x,
 float y,
 float dx,
 float dy,
 int modifiers)

Method Details

getButton

public int getButton()

getAction

public MouseEvent.Action getAction()

getX

public double getX()

getY

public double getY()

consumeDropMenu

public void consumeDropMenu()

Mark this mouse press event as having been responsible for opening a drop menu. This is used to flag that this click shouldn't close that drop menu immediately, even though it did not fall within its bounds.

consumeScrollX

public MouseEvent consumeScrollX()

consumeScrollY

public MouseEvent consumeScrollY()

consume

public MouseEvent consume()

Description copied from class: Event

Consume the event. Lower-priority event handlers should not perform the action associated with this event.

Overrides:

consume in class Event

Returns:

this

isDropMenuConsumed

public boolean isDropMenuConsumed()

Check whether mouse press was responsible for a context menu opening

Returns:

Whether this mouse event opened the currently active drop menu

isScrollXConsumed

public boolean isScrollXConsumed()

isScrollYConsumed

public boolean isScrollYConsumed()

setCount

public MouseEvent setCount(int count)

isRepeat

public boolean isRepeat(MouseEvent that)

getCount

public int getCount()

isButton

public boolean isButton(int button)

isDoubleClick

public boolean isDoubleClick()

toString

public String toString()

Overrides:

toString in class Object