SoSFEngine(3IV)

NAME
     SoSFEngine (SoSEngine) - field containing a pointer to a engine

INHERITS FROM
     SoField > SoSField > SoSFEngine

SYNOPSIS
     #include <Inventor_c/fields/SoSFEngine.h>

     typedef SoSFEngine  SoSEngine

          Functions from class SoSFEngine:

     SoType              SoSEngineGetClassTypeId()
     void                SoSEngineGetTypeId(const SoSEngine *this)
     SoEngine *          SoSEngineGet(const SoSEngine *this)
     void                SoSEngineSet(SoSEngine *this, SoEngine * newValue)
     int                 SoSEngineIsEq(const SoSEngine *this, const SoSFEngine
                              *f)
     int                 SoSEngineIsNEq(const SoSEngine *this, const
                              SoSFEngine *f)

          Functions from class SoField:

     void                SoSEngineSetIgnored(SoSEngine *this, SbBool ignore)
     SbBool              SoSEngineIsIgnored(const SoSEngine *this)
     SbBool              SoSEngineIsDflt(const SoSEngine *this)
     SbBool              SoSEngineIsOfType(const SoSEngine *this, SoType type)
     SbBool              SoSEngineSetFromStr(SoSEngine *this, const char
                              *valueString)
     void                SoSEngineGetIntoStr(SoSEngine *this, SbString
                              *valueString)
     void                SoSEngineTouch(SoSEngine *this)
     SbBool              SoSEngineConnFromField(SoSEngine *this, SoField
                              *fromField)
     SbBool              SoSEngineConnFrom(SoSEngine *this, SoEngineOutput
                              *fromEngine)
     void                SoSEngineDisconn(SoSEngine *this)
     SbBool              SoSEngineIsConn(const SoSEngine *this)
     SbBool              SoSEngineIsConnFromField(const SoSEngine *this)
     SbBool              SoSEngineGetConnField(const SoSEngine *this, SoField
                              **writingField)
     SbBool              SoSEngineIsConnFromEngine(const SoSEngine *this)
     SbBool              SoSEngineGetConnEngine(const SoSEngine *this,
                              SoEngineOutput **engineOutput)
     void                SoSEngineEnableConn(SoSEngine *this, SbBool flag)
     SbBool              SoSEngineIsConnEnabled(const SoSEngine *this)
     int                 SoSEngineGetForwardConn(const SoSEngine *this,
                              SoFieldList *list)
     SoFieldContainer *  SoSEngineGetContainer(const SoSEngine *this)
DESCRIPTION
     This field maintains a pointer to an SoEngine instance, correctly
     maintaining its reference count.

     SoSFEngines are written to file as the engine they are pointing to. For
     example:

          mySoSFEngineField ElapsedTime {}

     is an SoSFEngine field named 'mySoSFEngineField', pointing to an
     SoElapsedTime engine. If the engine is used elsewhere, the regular
     DEF/USE instancing mechanism applies:

          anotherSoSFEngineField USE calculator

     is an SoSFEngine field that points to a engine named 'calculator' that
     was DEF'ed earlier in the scene.

FUNCTIONS
     SoType              SoSEngineGetClassTypeId()
     void                SoSEngineGetTypeId(const SoSEngine *this)
          Returns the type for this class or a particular object of this
          class.

     SoEngine *          SoSEngineGet(const SoSEngine *this)
          Returns this field's value.

     void                SoSEngineSet(SoSEngine *this, SoEngine * newValue)
          Sets this field to newValue.

     int                 SoSEngineIsEq(const SoSEngine *this, const SoSFEngine
                              *f)
     int                 SoSEngineIsNEq(const SoSEngine *this, const
                              SoSFEngine *f)
          Returns TRUE if f is of the same type and has the same value as this
          field.


SEE ALSO
     SoField, SoSField, SoMFEngine, SoEngine