SoGLEnvironmentElement Class Reference

The SoGLEnvironmentElement class is for setting GL fog etc. More...

#include <Inventor/elements/SoGLEnvironmentElement.h>

Inheritance diagram for SoGLEnvironmentElement:

List of all members.

Public Member Functions
virtual void	init (SoState *state)
	FIXME: write doc.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
Public Member Functions inherited from SoEnvironmentElement
virtual void	print (FILE *file) const
	FIXME: write doc.
Public Member Functions inherited from SoReplacedElement
virtual SbBool	matches (const SoElement *element) const
virtual SoElement *	copyMatchInfo () const
uint32_t	getNodeId () const
Public Member Functions inherited from SoElement
const SoType	getTypeId (void) const
int	getStackIndex (void) const
virtual void	push (SoState *state)
void	setDepth (const int depth)
int	getDepth (void) const
virtual	~SoElement ()

Static Public Member Functions
static SoType	getClassTypeId (void)
static int	getClassStackIndex (void)
static void *	createInstance (void)
static void	initClass (void)
Static Public Member Functions inherited from SoEnvironmentElement
static void	set (SoState *const state, SoNode *const node, const float ambientIntensity, const SbColor &ambientColor, const SbVec3f &attenuation, const int32_t fogType, const SbColor &fogColor, const float fogVisibility, const float fogStart=0.0f)
	FIXME: write doc.
static void	get (SoState *const state, float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, int32_t &fogType, SbColor &fogColor, float &fogVisibility, float &fogStart)
	FIXME: write doc.
static float	getAmbientIntensity (SoState *const state)
	FIXME: write doc.
static float	getFogVisibility (SoState *const state)
	FIXME: write doc.
static const SbVec3f &	getLightAttenuation (SoState *const state)
	FIXME: write doc.
static const SbColor &	getAmbientColor (SoState *const state)
	FIXME: write doc.
static const SbColor &	getFogColor (SoState *const state)
	FIXME: write doc.
static int32_t	getFogType (SoState *const state)
	FIXME: write doc.
static void	getDefault (float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, int32_t &fogType, SbColor &fogColor, float &fogVisibility, float &fogNear)
	FIXME: write doc.

Protected Member Functions
virtual	~SoGLEnvironmentElement ()
virtual void	setElt (SoState *const state, const float ambientIntensity, const SbColor &ambientColor, const SbVec3f &attenuation, const int32_t fogType, const SbColor &fogColor, const float fogVisibility, const float fogStart)
	FIXME: doc.
Protected Member Functions inherited from SoEnvironmentElement
virtual	~SoEnvironmentElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
void	setTypeId (const SoType typeId)
void	setStackIndex (const int index)
SoElement *	getNextInStack (void) const
SoElement *	getNextFree (void) const

Additional Inherited Members
Public Types inherited from SoEnvironmentElement
enum	FogType { NONE, HAZE, FOG, SMOKE }
Protected Attributes inherited from SoEnvironmentElement
float	ambientIntensity
SbColor	ambientColor
SbVec3f	attenuation
int32_t	fogType
SbColor	fogColor
float	fogVisibility
float	fogStart
Protected Attributes inherited from SoReplacedElement
uint32_t	nodeId
Protected Attributes inherited from SoElement
SoType	typeId
int	stackIndex
int	depth

---

Detailed Description

The SoGLEnvironmentElement class is for setting GL fog etc.

---

Constructor & Destructor Documentation

SoGLEnvironmentElement::~SoGLEnvironmentElement ( )

protectedvirtual

The destructor.

---

Member Function Documentation

SoType SoGLEnvironmentElement::getClassTypeId ( void  )

static

This static method returns the class type.

Reimplemented from SoEnvironmentElement.

int SoGLEnvironmentElement::getClassStackIndex ( void  )

static

This static method returns the state stack index for the class.

Reimplemented from SoEnvironmentElement.

void * SoGLEnvironmentElement::createInstance ( void  )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoEnvironmentElement.

void SoGLEnvironmentElement::initClass ( void  )

static

This static method initializes static data for the SoGLEnvironmentElement class.

Reimplemented from SoEnvironmentElement.

void SoGLEnvironmentElement::pop ( SoState *  state, const SoElement *  prevTopElement  )

virtual

This method is callled when the state is popped, and the depth of the element is bigger than the current state depth. pop() is called on the new top of stack, and a pointer to the previous top of stack is passed in prevTopElement.

Override this method if you need to copy some state information from the previous top of stack.

Reimplemented from SoElement.

---

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

• SoGLEnvironmentElement.h
• SoGLEnvironmentElement.cpp