com.openinventor.inventor.fields

Class SoMFPlane

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFPlane

public class SoMFPlane
extends SoMField

Field containing several plane equations. 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, ]

Data copying:

SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesBuffer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoMFPlane() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFPlane(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	disableDeleteValues() Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(SbPlane targetValue) Calls find(targetValue, false).
int	find(SbPlane targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.
void	finishEditing() Indicates that batch edits have finished.
SbPlane	get1Value(int i) Deprecated.
java.nio.FloatBuffer	getDirectValues(int start) Returns a pointer into the array of values in the field, starting at index start.
SbPlane	getValueAt(int i)
SbPlane[]	getValues(int start) Returns a pointer into the array of values in the field, starting at index start.
long	getValueSize() Get size of the value.
void	set1Value(int index, SbPlane newValue) Sets the index'th value in the array to newValue.
void	setValue(SbPlane newValue) Sets the first value in the array to newValue, and deletes.
void	setValues(int start, SbPlane[] newValues) Sets num values starting at index start to the values.
java.nio.FloatBuffer	startEditing() Returns a pointer to the internally maintained array that can be modified.

Methods inherited from class com.openinventor.inventor.fields.SoMField

deleteValues, deleteValues, get1, getNum, insertSpace, set1, setNum

Methods inherited from class com.openinventor.inventor.fields.SoField

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoMFPlane

@Deprecated
public SoMFPlane()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoMFPlane

public SoMFPlane(SoFieldContainer fieldContainer,
                 java.lang.String fieldName,
                 SoField.FieldTypes fieldType)

Default constructor.

Method Detail

find

public int find(SbPlane targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public SbPlane get1Value(int i)

Deprecated.

startEditing

public java.nio.FloatBuffer 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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

set1Value

public void set1Value(int index,
                      SbPlane newValue)

Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.

setValue

public void setValue(SbPlane newValue)

Sets the first value in the array to newValue, and deletes. the second and subsequent values. If field's values are stored in an user data array, this array is no more used.

finishEditing

public void finishEditing()

Indicates that batch edits have finished. See startEditing().

find

public int find(SbPlane targetValue,
                boolean addIfNotFound)

Finds the given targetValue 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).

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

getValues

public SbPlane[] getValues(int start)

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.

getValueAt

public SbPlane getValueAt(int i)

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

setValues

public void setValues(int start,
                      SbPlane[] newValues)

Sets num values starting at index start to the values. in newValues. The array will automatically be made larger to accommodate the new values, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.

getDirectValues

public java.nio.FloatBuffer getDirectValues(int start)

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.