com.openinventor.inventor.fields

Class SoMFVec3d

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFVec3d

public class SoMFVec3d
extends SoMField

Multiple-value field containing any number of three-dimensional vectors. A multiple-value field that contains any number of three-dimensional vectors.

SoMFVec3ds are written to file as one or more triples of double precision values separated by whitespace.

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

   [ 0 0 0, 1.2 3.4 5.6, 98.6 -4e1 212 ]

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
SoMFVec3d() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFVec3d(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(SbVec3d targetValue) Calls find(targetValue, false).
int	find(SbVec3d 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.
SbVec3d	get1Value(int i) Deprecated.
java.nio.DoubleBuffer	getDirectValues(int start) Returns a pointer into the array of values in the field, starting at index start.
SbVec3d	getValueAt(int i)
SbVec3d[]	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, double[] xyz) Sets one value from 3 doubles in array.
void	set1Value(int index, double x, double y, double z) Sets one value from 3 doubles.
void	set1Value(int index, SbVec3d newValue) Sets the index'th value in the array to newValue.
void	setValue(double[] xyz) Sets to one value from 3 doubles in array.
void	setValue(double x, double y, double z) Sets to one value from 3 doubles.
void	setValue(SbVec3d newValue) Sets the first value in the array to newValue, and deletes.
void	setValues(int start, double[] xyz) Sets values from the specified array of doubles.
void	setValues(int start, int num, double[] xyz) Deprecated. As of Open Inventor 9.3.1, use setValues(int, double[]) instead.
void	setValues(int start, SbVec3d[] newValues) Sets num values starting at index start to the values.
void	setValuesBuffer(java.nio.ByteBuffer userData) Sets the field to contain the values stored in userData.
java.nio.DoubleBuffer	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

SoMFVec3d

@Deprecated
public SoMFVec3d()

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

SoMFVec3d

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

Default constructor.

Method Detail

setValues

public void setValues(int start,
                      int num,
                      double[] xyz)

Deprecated. As of Open Inventor 9.3.1, use setValues(int, double[]) instead.

Sets values from array of arrays of 3 doubles.

find

public int find(SbVec3d targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public SbVec3d get1Value(int i)

Deprecated.

getDirectValues

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

find

public int find(SbVec3d 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).

getValues

public SbVec3d[] 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.

set1Value

public void set1Value(int index,
                      double x,
                      double y,
                      double z)

Sets one value from 3 doubles.

startEditing

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

getValueAt

public SbVec3d getValueAt(int i)

finishEditing

public void finishEditing()

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

setValues

public void setValues(int start,
                      SbVec3d[] 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.

setValue

public void setValue(double[] xyz)

Sets to one value from 3 doubles in array.

setValues

public void setValues(int start,
                      double[] xyz)

Sets values from the specified array of doubles. The size of the array must be a multiple of 3.

set1Value

public void set1Value(int index,
                      double[] xyz)

Sets one value from 3 doubles in array.

setValue

public void setValue(double x,
                     double y,
                     double z)

Sets to one value from 3 doubles.

setValuesBuffer

public void setValuesBuffer(java.nio.ByteBuffer userData)

Sets the field to contain the values stored in userData. This data will not be copied into the field: it will be directly used by the field.

setValue

public void setValue(SbVec3d 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.

set1Value

public void set1Value(int index,
                      SbVec3d 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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.