![]() |
Coin3D is Free Software, published under the BSD 3-clause license. |
https://coin3d.github.io https://www.kongsberg.com/en/kogt/ |
The SoCounter class is an integer counter engine. More...
#include <Inventor/engines/SoCounter.h>
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void * | createInstance (void) |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static void | initClasses (void) |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static SoEngine * | getByName (const SbName &name) |
static int | getByName (const SbName &name, SoEngineList &el) |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static void | cleanupClass (void) |
static void | initCopyDict (void) |
static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
static SoFieldContainer * | findCopy (const SoFieldContainer *orig, const SbBool copyconnections) |
static void | copyDone (void) |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static void | addName (SoBase *const base, const char *const name) |
static void | removeName (SoBase *const base, const char *const name) |
static void | incrementCurrentWriteCounter (void) |
static void | decrementCurrentWriteCounter (void) |
static SoBase * | getNamedBase (const SbName &name, SoType type) |
static int | getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) |
static SbBool | read (SoInput *input, SoBase *&base, SoType expectedtype) |
static void | setInstancePrefix (const SbString &c) |
static void | setTraceRefs (SbBool trace) |
static SbBool | getTraceRefs (void) |
static SbBool | connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) |
static SbBool | readRoute (SoInput *input) |
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 |
virtual SoNotRec | createNotRec (void) |
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.
This static method returns the SoType object associated with objects of this class.
|
staticprotected |
Returns the SoFieldData class which holds information about inputs in this engine.
|
staticprotected |
Returns the SoEngineOutputData class which holds information about the outputs in this engine.
|
virtual |
Returns the SoFieldData class which holds information about inputs in this engine.
Reimplemented from SoFieldContainer.
|
virtual |
Returns the SoEngineOutputData class which holds information about the outputs in this engine.
Implements SoEngine.
Creates a new instance of the class type corresponding to the SoType object.
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.