SoScXMLEvent(3)

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
virtual void setSoEvent (const SoEvent *soevent)
virtual const SoEvent * getSoEvent (void) const
virtual void setUpIdentifier (void)

  Static Public Member Functions
static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)

  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:
    Coin 3.0

Member Function Documentation

  void SoScXMLEvent::setSoEvent (const SoEvent * soevent) [virtual]
This function stores a pointer to the originator SoEvent that caused the given event, if any.

There is no resource management with regards to this pointer - it has to be kept alive on the outside for as long as this event may live, and be deallocated on the outside as well.

See also:
    setUpIdentifiers

  const SoEvent * SoScXMLEvent::getSoEvent (void) const [virtual]
Returns the pointer stored by setSoEvent() or NULL if no pointer has been stored yet.

See also:
    setSoEvent

  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:
    setSoEvent

Author

Generated automatically by Doxygen for Coin from the source code.