![]() |
Coin3D is Free Software, published under the BSD 3-clause license. |
https://coin3d.github.io https://www.kongsberg.com/en/kogt/ |
The SoTimeCounter class is an integer counter engine. More...
#include <Inventor/engines/SoTimeCounter.h>
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void * | createInstance (void) |
static void | initClass () |
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) |
Protected Member Functions | |
virtual | ~SoTimeCounter (void) |
virtual void | inputChanged (SoField *which) |
virtual void | writeInstance (SoOutput *out) |
![]() | |
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 SoTimeCounter class is an integer counter engine.
The SoTimeCounter engine is by default connected to the realTime global field, and does stepwise updates on the SoTimeCounter::output field according to the field settings.
SoTimeCounter::SoTimeCounter | ( | void | ) |
Default constructor.
|
protectedvirtual |
Destructor.
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.
Called when an input is changed. The default method does nothing, but subclasses may override this method to do The Right Thing when a specific field is changed.
Reimplemented from SoEngine.
Writes all the fields contained in this instance to the output stream within out.
This method is solely called from the write methods of fields.
Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.
This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.
Reimplemented from SoEngine.
SoSFTime SoTimeCounter::timeIn |
Running time. Connected to the realTime field by default.
SoSFShort SoTimeCounter::min |
Minimum counter value. Default value is 0.
SoSFShort SoTimeCounter::max |
Maximum counter value. Default value is 1.
SoSFShort SoTimeCounter::step |
Counter step size. Default value is 1.
SoSFBool SoTimeCounter::on |
Set to FALSE
to pause the counter. Default value is TRUE
.
SoSFFloat SoTimeCounter::frequency |
Number of complete cycles from the min value to the max value per second. Default value is 1.0.
SoMFFloat SoTimeCounter::duty |
Used to weight step times. Supply one weight value per step. Default array is a single value of 1.0.
SoSFShort SoTimeCounter::reset |
Manually set the counter to some value. If SoTimeCounter::reset is set below the SoTimeCounter::min value or above the SoTimeCounter::max value it will be clamped to the closest boundary value.
SoSFTrigger SoTimeCounter::syncIn |
Restart counter at the minimum value.
SoEngineOutput SoTimeCounter::output |
(SoSFShort) The counter value.
SoEngineOutput SoTimeCounter::syncOut |
(SoSFTrigger) Triggers every cycle start.