NAME

       SoMFVec3f — multiple-value field containing any number of three-dimensional vectors

INHERITS FROM

       SoField > SoMField > SoMFVec3f

SYNOPSIS

       #include <Inventor/fields/SoMFVec3f.h>

          Methods from class SoMFVec3f:

     void                setValues(int start, int num, const float xyz[][3])
     void                set1Value(int index, float x, float y, float z)
     void                set1Value(int index, const float xyz[3])
     void                setValue(float x, float y, float z)
     void                setValue(const float xyz[3])
     static SoType       getClassTypeId()
     virtual void        getTypeId() const
     const SbVec3f &     operator [](int i) const
     const SbVec3f *     getValues(int start) const
     int                 find(const SbVec3f & targetValue, SbBool addIfNotFound = FALSE)
     void                setValues(int start, int num, const SbVec3f *newValues)
     void                set1Value(int index, const SbVec3f & newValue)
     const SbVec3f &     operator =(const SbVec3f & newValue)
     void                setValue(const SbVec3f & newValue)
     int                 operator ==(const SoMFVec3f &f) const
     int                 operator !=(const SoMFVec3f &f) const
     SbVec3f *           startEditing()
     void                finishEditing()

          Methods from class SoMField:

     int                 getNum() const
     void                setNum(int num)
     virtual void        deleteValues(int start, int num = -1)
     virtual void        insertSpace(int start, int num)
     SbBool              set1(int index, const char *valueString)
     void                get1(int index, SbString &valueString)

          Methods from class SoField:

     void                setIgnored(SbBool ignore)
     SbBool              isIgnored() const
     SbBool              isDefault() const
     virtual SbBool      isOfType(SoType type) const
     SbBool              set(const char *valueString)
     void                get(SbString &valueString)
     void                touch()
     SbBool              connectFrom(SoField *fromField)
     SbBool              connectFrom(SoEngineOutput *fromEngine)
     void                disconnect()
     SbBool              isConnected() const
     SbBool              isConnectedFromField() const
     SbBool              getConnectedField(SoField *&writingField) const
     SbBool              isConnectedFromEngine() const
     SbBool              getConnectedEngine(SoEngineOutput *&engineOutput) const
     void                enableConnection(SbBool flag)
     SbBool              isConnectionEnabled() const
     int                 getForwardConnections(SoFieldList &list) const
     SoFieldContainer *  getContainer() const

DESCRIPTION

       A multiple-value field that contains any number of three-dimensional vectors.

       SoMFVec3fs  are  written to file as one or more triples of floating point values separated
       by whitespace.

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

          [ 0 0 0, 1.2 3.4 5.6, 98.6 -4e1 212 ]

METHODS

     void                setValues(int start, int num, const float xyz[][3])
          Sets  num values starting at index start to the given floating point values. There must
          be num*3 values in the passed array.

     void                set1Value(int index, float x, float y, float z)
     void                set1Value(int index, const float xyz[3])
          Set the index'th value to the given floating point values.

     void                setValue(float x, float y, float z)
     void                setValue(const float xyz[3])
          Sets the field to contain the given value and only the given value (if  the  array  had
          multiple values before, they are deleted).

     static SoType       getClassTypeId()
     virtual void        getTypeId() const
          Returns the type for this class or a particular object of this class.

     const SbVec3f &     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.

     const SbVec3f *     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.

     int                 find(const SbVec3f & 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                setValues(int start, int num, const SbVec3f *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                set1Value(int index, const SbVec3f & newValue)
          Sets  the  index'th  value  in  the  array to newValue. The array will be automatically
          expanded, if necessary.

     const SbVec3f &     operator =(const SbVec3f & newValue)
     void                setValue(const SbVec3f & newValue)
          Sets the first value in the array to newValue, and deletes the  second  and  subsequent
          values.

     int                 operator ==(const SoMFVec3f &f) const
     int                 operator !=(const SoMFVec3f &f) const
          Returns  TRUE  if all of the values of this field equal (do not equal) 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).

     SbVec3f *           startEditing()
     void                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.

                                                                                 SoMFVec3f(3IV)()