com.openinventor.inventor.fields

Class SoMFMatrix

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFMatrix

public class SoMFMatrix
extends SoMField

Multiple-value field containing any number of 4x4 matrices. A multiple-value field that contains any number of 4x4 matrices.

SoMFMatrix are written to file as sets of 16 floating point numbers 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, two identity matrices might be written as:

   [ 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1,
   1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 ]

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
SoMFMatrix() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFMatrix(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(SbMatrix targetValue) Calls find(targetValue, false).
int	find(SbMatrix 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.
SbMatrix	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.
SbMatrix	getValueAt(int i)
SbMatrix[]	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, SbMatrix newValue) Sets the index'th value in the array to newValue.
void	set1Value(int index, SbMatrixd md) Sets the index 'th value in the array to newValue , a double precision matrix.
void	setValue(float a11, float a12, float a13, float a14, float a21, float a22, float a23, float a24, float a31, float a32, float a33, float a34, float a41, float a42, float a43, float a44) Makes this field contain one and only one value, which is the matrix given by the 16 values.
void	setValue(SbMatrix newValue) Sets the first value in the array to newValue, and deletes.
void	setValue(SbMatrixd md) Sets the first value in the array to newValue , a double precision matrix, and deletes the second and subsequent values.
void	setValues(int start, int num, SbMatrixd[] md) Deprecated. As of Open Inventor 9.3.1, use setValues(int, com.openinventor.inventor.SbMatrixd[]) instead.
void	setValues(int start, SbMatrix[] newValues) Sets num values starting at index start to the values.
void	setValues(int start, SbMatrixd[] md) Sets values starting at index start to the values in the specified array of double precision matrices.
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

SoMFMatrix

@Deprecated
public SoMFMatrix()

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

SoMFMatrix

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

Default constructor.

Method Detail

setValues

public void setValues(int start,
                      int num,
                      SbMatrixd[] md)

Deprecated. As of Open Inventor 9.3.1, use setValues(int, com.openinventor.inventor.SbMatrixd[]) instead.

Sets num values starting at index start to the values in newValues , an array of double precision values. The array will automatically be made larger to accommodate the new values, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified values are converted to single precision, then stored.

find

public int find(SbMatrix targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public SbMatrix get1Value(int i)

Deprecated.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

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.

finishEditing

public void finishEditing()

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

getValueAt

public SbMatrix getValueAt(int i)

set1Value

public void set1Value(int index,
                      SbMatrix 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(float a11,
                     float a12,
                     float a13,
                     float a14,
                     float a21,
                     float a22,
                     float a23,
                     float a24,
                     float a31,
                     float a32,
                     float a33,
                     float a34,
                     float a41,
                     float a42,
                     float a43,
                     float a44)

Makes this field contain one and only one value, which is the matrix given by the 16 values.

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

setValue

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

setValues

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

getValues

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

setValues

public void setValues(int start,
                      SbMatrixd[] md)

Sets values starting at index start to the values in the specified array of double precision matrices. The array will automatically be made larger to accommodate the new values, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified values are converted to single precision, then stored.

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.

set1Value

public void set1Value(int index,
                      SbMatrixd md)

Sets the index 'th value in the array to newValue , a double precision matrix. The array will be automatically expanded, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

find

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

setValue

public void setValue(SbMatrixd md)

Sets the first value in the array to newValue , a double precision matrix, and deletes the second and subsequent values. Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.