Package org.web3d.x3d.sai

Class X3DFieldEvent

java.lang.Object
java.util.EventObject
org.web3d.x3d.sai.X3DFieldEvent
All Implemented Interfaces:
java.io.Serializable
public class X3DFieldEvent
extends java.util.EventObject
The event type is implemented as the class X3DFieldEvent. This class contains methods for obtaining the source of the event, the time (in X3D time) and any user defined data that occurred with the event.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: B.4.2 X3DFieldEvent, SAI Abstract Specification: 5.4.2 SAIFieldEvent, X3D Tooltips, X3D Scene Authoring Hints, Serialized Form

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.lang.Object eventDataObject
    Passed field data for this event
    protected double timeStamp
    The time stamp, in X3D time, that this event occurred at

    Fields inherited from class java.util.EventObject

    source

  • Constructor Summary

    Constructors 
    Constructor Description
    X3DFieldEvent​(java.lang.Object sourceField, double newTimeStamp, java.lang.Object neweventDataObject)
    Construct a new X3DFieldEvent instance.

  • Method Summary

    Modifier and Type Method Description
    java.lang.Object getData()
    Get data with this event.
    double getTime()
    Get the timestamp that this event occurred at.

    Methods inherited from class java.util.EventObject

    getSource, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

    • timeStamp

      protected double timeStamp
      The time stamp, in X3D time, that this event occurred at

    • eventDataObject

      protected java.lang.Object eventDataObject
      Passed field data for this event

  • Constructor Details

    • X3DFieldEvent

      public X3DFieldEvent​(java.lang.Object sourceField, double newTimeStamp, java.lang.Object neweventDataObject)
      Construct a new X3DFieldEvent instance.
      Parameters:
      sourceField - The source field that generated this event
      newTimeStamp - The timestamp of the event, in X3D time
      neweventDataObject - Any user associated data with this event

  • Method Details

    • getTime

      public double getTime()
      Get the timestamp that this event occurred at.
      Returns:
      The time of this event, in X3D time coordinates.

    • getData

      public java.lang.Object getData()
      Get data with this event.
      Returns:
      eventDataObject