ScXMLEvent(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 ScXMLEvent(3) 💖

Library Functions Manual — yes bestie, this is a section 3 page, we're in library-functions territory, and today's main character is ScXMLEvent. Buckle up. 🎀

✨ NAME ✨

ScXMLEvent — the base class for events that get sent to SCXML state machines. It's the blueprint, the blueprint-y blueprint, the ancestral vibe from which event-ness flows. 💅

🌈 SYNOPSIS 🌈

#include <Inventor/scxml/ScXMLEvent.h>

So first things first: it inherits ScXMLObject. And it's inherited by SoScXMLEvent. A whole little family tree, iconic honestly. 👑

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void setIdentifier (const SbName &identifier)
  • const SbName & getIdentifier (void) const

🦋 Public Member Functions inherited from ScXMLObject

  • 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 * createInstance (void)
  • static void initClass (void)

💜 Static Public Member Functions inherited from ScXMLObject

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

🌸 Protected Attributes

  • SbName identifier — the protected little secret. 🙈

🧚 Additional Inherited Members

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 💫

Base class for events sent to SCXML state machines. That's the whole assignment, and it does it flawlessly. ✨

Since

Coin 3.0 — vintage, but make it slay. 🕰️

🎀 MEMBER FUNCTION DOCUMENTATION 🎀

SoType ScXMLEvent::getTypeId (void ) const [virtual]

Implements ScXMLObject. That's it, that's the note. She's a one-liner and she knows it. 💅

void ScXMLEvent::setIdentifier (const SbName & identifierarg) [virtual]

Okay so this method is literally for setting a string that will identify this particular event — as in, this one, having this particular state — and you can use it for event matching in the SCXML descriptions. It's the event's little nametag. 🏷️

The string should, according to spec., be a set of tokens made up of alphanumeric characters, separated with periods (.). Like foo.bar.baz, you know the vibe.

⚠️ But heads up bestie: this limitation is NOT enforced by this implementation. She's not checking your grammar. She trusts you. Don't make it weird. 😭

(And yeah, getIdentifier shows up in the synopsis but has no doc entry of its own here — not me pointing it out, just keeping it 100. 🫶)

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. No human wrote this, which is honestly so real of it. 🤖

And that's the page, bestie!! 💖 This was Coin, Version 3.1.3, the ScXMLEvent(3) page, and you absolutely ate this read. Go forth and match some events. Periodt. 🎀✨🦋

📦 where this page comes from