SoListenerDopplerElement Class Reference

The SoListenerDopplerElement holds the Doppler velocity and factor of the current listener. More...

#include <Inventor/elements/SoListenerDopplerElement.h>

Inheritance diagram for SoListenerDopplerElement:

Public Member Functions
virtual void	init (SoState *state)
virtual void	print (FILE *file) const
	Prints the contents of the element (unimplemented)
Public Member Functions inherited from SoReplacedElement
virtual SoElement *	copyMatchInfo () const
SbUniqueId	getNodeId () const
virtual SbBool	matches (const SoElement *element) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	push (SoState *state)
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static float	getDopplerFactor (SoState *const state)
	Returns the current listener's Doppler factor.
static const SbVec3f &	getDopplerVelocity (SoState *const state)
	Returns the current listener's Doppler velocity.
static void	initClass (void)
static void	setDopplerFactor (SoState *const state, SoNode *const node, float factor)
static void	setDopplerVelocity (SoState *const state, SoNode *const node, const SbVec3f &velocity)
Static Public Member Functions inherited from SoReplacedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoListenerDopplerElement ()
Protected Member Functions inherited from SoReplacedElement
virtual	~SoReplacedElement ()
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
float	dopplerFactor
SbVec3f	dopplerVelocity
Protected Attributes inherited from SoReplacedElement
SbUniqueId	nodeId
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Static Protected Member Functions inherited from SoReplacedElement
static SoElement *	getElement (SoState *const state, const int stackIndex, SoNode *const node)
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

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::~SoListenerDopplerElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

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.

getClassStackIndex()

int SoListenerDopplerElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoListenerDopplerElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

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.

initClass()

void SoListenerDopplerElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

print()

void SoListenerDopplerElement::print ( FILE * file ) const

virtual

Prints the contents of the element (unimplemented)

Reimplemented from SoReplacedElement.

setDopplerFactor()

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

static

Sets the current listener's Doppler factor.

setDopplerVelocity()

void SoListenerDopplerElement::setDopplerVelocity ( SoState *const state, SoNode *const node, const SbVec3f & velocity )

static

Sets the current listener's Doppler velocity.

Member Data Documentation

dopplerFactor

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.

dopplerVelocity

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.

---

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

• SoListenerDopplerElement.h
• SoListenerDopplerElement.cpp