Standard implementation of the sound shader manager. More...

Inheritance diagram for SoundShaderManagerImplT:

Public Member Functions
	SoundShaderManagerImplT ()
	Constructor. More...

	~SoundShaderManagerImplT ()
	Destructor. More...

ArrayT< const SoundShaderT * >	RegisterSoundShaderScript (const std::string &ScriptFile, const std::string &ModDir)
	SoundShaderManagerI Implementation. More...

ArrayT< const SoundShaderT * >	RegisterSoundShaderScriptsInDir (const std::string &Directory, const std::string &ModDir, bool Recurse=true)
	Registers all ".caud" files inside a directory. More...

const SoundShaderT *	GetSoundShader (const std::string &Name)
	Searches for the shader specified by Name and returns it. More...

Public Member Functions inherited from SoundShaderManagerI
virtual	~SoundShaderManagerI ()
	Virtual destructor, so that nothing can go wrong and even g++ is happy. More...

Detailed Description

Standard implementation of the sound shader manager.

Constructor & Destructor Documentation

SoundShaderManagerImplT::SoundShaderManagerImplT ( )

Constructor.

SoundShaderManagerImplT::~SoundShaderManagerImplT ( )

Destructor.

const SoundShaderT * SoundShaderManagerImplT::GetSoundShader ( const std::string & Name )

virtual

Searches for the shader specified by Name and returns it.

Parameters

Name	The name of this sound shader as it is defined in the sound shader script. If no sound shader by this name is found the manager tries to interpret the Name as a filename to an audio file and automatically creates a default shader for it.

Returns: Pointer to the found sound shader or NULL if no sound shader with this name is registered and no default shader could be created.

ArrayT< const SoundShaderT * > SoundShaderManagerImplT::RegisterSoundShaderScript	(	const std::string &	ScriptFile,
		const std::string &	ModDir
	)

virtual

ArrayT< const SoundShaderT * > SoundShaderManagerImplT::RegisterSoundShaderScriptsInDir	(	const std::string &	Directory,
		const std::string &	ModDir,
		bool	Recurse = `true`
	)

virtual

Registers all ".caud" files inside a directory.

Parameters

Directory	The path from which sound shader script files should be registered.
ModDir	The directory of the MOD for which the sound shader script in this directory are registered relative to the executables directory.
Recurse	Determines if subdirectories are searched for ".caud" files recusively.

Returns: Array of new created sound shaders or empty array if a problem occured or no new sound shader definitions were found in the script.

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