Base class for all button events. More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:

Public Types
enum	State { UP , DOWN , DBCLK , UNKNOWN }
	State. More...

Public Member Functions
	SoButtonEvent ()
	Constructor.

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

SoButtonEvent::State	getState () const
	Gets the state of the button.

Public Member Functions inherited from SoEvent
	SoEvent ()
	Constructor.

virtual	~SoEvent ()
	Destructor.

virtual SoType	getTypeId () const
	Returns the type id for this event instance.

virtual void	setTime (SbTime t)
	Sets the time at which the event occurred.

SbTime	getTime () const
	Gets the time at which the event occurred.

virtual void	setPosition (const SbVec2s &p)
	Sets the window pixel location of the cursor when the event occurred.

virtual void	setPosition (const SbVec2f &p)
	Float version of setPosition(const SbVec2s &p).

const SbVec2s &	getPosition () const
	Returns the window pixel location of the cursor when the event occurred as integer values.

const SbVec2f &	getPositionFloat () const
	Returns the window pixel location of the cursor when the event occurred as float values.

const SbVec2s &	getPosition (const SbViewportRegion &vpRgn) const
	Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as integer values.

const SbVec2f &	getPositionFloat (const SbViewportRegion &vpRgn) const
	Gets the viewport pixel location of the cursor when the event occurred, relative to the origin of the specified viewport region, as float values.

const SbVec2f &	getNormalizedPosition (const SbViewportRegion &vpRgn) const
	Gets the normalized location of the cursor when the event occurred, relative to the specified viewport region.

void	setShiftDown (SbBool isDown)
	Sets whether the shift key was down when the event occurred.

void	setCtrlDown (SbBool isDown)
	Sets whether the CTRL key was down when the event occurred.

void	setAltDown (SbBool isDown)
	Sets whether the ALT key was down when the event occurred.

void	setButton1Down (SbBool isDown)
	Sets whether mouse Button 1 was down when the event occurred.

SbBool	wasShiftDown () const
	Returns true if the shift key was down when the event occurred.

SbBool	wasCtrlDown () const
	Returns true if the CTRL key was down when the event occurred.

SbBool	wasAltDown () const
	Returns true if the ALT key was down when the event occurred.

SbBool	wasButton1Down () const
	Returns true if mouse button 1 was down when the event occurred.

virtual const SbTrackerInfo *	getTrackerInfo () const
	Gets whether an event object has associated tracker information.

SbTrackerInfo *	getTrackerInfo ()
	Gets whether an event object has associated tracker information.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass>
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Additional Inherited Members
Static Public Member Functions inherited from SoEvent
static SoType	getClassTypeId ()
	Returns the type id for the SoEvent class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Base class for all button events.

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

Member Enumeration Documentation

◆ State

enum SoButtonEvent::State

State.

Enumerator
UP	Button up event.
DOWN	Button down event.
DBCLK	Button double click event.
UNKNOWN	Button in unknown state.

Definition at line 101 of file SoButtonEvent.h.

Constructor & Destructor Documentation

◆ SoButtonEvent()

SoButtonEvent::SoButtonEvent ( )

Constructor.

Member Function Documentation

◆ getState()

SoButtonEvent::State SoButtonEvent::getState ( ) const

inline

Gets the state of the button.

Definition at line 127 of file SoButtonEvent.h.

◆ setState()

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

inline

Sets the state of the button.

Definition at line 123 of file SoButtonEvent.h.

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

Inventor/events/SoButtonEvent.h

Open Inventor Release 2025.2.0

Public Types

Public Member Functions

Additional Inherited Members