1SoSFEngine(3IV)()                                            SoSFEngine(3IV)()
2
3
4

NAME

6       SoSFEngine — field containing a pointer to a engine
7

INHERITS FROM

9       SoField > SoSField > SoSFEngine
10

SYNOPSIS

12       #include <Inventor/fields/SoSFEngine.h>
13
14          Methods from class SoSFEngine:
15
16     static SoType       getClassTypeId()
17     virtual void        getTypeId() const
18     SoEngine *          getValue() const
19     SoEngine *          operator =(SoEngine * newValue)
20     void                setValue(SoEngine * newValue)
21     int                 operator ==(const SoSFEngine &f) const
22     int                 operator !=(const SoSFEngine &f) const
23
24          Methods from class SoField:
25
26     void                setIgnored(SbBool ignore)
27     SbBool              isIgnored() const
28     SbBool              isDefault() const
29     virtual SbBool      isOfType(SoType type) const
30     SbBool              set(const char *valueString)
31     void                get(SbString &valueString)
32     void                touch()
33     SbBool              connectFrom(SoField *fromField)
34     SbBool              connectFrom(SoEngineOutput *fromEngine)
35     void                disconnect()
36     SbBool              isConnected() const
37     SbBool              isConnectedFromField() const
38     SbBool              getConnectedField(SoField *&writingField) const
39     SbBool              isConnectedFromEngine() const
40     SbBool              getConnectedEngine(SoEngineOutput     *&engineOutput)
41                              const
42     void                enableConnection(SbBool flag)
43     SbBool              isConnectionEnabled() const
44     int                 getForwardConnections(SoFieldList &list) const
45     SoFieldContainer *  getContainer() const
46
47

DESCRIPTION

49       This field maintains a pointer to an SoEngine instance, correctly main‐
50       taining its reference count.
51
52       SoSFEngines are written to file as the engine they are pointing to. For
53       example:
54
55          mySoSFEngineField ElapsedTime {}
56
57     is an SoSFEngine field named 'mySoSFEngineField',  pointing  to  an  SoE‐
58     lapsedTime  engine.  If the engine is used elsewhere, the regular DEF/USE
59     instancing mechanism applies:
60
61          anotherSoSFEngineField USE calculator
62
63     is an SoSFEngine field that points to a engine  named  'calculator'  that
64     was DEF'ed earlier in the scene.
65

METHODS

67     static SoType       getClassTypeId()
68     virtual void        getTypeId() const
69          Returns  the  type  for  this  class  or a particular object of this
70          class.
71
72     SoEngine *          getValue() const
73          Returns this field's value.
74
75     SoEngine *          operator =(SoEngine * newValue)
76     void                setValue(SoEngine * newValue)
77          Sets this field to newValue.
78
79     int                 operator ==(const SoSFEngine &f) const
80     int                 operator !=(const SoSFEngine &f) const
81          Returns TRUE if f is of the same type and has the same value as this
82          field.
83
84

SEE ALSO

86       SoField, SoSField, SoMFEngine, SoEngine
87
88
89
90
91                                                             SoSFEngine(3IV)()