Interface TextureBackground
- All Superinterfaces:
X3DBackgroundNode
,X3DBindableNode
,X3DChildNode
,X3DNode
- All Known Implementing Classes:
TextureBackground
TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
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
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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.
TextureBackground node tooltip: [X3DBackgroundNode] TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images 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. Avoid this authoring pattern.
- Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
- Hint: authors can have LoadSensor nodes receive notifications and send reporting events when background texture node(s) are loaded.
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 TypeMethodDescriptionProvide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.double
Provide double value in seconds from outputOnly SFTime field named bindTime.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.float[]
Provide array of float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.float[]
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.boolean
Provide boolean value from outputOnly SFBool field named isBound.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.float[]
Provide array of float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.float[]
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.setBackTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.setBottomTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.setFrontTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.setGroundAngle
(float[] newValue) Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.setGroundColor
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.setLeftTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setRightTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.setSkyAngle
(float[] newValue) Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.setSkyColor
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.setTopTexture
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.setTransparency
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named transparency.
-
Method Details
-
getBackTexture
X3DNode getBackTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of backTexture field
-
setBackTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the backTexture field.- Returns:
TextureBackground
- 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 interfaceX3DBackgroundNode
- Specified by:
getBindTime
in interfaceX3DBindableNode
- Returns:
- value of bindTime field
-
getBottomTexture
X3DNode getBottomTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of bottomTexture field
-
setBottomTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the bottomTexture field.- Returns:
TextureBackground
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFrontTexture
X3DNode getFrontTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of frontTexture field
-
setFrontTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the frontTexture field.- Returns:
TextureBackground
- 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: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Specified by:
getGroundAngle
in interfaceX3DBackgroundNode
- Returns:
- value of groundAngle field
-
setGroundAngle
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: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Specified by:
setGroundAngle
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the groundAngle field.- Returns:
TextureBackground
- 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).- Hint: setting the same color at two consecutive angles produces a solid color band.
- Warning: you must have one more groundColor value than groundAngle values. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getGroundColor
in interfaceX3DBackgroundNode
- Returns:
- value of groundColor field
-
setGroundColor
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).- Hint: setting the same color at two consecutive angles produces a solid color band.
- Warning: you must have one more groundColor value than groundAngle values. Interchange profile
- Hint: this field may be ignored, applying the default value regardless.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setGroundColor
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the groundColor field.- Returns:
TextureBackground
- 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 interfaceX3DBackgroundNode
- Specified by:
getIsBound
in interfaceX3DBindableNode
- Returns:
- value of isBound field
-
getLeftTexture
X3DNode getLeftTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of leftTexture field
-
setLeftTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the leftTexture field.- Returns:
TextureBackground
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DBackgroundNode
- Specified by:
getMetadata
in interfaceX3DBindableNode
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DBackgroundNode
- Specified by:
setMetadata
in interfaceX3DBindableNode
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TextureBackground
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getRightTexture
X3DNode getRightTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of rightTexture field
-
setRightTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the rightTexture field.- Returns:
TextureBackground
- 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: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Specified by:
getSkyAngle
in interfaceX3DBackgroundNode
- Returns:
- value of skyAngle field
-
setSkyAngle
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: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Specified by:
setSkyAngle
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the skyAngle field.- Returns:
TextureBackground
- 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).- Hint: setting the same color at two consecutive angles produces a solid color band.
- Warning: you must have one more skyColor value than skyAngle values. Interchange profile
- Hint: only one color might be rendered, others can be ignored.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getSkyColor
in interfaceX3DBackgroundNode
- Returns:
- value of skyColor field
-
setSkyColor
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).- Hint: setting the same color at two consecutive angles produces a solid color band.
- Warning: you must have one more skyColor value than skyAngle values. Interchange profile
- Hint: only one color might be rendered, others can be ignored.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setSkyColor
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the skyColor field.- Returns:
TextureBackground
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTopTexture
X3DNode getTopTexture()Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Returns:
- value of topTexture field
-
setTopTexture
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.
Tooltip: [X3DTexture2DNode|MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture).- Warning: each child image node must have a different containerField value.
- Parameters:
newValue
- is new value for the topTexture field.- Returns:
TextureBackground
- 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: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *- Specified by:
getTransparency
in interfaceX3DBackgroundNode
- Returns:
- value of transparency field
-
setTransparency
Accessor method to assign float value to inputOutput SFFloat field named transparency.
Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *- Specified by:
setTransparency
in interfaceX3DBackgroundNode
- Parameters:
newValue
- is new value for the transparency field.- Returns:
TextureBackground
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-