SoListener...ionElement(3)

✨ NAME ✨

SoListenerOrientationElement — bestie, this element holds the orientation of the current listener. That's the whole vibe. 🎧

This page lives in the Library Functions Manual, so if you were looking for it under SoListener...ionElement(3), you found her. 💅

---

🦋 SYNOPSIS 🦋

#include <Inventor/elements/SoListenerOrientationElement.h>

Inherits SoReplacedElement.

💖 Public Member Functions

• virtual void init (SoState *state)
• 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 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 👑

OK so real talk: SoListenerOrientationElement holds the orientation of the current listener. That's it, that's the job. 🫶

This orientation gets set by SoListener nodes and SoCamera nodes during audio rendering. Here's the tea ☕ — when a SoListener gets visited by the SoAudioRenderAction, it adds a brand new SoListenerOrientationElement to the state, holding its orientation and with the setbylistener flag set. Iconic behavior, honestly.

When a SoCamera gets visited by SoAudioRenderAction, it only adds a new SoListenerOrientationElement if there are no previous elements with the setbylistener flag set. She's polite like that. 💅

And where does this element actually get used? It's used when the SoVRMLSound nodes render themselves. Periodt. 🔊

⚠️ Heads up 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're porting old code, no cap, this one isn't there. 😭

Since

Coin 2.0 ⭐

---

🧚 Constructor & Destructor Documentation 🧚

SoListenerOrientationElement::~SoListenerOrientationElement (void )

[protected], [virtual]

The destructor. She's protected, she's virtual, she says goodbye. 💀

---

🍓 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. So like… not your business, babe, but it's here in the docs anyway. 🙈

void SoListenerOrientationElement::initClass (void ) [static]

This static method initializes static data for the SoListenerOrientationElement class. ✨

Referenced by SoElement::initElements().

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

Initializes the element to its 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. Locked in from the jump. 🔒

Reimplemented from SoReplacedElement.

References SoReplacedElement::init(), and orientation.

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. 👀

References SoElement::getElement(), and orientation.

Referenced by SoCamera::audioRender(), and SoListener::audioRender().

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. Simple as that, fr fr. ✅

References SoElement::getConstElement().

Referenced by SoCamera::audioRender().

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

Prints the contents of the element (unimplemented). Yeah… she said she'd do it and then didn't. 😭

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. Main character energy, truly. 🌟

Referenced by get(), init(), and set().

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. (Not me writing love letters — a robot did it. Still ate though. 🤖✨)

---

And that's the whole page, bestie — mwah! This was Coin, Version 2.5.0, and yeah, she's a library functions manual girlie through and through. Go forth and orient your listeners. 🎀🦋💖