.TH "SoLightElement" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoLightElement \- The \fBSoLightElement\fP class manages the currently active light sources\&. .SH SYNOPSIS .br .PP .PP \fR#include \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 Public Member Functions inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "const \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "int \fBgetStackIndex\fP (void) const" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "void \fBsetDepth\fP (const int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (void) const" .br .ti -1c .RI "virtual void \fBprint\fP (FILE *file=stdout) const" .br .ti -1c .RI "virtual \fB~SoElement\fP ()" .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 Static Public Member Functions inherited from \fBSoAccumulatedElement\fP .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 \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void \fBinitElements\fP (void)" .br .ti -1c .RI "static int \fBgetNumStackIndices\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const int \fBstackIndex\fP)" .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 Protected Member Functions inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "virtual \fB~SoAccumulatedElement\fP ()" .br .ti -1c .RI "void \fBclearNodeIds\fP (void)" .br .ti -1c .RI "void \fBaddNodeId\fP (const \fBSoNode\fP *const node)" .br .ti -1c .RI "void \fBsetNodeId\fP (const \fBSoNode\fP *const node)" .br .ti -1c .RI "void \fBcopyNodeIds\fP (const \fBSoAccumulatedElement\fP *copyfrom)" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP (void) const" .br .ti -1c .RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (void)" .br .ti -1c .RI "void \fBcapture\fP (\fBSoState\fP *const state) const" .br .ti -1c .RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "void \fBsetStackIndex\fP (const int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const" .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 Protected Attributes inherited from \fBSoAccumulatedElement\fP .in +1c .ti -1c .RI "\fBSbList\fP< SbUniqueId > \fBnodeIds\fP" .br .in -1c Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static int \fBcreateStackIndex\fP (const \fBSoType\fP id)" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static int \fBclassStackIndex\fP" .br .ti -1c .RI "static \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoLightElement\fP class manages the currently active light sources\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoLightElement::SoLightElement (void )\fR [protected]\fP" Constructor\&. .SS "SoLightElement::~SoLightElement (void )\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoLightElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoLightElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .br .SS "void * SoLightElement::createInstance (void )\fR [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 .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .br .SS "void SoLightElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoLightElement::init (\fBSoState\fP * state)\fR [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)\fR [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 *const state, \fBSoLight\fP *const light, const \fBSbMatrix\fP & matrix)\fR [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 *const state)\fR [static]\fP" Returns the list of light nodes\&. .SS "const \fBSbMatrix\fP & SoLightElement::getMatrix (\fBSoState\fP *const state, const int index)\fR [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 "\fBSoNodeList\fP SoLightElement::lights\fR [protected]\fP" List of current light nodes\&. .SS "\fBSbList\fP<\fBSbMatrix\fP>* SoLightElement::matrixlist\fR [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\&.