SoCounter Class Reference
[Engines]

Triggered integer counter. More...

#include <Inventor/engines/SoCounter.h>

Inheritance diagram for SoCounter:
SoEngine SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Classes

struct  Stage

Public Member Functions

virtual SoType getTypeId () const
 SoCounter ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFShort min
SoSFShort max
SoSFShort step
SoSFTrigger trigger
SoSFShort reset
SoEngineOutput output
SoEngineOutput syncOut

Detailed Description

Triggered integer counter.

This engine is a counter that outputs numbers, starting at a minimum value, increasing by a step value, and ending with a number that does not exceed the maximum value. It outputs the next number whenever the trigger input is touched. When the maximum number is reached, it starts counting from the beginning again.

At any time the counter can be reset to a specific value by setting the reset input field to that value. The next time the counter is triggered it will start counting from there. Note that the counter will always output numbers based on the min, max and step values, and setting the reset value does not affect those input fields. If the reset value is not a legal counter value, the counter will still behave as though it is.

Each time a counting cycle is started, the syncOut output is triggered. This output can be used to synchronize some other event with the counting cycle.

FILE FORMAT/DEFAULT

SEE ALSO

SoTimeCounter, SoEngineOutput


Constructor & Destructor Documentation

SoCounter::SoCounter (  ) 

Constructor.


Member Function Documentation

static SoType SoCounter::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoEngine.

virtual SoType SoCounter::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.


Member Data Documentation

Maximum value for the counter.

Minimum value for the counter.

( SoSFShort ) Counts min-to-max in step increments.

At the next trigger, reset the counter to the specified value.

Counter step value.

( SoSFTrigger ) Triggers at cycle start.

Go to the next step.


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

Open Inventor Toolkit reference manual, generated on 1 Nov 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/