ScXMLEventElt(3)

🎀 ScXMLEventElt 🎀

okay bestie, welcome to the Coin manual, section 3 — this page is all about ScXMLEventElt, and ngl she is that girl. 💅

---

✨ NAME ✨

ScXMLEventElt — the class that implements the <event> SCXML element. periodt.

---

🦋 SYNOPSIS 🦋

#include <Inventor/scxml/ScXMLEventElt.h>

Inherits ScXMLExecutableElt. 💖

👑 Public Member Functions

• virtual SoType getTypeId (void) const — hands you the type identification of an object derived from a class that inherits SoBase. it's literally the whole reason runtime type checking and downward casting exist. iconic.
• virtual void setNameAttribute (const char *name)
• virtual const char * getNameAttribute (void) const
• virtual SbBool handleXMLAttributes (void)
• virtual void copyContents (const ScXMLElt *rhs)
• virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const
• ScXMLEvent * createEvent (ScXMLEventTarget *host) const
• virtual void execute (ScXMLStateMachine *statemachine) const

🌸 Public Member Functions inherited from ScXMLElt

• void setXMLAttribute (const char *attribute, const char *value)
• const char * getXMLAttribute (const char *attribute) const
• ScXMLElt * clone (void) const
• virtual void setContainer (ScXMLElt *container)
• ScXMLElt * getContainer (void) const
• SbBool isContainedIn (const ScXMLElt *object) const

💜 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 as type or inherited from type. no cap.

⭐ Static Public Member Functions

• static ScXMLEltReader * getElementReader (void)
• static SoType getClassTypeId (void)
• static void * createInstance (void)
• static void initClass (void)
• static void cleanClass (void)

🌈 Static Public Member Functions inherited from ScXMLExecutableElt

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

🦋 Static Public Member Functions inherited from ScXMLElt

• 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 Attributes

• char * name

🧚 Additional Inherited Members

Static Protected Member Functions inherited from ScXMLElt

• 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)

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)

---

💖 Detailed Description 💖

implements the <event> SCXML element. that's the whole job bestie. 💅

Since

Coin 3.1 — so she's been serving since way back. 🫶

---

🔥 Member Function Documentation 🔥

SoType ScXMLEventElt::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. (it's giving type system main character energy ✨)

See also

SoBase::getTypeId() const

Implements ScXMLExecutableElt.

SbBool ScXMLEventElt::handleXMLAttributes (void ) [virtual]

This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were OK or if a read error should be produced. lowkey a whole vibe check for your XML attributes.

Returns

TRUE if the attributes are OK, and FALSE on error.

This base class implementation does nothing and just returns TRUE. ngl, she's just chillin'.

Reimplemented from ScXMLElt.

void ScXMLEventElt::copyContents (const ScXMLElt * rhs) [virtual]

Reimplemented from ScXMLExecutableElt.

const ScXMLElt * ScXMLEventElt::search (const char * attrname, const char * attrvalue) const [virtual]

This method searches the SCXML structure for an element with the given attribute value for the given attribute. she's out here hunting for that one element. 🔍

Returns

NULL if nothing was found. (sad girl hours 😭)

This function needs to be reimplemented to traverse child elements. don't forget the kids fr fr.

Reimplemented from ScXMLElt.

void ScXMLEventElt::execute (ScXMLStateMachine * statemachine) const [virtual]

Reimplemented from ScXMLExecutableElt.

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. (yes bestie, the robots wrote it and they ate. 👑)

---

okay and for the cute lil sign-off: this page is from Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and implement that <event> element, you absolute icon. 🦋✨💖