A class that opaquely wraps an arbitrary sound effect that has a SoundFilter interface. More...

#include <omSoundPlugin.h>

Public Member Functions
	SoundPlugin ()
	Create a new default empty invalid sound plugin. More...

	SoundPlugin (const PluginID &newID)
	Create a new sound plugin for the given plugin ID, but with no filter. More...

	SoundPlugin (const PluginID &newID, const Shared< SoundFilter > &newFilter)
	Create a new sound plugin for the given plugin ID and sound filter. More...

const Shared< SoundFilter > &	getFilter () const
	Return a pointer to the sound filter this plugin is wrapping. More...

void	setFilter (const Shared< SoundFilter > &newFilter)
	Set a pointer to the sound filter this plugin is wrapping. More...

const PluginID &	getID () const
	Return an object that uniquely represents this plugin's identifier. More...

void	setID (const PluginID &newID)
	Set an object that uniquely represents this plugin's identifier. More...

Static Public Attributes
static const om::resources::ResourceType	RESOURCE_TYPE
	The resource type for a sound plugin. More...

Detailed Description

A class that opaquely wraps an arbitrary sound effect that has a SoundFilter interface.

Constructor & Destructor Documentation

om::sound::plugins::SoundPlugin::SoundPlugin ( )

Create a new default empty invalid sound plugin.

om::sound::plugins::SoundPlugin::SoundPlugin ( const PluginID & newID )

Create a new sound plugin for the given plugin ID, but with no filter.

om::sound::plugins::SoundPlugin::SoundPlugin	(	const PluginID &	newID,
		const Shared< SoundFilter > &	newFilter
	)

Create a new sound plugin for the given plugin ID and sound filter.

const Shared<SoundFilter>& om::sound::plugins::SoundPlugin::getFilter ( ) const

inline

Return a pointer to the sound filter this plugin is wrapping.

void om::sound::plugins::SoundPlugin::setFilter ( const Shared< SoundFilter > & newFilter )

inline

Set a pointer to the sound filter this plugin is wrapping.

const PluginID& om::sound::plugins::SoundPlugin::getID ( ) const

inline

Return an object that uniquely represents this plugin's identifier.

void om::sound::plugins::SoundPlugin::setID ( const PluginID & newID )

inline

Set an object that uniquely represents this plugin's identifier.

const om::resources::ResourceType om::sound::plugins::SoundPlugin::RESOURCE_TYPE

static

The resource type for a sound plugin.

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