om::sound::filters::FilterPreset Class Reference

A class that represents a preset configuration for a SoundFilter. More...

#include <omSoundFilterPreset.h>

Public Member Functions
	FilterPreset ()
	Create a new sound filter preset with no name or data stored. More...
	FilterPreset (const UTF8String &newName)
	Create a new sound filter preset with the specified name and no data stored. More...
	FilterPreset (const UTF8String &newName, const FilterState &newState)
	Create a new sound filter preset with the specified name and filter state structure. More...
FilterState &	getState ()
	Return a reference to the FilterState object that contains the information for this preset. More...
const FilterState &	getState () const
	Return a reference to the FilterState object that contains the information for this preset. More...
void	setState (const FilterState &newState)
	Set the FilterState object that contains the information for this preset. More...
const UTF8String &	getName () const
	Return the human-readable name of this filter preset. More...
void	setName (const UTF8String &newName)
	Set the human-readable name of this filter preset. More...

Detailed Description

A class that represents a preset configuration for a SoundFilter.

A sound filter preset contains a FilterState object that stores the preset configuration, as well as a human-readable name associated with the preset.

Constructor & Destructor Documentation

om::sound::filters::FilterPreset::FilterPreset ( )

inline

Create a new sound filter preset with no name or data stored.

om::sound::filters::FilterPreset::FilterPreset ( const UTF8String &  newName )

inline

Create a new sound filter preset with the specified name and no data stored.

om::sound::filters::FilterPreset::FilterPreset ( const UTF8String &  newName, const FilterState &  newState  )

inline

Create a new sound filter preset with the specified name and filter state structure.

Member Function Documentation

FilterState& om::sound::filters::FilterPreset::getState ( )

inline

Return a reference to the FilterState object that contains the information for this preset.

const FilterState& om::sound::filters::FilterPreset::getState ( ) const

inline

Return a reference to the FilterState object that contains the information for this preset.

void om::sound::filters::FilterPreset::setState ( const FilterState &  newState )

inline

Set the FilterState object that contains the information for this preset.

const UTF8String& om::sound::filters::FilterPreset::getName ( ) const

inline

Return the human-readable name of this filter preset.

void om::sound::filters::FilterPreset::setName ( const UTF8String &  newName )

inline

Set the human-readable name of this filter preset.

---

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

• omSoundFilterPreset.h