Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
SoScXMLStateMachine Class Reference

Integration level for using Coin events with SCXML-based state machines. More...

#include <Inventor/scxml/SoScXMLStateMachine.h>

Inheritance diagram for SoScXMLStateMachine:
ScXMLStateMachine ScXMLEventTarget ScXMLObject

Public Member Functions

virtual SoCameragetActiveCamera (void) const
 
virtual SoNodegetSceneGraphRoot (void) const
 
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.
 
virtual const char * getVariable (const char *key) const
 
virtual const SbViewportRegiongetViewportRegion (void) const
 
virtual void postGLRender (void)
 
virtual void preGLRender (void)
 
virtual SbBool processSoEvent (const SoEvent *event)
 
virtual void setActiveCamera (SoCamera *camera)
 
virtual void setSceneGraphRoot (SoNode *root)
 
virtual void setViewportRegion (const SbViewportRegion &vp)
 
- Public Member Functions inherited from ScXMLStateMachine
virtual void addDeleteCallback (ScXMLStateMachineDeleteCB *callback, void *userdata)
 
virtual void addStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)
 
virtual const ScXMLEltgetActiveState (int idx) const
 
const ScXMLDocumentgetDescription (void) const
 
const char * getEnabledModuleName (int idx) const
 
ScXMLEvaluatorgetEvaluator (void) const
 
int getLogLevel (void) const
 
const SbNamegetName (void) const
 
virtual int getNumActiveStates (void) const
 
int getNumEnabledModules (void) const
 
const SbNamegetSessionId (void) const
 
virtual void initialize (void)
 
virtual SbBool isActive (void) const
 
virtual SbBool isFinished (void) const
 
SbBool isModuleEnabled (const char *modulename) const
 
virtual void removeDeleteCallback (ScXMLStateMachineDeleteCB *callback, void *userdata)
 
virtual void removeStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)
 
virtual void setDescription (ScXMLDocument *document)
 
void setEnabledModulesList (const SbList< const char * > &modulenames)
 
virtual void setEvaluator (ScXMLEvaluator *evaluator)
 
virtual void setLogLevel (int loglevel)
 
virtual void setName (const SbName &name)
 
virtual void setSessionId (const SbName &sessionid)
 
virtual void setVariable (const char *name, const char *value)
 
- Public Member Functions inherited from ScXMLEventTarget
virtual const ScXMLEventgetCurrentEvent (void) const
 
const char * getEventTargetName (void) const
 
const char * getEventTargetType (void) const
 
virtual SbBool processEventQueue (void)
 
virtual void queueEvent (const SbName &eventid)
 
virtual void queueEvent (const ScXMLEvent *event)
 
virtual void queueInternalEvent (const SbName &eventid)
 
virtual void queueInternalEvent (const ScXMLEvent *event)
 
virtual SbBool sendExternalEvent (const ScXMLSendElt *sendelt)
 
virtual SbBool sendInternalEvent (const ScXMLEventElt *sendelt)
 
virtual void setEventTargetName (const char *targetname)
 
virtual void setEventTargetType (const char *targettype)
 
- 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.
 

Static Public Member Functions

static void cleanClass (void)
 
static voidcreateInstance (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from ScXMLStateMachine
static void cleanClass (void)
 
static voidcreateInstance (void)
 
static SoType getClassTypeId (void)
 
static ScXMLStateMachinegetStateMachineForSessionId (const SbName &sessionid)
 
static void initClass (void)
 
- Static Public Member Functions inherited from ScXMLEventTarget
static void cleanClass (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from ScXMLObject
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.
 
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.
 

Additional Inherited Members

- Protected Member Functions inherited from ScXMLStateMachine
virtual SbBool processOneEvent (const ScXMLEvent *event)
 
- Protected Member Functions inherited from ScXMLEventTarget
virtual const ScXMLEventgetNextEvent (void)
 
virtual const ScXMLEventgetNextExternalEvent (void)
 
virtual const ScXMLEventgetNextInternalEvent (void)
 
virtual void setCurrentEvent (const ScXMLEvent *event)
 
- Static Protected Member Functions inherited from ScXMLEventTarget
static ScXMLEventTargetgetEventTarget (const char *targettype, const char *targetname, const char *sessionid=NULL)
 
static void registerEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
 
static void unregisterEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
 
- 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)
 
- Protected Attributes inherited from ScXMLEventTarget
const ScXMLEventcurrentevent
 
SbBool isprocessingqueue
 
char * targetname
 
char * targettype
 

Detailed Description

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.

Since
Coin 3.0

Member Function Documentation

◆ getTypeId()

SoType SoScXMLStateMachine::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

Reimplemented from ScXMLStateMachine.

◆ getVariable()

const char * SoScXMLStateMachine::getVariable ( const char * key) const
virtual

The string returned from this function is only valid until the next variable is requested.

Reimplemented from ScXMLStateMachine.

◆ processSoEvent()

SbBool SoScXMLStateMachine::processSoEvent ( const SoEvent * event)
virtual

This function makes the state machine process an SoEvent.


The documentation for this class was generated from the following files: