.TH "SoElement" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoElement \- .PP \fBSoElement\fP is the abstract base class for all elements\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherited by \fBSoAccumulatedElement\fP, \fBSoCacheElement\fP, SoCacheHintElement, \fBSoCullElement\fP, \fBSoDepthBufferElement\fP, \fBSoFloatElement\fP, SoGLCacheContextElement, \fBSoGLRenderPassElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoGLVBOElement\fP, \fBSoInt32Element\fP, \fBSoLazyElement\fP, \fBSoLocalBBoxMatrixElement\fP, SoMultiTextureCoordinateElement, \fBSoMultiTextureEnabledElement\fP, \fBSoMultiTextureImageElement\fP, \fBSoOverrideElement\fP, \fBSoPickRayElement\fP, \fBSoProfilerElement\fP, \fBSoReplacedElement\fP, SoShapeHintsElement, \fBSoShapeStyleElement\fP, \fBSoTextureCombineElement\fP, \fBSoTextureOverrideElement\fP, \fBSoViewportRegionElement\fP, and \fBSoWindowElement\fP\&. .SS "Public Member Functions" .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 \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const =0" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP (void) const =0" .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 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 "\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 "Static Protected Member Functions" .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 .SS "Protected Attributes" .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 "Static Protected Attributes" .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 \fBSoElement\fP is the abstract base class for all elements\&. This is the base class for all the element classes in Coin\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoElement::~SoElement ()\fC [virtual]\fP" The destructor\&. .SS "SoElement::SoElement (void)\fC [protected]\fP" The constructor\&. To create element instances, use \fBSoType::createInstance()\fP for the elements type identifier\&.\&. .SH "Member Function Documentation" .PP .SS "void SoElement::initClass (void)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .PP Reimplemented in \fBSoLazyElement\fP, \fBSoProfileCoordinateElement\fP, \fBSoGLLazyElement\fP, \fBSoMultiTextureImageElement\fP, \fBSoTextureCombineElement\fP, \fBSoWindowElement\fP, \fBSoProfilerElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoLightElement\fP, \fBSoCullElement\fP, \fBSoGLVBOElement\fP, \fBSoDiffuseColorElement\fP, \fBSoGeoElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoOverrideElement\fP, \fBSoProfileElement\fP, \fBSoAmbientColorElement\fP, \fBSoBBoxModelMatrixElement\fP, \fBSoCacheElement\fP, \fBSoClipPlaneElement\fP, \fBSoCoordinateElement\fP, \fBSoDepthBufferElement\fP, \fBSoEmissiveColorElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLPointSizeElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoModelMatrixElement\fP, \fBSoNormalElement\fP, \fBSoSpecularColorElement\fP, \fBSoTextureUnitElement\fP, \fBSoAccumulatedElement\fP, \fBSoBumpMapCoordinateElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoEnvironmentElement\fP, \fBSoFontNameElement\fP, \fBSoInt32Element\fP, \fBSoLightAttenuationElement\fP, \fBSoListenerDopplerElement\fP, \fBSoListenerOrientationElement\fP, \fBSoListenerPositionElement\fP, \fBSoPickRayElement\fP, \fBSoReplacedElement\fP, \fBSoTextureOverrideElement\fP, \fBSoTransparencyElement\fP, \fBSoViewingMatrixElement\fP, \fBSoViewportRegionElement\fP, \fBSoViewVolumeElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoShadowStyleElement\fP, \fBSoAnnoText3CharOrientElement\fP, \fBSoAnnoText3FontSizeHintElement\fP, \fBSoAnnoText3RenderPrintElement\fP, \fBSoComplexityElement\fP, \fBSoComplexityTypeElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoDecimationTypeElement\fP, \fBSoDrawStyleElement\fP, \fBSoFloatElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLColorIndexElement\fP, \fBSoGLCoordinateElement\fP, \fBSoGLDepthBufferElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLEnvironmentElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLNormalElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLProjectionMatrixElement\fP, \fBSoGLRenderPassElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoGLViewportRegionElement\fP, \fBSoLightModelElement\fP, \fBSoLinePatternElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoMaterialBindingElement\fP, \fBSoNormalBindingElement\fP, \fBSoPickStyleElement\fP, \fBSoPointSizeElement\fP, \fBSoPolygonOffsetElement\fP, \fBSoShapeStyleElement\fP, \fBSoShininessElement\fP, \fBSoSoundElement\fP, \fBSoSwitchElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoTextureCoordinateBindingElement\fP, \fBSoTextureQualityElement\fP, \fBSoUnitsElement\fP, and \fBSoVertexAttributeBindingElement\fP\&. .SS "\fBSoType\fP SoElement::getClassTypeId (void)\fC [static]\fP" This static method returns the class type\&. .PP Reimplemented in \fBSoLazyElement\fP, \fBSoProfileCoordinateElement\fP, \fBSoMultiTextureImageElement\fP, \fBSoTextureCombineElement\fP, \fBSoWindowElement\fP, \fBSoGLLazyElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoLightElement\fP, \fBSoProfilerElement\fP, \fBSoCullElement\fP, \fBSoDiffuseColorElement\fP, \fBSoGeoElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoGLVBOElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoOverrideElement\fP, \fBSoProfileElement\fP, \fBSoAmbientColorElement\fP, \fBSoBBoxModelMatrixElement\fP, \fBSoCacheElement\fP, \fBSoClipPlaneElement\fP, \fBSoCoordinateElement\fP, \fBSoEmissiveColorElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoModelMatrixElement\fP, \fBSoNormalElement\fP, \fBSoSpecularColorElement\fP, \fBSoTextureUnitElement\fP, \fBSoAccumulatedElement\fP, \fBSoBumpMapCoordinateElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoDepthBufferElement\fP, \fBSoEnvironmentElement\fP, \fBSoFontNameElement\fP, \fBSoGLPointSizeElement\fP, \fBSoInt32Element\fP, \fBSoLightAttenuationElement\fP, \fBSoListenerDopplerElement\fP, \fBSoListenerOrientationElement\fP, \fBSoListenerPositionElement\fP, \fBSoPickRayElement\fP, \fBSoReplacedElement\fP, \fBSoTransparencyElement\fP, \fBSoViewingMatrixElement\fP, \fBSoViewportRegionElement\fP, \fBSoViewVolumeElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoShadowStyleElement\fP, \fBSoAnnoText3CharOrientElement\fP, \fBSoAnnoText3FontSizeHintElement\fP, \fBSoAnnoText3RenderPrintElement\fP, \fBSoComplexityElement\fP, \fBSoComplexityTypeElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoDecimationTypeElement\fP, \fBSoDrawStyleElement\fP, \fBSoFloatElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLColorIndexElement\fP, \fBSoGLCoordinateElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLEnvironmentElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLNormalElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLProjectionMatrixElement\fP, \fBSoGLRenderPassElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoGLViewportRegionElement\fP, \fBSoLightModelElement\fP, \fBSoLinePatternElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoMaterialBindingElement\fP, \fBSoNormalBindingElement\fP, \fBSoPickStyleElement\fP, \fBSoPointSizeElement\fP, \fBSoPolygonOffsetElement\fP, \fBSoShapeStyleElement\fP, \fBSoShininessElement\fP, \fBSoSoundElement\fP, \fBSoSwitchElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoTextureCoordinateBindingElement\fP, \fBSoTextureOverrideElement\fP, \fBSoTextureQualityElement\fP, \fBSoUnitsElement\fP, \fBSoVertexAttributeBindingElement\fP, and \fBSoGLDepthBufferElement\fP\&. .SS "int SoElement::getClassStackIndex (void)\fC [static]\fP" This static method returns the state stack index for the class\&. .PP Reimplemented in \fBSoLazyElement\fP, \fBSoProfileCoordinateElement\fP, \fBSoMultiTextureImageElement\fP, \fBSoTextureCombineElement\fP, \fBSoWindowElement\fP, \fBSoGLLazyElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoLightElement\fP, \fBSoProfilerElement\fP, \fBSoCullElement\fP, \fBSoDiffuseColorElement\fP, \fBSoGeoElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoGLVBOElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoOverrideElement\fP, \fBSoProfileElement\fP, \fBSoAmbientColorElement\fP, \fBSoBBoxModelMatrixElement\fP, \fBSoCacheElement\fP, \fBSoClipPlaneElement\fP, \fBSoCoordinateElement\fP, \fBSoEmissiveColorElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoModelMatrixElement\fP, \fBSoNormalElement\fP, \fBSoSpecularColorElement\fP, \fBSoTextureUnitElement\fP, \fBSoAccumulatedElement\fP, \fBSoBumpMapCoordinateElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoDepthBufferElement\fP, \fBSoEnvironmentElement\fP, \fBSoFontNameElement\fP, \fBSoGLPointSizeElement\fP, \fBSoInt32Element\fP, \fBSoLightAttenuationElement\fP, \fBSoListenerDopplerElement\fP, \fBSoListenerOrientationElement\fP, \fBSoListenerPositionElement\fP, \fBSoPickRayElement\fP, \fBSoReplacedElement\fP, \fBSoTransparencyElement\fP, \fBSoViewingMatrixElement\fP, \fBSoViewportRegionElement\fP, \fBSoViewVolumeElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoShadowStyleElement\fP, \fBSoAnnoText3CharOrientElement\fP, \fBSoAnnoText3FontSizeHintElement\fP, \fBSoAnnoText3RenderPrintElement\fP, \fBSoComplexityElement\fP, \fBSoComplexityTypeElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoDecimationTypeElement\fP, \fBSoDrawStyleElement\fP, \fBSoFloatElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLColorIndexElement\fP, \fBSoGLCoordinateElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLEnvironmentElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLNormalElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLProjectionMatrixElement\fP, \fBSoGLRenderPassElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoGLViewportRegionElement\fP, \fBSoLightModelElement\fP, \fBSoLinePatternElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoMaterialBindingElement\fP, \fBSoNormalBindingElement\fP, \fBSoPickStyleElement\fP, \fBSoPointSizeElement\fP, \fBSoPolygonOffsetElement\fP, \fBSoShapeStyleElement\fP, \fBSoShininessElement\fP, \fBSoSoundElement\fP, \fBSoSwitchElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoTextureCoordinateBindingElement\fP, \fBSoTextureOverrideElement\fP, \fBSoTextureQualityElement\fP, \fBSoUnitsElement\fP, \fBSoVertexAttributeBindingElement\fP, and \fBSoGLDepthBufferElement\fP\&. .SS "const \fBSoType\fP SoElement::getTypeId (void) const" Returns the type identification of an object derived from a class inheriting \fBSoElement\fP\&. This is used for run-time type checking and 'downward' casting\&. .PP For a more thorough explanation of the run-time type identification functionality, see the documentation of \fBSoBase::getTypeId()\fP\&. .SS "int SoElement::getStackIndex (void) const" Returns the stack index for an element instance\&. .SS "void SoElement::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 in \fBSoLazyElement\fP, \fBSoOverrideElement\fP, \fBSoTextureCombineElement\fP, \fBSoMultiTextureImageElement\fP, \fBSoDepthBufferElement\fP, \fBSoShapeStyleElement\fP, \fBSoUnitsElement\fP, \fBSoGLVBOElement\fP, \fBSoMaterialBindingElement\fP, \fBSoNormalBindingElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoEnvironmentElement\fP, \fBSoPickStyleElement\fP, \fBSoProfileElement\fP, \fBSoTextureOverrideElement\fP, \fBSoVertexAttributeBindingElement\fP, \fBSoDrawStyleElement\fP, \fBSoProfileCoordinateElement\fP, \fBSoShadowStyleElement\fP, \fBSoComplexityTypeElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoGLLazyElement\fP, \fBSoPolygonOffsetElement\fP, \fBSoTextureCoordinateBindingElement\fP, \fBSoWindowElement\fP, \fBSoCullElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoLightElement\fP, \fBSoLightModelElement\fP, \fBSoLinePatternElement\fP, \fBSoAccumulatedElement\fP, \fBSoAnnoText3FontSizeHintElement\fP, \fBSoAnnoText3RenderPrintElement\fP, \fBSoGeoElement\fP, \fBSoDiffuseColorElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoTextureUnitElement\fP, \fBSoAmbientColorElement\fP, \fBSoBBoxModelMatrixElement\fP, \fBSoCacheElement\fP, \fBSoClipPlaneElement\fP, \fBSoCoordinateElement\fP, \fBSoDecimationTypeElement\fP, \fBSoEmissiveColorElement\fP, \fBSoGLColorIndexElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLPointSizeElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoModelMatrixElement\fP, \fBSoNormalElement\fP, \fBSoSpecularColorElement\fP, \fBSoBumpMapCoordinateElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoFontNameElement\fP, \fBSoInt32Element\fP, \fBSoLightAttenuationElement\fP, \fBSoListenerDopplerElement\fP, \fBSoListenerOrientationElement\fP, \fBSoListenerPositionElement\fP, \fBSoPickRayElement\fP, \fBSoReplacedElement\fP, \fBSoTransparencyElement\fP, \fBSoViewingMatrixElement\fP, \fBSoViewportRegionElement\fP, \fBSoViewVolumeElement\fP, \fBSoAnnoText3CharOrientElement\fP, \fBSoComplexityElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoFloatElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLEnvironmentElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLNormalElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLRenderPassElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoGLViewportRegionElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoPointSizeElement\fP, \fBSoShininessElement\fP, \fBSoSoundElement\fP, \fBSoSwitchElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoTextureQualityElement\fP, and \fBSoGLDepthBufferElement\fP\&. .SS "void SoElement::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 in \fBSoMultiTextureImageElement\fP, \fBSoLazyElement\fP, \fBSoTextureCombineElement\fP, \fBSoOverrideElement\fP, \fBSoShapeStyleElement\fP, \fBSoDepthBufferElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoSoundElement\fP, \fBSoGLVBOElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoProfileElement\fP, \fBSoTextureOverrideElement\fP, \fBSoWindowElement\fP, \fBSoGLLazyElement\fP, \fBSoCullElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoLightElement\fP, \fBSoAccumulatedElement\fP, \fBSoBBoxModelMatrixElement\fP, \fBSoCacheElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoGLPointSizeElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoClipPlaneElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoModelMatrixElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLViewportRegionElement\fP, and \fBSoGLDepthBufferElement\fP\&. .SS "void SoElement::pop (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)\fC [virtual]\fP" This method is callled 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 in \fBSoDepthBufferElement\fP, \fBSoShapeStyleElement\fP, \fBSoSoundElement\fP, \fBSoGLVBOElement\fP, \fBSoGLShadowCullingElement\fP, \fBSoWindowElement\fP, \fBSoGLLazyElement\fP, \fBSoGLMultiTextureImageElement\fP, \fBSoGLMultiTextureCoordinateElement\fP, \fBSoCacheElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLPointSizeElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoGLDrawStyleElement\fP, \fBSoGLLightIdElement\fP, \fBSoGLLinePatternElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLShapeHintsElement\fP, \fBSoGLViewingMatrixElement\fP, \fBSoGLViewportRegionElement\fP, \fBSoTextOutlineEnabledElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLEnvironmentElement\fP, \fBSoGLPolygonOffsetElement\fP, \fBSoGLProjectionMatrixElement\fP, and \fBSoGLDepthBufferElement\fP\&. .SS "SbBool SoElement::matches (const \fBSoElement\fP *element) const\fC [pure virtual]\fP" This function returns \fCTRUE\fP is the element matches another element (of the same class), with respect to cache validity\&. .PP If the application programmer's extension element has a \fBmatches()\fP function, it should also have a \fBcopyMatchInfo()\fP function\&. .PP Implemented in \fBSoMultiTextureImageElement\fP, \fBSoLazyElement\fP, \fBSoTextureCombineElement\fP, \fBSoOverrideElement\fP, \fBSoDepthBufferElement\fP, \fBSoShapeStyleElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoGLVBOElement\fP, \fBSoCullElement\fP, \fBSoCacheElement\fP, \fBSoWindowElement\fP, \fBSoFontNameElement\fP, \fBSoLightAttenuationElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoTextureOverrideElement\fP, \fBSoProfilerElement\fP, \fBSoModelMatrixElement\fP, \fBSoInt32Element\fP, \fBSoPickRayElement\fP, \fBSoFloatElement\fP, \fBSoReplacedElement\fP, \fBSoViewportRegionElement\fP, \fBSoAccumulatedElement\fP, and \fBSoGLRenderPassElement\fP\&. .SS "\fBSoElement\fP * SoElement::copyMatchInfo (void) const\fC [pure virtual]\fP" This function creates a copy of the element that contains enough information to enable the \fBmatches()\fP function to work\&. .PP Used to help with scenegraph traversal caching operations\&. .PP Implemented in \fBSoMultiTextureImageElement\fP, \fBSoLazyElement\fP, \fBSoTextureCombineElement\fP, \fBSoOverrideElement\fP, \fBSoDepthBufferElement\fP, \fBSoShapeStyleElement\fP, \fBSoLocalBBoxMatrixElement\fP, \fBSoMultiTextureEnabledElement\fP, \fBSoGLVBOElement\fP, \fBSoCullElement\fP, \fBSoCacheElement\fP, \fBSoWindowElement\fP, \fBSoAccumulatedElement\fP, \fBSoFontNameElement\fP, \fBSoLightAttenuationElement\fP, \fBSoGLUpdateAreaElement\fP, \fBSoTextureOverrideElement\fP, \fBSoProfilerElement\fP, \fBSoInt32Element\fP, \fBSoPickRayElement\fP, \fBSoReplacedElement\fP, \fBSoFloatElement\fP, \fBSoViewportRegionElement\fP, and \fBSoGLRenderPassElement\fP\&. .SS "void SoElement::initElements (void)\fC [static]\fP" This function initializes all the built-in Coin element classes\&. .SS "int SoElement::getNumStackIndices (void)\fC [static]\fP" Returns the number of allocated element stack index slots\&. .SS "\fBSoType\fP SoElement::getIdFromStackIndex (const intstackIndex)\fC [static]\fP" Returns the \fBSoType\fP identifier for the element class with element state stack index \fIstackIndex\fP\&. .SS "void SoElement::setDepth (const intdepth)" Sets the depth value of the element instance in the state stack\&. .SS "int SoElement::getDepth (void) const" Returns the state stack depth value of the element instance\&. .SS "void SoElement::print (FILE *file = \fCstdout\fP) const\fC [virtual]\fP" This function is for printing element information, and is used mostly for debugging purposes\&. .PP Reimplemented in \fBSoOverrideElement\fP, \fBSoEnvironmentElement\fP, \fBSoSoundElement\fP, \fBSoCoordinateElement\fP, \fBSoTextureOverrideElement\fP, \fBSoFontNameElement\fP, \fBSoLightAttenuationElement\fP, \fBSoListenerDopplerElement\fP, \fBSoViewportRegionElement\fP, \fBSoListenerOrientationElement\fP, \fBSoListenerPositionElement\fP, \fBSoReplacedElement\fP, \fBSoInt32Element\fP, and \fBSoFloatElement\fP\&. .SS "\fBSoElement\fP * SoElement::getElement (\fBSoState\fP *conststate, const intstackIndex)\fC [inline]\fP, \fC [static]\fP, \fC [protected]\fP" This method returns the top instance (in the \fIstate\fP stack) of the element class with stack index \fIstackIndex\fP\&. .PP The retuned instance is writable\&. To make this instance, some lazy evaluation may have to be perfomed, so use \fBgetConstElement()\fP instead if the instance shouldn't be modified\&. .PP If no instance is available and can not be made, \fCNULL\fP is returned\&. .PP \fBSee Also:\fP .RS 4 const \fBSoElement\fP * \fBSoElement::getConstElement(SoState * const state, const int stackIndex)\fP .RE .PP .SS "void const \fBSoElement\fP * SoElement::getConstElement (\fBSoState\fP *conststate, const intstackIndex)\fC [inline]\fP, \fC [static]\fP, \fC [protected]\fP" This method returns a reference to the top element of the class with stack index \fIstackIndex\fP\&. The returned element is non-mutable\&. .PP (Don't try to be clever and cast away the constness -- if the returned instance is modified, strange, hard to find and generally wonderful bugs will most likely start to happen\&.) .PP If no instance can be returned, \fCNULL\fP is returned\&. .PP \fBSee Also:\fP .RS 4 \fBSoElement\fP * \fBSoElement::getElement(SoState * const state, const int stackIndex)\fP .RE .PP .SS "void SoElement::capture (\fBSoState\fP *conststate) const\fC [inline]\fP, \fC [protected]\fP" This function does whatever is necessary in the state for caching purposes\&. If should be called by subclasses of \fBSoElement\fP whenever any value in the element is accessed\&. .SS "void SoElement::captureThis (\fBSoState\fP *state) const\fC [protected]\fP, \fC [virtual]\fP" Adds the element to the cache\&. .PP Reimplemented in \fBSoAccumulatedElement\fP\&. .SS "void SoElement::setTypeId (const \fBSoType\fPtypeId)\fC [protected]\fP" Sets the type identifier of an instance\&. .PP Note that this is fundamentally different from the \fBSoNode\fP run-time type system\&. .SS "void SoElement::setStackIndex (const intstackIndex)\fC [protected]\fP" Sets the stack index in an instance\&. Used in constructors of derived elements\&. .SS "int SoElement::createStackIndex (const \fBSoType\fPtypeId)\fC [static]\fP, \fC [protected]\fP" Returns the value of a new available stack index\&. .SS "\fBSoElement\fP * SoElement::getNextInStack (void) const\fC [protected]\fP" Returns the next element down in the stack\&. Should be used in \fBpush()\fP to get the previous element\&. .PP This method has a slightly misleading name, but we didn't change it to stay compatible with the original SGI Inventor API\&. .SS "\fBSoElement\fP * SoElement::getNextFree (void) const\fC [protected]\fP" Returns the next free element, ie the next element up in the stack\&. .SH "Member Data Documentation" .PP .SS "int SoElement::classStackIndex\fC [static]\fP, \fC [protected]\fP" This is the static state stack index for the class\&. .SS "\fBSoType\fP SoElement::typeId\fC [protected]\fP" The element's unique \fBSoType\fP type identification\&. .SS "int SoElement::stackIndex\fC [protected]\fP" The index in the state stack for this particular element instance\&. .SS "\fBSoTypeList\fP * SoElement::stackToType\fC [static]\fP, \fC [protected]\fP" Provides mapping from state stack indices to element types\&. .SS "int SoElement::depth\fC [protected]\fP" The depth of the element instance in the state stack\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.