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

#include <Inventor/elements/SoGLEnvironmentElement.h>

Inheritance diagram for SoGLEnvironmentElement:

Public Member Functions
virtual void	init (SoState *state)

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 SoElement *	copyMatchInfo () const

SbUniqueId	getNodeId () const

virtual SbBool	matches (const SoElement *element) const

Public Member Functions inherited from SoElement
virtual	~SoElement ()

int	getDepth (void) const

int	getStackIndex (void) const

const SoType	getTypeId (void) const

virtual void	push (SoState *state)

void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)

static int	getClassStackIndex (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoEnvironmentElement
static void *	createInstance (void)

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 const SbColor &	getAmbientColor (SoState *const state)
	FIXME: write doc.

static float	getAmbientIntensity (SoState *const state)
	FIXME: write doc.

static int	getClassStackIndex (void)

static SoType	getClassTypeId (void)

static void	getDefault (float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, int32_t &fogType, SbColor &fogColor, float &fogVisibility, float &fogNear)
	FIXME: write doc.

static const SbColor &	getFogColor (SoState *const state)
	FIXME: write doc.

static int32_t	getFogType (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 void	initClass (void)

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 Public Member Functions inherited from SoReplacedElement
static int	getClassStackIndex (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)

static SoType	getClassTypeId (void)

static SoType	getIdFromStackIndex (const int stackIndex)

static int	getNumStackIndices (void)

static void	initClass (void)

static void	initElements (void)

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

SoElement *	getNextFree (void) const

SoElement *	getNextInStack (void) const

void	setStackIndex (const int index)

void	setTypeId (const SoType typeId)

Additional Inherited Members
Public Types inherited from SoEnvironmentElement
enum	FogType { NONE , HAZE , FOG , SMOKE }

Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState const state, const int stackIndex, SoNode const node)

Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)

static const SoElement *	getConstElement (SoState *const state, const int stackIndex)

static SoElement *	getElement (SoState *const state, const int stackIndex)

Protected Attributes inherited from SoEnvironmentElement
SbColor	ambientColor

float	ambientIntensity

SbVec3f	attenuation

SbColor	fogColor

float	fogStart

int32_t	fogType

float	fogVisibility

Protected Attributes inherited from SoReplacedElement
SbUniqueId	nodeId

Protected Attributes inherited from SoElement
int	depth

int	stackIndex

SoType	typeId

Static Protected Attributes inherited from SoElement
static int	classStackIndex

static SoTypeList *	stackToType

Detailed Description

The SoGLEnvironmentElement class is for setting GL fog etc.

Constructor & Destructor Documentation

◆ ~SoGLEnvironmentElement()

SoGLEnvironmentElement::~SoGLEnvironmentElement ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ createInstance()

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.

Creates a new instance of the class type corresponding to the SoType object.

◆ getClassStackIndex()

int SoGLEnvironmentElement::getClassStackIndex ( void )

static

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

◆ getClassTypeId()

SoType SoGLEnvironmentElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ init()

void SoGLEnvironmentElement::init ( SoState * state )

virtual

Initializes the element to its default value. The defaults for the environment settings are:

SoEnvironmentElement::ambientIntensity = 0.2 SoEnvironmentElement::ambientColor = SbColor(1.0, 1.0, 1.0) SoEnvironmentElement::attenuation = SbVec3f(0.0, 0.0, 1.0) SoEnvironmentElement::fogType = SoEnvironmentElement::NONE SoEnvironmentElement::fogColor = SbColor(1.0, 1.0, 1.0) SoEnvironmentElement::fogVisibility = 0.0 SoEnvironmentElement::fogStart = 0.0

Reimplemented from SoEnvironmentElement.

◆ initClass()

void SoGLEnvironmentElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

◆ pop()

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

virtual

This method is called 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.

◆ setElt()

void SoGLEnvironmentElement::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	fogNear )

protectedvirtual

FIXME: doc.

Reimplemented from SoEnvironmentElement.

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

SoGLEnvironmentElement.h
SoGLEnvironmentElement.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SoGLEnvironmentElement()

Member Function Documentation

◆ createInstance()

◆ getClassStackIndex()

◆ getClassTypeId()

◆ init()

◆ initClass()

◆ pop()

◆ setElt()