CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iSoundListener Struct Reference

The sound listener is a unique object created by the sound renderer. More...

#include <isound/listener.h>

Inheritance diagram for iSoundListener:

iBase List of all members.

Public Member Functions

virtual void SetDirection (const csVector3 &Front, const csVector3 &Top)=0
 Set direction of listener (front and top 3d vectors).
virtual void SetPosition (const csVector3 &pos)=0
 Set position of listener.
virtual void SetVelocity (const csVector3 &v)=0
 Set velocity of listener.
virtual void SetDistanceFactor (float factor)=0
 Set a distance attenuator.
virtual void SetRollOffFactor (float factor)=0
 Set a RollOff factor.
virtual void SetDopplerFactor (float factor)=0
 Set the Doppler attenuator.
virtual void SetHeadSize (float size)=0
 Set distance between the 2 'ears' of listener.
virtual void SetEnvironment (csSoundEnvironment env)=0
 set type of environment where 'live' listener
virtual void GetDirection (csVector3 &Front, csVector3 &Top)=0
 Get direction of listener (front and top 3d vectors).
virtual const csVector3GetPosition ()=0
 Get position of listener.
virtual const csVector3GetVelocity ()=0
 Get velocity of listener.
virtual float GetDistanceFactor ()=0
 Get a distance attenuator.
virtual float GetRollOffFactor ()=0
 Get a RollOff factor.
virtual float GetDopplerFactor ()=0
 Get the Doppler attenuator.
virtual float GetHeadSize ()=0
 Get distance between the 2 'ears' of listener.
virtual csSoundEnvironment GetEnvironment ()=0
 Get type of environment where 'live' listener.

Detailed Description

The sound listener is a unique object created by the sound renderer.

It can be used to setup 'yourself' (the player) for 3d sound: position, orientation, speed and environment effects.

Definition at line 64 of file listener.h.


Member Function Documentation

virtual void iSoundListener::GetDirection csVector3 Front,
csVector3 Top
[pure virtual]
 

Get direction of listener (front and top 3d vectors).

virtual float iSoundListener::GetDistanceFactor  )  [pure virtual]
 

Get a distance attenuator.

virtual float iSoundListener::GetDopplerFactor  )  [pure virtual]
 

Get the Doppler attenuator.

virtual csSoundEnvironment iSoundListener::GetEnvironment  )  [pure virtual]
 

Get type of environment where 'live' listener.

virtual float iSoundListener::GetHeadSize  )  [pure virtual]
 

Get distance between the 2 'ears' of listener.

virtual const csVector3& iSoundListener::GetPosition  )  [pure virtual]
 

Get position of listener.

virtual float iSoundListener::GetRollOffFactor  )  [pure virtual]
 

Get a RollOff factor.

virtual const csVector3& iSoundListener::GetVelocity  )  [pure virtual]
 

Get velocity of listener.

virtual void iSoundListener::SetDirection const csVector3 Front,
const csVector3 Top
[pure virtual]
 

Set direction of listener (front and top 3d vectors).

virtual void iSoundListener::SetDistanceFactor float  factor  )  [pure virtual]
 

Set a distance attenuator.

virtual void iSoundListener::SetDopplerFactor float  factor  )  [pure virtual]
 

Set the Doppler attenuator.

virtual void iSoundListener::SetEnvironment csSoundEnvironment  env  )  [pure virtual]
 

set type of environment where 'live' listener

virtual void iSoundListener::SetHeadSize float  size  )  [pure virtual]
 

Set distance between the 2 'ears' of listener.

virtual void iSoundListener::SetPosition const csVector3 pos  )  [pure virtual]
 

Set position of listener.

virtual void iSoundListener::SetRollOffFactor float  factor  )  [pure virtual]
 

Set a RollOff factor.

virtual void iSoundListener::SetVelocity const csVector3 v  )  [pure virtual]
 

Set velocity of listener.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1