ScXMLAbstractStateElt(3)

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

πŸ’– ScXMLAbstractStateElt(3) πŸ’–

okay bestie, welcome to the Coin manual, section 3, and today's main character is ScXMLAbstractStateElt β€” she's abstract, she's a base class, and she is literally the blueprint for the SCXML state elements. πŸŽ€


✨ NAME ✨

ScXMLAbstractStateElt β€” abstract base class for the SCXML state elements.


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/scxml/ScXMLAbstractStateElt>

Inherits ScXMLElt.

Inherited by ScXMLFinalElt, ScXMLParallelElt, and ScXMLStateElt. (yes she has three daughters and they're all iconic πŸ’…)

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const =0 β€” returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and downward"casting.
  • virtual void setIdAttribute (const char *id) β€” sets the id attribute, no cap.
  • const char * getIdAttribute (void) const β€” hands you back the id attribute.
  • virtual SbBool handleXMLAttributes (void) β€” checks the XML attributes, more on her below πŸ‘‡
  • virtual void copyContents (const ScXMLElt *rhs) β€” copies contents over from rhs.
  • virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const β€” searches the SCXML structure for an element with the given attribute value for the given attribute.

🫢 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. so basically "are you her or are you her descendant, bestie" πŸ’€

⭐ Static Public Member Functions ⭐

  • 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. it's giving "we don't talk anymore" 😭

πŸŽ€ Protected Attributes πŸŽ€

  • char * id

🌈 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 πŸ‘‘

abstract base class for the SCXML state elements.

Since

Coin 3.1 β€” she's been that girl since 3.1, periodt. ✨


πŸ’œ Member Function Documentation πŸ’œ

πŸ¦‹ virtual SoType ScXMLAbstractStateElt::getTypeId (void ) const [pure 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.

Implemented in ScXMLFinalElt, ScXMLParallelElt, and ScXMLStateElt. (the three heiresses, as established πŸ‘‘)

🌸 SbBool ScXMLAbstractStateElt::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. literally the chillest base class alive, she's just vibing 😌

Reimplemented from ScXMLElt.

Reimplemented in ScXMLParallelElt, and ScXMLStateElt.

πŸŽ€ void ScXMLAbstractStateElt::copyContents (const ScXMLElt * rhs) [virtual]

Reimplemented from ScXMLElt.

⭐ const ScXMLElt * ScXMLAbstractStateElt::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. (ghosted fr 😭)

This function needs to be reimplemented to traverse child elements.

Reimplemented from ScXMLElt.

Reimplemented in ScXMLFinalElt, ScXMLParallelElt, and ScXMLStateElt.


🫢 Author 🫢

Generated automatically by Doxygen for Coin from the source code. (not me writing my own autobiography, Doxygen did that πŸŽ€)


sign-off time, bestie πŸ’– this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you were reading the ScXMLAbstractStateElt(3) page the whole time. slay, no cap, go forth and handle those XML attributes. πŸ’…βœ¨πŸŒΈ
πŸ“¦ where this page comes from