--- name: "SoNodeEngine" section: "3" platform: "linux" package: "coin" version: "1:4.0.10-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/SoNodeEngine" --- # SoNodeEngine(3) SoNodeEngine is the base class for Coin node engines. ## NAME SoNodeEngine - **SoNodeEngine** is the base class for Coin node engines. ## SYNOPSIS \#include \ Inherits **SoNode**. Inherited by **SoVRMLInterpolator**, and **SoVRMLTimeSensor**. ### Public Member Functions void **evaluateWrapper** (void)\ virtual int **getOutputs** (**SoEngineOutputList** &l) const\ **SoEngineOutput** \* **getOutput** (const **SbName** &outputname) const\ SbBool **getOutputName** (const **SoEngineOutput** \*output, **SbName** &outputname) const\ virtual const **SoEngineOutputData** \* **getOutputData** (void) const =0\ SbBool **isNotifying** (void) const\ virtual void **notify** (**SoNotList** \*nl)\ virtual void **writeInstance** (**SoOutput** \*out)\ Public Member Functions inherited from **SoNode** void **setOverride** (const SbBool state)\ SbBool **isOverride** (void) const\ void **setNodeType** (const **NodeType** type)\ **NodeType** **getNodeType** (void) const\ virtual **SoNode** \* **copy** (SbBool copyconnections=FALSE) const\ virtual SbBool **affectsState** (void) const\ virtual void **doAction** (**SoAction** \*action)\ virtual void **GLRender** (**SoGLRenderAction** \*action)\ virtual void **GLRenderBelowPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderInPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderOffPath** (**SoGLRenderAction** \*action)\ virtual void **callback** (**SoCallbackAction** \*action)\ virtual void **getBoundingBox** (**SoGetBoundingBoxAction** \*action)\ virtual void **getMatrix** (**SoGetMatrixAction** \*action)\ virtual void **handleEvent** (**SoHandleEventAction** \*action)\ virtual void **pick** (**SoPickAction** \*action)\ virtual void **rayPick** (**SoRayPickAction** \*action)\ virtual void **search** (**SoSearchAction** \*action)\ virtual void **write** (**SoWriteAction** \*action)\ virtual void **audioRender** (**SoAudioRenderAction** \*action)\ virtual void **getPrimitiveCount** (**SoGetPrimitiveCountAction** \*action)\ virtual void **grabEventsSetup** (void)\ virtual void **grabEventsCleanup** (void)\ virtual void **startNotify** (void)\ SbUniqueId **getNodeId** (void) const\ virtual **SoChildList** \* **getChildren** (void) const\ virtual **SoNode** \* **addToCopyDict** (void) const\ virtual void **copyContents** (const **SoFieldContainer** \*from, SbBool copyconnections)\ virtual **SoFieldContainer** \* **copyThroughConnection** (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 const **SoFieldData** \* **getFieldData** (void) const\ 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)\ virtual **SoType** **getTypeId** (void) const =0\ Returns the type identification of an object derived from a class inheriting **SoBase**. This is used for runtime type checking and *downward"*casting. SbBool **isOfType** (**SoType** type) const\ Returns TRUE if the type of this object is either of the same type or inherited from *type*. virtual **SbName** **getName** (void) const\ virtual void **setName** (const **SbName** &newname)\ 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 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)\ Static Public Member Functions inherited from **SoNode** static uint32\_t **getCompatibilityTypes** (const **SoType** &nodetype)\ static **SoType** **getClassTypeId** (void)\ static **SoNode** \* **getByName** (const **SbName** &name)\ static int **getByName** (const **SbName** &name, **SoNodeList** &l)\ 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 SbUniqueId **getNextNodeId** (void)\ static int **getActionMethodIndex** (const **SoType** type)\ static void **getBoundingBoxS** (**SoAction** \*action, **SoNode** \*node)\ static void **GLRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **callbackS** (**SoAction** \*action, **SoNode** \*node)\ static void **getMatrixS** (**SoAction** \*action, **SoNode** \*node)\ static void **handleEventS** (**SoAction** \*action, **SoNode** \*node)\ static void **pickS** (**SoAction** \*action, **SoNode** \*node)\ static void **rayPickS** (**SoAction** \*action, **SoNode** \*node)\ static void **searchS** (**SoAction** \*action, **SoNode** \*node)\ static void **writeS** (**SoAction** \*action, **SoNode** \*node)\ static void **audioRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **getPrimitiveCountS** (**SoAction** \*action, **SoNode** \*node)\ Static Public Member Functions inherited from **SoFieldContainer** 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 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)\ ### Protected Member Functions **SoNodeEngine** (void)\ virtual **~SoNodeEngine** (void)\ virtual void **evaluate** (void)=0\ virtual SbBool **readInstance** (**SoInput** \*in, unsigned short flags)\ virtual void **inputChanged** (**SoField** \*which)\ void **writeOutputTypes** (**SoOutput** \*out)\ Protected Member Functions inherited from **SoNode** **SoNode** (void)\ virtual **~SoNode** ()\ 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** \*\* **getFieldDataPtr** (void)\ static const **SoEngineOutputData** \*\* **getOutputDataPtr** (void)\ Static Protected Member Functions inherited from **SoNode** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ static void **setNextActionMethodIndex** (int index)\ static int **getNextActionMethodIndex** (void)\ static void **incNextActionMethodIndex** (void)\ static void **setCompatibilityTypes** (const **SoType** &nodetype, const uint32\_t bitmask)\ Static Protected Member Functions inherited from **SoBase** static uint32\_t **getCurrentWriteCounter** (void)\ static void **staticDataLock** (void)\ static void **staticDataUnlock** (void)\ ### Additional Inherited Members Public Types inherited from **SoNode** enum **NodeType** { **INVENTOR** = 0x0000, **VRML1** = 0x0001, **VRML2** = 0x0002, **INVENTOR\_1** = 0x0004, **INVENTOR\_2\_0** = 0x0008, **INVENTOR\_2\_1** = 0x0010, **INVENTOR\_2\_5** = 0x0020, **INVENTOR\_2\_6** = 0x0040, **COIN\_1\_0** = 0x0080, **COIN\_2\_0** = 0x0100, **EXTENSION** = 0x0200, **COIN\_2\_2** = 0x0400, **COIN\_2\_3** = 0x0800, **COIN\_2\_4** = 0x1000, **INVENTOR\_5\_0** = 0x2000, **COIN\_2\_5** = 0x4000, **COIN\_3\_0** = 0x8000, **INVENTOR\_6\_0** = 0x10000, **COIN\_4\_0** = 0x20000 }\ Protected Types inherited from **SoBase** enum **BaseFlags** { **IS\_ENGINE** = 0x01, **IS\_GROUP** = 0x02 }\ Protected Attributes inherited from **SoNode** SbUniqueId **uniqueId**\ Protected Attributes inherited from **SoFieldContainer** SbBool **isBuiltIn**\ Static Protected Attributes inherited from **SoNode** static SbUniqueId **nextUniqueId** = 1\ static int **nextActionMethodIndex** = 0\ ## Detailed Description **SoNodeEngine** is the base class for Coin node engines. Node engines have the same functionality as normal engines, except that they inherit **SoNode**, which makes it possible to insert node engines in the scene graph. The main rationale for this class is to simplify the implementation of VRML interpolator nodes, which are in a sense engines embedded in the shape of ordinary nodes. This abstract superclass will likely be of no interest to the Coin application programmer, and you can safely ignore it. Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.\ ## Constructor & Destructor Documentation ### SoNodeEngine::SoNodeEngine (void ) \[protected\] Default constructor. ### SoNodeEngine::~SoNodeEngine (void ) \[protected\], \[virtual\] Destructor. ## Member Function Documentation ### SoType SoNodeEngine::getClassTypeId (void ) \[static\] ### void SoNodeEngine::evaluateWrapper (void ) Triggers an engine evaluation. ### int SoNodeEngine::getOutputs (SoEngineOutputList & l) const \[virtual\] Adds all outputs to list. Returns the number of outputs added to the list. ### SoEngineOutput \* SoNodeEngine::getOutput (const SbName & outputname) const Returns the output with name *outputname*, or NULL if no such output exists. ### SbBool SoNodeEngine::getOutputName (const SoEngineOutput \* output, SbName & outputname) const Sets *outputname* to the name of *output*. Returns FALSE if no such output is contained within the engine instance. ### virtual const SoEngineOutputData \* SoNodeEngine::getOutputData (void ) const \[pure virtual\] *This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\ Implemented in **SoVRMLColorInterpolator**, **SoVRMLCoordinateInterpolator**, **SoVRMLInterpolator**, **SoVRMLNormalInterpolator**, **SoVRMLOrientationInterpolator**, **SoVRMLPositionInterpolator**, **SoVRMLScalarInterpolator**, and **SoVRMLTimeSensor**. ### SbBool SoNodeEngine::isNotifying (void ) const Returns whether we're in a notification process. This is needed to avoid double notification when an engine enables outputs during **inputChanged()**. ### void SoNodeEngine::notify (SoNotList \* l) \[virtual\] Notifies all auditors for this instance when changes are made. Reimplemented from **SoNode**. Reimplemented in **SoVRMLTimeSensor**. ### void SoNodeEngine::writeInstance (SoOutput \* out) \[virtual\] 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 **SoNode**. ### virtual void SoNodeEngine::evaluate (void ) \[protected\], \[pure virtual\] *This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\ ### SbBool SoNodeEngine::readInstance (SoInput \* in, unsigned short flags) \[protected\], \[virtual\] This method is mainly intended for internal use during file import operations. It reads a definition of an instance from the input stream *in*. The input stream state points to the start of a serialized / persistent representation of an instance of this class type. TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not. The import process should be robust and handle corrupted input streams by returning FALSE. *flags* is used internally during binary import when reading user extension nodes, group nodes or engines. Reimplemented from **SoNode**. ### void SoNodeEngine::inputChanged (SoField \* which) \[protected\], \[virtual\] Called when an input is changed. The default method does nothing, but subclasses may override this method to do the The Right Thing when a specific field is changed. Reimplemented in **SoVRMLTimeSensor**. ### const SoFieldData \*\* SoNodeEngine::getFieldDataPtr (void ) \[static\], \[protected\] Returns the **SoFieldData** class which holds information about inputs in this engine. ### const SoEngineOutputData \*\* SoNodeEngine::getOutputDataPtr (void ) \[static\], \[protected\] Returns the **SoEngineOutputData** class which holds information about the outputs in this engine. ### void SoNodeEngine::writeOutputTypes (SoOutput \* out) \[protected\] Writes the types of engine outputs for extension engines (i.e. engines not built in to Coin). ## Author Generated automatically by Doxygen for Coin from the source code.