Open Inventor Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
SoEnterLeaveEvent Class Reference

Open Inventor SoEvent that represents a mouse enter or mouse leave event. More...

#include <Inventor/events/SoEnterLeaveEvent.h>

Inheritance diagram for SoEnterLeaveEvent:
SoEvent

Public Types

enum  EnterLeaveEventType { SO_ENTER_EVENT , SO_LEAVE_EVENT }
 
- Public Types inherited from SoEvent
enum  MouseButtonsMask {
  NO_MOUSEBUTTON_MASK = 0 , LEFT_MOUSEBUTTON_MASK = 1 , MIDDLE_MOUSEBUTTON_MASK = 2 , RIGHT_MOUSEBUTTON_MASK = 4 ,
  ALL_MOUSEBUTTONS_MASK = LEFT_MOUSEBUTTON_MASK + MIDDLE_MOUSEBUTTON_MASK + RIGHT_MOUSEBUTTON_MASK
}
 This describes the bit mask values of setButtonMask and getButtonMask. More...
 

Public Member Functions

 SoEnterLeaveEvent ()
 
EnterLeaveEventType getEventType () const
 get the wheel's orientation
 
void setEventType (EnterLeaveEventType eventType)
 set the wheel's orientation
 
- Public Member Functions inherited from SoEvent
 SoEvent ()
 Constructor and destructor.
 
virtual ~SoEvent ()
 Constructor and destructor.
 
virtual SoType getTypeId () const
 Return the type id for this event instance.
 
bool isOfType (SoType type) const
 This returns TRUE if the event is an instance of or derived from an event of the passed type.
 
void setTime (SbTime t)
 Set the time at which the event occurred.
 
SbTime getTime () const
 Get the time at which the event occurred.
 
void setPosition (const SbVec2s &p)
 Set the window pixel location of the cursor when the event occurred.
 
const SbVec2s & getPosition () const
 Get position in pixel coodinates.
 
const SbVec2s & getPosition (const SbViewportRegion &vpRgn) const
 Get position relative to the specified viewport bounds.
 
const SbVec2f & getNormalizedPosition (const SbViewportRegion &vpRgn) const
 Get the normalized location of the cursor when the event occurred, relative to the specified viewport region.
 
void setShiftDown (bool isDown)
 Set whether the modifier keys were down when the event occurred.
 
void setCtrlDown (bool isDown)
 Set whether the modifier keys were down when the event occurred.
 
void setAltDown (bool isDown)
 Set whether the modifier keys were down when the event occurred.
 
bool wasShiftDown () const
 Get whether the modifier keys were down when the event occurred.
 
bool wasCtrlDown () const
 Get whether the modifier keys were down when the event occurred.
 
bool wasAltDown () const
 Get whether the modifier keys were down when the event occurred.
 
void setMouseButtonMask (int mask)
 Get which mouse buttons are currently pressed (as bit mask)
 
int getMouseButtonMask () const
 Set which mouse buttons are currently pressed.
 

Static Public Member Functions

static void initClass (void)
 
- Static Public Member Functions inherited from SoEvent
static SoType getClassTypeId ()
 Return the type id for the SoEvent class.
 
static void initClass ()
 Initializes base event class.
 
static void initClasses ()
 Initialize ALL Inventor event classes.
 

Detailed Description

This class represents either a mouse enter or a mouse leave event. The mouse position should be ignored on this event, since it may be meaningless.

Definition at line 52 of file SoEnterLeaveEvent.h.

Member Enumeration Documentation

◆ EnterLeaveEventType

enum SoEnterLeaveEvent::EnterLeaveEventType
Enumerator
SO_ENTER_EVENT 
SO_LEAVE_EVENT 

Definition at line 58 of file SoEnterLeaveEvent.h.

Constructor & Destructor Documentation

◆ SoEnterLeaveEvent()

SoEnterLeaveEvent::SoEnterLeaveEvent ( )
inline

Definition at line 63 of file SoEnterLeaveEvent.h.

References SO_ENTER_EVENT.

Member Function Documentation

◆ getEventType()

EnterLeaveEventType SoEnterLeaveEvent::getEventType ( ) const

◆ initClass()

static void SoEnterLeaveEvent::initClass ( void )
static

◆ setEventType()

void SoEnterLeaveEvent::setEventType ( EnterLeaveEventType eventType)
The documentation for this class was generated from the following file: