SoMFBool(3IV)

NAME
     SoMFBool (SoMBool) - multiple-value field containing any number of
     boolean values

INHERITS FROM
     SoField > SoMField > SoMFBool

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

     typedef SoMFBool    SoMBool

          Functions from class SoMFBool:

     SoType              SoMBoolGetClassTypeId()
     void                SoMBoolGetTypeId(const SoMBool *this)
     SbBool              SoMBoolGet(const SoMBool *this, int i)
     const SbBool *      SoMBoolGetN(const SoMBool *this, int start)
     int                 SoMBoolFind(SoMBool *this, SbBool targetValue, SbBool
                              addIfNotFound = FALSE)
     void                SoMBoolSetN(SoMBool *this, int start, int num, const
                              SbBool *newValues)
     void                SoMBoolSet1(SoMBool *this, int index, SbBool
                              newValue)
     void                SoMBoolSet(SoMBool *this, SbBool newValue)
     int                 SoMBoolIsEq(const SoMBool *this, const SoMFBool *f)
     int                 SoMBoolIsNEq(const SoMBool *this, const SoMFBool *f)
     SbBool *            SoMBoolStartEdit(SoMBool *this)
     void                SoMBoolFinishEdit(SoMBool *this)

          Functions from class SoMField:

     int                 SoMBoolGetNum(const SoMBool *this)
     void                SoMBoolSetNum(SoMBool *this, int num)
     void                SoMBoolDel(SoMBool *this, int start, int num = -1)
     void                SoMBoolInsertSpace(SoMBool *this, int start, int num)
     void                SoMBoolGet1(SoMBool *this, int index, SbString
                              *valueString)

          Functions from class SoField:

     void                SoMBoolSetIgnored(SoMBool *this, SbBool ignore)
     SbBool              SoMBoolIsIgnored(const SoMBool *this)
     SbBool              SoMBoolIsDflt(const SoMBool *this)
     SbBool              SoMBoolIsOfType(const SoMBool *this, SoType type)
     SbBool              SoMBoolSetFromStr(SoMBool *this, const char
                              *valueString)
     void                SoMBoolGetIntoStr(SoMBool *this, SbString
                              *valueString)
     void                SoMBoolTouch(SoMBool *this)
     SbBool              SoMBoolConnFromField(SoMBool *this, SoField
                              *fromField)
     SbBool              SoMBoolConnFrom(SoMBool *this, SoEngineOutput
                              *fromEngine)
     void                SoMBoolDisconn(SoMBool *this)
     SbBool              SoMBoolIsConn(const SoMBool *this)
     SbBool              SoMBoolIsConnFromField(const SoMBool *this)
     SbBool              SoMBoolGetConnField(const SoMBool *this, SoField
                              **writingField)
     SbBool              SoMBoolIsConnFromEngine(const SoMBool *this)
     SbBool              SoMBoolGetConnEngine(const SoMBool *this,
                              SoEngineOutput **engineOutput)
     void                SoMBoolEnableConn(SoMBool *this, SbBool flag)
     SbBool              SoMBoolIsConnEnabled(const SoMBool *this)
     int                 SoMBoolGetForwardConn(const SoMBool *this,
                              SoFieldList *list)
     SoFieldContainer *  SoMBoolGetContainer(const SoMBool *this)


DESCRIPTION
     A multiple-value field that contains any number of boolean values.

     SoMFBools are written to file as one or more boolean values, which are
     written as "0" (representing a false value), "1", "TRUE", or "FALSE".

     When more than one value is present, all of the values are enclosed in
     square brackets and separated by commas; for example:

          [ 0, FALSE, 1, TRUE ]



FUNCTIONS
     SoType              SoMBoolGetClassTypeId()
     void                SoMBoolGetTypeId(const SoMBool *this)
          Returns the type for this class or a particular object of this
          class.

     SbBool              SoMBoolGet(const SoMBool *this, int i)
          Returns the i'th value of the field. Indexing past the end of the
          field (passing in i greater than getNum()) will return garbage.

     const SbBool *      SoMBoolGetN(const SoMBool *this, int start)
          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.

     int                 SoMBoolFind(SoMBool *this, SbBool 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).
     void                SoMBoolSetN(SoMBool *this, int start, int num, const
                              SbBool *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.

     void                SoMBoolSet1(SoMBool *this, int index, SbBool
                              newValue)
          Sets the index'th value in the array to newValue. The array will be
          automatically expanded, if necessary.

     void                SoMBoolSet(SoMBool *this, SbBool newValue)
          Sets the first value in the array to newValue, and deletes the
          second and subsequent values.

     int                 SoMBoolIsEq(const SoMBool *this, const SoMFBool *f)
     int                 SoMBoolIsNEq(const SoMBool *this, const SoMFBool *f)
          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).

     SbBool *            SoMBoolStartEdit(SoMBool *this)
     void                SoMBoolFinishEdit(SoMBool *this)
          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   StartEdit() and FinishEdit() (e.g. Set1(),
          Set(), etc).

          Fields, engines or sensors connected to this field and sensors are
          not notified that this field has changed until FinishEdit() is
          called. Calling FinishEdit() always sets the IsDflt flag to FALSE
          and informs engines and sensors that the field changed, even if none
          of the values actually were changed.