ScXMLEvent(3)

💖 ScXMLEvent(3) 💖

okay bestie, sit down, hydrate, because we're talking about ScXMLEvent from the Coin manual. this is a 3D-graphics-library-adjacent, SCXML-state-machine-adjacent situation and honestly? it's giving base class energy in the best way. let's go 🦋

---

✨ NAME ✨

ScXMLEvent — the base class for events sent to SCXML state machines. the blueprint. the blueprint blueprint. the blueprint's blueprint. 👑

---

🌸 SYNOPSIS 🌸

#include <Inventor/scxml/ScXMLEvent.h>

so it Inherits ScXMLObject, and it's Inherited by SoScXMLEvent. family tree's looking cute 💅

🎀 Public Member Functions 🎀

• virtual SoType getTypeId (void) const — hands you the type identification of an object derived from a class inheriting SoBase. this is what makes runtime type checking and "downward" casting possible, no cap.
• virtual void setEventName (const SbName &name) — sets the event's name.
• const SbName & getEventName (void) const — gets the event's name.
• ScXMLEvent * clone (void) const — clones it. copy-paste but make it legal ✨
• void setAssociation (const char *key, const char *value) — sets an association.
• const char * getAssociation (const char *key) const — gets an association.
• size_t getNumAssociations (void) const — how many associations we got.
• size_t getAssociationKeys (SbList< const char * > &keys) const — grab all the association keys into your list.

💜 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. so basically "are you one of us or one of our ancestors" 🫶

⭐ Static Public Member Functions ⭐

• static SoType getClassTypeId (void)
• static void * createInstance (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. the un-init. the anti-init. iconic honestly.

🧚 Protected Member Functions 🧚

• virtual void copyContents (const ScXMLEvent *rhs) — copies the contents over.

🍓 Protected Attributes 🍓

• SbName name — yes. it's a name. we love a self-explanatory queen.

💀 Additional Inherited Members 💀

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)

---

🔥 DESCRIPTION 🔥

Base class for events sent to SCXML state machines. that's the whole vibe. it's the parent of all the little events that go knock-knock on your state machine's door. 🙈

Since: Coin 3.0

---

👑 MEMBER FUNCTION DOCUMENTATION 👑

SoType ScXMLEvent::getTypeId (void ) const [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.

Reimplemented in: SoScXMLEvent.

---

void ScXMLEvent::setEventName (const SbName & namearg) [virtual]

This method is for setting a string that will identify this particular event, having this particular state, and can be used for event matching in the SCXML descriptions.

The string should, according to the specification, be a set of tokens consisting of alphanumeric characters, separated with periods (.). This limitation is not enforced by this implementation. so like, the spec says one thing and the code is just out here living its truth 💀

---

💜 AUTHOR 💜

Generated automatically by Doxygen for Coin from the source code. (not a human, just a robot doing its little robot best 🫶)

---

okay bestie that's the whole page!! this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you just read ScXMLEvent(3). go forth and send some events, you absolute main character ✨💅🌸