ScXMLDocument(3)

💖 NAME 💖

ScXMLDocument — bestie, this is the Coin manual page, section 3, and we're about to get so cozy with it. 🎀

---

✨ SYNOPSIS ✨

Okay so first things first, you gotta pull it in:

#include <Inventor/scxml/Document.h>

And guess what — it Inherits ScXMLObject. Family tree matters, iykyk. 🦋

---

🌸 Public Member Functions 🌸

• virtual SoType getTypeId (void) const — hands you back the type identification of an object derived from a class inheriting SoBase. It's for runtime type checking and "downward" casting. Basically it's the "who even am I" function. 💅
• void setFilename (const char *filename) — sets the filename. That's it, that's the tweet. ✨
• const char * getFilename (void) const — reads the filename back out. ✨
• virtual void setRoot (ScXMLScxmlElt *root) — sets the root. 👑
• ScXMLScxmlElt * getRoot (void) const — gets the root. 👑
• ScXMLAbstractStateElt * getStateById (SbName id) const — grabs a state by its id. 🔍
• ScXMLDataElt * getDataById (SbName id) const — grabs data 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. No cap, it's the vibe check for class lineage. 🌈

---

⭐ Static Public Member Functions ⭐

• static SoType getClassTypeId (void) — the class-level type id. 🎀
• static void * createInstance (void) — makes you a fresh instance. ✨
• static void initClass (void) — sets the class up. ✨
• static void cleanClass (void) — tears the class back down. ✨
• static ScXMLDocument * readFile (const char *filename) — reads a document from a file. 📂
• static ScXMLDocument * readBuffer (const SbByteBuffer &buffer) — reads a document from a buffer. 🧺
• static ScXMLDocument * readXMLData (cc_xml_doc *xmldoc) — reads a document from raw XML data. 📜

---

💜 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. 🧹

---

🦋 Additional Inherited Members 🦋

Static Protected Member Functions inherited from ScXMLObject

• static void registerClassType (const char *xmlns, const char *classname, SoType type) — registers a class type. 🎀
• static void registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, SoType type) — registers an invoke class type. 🎀

---

👑 Detailed Description 👑

The <ScXMLDocument class is a container class for a complete SCXML document. It's literally the whole-document holder, the main character of the file. 💖

---

🔥 Member Function Documentation 🔥

SoType ScXMLDocument::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.

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (Not me hand-writing lore, bestie — the robots did it. 🤖✨)

---

And that's a wrap, gorgeous! 💅 This was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, straight from the ScXMLDocument(3) era of the Coin manual. Go forth and container-ize your SCXML documents, periodt. 🎀🦋💖