Package vrml.eai.field

Class EventOutSFTime

java.lang.Object

vrml.eai.field.BaseField

vrml.eai.field.EventOut

vrml.eai.field.EventOutSFTime

Direct Known Subclasses:

EventOutSFTimeWrapper

public abstract class EventOutSFTime
extends EventOut

VRML eventOut class for SFTime.

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

Method Summary

Modifier and Type	Method	Description
abstract double	getValue()	Get the time value in the given eventOut.

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

EventOutSFTime

protected EventOutSFTime()

Construct an instance of this class. Calls the superclass constructor with the field type set to SFTime.

Method Details

getValue

public abstract double getValue()

Get the time value in the given eventOut. Time can be any value either positive or negative but always absolute in value. As per the VRML time specification, all time values are absolute.

Returns:

The current time of this eventOut.