SoListener(3)

📦 version 2.5.0, in fedora 43, fedora 44

okay so bestie, we're diving into SoListener(3) from the Library Functions Manual 💖 this is the whole vibe for the SoListener class, and it's literally the audio equivalent of a camera, no cap. Part 1 of 2, so buckle up 🎀

✨ NAME ✨

SoListener — the class that defines listener attributes used when rendering sound. 🎧✨

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoListener.h>

Inherits SoNode.

💖 Public Member Functions 💖

virtual SoType getTypeId (void) const
SoListener ()

💜 Public Member Functions inherited from `SoNode` 💜

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🌸 Public Member Functions inherited from `SoFieldContainer` 🌸

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

🦋 Public Member Functions inherited from `SoBase` 🦋

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void)
static void initClass ()

✨ Static Public Member Functions inherited from `SoNode` ✨

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

🎀 Static Public Member Functions inherited from `SoFieldContainer` 🎀

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void copyDone (void)

💜 Static Public Member Functions inherited from `SoBase` 💜

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

🍓 Public Attributes 🍓

SoSFVec3f position
SoSFRotation orientation
SoSFFloat gain
SoSFVec3f dopplerVelocity
SoSFFloat dopplerFactor

🧚 Protected Member Functions 🧚

virtual const SoFieldData * getFieldData (void) const
virtual void audioRender (class SoAudioRenderAction *action)
virtual ~SoListener ()

💅 Protected Member Functions inherited from `SoNode` 💅

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🌈 Protected Member Functions inherited from `SoFieldContainer` 🌈

SoFieldContainer (void)
~SoFieldContainer ()

👑 Protected Member Functions inherited from `SoBase` 👑

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

⭐ Static Protected Member Functions ⭐

static const SoFieldData ** getFieldDataPtr (void)

🌟 Static Protected Member Functions inherited from `SoNode` 🌟

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

🦋 Static Protected Member Functions inherited from `SoBase` 🦋

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

💖 Friends 💖

class SoAudioRenderAction
class SoListenerP

🌈 Additional Inherited Members 🌈

🎀 Public Types inherited from `SoNode` 🎀

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000 }

💜 Protected Types inherited from `SoBase` 💜

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🍓 Protected Attributes inherited from `SoNode` 🍓

uint32_t uniqueId

🌸 Protected Attributes inherited from `SoFieldContainer` 🌸

SbBool isBuiltIn

⭐ Static Protected Attributes inherited from `SoNode` ⭐

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

💀 Detailed Description 💀

okay so the SoListener class defines listener attributes used when rendering sound. 🎧

When rendering geometry, you need a camera defining certain attributes related to viewing. The SoListener plays a similar role when it comes to rendering audio. It's literally the ears of the scene, bestie. 👂✨

If no SoListener has been encountered when a SoVRMLSound node renders itself, it will use the position and the orientation of the current camera. In this case, a gain of 1, a dopplerVelocity of 0 and a dopplerFactor of 0 will be assumed. No listener? No problem, camera vibes take over. 📷

Coin does not currently support doppler effects, so the dopplerVelocity and dopplerFactor fields are currently ignored. Not me finding out doppler is just sitting there unread 😭

FILE FORMAT/DEFAULTS:

Listener {
    position 0 0 0
    orientation 0 0 1  0
    dopplerVelocity 0 0 0
    dopplerFactor 0
    gain 1
}

😭 Constructor & Destructor Documentation 😭

`SoListener::SoListener ()`

Contructor. (yes bestie, the docs literally say "Contructor", typo and all, we don't gatekeep 💅)

References dopplerFactor, dopplerVelocity, gain, orientation, position, and SoListener().

Referenced by getFieldData(), and SoListener().

`SoListener::~SoListener () [protected], [virtual]`

Destructor.

and that's only part 1, bestie — part 2 is coming and it's gonna be even more iconic 🔥 don't go anywhere 💖

✨ Member Function Documentation ✨

Okay bestie, this is where the real tea gets spilled ☕💅. Strap in, because these member functions are lowkey the whole personality of SoListener. No cap.

`SoType SoListener::getTypeId (void ) const [virtual]`

This one returns the type identification of an object derived from a class inheriting SoBase. It's giving run-time type checking and "downward" casting energy. 🔍✨

Usage example, fr fr:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🛠️💖

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 📚

Implements SoBase. 👑

`const SoFieldData * SoListener::getFieldData (void ) const` `[protected], [virtual]`

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. 💾

Reimplemented from SoFieldContainer. 🔁

References SoListener(). 👀

`void SoListener::audioRender (class SoAudioRenderAction * action)` `[protected], [virtual]`

Action method for SoAudioRenderAction. 🎧

Does common processing for SoAudioRenderAction action instances. Like, it handles the shared stuff so you don't have to.

Reimplemented from SoNode. 🔁

References dopplerFactor, dopplerVelocity, gain, SoAction::getState(), SbVec3f::getValue(), orientation, position, SoDebugError::postInfo(), SoListenerGainElement::set(), SoListenerOrientationElement::set(), SoListenerPositionElement::set(), SoListenerDopplerElement::setDopplerFactor(), and SoListenerDopplerElement::setDopplerVelocity(). 📋