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

SoMFPlane — field containing several plane equations

Description

       A field containing one or more plane equations.

       SoMFPlanes  are  written to file as groups of four floating point values separated by whitespace. In each
       set of four values, the first three are the normal direction of the plane, the fourth is the distance  of
       the plane from the origin (in the direction of the normal).

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

          [ 1 0 0 0, .707 .707 0 100, ]

Inherits From

       SoField > SoMField > SoMFPlane

Methods

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

     SbPlaneoperator[](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.

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

     SbPlaneoperator=(SbPlanenewValue)voidsetValue(SbPlanenewValue)
          Sets the first value in the array to newValue, and deletes the second and subsequent values.

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

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

                                                                                                SoMFPlane(3IV)()

Name

       SoMFPlane — field containing several plane equations

Synopsis

#include<Inventor/fields/SoMFPlane.h>

          Methods from class SoMFPlane:

     staticSoTypegetClassTypeId()virtualvoidgetTypeId()constSbPlaneoperator[](inti)constconstSbPlane*getValues(intstart)constintfind(SbPlanetargetValue,SbBooladdIfNotFound=FALSE)voidsetValues(intstart,intnum,constSbPlane*newValues)voidset1Value(intindex,SbPlanenewValue)SbPlaneoperator=(SbPlanenewValue)voidsetValue(SbPlanenewValue)intoperator==(constSoMFPlane&f)constintoperator!=(constSoMFPlane&f)constSbPlane*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