.TH "SoSoundElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "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 \fC#include \fP .PP Inherits \fBSoReplacedElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP) \fBconst\fP" .br .RI "Prints contents of element (not implemented) " .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP () \fBconst\fP" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP () \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsetSceneGraphHasSoundNode\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool \fBflag\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsceneGraphHasSoundNode\fP (\fBSoState\fP *\fBconst\fP state)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsetSoundNodeIsPlaying\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool \fBflag\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsoundNodeIsPlaying\fP (\fBSoState\fP *\fBconst\fP state)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsetIsPartOfActiveSceneGraph\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool \fBflag\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisPartOfActiveSceneGraph\fP (\fBSoState\fP *\fBconst\fP state)" .br .in -1c Static Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoSoundElement\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBsetDefaultValues\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoReplacedElement\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoReplacedElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP" .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 "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP, \fBSoNode\fP *\fBconst\fP node)" .br .in -1c Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBcreateStackIndex\fP (\fBconst\fP \fBSoType\fP id)" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP int \fBclassStackIndex\fP" .br .ti -1c .RI "\fBstatic\fP \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 \fB2\&.0\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoSoundElement::~SoSoundElement (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoSoundElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoSoundElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoSoundElement::createInstance (\fBvoid\fP)\fC [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\&. .br .SS "\fBvoid\fP SoSoundElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "\fBvoid\fP SoSoundElement::init (\fBSoState\fP * state)\fC [virtual]\fP" Initializes the element to its default value\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .SS "\fBvoid\fP SoSoundElement::set (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool scenegraphhassoundnode, SbBool soundnodeisplaying, SbBool ispartofactivescenegraph)\fC [static]\fP" Sets the flags\&. .SS "SbBool SoSoundElement::setSceneGraphHasSoundNode (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool flag)\fC [static]\fP" Sets the sceneGraphHasSoundNode flag\&. .SS "SbBool SoSoundElement::sceneGraphHasSoundNode (\fBSoState\fP *\fBconst\fP state)\fC [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 *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool flag)\fC [static]\fP" Sets the soundNodeIsPlaying flag\&. .SS "SbBool SoSoundElement::soundNodeIsPlaying (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" The soundNodeIsPlaying flag is currently unused\&. .PP Returns the value of the soundNodeIsPlaying flag\&. .SS "SbBool SoSoundElement::setIsPartOfActiveSceneGraph (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SbBool flag)\fC [static]\fP" Sets the isPartOfActiveSceneGraph flag\&. .SS "SbBool SoSoundElement::isPartOfActiveSceneGraph (\fBSoState\fP *\fBconst\fP state)\fC [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 "\fBvoid\fP SoSoundElement::push (\fBSoState\fP * state)\fC [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 "\fBvoid\fP SoSoundElement::pop (\fBSoState\fP * state, \fBconst\fP \fBSoElement\fP * prevTopElement)\fC [virtual]\fP" Calls the superclass' pop method\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "\fBvoid\fP SoSoundElement::print (\fBFILE\fP * file) const\fC [virtual]\fP" .PP Prints contents of element (not implemented) .PP Reimplemented from \fBSoReplacedElement\fP\&. .SS "\fBvoid\fP SoSoundElement::setDefaultValues ()\fC [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\&.