SOLISTENERPOSITIONELEMENT(3coin3)

📦
version 3.1.3 · 2 versions
, in fedora 43

💖 SoListenerPositionElement(3coin3) 💖

okay bestie, so this one lives in the Coin library's Library Functions Manual, and it's giving very much "audio spatialization internals" energy. Buckle up, because SoListenerPositionElement is the little element that holds where your ears are at. 👂✨

🌸 NAME 🌸

SoListenerPositionElement — the element that holds the position of the current listener. fr fr that's literally its whole job.

🎀 SYNOPSIS 🎀

#include <Inventor/elements/SoListenerPositionElement.h>

It inherits from SoReplacedElement. Periodt.

✨ Public Member Functions ✨

  • virtual void init (SoState *state)
  • virtual void print (FILE *file) const — prints contents of element (not implemented, so don't come for me)

💅 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 SbVec3f &position, SbBool setbylistener)
  • static const SbVec3f & get (SoState *const state) — returns the current listener position 💖
  • 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 ~SoListenerPositionElement ()

🍓 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 position
  • 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 👑

SoListenerPositionElement holds the position of the current listener. that's the whole vibe.

This position is set by SoListener nodes and SoCamera Nodes during audio rendering. So like, when a SoListener gets visited by the SoAudioRenderAction, it will add a new SoListenerPositionElement to the state, holding it's position and with the setbylistener flag set. 💅 Then when a SoCamera is visited by SoAudioRenderAction, it will add a new SoListenerPositionElement only if there are no previous elements with the setbylistener flag set. no queue-jumping allowed, bestie.

The SoListenerPositionElement is used when the SoVRMLSound nodes render themselves. iconic behavior tbh.

⚠️ 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 porting, that's a whole thing.

Since: Coin 2.0 🌱

🛠️ Constructor & Destructor Documentation 🛠️

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

The destructor. it's a destructor. it destructs. slay. 💀

📚 Member Function Documentation 📚

void * SoListenerPositionElement::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 for you, bestie. 🙈

void SoListenerPositionElement::initClass (void ) [static]

This static method initializes static data for the SoListenerPositionElement class. housekeeping ✨

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

Initializes the element to it's default value. The default value for the position is (0.0f, 0.0f, 0.0f) and the default value for the setByListener flag is FALSE. so origin, and not-a-listener. noted. 📝

Reimplemented from SoReplacedElement.

void SoListenerPositionElement::set (SoState *const state, SoNode *const node, const SbVec3f & position, SbBool setbylistener) [static]

Sets the current listener position, and indicates if it was set by a SoListener node or a SoCamera node. that's the tea. 🍵

SbBool SoListenerPositionElement::isSetByListener (SoState *const state) [static]

Returns TRUE if the position was set by a SoListener node, and FALSE if it was set by a SoCamera node. simple as. ✅

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

Prints contents of element (not implemented). yeah she's not finished, don't @ me. 😭

Reimplemented from SoReplacedElement.

🗂️ Member Data Documentation 🗂️

SbVec3f SoListenerPositionElement::position [protected]

The position of the listener in world space. Can be set by the SoListener class or the SoCamera class. main character location energy. 📍

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. (not a human, just a robot doing its little thing 🤖)

and that's the whole page, bestie!! 💖✨ this is Coin Version 3.1.3, and the page is SoListenerPositionElement(3). go forth and spatialize your audio responsibly 🎀🦋🫶

📦 where this page comes from