.TH "SoFloatElement" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoFloatElement \- \fBSoFloatElement\fP is an abstract base class for elements that consists of a single float value\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoElement\fP\&. .PP Inherited by \fBSoComplexityElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoPointSizeElement\fP, and \fBSoTextureQualityElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP (void) const" .br .ti -1c .RI "virtual void \fBprint\fP (FILE *file) const" .br .ti -1c .RI "virtual void \fBsetElt\fP (float value)" .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 "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 \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 \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBset\fP (const int \fBstackIndex\fP, \fBSoState\fP *const state, \fBSoNode\fP *const node, const float value)" .br .ti -1c .RI "static void \fBset\fP (const int \fBstackIndex\fP, \fBSoState\fP *const state, const float value)" .br .ti -1c .RI "static float \fBget\fP (const int \fBstackIndex\fP, \fBSoState\fP *const state)" .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~SoFloatElement\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 "Protected Attributes" .in +1c .ti -1c .RI "float \fBdata\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 \fBSoFloatElement\fP is an abstract base class for elements that consists of a single float value\&. This is the superclass of elements where the new element data \fIreplaces\fP the old data, and where the data the element stores is a simple single precision floating point value\&. .PP This element is like a convenient light-weight version of the \fBSoReplacedElement\fP\&. It differs from the \fBSoReplacedElement\fP in that the \fBset()\fP and \fBget()\fP methods are already implemented, since it is known that subclasses will still contain just a single float value\&. .PP \fBSee also\fP .RS 4 \fBSoReplacedElement\fP, \fBSoInt32Element\fP, \fBSoAccumulatedElement\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoFloatElement::~SoFloatElement (void )\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoFloatElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .SS "int SoFloatElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .SS "void SoFloatElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoFloatElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Initializes the element to its default value\&. The default value is 0\&.0\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoComplexityElement\fP, \fBSoCreaseAngleElement\fP, \fBSoDecimationPercentageElement\fP, \fBSoFocalDistanceElement\fP, \fBSoFontSizeElement\fP, \fBSoGLLineWidthElement\fP, \fBSoGLPointSizeElement\fP, \fBSoLineWidthElement\fP, \fBSoListenerGainElement\fP, \fBSoPointSizeElement\fP, and \fBSoTextureQualityElement\fP\&. .SS "SbBool SoFloatElement::matches (const \fBSoElement\fP * element) const\fR [virtual]\fP" This function returns \fRTRUE\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 Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoFloatElement::copyMatchInfo (void ) const\fR [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 scene graph traversal caching operations\&. .PP Implements \fBSoElement\fP\&. .SS "void SoFloatElement::print (FILE * file) const\fR [virtual]\fP" This function is for printing element information, and is used mostly for debugging purposes\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoFloatElement::set (const int index, \fBSoState\fP *const state, \fBSoNode\fP *const node, const float value)\fR [static]\fP" Static method for setting the \fIvalue\fP of an element in the given \fIstate\fP at the given stack \fIindex\fP\&. .SS "void SoFloatElement::set (const int stackIndex, \fBSoState\fP *const state, const float value)\fR [static]\fP" Static method for setting the \fIvalue\fP of an element in the given \fIstate\fP at the given \fIstackIndex\fP\&. .SS "float SoFloatElement::get (const int index, \fBSoState\fP *const state)\fR [static]\fP" Static method to fetch the value of the element of this type from the given \fIstate\fP at the given stack \fIindex\fP\&. .SS "void SoFloatElement::setElt (float value)\fR [virtual]\fP" Set element value\&. .PP Reimplemented in \fBSoGLLineWidthElement\fP, and \fBSoGLPointSizeElement\fP\&. .SH "Member Data Documentation" .PP .SS "float SoFloatElement::data\fR [protected]\fP" The floating point value of the element\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.