ScXMLScxmlElt(3)

✨ ScXMLScxmlElt ✨

okay bestie, welcome to the Coin manual page for ScXMLScxmlElt, straight out of the Coin library (yes that's the manual name, we're in section 3, we move) 💅

---

💖 NAME 💖

ScXMLScxmlElt — bestie, it implements the <scxml> SCXML element. that's the whole job. that's her whole thing. 👑

---

🌸 SYNOPSIS 🌸

#include <Inventor/scxml/ScXMLScxmlElt.h>

Inherits ScXMLElt.

🎀 Public Member Functions 🎀

• virtual SoType getTypeId (void) const — Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and downward"casting.
• void setIsReferenced (SbBool referenced) — sets whether this thing is referenced, fr.
• SbBool isReferenced (void) const — asks her: are you referenced? yes or no.
• virtual void setInitialAttribute (const char *initial) — sets the initial attribute.
• const char * getInitialAttribute (void) const — hands you back the initial attribute.
• virtual void setNameAttribute (const char *name) — sets the name attribute.
• const char * getNameAttribute (void) const — gives you the name attribute.
• virtual void setXMLNSAttribute (const char *xmlns) — sets the xmlns attribute.
• const char * getXMLNSAttribute (void) const — returns the xmlns attribute.
• virtual void setVersionAttribute (const char *version) — sets the version attribute.
• const char * getVersionAttribute (void) const — returns the version attribute.
• virtual void setProfileAttribute (const char *profile) — sets the profile attribute.
• const char * getProfileAttribute (void) const — returns the profile attribute.
• virtual void setExModeAttribute (const char *exmode) — sets the exmode attribute.
• const char * getExModeAttribute (void) const — returns the exmode attribute.
• virtual SbBool handleXMLAttributes (void) — the callback the file reader hits once it's shoved all the XML attributes onto the object.
• virtual void copyContents (const ScXMLElt *rhs) — copies the contents over from rhs.
• virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const — hunts through the SCXML structure for an element with the given attribute value for the given attribute.
• virtual void setInitial (ScXMLInitialElt *initial) — sets the initial element.
• virtual ScXMLInitialElt * getInitial (void) const — gets the initial element.
• virtual int getNumStates (void) const — how many states we got.
• virtual ScXMLStateElt * getState (int idx) const — grab state number idx.
• virtual void addState (ScXMLStateElt *state) — add a state, periodt.
• virtual void removeState (ScXMLStateElt *state) — remove a state.
• virtual void clearAllStates (void) — wipe every state, no survivors.
• virtual int getNumParallels (void) const — how many parallels.
• virtual ScXMLParallelElt * getParallel (int idx) const — grab parallel number idx.
• virtual void addParallel (ScXMLParallelElt *state) — add a parallel.
• virtual void removeParallel (ScXMLParallelElt *state) — remove a parallel.
• virtual void clearAllParallels (void) — bye bye parallels.
• virtual int getNumFinals (void) const — how many finals.
• virtual ScXMLFinalElt * getFinal (int idx) const — grab final number idx.
• virtual void addFinal (ScXMLFinalElt *state) — add a final.
• virtual void removeFinal (ScXMLFinalElt *state) — remove a final.
• virtual void clearAllFinals (void) — all the finals, gone.
• virtual void setDataModel (ScXMLDataModelElt *datamodel) — set the data model.
• virtual ScXMLDataModelElt * getDataModel (void) const — get the data model.
• virtual int getNumScripts (void) const — how many scripts.
• virtual ScXMLScriptElt * getScript (int idx) const — grab script number idx.
• virtual void addScript (ScXMLScriptElt *state) — add a script.
• virtual void removeScript (ScXMLScriptElt *state) — remove a script.
• virtual void clearAllScripts (void) — scripts? deleted.
• virtual void execute (ScXMLStateMachine *statemachine) const — run it against statemachine.

🦋 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 or inherited from type.

💜 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 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 🍓

• SbBool referenced
• char * initial
• char * name
• char * xmlns
• char * version
• char * profile
• char * exmode

🫶 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 <scxml> SCXML element.

An object of this type represents the root <scxml> SCXML element in a document. It has the following attributes:

• initial
• name
• xmlns
• version [REQUIRED] must contain "1.0"
• profile
• exmode — "lax" or "strict"

The <scxml> element can have child elements of the following types:

• initial — zero or one element of this type, depending on whether the "initial" attribute is set or not (one of them must be set, and only one), but only when the <scxml> element is the root element and not an external reference from another document.
• state — zero or more elements
• parallel — zero or more elements
• final — zero or more elements
• datamodel — zero or one if the data model module is enabled

Since

Coin 3.0

---

💅 Member Function Documentation 💅

SoType ScXMLScxmlElt::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 ScXMLElt.

SbBool ScXMLScxmlElt::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.

Returns

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

This base class implementation does nothing and just returns TRUE.

Reimplemented from ScXMLElt.

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

Reimplemented from ScXMLElt.

const ScXMLElt * ScXMLScxmlElt::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.

Returns NULL if nothing was found.

This function needs to be reimplemented to traverse child elements.

Reimplemented from ScXMLElt.

---

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code.

---

okay that's the whole page, no skips, no crumbs left behind 💖 this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you can find her filed under ScXMLScxmlElt(3) in the Coin manual. slay, go build a state machine bestie 🦋✨