com.openinventor.inventor.fields

Class SoMFRotation

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFRotation

public class SoMFRotation
extends SoMField

Multiple-value field containing any number of SbRotations. A multiple-value field that contains any number of SbRotations.

SoMFRotations are written to file as one or more sets of four floating point values. Each set of 4 values is an axis of rotation followed by the amount of right-handed rotation about that axis, in radians.

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

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. See also:

SbRotation

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
SoMFRotation() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFRotation(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(SbRotation targetValue) Calls find(targetValue, false).
int	find(SbRotation 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.
SbRotation	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.
SbRotation	getValueAt(int i)
SbRotation[]	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, float[] q) Sets the index 'th value to the given quaternion (x, y, z, w).
void	set1Value(int index, float q0, float q1, float q2, float q3) Sets the index 'th value to the given quaternion (x, y, z, w).
void	set1Value(int index, SbRotation newValue) Sets the index'th value in the array to newValue.
void	set1Value(int index, SbRotationd rd) Sets the index 'th value in the array to newValue , a double precision rotation.
void	set1Value(int index, SbVec3f axis, float angle) Sets the index 'th value to the given axis/angle.
void	setValue(float[] q) Makes this field have exactly one value, given by the quaternion (x, y, z, w).
void	setValue(float q0, float q1, float q2, float q3) Makes this field have exactly one value, given by the quaternion (x, y, z, w).
void	setValue(SbRotation newValue) Sets the first value in the array to newValue, and deletes.
void	setValue(SbRotationd rd) Sets the first value in the array to newValue , a double precision rotation, and deletes the second and subsequent values.
void	setValue(SbVec3f axis, float angle) Makes this field have exactly one value, given by axis and angle .
void	setValues(int start, float[] q) Sets values from the specified array of floats.
void	setValues(int start, int num, float[] q) Deprecated. As of Open Inventor 9.3.1, use setValues(int, float[]) instead.
void	setValues(int start, int num, SbRotationd[] rd) Deprecated. As of Open Inventor 9.3.1, use setValues(int, com.openinventor.inventor.SbRotationd[]) instead.
void	setValues(int start, SbRotation[] newValues) Sets num values starting at index start to the values.
void	setValues(int start, SbRotationd[] rd) Sets values starting at index start to the values in the specified array of double precision rotations.
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

SoMFRotation

@Deprecated
public SoMFRotation()

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

SoMFRotation

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

Default constructor.

Method Detail

setValues

public void setValues(int start,
                      int num,
                      float[] q)

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

Sets values from an array of arrays of 4 floats.

setValues

public void setValues(int start,
                      int num,
                      SbRotationd[] rd)

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

Sets num values starting at index start to the values in newValues , an array of double precision rotations. 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(SbRotation targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public SbRotation get1Value(int i)

Deprecated.

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.

getValueAt

public SbRotation getValueAt(int i)

setValues

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

find

public int find(SbRotation 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 SbRotation[] 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,
                      float q0,
                      float q1,
                      float q2,
                      float q3)

Sets the index 'th value to the given quaternion (x, y, z, w).

set1Value

public void set1Value(int index,
                      float[] q)

Sets the index 'th value to the given quaternion (x, y, z, w).

set1Value

public void set1Value(int index,
                      SbVec3f axis,
                      float angle)

Sets the index 'th value to the given axis/angle.

finishEditing

public void finishEditing()

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

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.

set1Value

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

set1Value

public void set1Value(int index,
                      SbRotationd rd)

Sets the index 'th value in the array to newValue , a double precision rotation. 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.

setValue

public void setValue(float[] q)

Makes this field have exactly one value, given by the quaternion (x, y, z, w).

setValue

public void setValue(SbRotationd rd)

Sets the first value in the array to newValue , a double precision rotation, 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.

setValue

public void setValue(SbVec3f axis,
                     float angle)

Makes this field have exactly one value, given by axis and angle .

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValues

public void setValues(int start,
                      float[] q)

Sets values from the specified array of floats. The size of the array must be a multiple of 4.

setValue

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

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

setValues

public void setValues(int start,
                      SbRotationd[] rd)

Sets values starting at index start to the values in the specified array of double precision rotations. 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.

setValue

public void setValue(float q0,
                     float q1,
                     float q2,
                     float q3)

Makes this field have exactly one value, given by the quaternion (x, y, z, w).