sonus::Sound Class Reference

#include <Sound.h>

List of all members.

Public Member Functions

 Sound ()
 ~Sound ()
void initLevel (std::string levelName, Level2D *level)
void update (Level2D *level)
void endLevel ()

Public Attributes

ALObjportalSound
ALObjportalSoundFinal
ALObjspeechLevel
bool debug


Detailed Description

sonus::Sound

Manages everything sound related in the game. It holds an OpenAL Application (ALApp) and different sound objects (ALObj). It implements the logic to play the music and sound effects patterns depending on the individual level data.

filename: Sound.h

Author:
Martin Moehwald
Version:
1.0

Constructor & Destructor Documentation

sonus::Sound::Sound (  ) 

Constructor Initializes all structures related to sound in the game:

sonus::Sound::~Sound (  ) 

Destructor Unloads the OpenAL application.


Member Function Documentation

void sonus::Sound::initLevel ( std::string  levelName,
Level2D level 
)

Initializes the world by a given Level2D pointer. Looks for the configuration file of the level and analyzes it for the amount and types of sound source files and their paths alongside definitions of sound transitions.

Parameters:
levelName The name of the level to load. Used to identify the unique configurations file.
level The Level2D object containing all the essential world objects needed for initialization.

void sonus::Sound::update ( Level2D level  ) 

Updates the world by a given Level2D pointer. The game application object triggers the update routines of all modules (including the sound) in a certain cycle.

In this routine the whole logic processing of sound is done:

Parameters:
level The Level2D object containing all the essential world objects needed for initialization.

void sonus::Sound::endLevel (  ) 

Stops all playing sources and mutes them.


The documentation for this class was generated from the following file:
Generated on Tue Aug 26 12:26:54 2008 for sonus by  doxygen 1.5.4