Interface MFVec3f
- All Known Implementing Classes:
MFVec3f
MFVec3f is an array of SFVec3f values. Individual singleton SFVec3f array values are optionally separated by commas in XML syntax.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(float[] newValue) Places a new value at the end of the existing value array, increasing the field length accordingly.void
get1Value
(int index, float[] valueDestination) Get an individual value from the existing field array.void
getValue
(float[] valueDestination) Write out the current value of this field into the external valueDestination array.void
getValue
(float[][] valueDestination) Write out the current value of this field into the external valueDestination array.void
insertValue
(int index, float[] newValue) Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.void
set1Value
(int index, float[] newValue) Replace a single value at the appropriate location in the existing value array.void
setValue
(int size, float[] newValue) Assign an array subset to this field.void
setValue
(int size, float[][] newValue) Assign an array subset to this field.
-
Method Details
-
getValue
void getValue(float[][] valueDestination) Write out the current value of this field into the external valueDestination array.- Parameters:
valueDestination
- The array to be filled in with current field values.- Throws:
ArrayIndexOutOfBoundsException
- The provided valueDestination array was too small.
-
getValue
void getValue(float[] valueDestination) Write out the current value of this field into the external valueDestination array.- Parameters:
valueDestination
- The array to be filled in with current field values.- Throws:
ArrayIndexOutOfBoundsException
- The provided valueDestination array was too small.
-
get1Value
void get1Value(int index, float[] valueDestination) Get an individual value from the existing field array.
If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.
- Parameters:
index
- is position of selected value in current arrayvalueDestination
- The array to be filled in with the selected current field value.- Throws:
ArrayIndexOutOfBoundsException
- The index was outside of the bounds of the current array.
-
setValue
void setValue(int size, float[] newValue) Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.- Parameters:
size
- indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.newValue
- The replacement value array to (potentially) slice and then assign.
-
setValue
void setValue(int size, float[][] newValue) Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.- Parameters:
size
- indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.newValue
- The replacement value array to (potentially) slice and then assign.
-
set1Value
void set1Value(int index, float[] newValue) Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.- Parameters:
index
- is position of selected value in current arraynewValue
- provides new value to apply
-
append
void append(float[] newValue) Places a new value at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.- Parameters:
newValue
- The newValue to append
-
insertValue
void insertValue(int index, float[] newValue) Insert a new value prior to the index location in the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.- Parameters:
index
- The position for the inserted value in the current arraynewValue
- The newValue to insert
-