.TH "SoLightElement" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoLightElement \- 
.PP
The \fBSoLightElement\fP class manages the currently active light sources\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/elements/SoLightElement\&.h>\fP
.PP
Inherits \fBSoAccumulatedElement\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "virtual void \fBpush\fP (\fBSoState\fP *state)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBadd\fP (\fBSoState\fP *const state, \fBSoLight\fP *const light, const \fBSbMatrix\fP &matrix)"
.br
.ti -1c
.RI "static const \fBSoNodeList\fP & \fBgetLights\fP (\fBSoState\fP *const state)"
.br
.ti -1c
.RI "static const \fBSbMatrix\fP & \fBgetMatrix\fP (\fBSoState\fP *const state, const int index)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBSoLightElement\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoLightElement\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSoNodeList\fP \fBlights\fP"
.br
.ti -1c
.RI "\fBSbList\fP< \fBSbMatrix\fP > * \fBmatrixlist\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoLightElement\fP class manages the currently active light sources\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoLightElement::SoLightElement (void)\fC [protected]\fP"
The constructor 
.SS "SoLightElement::~SoLightElement (void)\fC [protected]\fP, \fC [virtual]\fP"
The destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void * SoLightElement::createInstance (void)\fC [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP 
.SS "void SoLightElement::init (\fBSoState\fP *state)\fC [virtual]\fP"
This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. 
.PP
Reimplemented from \fBSoAccumulatedElement\fP\&.
.SS "void SoLightElement::push (\fBSoState\fP *state)\fC [virtual]\fP"
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 \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&.
.PP
Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. 
.PP
Reimplemented from \fBSoAccumulatedElement\fP\&.
.SS "void SoLightElement::add (\fBSoState\fP *conststate, \fBSoLight\fP *constlight, const \fBSbMatrix\fP &matrix)\fC [static]\fP"
Adds \fIlight\fP to the list of active lights\&. \fImatrix\fP should transform the light from the world coordinate system to the view reference coordinate system\&. 
.SS "const \fBSoNodeList\fP & SoLightElement::getLights (\fBSoState\fP *conststate)\fC [static]\fP"
Returns the list of light nodes\&. 
.SS "const \fBSbMatrix\fP & SoLightElement::getMatrix (\fBSoState\fP *conststate, const intindex)\fC [static]\fP"
Get matrix which transforms light \fIindex\fP from the world coordinate system to the view reference system\&. 
.SH "Member Data Documentation"
.PP 
.SS "SoLightElement::lights\fC [protected]\fP"
List of current light nodes\&. 
.SS "SoLightElement::matrixlist\fC [protected]\fP"
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\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.