trusty (3) SoSpaceballButtonEvent.3.gz

NAME

       SoSpaceballButtonEvent -

       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.

SYNOPSIS

       #include <Inventor/events/SoSpaceballButtonEvent.h>

       Inherits SoButtonEvent.

   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 (Button button)
       Button getButton (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)

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

   enum SoSpaceballButtonEvent::Button
       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::Buttonbuttonarg)
       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::ButtonwhichButton) [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::ButtonwhichButton) [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 (Buttonenumval, 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

Author

       Generated automatically by Doxygen for Coin from the source code.