SoButtonEvent(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

SoButtonEvent — it's giving "the base class for all button events," and honestly? Mother. This is from the Coin manual, and she's iconic. 💅

✨ SYNOPSIS ✨

#include <Inventor/events/SoButtonEvent.h>

Bestie, real quick, the family tree: this class Inherits SoEvent. And Inherited by SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent — yeah, she's got kids. 👑

🎀 Public Types 🎀

  • enum State { UP, DOWN, UNKNOWN } — the three moods of a button, no cap.

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const — tells you what type this actually is at runtime.
  • SoButtonEvent (void) — constructor, hello.
  • virtual ~SoButtonEvent () — destructor, bye.
  • void setState (State state) — set the state, slay.
  • State getState (void) const — read the state back out.

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) — the class-level type id, periodt.
  • static void initClass (void) — sets everything up.
  • static SbBool enumToString (State enumval, SbString &stringrep) — enum to string, so handy.

Static Public Member Functions inherited from SoEvent

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

🌸 Detailed Description 🌸

So like, the SoButtonEvent class is the base class for all button events. That's the whole vibe.

Every event class that pops off when a user pushes buttons on some device — keyboard, mouse, or spaceball — inherits from this one. So if you're picturing the family reunion, they're all there. 🧚 The SoButtonEvent class is the one holding the methods for setting and getting the state of the button(s).

See also

  • SoEvent, SoKeyboardEvent, SoMouseButtonEvent, SoSpaceballButtonEvent
  • SoEventCallback, SoHandleEventAction

🦋 Member Enumeration Documentation 🦋

enum SoButtonEvent::State

This is literally the actual state of the button. Like, what is she doing right now. 🙈

  • UP — Button has been released. She's free, she's at peace. 🕊️
  • DOWN — Button has been pressed down. Committed. Pressed. Down. 💅
  • UNKNOWN — The state of the button is unknown. We do not know her. 🤷‍♀️

🌈 Constructor & Destructor Documentation 🌈

SoButtonEvent::SoButtonEvent (void )

Constructor. Baby's first button event. 🎀

SoButtonEvent::~SoButtonEvent () [virtual]

Destructor. She's leaving the group chat. 😭

⭐ Member Function Documentation ⭐

SoType SoButtonEvent::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. No cap.

SoType SoButtonEvent::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. Bestie, it's the vibe check for types. 👑

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

void SoButtonEvent::initClass (void ) [static]

Initialize the type information data. Just do it, fr fr. ✨

void SoButtonEvent::setState (SoButtonEvent::State state)

Set the state 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. So it's the translator of the whole operation, lowkey essential.

See also

  • getState()

SoButtonEvent::State SoButtonEvent::getState (void ) const

Returns the state of the button which is the cause of the event, i.e. whether it was pushed down or released. She's the one who did this. 🔥

See also

  • wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()

SbBool SoButtonEvent::enumToString (State enumval, SbString & stringrep) [static]

Converts from an enum value of type SoButtonEvent::State to a string containing the enum symbol. Translating enum energy into text energy, we love to see it. 🫶

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Heads up bestie — this one is Coin-only. The original SGI Open Inventor v2.1 API does not have it. Don't go looking for it there. 💀

Since

  • Coin 3.0

💌 Author 💌

Generated automatically by Doxygen for Coin from the source code. Not a human author, just a very productive robot. 🤖💖

Okay so that's the whole page, and here's the cute lil sign-off: this is Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it lives in the manual as SoButtonEvent(3). Byeee, go press some buttons. 💅🎀✨

📦 where this page comes from