SoButtonEvent.3coin3 man page

SoButtonEvent — 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).

Synopsis

#include <Inventor/events/SoButtonEvent.h>

Inherits SoEvent.

Inherited by SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

Public Types

enum State { UP, DOWN, UNKNOWN }

Public Member Functions

virtual SoType getTypeId (void) const

SoButtonEvent (void)

virtual ~SoButtonEvent ()

void setState (State state)

State getState (void) const

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass (void)

static SbBool enumToString (State enumval, SbString &stringrep)

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

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

Constructor.

SoButtonEvent::~SoButtonEvent () [virtual]

Destructor.

Member Function Documentation

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

Returns the actual type id of an instantiated object.

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoSpaceballButtonEvent, and SoMouseButtonEvent.

void SoButtonEvent::initClass (void) [static]

Initialize the type information data.

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

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

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

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoButtonEvent.3coin2(3) is an alias of SoButtonEvent.3coin3(3).

Mon Sep 5 2016 Version 3.1.3 Coin