![]() |
http://www.sim.no/ http://www.coin3d.org/ |
The SoCounter class is an integer counter engine. More...
#include <Inventor/engines/SoCounter.h>
Public Attributes | |
SoSFShort | min |
SoSFShort | max |
SoSFShort | step |
SoSFTrigger | trigger |
SoSFShort | reset |
SoEngineOutput | output |
SoEngineOutput | syncOut |
Protected Member Functions | |
virtual | ~SoCounter (void) |
![]() | |
SoEngine (void) | |
virtual | ~SoEngine (void) |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
void | writeOutputTypes (SoOutput *out) |
![]() | |
SoFieldContainer (void) | |
virtual | ~SoFieldContainer () |
![]() | |
SoBase (void) | |
virtual | ~SoBase () |
SbBool | hasMultipleWriteRefs (void) const |
SbBool | writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const |
void | writeFooter (SoOutput *out) const |
virtual const char * | getFileFormatName (void) const |
Static Protected Member Functions | |
static const SoFieldData ** | getInputDataPtr (void) |
static const SoEngineOutputData ** | getOutputDataPtr (void) |
![]() | |
static const SoFieldData ** | getInputDataPtr (void) |
static const SoEngineOutputData ** | getOutputDataPtr (void) |
![]() | |
static uint32_t | getCurrentWriteCounter (void) |
static void | staticDataLock (void) |
static void | staticDataUnlock (void) |
Additional Inherited Members | |
![]() | |
enum | BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 } |
![]() | |
SbBool | isBuiltIn |
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.
SoCounter::SoCounter | ( | void | ) |
Default constructor.
|
protectedvirtual |
Destructor.
Protected, as engines are not supposed to be explicitly deleted, but rather take care of their own destiny by monitoring their reference count.
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:
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.
|
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.
|
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.
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.
Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.
Generated on Mon Jan 22 2024 for Coin by Doxygen 1.10.0.