Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

SoListenerDopplerElement Class Reference

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. More...

#include <Inventor/elements/SoListenerDopplerElement.h>

Inheritance diagram for SoListenerDopplerElement:
SoReplacedElement SoElement

List of all members.

Public Member Functions

virtual void init (SoState *state)
virtual void print (FILE *file) const
 Prints the contents of the element (unimplemented)

Static Public Member Functions

static void initClass (void)
static void setDopplerVelocity (SoState *const state, SoNode *const node, const SbVec3f &velocity)
static void setDopplerFactor (SoState *const state, SoNode *const node, float factor)
static const SbVec3fgetDopplerVelocity (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

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

Constructor & Destructor Documentation

SoListenerDopplerElement::~SoListenerDopplerElement ( void  ) [protected, virtual]

The destructor.


Member Function Documentation

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.

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 SoElement::classStackIndex, dopplerVelocity, and SoElement::getElement().

Referenced by SoListener::audioRender().

void SoListenerDopplerElement::setDopplerFactor ( SoState *const  state,
SoNode *const  node,
float  factor 
) [static]

Sets the current listener's doppler factor.

References SoElement::classStackIndex, dopplerFactor, and SoElement::getElement().

Referenced by SoListener::audioRender().


Member Data Documentation

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().

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().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:14 for Coin by Doxygen. 1.7.3