Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoTimeCounter Class Reference

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. More...

#include <Inventor/engines/SoTimeCounter.h>

Inheritance diagram for SoTimeCounter:
SoEngine SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoTimeCounter ()

Static Public Member Functions

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 ()
virtual void inputChanged (SoField *which)
virtual void writeInstance (SoOutput *out)

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  )
SoTimeCounter::~SoTimeCounter ( ) [protected, virtual]

Destructor.


Member Function Documentation

void SoTimeCounter::initClass ( void  ) [static]

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

Reimplemented from 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 The Right Thing when a specific field is changed.

Reimplemented from SoEngine.

References duty, SoEngineOutput::enable(), frequency, SbTime::getValue(), max, min, on, output, reset, step, syncIn, syncOut, and timeIn.

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.

References SoField::connectFrom(), SoField::disconnect(), SoField::getConnectedField(), SoDB::getGlobalField(), SoField::isDefault(), SoField::setDefault(), timeIn, and SoEngine::writeInstance().


Member Data Documentation

Running time. Connected to the realTime field by default.

Referenced by inputChanged(), SoTimeCounter(), and writeInstance().

Minimum counter value. Default value is 0.

Referenced by inputChanged(), and SoTimeCounter().

Maximum counter value. Default value is 1.

Referenced by inputChanged(), and SoTimeCounter().

Counter step size. Default value is 1.

Referenced by inputChanged(), and SoTimeCounter().

Set to FALSE to pause the counter. Default value is TRUE.

Referenced by inputChanged(), and SoTimeCounter().

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

Referenced by inputChanged(), and SoTimeCounter().

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

Referenced by inputChanged(), and SoTimeCounter().

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.

Referenced by inputChanged(), and SoTimeCounter().

Restart counter at the minimum value.

Referenced by inputChanged(), and SoTimeCounter().

(SoSFShort) The counter value.

Referenced by inputChanged(), and SoTimeCounter().

(SoSFTrigger) Triggers every cycle start.

Referenced by inputChanged(), and SoTimeCounter().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:22 for Coin by Doxygen. 1.7.3