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

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

SoCounter Class Reference

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

#include <Inventor/engines/SoCounter.h>

Inheritance diagram for SoCounter:
SoEngine SoFieldContainer SoBase

List of all members.

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

virtual ~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.

SoCounter::~SoCounter ( void  ) [protected, virtual]

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

Minimum value for counter.

Maximum value for counter.

Counter step value.

Increment counter (using step).

Reset counter to this value. The value will be clamped between min and max, and step will be accounted for.

(SoSFShort) Output which contains the current counter value.

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


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

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen 1.7.3.