SoTimeCounter(3)

NAME
SoTimeCounter - The SoTimeCounter class is an integer counter engine.

The SoTimeCounter engine is by default connected to the realTime global field, and does stepwise updates on the SoTimeCounter::output field according to the field settings.

SYNOPSIS

#include <Inventor/engines/SoTimeCounter.h>

Inherits SoEngine.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoTimeCounter ()

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

  Public Attributes
SoSFTime timeIn
SoSFShort min
SoSFShort max
SoSFShort step
SoSFBool on
SoSFFloat frequency
SoMFFloat duty
SoSFShort reset
SoSFTrigger syncIn
SoEngineOutput output
SoEngineOutput syncOut

  Protected Member Functions
virtual ~SoTimeCounter (void)
virtual void inputChanged (SoField *which)
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 SoTimeCounter class is an integer counter engine.

The SoTimeCounter engine is by default connected to the realTime global field, and does stepwise updates on the SoTimeCounter::output field according to the field settings.

Constructor & Destructor Documentation

  SoTimeCounter::SoTimeCounter (void)
Default constructor.

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

Member Function Documentation

  SoType SoTimeCounter::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 * SoTimeCounter::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 * SoTimeCounter::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 SoTimeCounter::inputChanged (SoField * which) [protected], [virtual]
Called when an input is changed. The default method does nothing, but subclasses may override this method to do The Right Thing when a specific field is changed.

Reimplemented from SoEngine.

  void SoTimeCounter::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 SoTimeCounter::timeIn
Running time. Connected to the realTime field by default.

  SoSFShort SoTimeCounter::min
Minimum counter value. Default value is 0.

  SoSFShort SoTimeCounter::max
Maximum counter value. Default value is 1.

  SoSFShort SoTimeCounter::step
Counter step size. Default value is 1.

  SoSFBool SoTimeCounter::on
Set to FALSE to pause the counter. Default value is TRUE.

  SoSFFloat SoTimeCounter::frequency
Number of complete cycles from the min value to the max value per second. Default value is 1.0.

  SoMFFloat SoTimeCounter::duty
Used to weight step times. Supply one weight value per step. Default array is a single value of 1.0.

  SoSFShort SoTimeCounter::reset
Manually set the counter to some value. If SoTimeCounter::reset is set below the SoTimeCounter::min value or above the SoTimeCounter::max value it will be clamped to the closest boundary value.

  SoSFTrigger SoTimeCounter::syncIn
Restart counter at the minimum value.

  SoEngineOutput SoTimeCounter::output
(SoSFShort) The counter value.

  SoEngineOutput SoTimeCounter::syncOut
(SoSFTrigger) Triggers every cycle start.

Author

Generated automatically by Doxygen for Coin from the source code.