Manager for processing events and setting states in SCXML structures.
More...
#include <Inventor/scxml/ScXMLStateMachine.h>
|
static SoType | getClassTypeId (void) |
|
static void * | createInstance (void) |
|
static void | initClass (void) |
|
static SoType | getClassTypeId (void) |
|
static void | initClass (void) |
|
Manager for processing events and setting states in SCXML structures.
- Since
- Coin 3.0
void ScXMLStateMachine::initialize |
( |
void |
| ) |
|
|
virtual |
SbBool ScXMLStateMachine::processEventQueue |
( |
void |
| ) |
|
|
virtual |
Recursive calling of this function will be handled by letting the recursive call return immediately, while the first call will continue processing the event queue until it is empty.
SbBool ScXMLStateMachine::isActive |
( |
void |
| ) |
const |
|
virtual |
Returns whether the state machine is active or not.
SbBool ScXMLStateMachine::isFinished |
( |
void |
| ) |
const |
|
virtual |
Returns whether the state machine has run to completion or not.
const ScXMLEvent * ScXMLStateMachine::getCurrentEvent |
( |
void |
| ) |
const |
|
virtual |
This method returns the current event during event processing, and NULL when not processing events.
Event processing is in special cases done with NULL as the current event, as for instance during state machine initialization.
int ScXMLStateMachine::getNumActiveStates |
( |
void |
| ) |
const |
|
virtual |
Returns the number of active states in the state machine. This number should currently be 1, but in the future, when <parallel> is implemented, it can be more.
const ScXMLObject * ScXMLStateMachine::getActiveState |
( |
int |
idx | ) |
const |
|
virtual |
Returns the Nth active state.
const ScXMLObject * ScXMLStateMachine::getState |
( |
const char * |
identifier | ) |
const |
|
virtual |
Returns the state machine state object with the given identifier, or NULL if no object is found that has the given identifier.
void ScXMLStateMachine::addDeleteCallback |
( |
ScXMLStateMachineDeleteCB * |
cb, |
|
|
void * |
userdata |
|
) |
| |
|
virtual |
Registers a callback to be called when the state machine object is being deleted.
void ScXMLStateMachine::removeDeleteCallback |
( |
ScXMLStateMachineDeleteCB * |
cb, |
|
|
void * |
userdata |
|
) |
| |
|
virtual |
Unregisters a callback to be called when the state machine object is being deleted.
void ScXMLStateMachine::addStateChangeCallback |
( |
ScXMLStateChangeCB * |
callback, |
|
|
void * |
userdata |
|
) |
| |
|
virtual |
Registers a callback to be called when the state machine exits or enters a state.
void ScXMLStateMachine::removeStateChangeCallback |
( |
ScXMLStateChangeCB * |
callback, |
|
|
void * |
userdata |
|
) |
| |
|
virtual |
Unregisters a callback to be called when the state machine exits or enters a state.
SbBool ScXMLStateMachine::processOneEvent |
( |
const ScXMLEvent * |
event | ) |
|
|
protectedvirtual |
Processes one event. This is an internal inner event-loop utility function.
void ScXMLStateMachine::setCurrentEvent |
( |
const ScXMLEvent * |
event | ) |
|
|
protectedvirtual |
Sets a pointer for the event that is 'current' during event processing. This is an internal method, and updating the current event is handled automatically.
The documentation for this class was generated from the following files: