SoLightAttenuationElement Class Reference

Element that stores the light attenuation(s) of the current environment. More...

#include <Inventor/elements/SoLightAttenuationElement.h>

Inheritance diagram for SoLightAttenuationElement:

Public Member Functions
virtual void	init (SoState *state)
	Initializes element.
virtual SoElement *	copyMatchInfo () const
	Create and return a copy of this element.
virtual bool	matches (const SoElement *elt) const
	Returns TRUE if the attenuations match in both elements.
virtual void	print (FILE *fp) const
	Prints element (for debugging)
Public Member Functions inherited from SoReplacedElement
virtual void	init (SoState *state)
	Initializes node id in element.
virtual bool	matches (const SoElement *elt) const
	Returns TRUE if the element matches another element, based on node-id.
virtual void	print (FILE *fp) const
	Prints element (for debugging)
virtual SoElement *	copyMatchInfo () const
	Create and return a copy of this element.
SbNodeIdType	getNodeId () const
	Return nodeId.
Public Member Functions inherited from SoElement
virtual void	init (SoState *state)
	Initializes element.
virtual void	push (SoState *state)
	Pushes/pops element.
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *fp) const
	Prints element (for debugging)
virtual bool	matches (const SoElement *elt) const =0
	Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
virtual SoElement *	copyMatchInfo () const =0
	Create a copy that we can put in a cache used list and call matches() on later.
SoType	getTypeId () const
	Returns type identifier for element instance.
int	getStackIndex () const
	Returns the stack index for an element instance.
void	setDepth (int dpth)
	Sets stuff in an element instance.
void	setNext (SoElement *nxt)
void	setNextInStack (SoElement *nxt)
void	setNextFree (SoElement *nxt)
int	getDepth () const
	Returns stuff from element instance.
SoElement *	getNext () const
virtual	~SoElement ()
	Destructor.

Static Public Member Functions
static void	set (SoState *state, SoNode *node, const SbVec3f &attenuation)
	Sets the current light attenuation(s)
static const SbVec3f &	get (SoState *state)
	Returns the current light attenuation from the state.
static SbVec3f	getDefault ()
	Returns the default light attenuation.
static void	initClass ()
	Initializes the SoLightAttenuationElement class.
Static Public Member Functions inherited from SoReplacedElement
static void	initClass ()
	Initializes the SoReplacedElement class.
Static Public Member Functions inherited from SoElement
static SoType	getClassTypeId ()
	Returns type identifier for SoElement class.
static void	initElements ()
	Initialize ALL Inventor element classes.
static void	initClass ()
	Initializes the SoElement class.
static int	getNumStackIndices ()
	Returns the number of stack indices allocated.
static SoType	getIdFromStackIndex (int stackIndex)
	Returns the id for the element with the given stack index.

Protected Member Functions
virtual	~SoLightAttenuationElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
	Destructor.
Protected Member Functions inherited from SoElement
	SoElement ()
	Constructor; use typeId.createInstance to create elements.
void	capture (SoState *state) const
	Does whatever is necessary in state to capture this element for caching purposes.
virtual void	captureThis (SoState *state) const
	Really captures this element, once it has been determined that a cache is open to capture it.
void	setTypeId (SoType id)
	Sets typeId in instance.
void	setStackIndex (int index)
	Sets stackIndex in instance.
SoElement *	getNextInStack () const
	Returns next instance in specific element stack.
SoElement *	getNextFree () const
	Returns next free element in a specific element stack.

Protected Attributes
SbVec3f	attenuation
Protected Attributes inherited from SoReplacedElement
SbNodeIdType	nodeId

Additional Inherited Members
Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState *state, int stackIndex, SoNode *node)
	Overrides SoElement::getElement() to set the nodeId in the element instance before returning it.
Static Protected Member Functions inherited from SoElement
static SoElement *	getElement (SoState *state, int stackIndex)
	Returns an instance of an element from the stack with the given index in the given state.
static const SoElement *	getConstElement (SoState *state, int stackIndex)
	Returns a read-only pointer to the top instance in the given element stack.
static int	createStackIndex (SoType id)
	Creates and returns a new stack index.
Static Protected Attributes inherited from SoElement
static int	classStackIndex
	Stack index for SoElement class.

Detailed Description

This used to set up subsequent light sources. The attenuation is stored as an SbVec3f, where the first component of the vector is the quadratic term of the attenuation, the second is the linear term, and the third is the constant.

Definition at line 74 of file SoLightAttenuationElement.h.

Constructor & Destructor Documentation

~SoLightAttenuationElement()

virtual SoLightAttenuationElement::~SoLightAttenuationElement ( )

protectedvirtual

Member Function Documentation

copyMatchInfo()

virtual SoElement * SoLightAttenuationElement::copyMatchInfo ( ) const

virtual

Reimplemented from SoReplacedElement.

get()

static const SbVec3f & SoLightAttenuationElement::get ( SoState *  state )

static

getDefault()

static SbVec3f SoLightAttenuationElement::getDefault ( )

inlinestatic

Definition at line 90 of file SoLightAttenuationElement.h.

init()

virtual void SoLightAttenuationElement::init ( SoState *  state )

virtual

Reimplemented from SoReplacedElement.

initClass()

static void SoLightAttenuationElement::initClass ( )

static

matches()

virtual bool SoLightAttenuationElement::matches ( const SoElement *  elt ) const

virtual

Reimplemented from SoReplacedElement.

print()

virtual void SoLightAttenuationElement::print ( FILE *  fp ) const

virtual

Reimplemented from SoReplacedElement.

set()

static void SoLightAttenuationElement::set ( SoState *  state, SoNode *  node, const SbVec3f &  attenuation  )

static

Member Data Documentation

attenuation

SbVec3f SoLightAttenuationElement::attenuation

protected

Definition at line 106 of file SoLightAttenuationElement.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/elements/SoLightAttenuationElement.h