solistenerdopplerelement(3)
NAME
SoListenerDopplerElement
SYNOPSIS
#include <Inventor/elements/SoListenerDopplerElement.h> Inherits SoReplacedElement.
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.
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
- Public Member Functions
- virtual void init (SoState *state)
virtual void print (FILE *file) constPrints the contents of the element (unimplemented). - Static Public Member Functions
- static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void * createInstance (void)
static void initClass (void)
static void setDopplerVelocity (SoState *const state, SoNode *constnode, const SbVec3f &velocity) - static void setDopplerFactor (SoState *const state, SoNode *const node,
float factor)
- static const SbVec3f & getDopplerVelocity (SoState *const state)
Returns the current listener's doppler velocity.
- static float getDopplerFactor (SoState *const state)
Returns the current listener's doppler factor.
- Protected Member Functions
- virtual ~SoListenerDopplerElement ()
- Protected Attributes
- SbVec3f dopplerVelocity
float dopplerFactor
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.
- Referenced by SoElement::initElements().
- 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.
- References dopplerFactor, dopplerVelocity, and
SoReplacedElement::init(). - void SoListenerDopplerElement::setDopplerVelocity (SoState *const state,
- SoNode *const node, const SbVec3f & velocity) [static] Sets the current listener's doppler velocity.
- References dopplerVelocity, and SoElement::getElement().
- void SoListenerDopplerElement::setDopplerFactor (SoState *const state,
- SoNode *const node, float factor) [static] Sets the current listener's doppler factor.
- References dopplerFactor, and SoElement::getElement().
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. - Referenced by getDopplerVelocity(), init(), and setDopplerVelocity().
- 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.
- Referenced by getDopplerFactor(), init(), and setDopplerFactor().
Author
- Generated automatically by Doxygen for Coin from the source code.