com.openinventor.inventor.events

Class SoMouseButtonEvent

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.events.SoEvent

com.openinventor.inventor.events.SoButtonEvent

com.openinventor.inventor.events.SoMouseButtonEvent

public class SoMouseButtonEvent
extends SoButtonEvent

Mouse button press and release events. SoMouseButtonEvent represents mouse button press and release events in the Open Inventor event model.

Mouse event can only have one state: Press, Release or DoubleClick.

Mouse move events are represented by an SoLocation2Event.

Add an SoEventCallback node to the scene graph to handle Open Inventor events.

See also:

SoEvent, SoButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoWinDevice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoMouseButtonEvent.Buttons Button.

Nested classes/interfaces inherited from class com.openinventor.inventor.events.SoButtonEvent

SoButtonEvent.States

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY Deprecated. Use SoMouseButtonEvent.Buttons.ANY instead.
static int	BUTTON1 Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON1 instead.
static int	BUTTON2 Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON2 instead.
static int	BUTTON3 Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON3 instead.

Fields inherited from class com.openinventor.inventor.events.SoButtonEvent

DBCLK, DOWN, UNKNOWN, UP

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoMouseButtonEvent() Constructor.

Method Summary

Modifier and Type	Method and Description
SoMouseButtonEvent.Buttons	getButton() Gets which mouse button generated the event.
static boolean	isButtonDoubleClickEvent(SoEvent e, SoMouseButtonEvent.Buttons whichButton) Returns whether the passed event is a mouse button double click event of the passed button.
static boolean	isButtonPressEvent(SoEvent e, SoMouseButtonEvent.Buttons whichButton) Returns whether the passed event is a mouse button press event of the passed button.
static boolean	isButtonReleaseEvent(SoEvent e, SoMouseButtonEvent.Buttons whichButton) Returns whether the passed event is a mouse button release event of the passed button.
void	setButton(SoMouseButtonEvent.Buttons b) Sets which mouse button generated the event.

Methods inherited from class com.openinventor.inventor.events.SoButtonEvent

getState, setState

Methods inherited from class com.openinventor.inventor.events.SoEvent

getNormalizedPosition, getPosition, getPosition, getPositionFloat, getPositionFloat, getTime, setAltDown, setButton1Down, setCtrlDown, setPosition, setPosition, setShiftDown, setTime, wasAltDown, wasButton1Down, wasCtrlDown, wasShiftDown

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

ANY

@Deprecated
public static final int ANY

Deprecated. Use SoMouseButtonEvent.Buttons.ANY instead.

BUTTON1

@Deprecated
public static final int BUTTON1

Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON1 instead.

BUTTON2

@Deprecated
public static final int BUTTON2

Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON2 instead.

BUTTON3

@Deprecated
public static final int BUTTON3

Deprecated. Use SoMouseButtonEvent.Buttons.BUTTON3 instead.

Constructor Detail

SoMouseButtonEvent

public SoMouseButtonEvent()

Constructor.

Method Detail

isButtonDoubleClickEvent

public static boolean isButtonDoubleClickEvent(SoEvent e,
                                               SoMouseButtonEvent.Buttons whichButton)

Returns whether the passed event is a mouse button double click event of the passed button. When SoMouseButtonEvent.ANY is passed, this returns true if the event represents a double click of any mouse button.

isButtonReleaseEvent

public static boolean isButtonReleaseEvent(SoEvent e,
                                           SoMouseButtonEvent.Buttons whichButton)

Returns whether the passed event is a mouse button release event of the passed button. When SoMouseButtonEvent.ANY is passed, this returns true if the event represents a button release of any mouse button.

setButton

public void setButton(SoMouseButtonEvent.Buttons b)

Sets which mouse button generated the event.

getButton

public SoMouseButtonEvent.Buttons getButton()

Gets which mouse button generated the event.

isButtonPressEvent

public static boolean isButtonPressEvent(SoEvent e,
                                         SoMouseButtonEvent.Buttons whichButton)

Returns whether the passed event is a mouse button press event of the passed button. When SoMouseButtonEvent.ANY is passed, this returns true if the event represents a button press of any mouse button.