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

SoMFPath — multiple-value field containing any number of pointers to paths

Description

       This field maintains a set of pointers to SoPath instances, correctly maintaining their reference counts.

       SoMFPaths  are  written to file as one or more paths (see the SoPath manual page for a description of the
       file format for a path). When more than one value is present, all of the values are  enclosed  in  square
       brackets and separated by commas.

Inherits From

       SoField > SoMField > SoMFPath

Methods

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

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

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

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

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

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

                                                                                                 SoMFPath(3IV)()

Name

       SoMFPath — multiple-value field containing any number of pointers to paths

Synopsis

#include<Inventor/fields/SoMFPath.h>

          Methods from class SoMFPath:

     staticSoTypegetClassTypeId()virtualvoidgetTypeId()constSoPath*operator[](inti)constconstSoPath**getValues(intstart)constintfind(SoPath*targetValue,SbBooladdIfNotFound=FALSE)voidsetValues(intstart,intnum,constSoPath**newValues)voidset1Value(intindex,SoPath*newValue)SoPath*operator=(SoPath*newValue)voidsetValue(SoPath*newValue)intoperator==(constSoMFPath&f)constintoperator!=(constSoMFPath&f)constSoPath**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