SoSpaceballButtonEvent(3)

📦 version 2.5.0, in fedora 43, fedora 44

💫 SoSpaceballButtonEvent(3) — Library Functions Manual 💫

okay bestie, gather round, because we're talking about SoSpaceballButtonEvent from section 3 of the manual (Library Functions Manual, iykyk) 🫶

✨ NAME ✨

SoSpaceballButtonEvent — the class that holds all the tea about spaceball button interaction 🛰️🎀

🌸 SYNOPSIS 🌸

#include <Inventor/events/SoSpaceballButtonEvent.h>

Inherits SoButtonEvent. It's giving legacy, it's giving "my ancestor is SoEvent", and honestly? Iconic. 👑

🦋 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 (SoSpaceballButtonEvent::Button button)
  • SoSpaceballButtonEvent::Button getButton (void) const

🌈 Public Member Functions inherited from SoButtonEvent

  • SoButtonEvent (void)
  • virtual ~SoButtonEvent ()
  • void setState (SoButtonEvent::State state)
  • SoButtonEvent::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 SbBool isButtonPressEvent (const SoEvent *e, SoSpaceballButtonEvent::Button whichButton)
  • static SbBool isButtonReleaseEvent (const SoEvent *e, SoSpaceballButtonEvent::Button whichButton)
  • static void initClass (void)

🧚 Static Public Member Functions inherited from SoButtonEvent

  • static SoType getClassTypeId (void)
  • static void initClass (void)

🍓 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. No cap. 🛰️💖

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… the spaceball does a thing, Coin goes "say less", and an event gets yeeted straight into the scenegraph. Main character energy fr fr. ✨

👀 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. It's giving birth to an event, literally. 🐣

Referenced by getTypeId(), initClass(), isButtonPressEvent(), and isButtonReleaseEvent().

💜 SoSpaceballButtonEvent::~SoSpaceballButtonEvent () [virtual]

Destructor. RIP to the event, you served cunt. 😭💅

✨ Member Function Documentation ✨

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

Returns the actual type id of an instantiated object. Like, who are you really. 🪞

Reimplemented from SoButtonEvent.

References SoSpaceballButtonEvent().

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

Set the value of the button which the user interacted with. Tell it which button got pressed, bestie. 🫵

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. Which button was it? The plot thickens. 👀

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. It's the "did they press it tho" check. Fast, effortless, slay. 💅

See also

  • isButtonReleaseEvent(), isOfType(), getButton(), getState()

References SoButtonEvent::DOWN, SoEvent::isOfType(), SoButtonEvent::SoButtonEvent(), SoEvent::SoEvent(), and SoSpaceballButtonEvent().

🌸 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 "okay they let go, we can all relax now" check. 😌

See also

  • isButtonPressEvent(), isOfType(), getButton(), getState()

References SoEvent::isOfType(), SoButtonEvent::SoButtonEvent(), SoEvent::SoEvent(), SoSpaceballButtonEvent(), and SoButtonEvent::UP.

🧚 void SoSpaceballButtonEvent::initClass (void ) [static]

Initialize the type information data. Gotta set up the whole type system before anything else shows up to the party. 🎉

References SoButtonEvent::SoButtonEvent(), and SoSpaceballButtonEvent().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not a human, not a girlie, just a doc generator doing its lil thing. 🤖✨

okay that's the whole page bestie, go forth and handle those spaceball events 💖

Coin — Version 2.5.0 — SoSpaceballButtonEvent(3) 🦋 mwah, drink water, close your fds 💜

📦 where this page comes from