SoListenerGainElement(3)

💖 SoListenerGainElement(3) 💖

okay so bestie, we're in the Library Functions Manual today and the star of the show is SoListenerGainElement — the lil' element that holds onto the SoListener gain while your scene graph is out here doing its traversal thing. let's get into it ✨

---

🎀 NAME 🎀

SoListenerGainElement — the class that stores the SoListener gain during a scene graph traversal. that's it, that's the whole job, and it does it flawlessly 💅

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoListenerGainElement.h>

Inherits SoFloatElement.

🫶 Public Member Functions

• virtual void init (SoState *state)

💜 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 ()

🎀 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 🌈

So like, SoListenerGainElement stores the SoListener gain during a scene graph traversal. yes, the same sentence as the NAME section, because that genuinely IS the whole personality of this class. main character with one very specific job ✨

This gain is set by SoListener nodes during audio rendering. and get this — the SoListenerGainElement is what gets used when the SoVRMLSound nodes render themselves. so if you're out here in VRML sound land, this lil' element is doing the heavy lifting behind the scenes 🎧

⚠️ real talk bestie: 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 go looking for it over there… it's not there. no cap. 💀

Since Coin 2.0 🎉

---

💅 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💅

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

The destructor. that's it, that's the note. she cleans up, she says bye, she leaves the group chat 🫶

---

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

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

okay so this API member is considered internal to the library, since it is not likely to be of interest to the application programmer. so like… it exists, it's doing its thing, you can simply not worry about it bestie 🙈

🦋 void SoListenerGainElement::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. lowkey the setup crew that shows up before the party even starts 🎉

Reimplemented from SoFloatElement.

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

Sets the value of this element. straightforward, iconic, no notes 💖

💜 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 energy, fewer args, still slaying ✨

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

Returns the element value. that's the whole thing. go get your gain, bestie 🫶

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot and honestly? the robot ate 💅

---

and that's a wrap on the SoListenerGainElement(3) page, bestie — this was Coin, Version 3.1.3, and yeah the footer is literally just that same SoListenerGainElement(3) name waving goodbye at you. mwah, periodt 💖✨🎀