Package org.web3d.x3d.sai
Interface MFInt32
- All Known Implementing Classes:
MFInt32
public interface MFInt32 extends MField
MFInt32 defines an array of 32-bit signed integers. Array values are optionally separated by commas in XML syntax.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description void
append(int newValue)
Places a new value at the end of the existing value array, increasing the field length accordingly.int
get1Value(int index)
Get an individual value from the existing field array.void
getValue(int[] valueDestination)
Write out the current value of this field into the external valueDestination array.void
insertValue(int index, int newValue)
Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.void
set1Value(int imageIndex, int newValue)
Replace a single value at the appropriate location in the existing value array.void
setValue(int size, int[] newValue)
Assign an array subset to this field.Methods inherited from interface org.web3d.x3d.sai.X3DField
addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener
-
Method Details
-
getValue
void getValue(int[] 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:
java.lang.ArrayIndexOutOfBoundsException
- The provided valueDestination array was too small.
-
get1Value
int get1Value(int index) throws java.lang.ArrayIndexOutOfBoundsExceptionGet 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 array- Returns:
- The selected value
- Throws:
java.lang.ArrayIndexOutOfBoundsException
- The index was outside of the bounds of the current array.
-
setValue
void setValue(int size, int[] newValue)Assign an array subset to this field.- 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 imageIndex, int newValue) throws java.lang.ArrayIndexOutOfBoundsExceptionReplace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.- Parameters:
imageIndex
- the index of the selected imagenewValue
- provides new value to apply- Throws:
java.lang.ArrayIndexOutOfBoundsException
-
append
void append(int newValue)Places a new value at the end of the existing value array, increasing the field length accordingly.- Parameters:
newValue
- The newValue to append
-
insertValue
void insertValue(int index, int newValue)Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.- Parameters:
index
- The position for the inserted value in the current arraynewValue
- The newValue to insert
-