Coin Logo http://www.sim.no/
http://www.coin3d.org/

Public Types | Public Member Functions | Static Public Member Functions
SoButtonEvent Class Reference

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). More...

#include <Inventor/events/SoButtonEvent.h>

Inheritance diagram for SoButtonEvent:
SoEvent SoKeyboardEvent SoMouseButtonEvent SoSpaceballButtonEvent

List of all members.

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

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

Constructor.

Destructor.


Member Function Documentation

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

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoSpaceballButtonEvent, and SoMouseButtonEvent.

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.

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoSpaceballButtonEvent, and SoMouseButtonEvent.

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

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

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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated on Fri Dec 11 2015 03:25:04 for Coin by Doxygen 1.7.6.1.