deSynthesizerSystem Class Reference

Synthesizer system. More...

#include <deSynthesizerSystem.h>

Inheritance diagram for deSynthesizerSystem:

Public Member Functions
Constructors and Destructors
	deSynthesizerSystem (deEngine *engine)
	Create synthesizer system. More...
virtual	~deSynthesizerSystem ()
	Clean up synthesizer system. More...
Management
deBaseSynthesizerModule *	GetActiveModule () const
	Activate synthesizer module or NULL if none is active. More...
void	LoadSound (deSound *sound)
	Create and assign peer for sound using the active module. More...
void	LoadSynthesizer (deSynthesizer *synthesizer)
	Create and assign peer for synthesizer using the active module. More...
void	LoadSynthesizerInstance (deSynthesizerInstance *instance)
	Create and assign peer for synthesizer instance using the active module. More...
Public Member Functions inherited from deBaseSystem
	deBaseSystem (deEngine *engine, const char *systemName, int requiredModuleType)
	Create new base system linked to the given engine. More...
virtual	~deBaseSystem ()
	Clean up base system. More...
deEngine *	GetEngine () const
	Linked game engine. More...
deLoadableModule *	GetActiveLoadableModule () const
	Active loadable module. More...
bool	GetIsRunning () const
	System is running. More...
bool	GetHasFailed () const
	System has failed during runtime. More...
const decString &	GetSystemName () const
	System name. More...
virtual bool	CanStart ()
void	SetHasFailed (bool hasFailed)
	Set if system has failed. More...
virtual void	Start ()
	Start system and the active loadable module. More...
virtual void	Stop ()
	Stop system and the active loadable module. More...
void	CheckAndActivateFirst (deModuleSystem::eModuleTypes type)
	Check if at least one module is working and select the first one. More...
void	LogInfo (const char *message)
	Output information message on the console. More...
void	LogInfoFormat (const char *message,...)
	Output formated information message on the console. More...
void	LogInfoFormatUsing (const char *message, va_list args)
	Output formated information message on the console. More...
void	LogWarn (const char *message)
	Output warning message on the console. More...
void	LogWarnFormat (const char *message,...)
	Output formated warning message on the console. More...
void	LogWarnFormatUsing (const char *message, va_list args)
	Output formated warning message on the console. More...
void	LogError (const char *message)
	Output error message on the console. More...
void	LogErrorFormat (const char *message,...)
	Output formated error message on the console. More...
void	LogErrorFormatUsing (const char *message, va_list args)
	Output formated error message on the console. More...
void	LogException (const deException &exception)
	Output exception as error message on the console. More...

Overloadables
virtual void	SetActiveModule (deLoadableModule *module)
	Set active loadable module. More...
virtual void	ClearPermanents ()
	Clearcross references and links that could lead to memory leaks. More...
virtual void	PostStart ()
	Carry out here actions right after the system started up. More...
virtual void	PreStop ()
	Carry out here actions right before the system shuts down. More...

Detailed Description

Synthesizer system.

The synthesizer system is a single type system providing sound support for the engine. An synthesizer module is able to carry out the actions stored in an synthesizer object.

Constructor & Destructor Documentation

deSynthesizerSystem()

deSynthesizerSystem::deSynthesizerSystem

(

deEngine *

engine

)

Create synthesizer system.

~deSynthesizerSystem()

virtual deSynthesizerSystem::~deSynthesizerSystem ( )

virtual

Clean up synthesizer system.

Member Function Documentation

ClearPermanents()

virtual void deSynthesizerSystem::ClearPermanents ( )

virtual

Clearcross references and links that could lead to memory leaks.

Do not forget to call the super function.

Reimplemented from deBaseSystem.

GetActiveModule()

deBaseSynthesizerModule* deSynthesizerSystem::GetActiveModule ( ) const

inline

Activate synthesizer module or NULL if none is active.

LoadSound()

void deSynthesizerSystem::LoadSound

(

deSound *

sound

)

Create and assign peer for sound using the active module.

LoadSynthesizer()

void deSynthesizerSystem::LoadSynthesizer

(

deSynthesizer *

synthesizer

)

Create and assign peer for synthesizer using the active module.

LoadSynthesizerInstance()

void deSynthesizerSystem::LoadSynthesizerInstance

(

deSynthesizerInstance *

instance

)

Create and assign peer for synthesizer instance using the active module.

PostStart()

virtual void deSynthesizerSystem::PostStart ( )

virtual

Carry out here actions right after the system started up.

Reimplemented from deBaseSystem.

PreStop()

virtual void deSynthesizerSystem::PreStop ( )

virtual

Carry out here actions right before the system shuts down.

Reimplemented from deBaseSystem.

SetActiveModule()

virtual void deSynthesizerSystem::SetActiveModule ( deLoadableModule *  module )

virtual

Set active loadable module.

Do not forget to call the super function.

Reimplemented from deBaseSystem.

---

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

• deSynthesizerSystem.h