Drag[en]gine Game Engine  1.0
deBaseSynthesizerModule Class Referenceabstract

Base synthesizer module. More...

#include <deBaseSynthesizerModule.h>

Inheritance diagram for deBaseSynthesizerModule:
deBaseModule

Public Member Functions

Constructors and Destructors
 deBaseSynthesizerModule (deLoadableModule &loadableModule)
 Create module. More...
 
virtual ~deBaseSynthesizerModule ()
 Clean up module. More...
 
Module Management
virtual bool Init ()=0
 Init module and prepare for synthesizer processing. More...
 
virtual void CleanUp ()=0
 Clean up module. More...
 
Synthesizer Management
virtual deBaseSynthesizerSoundCreateSound (deSound *sound)
 Create peer for sound. More...
 
virtual deBaseSynthesizerSynthesizerCreateSynthesizer (deSynthesizer *synthesizer)
 Create peer for synthesizer or NULL if no explicit peer is required. More...
 
virtual deBaseSynthesizerSynthesizerInstanceCreateSynthesizerInstance (deSynthesizerInstance *instance)
 Create peer for synthesizer instance or NULL if no explicit peer is required. More...
 
- Public Member Functions inherited from deBaseModule
 deBaseModule (deLoadableModule &loadableModule)
 Creates a new base module. More...
 
virtual ~deBaseModule ()
 Cleans up the base module. More...
 
virtual int GetParameterCount () const
 Retrieves the count of parameters. More...
 
virtual void GetParameterInfo (int index, deModuleParameter *parameter) const
 Retrieves the informations about the given indexec parameter. More...
 
virtual int FindParameter (const char *name) const
 Retrieves the index of the parameter with the given name or -1 if not found. More...
 
virtual float GetParameterValue (int index) const
 Retrieves the value of the parameter at the given index. More...
 
virtual void SetParameterValue (int index, float value)
 Sets the parameter of the parameter at the given index. More...
 
virtual void SendCommand (const decUnicodeArgumentList &command, decUnicodeString &answer)
 Sends a command to the module and retrieves an answer from it. More...
 
void LogInfo (const char *message)
 Outputs an information message on the console. More...
 
void LogInfoFormat (const char *message,...)
 Outputs a formated information message on the console. More...
 
void LogInfoFormatUsing (const char *message, va_list args)
 Outputs a formated information message on the console. More...
 
void LogWarn (const char *message)
 Outputs a warning message on the console. More...
 
void LogWarnFormat (const char *message,...)
 Outputs a formated warning message on the console. More...
 
void LogWarnFormatUsing (const char *message, va_list args)
 Outputs a formated warning message on the console. More...
 
void LogError (const char *message)
 Outputs an error message on the console. More...
 
void LogErrorFormat (const char *message,...)
 Outputs a formated error message on the console. More...
 
void LogErrorFormatUsing (const char *message, va_list args)
 Outputs a formated error message on the console. More...
 
void LogException (const deException &exception)
 Outputs an exception as error message on the console. More...
 
deEngineGetGameEngine () const
 Retrieves the game engine object. More...
 
deLoadableModuleGetLoadableModule () const
 Retrieves the loadable module. More...
 
deOSGetOS () const
 Retrieves the os object from the game engine. More...
 
deVirtualFileSystemGetVFS () const
 Retrieves the module virtual file system. More...
 
deErrorTracePointSetErrorTrace (const char *error, const char *sourceFunc, int sourceLine)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointSetErrorTrace (const deException &exception)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointAddErrorTracePoint (const char *sourceFunc, int sourceLine)
 Adds a new trace point to the engine error trace with an empty error. More...
 

Detailed Description

Base synthesizer module.

Author
Pl├╝ss Roland
Version
1.0
Date
2016

Constructor & Destructor Documentation

◆ deBaseSynthesizerModule()

deBaseSynthesizerModule::deBaseSynthesizerModule ( deLoadableModule loadableModule)

Create module.

◆ ~deBaseSynthesizerModule()

virtual deBaseSynthesizerModule::~deBaseSynthesizerModule ( )
virtual

Clean up module.

Member Function Documentation

◆ CleanUp()

virtual void deBaseSynthesizerModule::CleanUp ( )
pure virtual

Clean up module.

All resources have to be freed and running threads stopped or killed if needed.

◆ CreateSound()

virtual deBaseSynthesizerSound* deBaseSynthesizerModule::CreateSound ( deSound sound)
virtual

Create peer for sound.

◆ CreateSynthesizer()

virtual deBaseSynthesizerSynthesizer* deBaseSynthesizerModule::CreateSynthesizer ( deSynthesizer synthesizer)
virtual

Create peer for synthesizer or NULL if no explicit peer is required.

Default implementation return NULL.

◆ CreateSynthesizerInstance()

virtual deBaseSynthesizerSynthesizerInstance* deBaseSynthesizerModule::CreateSynthesizerInstance ( deSynthesizerInstance instance)
virtual

Create peer for synthesizer instance or NULL if no explicit peer is required.

Default implementation return NULL.

◆ Init()

virtual bool deBaseSynthesizerModule::Init ( )
pure virtual

Init module and prepare for synthesizer processing.

Returns
true on success or false on failure.

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