Package org.web3d.x3d.sai.Time

Interface X3DTimeDependentNode

All Superinterfaces:
X3DChildNode, X3DNode
All Known Subinterfaces:
AudioClip, MovieTexture, TimeSensor, X3DSoundSourceNode
All Known Implementing Classes:
AudioClipObject, MovieTextureObject, TimeSensorObject
public interface X3DTimeDependentNode
extends X3DChildNode
Base type from which all time-dependent nodes are derived.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    double getElapsedTime()
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    boolean getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    boolean getIsPaused()
    Provide boolean value from outputOnly SFBool field named isPaused.
    boolean getLoop()
    Provide boolean value from inputOutput SFBool field named loop.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    double getPauseTime()
    Provide double value in seconds from inputOutput SFTime field named pauseTime.
    double getResumeTime()
    Provide double value in seconds from inputOutput SFTime field named resumeTime.
    double getStartTime()
    Provide double value in seconds from inputOutput SFTime field named startTime.
    double getStopTime()
    Provide double value in seconds from inputOutput SFTime field named stopTime.
    X3DTimeDependentNode setLoop​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named loop.
    X3DTimeDependentNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DTimeDependentNode setPauseTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
    X3DTimeDependentNode setResumeTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
    X3DTimeDependentNode setStartTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
    X3DTimeDependentNode setStopTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

  • Method Details

    • getElapsedTime

      double getElapsedTime()
      Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
      Returns:
      value of elapsedTime field

    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.
      Returns:
      value of isActive field

    • getIsPaused

      boolean getIsPaused()
      Provide boolean value from outputOnly SFBool field named isPaused.
      Returns:
      value of isPaused field

    • getLoop

      boolean getLoop()
      Provide boolean value from inputOutput SFBool field named loop.
      Returns:
      value of loop field

    • setLoop

      X3DTimeDependentNode setLoop​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named loop.
      Parameters:
      newValue - is new value for the loop field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      X3DTimeDependentNode setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getPauseTime

      double getPauseTime()
      Provide double value in seconds from inputOutput SFTime field named pauseTime.
      Returns:
      value of pauseTime field

    • setPauseTime

      X3DTimeDependentNode setPauseTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getResumeTime

      double getResumeTime()
      Provide double value in seconds from inputOutput SFTime field named resumeTime.
      Returns:
      value of resumeTime field

    • setResumeTime

      X3DTimeDependentNode setResumeTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStartTime

      double getStartTime()
      Provide double value in seconds from inputOutput SFTime field named startTime.
      Returns:
      value of startTime field

    • setStartTime

      X3DTimeDependentNode setStartTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStopTime

      double getStopTime()
      Provide double value in seconds from inputOutput SFTime field named stopTime.
      Returns:
      value of stopTime field

    • setStopTime

      X3DTimeDependentNode setStopTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      X3DTimeDependentNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).