.TH "SoSoundElement" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoSoundElement \- The \fBSoSoundElement\fP is used for optimizing audio rendering and for turning off inactive \fBSoVRMLSound\fP nodes\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoReplacedElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "virtual void \fBprint\fP (FILE *file) const" .br .RI "Prints contents of element (not implemented)\&. " .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const" .br .ti -1c .RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP () const" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP () const" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "const \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "int \fBgetStackIndex\fP (void) const" .br .ti -1c .RI "void \fBsetDepth\fP (const int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (void) const" .br .ti -1c .RI "virtual \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph)" .br .ti -1c .RI "static SbBool \fBsetSceneGraphHasSoundNode\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)" .br .ti -1c .RI "static SbBool \fBsceneGraphHasSoundNode\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static SbBool \fBsetSoundNodeIsPlaying\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)" .br .ti -1c .RI "static SbBool \fBsoundNodeIsPlaying\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static SbBool \fBsetIsPartOfActiveSceneGraph\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)" .br .ti -1c .RI "static SbBool \fBisPartOfActiveSceneGraph\fP (\fBSoState\fP *const state)" .br .in -1c Static Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void \fBinitElements\fP (void)" .br .ti -1c .RI "static int \fBgetNumStackIndices\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual \fB~SoSoundElement\fP ()" .br .ti -1c .RI "void \fBsetDefaultValues\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "virtual \fB~SoReplacedElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (void)" .br .ti -1c .RI "void \fBcapture\fP (\fBSoState\fP *const state) const" .br .ti -1c .RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const" .br .ti -1c .RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "void \fBsetStackIndex\fP (const int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "SbBool \fBscenegraphhassoundnode\fP" .br .ti -1c .RI "SbBool \fBsoundnodeisplaying\fP" .br .ti -1c .RI "SbBool \fBispartofactivescenegraph\fP" .br .in -1c Protected Attributes inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "SbUniqueId \fBnodeId\fP" .br .in -1c Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP, \fBSoNode\fP *const node)" .br .in -1c Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static int \fBcreateStackIndex\fP (const \fBSoType\fP id)" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static int \fBclassStackIndex\fP" .br .ti -1c .RI "static \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoSoundElement\fP is used for optimizing audio rendering and for turning off inactive \fBSoVRMLSound\fP nodes\&. .PP \fBSince\fP .RS 4 Coin 2\&.0 .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoSoundElement::~SoSoundElement (void )\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoSoundElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .SS "int SoSoundElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .SS "void * SoSoundElement::createInstance (void )\fR [static]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .SS "void SoSoundElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoSoundElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Initializes the element to its default value\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .SS "void SoSoundElement::set (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph)\fR [static]\fP" Sets the flags\&. .SS "SbBool SoSoundElement::setSceneGraphHasSoundNode (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)\fR [static]\fP" Sets the sceneGraphHasSoundNode flag\&. .SS "SbBool SoSoundElement::sceneGraphHasSoundNode (\fBSoState\fP *const state)\fR [static]\fP" The sceneGraphHasSoundNode flag is used to stop the \fBSoAudioRenderAction\fP in \fBSoSeparator\fP and \fBSoVRMLGroup\fP nodes for cases where the subgraph does not contain any \fBSoVRMLSound\fP nodes\&. .PP Returns the value of the sceneGraphHasSoundNode flag\&. .SS "SbBool SoSoundElement::setSoundNodeIsPlaying (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)\fR [static]\fP" Sets the soundNodeIsPlaying flag\&. .SS "SbBool SoSoundElement::soundNodeIsPlaying (\fBSoState\fP *const state)\fR [static]\fP" The soundNodeIsPlaying flag is currently unused\&. .PP Returns the value of the soundNodeIsPlaying flag\&. .SS "SbBool SoSoundElement::setIsPartOfActiveSceneGraph (\fBSoState\fP *const state, \fBSoNode\fP *const node, SbBool flag)\fR [static]\fP" Sets the isPartOfActiveSceneGraph flag\&. .SS "SbBool SoSoundElement::isPartOfActiveSceneGraph (\fBSoState\fP *const state)\fR [static]\fP" The isPartOfActiveSceneGraph flag is used to make \fBSoVRMLSound\fP that are below inactive parts of the scene graph (i\&.e\&. below a \fBSoSwitch\fP or \fBSoLOD\fP node) stop playing\&. .PP Returns the value of the isPartOfActiveSceneGraph flag\&. .SS "void SoSoundElement::push (\fBSoState\fP * state)\fR [virtual]\fP" Calls the superclass' push method\&. Initializes the element to the default values\&. Uses previous element's isPartOfActiveSceneGraph flag\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoSoundElement::pop (\fBSoState\fP * state, const \fBSoElement\fP * prevTopElement)\fR [virtual]\fP" Calls the superclass' pop method\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "void SoSoundElement::print (FILE * file) const\fR [virtual]\fP" .PP Prints contents of element (not implemented)\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .SS "void SoSoundElement::setDefaultValues ()\fR [protected]\fP" Initializes the element to the default values\&. The default values for the sceneGraphHasSoundNode is FALSE\&. The default value for the isPartOfActiveSceneGraph flag is TRUE\&. the default value for the soundNodeIsPlaying flag is FALSE\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.