SoMouseButtonEvent.3coin4 - Man Page

enum Button { ANY, BUTTON1, BUTTON2, BUTTON3, BUTTON4, BUTTON5 }

Public Types inherited from SoButtonEvent
enum State { UP, DOWN, UNKNOWN }

virtual SoType getTypeId (void) const
SoMouseButtonEvent (void)
virtual ~SoMouseButtonEvent ()
void setButton (Button button)
Button getButton (void) const

Public Member Functions inherited from SoButtonEvent
SoButtonEvent (void)
virtual ~SoButtonEvent ()
void setState (State state)
State getState (void) const

Public Member Functions inherited from SoEvent
SoEvent (void)
virtual ~SoEvent ()
SbBool isOfType (SoType type) const
void setTime (const SbTime t)
SbTime getTime (void) const
void setPosition (const SbVec2s &p)
const SbVec2s & getPosition (void) const
const SbVec2s & getPosition (const SbViewportRegion &vpRgn) const
const SbVec2f & getNormalizedPosition (const SbViewportRegion &vpRgn) const
void setShiftDown (SbBool isDown)
SbBool wasShiftDown (void) const
void setCtrlDown (SbBool isDown)
SbBool wasCtrlDown (void) const
void setAltDown (SbBool isDown)
SbBool wasAltDown (void) const

static SoType getClassTypeId (void)
static void initClass (void)
static SbBool isButtonPressEvent (const SoEvent *e, Button whichButton)
static SbBool isButtonReleaseEvent (const SoEvent *e, Button whichButton)
static SbBool enumToString (Button enumval, SbString &stringrep)

Static Public Member Functions inherited from SoButtonEvent
static SoType getClassTypeId (void)
static void initClass (void)
static SbBool enumToString (State enumval, SbString &stringrep)

Static Public Member Functions inherited from SoEvent
static SoType getClassTypeId (void)
static void initClass (void)

This enum contains all mouse buttons detected by Coin.

Enumerator

ANY

Unknown button.

BUTTON1

First mouse button (usually the leftmost button).

BUTTON2

Second mouse button (usually the middle button).

BUTTON3

Third mouse button (usually the rightmost button).

BUTTON4

Fourth mouse button (typically from a wheel mouse). This is not part of the original Open Inventor API.

BUTTON5

Fifth mouse button (typically from a wheel mouse). This is not part of the original Open Inventor API.

Constructor.

Destructor.

This static method returns the SoType object associated with objects of this class.

Returns the type identification of an object derived from a class inheriting SoEvent. This is used for runtime type checking and 'downward' casting.

Reimplemented from SoButtonEvent.

Initialize the type information data.

Set the value of the button which the user interacted with.

This method is used from the window specific device classes when translating events to the generic Coin library.

See also

getButton()

Returns the value of the button which was pressed or released.

See also

getState()

wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()

Convenience method for quickly checking if the given event is a press on the given button, whichButton.

See also

isButtonReleaseEvent(), isOfType(), getButton(), getState()

Convenience method for quickly checking if the given event is a release of the given button, whichButton.

See also

isButtonPressEvent(), isOfType(), getButton(), getState()

Converts from an enum value of type SoMouseButtonEvent::Button to a string containing the enum symbol.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Since