Interface X3DUrlObject

All Known Subinterfaces:
Anchor, AudioClip, BufferAudioSource, DISEntityTypeMapping, GeoMetadata, ImageCubeMapTexture, ImageTexture, ImageTexture3D, Inline, MovieTexture, PackagedShader, Script, ShaderPart, ShaderProgram, X3DScriptNode
All Known Implementing Classes:
Anchor, AudioClip, BufferAudioSource, DISEntityTypeMapping, GeoMetadata, ImageCubeMapTexture, ImageTexture, ImageTexture3D, Inline, MovieTexture, PackagedShader, Script, ShaderPart, ShaderProgram
public interface X3DUrlObject
X3DUrlObject indicates that a node has content loaded from a Uniform Resource Locator (URL) and can be tracked via a LoadSensor. Such child nodes have containerField='children' to indicate their relationship to the parent LoadSensor node.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAutoRefresh()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
    double
    getAutoRefreshTimeLimit()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean
    getLoad()
    Provide boolean value from inputOutput SFBool field named load.
    String[]
    getUrl()
    Provide array of String results from inputOutput MFString field named url.
    X3DUrlObject
    setAutoRefresh(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
    X3DUrlObject
    setAutoRefreshTimeLimit(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
    X3DUrlObject
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    X3DUrlObject
    setLoad(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named load.
    X3DUrlObject
    setUrl(String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • getAutoRefresh

      double getAutoRefresh()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
      Returns:
      value of autoRefresh field

    • setAutoRefresh

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

    • getAutoRefreshTimeLimit

      double getAutoRefreshTimeLimit()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
      Returns:
      value of autoRefreshTimeLimit field

    • setAutoRefreshTimeLimit

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

    • getDescription

      String getDescription()
      Provide String value from inputOutput SFString field named description.
      Returns:
      value of description field

    • setDescription

      X3DUrlObject setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DUrlObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLoad

      boolean getLoad()
      Provide boolean value from inputOutput SFBool field named load.
      Returns:
      value of load field

    • setLoad

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

    • getUrl

      String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.
      Returns:
      value of url field

    • setUrl

      X3DUrlObject setUrl(String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.
      Parameters:
      newValue - is new value for the url field.
      Returns:
      X3DUrlObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).