Interface Background

All Superinterfaces:
X3DBackgroundNode, X3DBindableNode, X3DChildNode, X3DNode
All Known Implementing Classes:
BackgroundObject

public interface Background
extends X3DBackgroundNode
Background simulates ground and sky, using vertical arrays of wraparound color values.

X3D node tooltip: [X3DBackgroundNode] Background simulates ground and sky, using vertical arrays of wraparound color values. Background can also provide url addresses for backdrop textures on all six sides.
  • Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
  • Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch.
  • Hint: X3D Example Archives, Basic, Universal Media Panoramas https://www.web3d.org/x3d/content/examples/Basic/UniversalMediaPanoramas

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: Background, X3D Tooltips: Background, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    java.lang.String[] getBackUrl()
    Provide array of String results from inputOutput MFString field named backUrl.
    double getBindTime()
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    java.lang.String[] getBottomUrl()
    Provide array of String results from inputOutput MFString field named bottomUrl.
    java.lang.String[] getFrontUrl()
    Provide array of String results from inputOutput MFString field named frontUrl.
    float[] getGroundAngle()
    Provide array of float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.
    float[] getGroundColor()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.
    boolean getIsBound()
    Provide boolean value from outputOnly SFBool field named isBound.
    java.lang.String[] getLeftUrl()
    Provide array of String results from inputOutput MFString field named leftUrl.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String[] getRightUrl()
    Provide array of String results from inputOutput MFString field named rightUrl.
    float[] getSkyAngle()
    Provide array of float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.
    float[] getSkyColor()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.
    java.lang.String[] getTopUrl()
    Provide array of String results from inputOutput MFString field named topUrl.
    float getTransparency()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
    Background setBackUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named backUrl.
    Background setBottomUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named bottomUrl.
    Background setFrontUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named frontUrl.
    Background setGroundAngle​(float[] newValue)
    Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.
    Background setGroundColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.
    Background setLeftUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named leftUrl.
    Background setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Background setRightUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named rightUrl.
    Background setSkyAngle​(float[] newValue)
    Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.
    Background setSkyColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.
    Background setTopUrl​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named topUrl.
    Background setTransparency​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named transparency.
  • Method Details

    • getBackUrl

      java.lang.String[] getBackUrl()
      Provide array of String results from inputOutput MFString field named backUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of backUrl field
    • setBackUrl

      Background setBackUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named backUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the backUrl field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBindTime

      double getBindTime()
      Provide double value in seconds from outputOnly SFTime field named bindTime.

      Tooltip: event sent when node becomes active/inactive.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getBindTime in interface X3DBackgroundNode
      Specified by:
      getBindTime in interface X3DBindableNode
      Returns:
      value of bindTime field
    • getBottomUrl

      java.lang.String[] getBottomUrl()
      Provide array of String results from inputOutput MFString field named bottomUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of bottomUrl field
    • setBottomUrl

      Background setBottomUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named bottomUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the bottomUrl field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFrontUrl

      java.lang.String[] getFrontUrl()
      Provide array of String results from inputOutput MFString field named frontUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of frontUrl field
    • setFrontUrl

      Background setFrontUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named frontUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the frontUrl field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGroundAngle

      float[] getGroundAngle()
      Provide array of float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.

      Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).
      • Warning: you must have one more groundColor value than groundAngle values.
      • Warning: colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Specified by:
      getGroundAngle in interface X3DBackgroundNode
      Returns:
      value of groundAngle field
    • setGroundAngle

      Background setGroundAngle​(float[] newValue)
      Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.

      Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).
      • Warning: you must have one more groundColor value than groundAngle values.
      • Warning: colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Specified by:
      setGroundAngle in interface X3DBackgroundNode
      Parameters:
      newValue - is new value for the groundAngle field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGroundColor

      float[] getGroundColor()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.

      Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).
      Specified by:
      getGroundColor in interface X3DBackgroundNode
      Returns:
      value of groundColor field
    • setGroundColor

      Background setGroundColor​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.

      Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).
      Specified by:
      setGroundColor in interface X3DBackgroundNode
      Parameters:
      newValue - is new value for the groundColor field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIsBound

      boolean getIsBound()
      Provide boolean value from outputOnly SFBool field named isBound.

      Tooltip: event true sent when node becomes active, event false sent when unbound by another node.
      • Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsBound in interface X3DBackgroundNode
      Specified by:
      getIsBound in interface X3DBindableNode
      Returns:
      value of isBound field
    • getLeftUrl

      java.lang.String[] getLeftUrl()
      Provide array of String results from inputOutput MFString field named leftUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of leftUrl field
    • setLeftUrl

      Background setLeftUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named leftUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the leftUrl field.
      Returns:
      Background - 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 X3DBackgroundNode
      Specified by:
      getMetadata in interface X3DBindableNode
      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

      Background setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DBackgroundNode
      Specified by:
      setMetadata in interface X3DBindableNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Background - 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
    • getRightUrl

      java.lang.String[] getRightUrl()
      Provide array of String results from inputOutput MFString field named rightUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of rightUrl field
    • setRightUrl

      Background setRightUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named rightUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the rightUrl field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSkyAngle

      float[] getSkyAngle()
      Provide array of float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.

      Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).
      • Warning: you must have one more skyColor value than skyAngle values.
      • Warning: colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Specified by:
      getSkyAngle in interface X3DBackgroundNode
      Returns:
      value of skyAngle field
    • setSkyAngle

      Background setSkyAngle​(float[] newValue)
      Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.

      Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).
      • Warning: you must have one more skyColor value than skyAngle values.
      • Warning: colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
      • Hint: https://en.wikipedia.org/wiki/Radian
      Specified by:
      setSkyAngle in interface X3DBackgroundNode
      Parameters:
      newValue - is new value for the skyAngle field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSkyColor

      float[] getSkyColor()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.

      Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).
      Specified by:
      getSkyColor in interface X3DBackgroundNode
      Returns:
      value of skyColor field
    • setSkyColor

      Background setSkyColor​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.

      Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).
      Specified by:
      setSkyColor in interface X3DBackgroundNode
      Parameters:
      newValue - is new value for the skyColor field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTopUrl

      java.lang.String[] getTopUrl()
      Provide array of String results from inputOutput MFString field named topUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Returns:
      value of topUrl field
    • setTopUrl

      Background setTopUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named topUrl.

      Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
      Parameters:
      newValue - is new value for the topUrl field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransparency

      float getTransparency()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.

      Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *
      Specified by:
      getTransparency in interface X3DBackgroundNode
      Returns:
      value of transparency field
    • setTransparency

      Background setTransparency​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named transparency.

      Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency < .5 opaque, transparency > .5 transparent. *
      Specified by:
      setTransparency in interface X3DBackgroundNode
      Parameters:
      newValue - is new value for the transparency field.
      Returns:
      Background - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).