SoButtonEvent Class Reference
[Events]

Base class for all button events. More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:
SoEvent SoTypedObject SoControllerButtonEvent SoKeyboardEvent SoMouseButtonEvent SoSpaceballButtonEvent

List of all members.

Public Types

enum  State {
  UP,
  DOWN,
  DBCLK,
  UNKNOWN
}

Public Member Functions

virtual SoType getTypeId () const
 SoButtonEvent ()
void setState (SoButtonEvent::State s)
SoButtonEvent::State getState () const

Static Public Member Functions

static SoType getClassTypeId ()

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.

SEE ALSO

SoEvent, SoControllerButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoWinDevice


Member Enumeration Documentation

State.

Enumerator:
UP 

Button up event.

DOWN 

Button down event.

DBCLK 

Button double click event.

UNKNOWN 

Button in unknown state.


Constructor & Destructor Documentation

SoButtonEvent::SoButtonEvent (  ) 

Constructor.


Member Function Documentation

static SoType SoButtonEvent::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoEvent.

Reimplemented in SoControllerButtonEvent, SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

SoButtonEvent::State SoButtonEvent::getState (  )  const [inline]

Gets the state of the button.

virtual SoType SoButtonEvent::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoEvent.

Reimplemented in SoControllerButtonEvent, SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

void SoButtonEvent::setState ( SoButtonEvent::State  s  )  [inline]

Sets the state of the button.


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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/