man SoMFPlane () - field containing several plane equations

NAME

SoMFPlane - field containing several plane equations

INHERITS FROM

SoField > SoMField > SoMFPlane

SYNOPSIS

#include <Inventor/fields/SoMFPlane.h> Methods from class SoMFPlane: c } c } getClassTypeId()

c } c } getTypeId() const

c } c } operator [](int i) const

c } c } getValues(int start) const

c } c } find(SbPlane targetValue, SbBool addIfNotFound = FALSE)

c } c } setValues(int start, int num, const SbPlane *newValues)

c } c } set1Value(int index, SbPlane newValue)

c } c } operator =(SbPlane newValue)

c } c } setValue(SbPlane newValue)

c } c } operator ==(const SoMFPlane &f) const

c } c } operator !=(const SoMFPlane &f) const

c } c } startEditing()

c } c } finishEditing() Methods from class SoMField: c } c } getNum() const

c } c } setNum(int num)

c } c } deleteValues(int start, int num = -1)

c } c } insertSpace(int start, int num)

c } c } set1(int index, const char *valueString)

c } c } get1(int index, SbString &valueString) Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

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, ]

METHODS

c } c } getClassTypeId()

c } c } getTypeId() const

Returns the type for this class or a particular object of this class. c } c } 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. c } c } 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. c } c } find(SbPlane 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). c } c } setValues(int start, int num, const SbPlane *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. c } c } set1Value(int index, SbPlane newValue)

Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. c } c } operator =(SbPlane newValue)

c } c } setValue(SbPlane newValue)

Sets the first value in the array to newValue, and deletes the second and subsequent values. c } c } operator ==(const SoMFPlane &f) const

c } c } operator !=(const SoMFPlane &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). c } c } startEditing()

c } c } 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.