NAME

       SoElapsedTime -

       The SoElapsedTime class is a controllable time source engine.

       The additional functionality provided by this engine versus just connecting to the
       realTime global field is the ability to control the speed of the time source plus logic to
       reset, stop and restart it.

SYNOPSIS

       #include <Inventor/engines/SoElapsedTime.h>

       Inherits SoEngine.

   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 const SoFieldData * getFieldData (void) const
       virtual const SoEngineOutputData * getOutputData (void) const
       SoElapsedTime (void)

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

   Public Attributes
       SoSFTime timeIn
       SoSFFloat speed
       SoSFBool on
       SoSFBool pause
       SoSFTrigger reset
       SoEngineOutput timeOut

   Protected Member Functions
       virtual ~SoElapsedTime (void)
       virtual void writeInstance (SoOutput *out)

   Static Protected Member Functions
       static const SoFieldData ** getInputDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoElapsedTime class is a controllable time source engine.

       The additional functionality provided by this engine versus just connecting to the
       realTime global field is the ability to control the speed of the time source plus logic to
       reset, stop and restart it.

       Simple usage example, combined with SoComposeRotation:

       #Inventor V2.1 ascii

       Separator {
          Transform {
             rotation =
             ComposeRotation { axis 0 1 0  angle =
                ElapsedTime { }.timeOut
             }.rotation
          }
          Cube { }
       }

       See Also:
           SoTimeCounter

Constructor & Destructor Documentation

   SoElapsedTime::SoElapsedTime (void)
       Default constructor.

   SoElapsedTime::~SoElapsedTime (void) [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoElapsedTime::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. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)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.

   const SoFieldData * SoElapsedTime::getFieldData (void) const [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoFieldContainer.

   const SoEngineOutputData * SoElapsedTime::getOutputData (void) const [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Implements SoEngine.

   void SoElapsedTime::writeInstance (SoOutput *out) [protected],  [virtual]
       Writes all the fields contained in this instance to the output stream within out.

       This method is solely called from the write methods of fields.

       Either from SoField if the write is done because of a field-to-field connection, or from
       one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode,
       SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.

       This method, in addition to the ordinary write() method of SoNode, needs to be present
       since the fields don't have a write action instance in their writeValue() method, and
       writeInstance() will create a new SoWriteAction and call continueToApply() on it.

       Reimplemented from SoEngine.

Member Data Documentation

   SoSFTime SoElapsedTime::timeIn
       Input time value. Default connected to the global realTime field.

   SoSFFloat SoElapsedTime::speed
       Decides how fast the timer should run, measured versus 'real time' from the timeIn field.
       Default value is 1.0.

       A negative value makes the time go backward.

   SoSFBool SoElapsedTime::on
       Shuts timer on and off. Will restart at the same position.

   SoSFBool SoElapsedTime::pause
       Shuts timer on and off. Will restart at the position it would have been if not paused
       (i.e. doesn't 'lose time').

   SoSFTrigger SoElapsedTime::reset
       Restart timer at 0.

   SoEngineOutput SoElapsedTime::timeOut
       (SoSFTime) Output time value. Starts at 0.

Author

       Generated automatically by Doxygen for Coin from the source code.