TextureBackground
Overview
TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
The TextureBackground node belongs to the EnvironmentalEffects component and requires at least level 3, its default container field is children. It is available from X3D version 3.0 or higher.
Hierarchy
1
2
3
4
5
+ X3DNode
+ X3DChildNode
+ X3DBindableNode
+ X3DBackgroundNode
+ TextureBackground
Fields
SFNode [in, out] metadata NULL [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint
SFBool [in] set_bind
Input event set_bind=true makes this node active, input event set_bind=false makes this node inactive. Thus setting set_bind true/false will pop/push (enable/disable) this 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 inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
MFFloat [in, out] skyAngle [ ] [0,π]
The angle array values increase from 0.0 zenith (straight up) to π/2=1.570796 (horizon) to π=3.14159 (nadir).
Hint
Warnings
- You must have one more skyColor value than skyAngle values.
- Colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
MFColor [in, out] skyColor 0 0 0 [0,1]
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).
Hints
- Setting the same color at two consecutive angles produces a solid color band.
- X3D Scene Authoring Hints, Color
Warning
- You must have one more skyColor value than skyAngle values. Interchange profile hint: only one color might be rendered, others can be ignored.
MFFloat [in, out] groundAngle [ ] [0,π/2]
The angle array values increase from 0.0 nadir (straight down) to π/2=1.570796 (horizon).
Hint
Warnings
- You must have one more groundColor value than groundAngle values.
- Colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
MFColor [in, out] groundColor [ ] [0,1]
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).
Hints
- Setting the same color at two consecutive angles produces a solid color band.
- X3D Scene Authoring Hints, Color
Warning
- You must have one more groundColor value than groundAngle values. Interchange profile hint: this field may be ignored, applying the default value regardless.
SFFloat [in, out] transparency 0 [0,1]
transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop.
SFBool [out] isBound
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.
SFTime [out] bindTime
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.
SFNode [in, out] frontTexture NULL [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.
SFNode [in, out] backTexture NULL [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.
SFNode [in, out] leftTexture NULL [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.
SFNode [in, out] rightTexture NULL [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.
SFNode [in, out] topTexture NULL [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.
SFNode [in, out] bottomTexture NULL [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.
Advice
Hints
- 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.
- Authors can have LoadSensor nodes receive notifications and send reporting events when background texture node(s) are loaded.
Warnings
- 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.
- Each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.