The SoListenerDopplerElement holds the Doppler velocity and factor of the current listener.
More...
#include <Inventor/elements/SoListenerDopplerElement.h>
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.
Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
- Since
- Coin 2.0
◆ ~SoListenerDopplerElement()
SoListenerDopplerElement::~SoListenerDopplerElement |
( |
void | | ) |
|
|
protectedvirtual |
◆ getClassTypeId()
SoType SoListenerDopplerElement::getClassTypeId |
( |
void | | ) |
|
|
static |
This static method returns the SoType object associated with objects of this class.
◆ getClassStackIndex()
int SoListenerDopplerElement::getClassStackIndex |
( |
void | | ) |
|
|
static |
This static method returns the state stack index for the class.
◆ createInstance()
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.
Creates a new instance of the class type corresponding to the SoType object.
◆ initClass()
void SoListenerDopplerElement::initClass |
( |
void | | ) |
|
|
static |
Initialize relevant common data for all instances, like the type system.
◆ init()
void SoListenerDopplerElement::init |
( |
SoState * | state | ) |
|
|
virtual |
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.
Reimplemented from SoReplacedElement.
◆ setDopplerVelocity()
void SoListenerDopplerElement::setDopplerVelocity |
( |
SoState *const | state, |
|
|
SoNode *const | node, |
|
|
const SbVec3f & | velocity ) |
|
static |
Sets the current listener's Doppler velocity.
◆ setDopplerFactor()
void SoListenerDopplerElement::setDopplerFactor |
( |
SoState *const | state, |
|
|
SoNode *const | node, |
|
|
float | factor ) |
|
static |
Sets the current listener's Doppler factor.
◆ print()
void SoListenerDopplerElement::print |
( |
FILE * | file | ) |
const |
|
virtual |
Prints the contents of the element (unimplemented)
Reimplemented from SoReplacedElement.
◆ dopplerVelocity
SbVec3f 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.
◆ dopplerFactor
float 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.
The documentation for this class was generated from the following files: