SoSpaceballButtonEvent(3)

💅 SoSpaceballButtonEvent 💅 (NAME)

okay so bestie, this is SoSpaceballButtonEvent — a page from the Library Functions Manual — and it's literally the class that holds all the tea about spaceball button interaction. 👑

---

✨ SYNOPSIS ✨

#include <Inventor/events/SoSpaceballButtonEvent.h>

Inherits SoButtonEvent. 💖

🌸 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 — grab the actual type id of the object.
• SoSpaceballButtonEvent (void) — constructor, makes a new one.
• virtual ~SoSpaceballButtonEvent () — destructor, says bye.
• void setButton (Button button) — set which button it was.
• Button getButton (void) const — read which button it was.

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 SbVec2s & getPosition (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. that's the whole assignment bestie. 🫶

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. so like, your spaceball press goes through a whole glow-up journey before the scenegraph even hears about it. ✨

See also:

• SoEvent, SoButtonEvent, SoMouseButtonEvent, SoKeyboardEvent
• SoEventCallback, SoHandleEventAction

---

🌈 Member Enumeration Documentation 🌈

🍓 enum SoSpaceballButtonEvent::Button

This enum contains all spaceball buttons detected by Coin. every single one of them, no crumbs left. 💖

---

🧚 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. lowkey the laziest way to check and that's a compliment. 💅

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.

not me noticing the docs say SoMouseButtonEvent::Button in a spaceball page 💀 anyway, that's exactly what it says, so I'm passing it along fr fr.

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. the robots wrote it, I just gave it main character energy. 😭

---

and that's the whole page bestie!! this one came from Coin, Version 3.1.3, and it's manual page SoSpaceballButtonEvent(3) — slay, go forth and handle your spaceball buttons 💖✨🎀