SoElapsedTime Class Reference

Basic controllable time source. More...

#include <Inventor/engines/SoElapsedTime.h>

Inheritance diagram for SoElapsedTime:

Inputs
SoSFTime	timeIn
	Running time.
SoSFFloat	speed
	Scale factor for time.
SoSFBool	on
	TRUE to start running, FALSE to stop.
SoSFBool	pause
	TRUE to freeze, FALSE to continue running.
SoSFTrigger	reset
	Reset the base time.
SoEngineOutput	timeOut
	While the engine is on, it keeps track of 'clock' time.
	SoElapsedTime ()
	Constructor.
static void	initClass ()
virtual void	inputChanged (SoField *whichInput)
	Detects when the running time input changed.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput.
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance.

Additional Inherited Members
Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.
SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a pointer to the engine output with the given name.
bool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).
SoEngine *	copy () const
	Creates and returns an exact copy of the engine.
void	evaluateWrapper ()
	wrapper for the user's evaluate() engine
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
virtual const SoEngineOutputData *	getOutputData () const =0
	Info on outputs:
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)
virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.
bool	shouldCopy () const
	Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is.
bool	isNotifying () const
	A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that:
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.
bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
bool	set (const char *fieldDataString, SoInput *dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)
bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.
virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.
virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.
void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.
Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.
void	unref () const
void	unrefNoDelete () const
void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
virtual void	startNotify ()
	Initiates notification from an instance.
virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.
void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.
void	removeAuditor (void *auditor, SoNotRec::Type type)
const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
int	getRefCount () const
	Returns current reference count.
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.
bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.
static SoEngine *	getByName (const SbName &name)
	Look up engine(s) by name.
static int	getByName (const SbName &name, SoEngineList &list)
	Look up engine(s) by name.
static void	initClass ()
	Initializes base engine class.
static void	initClasses ()
	Initialize ALL Inventor engine classes.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
static void	initClass ()
	Setup type information.
static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
static void	addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
	Adds an instance to the dictionary.
static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.
static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.
static void	copyDone ()
	Cleans up the dictionary when done.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
	Setup type information.
static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.
static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.
static void	addName (SoBase *, const char *)
	Internal methods used to maintain the global name dictionary.
static void	removeName (SoBase *, const char *)
static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.
static int	getNamedBases (const SbName &, SoBaseList &, SoType)
static bool	read (SoInput *in, SoBase *&base, SoType expectedType)
	Reads one instance of some subclass of SoBase.
static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...
Protected Member Functions inherited from SoEngine
virtual void	evaluate ()=0
	User-written evaluation engine.
	SoEngine ()
	Constructor, destructor.
	~SoEngine ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
virtual void	inputChanged (SoField *whichField)
	This is called whenever the value of an input is changed.
void	writeOutputTypes (SoOutput *out)
	Write output type information for engines that are not built-in.
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()
	~SoFieldContainer ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.
virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.
virtual void	destroy ()
	Actually deletes an instance.
bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.
bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.
Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr ()
	This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros.
static const SoEngineOutputData **	getOutputDataPtr ()
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.
Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Detailed Description

This engine functions as a stopwatch; it outputs the time that has elapsed since it started running. By default, the timeIn input is connected to the realTime global field. It can, however, be connected to any other time source.

The ouput from the engine is the time that has elapsed since it started running, or since the reset input was last triggered. You can affect the speed of the output time by setting the speed scale factor. A value greater than 1.0 will speed up the output, and a value less than 1.0 will slow it down.

If you pause the engine, by setting the pause input to TRUE, it stops updating the timeOut output. When you turn off the pause, it jumps to its current position without losing time. Alternatively, if you want to stop the engine for a while, and then restart it from where it left off, use the on input field.

File Format/Default

ElapsedTime {
  timeIn 1316437066.35
  speed 1
  on TRUE
  pause FALSE
}

See Also

SoTimeCounter, SoOneShot, SoEngineOutput

Definition at line 109 of file SoElapsedTime.h.

Constructor & Destructor Documentation

SoElapsedTime()

SoElapsedTime::SoElapsedTime

(

)

Member Function Documentation

initClass()

static void SoElapsedTime::initClass ( )

static

inputChanged()

virtual void SoElapsedTime::inputChanged ( SoField *  whichInput )

protectedvirtual

Reimplemented from SoEngine.

readInstance()

virtual bool SoElapsedTime::readInstance ( SoInput *  in, unsigned short  flags  )

protectedvirtual

Works around a problem with old files that contain explicit references to the default connection to realTime.

Reimplemented from SoEngine.

writeInstance()

virtual void SoElapsedTime::writeInstance ( SoOutput *  out )

protectedvirtual

Takes care of not writing out connection to realTime that is created in constructor.

Reimplemented from SoEngine.

Member Data Documentation

on

SoSFBool SoElapsedTime::on

Definition at line 124 of file SoElapsedTime.h.

pause

SoSFBool SoElapsedTime::pause

Definition at line 127 of file SoElapsedTime.h.

reset

SoSFTrigger SoElapsedTime::reset

Definition at line 130 of file SoElapsedTime.h.

speed

SoSFFloat SoElapsedTime::speed

Definition at line 121 of file SoElapsedTime.h.

timeIn

SoSFTime SoElapsedTime::timeIn

Definition at line 118 of file SoElapsedTime.h.

timeOut

SoEngineOutput SoElapsedTime::timeOut

This is the amount of real time that passes multiplied by the speed. If the speed input varies while the engine is on, then 'clock' time advances non-uniformly.

Pausing the engine will freeze the timeOut value, but internally the 'clock' time will continue to advance. Unpause the engine and the timeOut will jump forward to display 'clock' time.

Stop the engine (by setting 'on' to FALSE) to freeze both the timeOut value and the 'clock' time. Re-start (by setting 'on' to TRUE) and both timeOut and 'clock' will continue from where they were at the time the engine was stopped.

Definition at line 149 of file SoElapsedTime.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/engines/SoElapsedTime.h