SoMField(3IV)

NAME
     SoMField (SoMField) - base class for all multiple-valued fields

INHERITS FROM
     SoField > SoMField

SYNOPSIS
     #include <Inventor_c/fields/SoField.h>

          Functions from class SoMField:

     int                 SoMFieldGetNum(const SoMField *this)
     void                SoMFieldSetNum(SoMField *this, int num)
     void                SoMFieldDel(SoMField *this, int start, int num = -1)
     void                SoMFieldInsertSpace(SoMField *this, int start, int
                              num)
     SbBool              SoMFieldSet1(SoMField *this, int index, const char
                              *valueString)
     void                SoMFieldGet1(SoMField *this, int index, SbString
                              *valueString)
     SoType              SoMFieldGetClassTypeId()

          Functions from class SoField:

     void                SoMFieldSetIgnored(SoMField *this, SbBool ignore)
     SbBool              SoMFieldIsIgnored(const SoMField *this)
     SbBool              SoMFieldIsDflt(const SoMField *this)
     SoType              SoMFieldGetTypeId(const SoMField *this)
     SbBool              SoMFieldIsOfType(const SoMField *this, SoType type)
     SbBool              SoMFieldSetFromStr(SoMField *this, const char
                              *valueString)
     void                SoMFieldGetIntoStr(SoMField *this, SbString
                              *valueString)
     int                 SoMFieldIsEq(const SoMField *this, const SoField *f)
     int                 SoMFieldIsNEq(const SoMField *this, const SoField *f)
     void                SoMFieldTouch(SoMField *this)
     SbBool              SoMFieldConnFromField(SoMField *this, SoField
                              *fromField)
     SbBool              SoMFieldConnFrom(SoMField *this, SoEngineOutput
                              *fromEngine)
     void                SoMFieldDisconn(SoMField *this)
     SbBool              SoMFieldIsConn(const SoMField *this)
     SbBool              SoMFieldIsConnFromField(const SoMField *this)
     SbBool              SoMFieldGetConnField(const SoMField *this, SoField
                              **writingField)
     SbBool              SoMFieldIsConnFromEngine(const SoMField *this)
     SbBool              SoMFieldGetConnEngine(const SoMField *this,
                              SoEngineOutput **engineOutput)
     void                SoMFieldEnableConn(SoMField *this, SbBool flag)
     SbBool              SoMFieldIsConnEnabled(const SoMField *this)
     int                 SoMFieldGetForwardConn(const SoMField *this,
                              SoFieldList *list)
     SoFieldContainer *  SoMFieldGetContainer(const SoMField *this)


DESCRIPTION
     Each class derived from SoMField begins with an SoMF prefix and contains
     a dynamic array of values of a particular type. Each has a SetN() 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 GetN() 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.)

     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 StartEdit() 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 FinishEdit() method indicates that
     the editing is done and notifies any sensors or engines that may be
     connected to the field.

     This class is rarely needed by C programmers.

     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, ]



FUNCTIONS
     int                 SoMFieldGetNum(const SoMField *this)
          Returns the number of values currently in the field.

     void                SoMFieldSetNum(SoMField *this, int num)
          Forces this field to have exactly num values, inserting or deleting
          values as necessary.
     void                SoMFieldDel(SoMField *this, int start, int num = -1)
          Deletes num values beginning at index start (index start through
          start+num-1 will be deleted, and any leftover values will be moved
          down to fill in the gap created). A num of -1 means delete all
          values from start to the last value in the field; getNum() will
          return start as the number of values in the field after this
          operation ( empties the field).

     void                SoMFieldInsertSpace(SoMField *this, int start, int
                              num)
          Inserts space for num values at index start. Index start through
          start+num-1 will be moved up to make room. For example, to make room
          for 7 new values at the beginning of the field call InsertSpace(0,
          10).

     SbBool              SoMFieldSet1(SoMField *this, int index, const char
                              *valueString)
     void                SoMFieldGet1(SoMField *this, int index, SbString
                              *valueString)
          These are equivalent to the Set() and Get() methods of SoField, but
          they operate on only one value. See the SoField methods for details.

     SoType              SoMFieldGetClassTypeId()
          Return the type identifier for this field class.


SEE ALSO
     SoNode, SoEngine