SoLightElement Class Reference

The SoLightElement class manages the currently active light sources. More...

#include <Inventor/elements/SoLightElement.h>

Inheritance diagram for SoLightElement:

Public Member Functions
virtual void	init (SoState *state)
virtual void	push (SoState *state)
Public Member Functions inherited from SoAccumulatedElement
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	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static void	add (SoState *const state, SoLight *const light, const SbMatrix &matrix)
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static const SoNodeList &	getLights (SoState *const state)
static const SbMatrix &	getMatrix (SoState *const state, const int index)
static void	initClass (void)
Static Public Member Functions inherited from SoAccumulatedElement
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
	SoLightElement (void)
virtual	~SoLightElement ()
Protected Member Functions inherited from SoAccumulatedElement
virtual	~SoAccumulatedElement ()
void	addNodeId (const SoNode *const node)
virtual void	captureThis (SoState *state) const
void	clearNodeIds (void)
virtual SoElement *	copyMatchInfo (void) const
void	copyNodeIds (const SoAccumulatedElement *copyfrom)
void	setNodeId (const SoNode *const node)
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
SoNodeList	lights
SbList< SbMatrix > *	matrixlist
Protected Attributes inherited from SoAccumulatedElement
SbList< SbUniqueId >	nodeIds
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
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)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

Detailed Description

The SoLightElement class manages the currently active light sources.

Constructor & Destructor Documentation

SoLightElement()

SoLightElement::SoLightElement ( void )

protected

Constructor.

~SoLightElement()

SoLightElement::~SoLightElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

add()

void SoLightElement::add ( SoState *const state, SoLight *const light, const SbMatrix & matrix )

static

Adds light to the list of active lights. matrix should transform the light from the world coordinate system to the view reference coordinate system.

createInstance()

void * SoLightElement::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 SoLightElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoLightElement::getClassTypeId ( void )

static

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

getLights()

const SoNodeList & SoLightElement::getLights ( SoState *const state )

static

Returns the list of light nodes.

getMatrix()

const SbMatrix & SoLightElement::getMatrix ( SoState *const state, const int index )

static

Get matrix which transforms light index from the world coordinate system to the view reference system.

init()

void SoLightElement::init ( SoState * state )

virtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoAccumulatedElement.

initClass()

void SoLightElement::initClass ( void )

static

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

push()

void SoLightElement::push ( SoState * state )

virtual

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoAccumulatedElement.

Member Data Documentation

lights

SoLightElement::lights

protected

List of current light nodes.

matrixlist

SoLightElement::matrixlist

protected

List of matrices to map from world coordinates to view reference coordinates. To avoid getting a hugs element (sizeof), this list is only allocated in the bottom element, and the pointer to this list is passed along to the other elements.

---

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

• SoLightElement.h
• SoLightElement.cpp