man SoMFEngine () - multiple-value field containing any number of pointers to engines
NAME
SoMFEngine - multiple-value field containing any number of pointers to engines
INHERITS FROM
SoField > SoMField > SoMFEngine
SYNOPSIS
#include <Inventor/fields/SoMFEngine.h>
Methods from class SoMFEngine:
c
}
c
}
getClassTypeId()
c
}
c
}
getTypeId() const
c
}
c
}
operator [](int i) const
c
}
c
}
getValues(int start) const
c
}
c
}
find(SoEngine * targetValue, SbBool addIfNotFound = FALSE)
c
}
c
}
setValues(int start, int num, const SoEngine * *newValues)
c
}
c
}
set1Value(int index, SoEngine * newValue)
c
}
c
}
operator =(SoEngine * newValue)
c
}
c
}
setValue(SoEngine * newValue)
c
}
c
}
operator ==(const SoMFEngine &f) const
c
}
c
}
operator !=(const SoMFEngine &f) const
c
}
c
}
startEditing()
c
}
c
}
finishEditing()
Methods from class SoMField:
c
}
c
}
getNum() const
c
}
c
}
setNum(int num)
c
}
c
}
deleteValues(int start, int num = -1)
c
}
c
}
insertSpace(int start, int num)
c
}
c
}
set1(int index, const char *valueString)
c
}
c
}
get1(int index, SbString &valueString)
Methods from class SoField:
c
}
c
}
setIgnored(SbBool ignore)
c
}
c
}
isIgnored() const
c
}
c
}
isDefault() const
c
}
c
}
isOfType(SoType type) const
c
}
c
}
set(const char *valueString)
c
}
c
}
get(SbString &valueString)
c
}
c
}
touch()
c
}
c
}
connectFrom(SoField *fromField)
c
}
c
}
connectFrom(SoEngineOutput *fromEngine)
c
}
c
}
disconnect()
c
}
c
}
isConnected() const
c
}
c
}
isConnectedFromField() const
c
}
c
}
getConnectedField(SoField *&writingField) const
c
}
c
}
isConnectedFromEngine() const
c
}
c
}
getConnectedEngine(SoEngineOutput *&engineOutput) const
c
}
c
}
enableConnection(SbBool flag)
c
}
c
}
isConnectionEnabled() const
c
}
c
}
getForwardConnections(SoFieldList &list) const
c
}
c
}
getContainer() const
DESCRIPTION
This field maintains a set of pointers to SoEngine instances, correctly maintaining their reference counts. SoMFEngines are written to file as one or more engines. When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:
[ ElapsedTime { }, OneShot { duration 2.0 }, USE myCalculator ]
METHODS
c
}
c
}
getClassTypeId()
c
}
c
}
getTypeId() const
Returns the type for this class or a particular object of this class.
c
}
c
}
operator [](int i) const
Returns the i'th value of the field. Indexing past the end of the field (passing in i greater than getNum()) will return garbage.
c
}
c
}
getValues(int start) const
Returns a pointer into the array of values in the field, starting at index start. The values are read-only; see the startEditing()/finishEditing() methods for a way of modifying values in place.
c
}
c
}
find(SoEngine * targetValue, SbBool addIfNotFound = FALSE)
Finds the given value in the array and returns the index of that value in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array (but -1 is still returned).
c
}
c
}
setValues(int start, int num, const SoEngine * *newValues)
Sets num values starting at index start to the values in newValues. The array will be automatically be made larger to accomodate the new values, if necessary.
c
}
c
}
set1Value(int index, SoEngine * newValue)
Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary.
c
}
c
}
operator =(SoEngine * newValue)
c
}
c
}
setValue(SoEngine * newValue)
Sets the first value in the array to newValue, and deletes the second and subsequent values.
c
}
c
}
operator ==(const SoMFEngine &f) const
c
}
c
}
operator !=(const SoMFEngine &f) const
Returns TRUE if all of the values of this field equal (do not equal) those of the given field. If the fields are different types FALSE will always be returned (even if one field is an SoMFFloat with one value of
1.0 and the other is an SoMFInt with a value of 1, for example).
c
}
c
}
startEditing()
c
}
c
}
finishEditing()
startEditing() returns a pointer to the internally-maintained array that can be modified. The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods
between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc).
Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and
sensors that the field changed, even if none of the values actually were changed.