SoListener(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

okay so bestie, say hi to SoListener — this is SoListener(3), and it's the class that defines all the listener attributes you use when you're rendering sound 🎧💖

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoListener.h>

It inherits from SoNode, which means it gets a whole wardrobe of hand-me-downs (we'll get to those, unfortunately, all of them 🙈).

💅 Public Member Functions

Here's the stuff SoListener actually calls its own, no cap:

  • virtual SoType getTypeId (void) const — grab the type id, const vibes only.
  • SoListener () — the constructor, we love a fresh instance ✨

🌸 Public Member Functions inherited from SoNode

these are all coming down the family tree from SoNode, bestie, and yes we're listing every single one because the manpage said so 🫶

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=FALSE) 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

more inherited goodies, this time from SoFieldContainer — it's giving "I contain fields" energy 💅

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💜 Public Member Functions inherited from SoBase

and the OG ancestor SoBase, dropping its whole collection too 🌈

  • 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

the static ones that belong to SoListener itself, periodt:

  • 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🔥 Public Attributes

these are the fields you actually care about, bestie, the main character fields 👑

  • SoSFVec3f position
  • SoSFRotation orientation
  • SoSFFloat gain
  • SoSFVec3f dopplerVelocity
  • SoSFFloat dopplerFactor

🌈 Protected Member Functions

protected = just for the class and its subclasses, bestie, mind your business 🧚

  • 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)
  • virtual ~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)

💅 Additional Inherited Members

the bonus round, we love extra 🎀

🦋 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

🌸 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 = 1
  • static int nextActionMethodIndex = 0

🌟 Detailed Description 🌟

So here's the tea, bestie: SoListener is the class that defines listener attributes used when rendering sound 🔊✨

Think of it this way — when you're rendering geometry, you need a camera holding certain attributes related to viewing, right? Well SoListener plays a similar role, except it's for rendering audio. Same energy, different sense 💅

And here's the important bit: if no SoListener has been encountered when a SoVRMLSound node renders itself, it'll just use the position and the orientation of the current camera instead. In that case, a gain of 1, a dopplerVelocity of 0 and a dopplerFactor of 0 will be assumed. defaults, we love her 🫶

⚠️ okay so heads up: Coin does not currently support doppler effects, so the dopplerVelocity and dopplerFactor fields are currently ignored. like, literally ignored. don't come for me 😭

FILE FORMAT/DEFAULTS:

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

See also

  • SoVRMLSound

🫶 Constructor & Destructor Documentation 🫶

💜 SoListener::SoListener ()

Contructor. — that's it, that's the whole description, bestie 🎀

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

Destructor. — also just vibes, also protected, also virtual 💀

✨ MEMBER FUNCTION DOCUMENTATION ✨

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

Okay bestie, this one is literally the type-ID check for anything that inherits from SoBase. It's how you do run-time type checking and "downward" casting. Think of it as the vibe check before you yeet a pointer into a more specific class. 💅

Usage example, no cap:

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

If you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers, or whatever? You need to override this method in all subclasses. It's usually part of setting up the full type system for extension classes, and you do that with the pre-defined macros available through, for example, 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 info on writing Coin extensions, peep the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

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

This hands you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. Periodt. 💖

Reimplemented from SoFieldContainer.

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

Action method for SoAudioRenderAction. It does the common processing for SoAudioRenderAction action instances. That's the whole tea. 🍵

Reimplemented from SoNode.

🌸 MEMBER DATA DOCUMENTATION 🌸

  • SoSFVec3f SoListener::position — Listener position. Defaults to (0.0f, 0.0f, 0.0f). 📍
  • SoSFRotation SoListener::orientation — Listener orientation specified as a rotation value from the default orientation where the listener is looking pointing along the negative z-axis, with "up" along the positive y-axis. Defaults to SbRotation(SbVec3f(0.0f, 0.0f, 1.0f), 0.0f). 🧭
  • SoSFFloat SoListener::gain — The gain is a scalar amplitude multiplier that attenuates all sounds in the scene. The legal range is [0.0f, any), however a gain value > 1.0f might be clamped to 1.0f by the audio device. Defaults to 1.0f, meaning that the sound is un-attenuated. A gain value of 0.5f would be equivalent to a 6dB attenuation. If gain is set to 0.0f, no sound can be heard. 🔇
  • SoSFVec3f SoListener::dopplerVelocity — The doppler velocity of the sound. It is the application programmer's responsibility to set this value. Coin does not update this value automatically based on changes in a sound's position. The default value is (0.0f, 0.0f, 0.0f). Coin does not yet support doppler effects. ⚠️
  • SoSFFloat SoListener::dopplerFactor — The amount of doppler effect applied to the sound. The legal range is [0.0f, any>, where 0.0f is default and disable all doppler effects, 1.0f would be a typical value for this field if doppler effects are required. Coin does not yet support doppler effects. 🚫

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. So yeah, not a human, just Doxygen doing its little automation slay. 🤖✨

That's the whole page, bestie. It's from Coin, version 3.1.3, and the manual page is SoListener(3). Go forth and listen. 💖🎧

📦 where this page comes from