H3D::Background Class Reference
[X3D node classes.]

A background node that uses six static images to compose the backdrop. More...

#include <Background.h>

Inheritance diagram for H3D::Background:

List of all members.

Public Member Functions
	Background (Inst< SFSetBind > _set_bind=0, Inst< SFNode > _metadata=0, Inst< SFTime > _bindTime=0, Inst< SFBool > _isBound=0, Inst< DisplayList > _displayList=0, Inst< MFFloat > _groundAngle=0, Inst< MFColor > _groundColor=0, Inst< MFFloat > _skyAngle=0, Inst< MFColor > _skyColor=0, Inst< MFString > _backUrl=0, Inst< MFString > _frontUrl=0, Inst< MFString > _leftUrl=0, Inst< MFString > _rightUrl=0, Inst< MFString > _topUrl=0, Inst< MFString > _bottomUrl=0)
	Constructor.
virtual void	render ()
	Renders the background with OpenGL.
Public Attributes
auto_ptr< MFString >	backUrl
	The url of the texture to use on the back face of the cube.
auto_ptr< MFString >	frontUrl
	The url of the texture to use on the front face of the cube.
auto_ptr< MFString >	leftUrl
	The url of the texture to use on the left face of the cube.
auto_ptr< MFString >	rightUrl
	The url of the texture to use on the right face of the cube.
auto_ptr< MFString >	topUrl
	The url of the texture to use on the top face of the cube.
auto_ptr< MFString >	bottomUrl
	The url of the texture to use on the bottom face of the cube.
Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.
Protected Attributes
AutoRef< ImageTexture >	backTexture
	The texture displayed at the back.
AutoRef< ImageTexture >	frontTexture
	The texture displayed at the front.
AutoRef< ImageTexture >	leftTexture
	The texture displayed to the left.
AutoRef< ImageTexture >	rightTexture
	The texture displayed to the right.
AutoRef< ImageTexture >	topTexture
	The texture displayed at the top.
AutoRef< ImageTexture >	bottomTexture
	The texture displayed at the bottom.

---

Detailed Description

A background node that uses six static images to compose the backdrop.

The backUrl, bottomUrl, frontUrl, leftUrl, rightUrl, and topUrl fields specify the url to a set of images that define a background panorama between the ground/sky backdrop and the scene's geometry. The panorama consists of six images, each of which is mapped onto a face of an infinitely large cube contained within the backdrop spheres and centred in the local coordinate system. The images are applied individually to each face of the cube. On the front, back, right, and left faces of the cube, when viewed from the origin looking down the negative Z-axis with the Y-axis as the view up direction, each image is mapped onto the corresponding face with the same orientation as if the image were displayed normally in 2D (back to back face, front to front face, left to left face, and right to right face). On the top face of the cube, when viewed from the origin looking along the +Y-axis with the +Z-axis as the view up direction, the top image is mapped onto the face with the same orientation as if the image were displayed normally in 2D. On the bottom face of the box, when viewed from the origin along the negative Y-axis with the negative Z-axis as the view up direction, the bottom image is mapped onto the face with the same orientation as if the image were displayed normally in 2D.

Alpha values in the panorama images (i.e., two or four component images) specify that the panorama is semi-transparent or transparent in regions, allowing the groundColor and skyColor to be visible.

Often, the bottom and top images will not be specified, to allow sky and ground to show. The other four images may depict surrounding mountains or other distant scenery.

The other fields work just as in X3DBackgroundNode.

Internal routes:

---

Member Data Documentation

auto_ptr< MFString > H3D::Background::backUrl

The url of the texture to use on the back face of the cube. Access type: inputOutput

auto_ptr< MFString > H3D::Background::bottomUrl

The url of the texture to use on the bottom face of the cube. Access type: inputOutput

auto_ptr< MFString > H3D::Background::frontUrl

The url of the texture to use on the front face of the cube. Access type: inputOutput

auto_ptr< MFString > H3D::Background::leftUrl

The url of the texture to use on the left face of the cube. Access type: inputOutput

auto_ptr< MFString > H3D::Background::rightUrl

The url of the texture to use on the right face of the cube. Access type: inputOutput

auto_ptr< MFString > H3D::Background::topUrl

The url of the texture to use on the top face of the cube. Access type: inputOutput

---