SoMouseButtonEvent(3)

SoMouseButtonEvent(3) 💖 Library Functions Manual but make it fashion ✨

Okay bestie, welcome to the mouse button event page. This is the manual for SoMouseButtonEvent, and it's giving exactly what it says on the tin: info about mousebutton interaction. 🐭💅

---

NAME 🎀

SoMouseButtonEvent — the class that contains information about mousebutton interaction. 🖱️✨

---

SYNOPSIS 🦋

#include <Inventor/events/SoMouseButtonEvent.h>

Inherits SoButtonEvent.

Public Types 🌸

enum Button { ANY, BUTTON1, BUTTON2, BUTTON3, BUTTON4, BUTTON5 }

Public Types inherited from SoButtonEvent 💜

enum State { UP, DOWN, UNKNOWN }

Public Member Functions 💅

virtual SoType getTypeId (void) const
SoMouseButtonEvent (void)
virtual ~SoMouseButtonEvent ()
void setButton (SoMouseButtonEvent::Button button)
SoMouseButtonEvent::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,
    SoMouseButtonEvent::Button whichButton)
static SbBool isButtonReleaseEvent (const SoEvent *e,
    SoMouseButtonEvent::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 SoMouseButtonEvent class contains information about mousebutton interaction. 🖱️

When the user presses any buttons on the mouse, these will be translated from a system specific event into a Coin event and sent to the scenegraph by using instances of this class. ✨

See also:

• SoEvent
• SoButtonEvent
• SoSpaceballButtonEvent
• SoKeyboardEvent
• SoEventCallback
• SoHandleEventAction

---

Member Enumeration Documentation 🔥

enum SoMouseButtonEvent::Button

This enum contains all mouse buttons detected by Coin. 👑

Enumerator

• ANY — Unknown button. 🙈
• BUTTON1 — First mouse button (usually the leftmost button). 👈
• BUTTON2 — Second mouse button (usually the middle button). 👆
• BUTTON3 — Third mouse button (usually the rightmost button). 👉
• BUTTON4 — Fourth mouse button (typically from a wheelmouse). This is not part of the original Open Inventor API. 🖱️
• BUTTON5 — Fifth mouse button (typically from a wheelmouse). This is not part of the original Open Inventor API. 🖱️

---

Constructor & Destructor Documentation 🎀

SoMouseButtonEvent::SoMouseButtonEvent (void )

Constructor. ✨

References ANY.

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

SoMouseButtonEvent::~SoMouseButtonEvent () [virtual]

Destructor. 💀

---

Member Function Documentation 💖

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

Returns the actual type id of an instantiated object. 🔍

Reimplemented from SoButtonEvent.

References SoMouseButtonEvent().

void SoMouseButtonEvent::setButton (SoMouseButtonEvent::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().

SoMouseButtonEvent::Button SoMouseButtonEvent::getButton (void ) const

Returns the value of the button which was pressed or released. 🖱️

See also getState(), wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime().

Referenced by isButtonPressEvent(), and isButtonReleaseEvent().

SbBool SoMouseButtonEvent::isButtonPressEvent (const SoEvent * e, SoMouseButtonEvent::Button whichButton) [static]

Convenience method for quickly checking if the given event is a press on the given button, whichButton. 👆

See also isButtonReleaseEvent(), isOfType(), getButton(), getState().

References ANY, SoButtonEvent::DOWN, getButton(), SoButtonEvent::getState(), SoEvent::isOfType(), SoEvent::SoEvent(), and SoMouseButtonEvent().

Referenced by SoVRMLAnchor::handleEvent(), and SoWWWAnchor::handleEvent().

SbBool SoMouseButtonEvent::isButtonReleaseEvent (const SoEvent * e, SoMouseButtonEvent::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().

References ANY, getButton(), SoButtonEvent::getState(), SoEvent::isOfType(), SoEvent::SoEvent(), SoMouseButtonEvent(), and SoButtonEvent::UP.

void SoMouseButtonEvent::initClass (void ) [static]

Initialize the type information data. 🛠️

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

---

Author 🤖

Generated automatically by Doxygen for Coin from the source code. 💖

---

Coin • Version 2.5.0 • SoMouseButtonEvent(3) — that's the footer tea, bestie. No date in the footer, just pure Coin energy. Stay iconic. 💅✨