![]() |
http://www.sim.no http://www.coin3d.org |
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>
Public Member Functions | |
virtual SoType | getTypeId (void) const |
virtual const SoFieldData * | getFieldData (void) const |
virtual const SoEngineOutputData * | getOutputData (void) const |
SoCounter (void) | |
![]() | |
void | evaluateWrapper (void) |
virtual int | getOutputs (SoEngineOutputList &l) const |
SoEngineOutput * | getOutput (const SbName &outputname) const |
SbBool | getOutputName (const SoEngineOutput *output, SbName &outputname) const |
SbBool | isNotifying (void) const |
virtual void | notify (SoNotList *nl) |
SoEngine * | copy (void) const |
virtual SoFieldContainer * | copyThroughConnection (void) const |
SbBool | shouldCopy (void) const |
virtual void | writeInstance (SoOutput *out) |
![]() | |
void | setToDefaults (void) |
SbBool | hasDefaultValues (void) const |
SbBool | fieldsAreEqual (const SoFieldContainer *container) const |
void | copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) |
SbBool | set (const char *const fielddata) |
void | get (SbString &fielddata) |
virtual int | getFields (SoFieldList &l) const |
virtual int | getAllFields (SoFieldList &l) const |
virtual SoField * | getField (const SbName &name) const |
virtual SoField * | getEventIn (const SbName &name) const |
virtual SoField * | getEventOut (const SbName &name) const |
SbBool | getFieldName (const SoField *const field, SbName &name) const |
SbBool | enableNotify (const SbBool flag) |
SbBool | isNotifyEnabled (void) const |
SbBool | set (const char *fielddata, SoInput *in) |
void | get (SbString &fielddata, SoOutput *out) |
virtual SbBool | validateNewFieldValue (SoField *field, void *newval) |
virtual void | addWriteReference (SoOutput *out, SbBool isfromfield=0) |
SbBool | getIsBuiltIn (void) const |
virtual void | copyContents (const SoFieldContainer *from, SbBool copyconnections) |
void | setUserData (void *userdata) const |
void * | getUserData (void) const |
![]() | |
void | ref (void) const |
void | unref (void) const |
void | unrefNoDelete (void) const |
int32_t | getRefCount (void) const |
void | touch (void) |
SbBool | isOfType (SoType type) const |
virtual SbName | getName (void) const |
virtual void | setName (const SbName &newname) |
virtual void | startNotify (void) |
void | addAuditor (void *const auditor, const SoNotRec::Type type) |
void | removeAuditor (void *const auditor, const SoNotRec::Type type) |
const SoAuditorList & | getAuditors (void) const |
SbBool | shouldWrite (void) |
void | assertAlive (void) const |
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void * | createInstance (void) |
static void | initClass (void) |
![]() | |
static void | initClass (void) |
static void | initClasses (void) |
static SoType | getClassTypeId (void) |
static SoEngine * | getByName (const SbName &name) |
static int | getByName (const SbName &name, SoEngineList &el) |
![]() | |
static void | initClass (void) |
static SoType | getClassTypeId (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) |
static SoType | getClassTypeId (void) |
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 *in, SoBase *&base, SoType expectedtype) |
static void | setInstancePrefix (const SbString &c) |
static void | setTraceRefs (SbBool trace) |
static SbBool | getTraceRefs (void) |
static SbBool | connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) |
static SbBool | readRoute (SoInput *in) |
Public Attributes | |
SoSFShort | min |
SoSFShort | max |
SoSFShort | step |
SoSFTrigger | trigger |
SoSFShort | reset |
SoEngineOutput | output |
SoEngineOutput | syncOut |
Protected Member Functions | |
~SoCounter (void) | |
![]() | |
SoEngine (void) | |
virtual | ~SoEngine () |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
void | writeOutputTypes (SoOutput *out) |
![]() | |
SoFieldContainer (void) | |
~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 | ) |
|
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.
|
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:
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.
Referenced by SoCounter().
SoSFShort SoCounter::max |
Maximum value for counter.
Referenced by SoCounter().
SoSFShort SoCounter::step |
Counter step value.
Referenced by SoCounter().
SoSFTrigger SoCounter::trigger |
Increment counter (using step).
Referenced by SoCounter().
SoSFShort SoCounter::reset |
Reset 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().
Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.
Generated on Fri Jul 20 2018 for Coin by Doxygen. 1.8.14