Engine::SoundListener Class Reference

A point where sound is heard from. More...

#include <Audio.h>

List of all members.

Public Member Functions

 SoundListener ()
 ~SoundListener ()
void set_position (btVector3 position, btVector3 forward, btVector3 up)
 Set the position and orientation of the listener.
void set_velocity (btVector3 velocity)
 Set the velocity of the listner.

Private Member Functions

 SoundListener (const SoundListener &source)
SoundListeneroperator= (const SoundListener &source)

Private Attributes

btVector3 m_position
btVector3 m_forward
btVector3 m_up
btVector3 m_velocity
btTransform m_inverse_transform


class Audio

Detailed Description

A point where sound is heard from.

There should be one for each camera. Unlike OpenAL, there can be more than one listener.

Definition at line 124 of file Audio.h.

Constructor & Destructor Documentation

Engine::SoundListener::SoundListener (  ) 

Definition at line 366 of file Audio.cpp.

Engine::SoundListener::~SoundListener (  ) 

Definition at line 375 of file Audio.cpp.

Engine::SoundListener::SoundListener ( const SoundListener source  )  [private]

Member Function Documentation

SoundListener& Engine::SoundListener::operator= ( const SoundListener source  )  [private]

void Engine::SoundListener::set_position ( btVector3  position,
btVector3  forward,
btVector3  up 

Set the position and orientation of the listener.

The forward and up vectors will be normalised.

position The location of the listener in world space.
forward The direction the listener is facing.
up The direction the listener considers up.

Definition at line 380 of file Audio.cpp.

void Engine::SoundListener::set_velocity ( btVector3  velocity  ) 

Set the velocity of the listner.

Used for doppler shift calculation.

velocity Velocity of the distance in world space in spacial units per second.

Definition at line 399 of file Audio.cpp.

Friends And Related Function Documentation

friend class Audio [friend]

Definition at line 126 of file Audio.h.

Member Data Documentation

btVector3 Engine::SoundListener::m_forward [private]

Definition at line 145 of file Audio.h.

btTransform Engine::SoundListener::m_inverse_transform [private]

Definition at line 148 of file Audio.h.

btVector3 Engine::SoundListener::m_position [private]

Definition at line 144 of file Audio.h.

btVector3 Engine::SoundListener::m_up [private]

Definition at line 146 of file Audio.h.

btVector3 Engine::SoundListener::m_velocity [private]

Definition at line 147 of file Audio.h.

The documentation for this class was generated from the following files:
Get Racer at SourceForge.net. Fast, secure and Free Open Source software downloads

Generated at Mon Sep 6 00:41:17 2010 by Doxygen version 1.4.7 for Racer version svn335.