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
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual const SoFieldData * getFieldData (void) const
       virtual const SoEngineOutputData * getOutputData (void) const
       SoCounter (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void * createInstance (void)
       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)

   Static Protected Member Functions
       static const SoFieldData ** getInputDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (void)

   Additional Inherited Members

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

   SoType SoCounter::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: this method needs to be overridden in all subclasses. This
       is typically done as part of setting up the full type system for extension classes, which
       is usually accomplished by using the pre-defined macros available through for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Implements SoBase.

   const SoFieldData * SoCounter::getFieldData (void) const [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoFieldContainer.

   const SoEngineOutputData * SoCounter::getOutputData (void) const [virtual]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

       Implements SoEngine.

Member Data Documentation

   SoSFShort SoCounter::min
       Minimum value for counter.

   SoSFShort SoCounter::max
       Maximum value for counter.

   SoSFShort SoCounter::step
       Counter step value.

   SoSFTrigger SoCounter::trigger
       Increment counter (using step).

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

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

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

Author

       Generated automatically by Doxygen for Coin from the source code.