com.openinventor.inventor.nodes

Class SoEnvironment

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.nodes.SoEnvironment

All Implemented Interfaces:

SafeDisposable

public class SoEnvironment
extends SoNode

Global environment node. This node describes global environmental attributes such as ambient lighting, light attenuation, and fog.

Ambient lighting is the amount of extra light impinging on each surface point when the lighting model is Phong (see SoLightModel).

Light attenuation affects all subsequent lights in a scene (see SoLight). It is a quadratic function of distance from a light source to a surface point. The three coefficients are specified in the attenuation field. Attenuation works only for light sources with a fixed location, such as point and spot lights.

Fog has one of four types, each of which blends each surface point with the specified fog color. Each type interprets the fogVisibility field to be the distance at which fog totally obscures objects. A fogVisibility value of 0 (the default) causes the SoEnvironment node to set up fog so that the visibility is the distance to the far clipping plane of the current camera. Using a fog of type HAZE results in a linear fog between the fogStart value and the fogVisibility value.

Note that this node has effect only during rendering.

File format/default:

Environment {

ambientIntensity	0.2
ambientColor	1 1 1
attenuation	0 0 1
fogType	NONE
fogColor	1 1 1
fogStart	0
fogVisibility	0

}

Action behavior:

SoGLRenderAction
Sets the current environment parameters to those specified with this node. Successive geometries will be rendered using this environment. Sets: SoEnvironmentElement, SoLightAttenuationElement

See also:

SoLight, SoLightModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoEnvironment.FogTypes Type of fog.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFColor	ambientColor RGB color of ambient lighting (for Phong lighting).
SoSFFloat	ambientIntensity Intensity of ambient lighting (for Phong lighting).
SoSFVec3f	attenuation Squared, linear, and constant light attenuation coefficients (in that order) with respect to distance of light from surface (for Phong lighting).
static int	FOG Deprecated. Use SoEnvironment.FogTypes.FOG instead.
SoSFColor	fogColor Fog color.
SoSFFloat	fogStart Distance at which the linear fog HAZE starts to be applied.
SoSFEnum<SoEnvironment.FogTypes>	fogType Type of fog.
SoSFFloat	fogVisibility Fog visibility distance, which is the distance at which fog totally obscures objects.
static int	HAZE Deprecated. Use SoEnvironment.FogTypes.HAZE instead.
static int	NONE Deprecated. Use SoEnvironment.FogTypes.NONE instead.
static int	SMOKE Deprecated. Use SoEnvironment.FogTypes.SMOKE instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoEnvironment() Creates an environment node with default settings.

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

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoEnvironment.FogTypes.NONE instead.

HAZE

@Deprecated
public static final int HAZE

Deprecated. Use SoEnvironment.FogTypes.HAZE instead.

FOG

@Deprecated
public static final int FOG

Deprecated. Use SoEnvironment.FogTypes.FOG instead.

SMOKE

@Deprecated
public static final int SMOKE

Deprecated. Use SoEnvironment.FogTypes.SMOKE instead.

ambientIntensity

public final SoSFFloat ambientIntensity

Intensity of ambient lighting (for Phong lighting). Default is 0.2.

ambientColor

public final SoSFColor ambientColor

RGB color of ambient lighting (for Phong lighting). Default is 1, 1, 1.

attenuation

public final SoSFVec3f attenuation

Squared, linear, and constant light attenuation coefficients (in that order) with respect to distance of light from surface (for Phong lighting). Default is 0, 0, 1.

fogType

public final SoSFEnum<SoEnvironment.FogTypes> fogType

Type of fog. . Default is NONE.

fogColor

public final SoSFColor fogColor

Fog color. Default is 1, 1, 1.

fogStart

public final SoSFFloat fogStart

Distance at which the linear fog HAZE starts to be applied. Between fogStart and fogVisibility, the HAZE fog is linear, and beyond the fogVisibility distance, the fog totally obscures objects. This field has no effect on other types of fog. Default is 0.

fogVisibility

public final SoSFFloat fogVisibility

Fog visibility distance, which is the distance at which fog totally obscures objects. Default is 0. A value of 0 (the default) causes the SoEnvironment node to set up fog so that the visibility is the distance to the far clipping plane of the current camera.

Constructor Detail

SoEnvironment

public SoEnvironment()

Creates an environment node with default settings.