ScXMLObject(3)

💖 ScXMLObject(3) 💖

Library Functions Manual ✨ ScXMLObject

okay bestie, gather round, because today we're meeting the OG mom of the whole SCXML family — the base class that literally everything else is descended from. no cap. 👑

---

✨ NAME ✨

ScXMLObject — the base class for all SCXML objects. like, all all. the whole bloodline. 🧬

---

🌸 SYNOPSIS 🌸

#include <Inventor/scxml/ScXMLObject.h>

Inherited by ScXMLEvent, ScXMLInvoke, and ScXMLStateMachine. (yes queen, the whole nepo-baby lineup 💅)

🎀 Public Member Functions 🎀

• virtual SoType getTypeId (void) const =0
• SbBool isOfType (SoType type) const
• void setXMLAttribute (const char *attribute, const char *value)
• const char * getXMLAttribute (const char *attribute) const
• virtual SbBool handleXMLAttributes (void)
• virtual void setContainer (ScXMLObject *container)
• ScXMLObject * getContainer (void) const
• SbBool isContainedIn (const ScXMLObject *object) const

🦋 Static Public Member Functions 🦋

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

🧚 Static Protected Member Functions 🧚

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

Base class for all SCXML objects. that's it, that's the whole vibe — she's the blueprint everyone else was built from. 🌈

Since Coin 3.0 — vintage, but she's still serving. ⭐

---

💜 Member Function Documentation 💜

🍓 void ScXMLObject::setXMLAttribute (const char * attribute, const char * value)

This method associates a value with an attribute name. It's used for parameter passing while reading by the SCXML reader, but lowkey you can also just use it as a general-purpose attribute dictionary outside of that. 💅

If NULL is passed as the value, the attribute gets removed. poof. gone. 🙈

🌸 const char * ScXMLObject::getXMLAttribute (const char * attribute) const

Returns the string value that was set for an attribute — or NULL if it wasn't set at all. no value, no problem. 💖

🦋 SbBool ScXMLObject::handleXMLAttributes (void ) [virtual]

This one gets called when the file reader has set all the XML attributes on the object and wants the object to, like, handle them and report back whether the values were okay or whether a read error should be produced. it's giving accountability. 📋✨

Returns TRUE if the attributes are ok, and FALSE on error.

This base class implementation does absolutely nothing and just returns TRUE. iconic minimalism, honestly. 💀

Reimplemented in ScXMLInvoke.

🧚 void ScXMLObject::setContainer (ScXMLObject * container) [virtual]

Sets the pointer to the parent ScXML object. it's giving family tree energy. 🌳

⭐ SbBool ScXMLObject::isContainedIn (const ScXMLObject * object) const

This method returns TRUE if the object is contained within the given object argument. And if they're literally the same object? still TRUE, bestie. Otherwise, FALSE is retured.

(yes, "retured" — that's the original's typo, not mine, we keep the lore intact 💀)

🎀 void ScXMLObject::registerClassType (const char * xmlns, const char * classname, SoType type) [static], [protected]

Internal method. Friendly forwarding for ScXMLObject subclasses. 🫶

🌈 void ScXMLObject::registerInvokeClassType (const char * xmlns, const char * targettype, const char * source, SoType type) [static], [protected]

Internal method. Friendly forwarding for ScXMLObject subclasses. (yes, same energy, different signature, don't @ me 💅)

---

💖 Author 💖

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot and not me, but I'm the one explaining it with love. 🎀

---

okay that's the whole page!! Coin, Version 3.1.3 — and yes, ScXMLObject(3) — that's the manual section she lives in, periodt. 💅✨ go forth and subclass responsibly, bestie!! 🦋💜