1SoMFEngine(3IV)() SoMFEngine(3IV)()
2
6 SoMFEngine — multiple-value field containing any number of pointers to
7 engines
8
10 SoField > SoMField > SoMFEngine
11
13 #include <Inventor/fields/SoMFEngine.h>
14 Methods from class SoMFEngine:
16 static SoType getClassTypeId()
18 virtual void getTypeId() const
19 SoEngine * operator [](int i) const
20 const SoEngine * * getValues(int start) const
21 int find(SoEngine * targetValue, SbBool addIfNotFound =
22 FALSE)
23 void setValues(int start, int num, const SoEngine * *new‐
24 Values)
25 void set1Value(int index, SoEngine * newValue)
26 SoEngine * operator =(SoEngine * newValue)
27 void setValue(SoEngine * newValue)
28 int operator ==(const SoMFEngine &f) const
29 int operator !=(const SoMFEngine &f) const
30 SoEngine * * startEditing()
31 void finishEditing()
32 Methods from class SoMField:
34 int getNum() const
36 void setNum(int num)
37 virtual void deleteValues(int start, int num = -1)
38 virtual void insertSpace(int start, int num)
39 SbBool set1(int index, const char *valueString)
40 void get1(int index, SbString &valueString)
41 Methods from class SoField:
43 void setIgnored(SbBool ignore)
45 SbBool isIgnored() const
46 SbBool isDefault() const
47 virtual SbBool isOfType(SoType type) const
48 SbBool set(const char *valueString)
49 void get(SbString &valueString)
50 void touch()
51 SbBool connectFrom(SoField *fromField)
52 SbBool connectFrom(SoEngineOutput *fromEngine)
53 void disconnect()
54 SbBool isConnected() const
55 SbBool isConnectedFromField() const
56 SbBool getConnectedField(SoField *&writingField) const
57 SbBool isConnectedFromEngine() const
58 SbBool getConnectedEngine(SoEngineOutput *&engineOutput)
59 const
60 void enableConnection(SbBool flag)
61 SbBool isConnectionEnabled() const
62 int getForwardConnections(SoFieldList &list) const
63 SoFieldContainer * getContainer() const
64
67 This field maintains a set of pointers to SoEngine instances, correctly
68 maintaining their reference counts.
69 SoMFEngines are written to file as one or more engines. When more than
71 one value is present, all of the values are enclosed in square brackets
72 and separated by commas; for example:
73 [ ElapsedTime { }, OneShot { duration 2.0 }, USE myCalculator ]
75
79 static SoType getClassTypeId()
80 virtual void getTypeId() const
81 Returns the type for this class or a particular object of this
82 class.
83 SoEngine * operator [](int i) const
85 Returns the i'th value of the field. Indexing past the end of the
86 field (passing in i greater than getNum()) will return garbage.
87 const SoEngine * * getValues(int start) const
89 Returns a pointer into the array of values in the field, starting at
90 index start. The values are read-only; see the startEditing()/fin‐
91 ishEditing() methods for a way of modifying values in place.
92 int find(SoEngine * targetValue, SbBool addIfNotFound =
94 FALSE)
95 Finds the given value in the array and returns the index of that
96 value in the array. If the value is not found, -1 is returned. If
97 addIfNotFound is set, then targetValue is added to the end of the
98 array (but -1 is still returned).
99 void setValues(int start, int num, const SoEngine * *new‐
101 Values)
102 Sets num values starting at index start to the values in newValues.
103 The array will be automatically be made larger to accomodate the new
104 values, if necessary.
105 void set1Value(int index, SoEngine * newValue)
107 Sets the index'th value in the array to newValue. The array will be
108 automatically expanded, if necessary.
109 SoEngine * operator =(SoEngine * newValue)
111 void setValue(SoEngine * newValue)
112 Sets the first value in the array to newValue, and deletes the sec‐
113 ond and subsequent values.
114 int operator ==(const SoMFEngine &f) const
116 int operator !=(const SoMFEngine &f) const
117 Returns TRUE if all of the values of this field equal (do not equal)
118 those of the given field. If the fields are different types FALSE
119 will always be returned (even if one field is an SoMFFloat with one
120 value of 1.0 and the other is an SoMFInt with a value of 1, for
121 example).
122 SoEngine * * startEditing()
124 void finishEditing()
125 startEditing() returns a pointer to the internally-maintained array
126 that can be modified. The values in the array may be changed, but
127 values cannot be added or removed. It is illegal to call any other
128 editing methods between startEditing() and finishEditing() (e.g.
129 set1Value(), setValue(), etc).
130 Fields, engines or sensors connected to this field and sensors are
132 not notified that this field has changed until finishEditing() is
133 called. Calling finishEditing() always sets the isDefault() flag to
134 FALSE and informs engines and sensors that the field changed, even
135 if none of the values actually were changed.
136 SoMFEngine(3IV)()