Base class for all engines. More...

#include <Inventor/engines/SoEngine.h>

Inheritance diagram for SoEngine:

Public Member Functions
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine. More...

SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a pointer to the engine output with the given name. More...

bool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in `outputName`) the name of the engine output (`output`). More...

SoEngine *	copy () const
	Creates and returns an exact copy of the engine. More...

void	evaluateWrapper ()
	wrapper for the user's evaluate() engine More...

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance. More...

virtual const SoEngineOutputData *	getOutputData () const =0
	Info on outputs: More...

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing) More...

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection. More...

bool	shouldCopy () const
	Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is. More...

bool	isNotifying () const
	A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that: More...

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values. More...

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values. More...

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields. More...

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields. More...

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. More...

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name. More...

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument. More...

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed. More...

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. More...

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. More...

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing. More...

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library. More...

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node. More...

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance. More...

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container. More...

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance. More...

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it. More...

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance. More...

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type. More...

virtual SbName	getName () const
	Returns the name of an instance. More...

virtual void	setName (const SbName &name)
	Sets the name of an instance. More...

virtual void	startNotify ()
	Initiates notification from an instance. More...

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list. More...

void	removeAuditor (void *auditor, SoNotRec::Type type)

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...

int	getRefCount () const
	Returns current reference count. More...

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class. More...

static SoEngine *	getByName (const SbName &name)
	Look up engine(s) by name. More...

static int	getByName (const SbName &name, SoEngineList &list)
	Look up engine(s) by name. More...

static void	initClass ()
	Initializes base engine class. More...

static void	initClasses ()
	Initialize ALL Inventor engine classes. More...

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class. More...

static void	initClass ()
	Setup type information. More...

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. More...

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary. More...

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it. More...

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL. More...

static void	copyDone ()
	Cleans up the dictionary when done. More...

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class. More...

static void	initClass ()
	Setup type information. More...

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation. More...

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases. More...

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary. More...

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict. More...

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase. More...

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...

Protected Member Functions
virtual void	evaluate ()=0
	User-written evaluation engine. More...

	SoEngine ()
	Constructor, destructor. More...

	~SoEngine ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error. More...

virtual void	inputChanged (SoField *whichField)
	This is called whenever the value of an input is changed. More...

void	writeOutputTypes (SoOutput *out)
	Write output type information for engines that are not built-in. More...

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class. More...

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly. More...

virtual void	destroy ()
	Actually deletes an instance. More...

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references. More...

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...

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) More...

Static Protected Member Functions
static const SoFieldData **	getInputDataPtr ()
	This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros. More...

static const SoEngineOutputData **	getOutputDataPtr ()

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter. More...

Friends
class	SoEngineOutput

Additional Inherited Members
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging) More...

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 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. More...

Detailed Description

SoEngine is the abstract base class for all engines. Engines are objects used for animation and behavior. They are lightweight objects that are connected between nodes, the clock, and other engines to form interesting behaviorial objects (e.g., a spinning windmill).

Engines are used to animate parts of a scene and/or to constrain one part of a scene in relation to some other part of the scene. An engine receives a number of input values, performs some operation on them, and then copies the results into one or more output fields. Both the inputs and the outputs can be connected to other fields or engines in the scene graph. When an engine's output values change, those new values are sent to any fields or engines connected to them.

See Also

Definition at line 102 of file SoEngine.h.

Constructor & Destructor Documentation

◆ SoEngine()

SoEngine::SoEngine ( )

protected

◆ ~SoEngine()

SoEngine::~SoEngine ( )

protected

Member Function Documentation

◆ copy()

SoEngine* SoEngine::copy ( ) const

All connections to inputs are copied as is (without copying what's at the other end).

◆ copyThroughConnection()

virtual SoFieldContainer* SoEngine::copyThroughConnection ( ) const

virtual

Reimplemented from SoFieldContainer.

Reimplemented in SoSelectOne, SoGate, and SoConcatenate.

◆ evaluate()

virtual void SoEngine::evaluate ( )

protectedpure virtual

◆ evaluateWrapper()

void SoEngine::evaluateWrapper ( )

◆ getByName() [1/2]

static SoEngine* SoEngine::getByName ( const SbName & name )

static

◆ getByName() [2/2]

static int SoEngine::getByName	(	const SbName &	name,
		SoEngineList &	list
	)

static

◆ getClassTypeId()

static SoType SoEngine::getClassTypeId ( )

inlinestatic

Definition at line 107 of file SoEngine.h.

◆ getInputDataPtr()

static const SoFieldData** SoEngine::getInputDataPtr ( )

inlinestaticprotected

Definition at line 188 of file SoEngine.h.

◆ getOutput()

SoEngineOutput* SoEngine::getOutput ( const SbName & outputName ) const

If no such output exists, NULL is returned.

◆ getOutputData()

virtual const SoEngineOutputData* SoEngine::getOutputData ( ) const

pure virtual

◆ getOutputDataPtr()

static const SoEngineOutputData** SoEngine::getOutputDataPtr ( )

inlinestaticprotected

Definition at line 189 of file SoEngine.h.

◆ getOutputName()

bool SoEngine::getOutputName	(	const SoEngineOutput *	output,
		SbName &	outputName
	)		const

Returns FALSE if the engine output is not contained within the engine instance.

◆ getOutputs()

virtual int SoEngine::getOutputs ( SoEngineOutputList & list ) const

virtual

Use getOutputName to get the names of the outputs, and use SoEngineOutput::getConnectionType to determine their types.

◆ initClass()

static void SoEngine::initClass ( )

static

◆ initClasses()

static void SoEngine::initClasses ( )

static

◆ inputChanged()

virtual void SoEngine::inputChanged ( SoField * whichField )

protectedvirtual

The default method does nothing. Subclasses can override this to detect when a specific field is changed.

Reimplemented in SoTimeCounter, SoOnOff, SoOneShot, SoGate, SoElapsedTime, SoCounter, SoComputeBoundingBox, and SoCalculator.

◆ isNotifying()

bool SoEngine::isNotifying ( ) const

inline

Definition at line 170 of file SoEngine.h.

◆ notify()

virtual void SoEngine::notify ( SoNotList * list )

virtual

Reimplemented from SoFieldContainer.

◆ readInstance()

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

protectedvirtual

Reimplemented from SoFieldContainer.

Reimplemented in SoTimeCounter, SoOneShot, and SoElapsedTime.

◆ shouldCopy()

bool SoEngine::shouldCopy ( ) const

◆ writeInstance()

virtual void SoEngine::writeInstance ( SoOutput * out )

virtual

Reimplemented from SoFieldContainer.

Reimplemented in SoTimeCounter, SoOneShot, and SoElapsedTime.

◆ writeOutputTypes()

void SoEngine::writeOutputTypes ( SoOutput * out )

protected

Friends And Related Function Documentation

◆ SoEngineOutput

friend class SoEngineOutput

friend

Definition at line 199 of file SoEngine.h.

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

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/engines/SoEngine.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoEngine()

◆ ~SoEngine()

Member Function Documentation

◆ copy()

◆ copyThroughConnection()

◆ evaluate()

◆ evaluateWrapper()

◆ getByName() [1/2]

◆ getByName() [2/2]

◆ getClassTypeId()

◆ getInputDataPtr()

◆ getOutput()

◆ getOutputData()

◆ getOutputDataPtr()

◆ getOutputName()

◆ getOutputs()

◆ initClass()

◆ initClasses()

◆ inputChanged()

◆ isNotifying()

◆ notify()

◆ readInstance()

◆ shouldCopy()

◆ writeInstance()

◆ writeOutputTypes()

Friends And Related Function Documentation

◆ SoEngineOutput