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

#include <Inventor/nodes/CoinEnvironment.h>

Inherits SoNode.

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

Public Types inherited from SoNode
enum	NodeType

Public Member Functions
	CoinEnvironment (void)

virtual void	GLRender (SoGLRenderAction *action)

virtual void	callback (SoCallbackAction *action)

Public Member Functions inherited from SoNode
void	setOverride (const SbBool state)

SbBool	isOverride (void) const

void	setNodeType (const NodeType type)

NodeType	getNodeType (void) const

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

virtual SbBool	affectsState (void) const

virtual void	doAction (SoAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	audioRender (SoAudioRenderAction *action)

virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void	grabEventsSetup (void)

virtual void	grabEventsCleanup (void)

virtual void	startNotify (void)

virtual void	notify (SoNotList *l)

SbUniqueId	getNodeId (void) const

virtual SoChildList *	getChildren (void) const

virtual void	writeInstance (SoOutput *out)

virtual SoNode *	addToCopyDict (void) const

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

virtual SoFieldContainer *	copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer
void	setToDefaults (void)

SbBool	hasDefaultValues (void) const

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	set (const char *const fielddata)

void	get (SbString &fielddata)

virtual int	getFields (SoFieldList &l) const

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getField (const SbName &name) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

SbBool	enableNotify (const SbBool flag)

SbBool	isNotifyEnabled (void) const

SbBool	set (const char fielddata, SoInput input)

void	get (SbString &fielddata, SoOutput *out)

virtual SbBool	validateNewFieldValue (SoField field, void newval)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

SbBool	getIsBuiltIn (void) const

virtual const SoFieldData *	getFieldData (void) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

void	setUserData (void *userdata) const

void *	getUserData (void) const

Public Member Functions inherited from SoBase
void	ref (void) const

void	unref (void) const

void	unrefNoDelete (void) const

int32_t	getRefCount (void) const

void	touch (void)

virtual SoType	getTypeId (void) const=0

SbBool	isOfType (SoType type) const

virtual SbName	getName (void) const

virtual void	setName (const SbName &newname)

void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

const SoAuditorList &	getAuditors (void) const

SbBool	shouldWrite (void)

void	assertAlive (void) const

Static Public Member Functions
static void	initClass (void)

Static Public Member Functions inherited from SoNode
static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static void	initClasses (void)

static SbUniqueId	getNextNodeId (void)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static void	getMatrixS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	pickS (SoAction action, SoNode node)

static void	rayPickS (SoAction action, SoNode node)

static void	searchS (SoAction action, SoNode node)

static void	writeS (SoAction action, SoNode node)

static void	audioRenderS (SoAction action, SoNode node)

static void	getPrimitiveCountS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	initCopyDict (void)

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static void	copyDone (void)

Static Public Member Functions inherited from SoBase
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	addName (SoBase const base, const char const name)

static void	removeName (SoBase const base, const char const name)

static void	incrementCurrentWriteCounter (void)

static void	decrementCurrentWriteCounter (void)

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

static SbBool	getTraceRefs (void)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static SbBool	readRoute (SoInput *input)

Public Attributes
SoSFFloat	ambientIntensity

SoSFColor	ambientColor

SoSFVec3f	attenuation

SoSFEnum	fogType

SoSFColor	fogColor

SoSFFloat	fogVisibility

SoSFFloat	fogStart

Public Attributes inherited from SoNode
	INVENTOR

	VRML1

	VRML2

	INVENTOR_1

	INVENTOR_2_0

	INVENTOR_2_1

	INVENTOR_2_5

	INVENTOR_2_6

	COIN_1_0

	COIN_2_0

	EXTENSION

Protected Member Functions
virtual	~CoinEnvironment ()

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual void	destroy (void)

SbBool	hasMultipleWriteRefs (void) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName (void) const

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static void	setNextActionMethodIndex (int index)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Static Protected Attributes inherited from SoNode
static SbUniqueId	nextUniqueId

static int	nextActionMethodIndex

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.

Reimplemented from SoNode.

◆ GLRender()

void CoinEnvironment::GLRender ( SoGLRenderAction * action )

virtual

Coin method. Updates state with new environment values.

Reimplemented from SoNode.

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