Linux Certif

Toute la documentation sur la certification Linux LPI

SoCounter.3coin2

NAME

SoCounter -

The SoCounter class is an integer counter engine.

The engine counts from its min value to its max value, adding the value of step each time trigger is touched.

SYNOPSIS

#include <Inventor/engines/SoCounter.h>

Inherits SoEngine.

Public Member Functions

SoCounter (void)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFShort min

SoSFShort max

SoSFShort step

SoSFTrigger trigger

SoSFShort reset

SoEngineOutput output

SoEngineOutput syncOut

Protected Member Functions

~SoCounter (void)

Detailed Description

The SoCounter class is an integer counter engine.

The engine counts from its min value to its max value, adding the value of step each time trigger is touched.

SoCounter provides a convenient way of keeping track of the number of times some event in your application is triggered.

Constructor & Destructor Documentation

SoCounter::SoCounter (void)Default constructor.

References SoEngineOutput::enable(), max, min, output, reset, step, syncOut, and trigger.

SoCounter::~SoCounter (void) [protected]Destructor.

Protected, as engines are not supposed to be explicitly deleted, but rather take care of their own destiny by monitoring their reference count.

Member Function Documentation

void SoCounter::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.

Member Data Documentation

SoSFShort SoCounter::minMinimum value for counter.

Referenced by SoCounter().

SoSFShort SoCounter::maxMaximum value for counter.

Referenced by SoCounter().

SoSFShort SoCounter::stepCounter step value.

Referenced by SoCounter().

SoSFTrigger SoCounter::triggerIncrement counter (using step).

Referenced by SoCounter().

SoSFShort SoCounter::resetReset counter to this value. The value will be clamped between min and max, and step will be accounted for.

Referenced by SoCounter().

SoEngineOutput SoCounter::output(SoSFShort) Output which contains the current counter value.

Referenced by SoCounter().

SoEngineOutput SoCounter::syncOut(SoSFTrigger) Triggers every time counter restarts at SoCounter::min.

Referenced by SoCounter().

Author

Generated automatically by Doxygen for Coin from the source code.