SoButtonEvent Class Reference

The SoButtonEvent class is the base class for all button events. More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:

Public Types
enum	State { UP , DOWN , UNKNOWN }

Public Member Functions
	SoButtonEvent (void)
virtual	~SoButtonEvent ()
State	getState (void) const
virtual SoType	getTypeId (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 (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 SoButtonEvent class is the base class for all button events.

The event classes which results from the user pushing buttons on some device (keyboard, mouse or spaceball) all inherit this class. The SoButtonEvent class contains methods for setting and getting the state of the button(s).

See also

SoEvent, SoKeyboardEvent, SoMouseButtonEvent, SoSpaceballButtonEvent

SoEventCallback, SoHandleEventAction

Member Enumeration Documentation

State

enum SoButtonEvent::State

This gives the actual state of the button.

Enumerator
UP	Button has been released.
DOWN	Button has been pressed down.
UNKNOWN	The state of the button is unknown.

Constructor & Destructor Documentation

SoButtonEvent()

SoButtonEvent::SoButtonEvent

(

void

)

Constructor.

~SoButtonEvent()

SoButtonEvent::~SoButtonEvent ( )

virtual

Destructor.

Member Function Documentation

enumToString()

SbBool SoButtonEvent::enumToString ( State enumval, SbString & stringrep )

static

Converts from an enum value of type SoButtonEvent::State 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

getClassTypeId()

SoType SoButtonEvent::getClassTypeId ( void )

static

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

getState()

SoButtonEvent::State SoButtonEvent::getState

(

void

)

const

Returns the state of the button which is the cause of the event, i.e. whether it was pushed down or released.

See also

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

getTypeId()

SoType SoButtonEvent::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 SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

initClass()

void SoButtonEvent::initClass ( void )

static

Initialize the type information data.

setState()

void SoButtonEvent::setState

(

SoButtonEvent::State

state

)

Set the state 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

getState()

---

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

• SoButtonEvent.h
• SoButtonEvent.cpp