1SoEngine(3IV)()                                                SoEngine(3IV)()
2
3
4

NAME

6       SoEngine — base class for all engines
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoEngine
10

SYNOPSIS

12       #include <Inventor/engines/SoEngine.h>
13
14          Methods from class SoEngine:
15
16     static SoType       getClassTypeId()
17     virtual int         getOutputs(SoEngineOutputList &list) const
18     SoEngineOutput *    getOutput(const SbName &outputName) const
19     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
20                              &outputName) const
21     SoEngine *          copy() const
22     static SoEngine *   getByName(const SbName &name)
23     static int          getByName(const SbName &name, SoEngineList &list)
24
25          Methods from class SoFieldContainer:
26
27     void                setToDefaults()
28     SbBool              hasDefaultValues() const
29     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
30     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
31                              copyConnections = FALSE)
32     SbBool              set(const char *fieldDataString)
33     void                get(SbString &fieldDataString)
34     virtual int         getFields(SoFieldList &resultList) const
35     virtual SoField *   getField(const SbName &fieldName) const
36     SbBool              getFieldName(const SoField *field, SbName &fieldName)
37                              const
38     SbBool              isNotifyEnabled() const
39     SbBool              enableNotify(SbBool flag)
40
41          Methods from class SoBase:
42
43     void                ref()
44     void                unref() const
45     void                unrefNoDelete() const
46     void                touch()
47     virtual SoType      getTypeId() const
48     SbBool              isOfType(SoType type) const
49     virtual void        setName(const SbName &name)
50     virtual SbName      getName() const
51
52

DESCRIPTION

54       SoEngine is the abstract  base  class  for  all  engines.  Engines  are
55       objects  used  for animation and behavior. They are lightweight objects
56       that are connected between nodes, the clock, and other engines to  form
57       interesting behaviorial objects (e.g., a spinning windmill).
58
59       Engines  are  used  to animate parts of a scene and/or to constrain one
60       part of a scene in relation to some other part of the scene. An  engine
61       receives a number of input values, performs some operation on them, and
62       then copies the results into one or more output fields. Both the inputs
63       and  the  outputs  can  be  connected to other fields or engines in the
64       scene graph.  When an engine's output values change, those  new  values
65       are sent to any fields or engines connected to them.
66

METHODS

68     static SoType       getClassTypeId()
69          Returns the type identifier for the SoEngine class.
70
71     virtual int         getOutputs(SoEngineOutputList &list) const
72          Returns  a  list of outputs in this engine. Use getOutputName to get
73          the names of the outputs, and use  SoEngineOutput::getConnectionType
74          to determine their types.
75
76     SoEngineOutput *    getOutput(const SbName &outputName) const
77          Returns  a  pointer  to the engine output with the given name. If no
78          such output exists, NULL is returned.
79
80     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
81                              &outputName) const
82          Returns  (in  outputName)  the  name  of the engine output (output).
83          Returns FALSE if the engine  output  is  not  contained  within  the
84          engine instance.
85
86     SoEngine *          copy() const
87          Creates  and returns an exact copy of the engine. All connections to
88          inputs are copied as is (without copying what's at the other end).
89
90     static SoEngine *   getByName(const SbName &name)
91     static int          getByName(const SbName &name, SoEngineList &list)
92          Look up engine(s) by name.
93
94

FILE FORMAT/DEFAULTS

96       This is an abstract class. See the reference page of  a  derived  class
97       for the format and default values.
98

SEE ALSO

100       SoBoolOperation,   SoCalculator,   SoComposeMatrix,  SoComposeRotation,
101       SoComposeRotationFromTo,   SoComposeVec2f,   SoComposeVec3f,   SoCompo‐
102       seVec4f, SoComputeBoundingBox, SoConcatenate, SoCounter, SoDecomposeMa‐
103       trix, SoDecomposeRotation, SoDecomposeVec2f, SoDecomposeVec3f, SoDecom‐
104       poseVec4f,  SoElapsedTime,  SoGate,  SoInterpolate, SoOnOff, SoOneShot,
105       SoSelectOne, SoTimeCounter, SoTransformVec3f, SoTriggerAny
106
107
108
109
110                                                               SoEngine(3IV)()
Impressum