SoSpaceballButtonEvent(3IV)

NAME
     SoSpaceballButtonEvent (SoSpballEv) - spaceball button press and release
     events

INHERITS FROM
     SoEvent > SoButtonEvent > SoSpaceballButtonEvent

SYNOPSIS
     #include <Inventor_c/events/SoSpaceballButtonEvent.h>

     typedef SoSpaceballButtonEvent
                         SoSpballEv

                              #define SO_SPBALL_PRESS_EV(EVENT,BUTTON)
                                                  (SoSpballEvIsBtnPressEv(EVENT,BUTTON))
                              #define SO_SPBALL_RELEASE_EV(EVENT,BUTTON)
                                                  (SoSpballEvIsBtnReleaseEv(EVENT,BUTTON))

     enum SoSpaceballButtonEventButton {
          SO_SPBALL_EV_ANY      Any spaceball button
          SO_SPBALL_EV_BUTTON1  Spaceball button 1
          SO_SPBALL_EV_BUTTON2  Spaceball button 2
          SO_SPBALL_EV_BUTTON3  Spaceball button 3
          SO_SPBALL_EV_BUTTON4  Spaceball button 4
          SO_SPBALL_EV_BUTTON5  Spaceball button 5
          SO_SPBALL_EV_BUTTON6  Spaceball button 6
          SO_SPBALL_EV_BUTTON7  Spaceball button 7
          SO_SPBALL_EV_BUTTON8  Spaceball button 8
          SO_SPBALL_EV_PICK     Spaceball pick button
     }

          Functions from class SoSpaceballButtonEvent:

     SoSpaceballButtonEvent *  SoSpballEvCreate()
     SoType                    SoSpballEvGetClassTypeId()
     void                      SoSpballEvSetBtn(SoSpballEv *this,
                                    SoSpaceballButtonEventButton b)
     SoSpaceballButtonEventButton
                               SoSpballEvGetBtn(const SoSpballEv *this)
     SbBool                    SoSpballEvIsBtnPressEv(const SoEvent *e,
                                    SoSpaceballButtonEventButton whichButton)
     SbBool                    SoSpballEvIsBtnReleaseEv(const SoEvent *e,
                                    SoSpaceballButtonEventButton whichButton)

          Functions from class SoButtonEvent:

     void                SoSpballEvSetState(SoSpballEv *this,
                              SoButtonEventState s)
     SoButtonEventState  SoSpballEvGetState(const SoSpballEv *this)

          Functions from class SoEvent:

     SoType              SoSpballEvGetTypeId(const SoSpballEv *this)
     SbBool              SoSpballEvIsOfType(const SoSpballEv *this, SoType
                              type)
     void                SoSpballEvSetTime(SoSpballEv *this, SbTime t)
     SbTime              SoSpballEvGetTime(const SoSpballEv *this)
     void                SoSpballEvSetPos(SoSpballEv *this, const SbVec2s *p)
     const SbVec2s *     SoSpballEvGetPos(const SoSpballEv *this)
     const SbVec2s *     SoSpballEvGetPosInVP(const SoSpballEv *this, const
                              SbViewportRegion *vpRgn)
     const SbVec2f *     SoSpballEvGetNormPos(const SoSpballEv *this, const
                              SbViewportRegion *vpRgn)
     void                SoSpballEvSetShiftDown(SoSpballEv *this, SbBool
                              isDown)
     void                SoSpballEvSetCtrlDown(SoSpballEv *this, SbBool
                              isDown)
     void                SoSpballEvSetAltDown(SoSpballEv *this, SbBool isDown)
     SbBool              SoSpballEvWasShiftDown(const SoSpballEv *this)
     SbBool              SoSpballEvWasCtrlDown(const SoSpballEv *this)
     SbBool              SoSpballEvWasAltDown(const SoSpballEv *this)


DESCRIPTION
     SoSpaceballButtonEvent represents spaceball button press and release
     events in the Inventor event model.

FUNCTIONS
     SoSpaceballButtonEvent *  SoSpballEvCreate()
          Constructor.

     SoType                    SoSpballEvGetClassTypeId()
          Return the type id for the SoSpaceballButtonEvent class.

     void                      SoSpballEvSetBtn(SoSpballEv *this,
                                    SoSpaceballButtonEventButton b)
     SoSpaceballButtonEventButton
                               SoSpballEvGetBtn(const SoSpballEv *this)
          Set and get which spaceball button generated the event.

     SbBool                    SoSpballEvIsBtnPressEv(const SoEvent *e,
                                    SoSpaceballButtonEventButton whichButton)
     SbBool                    SoSpballEvIsBtnReleaseEv(const SoEvent *e,
                                    SoSpaceballButtonEventButton whichButton)
          Returns whether the passed event is a spaceball button press or
          release event of the passed button. When SO_SPBALL_EV_ANY is passed,
          this returns TRUE if the event represents a button press or release
          of any spaceball button.


SEE ALSO
     SoEvent, SoButtonEvent, SoKeyboardEvent, SoLocation2Event,
     SoMotion3Event, SoMouseButtonEvent, SoHandleEventAction, SoEventCallback,
     SoSelection, SoInteraction, SoXtDevice