.TH "SoListenerDopplerElement" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoListenerDopplerElement \- The \fBSoListenerDopplerElement\fP holds the Doppler velocity and factor of the current listener\&. .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 \fBprint\fP (FILE *file) const" .br .RI "Prints the contents of the element (unimplemented) " .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 "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 "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 \fBsetDopplerVelocity\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3f\fP &velocity)" .br .ti -1c .RI "static void \fBsetDopplerFactor\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, float factor)" .br .ti -1c .RI "static const \fBSbVec3f\fP & \fBgetDopplerVelocity\fP (\fBSoState\fP *const state)" .br .RI "Returns the current listener's Doppler velocity\&. " .ti -1c .RI "static float \fBgetDopplerFactor\fP (\fBSoState\fP *const state)" .br .RI "Returns the current listener's Doppler factor\&. " .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~SoListenerDopplerElement\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 "\fBSbVec3f\fP \fBdopplerVelocity\fP" .br .ti -1c .RI "float \fBdopplerFactor\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 \fBSoListenerDopplerElement\fP holds the Doppler velocity and factor of the current listener\&. The dopplerVelocity and dopplerFactor is set by \fBSoListener\fP nodes during audio rendering\&. The \fBSoListenerDopplerElement\fP is used when the \fBSoVRMLSound\fP nodes render themselves\&. .PP Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .br .PP \fBSince\fP .RS 4 Coin 2\&.0 .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoListenerDopplerElement::~SoListenerDopplerElement (void )\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoListenerDopplerElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoListenerDopplerElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .br .SS "void * SoListenerDopplerElement::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\&. .br .SS "void SoListenerDopplerElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoListenerDopplerElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Initializes the element to its default value\&. The default value for the velocity is (0\&.0, 0\&.0, 0\&.0), in other words, the listener is not moving\&. The default value for the dopplerFactor is 0\&.0, in other words, Doppler effect is disabled\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .SS "void SoListenerDopplerElement::setDopplerVelocity (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3f\fP & velocity)\fR [static]\fP" Sets the current listener's Doppler velocity\&. .SS "void SoListenerDopplerElement::setDopplerFactor (\fBSoState\fP *const state, \fBSoNode\fP *const node, float factor)\fR [static]\fP" Sets the current listener's Doppler factor\&. .SS "void SoListenerDopplerElement::print (FILE * file) const\fR [virtual]\fP" .PP Prints the contents of the element (unimplemented) .PP Reimplemented from \fBSoReplacedElement\fP\&. .SH "Member Data Documentation" .PP .SS "\fBSbVec3f\fP SoListenerDopplerElement::dopplerVelocity\fR [protected]\fP" The Doppler velocity of the listener\&. It is the application programmer's responsibility to set this value\&. Coin does not update this value automatically based on changes in a listener's position\&. .SS "float SoListenerDopplerElement::dopplerFactor\fR [protected]\fP" The amount of Doppler effect applied to the listener\&. The normal range would be [0\&.0f to 1\&.0f], where 0\&.0f is default and disable all Doppler effects\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.