Each class derived from
SoMField begins with an
SoMF prefix and contains a dynamic array of values of a particular type. Each has a
setValues() method that is passed a pointer to a const array of values of the correct type;
these values are copied into the array in the field, making extra room in the array if necessary. The start and num parameters to this method indicate the starting array index to copy into and the number
of values to copy.
The
getValues() method for a multiple-value field returns a const pointer to the array of values in the field. (Because this pointer is const, it cannot be used to change values in this array.)
In addition, the indexing operator "[]" is overloaded to return the
i'th value in the array; because it returns a const reference, it can be used only to get values, not to set them.
Methods
are provided for getting the number of values in the field, inserting space for new values in the middle, and deleting values.
There are other methods that allow you to set only one value of several in
the field and to set the field to contain one and only one value.
Two other methods can be used to make several changes to a multiple-value field without the overhead of copying values into and out of
the fields. The
startEditing() method returns a non-const pointer to the array of values in the field; this pointer can then be used to change (but not add or remove) any values in the array. The
finishEditing() method indicates that
the editing is done and notifies any sensors or engines that may be connected to the field.
SoMFields are written to file as a series of values separated by commas, all enclosed in square brackets. If the field
has no values (
getNum() returns zero), then only the square brackets ("[]") are written. The last value may optionally be followed by a comma. Each field subtype defines how the values are written; for example,
a field whose values are integers might be written as:
[ 1, 2, 3, 4 ]
or:
[ 1, 2, 3, 4, ]