com.openinventor.inventor.vrmlnodes

Class SoVRMLBackground

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLBackground

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLBackground
extends SoVRMLNode

Color backdrop node.
<font color="#FF0000">Action not implemented for this node. </font>

The SoVRMLBackground node is used to specify a color backdrop that simulates ground and sky, as well as a background texture, or panorama, that is placed behind all geometry in the scene and in front of the ground and sky. SoVRMLBackground nodes are specified in the local coordinate system and are affected by the accumulated rotation of their parents.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLBackground node is used to specify a color backdrop that simulates ground and sky, as well as a background texture, or panorama, that is placed behind all geometry in the scene and in front of the ground and sky. SoVRMLBackground nodes are specified in the local coordinate system and are affected by the accumulated rotation of their parents (see below).

SoVRMLBackground nodes are bindable nodes (see "Concepts - Bindable Children Nodes"). There exists an SoVRMLBackground stack, in which the top-most SoVRMLBackground on the stack is the currently active SoVRMLBackground and thus applied to the view. To move an SoVRMLBackground to the top of the stack, a true value is sent to the set_bind eventIn. Once active, the SoVRMLBackground is then bound to the browsers view. A false value of set_bind , removes the SoVRMLBackground from the stack and unbinds it from the browser viewer. See "Concepts - Bindable Children Nodes" for more details on the the bind stack.

The ground and sky backdrop is conceptually a partial sphere (i.e., ground) enclosed inside of a full sphere (i.e., sky) in the local coordinate system, with the viewer placed at the center of the spheres. Both spheres have infinite radius (epsilon apart), and each is painted with concentric circles of interpolated color perpendicular to the local Y axis of the sphere. The SoVRMLBackground node is subject to the accumulated rotations of its parent transformations - scaling and translation transformations are ignored. The sky sphere is always slightly farther away from the viewer than the ground sphere - the ground appears in front of the sky in cases where they overlap.

The skyColor field specifies the color of the sky at the various angles on the sky sphere. The first value of the skyColor field specifies the color of the sky at 0.0 degrees, the north pole (i.e., straight up from the viewer). The skyAngle field specifies the angles from the north pole in which concentric circles of color appear - the north pole of the sphere is implicitly defined to be 0.0 degrees, the natural horizon at pi/2 radians, and the south pole is pi radians. skyAngle is restricted to increasing values in the range 0.0 to pi. There must be one more skyColor value than there are skyAngle values - the first color value is the color at the north pole, which is not specified in the skyAngle field. If the last skyAngle is less than pi, then the color band between the last skyAngle and the south pole is clamped to the last skyColor. The sky color is linearly interpolated between the specified skyColor values.

The groundColor field specifies the color of the ground at the various angles on the ground sphere. The first value of the groundColor field specifies the color of the ground at 0.0 degrees, the south pole (i.e., straight down). The groundAngle field specifies the angles from the south pole that the concentric circles of color appear - the south pole of the sphere is implicitly defined at 0.0 degrees. groundAngle is restricted to increasing values in the range 0.0 to pi. There must be one more groundColor values than there are groundAngle values - the first color value is for the south pole which is not specified in the groundAngle field. If the last groundAngle is less than pi (it usually is), then the region between the last groundAngle and the north pole is invisible. The ground color is linearly interpolated between the specified groundColor values.

The backUrl, bottomUrl, frontUrl, leftUrl, rightUrl, and topUrl fields specify a set of images that define a background panorama, between the ground/sky backdrop and the world's geometry. The panorama consists of six images, each of which is mapped onto the faces of an infinitely large cube centered in the local coordinate system. The images are applied individually to each face of the cube; the entire image goes on each face. On the front, back, right, and left faces of the cube, when viewed from the inside with the Y-axis up, the texture is mapped onto each face with the same orientation as the if image was displayed normally in 2D. On the top face of the cube, when viewed from the inside looking up along the +Y axis with the +Z axis as the view up direction, the texture is mapped onto the face with the same orientation as the if image was displayed normally in 2D. On the bottom face of the box, when viewed from the inside down the -Y axis with the -Z axis as the view up direction, the texture is mapped onto the face with the same orientation as the if image was 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. One-component images are displayed in grayscale; two-component images are displayed in grayscale with alpha transparency; three-component images are displayed in full RGB color; four-component images are displayed in full RGB color with alpha transparency. Often, the bottomUrl and topUrl images will not be specified, to allow sky and ground to show. The other four images may depict surrounding mountains or other distant scenery. Browsers are required to support the JPEG and PNG image file formats, and in addition, may support any other image formats. Support for the GIF format (including transparent backgrounds) is recommended. See the section "Concepts - URLS and URNs" for details on the url fields.

Panorama images may be one-component (grayscale), two-component (grayscale plus alpha), three-component (full RGB color), or four-component (full RGB color plus alpha).

Ground colors, sky colors, and panoramic images do not translate with respect to the viewer, though they do rotate with respect to the viewer. That is, the viewer can never get any closer to the background, but can turn to examine all sides of the panorama cube, and can look up and down to see the concentric rings of ground and sky (if visible).

SoVRMLBackground is not affected by SoVRMLFog. Therefore, if an SoVRMLBackground is active (i.e bound) while an SoVRMLFog is active, then the SoVRMLBackground will be displayed with no fogging effects. It is the author's responsibility to set the SoVRMLBackground values to match the SoVRMLFog (e.g. ground colors fade to fog color with distance and panorama images tinted with fog color).

The first SoVRMLBackground node found during reading of the world is automatically bound (receives set_bind true) and is used as the initial background when the world is loaded.

File format/default:

VRMLBackground {

groundAngle	[]
groundColor	[]
backUrl	[]
bottomUrl	[]
frontUrl	[]
leftUrl	[]
rightUrl	[]
topUrl	[]
skyAngle	[]
skyColor	[ 0 0 0 ]
metadata	NULL

}

EVENTS

eventIn

SoSFBool	set_bind
SoMFFloat	set_groundAngle
SoMFColor	set_groundColor
SoMFFilePathString	set_backUrl
SoMFFilePathString	set_bottomUrl
SoMFFilePathString	set_frontUrl
SoMFFilePathString	set_leftUrl
SoMFFilePathString	set_rightUrl
SoMFFilePathString	set_topUrl
SoMFFloat	set_skyAngle
SoMFColor	set_skyColor
SoSFNode	set_metadata

eventOut

SoSFBool	isBound
SoSFTime	bindTime
SoMFFloat	groundAngle_changed
SoMFColor	groundColor_changed
SoMFFilePathString	backUrl_changed
SoMFFilePathString	bottomUrl_changed
SoMFFilePathString	frontUrl_changed
SoMFFilePathString	leftUrl_changed
SoMFFilePathString	rightUrl_changed
SoMFFilePathString	topUrl_changed
SoMFFloat	skyAngle_changed
SoMFColor	skyColor_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoMFFilePathString	backUrl Deprecated. Specifies one of a set of images that define a background panorama between the ground/sky backdrop and the world's geometry.
SoMFFilePathString	bottomUrl Deprecated. See backUrl.
SoMFFilePathString	frontUrl Deprecated. See backUrl.
SoMFFloat	groundAngle Deprecated. Specifies the angles from the south pole in which the concentric circles of color appear.
SoMFColor	groundColor Deprecated. Specifies the color of the ground at the various angle on the ground sphere.
SoMFFilePathString	leftUrl Deprecated. See backUrl.
SoMFFilePathString	rightUrl Deprecated. See backUrl.
SoMFFloat	skyAngle Deprecated. Specifies the angles from the north pole in which concentric circles of color appear.
SoMFColor	skyColor Deprecated. Specifies the color of the sky at the various angles on the sky sphere.
SoMFFilePathString	topUrl Deprecated. See backUrl.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLBackground() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groundColor

public final SoMFColor groundColor

Deprecated.

Specifies the color of the ground at the various angle on the ground sphere. The first value of groundColor specifies the color of the ground at 0.0 degrees. There must be one more goundColor value than there are groundAngle values. The first color is for 0.0 which is not specified in the groundAngle field.

groundAngle

public final SoMFFloat groundAngle

Deprecated.

Specifies the angles from the south pole in which the concentric circles of color appear. The south pole is 0.0 degrees. groundAngle ranges from 0.0 to pi.

skyColor

public final SoMFColor skyColor

Deprecated.

Specifies the color of the sky at the various angles on the sky sphere. The first value specifies the color of the sky at 0.0 degrees, the north pole. There must be one more skyColor value than there are skyAngle values. The first color value is the color at the north pole, which is not specified in the skyAngle field.

skyAngle

public final SoMFFloat skyAngle

Deprecated.

Specifies the angles from the north pole in which concentric circles of color appear. The north pole is 0.0 degrees, the natural horizon pi/2 radians, and the south pole is pi radians.

backUrl

public final SoMFFilePathString backUrl

Deprecated.

Specifies one of a set of images that define a background panorama between the ground/sky backdrop and the world's geometry. The panorama consists of six images, each of which is mapped onto the faces of an infinitely large cube centered in the local coordinate system.

bottomUrl

public final SoMFFilePathString bottomUrl

Deprecated.

See backUrl.

frontUrl

public final SoMFFilePathString frontUrl

Deprecated.

See backUrl.

leftUrl

public final SoMFFilePathString leftUrl

Deprecated.

See backUrl.

rightUrl

public final SoMFFilePathString rightUrl

Deprecated.

See backUrl.

topUrl

public final SoMFFilePathString topUrl

Deprecated.

See backUrl.

Constructor Detail

SoVRMLBackground

public SoVRMLBackground()

Deprecated.

Constructor.