.TH "SoScXMLStateMachine" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoScXMLStateMachine \- Integration level for using Coin events with SCXML-based state machines\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBScXMLStateMachine\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and "downward" casting\&. " .ti -1c .RI "virtual void \fBsetSceneGraphRoot\fP (\fBSoNode\fP *root)" .br .ti -1c .RI "virtual \fBSoNode\fP * \fBgetSceneGraphRoot\fP (void) const" .br .ti -1c .RI "virtual void \fBsetActiveCamera\fP (\fBSoCamera\fP *camera)" .br .ti -1c .RI "virtual \fBSoCamera\fP * \fBgetActiveCamera\fP (void) const" .br .ti -1c .RI "virtual void \fBsetViewportRegion\fP (const \fBSbViewportRegion\fP &vp)" .br .ti -1c .RI "virtual const \fBSbViewportRegion\fP & \fBgetViewportRegion\fP (void) const" .br .ti -1c .RI "virtual void \fBpreGLRender\fP (void)" .br .ti -1c .RI "virtual void \fBpostGLRender\fP (void)" .br .ti -1c .RI "virtual SbBool \fBprocessSoEvent\fP (const \fBSoEvent\fP *event)" .br .ti -1c .RI "virtual const char * \fBgetVariable\fP (const char *key) const" .br .in -1c Public Member Functions inherited from \fBScXMLStateMachine\fP .in +1c .ti -1c .RI "virtual void \fBsetName\fP (const \fBSbName\fP &name)" .br .ti -1c .RI "const \fBSbName\fP & \fBgetName\fP (void) const" .br .ti -1c .RI "virtual void \fBsetDescription\fP (\fBScXMLDocument\fP *document)" .br .ti -1c .RI "const \fBScXMLDocument\fP * \fBgetDescription\fP (void) const" .br .ti -1c .RI "virtual void \fBsetSessionId\fP (const \fBSbName\fP &sessionid)" .br .ti -1c .RI "const \fBSbName\fP & \fBgetSessionId\fP (void) const" .br .ti -1c .RI "virtual void \fBinitialize\fP (void)" .br .ti -1c .RI "virtual SbBool \fBisActive\fP (void) const" .br .ti -1c .RI "virtual SbBool \fBisFinished\fP (void) const" .br .ti -1c .RI "virtual int \fBgetNumActiveStates\fP (void) const" .br .ti -1c .RI "virtual const \fBScXMLElt\fP * \fBgetActiveState\fP (int idx) const" .br .ti -1c .RI "virtual void \fBaddDeleteCallback\fP (ScXMLStateMachineDeleteCB *callback, void *userdata)" .br .ti -1c .RI "virtual void \fBremoveDeleteCallback\fP (ScXMLStateMachineDeleteCB *callback, void *userdata)" .br .ti -1c .RI "virtual void \fBaddStateChangeCallback\fP (ScXMLStateChangeCB *callback, void *userdata)" .br .ti -1c .RI "virtual void \fBremoveStateChangeCallback\fP (ScXMLStateChangeCB *callback, void *userdata)" .br .ti -1c .RI "virtual void \fBsetVariable\fP (const char *name, const char *value)" .br .ti -1c .RI "virtual void \fBsetLogLevel\fP (int loglevel)" .br .ti -1c .RI "int \fBgetLogLevel\fP (void) const" .br .ti -1c .RI "virtual void \fBsetEvaluator\fP (\fBScXMLEvaluator\fP *evaluator)" .br .ti -1c .RI "\fBScXMLEvaluator\fP * \fBgetEvaluator\fP (void) const" .br .ti -1c .RI "SbBool \fBisModuleEnabled\fP (const char *modulename) const" .br .ti -1c .RI "int \fBgetNumEnabledModules\fP (void) const" .br .ti -1c .RI "const char * \fBgetEnabledModuleName\fP (int idx) const" .br .ti -1c .RI "void \fBsetEnabledModulesList\fP (const \fBSbList\fP< const char * > &modulenames)" .br .in -1c Public Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "virtual void \fBsetEventTargetType\fP (const char *targettype)" .br .ti -1c .RI "const char * \fBgetEventTargetType\fP (void) const" .br .ti -1c .RI "virtual void \fBsetEventTargetName\fP (const char *targetname)" .br .ti -1c .RI "const char * \fBgetEventTargetName\fP (void) const" .br .ti -1c .RI "virtual const \fBScXMLEvent\fP * \fBgetCurrentEvent\fP (void) const" .br .ti -1c .RI "virtual void \fBqueueEvent\fP (const \fBScXMLEvent\fP *event)" .br .ti -1c .RI "virtual void \fBqueueEvent\fP (const \fBSbName\fP &eventid)" .br .ti -1c .RI "virtual SbBool \fBprocessEventQueue\fP (void)" .br .ti -1c .RI "virtual SbBool \fBsendExternalEvent\fP (const \fBScXMLSendElt\fP *sendelt)" .br .ti -1c .RI "virtual SbBool \fBsendInternalEvent\fP (const \fBScXMLEventElt\fP *sendelt)" .br .ti -1c .RI "virtual void \fBqueueInternalEvent\fP (const \fBScXMLEvent\fP *event)" .br .ti -1c .RI "virtual void \fBqueueInternalEvent\fP (const \fBSbName\fP &eventid)" .br .in -1c Public Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const" .br .RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. " .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBScXMLStateMachine\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .ti -1c .RI "static \fBScXMLStateMachine\fP * \fBgetStateMachineForSessionId\fP (const \fBSbName\fP &sessionid)" .br .in -1c Static Public Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .RI "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\&. " .in -1c .SS "Additional Inherited Members" Protected Member Functions inherited from \fBScXMLStateMachine\fP .in +1c .ti -1c .RI "virtual SbBool \fBprocessOneEvent\fP (const \fBScXMLEvent\fP *event)" .br .in -1c Protected Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "virtual void \fBsetCurrentEvent\fP (const \fBScXMLEvent\fP *event)" .br .ti -1c .RI "virtual const \fBScXMLEvent\fP * \fBgetNextEvent\fP (void)" .br .ti -1c .RI "virtual const \fBScXMLEvent\fP * \fBgetNextInternalEvent\fP (void)" .br .ti -1c .RI "virtual const \fBScXMLEvent\fP * \fBgetNextExternalEvent\fP (void)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "static void \fBregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, const char *sessionid=NULL)" .br .ti -1c .RI "static void \fBunregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, const char *sessionid=NULL)" .br .ti -1c .RI "static \fBScXMLEventTarget\fP * \fBgetEventTarget\fP (const char *targettype, const char *targetname, const char *sessionid=NULL)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)" .br .ti -1c .RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const char *source, \fBSoType\fP type)" .br .in -1c Protected Attributes inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "char * \fBtargetname\fP" .br .ti -1c .RI "char * \fBtargettype\fP" .br .ti -1c .RI "const \fBScXMLEvent\fP * \fBcurrentevent\fP" .br .ti -1c .RI "SbBool \fBisprocessingqueue\fP" .br .in -1c .SH "Detailed Description" .PP Integration level for using Coin events with SCXML-based state machines\&. This class is part of integrating the Coin types with the SCXML subsystem\&. SoScXMLStateMachines adds convenience for using SCXML state machines together with Coin events\&. .PP \fBSince\fP .RS 4 Coin 3\&.0 .RE .PP .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoScXMLStateMachine::getTypeId (void ) const\fR [virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and "downward" casting\&. .PP \fBSee also\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Reimplemented from \fBScXMLStateMachine\fP\&. .SS "SbBool SoScXMLStateMachine::processSoEvent (const \fBSoEvent\fP * event)\fR [virtual]\fP" This function makes the state machine process an \fBSoEvent\fP\&. .SS "const char * SoScXMLStateMachine::getVariable (const char * key) const\fR [virtual]\fP" The string returned from this function is only valid until the next variable is requested\&. .PP Reimplemented from \fBScXMLStateMachine\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.