Package vrml.eai.field

Class EventOutMFTime

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutMField

vrml.eai.field.EventOutMFTime

Direct Known Subclasses:

EventOutMFTimeWrapper

public abstract class EventOutMFTime
extends EventOutMField

VRML eventIn class for MFTime.

Time values are represented as per the VRML IS specification Section 4.11 Time. That is, time is set as VRML "Time" - the number of seconds since Jan 1, 1970 GMT, rather than a Java time which is a long, the number of milliseconds since Jan 1, 1970 GMT. To convert between the two simply divide java time by 1000 and cast to a double.

Note that in setting time values from an external application, the idea of the time that java represents and the time that the VRML world currently has set may well be different. It is best to source the current "time" from a node or eventOut in the VRML world rather than relying exclusively on the value returned from System.currentTimeMillies. This is especially important to note if you are dealing with high speed, narrow interval work such as controlling animation.

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

Method Summary

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

EventOutMFTime

protected EventOutMFTime()

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

Method Details

getValue

public abstract double[] getValue()

Get the value of the array of times.

Returns:

The array of time values

getValue

public abstract void getValue(double[] vec)

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

Parameters:

vec - The array to be filled in where

Throws:

ArrayIndexOutOfBoundsException - The provided array was too small

get1Value

public abstract double get1Value(int index)

Get a particular time 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 time value

Returns:

The time value.

Throws:

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