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

SoMFString — multiple-value field containing any number of strings

Description

       A multiple-value field that contains any number of strings.

       SoMFStrings  are  written  to file as one or more strings within double quotes. Any characters (including
       newlines) may appear within the quotes. To include a double quote character within the string, precede it
       with a backslash. For example:

          [ cowEnizer , "Scene Boy" , "He said, \"I did not!\"" ]

Inherits From

       SoField > SoMField > SoMFString

Methods

setValues(intstart,intnum,constchar*strings[])
          Sets num values, starting at index start, to the strings in the given character arrays.

                         setValue(constchar*string)
          Deletes all values currently in this field and sets this field to contain only the given string.

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

     constSbString&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.

     constSbString*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(constSbString&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 will be added to the end  of  the
          array (but -1 is still returned).

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

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

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

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

                                                                                               SoMFString(3IV)()

Name

       SoMFString — multiple-value field containing any number of strings

Synopsis

#include<Inventor/fields/SoMFString.h>

          Methods from class SoMFString:

                         setValues(intstart,intnum,constchar*strings[])setValue(constchar*string)staticSoTypegetClassTypeId()virtualvoidgetTypeId()constconstSbString&operator[](inti)constconstSbString*getValues(intstart)constintfind(constSbString&targetValue,SbBooladdIfNotFound=FALSE)voidsetValues(intstart,intnum,constSbString*newValues)voidset1Value(intindex,constSbString&newValue)constSbString&operator=(constSbString&newValue)voidsetValue(constSbString&newValue)intoperator==(constSoMFString&f)constintoperator!=(constSoMFString&f)constSbString*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