SoCounter - triggered integer counter

SoBase > SoFieldContainer > SoEngine > SoCounter

#include <Inventor/engines/SoCounter.h> Inputs from class SoCounter: c } c } min

c } c } max

c } c } step

c } c } trigger

c } c } reset Outputs from class SoCounter: c } c } output

c } c } syncOut Methods from class SoCounter: c } c } SoCounter() Methods from class SoEngine: c } c } getClassTypeId()

c } c } getOutputs(SoEngineOutputList &list) const

c } c } getOutput(const SbName &outputName) const

c } c } getOutputName(const SoEngineOutput *output, SbName &outputName) const

c } c } copy() const

c } c } getByName(const SbName &name)

c } c } getByName(const SbName &name, SoEngineList &list) Methods from class SoFieldContainer: c } c } setToDefaults()

c } c } hasDefaultValues() const

c } c } fieldsAreEqual(const SoFieldContainer *fc) const

c } c } copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)

c } c } set(const char *fieldDataString)

c } c } get(SbString &fieldDataString)

c } c } getFields(SoFieldList &resultList) const

c } c } getField(const SbName &fieldName) const

c } c } getFieldName(const SoField *field, SbName &fieldName) const

c } c } isNotifyEnabled() const

c } c } enableNotify(SbBool flag) Methods from class SoBase: c } c } ref()

c } c } unref() const

c } c } unrefNoDelete() const

c } c } touch()

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } setName(const SbName &name)

c } c } getName() const

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.

If reset is greater than max, the counter is set to max. If reset is less than min, the counter is set to min. If reset is between steps, the counter is set to the lower step value.

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.

c } c } min

Minimum value for the counter. c } c } max

Maximum value for the counter. c } c } step

Counter step value. c } c } trigger

Go to the next step. c } c } reset

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

c } c } output

Counts min-to-max in step increments. c } c } syncOut

Triggers at cycle start.

c } c } SoCounter()

Constructor

Counter {
min	0
max	1
step	1
trigger	
reset	0
}

SoTimeCounter, SoEngineOutput