SoMouseButtonEvent Class Reference

The SoMouseButtonEvent class contains information about mouse button interaction. More...

#include <Inventor/events/SoMouseButtonEvent.h>

Inheritance diagram for SoMouseButtonEvent:

Public Types
enum	Button {   ANY , BUTTON1 , BUTTON2 , BUTTON3 ,   BUTTON4 , BUTTON5 }
Public Types inherited from SoButtonEvent
enum	State { UP , DOWN , UNKNOWN }

Public Member Functions
	SoMouseButtonEvent (void)
virtual	~SoMouseButtonEvent ()
Button	getButton (void) const
virtual SoType	getTypeId (void) const
void	setButton (Button button)
Public Member Functions inherited from SoButtonEvent
	SoButtonEvent (void)
virtual	~SoButtonEvent ()
State	getState (void) const
void	setState (State state)
Public Member Functions inherited from SoEvent
	SoEvent (void)
virtual	~SoEvent ()
const SbVec2f &	getNormalizedPosition (const SbViewportRegion &vpRgn) const
const SbVec2s &	getPosition (const SbViewportRegion &vpRgn) const
const SbVec2s &	getPosition (void) const
SbTime	getTime (void) const
SbBool	isOfType (SoType type) const
void	setAltDown (SbBool isDown)
void	setCtrlDown (SbBool isDown)
void	setPosition (const SbVec2s &p)
void	setShiftDown (SbBool isDown)
void	setTime (const SbTime t)
SbBool	wasAltDown (void) const
SbBool	wasCtrlDown (void) const
SbBool	wasShiftDown (void) const

Static Public Member Functions
static SbBool	enumToString (Button enumval, SbString &stringrep)
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 Public Member Functions inherited from SoButtonEvent
static SbBool	enumToString (State enumval, SbString &stringrep)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoEvent
static SoType	getClassTypeId (void)
static void	initClass (void)

Detailed Description

The SoMouseButtonEvent class contains information about mouse button interaction.

When the user presses any buttons on the mouse, these will be translated from a system specific event into a Coin event and sent to the scene graph by using instances of this class.

See also

SoEvent, SoButtonEvent, SoSpaceballButtonEvent, SoKeyboardEvent

SoEventCallback, SoHandleEventAction

Member Enumeration Documentation

Button

enum SoMouseButtonEvent::Button

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 Documentation

SoMouseButtonEvent()

SoMouseButtonEvent::SoMouseButtonEvent

(

void

)

Constructor.

~SoMouseButtonEvent()

SoMouseButtonEvent::~SoMouseButtonEvent ( )

virtual

Destructor.

Member Function Documentation

enumToString()

SbBool SoMouseButtonEvent::enumToString ( Button enumval, SbString & stringrep )

static

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

Coin 3.0

getButton()

SoMouseButtonEvent::Button SoMouseButtonEvent::getButton

(

void

)

const

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

See also

getState()

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

getClassTypeId()

SoType SoMouseButtonEvent::getClassTypeId ( void )

static

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

getTypeId()

SoType SoMouseButtonEvent::getTypeId ( void ) const

virtual

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.

initClass()

void SoMouseButtonEvent::initClass ( void )

static

Initialize the type information data.

isButtonPressEvent()

SbBool SoMouseButtonEvent::isButtonPressEvent ( const SoEvent * e, SoMouseButtonEvent::Button whichButton )

static

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

See also

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

isButtonReleaseEvent()

SbBool SoMouseButtonEvent::isButtonReleaseEvent ( const SoEvent * e, SoMouseButtonEvent::Button whichButton )

static

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

See also

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

setButton()

void SoMouseButtonEvent::setButton

(

SoMouseButtonEvent::Button

buttonarg

)

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()

---

The documentation for this class was generated from the following files:

• SoMouseButtonEvent.h
• SoMouseButtonEvent.cpp