SoEnvironmentElement Class Reference
[Elements]

Stores the current environment. More...

#include <Inventor/elements/SoEnvironmentElement.h>

Inheritance diagram for SoEnvironmentElement:

List of all members.

Classes
struct	EnvironmentParameters
	EnvironmentParameters packages all the different environment parameters. More...
Public Types
enum	FogType {   NONE,   HAZE,   FOG,   SMOKE }
Public Member Functions
virtual void	push (SoState *state)
Static Public Member Functions
static SoType	getClassTypeId ()
static int	getClassStackIndex ()
static void	set (SoState *state, SoNode *node, const EnvironmentParameters &envParams)
static void	get (SoState *state, EnvironmentParameters &envParams)
static float	getAmbientIntensity (SoState *state)
static const SbColor &	getAmbientColor (SoState *state)
static const SbVec3f &	getLightAttenuation (SoState *state)
Deprecated
static SoDEPRECATED void	set (SoState *state, SoNode *node, float ambientIntensity, const SbColor &ambientColor, const SbVec3f attenuation, FogType fogType, const SbColor fogColor, float fogVisibility)
static SoDEPRECATED void	get (SoState *state, float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, FogType &fogType, SbColor &fogColor, float &fogVisibility)
static SoDEPRECATED void	getDefault (float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, FogType &fogType, SbColor &fogColor, float &fogVisibility)

---

Detailed Description

Stores the current environment.

This element stores the current environment.

SEE ALSO

SoEnvironment

---

Member Enumeration Documentation

enum SoEnvironmentElement::FogType

Fog type.

Enumerator:

NONE	None.
HAZE	Haze.
FOG	Fog.
SMOKE	Smoke.

---

Member Function Documentation

static void SoEnvironmentElement::get	(	SoState *	state,
		EnvironmentParameters &	envParams
	)			[static]

Gets the current environment in the state.

static SoDEPRECATED void SoEnvironmentElement::get	(	SoState *	state,
		float &	ambientIntensity,
		SbColor &	ambientColor,
		SbVec3f &	attenuation,
		FogType &	fogType,
		SbColor &	fogColor,
		float &	fogVisibility
	)			[static]

Gets the current environment in the state.

Deprecated:

Deprecated since Open Inventor 9900
This method is deprecated. Please use get(SoState *state, EnvironmentParameters& envParams) instead

static const SbColor& SoEnvironmentElement::getAmbientColor

(

SoState *

state

)

[static]

Gets the ambient color.

static float SoEnvironmentElement::getAmbientIntensity

(

SoState *

state

)

[static]

Gets the ambient intensity.

static int SoEnvironmentElement::getClassStackIndex

(

)

[static]

Returns the stack id for this element.

Reimplemented from SoReplacedElement.

Reimplemented in SoGLEnvironmentElement.

static SoType SoEnvironmentElement::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoReplacedElement.

Reimplemented in SoGLEnvironmentElement.

static SoDEPRECATED void SoEnvironmentElement::getDefault	(	float &	ambientIntensity,
		SbColor &	ambientColor,
		SbVec3f &	attenuation,
		FogType &	fogType,
		SbColor &	fogColor,
		float &	fogVisibility
	)			[static]

Returns the default value.

Deprecated:

Deprecated since Open Inventor 9900
This method is deprecated. Please use the default constructor of the EnvironmentParameters struct instead

static const SbVec3f& SoEnvironmentElement::getLightAttenuation

(

SoState *

state

)

[static]

Gets the light attenuation.

virtual void SoEnvironmentElement::push

(

SoState *

state

)

[virtual]

Pushes element.

Allows for side effects to occur. Default methods do nothing.

Reimplemented from SoElement.

Reimplemented in SoGLEnvironmentElement.

static void SoEnvironmentElement::set	(	SoState *	state,
		SoNode *	node,
		const EnvironmentParameters &	envParams
	)			[static]

Sets the current environment in the state.

static SoDEPRECATED void SoEnvironmentElement::set	(	SoState *	state,
		SoNode *	node,
		float	ambientIntensity,
		const SbColor &	ambientColor,
		const SbVec3f	attenuation,
		FogType	fogType,
		const SbColor	fogColor,
		float	fogVisibility
	)			[static]

Sets the current environment in the state.

Deprecated:

Deprecated since Open Inventor 9900
This method is deprecated. Please use set(SoState *state, SoNode *node, const EnvironmentParameters& envParams) instead

---

The documentation for this class was generated from the following file:

• Inventor/elements/SoEnvironmentElement.h