NAME¶

SoScXMLEvent - Adds an SoEvent holder to the ScXMLEvent base.

SYNOPSIS¶

#include <Inventor/scxml/SoScXMLEvent.h> Inherits ScXMLEvent.

Public Member Functions¶

virtual SoType getTypeId (void) const Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. virtual void setSoEvent (const SoEvent *soevent) virtual const SoEvent * getSoEvent (void) const virtual void setUpIdentifier (void) virtual void copyContents (const ScXMLEvent *rhs)

Static Public Member Functions¶

static SoType getClassTypeId (void) This static method returns the SoType object associated with objects of this class. static void * createInstance (void) 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. 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 typesystem.

Additional Inherited Members¶

Detailed Description¶

Adds an SoEvent holder to the ScXMLEvent base. This class is part of integrating the Coin types with the SCXML subsystem. SoScXMLEvent objects are ScXMLEvents that wraps/passes an SoEvent to the SCXML state machine. Since:

Member Function Documentation¶

SoType SoScXMLEvent::getClassTypeId (void) [static]¶

This static method returns the SoType object associated with objects of this class. See Also: Reimplemented from ScXMLEvent.

SoType SoScXMLEvent::getTypeId (void) const [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: Reimplemented from ScXMLEvent.

void SoScXMLEvent::initClass (void) [static]¶

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. See Also: Reimplemented from ScXMLEvent.

void SoScXMLEvent::setSoEvent (const SoEvent *soevent) [virtual]¶

This function stores a pointer to the originator SoEvent that caused the given event, if any. The event is duplicated when set, and can be deleted immediately by the caller. See Also:

const SoEvent * SoScXMLEvent::getSoEvent (void) const [virtual]¶

Returns the pointer to the stored SoEvent or NULL if no event has been stored yet. See Also:

void SoScXMLEvent::setUpIdentifier (void) [virtual]¶

This method updates the ScXMLEvent event class and event identifier strings based on the set SoEvent object. The identifiers will be cleared if no SoEvent object has been stored. See Also:

Author¶

Generated automatically by Doxygen for Coin from the source code.