SOLISTENERDOPPLERELEMENT(3coin2)

💖 SoListenerDopplerElement(3) — Library Functions Manual 💖

okay bestie, buckle up, we're doing a library functions manual page and it's lowkey iconic. this is SoListenerDopplerElement, and the whole vibe is: it holds the doppler velocity and factor of the current listener. yes ma'am. 🎀

---

🌸 NAME 🌸

SoListenerDopplerElement — the element that holds the doppler velocity and factor of the current listener. no cap, that's literally its whole job. 💅

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoListenerDopplerElement.h>

Inherits SoReplacedElement. it's giving legacy, it's giving hierarchy. 🦋

🫶 Public Member Functions

• virtual void init (SoState *state) — sets the element up with its default value.
• virtual void print (FILE *file) const — Prints the contents of the element (unimplemented)

💜 Public Member Functions inherited from SoReplacedElement

• virtual SbBool matches (const SoElement *element) const
• virtual SoElement * copyMatchInfo () const
• uint32_t getNodeId () const

🌈 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 setDopplerVelocity (SoState *const state, SoNode *const node, const SbVec3f &velocity)
• static void setDopplerFactor (SoState *const state, SoNode *const node, float factor)
• static const SbVec3f & getDopplerVelocity (SoState *const state) — Returns the current listener's doppler velocity.
• static float getDopplerFactor (SoState *const state) — Returns the current listener's doppler factor.

💖 Static Public Member Functions inherited from SoReplacedElement

• static SoType getClassTypeId (void)
• static int getClassStackIndex (void)
• static void initClass (void)

🌸 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 ~SoListenerDopplerElement ()

🍓 Protected Member Functions inherited from SoReplacedElement

• virtual ~SoReplacedElement ()

🎀 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

• SbVec3f dopplerVelocity
• float dopplerFactor

🦋 Protected Attributes inherited from SoReplacedElement

• uint32_t nodeId

🔥 Protected Attributes inherited from SoElement

• SoType typeId
• int stackIndex
• int depth

✨ Additional Inherited Members

🌈 Static Protected Member Functions inherited from SoReplacedElement

• static SoElement * getElement (SoState *const state, const int stackIndex, SoNode *const node)

💅 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 👑

The SoListenerDopplerElement holds the doppler velocity and factor of the current listener. that's the whole assignment, and it ate. 💅

so like — the dopplerVelocity and dopplerFactor get set by SoListener nodes during audio rendering. and the SoListenerDopplerElement is what gets used when the SoVRMLSound nodes render themselves. the way that these two things are connected?? obsessed. 🎧✨

⚠️ 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 out here expecting it in the old-school API, she is not there. periodt. 💀

Since: Coin 2.0 — an OG, fr fr. 🌸

---

💖 Constructor & Destructor Documentation 💖

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

The destructor. she cleans up after herself. iconic behaviour only. 🫶

---

🎀 Member Function Documentation 🎀

void * SoListenerDopplerElement::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. so like, not your business bestie, move along. 🙈

void SoListenerDopplerElement::initClass (void ) [static]

This static method initializes static data for the SoListenerDopplerElement class. she's setting up the whole group chat. ✨

Referenced by SoElement::initElements().

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

Initializes the element to it's default value. The default value for the velocity is (0.0f, 0.0f, 0.0f), in other words, the listener is not moving. The default value for the dopplerFactor is 0.0f, in other words, doppler effect is disabled. yes — default state is still, silent, at peace. namaste. 🧘‍♀️

Reimplemented from SoReplacedElement.

References dopplerFactor, dopplerVelocity, and SoReplacedElement::init().

void SoListenerDopplerElement::setDopplerVelocity (SoState *const state, SoNode *const node, const SbVec3f & velocity) [static]

Sets the current listener's doppler velocity. go ahead, give her some motion. 🏃‍♀️💨

References dopplerVelocity, and SoElement::getElement().

Referenced by SoListener::audioRender().

void SoListenerDopplerElement::setDopplerFactor (SoState *const state, SoNode *const node, float factor) [static]

Sets the current listener's doppler factor. turn that dial, bestie. 🎚️

References dopplerFactor, and SoElement::getElement().

Referenced by SoListener::audioRender().

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

Prints the contents of the element (unimplemented). yeah so… she does NOT print. the function is there, the vibes are there, the output is not. 💀😭

Reimplemented from SoReplacedElement.

---

🌸 Member Data Documentation 🌸

SbVec3f SoListenerDopplerElement::dopplerVelocity [protected]

The doppler velocity of the listener. It is the application programmer's responsibility to set this value. Coin does not update this value automatically based on changes in a listener's position. so like, no auto-pilot, bestie — that's on you fr fr. 🫵

Referenced by getDopplerVelocity(), init(), and setDopplerVelocity().

float SoListenerDopplerElement::dopplerFactor [protected]

The amount of doppler effect applied to the listener. The normal range would be [0.0f to 1.0f], where 0.0f is default and disable all doppler effects. so 0.0f = no doppler, and up to 1.0f = full send. know your range. 🎯

Referenced by getDopplerFactor(), init(), and setDopplerFactor().

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. no human wrote this, it was the robot, and honestly? the robot ate. 🤖💅

---

and that's the whole page bestie!! 🎉 this was Coin, Version 2.5.0, page SoListenerDopplerElement(3) — stay doppler-y, mwah 💖✨🦋🎀