Xj3D VRML/X3D Code API

org.web3d.util
Class FloatArray

java.lang.Object
  extended byorg.web3d.util.FloatArray

public class FloatArray
extends java.lang.Object

Simple dynamic array structure that holds float primitives.

Version:
$Revision: 1.4 $
Author:
Justin Couch

Constructor Summary
FloatArray()
          Create a new default array with size 512 items
FloatArray(int initialSize)
          Create an array with the given initial size
 
Method Summary
 void add(float newFloat)
          Add a new value to the array.
 void add(float[] values)
          Add an array of values in bulk to the array.
 void clear()
          Clear the array so that it contains no values
 float get(int index)
          Get the value at the given index.
 float remove(int index)
          Remove the value at the given index.
 void set(int index, float value)
          Set the value at the given index.
 int size()
          Get the count of the number of items in the array.
 float[] toArray()
          Turn the values of this array into a real array.
 float[] toArray(float[] values)
          Turn the values of this array into a real array by copying them floato the given array if possible.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FloatArray

public FloatArray()
Create a new default array with size 512 items


FloatArray

public FloatArray(int initialSize)
Create an array with the given initial size

Parameters:
initialSize - The size to start with
Method Detail

size

public int size()
Get the count of the number of items in the array.

Returns:
The number of items in the array

clear

public void clear()
Clear the array so that it contains no values


add

public void add(float newFloat)
Add a new value to the array. Will resize the array if needed to accommodate new values.

Parameters:
newFloat - the value to be added

add

public void add(float[] values)
Add an array of values in bulk to the array. The array should not be null.

Parameters:
values - The values to be added

get

public float get(int index)
Get the value at the given index.

Parameters:
index - The position to get values from
Returns:
The value at that index
Throws:
java.lang.IndexOutOfBoundsException - The index was not legal

set

public void set(int index,
                float value)
Set the value at the given index. If the index is out of the range of the current items, it will generate an index exception.

Parameters:
index - The position to get values from
value - The new value to set
Throws:
java.lang.IndexOutOfBoundsException - The index was not legal

remove

public float remove(int index)
Remove the value at the given index.

Parameters:
index - The position to remove the value from
Returns:
The value at that index
Throws:
java.lang.IndexOutOfBoundsException - The index was not legal

toArray

public float[] toArray()
Turn the values of this array into a real array. Returns an array with the exact number of items in it. This is a separate copy of the floaternal array.

Returns:
The array of values

toArray

public float[] toArray(float[] values)
Turn the values of this array into a real array by copying them floato the given array if possible. If the array is big enough then it will copy the values straight in. If not, it will ignore that array and create it's own copy and return that. If the passed array is used, the return value will be a reference to the passed array, otherwise it will be the new copy.

Parameters:
values - The array to copy values to
Returns:
The array of values

Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium