Base class for all button events. More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:

Public Types
enum	State { UP , DOWN , UNKNOWN }

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
	SoButtonEvent ()
	Constructor.

virtual	~SoButtonEvent ()

void	setState (SoButtonEvent::State s)
	get state of the button

SoButtonEvent::State	getState () const

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

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

SoButtonEvent represents generic button press and release events in the Inventor event model. It is the base class for device-specific button events, namely SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent. This class stores the down/up state of the button when the event occurred.

See Also

: SoEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction

Definition at line 82 of file SoButtonEvent.h.

Member Enumeration Documentation

◆ State

enum SoButtonEvent::State

Enumerator
UP
DOWN
UNKNOWN

Definition at line 92 of file SoButtonEvent.h.

Constructor & Destructor Documentation

◆ SoButtonEvent()

SoButtonEvent::SoButtonEvent ( )

◆ ~SoButtonEvent()

virtual SoButtonEvent::~SoButtonEvent ( )

virtual

Member Function Documentation

◆ getState()

SoButtonEvent::State SoButtonEvent::getState ( ) const

inline

Definition at line 100 of file SoButtonEvent.h.

◆ initClass()

static void SoButtonEvent::initClass ( )

static

◆ setState()

void SoButtonEvent::setState ( SoButtonEvent::State s )

inline

Definition at line 99 of file SoButtonEvent.h.

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

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/events/SoButtonEvent.h

Public Types

Public Member Functions

Static Public Member Functions