SoTimeCounter Class Reference

The SoTimeCounter class is an integer counter engine. More...

#include <Inventor/engines/SoTimeCounter.h>

Inheritance diagram for SoTimeCounter:

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. More...
virtual const SoFieldData *	getFieldData (void) const
virtual const SoEngineOutputData *	getOutputData (void) const
	SoTimeCounter ()
Public Member Functions inherited from SoEngine
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
Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)
SbBool	hasDefaultValues (void) const
SbBool	fieldsAreEqual (const SoFieldContainer *container) const
void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
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 *input)
void	get (SbString &fielddata, SoOutput *out)
virtual SbBool	validateNewFieldValue (SoField *field, void *newval)
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool	getIsBuiltIn (void) const
virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
void	setUserData (void *userdata) const
void *	getUserData (void) const
Public Member Functions inherited from SoBase
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
	Returns TRUE if the type of this object is either of the same type or inherited from type. More...
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 ()
Static Public Member Functions inherited from SoEngine
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 Public Member Functions inherited from SoFieldContainer
static void	initClass (void)
static SoType	getClassTypeId (void)
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 Public Member Functions inherited from SoBase
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
SoSFTime	timeIn
SoSFShort	min
SoSFShort	max
SoSFShort	step
SoSFBool	on
SoSFFloat	frequency
SoMFFloat	duty
SoSFShort	reset
SoSFTrigger	syncIn
SoEngineOutput	output
SoEngineOutput	syncOut

Protected Member Functions
virtual	~SoTimeCounter (void)
virtual void	inputChanged (SoField *which)
virtual void	writeInstance (SoOutput *out)
Protected Member Functions inherited from SoEngine
	SoEngine (void)
virtual	~SoEngine (void)
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
void	writeOutputTypes (SoOutput *out)
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)
virtual	~SoFieldContainer ()
Protected Member Functions inherited from SoBase
	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 Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr (void)
static const SoEngineOutputData **	getOutputDataPtr (void)
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)
static void	staticDataLock (void)
static void	staticDataUnlock (void)

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Detailed Description

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.

Constructor & Destructor Documentation

SoTimeCounter()

SoTimeCounter::SoTimeCounter

(

void

)

Default constructor.

~SoTimeCounter()

SoTimeCounter::~SoTimeCounter ( void  )

protectedvirtual

Destructor.

Member Function Documentation

getTypeId()

SoType SoTimeCounter::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.

getFieldData()

const SoFieldData * SoTimeCounter::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.

getOutputData()

const SoEngineOutputData * SoTimeCounter::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.

inputChanged()

void SoTimeCounter::inputChanged ( SoField *  which )

protectedvirtual

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.

writeInstance()

void SoTimeCounter::writeInstance ( SoOutput *  out )

protectedvirtual

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.

Member Data Documentation

timeIn

SoSFTime SoTimeCounter::timeIn

Running time. Connected to the realTime field by default.

min

SoSFShort SoTimeCounter::min

Minimum counter value. Default value is 0.

max

SoSFShort SoTimeCounter::max

Maximum counter value. Default value is 1.

step

SoSFShort SoTimeCounter::step

Counter step size. Default value is 1.

on

SoSFBool SoTimeCounter::on

Set to FALSE to pause the counter. Default value is TRUE.

frequency

SoSFFloat SoTimeCounter::frequency

Number of complete cycles from the min value to the max value per second. Default value is 1.0.

duty

SoMFFloat SoTimeCounter::duty

Used to weight step times. Supply one weight value per step. Default array is a single value of 1.0.

reset

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.

syncIn

SoSFTrigger SoTimeCounter::syncIn

Restart counter at the minimum value.

output

SoEngineOutput SoTimeCounter::output

(SoSFShort) The counter value.

syncOut

SoEngineOutput SoTimeCounter::syncOut

(SoSFTrigger) Triggers every cycle start.

---

The documentation for this class was generated from the following files:

• SoTimeCounter.h
• SoTimeCounter.cpp