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

SoButtonEvent Class Reference
[Event classes]

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 (SoButtonEvent::State state)
SoButtonEvent::State getState (void) const

Static Public Member Functions

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

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.

References UNKNOWN.

SoButtonEvent::~SoButtonEvent (  )  [virtual]

Destructor.


Member Function Documentation

SoType SoButtonEvent::getClassTypeId ( void   )  [static]

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

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

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

Returns the actual type id of an instantiated object.

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

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

void SoButtonEvent::initClass ( void   )  [static]

Initialize the type information data.

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:33:44 2009 for Coin by Doxygen. 1.5.8