Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

Public Types | Public Member Functions | Static Public Member Functions | List of all members
SoSpaceballButtonEvent Class Reference

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

Public Types

enum  Button {
  ANY, BUTTON1, BUTTON2, BUTTON3,
  BUTTON4, BUTTON5, BUTTON6, BUTTON7,
  BUTTON8, PICK
}
 
- Public Types inherited from SoButtonEvent
enum  State { UP, DOWN, UNKNOWN }
 

Public Member Functions

virtual SoType getTypeId (void) const
 
 SoSpaceballButtonEvent (void)
 
virtual ~SoSpaceballButtonEvent ()
 
void setButton (Button button)
 
Button getButton (void) const
 
- Public Member Functions inherited from SoButtonEvent
 SoButtonEvent (void)
 
virtual ~SoButtonEvent ()
 
void setState (State state)
 
State getState (void) const
 
- Public Member Functions inherited from SoEvent
 SoEvent (void)
 
virtual ~SoEvent ()
 
SbBool isOfType (SoType type) const
 
void setTime (const SbTime t)
 
SbTime getTime (void) const
 
void setPosition (const SbVec2s &p)
 
const SbVec2sgetPosition (void) const
 
const SbVec2s getPosition (const SbViewportRegion &vpRgn) const
 
const SbVec2f getNormalizedPosition (const SbViewportRegion &vpRgn) const
 
void setShiftDown (SbBool isDown)
 
SbBool wasShiftDown (void) const
 
void setCtrlDown (SbBool isDown)
 
SbBool wasCtrlDown (void) const
 
void setAltDown (SbBool isDown)
 
SbBool wasAltDown (void) const
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static void initClass (void)
 
static SbBool isButtonPressEvent (const SoEvent *e, Button whichButton)
 
static SbBool isButtonReleaseEvent (const SoEvent *e, Button whichButton)
 
static SbBool enumToString (Button enumval, SbString &stringrep)
 
- Static Public Member Functions inherited from SoButtonEvent
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static SbBool enumToString (State enumval, SbString &stringrep)
 
- Static Public Member Functions inherited from SoEvent
static SoType getClassTypeId (void)
 
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::getTypeId ( void  ) const
virtual

Returns the actual type id of an instantiated object.

Reimplemented from SoButtonEvent.

void SoSpaceballButtonEvent::initClass ( void  )
static

Initialize the type information data.

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()
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()
SbBool SoSpaceballButtonEvent::enumToString ( Button  enumval,
SbString stringrep 
)
static

Converts from an enum value of type SoMouseButtonEvent::Button 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 © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen