logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SoMFName — multiple-value field containing any number of names

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 ]

Inherits From

       SoField > SoMField > SoMFName

Methods

voidsetValues(intstart,intnum,constchar*strings[])
          Sets num values beginning at index start to the names contained in the given set of character strings.

     voidsetValue(constchar*string)
          Sets this field to contain one and only one value, given by string.

     staticSoTypegetClassTypeId()virtualvoidgetTypeId()const
          Returns the type for this class or a particular object of this class.

     constSbName&operator[](inti)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.

     constSbName*getValues(intstart)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.

     intfind(constSbName&targetValue,SbBooladdIfNotFound=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).

     voidsetValues(intstart,intnum,constSbName*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.

     voidset1Value(intindex,constSbName&newValue)
          Sets the index'th value in the array to  newValue.  The  array  will  be  automatically  expanded,  if
          necessary.

     constSbName&operator=(constSbName&newValue)voidsetValue(constSbName&newValue)
          Sets the first value in the array to newValue, and deletes the second and subsequent values.

     intoperator==(constSoMFName&f)constintoperator!=(constSoMFName&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()voidfinishEditing()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)()

Name

       SoMFName — multiple-value field containing any number of names

Synopsis

#include<Inventor/fields/SoMFName.h>

          Methods from class SoMFName:

     voidsetValues(intstart,intnum,constchar*strings[])voidsetValue(constchar*string)staticSoTypegetClassTypeId()virtualvoidgetTypeId()constconstSbName&operator[](inti)constconstSbName*getValues(intstart)constintfind(constSbName&targetValue,SbBooladdIfNotFound=FALSE)voidsetValues(intstart,intnum,constSbName*newValues)voidset1Value(intindex,constSbName&newValue)constSbName&operator=(constSbName&newValue)voidsetValue(constSbName&newValue)intoperator==(constSoMFName&f)constintoperator!=(constSoMFName&f)constSbName*startEditing()voidfinishEditing()

          Methods from class SoMField:

     intgetNum()constvoidsetNum(intnum)virtualvoiddeleteValues(intstart,intnum=-1)virtualvoidinsertSpace(intstart,intnum)SbBoolset1(intindex,constchar*valueString)voidget1(intindex,SbString&valueString)

          Methods from class SoField:

     voidsetIgnored(SbBoolignore)SbBoolisIgnored()constSbBoolisDefault()constvirtualSbBoolisOfType(SoTypetype)constSbBoolset(constchar*valueString)voidget(SbString&valueString)voidtouch()SbBoolconnectFrom(SoField*fromField)SbBoolconnectFrom(SoEngineOutput*fromEngine)voiddisconnect()SbBoolisConnected()constSbBoolisConnectedFromField()constSbBoolgetConnectedField(SoField*&writingField)constSbBoolisConnectedFromEngine()constSbBoolgetConnectedEngine(SoEngineOutput*&engineOutput)constvoidenableConnection(SbBoolflag)SbBoolisConnectionEnabled()constintgetForwardConnections(SoFieldList&list)constSoFieldContainer*getContainer()const

See Also