Package vrml.eai.field

Class EventOutMFFloat

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFFloat

Direct Known Subclasses:

EventOutMFFloatWrapper

public abstract class EventOutMFFloat
extends EventOutMField

VRML eventOut class for MFFloat.

Version:

1.0 30 April 1998

Field Summary

Fields inherited from class vrml.eai.field.BaseField

fieldType, MFColor, MFFloat, MFInt32, MFNode, MFRotation, MFString, MFTime, MFVec2f, MFVec3f, SFBool, SFColor, SFFloat, SFImage, SFInt32, SFNode, SFRotation, SFString, SFTime, SFVec2f, SFVec3f, UNSET_FIELD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventOutMFFloat()	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract float	get1Value(int index)	Get the value of an individual item in the eventOut's value.
abstract float[]	getValue()	Get the value of the eventOut array of float values.
abstract void	getValue(float[] values)	Write the value of the array of the floats to the given array.

Methods inherited from class vrml.eai.field.EventOutMField

size

Methods inherited from class vrml.eai.field.EventOut

addVrmlEventListener, getUserData, removeVrmlEventListener, setUserData

Methods inherited from class vrml.eai.field.BaseField

getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EventOutMFFloat

protected EventOutMFFloat()

Construct an instance of this class. Calls the superclass constructor with the type MFFloat

Method Details

getValue

public abstract float[] getValue()

Get the value of the eventOut array of float values.

Returns:

The array of values currently set.

getValue

public abstract void getValue(float[] values)

Write the value of the array of the floats to the given array.

Parameters:

values - The array to be filled in

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

get1Value

public abstract float get1Value(int index)
                         throws ArrayIndexOutOfBoundsException

Get the value of an individual item in the eventOut's value. If the index is out of the bounds of the current array of data values an ArrayIndexOutOfBoundsException will be generated.

Parameters:

index - The position to be retrieved

Returns:

The value to at that position

Throws:

ArrayIndexOutOfBoundsException - The index was outside the current data array bounds.