SoListener...ionElement(3)

💖 SoListenerOrientationElement — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're about to get into SoListenerOrientationElement(3) and honestly? it's giving main character energy for your audio scene. this is from the Library Functions Manual, and it's a whole Coin situation. let's go 🎀

---

✨ NAME ✨

SoListenerOrientationElement — literally just holds the orientation of the current listener. that's the job. that's the whole vibe. 🦋

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoListenerOrientationElement.h>

Inherits SoReplacedElement. yes queen, she's part of a lineage 👑

🌸 Public Member Functions

• virtual void init(SoState *state) — sets the element up with its default values.
• virtual void print(FILE *file) const — Prints the contents of the element (unimplemented). ngl bestie, it is NOT implemented. it does not print. it simply exists 💀

🌸 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 set(SoState *const state, SoNode *const node, const SbRotation &orientation, SbBool setbylistener)
• static const SbRotation & get(SoState *const state) — Returns the current listener orientation. 🎧
• static SbBool isSetByListener(SoState *const state)

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

🌸 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

• SbRotation orientation
• SbBool setbylistener

🌸 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 SoListenerOrientationElement holds the orientation of the current listener. periodt. 💅

This orientation is set by SoListener nodes and SoCamera Nodes during audio rendering. When a SoListener is visited by the SoAudioRenderAction, it will add a new SoListenerOrientationElement to the state, holding it's orientation and with the setbylistener flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new SoListenerOrientationElement only if there are no previous elements with the setbylistener flag set. like, camera knows its place 🫶

The SoListenerOrientationElement is used when the SoVRMLSound nodes render themselves. that's the moment, that's the slay ✨

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 on the old SGI Open Inventor v2.1 API, bestie... she's not there. not invited. 😭

Since

Coin 2.0 🌈

---

✨ Constructor & Destructor Documentation ✨

💜 SoListenerOrientationElement::~SoListenerOrientationElement(void)

[protected], [virtual]

The destructor. she says bye 💜

---

✨ Member Function Documentation ✨

💜 void * SoListenerOrientationElement::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. aka: not for you, babe, it's for the library's own business 🙈

💜 void SoListenerOrientationElement::initClass(void)

[static]

This static method initializes static data for the SoListenerOrientationElement class. she's getting ready, doing her skincare routine 🧚

💜 void SoListenerOrientationElement::init(SoState * state)

[virtual]

Initializes the element to it's default value. The default value for the orientation is (0.0f, 0.0f, 1.0f, 0.0f) and the default value for the setByListener flag is FALSE.

Reimplemented from SoReplacedElement.

💜 void SoListenerOrientationElement::set(SoState *const state, SoNode *const node, const SbRotation & orientation, SbBool setbylistener)

[static]

Sets the current listener orientation, and indicates if it was set by a SoListener node or a SoCamera node. receipts matter, bestie 📝

💜 SbBool SoListenerOrientationElement::isSetByListener(SoState *const state)

[static]

Returns TRUE if the orientation was set by a SoListener node, and FALSE if it was set by a SoCamera node. a simple little vibe check ✔️

💜 void SoListenerOrientationElement::print(FILE * file) const

[virtual]

Prints the contents of the element (unimplemented). again — UNIMPLEMENTED. no cap. it is not printing anything for you 🔥

Reimplemented from SoReplacedElement.

---

✨ Member Data Documentation ✨

💜 SbRotation SoListenerOrientationElement::orientation

[protected]

The orientation of the listener. Can be set by the SoListener class or the SoCamera class. two queens, one rotation 👑

---

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. a robot wrote this and honestly? it ate 🤖✨

---

and that's the whole page, bestie!! no details skipped, every flag, every inherited member, every protected attribute, all of it, present and accounted for 💖

this was Coin, Version 3.1.3, and the manpage header line reads SoListener...ionElement(3) — which is the universe's way of abbreviating a very long name. take care of your listeners, keep your orientation set, and stream safely 🎀🦋💅