NAME

       SoMFName — multiple-value field containing any number of names

INHERITS FROM

       SoField > SoMField > SoMFName

SYNOPSIS

       #include <Inventor/fields/SoMFName.h>

          Methods from class SoMFName:

     void                setValues(int start, int num, const char *strings[])
     void                setValue(const char *string)
     static SoType       getClassTypeId()
     virtual void        getTypeId() const
     const SbName &      operator [](int i) const
     const SbName *      getValues(int start) const
     int                 find(const SbName & targetValue, SbBool addIfNotFound = FALSE)
     void                setValues(int start, int num, const SbName *newValues)
     void                set1Value(int index, const SbName & newValue)
     const SbName &      operator=(const SbName & newValue)
     void                setValue(const SbName & newValue)
     int                 operator ==(const SoMFName &f) const
     int                 operator !=(const SoMFName &f) const
     SbName *            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-valued  field  containing  any  number  of  names.  Names  are short series of
       characters generally used for labels or names, and are stored in a special table  designed
       to  allow  fast lookup and comparison.  For most purposes, an SoMFString field is probably
       more appropriate.

       SoMFNames are written to file as one or more strings of characters. Names must begin  with
       an  underscore  or  alphabetic  character,  and  must  consist  entirely  of  underscores,
       alphabetic characters, or numbers. When more than one value is present, all of the  values
       are enclosed in square brackets and separated by commas; for example:

          [ Fred, Wilma, _Part_01, translationField ]

METHODS

     void                setValues(int start, int num, const char *strings[])
          Sets  num  values  beginning  at index start to the names contained in the given set of
          character strings.

     void                setValue(const char *string)
          Sets this field to contain one and only one value, given by string.

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

     const SbName &      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 SbName *      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 SbName & 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 SbName *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 SbName & newValue)
          Sets the index'th value in the array to  newValue.  The  array  will  be  automatically
          expanded, if necessary.

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

     int                 operator ==(const SoMFName &f) const
     int                 operator !=(const SoMFName &f) const
          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).

     SbName *            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.

                                                                                  SoMFName(3IV)()