SOXTMOUSE(3iv)

💖 SoXtMouse(3IV) — the mouse translator girlies have been WAITING 💖

okay bestie, sit DOWN, because this one is literally the mouse's whole personality in a header file. SoXtMouse translates and reports events for the mouse. That's it. That's the job. She's the middlewoman between your clicky little friend and the rest of the toolkit, and she is so good at it. 🐭✨

This page lives in section 3IV of the manual, so keep that in mind if you're citing her. iykyk.

---

🌸 INHERITS FROM 🌸

SoXtDevice > SoXtMouse

so yeah, she's a SoXtDevice at heart, and SoXtMouse is the glow-up. the family tree is giving legacy code but make it fashion. 💅

---

✨ SYNOPSIS ✨

#include <Inventor/Xt/devices/SoXtMouse.h>

#define SO_XT_ALL_MOUSE_EVENTS
    (ButtonPressMask | ButtonReleaseMask |
     PointerMotionMask | ButtonMotionMask)

Methods from class SoXtMouse:

SoXtMouse(EventMask mask = SO_XT_ALL_MOUSE_EVENTS)
~SoXtMouse()

Methods from class SoXtDevice:

virtual void             enable(Widget w, XtEventHandler f, XtPointer
                              data, Window win = NULL)
virtual void             disable(Widget w, XtEventHandler f, XtPointer
                              data)
virtual const SoEvent *  translateEvent(XAnyEvent *xevent)
void                     setWindowSize(const SbVec2s &size)
const SbVec2s &          getWindowSize() const

look at that lineup. the whole squad is here. 🫶

---

🦋 DESCRIPTION 🦋

This class manages events generated by the mouse. all of them. the whole mouse situation. 💖

That includes:

• mouse motion → she hands you an SoLocation2Event
• mouse button press and release → she hands you an SoMouseButtonEvent

she's not doing anything weird with it, she's just translating and reporting, which is honestly the most reliable friend behavior. no cap. 🎀

---

👑 METHODS 👑

🍓 Constructor & Destructor 🍓

SoXtMouse(EventMask mask = SO_XT_ALL_MOUSE_EVENTS)
~SoXtMouse()

Constructor and destructor, babes. the birth and the farewell. 🥹

To the constructor, you pass which mouse events you are interested in as a bitwise OR of the following values — and yes, you have to pick, she's not a mind reader (she's a mouse reader):

• ButtonPressMask — mouse press events 🖱️
• ButtonReleaseMask — mouse release events
• PointerMotionMask — mouse motion with no buttons
• ButtonMotionMask — mouse motion with buttons pressed

Or, and this is the lazy-girl-friend-approved option, simply pass the defined value SO_XT_ALL_MOUSE_EVENTS for all mouse events. everything. the full buffet. ✨

real talk though: the device will only report events of this type, and only for the widget it is enabled on. so if you didn't ask for it, you're not getting it. the vibe check is strict and that's a good thing. 💅

---

🌈 SEE ALSO 🌈

• SoXtDevice
• SoLocation2Event
• SoMouseButtonEvent

go read those too, bestie, they're the supporting cast and they ate. 🔥

---

mwah 💜 that's the whole page. this one came from the SoXtMouse manpage, section 3IV, footer date field left blank (the version/date line was literally just the title again — not me being mysterious, that's just how the page ships 🙈). now go forth and handle those events. periodt. 💖✨