Package org.web3d.x3d.sai.Networking

Interface X3DUrlObject

All Known Subinterfaces:
Anchor, AudioClip, DISEntityTypeMapping, GeoMetadata, ImageCubeMapTexture, ImageTexture, ImageTexture3D, Inline, MovieTexture, PackagedShader, Script, ShaderPart, ShaderProgram, X3DScriptNode
All Known Implementing Classes:
Anchor, AudioClip, 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='watchList' to indicate their relationship to the parent LoadSensor node.


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

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean getLoad()
    Provide boolean value from inputOutput SFBool field named load.
    double getRefresh()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named refresh.
    java.lang.String[] getUrl()
    Provide array of String results from inputOutput MFString field named url.
    X3DUrlObject setDescription​(java.lang.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 setRefresh​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named refresh.
    X3DUrlObject setUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named url.

  • Method Details

    • getDescription

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

    • setDescription

      X3DUrlObject setDescription​(java.lang.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).

    • getRefresh

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

    • setRefresh

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

    • getUrl

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

    • setUrl

      X3DUrlObject setUrl​(java.lang.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).