Open Inventor Reference
SoMouseButtonEvent Class Reference

Mouse button press and release events. More...

#include <Inventor/events/SoMouseButtonEvent.h>

Inheritance diagram for SoMouseButtonEvent:
SoButtonEvent SoEvent

List of all members.

Public Types

enum  Button { ANY = 0, BUTTON1 = 1, BUTTON2 = 2, BUTTON3 = 3 }

Public Member Functions

 SoMouseButtonEvent ()
 Constructor.
virtual ~SoMouseButtonEvent ()
void setButton (SoMouseButtonEvent::Button b)
 set/get which button generated the event, either SO_MOUSE_BUTTON1, SO_MOUSE_BUTTON2, or SO_MOUSE_BUTTON3
SoMouseButtonEvent::Button getButton () const

Static Public Member Functions

static SbBool isButtonPressEvent (const SoEvent *e, SoMouseButtonEvent::Button whichButton)
 convenience routines to see if an SoEvent is a press or release of the passed mouse button
static SbBool isButtonReleaseEvent (const SoEvent *e, SoMouseButtonEvent::Button whichButton)
static void initClass ()
 Initializes base event class.

Detailed Description

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

See Also
SoEvent, SoButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction

Definition at line 87 of file SoMouseButtonEvent.h.


Member Enumeration Documentation

Enumerator:
ANY 
BUTTON1 
BUTTON2 
BUTTON3 

Definition at line 92 of file SoMouseButtonEvent.h.


Constructor & Destructor Documentation

SoMouseButtonEvent::SoMouseButtonEvent ( )
virtual SoMouseButtonEvent::~SoMouseButtonEvent ( ) [virtual]

Member Function Documentation

SoMouseButtonEvent::Button SoMouseButtonEvent::getButton ( ) const [inline]

Definition at line 106 of file SoMouseButtonEvent.h.

static void SoMouseButtonEvent::initClass ( ) [static]

Reimplemented from SoButtonEvent.

static SbBool SoMouseButtonEvent::isButtonPressEvent ( const SoEvent e,
SoMouseButtonEvent::Button  whichButton 
) [static]
static SbBool SoMouseButtonEvent::isButtonReleaseEvent ( const SoEvent e,
SoMouseButtonEvent::Button  whichButton 
) [static]
void SoMouseButtonEvent::setButton ( SoMouseButtonEvent::Button  b) [inline]

Definition at line 105 of file SoMouseButtonEvent.h.


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