Package vrml.eai.field

Class EventOutMFNode

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFNode

Direct Known Subclasses:

EventOutMFNodeWrapper

public abstract class EventOutMFNode
extends EventOutMField

VRML eventIn class for MFNode.

Get the values of a node array. The java null reference is treated to be equivalent to the VRML NULL field values.

It is not illegal to construct an array where some members of the array are null pointers. Due to no specification on the intended result in the VRML specification, the response given by the browser is implementation dependent. Calls will not generate an exception, but the value of actual event received from the scene graph may vary until the issue is resolved.

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

Method Summary

Modifier and Type	Method	Description
abstract Node	get1Value(int index)	Get a particular node value in the given eventOut array.
abstract Node[]	getValue()	Get the value of the array of nodes.
abstract void	getValue(Node[] nodes)	Write the value of the array of the nodes 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

EventOutMFNode

protected EventOutMFNode()

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

Method Details

getValue

public abstract Node[] getValue()

Get the value of the array of nodes.

Returns:

The array of node references

getValue

public abstract void getValue(Node[] nodes)

Write the value of the array of the nodes to the given array. Individual elements in the array may be null depending on the implementation of the browser and whether it maintains null references.

Parameters:

nodes - The node array to be filled in

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

get1Value

public abstract Node get1Value(int index)

Get a particular node 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. If the Node value is NULL because the browser implementation keeps null references then this method will return a null pointer without throwing any exception.

Parameters:

index - The position to read the values from

Returns:

The node reference

Throws:

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