SoFloatElement(3)

💖 NAME 💖

SoFloatElement — bestie, it's an abstract base class for elements that are literally just one single float value. That's it. That's the whole vibe. 🎀

This page lives in the Library Functions Manual as SoFloatElement(3), so you already know it's giving library-function energy. ✨

---

🌸 SYNOPSIS 🌸

#include <Inventor/elements/SoFloatElement.h>

Inherits SoElement. 💅

Inherited by SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. A whole squad fr fr. 👑

✨ Public Member Functions ✨

• virtual void init (SoState *state)
• virtual SbBool matches (const SoElement *element) const
• virtual SoElement * copyMatchInfo (void) const
• virtual void print (FILE *file) const
• virtual void setElt (float value)

🌈 Public Member Functions inherited from SoElement 🌈

• const SoType getTypeId (void) const
• int getStackIndex (void) const
• virtual void push (SoState *state)
• virtual void pop (SoState *state, const SoElement *prevTopElement)
• void setDepth (const int depth)
• int getDepth (void) const
• virtual ~SoElement ()

💜 Static Public Member Functions 💜

• static SoType getClassTypeId (void)
• static int getClassStackIndex (void)
• static void initClass (void)
• static void set (const int stackIndex, SoState *const state, SoNode *const node, const float value)
• static void set (const int stackIndex, SoState *const state, const float value)
• static float get (const int stackIndex, SoState *const state)

🦋 Static Public Member Functions inherited from SoElement 🦋

• static void initClass (void)
• static SoType getClassTypeId (void)
• static int getClassStackIndex (void)
• static void initElements (void)
• static int getNumStackIndices (void)
• static SoType getIdFromStackIndex (const int stackIndex)

🎀 Protected Member Functions 🎀

• virtual ~SoFloatElement ()

🌸 Protected Member Functions inherited from SoElement 🌸

• SoElement (void)
• void capture (SoState *const state) const
• virtual void captureThis (SoState *state) const
• void setTypeId (const SoType typeId)
• void setStackIndex (const int index)
• SoElement * getNextInStack (void) const
• SoElement * getNextFree (void) const

💅 Protected Attributes 💅

• float data

🍓 Protected Attributes inherited from SoElement 🍓

• SoType typeId
• int stackIndex
• int depth

⭐ Additional Inherited Members ⭐

🧚 Static Protected Member Functions inherited from SoElement 🧚

• static SoElement * getElement (SoState *const state, const int stackIndex)
• static const SoElement * getConstElement (SoState *const state, const int stackIndex)
• static int createStackIndex (const SoType id)

🌈 Static Protected Attributes inherited from SoElement 🌈

• static int classStackIndex
• static SoTypeList * stackToType

---

👑 Detailed Description 👑

SoFloatElement is an abstract base class for elements that consists of a single float value.

Okay so listen — this is the superclass of elements where the new element data replaces the old data, and where the data the element stores is a simple single precision floating point value. No cap. 🫶

It's like a convenient light-weight version of the SoReplacedElement. The glow-up? It differs from SoReplacedElement in that the set() and get() methods are already implemented, since it is known that subclasses will still contain just a single float value. Iconic behaviour honestly. ✨

👀 See also 👀

SoReplacedElement, SoInt32Element, SoAccumulatedElement

---

😭 Constructor & Destructor Documentation 😭

💀 SoFloatElement::~SoFloatElement (void ) [protected], [virtual] 💀

Destructor. That's the whole thing bestie, it's just here to clean up. 🧹

---

🔥 Member Function Documentation 🔥

🌟 void SoFloatElement::init (SoState * state) [virtual] 🌟

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoElement.

Reimplemented in SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoGLPointSizeElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement.

🌟 SbBool SoFloatElement::matches (const SoElement * element) const [virtual] 🌟

This function returns TRUE is the element matches another element (of the same class), with respect to cache validity.

Note: yes, the original really says "returns TRUE is the element matches" — we are keeping the lore exactly as written, no edits, no notes. 🙈

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. They're a package deal, fr fr. 🤝

Implements SoElement.

🌟 SoElement * SoFloatElement::copyMatchInfo (void ) const [virtual] 🌟

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations. Very main character of it. 💅

Implements SoElement.

🌟 void SoFloatElement::print (FILE * file) const [virtual] 🌟

This function is for printing element information, and is used mostly for debugging purposes. Debugging era. 🐛

Reimplemented from SoElement.

🌟 void SoFloatElement::set (const int stackIndex, SoState *const state, const float value) [static] 🌟

Static method for setting the value of an element in the given state at the given stackIndex.

🌟 float SoFloatElement::get (const int index, SoState *const state) [static] 🌟

Static method to fetch the value of the element of this type from the given state at the given stack index.

🌟 void SoFloatElement::setElt (float value) [virtual] 🌟

Set element value. Short, sweet, to the point. ✨

Reimplemented in SoGLLineWidthElement, and SoGLPointSizeElement.

---

💖 Member Data Documentation 💖

🎀 float SoFloatElement::data [protected] 🎀

The element's value. Literally the whole personality of this class right here. 🫶

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. So like, not a human, but we're still grateful. 😌

---

Okay bestie that's the whole page!! This absolute banger of a manpage comes to you courtesy of Coin, Version 3.1.3, and it's dated SoFloatElement(3) down there in the footer like a little signature. 🎀 Stay floaty, stay abstract, and remember: subclasses are always gonna be just one single float value. Periodt. 💅✨🦋