The CoinEnvironment class is a node for specifying global rendering parameters. More...

#include <Inventor/nodes/CoinEnvironment.h>

Inheritance diagram for CoinEnvironment:

Public Types
enum	FogType { NONE = SoEnvironmentElement::NONE , HAZE = SoEnvironmentElement::HAZE , FOG = SoEnvironmentElement::FOG , SMOKE = SoEnvironmentElement::SMOKE }

Public Member Functions
	CoinEnvironment (void)

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)

Static Public Member Functions
static void	initClass (void)

Public Attributes
SoSFColor	ambientColor

SoSFFloat	ambientIntensity

SoSFVec3f	attenuation

SoSFColor	fogColor

SoSFFloat	fogStart

SoSFEnum	fogType

SoSFFloat	fogVisibility

Protected Member Functions
virtual	~CoinEnvironment ()

Detailed Description

The CoinEnvironment class is a node for specifying global rendering parameters.

This node type provides the application programmer with the ability to set global parameters influencing lighting and fog. It is a temporary replacement of the standard SoEnvironment node, which didn't have a fogStart field.

Member Enumeration Documentation

◆ FogType

enum CoinEnvironment::FogType

Enumeration of available types of fog.

Enumerator
NONE	No fog. Visibility will be equal for all objects, independent of distance to camera.
HAZE	Fog where visibility will decrease linearly with distance to camera.
FOG	Fog where visibility will decrease exponentially with distance to camera.
SMOKE	Fog where visibility will decrease exponentially with the square of the distance to camera (simulating really thick fog).

Constructor & Destructor Documentation

◆ CoinEnvironment()

CoinEnvironment::CoinEnvironment ( void )

Constructor.

◆ ~CoinEnvironment()

CoinEnvironment::~CoinEnvironment ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ callback()

void CoinEnvironment::callback ( SoCallbackAction * action )

virtual

Coin method. Updates state with the new environment values.

◆ GLRender()

void CoinEnvironment::GLRender ( SoGLRenderAction * action )

virtual

Coin method. Updates state with new environment values.

◆ initClass()

void CoinEnvironment::initClass ( void )

static

Required Coin method.

Member Data Documentation

◆ ambientColor

SoSFColor CoinEnvironment::ambientColor

The color of the global ambient light. Defaults to full intensity white.

◆ ambientIntensity

SoSFFloat CoinEnvironment::ambientIntensity

A global ambient value for the light intensity for the complete scene. This will provide some light even when there are no light sources defined for the scene.

Valid values is from 0.0 (no ambient light) to 1.0 (full ambient light intensity). Default value is 0.2.

◆ attenuation

SoSFVec3f CoinEnvironment::attenuation

Light attenuation coefficients.

◆ fogColor

SoSFColor CoinEnvironment::fogColor

Color of fog. Defaults to full intensity white.

◆ fogStart

SoSFFloat CoinEnvironment::fogStart

The distance from the near plane from which objects will start to be obscured by fog. This field will only be used in linear (HAZE) mode.

Default value is 0.0.

◆ fogType

SoSFEnum CoinEnvironment::fogType

The fog model. See CoinEnvironment::FoType.

◆ fogVisibility

SoSFFloat CoinEnvironment::fogVisibility

The "cut-off" distance from the camera where objects will be totally obscured by fog. If set to 0.0, the far plane distance will be used instead.