SoMFPlane(3IV)

NAME
     SoMFPlane (SoMPlane) - field containing several plane equations

INHERITS FROM
     SoField > SoMField > SoMFPlane

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

     typedef SoMFPlane   SoMPlane

          Functions from class SoMFPlane:

     SoType              SoMPlaneGetClassTypeId()
     void                SoMPlaneGetTypeId(const SoMPlane *this)
     SbPlane             SoMPlaneGet(const SoMPlane *this, int i)
     const SbPlane *     SoMPlaneGetN(const SoMPlane *this, int start)
     int                 SoMPlaneFind(SoMPlane *this, SbPlane targetValue,
                              SbBool addIfNotFound = FALSE)
     void                SoMPlaneSetN(SoMPlane *this, int start, int num,
                              const SbPlane *newValues)
     void                SoMPlaneSet1(SoMPlane *this, int index, SbPlane
                              newValue)
     void                SoMPlaneSet(SoMPlane *this, SbPlane newValue)
     int                 SoMPlaneIsEq(const SoMPlane *this, const SoMFPlane
                              *f)
     int                 SoMPlaneIsNEq(const SoMPlane *this, const SoMFPlane
                              *f)
     SbPlane *           SoMPlaneStartEdit(SoMPlane *this)
     void                SoMPlaneFinishEdit(SoMPlane *this)

          Functions from class SoMField:

     int                 SoMPlaneGetNum(const SoMPlane *this)
     void                SoMPlaneSetNum(SoMPlane *this, int num)
     void                SoMPlaneDel(SoMPlane *this, int start, int num = -1)
     void                SoMPlaneInsertSpace(SoMPlane *this, int start, int
                              num)
     void                SoMPlaneGet1(SoMPlane *this, int index, SbString
                              *valueString)

          Functions from class SoField:

     void                SoMPlaneSetIgnored(SoMPlane *this, SbBool ignore)
     SbBool              SoMPlaneIsIgnored(const SoMPlane *this)
     SbBool              SoMPlaneIsDflt(const SoMPlane *this)
     SbBool              SoMPlaneIsOfType(const SoMPlane *this, SoType type)
     SbBool              SoMPlaneSetFromStr(SoMPlane *this, const char
                              *valueString)
     void                SoMPlaneGetIntoStr(SoMPlane *this, SbString
                              *valueString)
     void                SoMPlaneTouch(SoMPlane *this)
     SbBool              SoMPlaneConnFromField(SoMPlane *this, SoField
                              *fromField)
     SbBool              SoMPlaneConnFrom(SoMPlane *this, SoEngineOutput
                              *fromEngine)
     void                SoMPlaneDisconn(SoMPlane *this)
     SbBool              SoMPlaneIsConn(const SoMPlane *this)
     SbBool              SoMPlaneIsConnFromField(const SoMPlane *this)
     SbBool              SoMPlaneGetConnField(const SoMPlane *this, SoField
                              **writingField)
     SbBool              SoMPlaneIsConnFromEngine(const SoMPlane *this)
     SbBool              SoMPlaneGetConnEngine(const SoMPlane *this,
                              SoEngineOutput **engineOutput)
     void                SoMPlaneEnableConn(SoMPlane *this, SbBool flag)
     SbBool              SoMPlaneIsConnEnabled(const SoMPlane *this)
     int                 SoMPlaneGetForwardConn(const SoMPlane *this,
                              SoFieldList *list)
     SoFieldContainer *  SoMPlaneGetContainer(const SoMPlane *this)


DESCRIPTION
     A field containing one or more plane equations.

     SoMFPlanes are written to file as groups of four floating point values
     separated by whitespace. In each set of four values, the first three are
     the normal direction of the plane, the fourth is the distance of the
     plane from the origin (in the direction of the normal).

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

          [ 1 0 0 0, .707 .707 0 100, ]



FUNCTIONS
     SoType              SoMPlaneGetClassTypeId()
     void                SoMPlaneGetTypeId(const SoMPlane *this)
          Returns the type for this class or a particular object of this
          class.

     SbPlane             SoMPlaneGet(const SoMPlane *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 SbPlane *     SoMPlaneGetN(const SoMPlane *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                 SoMPlaneFind(SoMPlane *this, SbPlane 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                SoMPlaneSetN(SoMPlane *this, int start, int num,
                              const SbPlane *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                SoMPlaneSet1(SoMPlane *this, int index, SbPlane
                              newValue)
          Sets the index'th value in the array to newValue. The array will be
          automatically expanded, if necessary.

     void                SoMPlaneSet(SoMPlane *this, SbPlane newValue)
          Sets the first value in the array to newValue, and deletes the
          second and subsequent values.

     int                 SoMPlaneIsEq(const SoMPlane *this, const SoMFPlane
                              *f)
     int                 SoMPlaneIsNEq(const SoMPlane *this, const SoMFPlane
                              *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).

     SbPlane *           SoMPlaneStartEdit(SoMPlane *this)
     void                SoMPlaneFinishEdit(SoMPlane *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.