SoSpaceballButtonEvent(3)

💖 SoSpaceballButtonEvent — a Coin manual page, bestie edition 💖

okay so this is SoSpaceballButtonEvent(3), a page from the Coin manual, and it's literally all about spaceball button interaction. yes, spaceball. the 3D mouse thing. it's giving retro-futuristic and we're obsessed. 🦋

---

✨ NAME ✨

SoSpaceballButtonEvent — the class that holds all the info about spaceball button interaction. that's it, that's the whole job. 💅

---

🎀 SYNOPSIS 🎀

#include <Inverter/events/SoSpaceballButtonEvent.h>

wait no 😭 — it's:

#include <Inventor/events/SoSpaceballButtonEvent.h>

Inherits SoButtonEvent. family tree matters, okay?

🌸 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 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 👑

SoSpaceballButtonEvent is the class that carries around all the info about spaceball button interaction. main character energy, honestly.

so like — when the user presses any buttons on a spaceball device, those get translated from a system specific event into a Coin event, and then they get sent to the scene graph using instances of this class. that's the whole pipeline. no cap. 🔥

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. 💖

Enumerator

• ANY — any of the buttons. yes, all of them. chaotic but valid.
• BUTTON1 — spaceball button 1.
• BUTTON2 — spaceball button 2.
• BUTTON3 — spaceball button 3.
• BUTTON4 — spaceball button 4.
• BUTTON5 — spaceball button 5.
• BUTTON6 — spaceball button 6.
• BUTTON7 — spaceball button 7.
• BUTTON8 — spaceball button 8.
• PICK — spaceball pick button. the pick one. iconic.

---

🦋 Constructor & Destructor Documentation 🦋

SoSpaceballButtonEvent::SoSpaceballButtonEvent (void )

Constructor. it makes one. slay. ✨

SoSpaceballButtonEvent::~SoSpaceballButtonEvent () [virtual]

Destructor. it unmakes one. 😭

---

💅 Member Function Documentation 💅

SoType SoSpaceballButtonEvent::getClassTypeId (void ) [static]

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

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

returns the type identification of an object derived from a class inheriting SoEvent. this is used for runtime type checking and "downward" casting. very detective of it. 🔍

Reimplemented from SoButtonEvent.

void SoSpaceballButtonEvent::initClass (void ) [static]

initialize the type information data. set it up, queen. 👑

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

sets 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. iykyk.

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. quick lil vibe check on your event. ✅

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. the letting-go check. 🙈

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. glow-up from enum to string. 💖

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. not a human, just a very diligent robot. 🤖✨

---

okay bestie that's the whole page!! this was SoSpaceballButtonEvent(3) from Coin, version 4.0.10, dated Thu Jun 25 2026 00:00:00. go press some spaceball buttons, you absolute legend. periodt. 💅🎀🦋🌈⭐💜