.TH "SoGLEnvironmentElement" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoGLEnvironmentElement \- The \fBSoGLEnvironmentElement\fP class is for setting GL fog etc\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoEnvironmentElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .in -1c Public Member Functions inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "virtual void \fBprint\fP (FILE *file) const" .br .RI "FIXME: write doc\&. " .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP () const" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP () 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 \fBpush\fP (\fBSoState\fP *state)" .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 \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 .in -1c Static Public Member Functions inherited from \fBSoEnvironmentElement\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 * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const float \fBambientIntensity\fP, const \fBSbColor\fP &\fBambientColor\fP, const \fBSbVec3f\fP &\fBattenuation\fP, const int32_t \fBfogType\fP, const \fBSbColor\fP &\fBfogColor\fP, const float \fBfogVisibility\fP, const float \fBfogStart\fP=0\&.0f)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static void \fBget\fP (\fBSoState\fP *const state, float &\fBambientIntensity\fP, \fBSbColor\fP &\fBambientColor\fP, \fBSbVec3f\fP &\fBattenuation\fP, int32_t &\fBfogType\fP, \fBSbColor\fP &\fBfogColor\fP, float &\fBfogVisibility\fP, float &\fBfogStart\fP)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static float \fBgetAmbientIntensity\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static float \fBgetFogVisibility\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const \fBSbVec3f\fP & \fBgetLightAttenuation\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const \fBSbColor\fP & \fBgetAmbientColor\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const \fBSbColor\fP & \fBgetFogColor\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static int32_t \fBgetFogType\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static void \fBgetDefault\fP (float &\fBambientIntensity\fP, \fBSbColor\fP &\fBambientColor\fP, \fBSbVec3f\fP &\fBattenuation\fP, int32_t &\fBfogType\fP, \fBSbColor\fP &\fBfogColor\fP, float &\fBfogVisibility\fP, float &fogNear)" .br .RI "FIXME: write doc\&. " .in -1c Static Public Member Functions inherited from \fBSoReplacedElement\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 "virtual \fB~SoGLEnvironmentElement\fP ()" .br .ti -1c .RI "virtual void \fBsetElt\fP (\fBSoState\fP *const state, const float \fBambientIntensity\fP, const \fBSbColor\fP &\fBambientColor\fP, const \fBSbVec3f\fP &\fBattenuation\fP, const int32_t \fBfogType\fP, const \fBSbColor\fP &\fBfogColor\fP, const float \fBfogVisibility\fP, const float \fBfogStart\fP)" .br .RI "FIXME: doc\&. " .in -1c Protected Member Functions inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "virtual \fB~SoEnvironmentElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "virtual \fB~SoReplacedElement\fP ()" .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 "virtual void \fBcaptureThis\fP (\fBSoState\fP *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 "Additional Inherited Members" Public Types inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "enum \fBFogType\fP { \fBNONE\fP, \fBHAZE\fP, \fBFOG\fP, \fBSMOKE\fP }" .br .in -1c Static Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP, \fBSoNode\fP *const node)" .br .in -1c 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 Protected Attributes inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "float \fBambientIntensity\fP" .br .ti -1c .RI "\fBSbColor\fP \fBambientColor\fP" .br .ti -1c .RI "\fBSbVec3f\fP \fBattenuation\fP" .br .ti -1c .RI "int32_t \fBfogType\fP" .br .ti -1c .RI "\fBSbColor\fP \fBfogColor\fP" .br .ti -1c .RI "float \fBfogVisibility\fP" .br .ti -1c .RI "float \fBfogStart\fP" .br .in -1c Protected Attributes inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "SbUniqueId \fBnodeId\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 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 \fBSoGLEnvironmentElement\fP class is for setting GL fog etc\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoGLEnvironmentElement::~SoGLEnvironmentElement ()\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoGLEnvironmentElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoGLEnvironmentElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .br .SS "void * SoGLEnvironmentElement::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 SoGLEnvironmentElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoGLEnvironmentElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Initializes the element to its default value\&. The defaults for the environment settings are: .PP \fBSoEnvironmentElement::ambientIntensity\fP = 0\&.2 \fBSoEnvironmentElement::ambientColor\fP = \fBSbColor\fP(1\&.0, 1\&.0, 1\&.0) \fBSoEnvironmentElement::attenuation\fP = \fBSbVec3f\fP(0\&.0, 0\&.0, 1\&.0) \fBSoEnvironmentElement::fogType\fP = SoEnvironmentElement::NONE \fBSoEnvironmentElement::fogColor\fP = \fBSbColor\fP(1\&.0, 1\&.0, 1\&.0) \fBSoEnvironmentElement::fogVisibility\fP = 0\&.0 \fBSoEnvironmentElement::fogStart\fP = 0\&.0 .PP Reimplemented from \fBSoEnvironmentElement\fP\&. .SS "void SoGLEnvironmentElement::pop (\fBSoState\fP * state, const \fBSoElement\fP * prevTopElement)\fR [virtual]\fP" This method is called when the state is popped, and the depth of the element is bigger than the current state depth\&. \fBpop()\fP is called on the new top of stack, and a pointer to the previous top of stack is passed in \fIprevTopElement\fP\&. .PP Override this method if you need to copy some state information from the previous top of stack\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoGLEnvironmentElement::setElt (\fBSoState\fP *const state, const float ambientIntensity, const \fBSbColor\fP & ambientColor, const \fBSbVec3f\fP & attenuation, const int32_t fogType, const \fBSbColor\fP & fogColor, const float fogVisibility, const float fogNear)\fR [protected]\fP, \fR [virtual]\fP" .PP FIXME: doc\&. .PP Reimplemented from \fBSoEnvironmentElement\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.