table of contents
other versions
- jessie 3.1.4~abc9f50-7
ScXMLEventTarget(3) | Coin | ScXMLEventTarget(3) |
NAME¶
ScXMLEventTarget - base class for event targets for inter-system event communicationSYNOPSIS¶
#include <Inventor/scxml/ScXMLEventTarget.h> Inherits ScXMLObject. Inherited by ScXMLStateMachine, and SoScXMLNavigationTarget.Public Member Functions¶
virtual SoType getTypeId (void) const =0
Static Public Member Functions¶
static SoType getClassTypeId (void)
Protected Member Functions¶
virtual void setCurrentEvent (const ScXMLEvent *event)
Static Protected Member Functions¶
static void registerEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
Protected Attributes¶
char * targetname
Detailed Description¶
base class for event targets for inter-system event communication This class manages inter-communication between SCXML systems and systems intended for communicating with such systems. It also manages the external event queue for such systems (systems may also have internal event queues). Since:Coin 3.1
Member Function Documentation¶
virtual SoType ScXMLEventTarget::getTypeId (void) const [pure virtual]¶
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. See also:SoBase::getTypeId() const
Implements ScXMLObject.
Implemented in ScXMLStateMachine, SoScXMLNavigationTarget,
SoScXMLDollyTarget, SoScXMLZoomTarget, SoScXMLPanTarget,
SoScXMLRotateTarget, SoScXMLSeekTarget,
SoScXMLSpinTarget, SoScXMLStateMachine,
SoScXMLFlightControlTarget, SoScXMLMiscTarget, and
SoScXMLMotionTarget.
const ScXMLEvent * ScXMLEventTarget::getCurrentEvent (void) const [inline], [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.void ScXMLEventTarget::queueEvent (const ScXMLEvent *event) [virtual]¶
Queues an ScXMLEvent event. The event is copied, and can be deleted as soon as the function return.void ScXMLEventTarget::queueEvent (const SbName &eventid) [virtual]¶
Queues an ScXMLEvent event that has the given eventid as its event name.void ScXMLEventTarget::setCurrentEvent (const ScXMLEvent *event) [protected], [virtual]¶
Sets a pointer for the event that is 'current' during event processing. This is an internal method, and the updating of the current event should be handled automatically.SbBool ScXMLEventTarget::processOneEvent (const ScXMLEvent *event) [protected], [virtual]¶
This function processes one event. The base class implementation does nothing. Reimplemented in ScXMLStateMachine, SoScXMLPanTarget, SoScXMLDollyTarget, SoScXMLRotateTarget, SoScXMLZoomTarget, SoScXMLFlightControlTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, SoScXMLMiscTarget, and SoScXMLMotionTarget.Author¶
Generated automatically by Doxygen for Coin from the source code.Thu May 29 2014 | Version 4.0.0a |