SoEventManager(3)

💖 NAME 💖

SoEventManager — the class that handles events for a Coin3D viewer. That's the whole job bestie, and it ate. 👑

---

🦋 SYNOPSIS 🦋

#include <Inventor/SoEventManager.h>

✨ Public Types ✨

enum NavigationState { NO_NAVIGATION, JUST_NAVIGATION, MIXED_NAVIGATION }

✨ Public Member Functions ✨

virtual ~SoEventManager ()
virtual void setSceneGraph (SoNode *const sceneroot)
virtual SoNode * getSceneGraph (void) const
virtual void setCamera (SoCamera *camera)
virtual SoCamera * getCamera (void) const
virtual SbBool processEvent (const SoEvent *const event)
virtual void setNavigationState (NavigationState state)
virtual NavigationState getNavigationState (void) const
int getNumSoScXMLStateMachines (void) const
SoScXMLStateMachine * getSoScXMLStateMachine (int idx) const
void addSoScXMLStateMachine (SoScXMLStateMachine *sm)
void removeSoScXMLStateMachine (SoScXMLStateMachine *sm)
virtual void setSize (const SbVec2s &newsize)
virtual void setOrigin (const SbVec2s &newOrigin)
virtual void setViewportRegion (const SbViewportRegion &newregion)
const SbViewportRegion & getViewportRegion (void) const
virtual void setHandleEventAction (SoHandleEventAction *hea)
virtual SoHandleEventAction * getHandleEventAction (void) const

🌈 Protected Member Functions 🌈

virtual SbBool actuallyProcessEvent (const SoEvent *const event)

---

🌸 Detailed Description 🌸

Okay so SoEventManager is literally the event-handling queen for a Coin3D viewer. 💅

It receives Coin events (usually translated from GUI events by whatever GUI binding you're using) and then passes them along to the state machine or straight to the scene graph — depends on the navigation mode, no cap. SoEventManager implements the event interface for the Coin3D navigation system, which is based on ScXML. 🧚

And the lore: SoEventManager and SoRenderManager together supersede SoSceneManager, which is now just a wrapper around these two classes. Periodt. 💀 It's the class the QuarterWidget uses in Quarter (that's the Qt binding for Coin3D, iykyk). 🫶

---

👑 Member Enumeration Documentation 👑

⭐ enum SoEventManager::NavigationState ⭐

This one sets how events are handled. The vibe check for your input, basically. ✨

Enumerator:

• NO_NAVIGATION — forwards the events only to the scene graph.
• JUST_NAVIGATION — forwards the events only to the state machines.
• MIXED_NAVIGATION — forwards the events to the scene graph first. If it doesn't get handled, then the events get forwarded to the state machines. Best of both worlds, honestly. 💅

---

🎀 Constructor & Destructor Documentation 🎀

🌟 SoEventManager::~SoEventManager () [virtual] 🌟

Destructor. 🫧

When it's invoked, the destructor destructs all subobjects it still has handles on. So like, it cleans up after itself, slay. 🧹✨

---

💜 Member Function Documentation 💜

🦋 void SoEventManager::setSceneGraph (SoNode *const sceneroot) [virtual] 🦋

Sets the node that's the top of the scene graph we're managing. The sceneroot node reference count gets increased by 1, and whatever scene graph top node was set before gets its reference count decreased by 1. Mutual, fair, iconic. 💅

See also: getSceneGraph

🦋 SoNode * SoEventManager::getSceneGraph (void ) const [virtual] 🦋

Returns the pointer to the root of the scene graph. Here's your crown bestie 👑

🦋 void SoEventManager::setCamera (SoCamera * camera) [virtual] 🦋

Sets the camera to be used. That's it, that's the function. 📸

🦋 SoCamera * SoEventManager::getCamera (void ) const [virtual] 🦋

Returns the current camera. Smile! 😁

🦋 SbBool SoEventManager::processEvent (const SoEvent *const event) [virtual] 🦋

Handles the event. Depending on the navigation state, this forwards the event to the state machines and/or the scene graph. Yeah it's the group-chat forwarder of the Coin3D world. 💌

🦋 void SoEventManager::setNavigationState (NavigationState state) [virtual] 🦋

This method sets the navigation mode of the scene manager. The navigation mode decides the system the user uses to navigate the 3D model. 🧭

Heads up bestie: SoEventManager::NO_NAVIGATION is the default setting. 💖

See also: SoEventManager::NavigationState, getNavigationState

🦋 SoEventManager::NavigationState SoEventManager::getNavigationState (void ) const [virtual] 🦋

This method returns which state the camera navigation system is in. Basically "what mode are we in rn" energy. 🫶

See also: SoEventManager::NavigationState, setNavigationState

🦋 int SoEventManager::getNumSoScXMLStateMachines (void ) const 🦋

Returns the number of SCXML state machines registered on the SoEventManager object. Count 'em. 🔢

🦋 SoScXMLStateMachine * SoEventManager::getSoScXMLStateMachine (int idx) const 🦋

Returns the pointer to the Nth (idx) SCXML state machine registered on the SoSceneManager object.

Okay so real talk: the idx argument must be a valid index, not outside the actual range of SCXML state machine object indices. Don't be out here indexing into the void. 💀

🦋 void SoEventManager::addSoScXMLStateMachine (SoScXMLStateMachine * sm) 🦋

Adds an SCXML state machine object to the SoEventManager's event pipeline. ⚡

Careful bestie: if it's not removed before SoSceneManager destruction, the SoSceneManager destructor will delete it. 😭

🦋 void SoEventManager::removeSoScXMLStateMachine (SoScXMLStateMachine * sm) 🦋

Removes the SoSceneManager object's reference to an SCXML state machine. It will just be removed, not destructed. It's giving "we're not deleting you, we're just not inviting you to the party". 🙈

If no reference to the given SCXML state machine exists, nothing will happen. No drama, no error. ✨

🦋 void SoEventManager::setSize (const SbVec2s & newsize) [virtual] 🦋

Set the size of the rendering area for the viewport, within the current window. 📐

🦋 void SoEventManager::setOrigin (const SbVec2s & newOrigin) [virtual] 🦋

Sets only the origin of the viewport region, within the rendering window. Just the origin, nothing else, don't get greedy. 💅

See also: setViewportRegion(), setWindowSize()

🦋 void SoEventManager::setViewportRegion (const SbViewportRegion & newregion) [virtual] 🦋

Sets the current viewport region. This will overwrite the default viewport region that was created in the constructor. Out with the old, in with the new. 🌈

See also: getViewportRegion()

🦋 const SbViewportRegion & SoEventManager::getViewportRegion (void ) const 🦋

Returns the viewport region used by the event manager. 🖼️

🦋 void SoEventManager::setHandleEventAction (SoHandleEventAction * handleeventaction) [virtual] 🦋

Set the action to use for event handling. This overrides the default action that was made in the constructor. Main character energy, honestly. 👑

🦋 SoHandleEventAction * SoEventManager::getHandleEventAction (void ) const [virtual] 🦋

Returns the pointer to the event handler action. 🫶

🦋 SbBool SoEventManager::actuallyProcessEvent (const SoEvent *const event) [protected], [virtual] 🦋

Forwards the event to the scene graph. Short, sweet, does exactly what it says on the tin. ✨

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. It wrote itself, we just vibed with it. 🧚💖

---

And that's a wrap, bestie! This page is from Coin, Version 3.1.3, and it's the SoEventManager(3) manual page. Go forth and handle those events. Periodt. 💅✨🎀