Package vrml.eai.field

Class EventOutMFVec2f

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFVec2f

Direct Known Subclasses:

EventOutMFVec2fWrapper

public abstract class EventOutMFVec2f
extends EventOutMField

VRML eventIn class for MFVec2f.

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	EventOutMFVec2f()	Construct an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract float[]	get1Value(int index)	Get a particular vector value in the given eventOut array.
abstract void	get1Value(int index, float[] vec)	Get the value of a particular vector value in the event out array.
abstract float[][]	getValue()	Get the value of the array of 2D vectors.
abstract void	getValue(float[] vec)	Get the values of the event out flattened into a single 1D array.
abstract void	getValue(float[][] vec)	Write the value of the event out 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

EventOutMFVec2f

protected EventOutMFVec2f()

Construct an instance of this class. The superclass is called with the type MFVec2f

Method Details

getValue

public abstract float[][] getValue()

Get the value of the array of 2D vectors. Output is an array of floats

Returns:

The array of vec2f values where
value[i][0] = X
value[i][1] = Y

getValue

public abstract void getValue(float[][] vec)

Write the value of the event out to the given array.

Parameters:

vec - The array to be filled in where
vec[i][0] = X
vec[i][1] = Y

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

getValue

public abstract void getValue(float[] vec)

Get the values of the event out flattened into a single 1D array. The array must be at least 3 times the size of the array.

Parameters:

vec - The array to be filled in where the vec[i + 0] = X
vec[i + 1] = Y

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

get1Value

public abstract float[] get1Value(int index)

Get a particular vector value in the given eventOut array.

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 get the vector value from

Returns:

The array of vector values where
value[0] = X
value[1] = Y

Throws:

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

get1Value

public abstract void get1Value(int index,
 float[] vec)

Get the value of a particular vector value in the event out array.

Parameters:

index - The position to get the vector value from.

vec - The array to place the value in where. vec[0] = X
vec[1] = Y

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small or the index was outside the current data array bounds.