other versions
- wheezy-backports 3.1.4~abc9f50-3~bpo70+1
- jessie 3.1.4~abc9f50-7
SoListenerDopplerElement(3) | Coin | SoListenerDopplerElement(3) |
NAME¶
SoListenerDopplerElement - The SoListenerDopplerElement holds the doppler velocity and factor of the current listener. The dopplerVelocity and dopplerFactor is set by SoListener nodes during audio rendering. The SoListenerDopplerElement is used when the SoVRMLSound nodes render themselves.SYNOPSIS¶
#include <Inventor/elements/SoListenerDopplerElement.h> Inherits SoReplacedElement.Public Member Functions¶
virtual void init (SoState *state)
Static Public Member Functions¶
static SoType getClassTypeId (void)
Protected Member Functions¶
virtual ~SoListenerDopplerElement ()
Protected Attributes¶
SbVec3f dopplerVelocity
Additional Inherited Members¶
Detailed Description¶
The SoListenerDopplerElement holds the doppler velocity and factor of the current listener. The dopplerVelocity and dopplerFactor is set by SoListener nodes during audio rendering. The SoListenerDopplerElement is used when the SoVRMLSound nodes render themselves.Coin 2.0
Constructor & Destructor Documentation¶
SoListenerDopplerElement::~SoListenerDopplerElement (void) [protected], [virtual]¶
The destructor.Member Function Documentation¶
SoType SoListenerDopplerElement::getClassTypeId (void) [static]¶
This static method returns the class type. Reimplemented from SoReplacedElement.int SoListenerDopplerElement::getClassStackIndex (void) [static]¶
This static method returns the state stack index for the class. Reimplemented from SoReplacedElement.void * SoListenerDopplerElement::createInstance (void) [static]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.void SoListenerDopplerElement::initClass (void) [static]¶
This static method initializes static data for the SoListenerDopplerElement class. Reimplemented from SoReplacedElement.void SoListenerDopplerElement::init (SoState *state) [virtual]¶
Initializes the element to it's default value. The default value for the velocity is (0.0f, 0.0f, 0.0f), in other words, the listener is not moving. The default value for the dopplerFactor is 0.0f, in other words, doppler effect is disabled. Reimplemented from SoReplacedElement.void SoListenerDopplerElement::setDopplerVelocity (SoState *conststate, SoNode *constnode, const SbVec3f &velocity) [static]¶
Sets the current listener's doppler velocity.void SoListenerDopplerElement::setDopplerFactor (SoState *conststate, SoNode *constnode, floatfactor) [static]¶
Sets the current listener's doppler factor.Member Data Documentation¶
SoListenerDopplerElement::dopplerVelocity [protected]¶
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.SoListenerDopplerElement::dopplerFactor [protected]¶
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.Author¶
Generated automatically by Doxygen for Coin from the source code.Sat Oct 12 2013 | Version 4.0.0a |