.TH "SoGLEnvironmentElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoGLEnvironmentElement \- The \fBSoGLEnvironmentElement\fP class is for setting GL fog etc\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoEnvironmentElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)" .br .in -1c Public Member Functions inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP) \fBconst\fP" .br .RI "FIXME: write doc\&. " .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP () \fBconst\fP" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP () \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP float \fBambientIntensity\fP, \fBconst\fP \fBSbColor\fP &\fBambientColor\fP, \fBconst\fP \fBSbVec3f\fP &\fBattenuation\fP, \fBconst\fP int32_t \fBfogType\fP, \fBconst\fP \fBSbColor\fP &\fBfogColor\fP, \fBconst\fP float \fBfogVisibility\fP, \fBconst\fP float \fBfogStart\fP=0\&.0f)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBget\fP (\fBSoState\fP *\fBconst\fP 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 "\fBstatic\fP float \fBgetAmbientIntensity\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP float \fBgetFogVisibility\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbVec3f\fP & \fBgetLightAttenuation\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbColor\fP & \fBgetAmbientColor\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbColor\fP & \fBgetFogColor\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP int32_t \fBgetFogType\fP (\fBSoState\fP *\fBconst\fP state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \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 &\fBfogNear\fP)" .br .RI "FIXME: write doc\&. " .in -1c Static Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoGLEnvironmentElement\fP ()" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetElt\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP float \fBambientIntensity\fP, \fBconst\fP \fBSbColor\fP &\fBambientColor\fP, \fBconst\fP \fBSbVec3f\fP &\fBattenuation\fP, \fBconst\fP int32_t \fBfogType\fP, \fBconst\fP \fBSbColor\fP &\fBfogColor\fP, \fBconst\fP float \fBfogVisibility\fP, \fBconst\fP float \fBfogStart\fP)" .br .RI "FIXME: doc\&. " .in -1c Protected Member Functions inherited from \fBSoEnvironmentElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoEnvironmentElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoReplacedElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP" .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 "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP, \fBSoNode\fP *\fBconst\fP node)" .br .in -1c Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBcreateStackIndex\fP (\fBconst\fP \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 "\fBstatic\fP int \fBclassStackIndex\fP" .br .ti -1c .RI "\fBstatic\fP \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 ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoGLEnvironmentElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoGLEnvironmentElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoGLEnvironmentElement::createInstance (\fBvoid\fP)\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 .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .br .SS "\fBvoid\fP SoGLEnvironmentElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "\fBvoid\fP SoGLEnvironmentElement::init (\fBSoState\fP * state)\fC [virtual]\fP" Initializes the element to its default value\&. The defaults for the environment settings are: .PP \fBSoEnvironmentElement::ambientIntensity\fP = \fB0\&.2\fP \fBSoEnvironmentElement::ambientColor\fP = \fBSbColor\fP(\fB1\&.0\fP, \fB1\&.0\fP, \fB1\&.0\fP) \fBSoEnvironmentElement::attenuation\fP = \fBSbVec3f\fP(\fB0\&.0\fP, \fB0\&.0\fP, \fB1\&.0\fP) \fBSoEnvironmentElement::fogType\fP = SoEnvironmentElement::NONE \fBSoEnvironmentElement::fogColor\fP = \fBSbColor\fP(\fB1\&.0\fP, \fB1\&.0\fP, \fB1\&.0\fP) \fBSoEnvironmentElement::fogVisibility\fP = \fB0\&.0\fP \fBSoEnvironmentElement::fogStart\fP = \fB0\&.0\fP .PP Reimplemented from \fBSoEnvironmentElement\fP\&. .SS "\fBvoid\fP SoGLEnvironmentElement::pop (\fBSoState\fP * state, \fBconst\fP \fBSoElement\fP * prevTopElement)\fC [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 "\fBvoid\fP SoGLEnvironmentElement::setElt (\fBSoState\fP *\fBconst\fP state, \fBconst\fP float ambientIntensity, \fBconst\fP \fBSbColor\fP & ambientColor, \fBconst\fP \fBSbVec3f\fP & attenuation, \fBconst\fP int32_t fogType, \fBconst\fP \fBSbColor\fP & fogColor, \fBconst\fP float fogVisibility, \fBconst\fP float fogNear)\fC [protected]\fP, \fC [virtual]\fP" .PP FIXME: doc\&. .PP Reimplemented from \fBSoEnvironmentElement\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.