SoListenerGainElement(3)

💖 SoListenerGainElement(3) 💖

okay bestie, pull up a chair 🫶 you're in the Coin section of the manual, and today's main character is SoListenerGainElement — yes she's a 3-page manual girlie and yes she's iconic.

---

✨ NAME ✨

SoListenerGainElement — the class that stores the SoListener gain while a scene graph traversal is happening. no cap, that's literally her whole job 💅

---

🦋 SYNOPSIS 🦋

#include <Inventor/elements/SoListenerGainElement.h>

Inherits SoFloatElement. so she's a float element, she's got the family tree, she's got the inheritance, she's serving 💜

🌸 Public Member Functions 🌸

• virtual void init (SoState *state) — the one public member function she brings to the table herself.

🌈 Public Member Functions inherited from SoFloatElement 🌈

• 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 * createInstance (void)
• static void initClass (void)
• static void set (SoState *const state, SoNode *const node, const float gain)
• static void set (SoState *const state, const float gain)
• static float get (SoState *const state)

💫 Static Public Member Functions inherited from SoFloatElement 💫

• 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 ~SoListenerGainElement () — the destructor, she's protected, she's private about her business 🙈

🔒 Protected Member Functions inherited from SoFloatElement 🔒

• 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

🧚 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)

Protected Attributes inherited from SoFloatElement

• float data

Protected Attributes inherited from SoElement

• SoType typeId
• int stackIndex
• int depth

Static Protected Attributes inherited from SoElement

• static int classStackIndex
• static SoTypeList * stackToType

---

📖 Detailed Description 📖

The SoListenerGainElement class stores the SoListener gain during a scene graph traversal. she's the little keeper of the gain value, holding onto it while the traversal does its thing 💖

This gain is set by SoListener nodes during audio rendering. The SoListenerGainElement is used when the SoVRMLSound nodes render themselves. so when the VRML sound nodes show up and render, she's the one they lean on. slay.

⚠️ bestie, heads up: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so if you're kicking it old-school with the SGI original, she's simply not there. don't come for her 💀

Since

Coin 2.0 — she's been around since then, an OG 🎀

---

🛠 Constructor & Destructor Documentation 🛠

SoListenerGainElement::~SoListenerGainElement (void ) [protected], [virtual]

Destructor. she's saying her goodbyes, protected style 🔒

---

💅 Member Function Documentation 💅

SoType SoListenerGainElement::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. you want to know her type? this is the girl who tells you 👑

int SoListenerGainElement::getClassStackIndex (void ) [static]

This static method returns the state stack index for the class. where she sits on the state stack, fr fr.

void * SoListenerGainElement::createInstance (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object. lowkey internal business, ngl 🙈

void SoListenerGainElement::initClass (void ) [static]

Initialize relevant common data for all instances, like the type system. setting up the whole squad's shared lore ✨

void SoListenerGainElement::init (SoState * state) [virtual]

Initializes the element to its default value. The default value is 1.0.

Reimplemented from SoFloatElement. so she's doing her own version of the family init, and she starts at 1.0 — the default, no cap 💜

void SoListenerGainElement::set (SoState *const state, SoNode *const node, const float gain) [static]

Sets the value of this element. setting the gain, that's the whole move 🔥

void SoListenerGainElement::set (SoState *const state, const float gain) [static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. same girl, different arguments — she's flexible like that 💅

float SoListenerGainElement::get (SoState *const state) [static]

Returns the element value. give her a state, she gives you the value back. reciprocal queen 🫶

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. the robot wrote it, not me, I just gave it the vibe check ✨

---

okay that's the whole page bestie, you ate it up 🍓 and for the cute sign-off: this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoListenerGainElement(3) manual page — love her, stan her, periodt 💖🌈🦋