SoSFTrigger(3IV)

NAME
     SoSFTrigger (SoSTrigger) - field used to trigger engines or connection
     networks

INHERITS FROM
     SoField > SoSField > SoSFTrigger

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

     typedef SoSFTrigger  SoSTrigger

          Functions from class SoSFTrigger:

     void                SoSTriggerSet(SoSTrigger *this)
     void                SoSTriggerGet(SoSTrigger *this)
     int                 SoSTriggerIsEq(const SoSTrigger *this, const
                              SoSFTrigger *t)
     int                 SoSTriggerIsNEq(const SoSTrigger *this, const
                              SoSFTrigger *t)

          Functions from class SoSField:

     SoType              SoSTriggerGetClassTypeId()

          Functions from class SoField:

     void                SoSTriggerSetIgnored(SoSTrigger *this, SbBool ignore)
     SbBool              SoSTriggerIsIgnored(const SoSTrigger *this)
     SbBool              SoSTriggerIsDflt(const SoSTrigger *this)
     SoType              SoSTriggerGetTypeId(const SoSTrigger *this)
     SbBool              SoSTriggerIsOfType(const SoSTrigger *this, SoType
                              type)
     SbBool              SoSTriggerSetFromStr(SoSTrigger *this, const char
                              *valueString)
     void                SoSTriggerGetIntoStr(SoSTrigger *this, SbString
                              *valueString)
     void                SoSTriggerTouch(SoSTrigger *this)
     SbBool              SoSTriggerConnFromField(SoSTrigger *this, SoField
                              *fromField)
     SbBool              SoSTriggerConnFrom(SoSTrigger *this, SoEngineOutput
                              *fromEngine)
     void                SoSTriggerDisconn(SoSTrigger *this)
     SbBool              SoSTriggerIsConn(const SoSTrigger *this)
     SbBool              SoSTriggerIsConnFromField(const SoSTrigger *this)
     SbBool              SoSTriggerGetConnField(const SoSTrigger *this,
                              SoField **writingField)
     SbBool              SoSTriggerIsConnFromEngine(const SoSTrigger *this)
     SbBool              SoSTriggerGetConnEngine(const SoSTrigger *this,
                              SoEngineOutput **engineOutput)
     void                SoSTriggerEnableConn(SoSTrigger *this, SbBool flag)
     SbBool              SoSTriggerIsConnEnabled(const SoSTrigger *this)
     int                 SoSTriggerGetForwardConn(const SoSTrigger *this,
                              SoFieldList *list)
     SoFieldContainer *  SoSTriggerGetContainer(const SoSTrigger *this)


DESCRIPTION
     This class can be used to start or to synchronize a network of field
     connections. It is the "null" field - a field with no values. It is
     typically used as the "start button" for engines that change over time.

     Triggers can be connected from any other type of field, and will notify
     any engines or nodes they are part of (or any other triggers they are
     connected to) whenever the value of the field is set (even if it is set
     to its current value) or the field is touch()'ed.

     Since they have no value, SoSFTriggers are not written to file. A node or
     engine containing an SoSFTrigger field will write only the field's name.

FUNCTIONS
     void                SoSTriggerSet(SoSTrigger *this)
          Starts the notification process; this is equivalent to calling
          touch().

     void                SoSTriggerGet(SoSTrigger *this)
          Forces any connected engines or fields to evaluate themselves.

     int                 SoSTriggerIsEq(const SoSTrigger *this, const
                              SoSFTrigger *t)
     int                 SoSTriggerIsNEq(const SoSTrigger *this, const
                              SoSFTrigger *t)
          All trigger fields are equal; these methods always return TRUE and
          FALSE, respectively.


SEE ALSO
     SoSFBool, SoMFBool