ScXMLOnExitElt(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

✨ ScXMLOnExitElt ✨

okay bestie, we're reading the ScXMLOnExitElt(3) manpage from the Coin manual and it is lowkey iconic πŸ’… this one implements the <onexit> SCXML element, and yes it's giving very "small class, huge responsibilities" energy πŸ‘‘


🌸 NAME 🌸

ScXMLOnExitElt β€” implements the <onexit> SCXML element. periodt.


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/scxml/ScXMLOnExitElt.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. (yes the original quote has that lil stray quote in downward"casting β€” we keep it, no cap, character for character 🫢)
  • virtual int getNumExecutables (void) const β€” how many executables are in here, as a number.
  • virtual ScXMLExecutableElt * getExecutable (int idx) const β€” grab the executable sitting at index idx.
  • virtual void addExecutable (ScXMLExecutableElt *executable) β€” add an executable to the pile.
  • virtual void removeExecutable (ScXMLExecutableElt *executable) β€” yeet an executable back out.
  • virtual void clearAllExecutables (void) β€” remove literally all of them, clean slate energy ✨
  • 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 execute (ScXMLStateMachine *statemachine) const β€” runs this thing against statemachine.

🌈 Public Member Functions inherited from ScXMLElt 🌈

  • void setXMLAttribute (const char *attribute, const char *value) β€” set an XML attribute.
  • const char * getXMLAttribute (const char *attribute) const β€” get an XML attribute back.
  • virtual SbBool handleXMLAttributes (void) β€” handle those XML attributes.
  • ScXMLElt * clone (void) const β€” clone it.
  • virtual void setContainer (ScXMLElt *container) β€” set the container.
  • ScXMLElt * getContainer (void) const β€” get the container.
  • SbBool isContainedIn (const ScXMLElt *object) const β€” is it contained in object? mystery solved.

πŸŽ€ 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. fr fr, it's the vibe check for types.

⭐ Static Public Member Functions ⭐

  • static ScXMLEltReader * getElementReader (void) β€” hands you the element reader.
  • static SoType getClassTypeId (void) β€” the class's SoType.
  • static void * createInstance (void) β€” makes an instance.
  • static void initClass (void) β€” sets the class up.
  • static void cleanClass (void) β€” tears it back down.

πŸ’œ 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. so basically the factory reset 🧚

πŸ¦‹ 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 <onexit> SCXML element. that's the whole vibe, honestly.

Since: Coin 3.0 ✨ (she's been here a minute)


πŸ’… Member Function Documentation πŸ’…

πŸ’– SoType ScXMLOnExitElt::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.

πŸ“ void ScXMLOnExitElt::copyContents (const ScXMLElt * rhs) [virtual] πŸ“

Reimplemented from ScXMLElt.

🌈 const ScXMLElt * ScXMLOnExitElt::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. (ngl, she will absolutely come back empty-handed sometimes 😭)

This function needs to be reimplemented to traverse child elements.

Reimplemented from ScXMLElt.


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code. (so if the prose is a little stiff, blame the robot, not me πŸ™ˆ)


aaaand that's the whole page bestie 🫢 this was ScXMLOnExitElt(3), straight out of Coin, Version 4.0.10, dated Thu Jun 25 2026 00:00:00. go forth and <onexit> responsibly, mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from