com.openinventor.inventor.vrmlnodes

Class SoVRMLFog

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.SoVRMLFog

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLFog
extends SoVRMLNode

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

The SoVRMLFog node provides a way to simulate atmospheric effects.

<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 SoVRMLFog node provides a way to simulate atmospheric effects by blending objects with the color specified by the color field based on the objects' distances from the viewer. The distances are calculated in the coordinate space of the SoVRMLFog node. The visibilityRange specifies the distance (in the SoVRMLFog node's coordinate space) at which objects are totally obscured by the fog. Objects located visibilityRange meters or more away from the viewer are drawn with a constant color of color. Objects very close to the viewer are blended very little with the fog color. A visibilityRange of 0.0 or less disables the SoVRMLFog node. Note that visibilityRange is affected by the scaling transformations of the SoVRMLFog node's parents - translations and rotations have no affect on visibilityRange.

SoVRMLFog nodes are bindable children nodes and thus there exists an SoVRMLFog stack, in which the top-most SoVRMLFog node on the stack is currently active. To push an SoVRMLFog node onto the top of the stack, a true value is sent to the set_bind eventIn. Once active, the SoVRMLFog is then bound to the browser's view. A false value of set_bind pops the SoVRMLFog from the stack and unbinds it from the browser viewer. See "Concepts - Bindable Children Nodes" for more details on the SoVRMLFog stack.

The fogType field controls how much of the fog color is blended with the object as a function of distance. If fogType is "LINEAR" (the default), then the amount of blending is a linear function of the distance, resulting in a depth cuing effect. If fogType is "EXPONENTIAL" then an exponential increase in blending should be used, resulting in a more natural fog appearance.

For best visual results, the SoVRMLBackground node (which is unaffected by the SoVRMLFog node) should be the same color as the fog node. The SoVRMLFog node can also be used in conjunction with the visibilityLimit field of SoVRMLNavigationInfo node to provide a smooth fade out of objects as they approach the far clipping plane.

See the section "Concepts - Lighting Model" for details on lighting calculations.

File format/default:

VRMLFog {

color	1 1 1
fogType	"LINEAR"
visibilityRange	0
metadata	NULL

}

EVENTS

eventIn

SoSFBool	set_bind
SoSFColor	set_color
SoSFString	set_fogType
SoSFFloat	set_visibilityRange
SoSFNode	set_metadata

eventOut

SoSFBool	isBound
SoSFBool	bindTime
SoSFColor	color_changed
SoSFString	fogType_changed
SoSFFloat	visibilityRange_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
SoSFColor	color Deprecated.
SoSFString	fogType Deprecated.
SoSFFloat	visibilityRange Deprecated.

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
SoVRMLFog() 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

fogType

public final SoSFString fogType

Deprecated.

visibilityRange

public final SoSFFloat visibilityRange

Deprecated.

color

public final SoSFColor color

Deprecated.

Constructor Detail

SoVRMLFog

public SoVRMLFog()

Deprecated.

Constructor.