ScXMLEventTarget(3)

💖 ScXMLEventTarget(3) — a Coin manual page, but make it cute 💖

okay so bestie, you opened the Coin manual and landed on ScXMLEventTarget(3), and honestly? it's giving foundational. this is the base-class baddie that every event target in the whole SCXML situation descends from. let's get into it 🫶

---

✨ NAME ✨

ScXMLEventTarget — base class for event targets for inter-system event communication

---

🌸 SYNOPSIS 🌸

#include <Inventor/scxml/ScXMLEventTarget.h>

Inherits ScXMLObject.

Inherited by ScXMLStateMachine, and SoScXMLNavigationTarget.

💅 Public Member Functions

• virtual SoType getTypeId (void) const =0 — hands you back the type identification of an object derived from a class that inherits SoBase. this is the whole reason runtime type checking and "downward" casting even work, no cap.
• virtual void setEventTargetType (const char *targettype) — sets the target type.
• const char * getEventTargetType (void) const — gives you the target type back.
• virtual void setEventTargetName (const char *targetname) — sets the target name.
• const char * getEventTargetName (void) const — gives you the target name back.
• virtual const ScXMLEvent * getCurrentEvent (void) const — the current event, please.
• virtual void queueEvent (const ScXMLEvent *event) — queue an event up, queen.
• virtual void queueEvent (const SbName &eventid) — same thing but you hand it an event id.
• virtual SbBool processEventQueue (void) — go through the queue.
• virtual SbBool sendExternalEvent (const ScXMLSendElt *sendelt) — send an external event.
• virtual SbBool sendInternalEvent (const ScXMLEventElt *sendelt) — send an internal event.
• virtual void queueInternalEvent (const ScXMLEvent *event) — queue an internal event.
• virtual void queueInternalEvent (const SbName &eventid) — queue an internal event by its id.

🦋 Public Member Functions inherited from ScXMLObject

• SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type.

⭐ Static Public Member Functions

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

🎀 Static Public Member Functions inherited from ScXMLObject

• static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
• static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• static void cleanClass (void) — Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin type system.

🔥 Protected Member Functions

• virtual void setCurrentEvent (const ScXMLEvent *event)
• virtual const ScXMLEvent * getNextEvent (void)
• virtual const ScXMLEvent * getNextInternalEvent (void)
• virtual const ScXMLEvent * getNextExternalEvent (void)
• virtual SbBool processOneEvent (const ScXMLEvent *event)

🧚 Static Protected Member Functions

• static void registerEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
• static void unregisterEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
• static ScXMLEventTarget * getEventTarget (const char *targettype, const char *targetname, const char *sessionid=NULL)

💜 Static Protected Member Functions inherited from ScXMLObject

• static void registerClassType (const char *xmlns, const char *classname, SoType type)
• static void registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, SoType type)

🌈 Protected Attributes

• char * targetname
• char * targettype
• const ScXMLEvent * currentevent
• SbBool isprocessingqueue

---

👑 Detailed Description 👑

base class for event targets for inter-system event communication

This class manages inter-communication between SCXML systems and systems intended for communicating with such systems. It also manages the external event queue for such systems (systems may also have internal event queues).

Since — Coin 3.1. so like, vintage. an OG. respect it 💅

---

💖 Member Function Documentation 💖

virtual SoType ScXMLEventTarget::getTypeId (void ) const [pure virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

See also: SoBase::getTypeId() const

Implements ScXMLObject.

Implemented in ScXMLStateMachine, SoScXMLDollyTarget, SoScXMLFlightControlTarget, SoScXMLMiscTarget, SoScXMLMotionTarget, SoScXMLNavigationTarget, SoScXMLPanTarget, SoScXMLRotateTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, SoScXMLStateMachine, and SoScXMLZoomTarget.

(it's =0, bestie — pure virtual. you do not get to skip this one. main character obligation 🫡)

virtual const ScXMLEvent * ScXMLEventTarget::getCurrentEvent (void ) const [inline], [virtual]

This method returns the current event during event processing, and NULL when not processing events.

Event processing is in special cases done with NULL as the current event, as for instance during state machine initialization.

void ScXMLEventTarget::queueEvent (const ScXMLEvent * event) [virtual]

Queues an ScXMLEvent event. The event is copied, and can be deleted as soon as the function returns. so you can let that pointer go, she's got it from here ✨

void ScXMLEventTarget::queueEvent (const SbName & eventid) [virtual]

Queues an ScXMLEvent event that has the given eventid as its event name.

void ScXMLEventTarget::setCurrentEvent (const ScXMLEvent * event) [protected], [virtual]

Sets a pointer for the event that is 'current' during event processing. This is an internal method, and the updating of the current event should be handled automatically. so like, hands off, it's not yours to micromanage 💅

SbBool ScXMLEventTarget::processOneEvent (const ScXMLEvent * event) [protected], [virtual]

This function processes one event. The base class implementation does nothing. literally nothing. it's a placeholder, the actual personality comes from the subclasses.

Reimplemented in ScXMLStateMachine, SoScXMLDollyTarget, SoScXMLFlightControlTarget, SoScXMLMiscTarget, SoScXMLMotionTarget, SoScXMLPanTarget, SoScXMLRotateTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, and SoScXMLZoomTarget.

---

🍓 Author 🍓

Generated automatically by Doxygen for Coin from the source code.

---

okay that's the whole page, you ate it, you're welcome 🎀 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's still filed under ScXMLEventTarget(3). go forth and communicate between systems, bestie 🌟💖