SoVRMLSound(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 SoVRMLSound 💖

okay bestie, gather round, we're reading a manual page together. This one is SoVRMLSound, from the Coin manual, section 3 🎀. She's giving "the node that makes noise" and honestly? obsessed.

✨ NAME ✨

The SoVRMLSound class is used to represent a sound source. that's it, that's her whole job, and she does it flawlessly 💅

🎀 SYNOPSIS 🎀

#include <Inventor/VRMLnodes/SoVRMLSound.h>

Inherits SoNode. she's a node girlie, no cap 🌸

🔥 Public Member Functions

virtual SoType getTypeId (void) const — hands you back her type id. every node has one, it's her little ID card 💳
SoVRMLSound (void) — the constructor, the origin story, the main character entrance ✨
void setDopplerVelocity (float velocity) — sets the doppler velocity, takes a float velocity
float getDopplerVelocity (void) const — reads the doppler velocity back out, returns a float
void setDopplerFactor (float factor) — sets the doppler factor, takes a float factor
float getDopplerFactor (void) const — returns the doppler factor as a float
void startPlaying (SoPath *path, void *userdataptr) — kicks off playback, takes an SoPath * and a void * userdata pointer
void stopPlaying (SoPath *path, void *userdataptr) — stops the playback, same SoPath * + void * combo
void setBufferingProperties (int bufferLength, int numBuffers, SbTime sleepTime) — tunes the buffering, takes an int buffer length, an int number of buffers, and an SbTime sleep time
void getBufferingProperties (int &bufferLength, int &numBuffers, SbTime &sleepTime) — reads those buffering settings back through the references you hand her 🫶
virtual void audioRender (SoAudioRenderAction *action) — the audio render hook, takes an SoAudioRenderAction *

🌈 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=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)
SbUniqueId 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=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`

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 — Returns TRUE if the type of this object is either of the same type or inherited from type. so like, a little family tree check 🌳
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 (void)
static void setDefaultBufferingProperties (int bufferLength, int numBuffers, SbTime sleepTime) — sets the default buffering properties, for everyone, globally. takes the same int/int/SbTime trio 🎧

🌸 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static void initClasses (void)
static SbUniqueId 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
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

bestie these are the fields, the actual knobs you turn. look at them, so many:

SoSFNode source
SoSFFloat intensity
SoSFFloat priority
SoSFVec3f location
SoSFVec3f direction
SoSFFloat minFront
SoSFFloat maxFront
SoSFFloat minBack
SoSFFloat maxBack
SoSFBool spatialize
SoSFFloat dopplerFactor
SoSFFloat dopplerVelocity

💅 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoVRMLSound (void) — the destructor. she says goodbye, but make it virtual 💀

🦋 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
virtual SoNotRec createNotRec (void)

⭐ 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 ✨

👑 Public Types inherited from `SoNode`

the enum era, and she has so many eras:

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,
    COIN_4_0 = 0x20000
}

🦋 Protected Types inherited from `SoBase`

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

💜 Protected Attributes inherited from `SoNode`

SbUniqueId uniqueId

🌸 Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn

🎀 Static Protected Attributes inherited from `SoNode`

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

💜 Detailed Description 💜

The SoVRMLSound class is used to represent a sound source. Basically it's the little node that says "hey, there's noise coming from right here" 🎧✨

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

Sound {
  exposedField SFVec3f  direction     0 0 1   # (-inf, inf)
  exposedField SFFloat  intensity     1       # [0,1]
  exposedField SFVec3f  location      0 0 0   # (-inf, inf)
  exposedField SFFloat  maxBack       10      # [0,inf)
  exposedField SFFloat  maxFront      10      # [0,inf)
  exposedField SFFloat  minBack       1       # [0,inf)
  exposedField SFFloat  minFront      1       # [0,inf)
  exposedField SFFloat  priority      0       # [0,1]
  exposedField SFNode   source        NULL
  field        SFBool   spatialize    TRUE
}

The Sound node specifies the spatial presentation of a sound in a VRML scene. The sound is located at a point in the local coordinate system and emits sound in an elliptical pattern (defined by two ellipsoids). The ellipsoids are oriented in a direction specified by the direction field. The shape of the ellipsoids may be modified to provide more or less directional focus from the location of the sound. two whole ellipsoids, bestie 🌈

The source field specifies the sound source for the Sound node. If the source field is not specified, the Sound node will not emit audio. The source field shall specify either an AudioClip node or a MovieTexture node. If a MovieTexture node is specified as the sound source, the MovieTexture shall refer to a movie format that supports sound (e.g., MPEG1-Systems). 👀

The intensity field adjusts the loudness (decibels) of the sound emitted by the Sound node (note: this is different from the traditional definition of intensity with respect to sound). No cap, it's just... not that kind of intensity 💅

The intensity field has a value that ranges from 0.0 to 1.0 and specifies a factor which shall be used to scale the normalized sample data of the sound source during playback. A Sound node with an intensity of 1.0 shall emit audio at its maximum loudness (before attenuation), and a Sound node with an intensity of 0.0 shall emit no audio. Between these values, the loudness should increase linearly from a -20 dB change approaching an intensity of 0.0 to a 0 dB change at an intensity of 1.0. 📈🔊

The priority field provides a hint for the browser to choose which sounds to play when there are more active Sound nodes than can be played at once due to either limited system resources or system load. 7.3.4, Sound priority, attenuation, and spatialization (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#7.3.4), describes a recommended algorithm for determining which sounds to play under such circumstances. The priority field ranges from 0.0 to 1.0, with 1.0 being the highest priority and 0.0 the lowest priority. 🏆

The location field determines the location of the sound emitter in the local coordinate system. A Sound node's output is audible only if it is part of the traversed scene. Sound nodes that are descended from LOD, Switch, or any grouping or prototype node that disables traversal (i.e., drawing) of its children are not audible unless they are traversed. If a Sound node is disabled by a Switch or LOD node, and later it becomes part of the traversal again, the sound shall resume where it would have been had it been playing continuously. like it never even left 🫶

The Sound node has an inner ellipsoid that defines a volume of space in which the maximum level of the sound is audible. Within this ellipsoid, the normalized sample data is scaled by the intensity field and there is no attenuation. The inner ellipsoid is defined by extending the direction vector through the location. 🥚

The minBack and minFront fields specify distances behind and in front of the location along the direction vector respectively. The inner ellipsoid has one of its foci at location (the second focus is implicit) and intersects the direction vector at minBack and minFront. The Sound node has an outer ellipsoid that defines a volume of space that bounds the audibility of the sound. No sound can be heard outside of this outer ellipsoid. 🚫🔊

The outer ellipsoid is defined by extending the direction vector through the location. The maxBack and maxFront fields specify distances behind and in front of the location along the direction vector respectively. The outer ellipsoid has one of its foci at location (the second focus is implicit) and intersects the direction vector at maxBack and maxFront. The minFront, maxFront, minBack, and maxBack fields are defined in local coordinates, and shall be greater than or equal to zero. The minBack field shall be less than or equal to maxBack, and minFront shall be less than or equal to maxFront. The ellipsoid parameters are specified in the local coordinate system but the ellipsoids' geometry is affected by ancestors' transformations. 🌀

⚠️ okay listen up bestie, these constraints are NOT a suggestion: keep every one of minFront, maxFront, minBack, maxBack ≥ 0, keep minBack ≤ maxBack, and keep minFront ≤ maxFront. fr fr.

Between the two ellipsoids, there shall be a linear attenuation ramp in loudness, from 0 dB at the minimum ellipsoid to -20 dB at the maximum ellipsoid:

attenuation = -20 × (d' / d")

where d' is the distance along the location-to-viewer vector, measured from the transformed minimum ellipsoid boundary to the viewer, and d" is the distance along the location-to-viewer vector from the transformed minimum ellipsoid boundary to the transformed maximum ellipsoid boundary (see Figure 6.14).

  Figure 6.14 -- Sound node geometry

The spatialize field specifies if the sound is perceived as being directionally located relative to the viewer. If the spatialize field is TRUE and the viewer is located between the transformed inner and outer ellipsoids, the viewer's direction and the relative location of the Sound node should be taken into account during playback. Details outlining the minimum required spatialization functionality can be found in 7.3.4, Sound priority, attenuation, and spatialization (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#7.3.4), If the spatialize field is FALSE, then directional effects are ignored, but the ellipsoid dimensions and intensity will still affect the loudness of the sound. If the sound source is multi-channel (e.g., stereo), then the source should retain its channel separation during playback. 🎧👑 (channel separation stays SEPARATED, we don't blend here)

🎀 Constructor & Destructor Documentation 🎀

`SoVRMLSound::SoVRMLSound (void )`

Constructor. 🐣 she's born

`SoVRMLSound::~SoVRMLSound (void ) [protected], [virtual]`

Destructor. 🫧 she's gone (protected tho, so not your business)

✨ Member Function Documentation ✨

`SoType SoVRMLSound::getClassTypeId (void ) [static]`

This static method returns the SoType object associated with objects of this class. 🪪

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. 🎯

Implements SoBase.

`const SoFieldData ** SoVRMLSound::getFieldDataPtr (void ) [static], [protected]`

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🙈 (bestie, this one's not for you, it's giving library-internal)

Returns the SoFieldData class which holds information about fields in this node.

`const SoFieldData * SoVRMLSound::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.

`void SoVRMLSound::initClass (void ) [static]`

(no description in the source — she's just out here initializing the class, quietly iconic 💅)

`void SoVRMLSound::setDopplerVelocity (float velocity)`

Sets the doppler velocity relative to the global coordinate system. Not implemented yet. 😭

`float SoVRMLSound::getDopplerVelocity (void ) const`

Returns the doppler velocity relative to the global coordinate system. Not implemented yet. 😭

`void SoVRMLSound::setDopplerFactor (float factor)`

Sets the doppler factor. Not implemented yet. 😭

`float SoVRMLSound::getDopplerFactor (void ) const`

Returns the doppler factor. Not implemented yet. 😭

`void SoVRMLSound::startPlaying (SoPath * path, void * userdataptr)`

Starts playing the sound. Not implemented yet. Please use the fields of SoVRMLAudioClip to start and stop sounds. 🎬

`void SoVRMLSound::stopPlaying (SoPath * path, void * userdataptr)`

Stops playing the sound. Not implemented yet. Please use the fields of SoVRMLAudioClip to start and stop sounds. 🛑

`void SoVRMLSound::audioRender (SoAudioRenderAction * action) [virtual]`

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances. 🔥

Reimplemented from SoNode.

🌸 Member Data Documentation 🌸

`SoSFNode SoVRMLSound::source`

The audio stream. Either an SoVRMLAudioClip or an SoVRMLMovieTexture. Coin only supports playback of audio from SoVRMLAudioClip, not from SoVRMLMovieTexture. 🎵 (soz MovieTexture, you're not getting played)

`SoSFFloat SoVRMLSound::intensity`

Sound intensity. A value from 0 to 1. Default value is 1. 🔊

`SoSFFloat SoVRMLSound::priority`

Browser hint for how important the sound is. A value from 0 to 1. Default value is 0. Coin does not yet support this field. 🥲

`SoSFVec3f SoVRMLSound::location`

The sound position. Default value is (0, 0, 0). 📍

`SoSFVec3f SoVRMLSound::direction`

Sound direction. Default value is (0, 0, 1). 🧭

`SoSFFloat SoVRMLSound::minFront`

Inner ellipse front value. Default value is 1. ⭕

`SoSFFloat SoVRMLSound::maxFront`

Outer ellipse front value. Default value is 10. 🌐

`SoSFFloat SoVRMLSound::minBack`

Inner ellipse back value. Default value is 1. ⭕

`SoSFFloat SoVRMLSound::maxBack`

Outer ellips back value. Default value is 10. 🌐

`SoSFBool SoVRMLSound::spatialize`

Set to TRUE if sound should be spatialized (directional effects are applied) with respect to the viewer. Distance attenuation is always applied. Default value is TRUE. 🎧✨

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. 🤖 (not me writing this by hand, bestie, the robot did it)

and that's the whole page!! this one came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoVRMLSound(3) manual page 🦋 thanks for reading all the way to the bottom, you're literally the main character 💖

📦 where this page comes from

fedora 43: Coin4-devel 4.0.10-1.fc43 · BSD-3-Clause AND GPL-3.0-or-later
fedora 43: Coin4-devel 4.0.10-1.fc43 · BSD-3-Clause AND GPL-3.0-or-later
fedora 44: Coin4-devel 4.0.10-1.fc44 · BSD-3-Clause AND GPL-3.0-or-later
fedora 44: Coin4-devel 4.0.10-1.fc44 · BSD-3-Clause AND GPL-3.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoVRMLSound(3)

💖 SoVRMLSound 💖

✨ NAME ✨

🎀 SYNOPSIS 🎀

🔥 Public Member Functions

🌈 Public Member Functions inherited from SoNode

💜 Public Member Functions inherited from SoFieldContainer

🦋 Public Member Functions inherited from SoBase

⭐ Static Public Member Functions

🌸 Static Public Member Functions inherited from SoNode

🌈 Static Public Member Functions inherited from SoFieldContainer

💜 Static Public Member Functions inherited from SoBase

🎀 Public Attributes

💅 Protected Member Functions

🦋 Protected Member Functions inherited from SoNode

🌸 Protected Member Functions inherited from SoFieldContainer

💜 Protected Member Functions inherited from SoBase

⭐ Static Protected Member Functions

🌈 Static Protected Member Functions inherited from SoNode

💖 Static Protected Member Functions inherited from SoBase

✨ Additional Inherited Members ✨

👑 Public Types inherited from SoNode

🦋 Protected Types inherited from SoBase

💜 Protected Attributes inherited from SoNode

🌸 Protected Attributes inherited from SoFieldContainer

🎀 Static Protected Attributes inherited from SoNode

💜 Detailed Description 💜

🎀 Constructor & Destructor Documentation 🎀

SoVRMLSound::SoVRMLSound (void )

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

✨ Member Function Documentation ✨

SoType SoVRMLSound::getClassTypeId (void ) [static]

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

const SoFieldData ** SoVRMLSound::getFieldDataPtr (void ) [static], [protected]

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

void SoVRMLSound::initClass (void ) [static]

void SoVRMLSound::setDopplerVelocity (float velocity)

float SoVRMLSound::getDopplerVelocity (void ) const

void SoVRMLSound::setDopplerFactor (float factor)

float SoVRMLSound::getDopplerFactor (void ) const

void SoVRMLSound::startPlaying (SoPath * path, void * userdataptr)

void SoVRMLSound::stopPlaying (SoPath * path, void * userdataptr)

void SoVRMLSound::audioRender (SoAudioRenderAction * action) [virtual]