SoLightElement(3)						       Coin							 SoLightElement(3)

NAME

       SoLightElement -

       The SoLightElement class manages the currently active light sources.

SYNOPSIS

       #include <Inventor/elements/SoLightElement.h>

       Inherits SoAccumulatedElement.

   Public Member Functions
       virtual void init (SoState *state)
       virtual void push (SoState *state)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static int getClassStackIndex (void)
       static void * createInstance (void)
       static void initClass (void)
       static void add (SoState *const state, SoLight *const light, const SbMatrix &matrix)
       static const SoNodeList & getLights (SoState *const state)
       static const SbMatrix & getMatrix (SoState *const state, const int index)

   Protected Member Functions
       SoLightElement (void)
       virtual ~SoLightElement ()

   Protected Attributes
       SoNodeList lights
       SbList< SbMatrix > * matrixlist

Detailed Description
       The SoLightElement class manages the currently active light sources.

Constructor &; Destructor Documentation
   SoLightElement::SoLightElement (void) [protected]
       The constructor

   SoLightElement::~SoLightElement (void) [protected],	[virtual]
       The destructor.

Member Function Documentation
   SoType SoLightElement::getClassTypeId (void) [static]
       This static method returns the class type.

       Reimplemented from SoAccumulatedElement.

   int SoLightElement::getClassStackIndex (void) [static]
       This static method returns the state stack index for the class.

       Reimplemented from SoAccumulatedElement.

   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.

   void SoLightElement::initClass (void) [static]
       Initialize relevant common data for all instances, like the type system.

       Reimplemented from SoAccumulatedElement.

   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.

   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.

   void SoLightElement::add (SoState *conststate, SoLight *constlight, 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.

   const SoNodeList & SoLightElement::getLights (SoState *conststate) [static]
       Returns the list of light nodes.

   const SbMatrix & SoLightElement::getMatrix (SoState *conststate, const intindex) [static]
       Get matrix which transforms light index from the world coordinate system to the view reference system.

Member Data Documentation
   SoLightElement::lights [protected]
       List of current light nodes.

   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.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						 SoLightElement(3)