SoEnvironmentElement Class Reference

Stores the current environment. More...

#include <Inventor/elements/SoEnvironmentElement.h>

Inheritance diagram for SoEnvironmentElement:

Classes
struct	EnvironmentParameters
	EnvironmentParameters packages all the different environment parameters. More...

Public Types
enum	FogType {   NONE ,   HAZE ,   FOG ,   SMOKE }
	Fog type. More...

Public Member Functions
virtual void	push (SoState *state)
	Pushes element.
Public Member Functions inherited from SoReplacedElement
virtual void	print (FILE *fp) const
	Prints element (for debugging).
Public Member Functions inherited from SoElement
virtual void	pop (SoState *state, const SoElement *prevTopElement)
	Pops element.
virtual SoType	getTypeId () const
	Returns type identifier for element instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
static void	set (SoState *state, SoNode *node, const EnvironmentParameters &envParams)
	Sets the current environment in the state.
static void	get (SoState *state, EnvironmentParameters &envParams)
	Gets the current environment in the state.
static float	getAmbientIntensity (SoState *state)
	Gets the ambient intensity.
static const SbColor &	getAmbientColor (SoState *state)
	Gets the ambient color.
static const SbVec3f &	getLightAttenuation (SoState *state)
	Gets the light attenuation.
static const SbBool &	getAmbientOcclusion (SoState *state)
	Gets the ambient occlusion state (TRUE : activated, otherwise deactivated)
Static Public Member Functions inherited from SoReplacedElement
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static int	getClassStackIndex ()
	Returns the stack id for this element.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores the current environment.

This element stores the current environment.

SEE ALSO

SoEnvironment

Definition at line 42 of file SoEnvironmentElement.h.

Member Enumeration Documentation

FogType

enum SoEnvironmentElement::FogType

Fog type.

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

Definition at line 48 of file SoEnvironmentElement.h.

Member Function Documentation

get()

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

static

Gets the current environment in the state.

getAmbientColor()

static const SbColor & SoEnvironmentElement::getAmbientColor ( SoState *  state )

static

Gets the ambient color.

getAmbientIntensity()

static float SoEnvironmentElement::getAmbientIntensity ( SoState *  state )

static

Gets the ambient intensity.

getAmbientOcclusion()

static const SbBool & SoEnvironmentElement::getAmbientOcclusion ( SoState *  state )

static

Gets the ambient occlusion state (TRUE : activated, otherwise deactivated)

getClassStackIndex()

static int SoEnvironmentElement::getClassStackIndex ( )

static

Returns the stack id for this element.

getClassTypeId()

static SoType SoEnvironmentElement::getClassTypeId ( )

static

Returns the type identifier for this class.

getLightAttenuation()

static const SbVec3f & SoEnvironmentElement::getLightAttenuation ( SoState *  state )

static

Gets the light attenuation.

push()

virtual void SoEnvironmentElement::push ( SoState *  state )

virtual

Pushes element.

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

Reimplemented from SoElement.

set()

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

static

Sets the current environment in the state.

---

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

• Inventor/elements/SoEnvironmentElement.h