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

SoSpaceballButtonEvent Class Reference
[Event classes]

The SoSpaceballButtonEvent class contains information about spaceball button interaction.

When the user presses any buttons on a spaceball device, these will be translated from a system specific event into a Coin event and sent to the scenegraph by using instances of this class. More...

#include <Inventor/events/SoSpaceballButtonEvent.h>

Inheritance diagram for SoSpaceballButtonEvent:

SoButtonEvent SoEvent

List of all members.

Public Types

enum  Button {
  ANY, BUTTON1, BUTTON2, BUTTON3,
  BUTTON4, BUTTON5, BUTTON6, BUTTON7,
  BUTTON8, PICK
}

Public Member Functions

virtual SoType getTypeId (void) const
 SoSpaceballButtonEvent (void)
virtual ~SoSpaceballButtonEvent ()
void setButton (SoSpaceballButtonEvent::Button button)
SoSpaceballButtonEvent::Button getButton (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static SbBool isButtonPressEvent (const SoEvent *e, SoSpaceballButtonEvent::Button whichButton)
static SbBool isButtonReleaseEvent (const SoEvent *e, SoSpaceballButtonEvent::Button whichButton)
static void initClass (void)


Detailed Description

The SoSpaceballButtonEvent class contains information about spaceball button interaction.

When the user presses any buttons on a spaceball device, these will be translated from a system specific event into a Coin event and sent to the scenegraph by using instances of this class.

See also:
SoEvent, SoButtonEvent, SoMouseButtonEvent, SoKeyboardEvent

SoEventCallback, SoHandleEventAction


Member Enumeration Documentation

This enum contains all spaceball buttons detected by Coin.


Constructor & Destructor Documentation

SoSpaceballButtonEvent::SoSpaceballButtonEvent ( void   ) 

Constructor.

SoSpaceballButtonEvent::~SoSpaceballButtonEvent (  )  [virtual]

Destructor.


Member Function Documentation

SoType SoSpaceballButtonEvent::getClassTypeId ( void   )  [static]

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

Reimplemented from SoButtonEvent.

Referenced by isButtonPressEvent(), and isButtonReleaseEvent().

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

Returns the actual type id of an instantiated object.

Reimplemented from SoButtonEvent.

void SoSpaceballButtonEvent::setButton ( SoSpaceballButtonEvent::Button  buttonarg  ) 

Set the value 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:
getButton()

SoSpaceballButtonEvent::Button SoSpaceballButtonEvent::getButton ( void   )  const

Returns the value of the button which was pressed or released.

See also:
getState()

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

SbBool SoSpaceballButtonEvent::isButtonPressEvent ( const SoEvent e,
SoSpaceballButtonEvent::Button  whichButton 
) [static]

Convenience method for quickly checking if the given event is a press on the given button, whichButton.

See also:
isButtonReleaseEvent(), isOfType(), getButton(), getState()

References SoButtonEvent::DOWN, getClassTypeId(), SoButtonEvent::getState(), and SoEvent::isOfType().

SbBool SoSpaceballButtonEvent::isButtonReleaseEvent ( const SoEvent e,
SoSpaceballButtonEvent::Button  whichButton 
) [static]

Convenience method for quickly checking if the given event is a release of the given button, whichButton.

See also:
isButtonPressEvent(), isOfType(), getButton(), getState()

References getClassTypeId(), SoButtonEvent::getState(), SoEvent::isOfType(), and SoButtonEvent::UP.

void SoSpaceballButtonEvent::initClass ( void   )  [static]

Initialize the type information data.

Reimplemented from SoButtonEvent.


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:34:01 2009 for Coin by Doxygen. 1.5.8