enum Flags { RETRIGGERABLE = 1, HOLD_FINAL = 2 }

virtual SoType getTypeId (void) const

virtual const SoFieldData * getFieldData (void) const

virtual const SoEngineOutputData * getOutputData (void) const

SoOneShot (void)

static SoType getClassTypeId (void)

static void * createInstance (void)

static void initClass (void)

SoSFTime timeIn

SoSFTime duration

SoSFTrigger trigger

SoSFBitMask flags

SoSFBool disable

SoEngineOutput timeOut

SoEngineOutput isActive

SoEngineOutput ramp

~SoOneShot ()

static const SoFieldData ** getInputDataPtr (void)

static const SoEngineOutputData ** getOutputDataPtr (void)

There are two flags available: RETRIGGERABLE will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run (otherwise the trigger is ignored during runs).

HOLD_FINAL will make the engine outputs keep their values after a run, instead of resetting them.

Default constructor.

Destructor is protected to avoid explicit destruction.

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoEngine.

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example:

  void foo(SoNode * node)
  {
    if (node->getTypeId() == SoFile::getClassTypeId()) {
      SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
    }
  }

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoEngine.

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoEngine.

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoEngine.

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoEngine.

Input time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source.

The time the engine should run for when it is triggered. Defaults to 1 second.

A pulse on this input field starts the engine.

Control flags. See SoOneShot::Flags.

Reimplemented from SoEngine.

Set to TRUE to disable the engine completely.

(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.

(SoSFBool) TRUE while the engine is running, FALSE otherwise.

(SoSFFloat) Will run from 0 to 1 during the active period.