FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::Equalizer Class Reference

The Equalizer providing tonal control over four different adjustable frequency ranges. More...

#include <soundeffect.h>

+ Inheritance diagram for FIFE::Equalizer:
+ Collaboration diagram for FIFE::Equalizer:

Public Member Functions

 Equalizer ()
 Constructor. More...
 
void setLowGain (float value)
 Sets low gain, the amount of cut or boost on the low frequency range. More...
 
float getLowGain () const
 Return low gain. More...
 
void setLowCutoff (float value)
 Sets low cutoff, the low frequency below which signal will be cut off. More...
 
float getLowCutoff () const
 Return low cutoff. More...
 
void setMid1Gain (float value)
 Sets mid1 gain, cut / boost signal on the “mid1” range. More...
 
float getMid1Gain () const
 Return mid1 gain. More...
 
void setMid1Center (float value)
 Sets mid1 center, the center frequency for the “mid1” range. More...
 
float getMid1Center () const
 Return mid1 center frequency. More...
 
void setMid1Width (float value)
 Sets mid1 width, the width of the “mid1” range. More...
 
float getMid1Width () const
 Return mid1 width. More...
 
void setMid2Gain (float value)
 Sets mid2 gain, cut / boost signal on the “mid2” range. More...
 
float getMid2Gain () const
 Return mid1 gain. More...
 
void setMid2Center (float value)
 Sets mid2 center, the center frequency for the “mid2” range. More...
 
float getMid2Center () const
 Return mid2 center frequency. More...
 
void setMid2Width (float value)
 Sets mid2 width, the width of the “mid2” range. More...
 
float getMid2Width () const
 Return mid2 width. More...
 
void setHighGain (float value)
 Sets high gain, cut / boost signal on the “high” range. More...
 
float getHighGain () const
 Return high gain. More...
 
void setHighCutoff (float value)
 Sets high cutoff, the high frequency above which signal will be cut off. More...
 
float getHighCutoff () const
 Return high cutoff frequency. More...
 
- Public Member Functions inherited from FIFE::SoundEffect
 SoundEffect ()
 Constructor. More...
 
virtual ~SoundEffect ()
 Destructor. More...
 
ALuint getEffectId () const
 Return the OpenAL effect handle. More...
 
void setSlotId (ALuint slot)
 Sets the OpenAL auxiliary slot handle. More...
 
ALuint getSlotId ()
 Return the OpenAL auxiliary slot handle. More...
 
SoundEffectType getEffectType () const
 Return sound effect type. More...
 
void setEnabled (bool enabled)
 Enables or disables the effect. More...
 
bool isEnabled () const
 Return true if the effect is enabled, false otherwise. More...
 
void setFilter (SoundFilter *filter)
 Sets the additional sound filter. More...
 
SoundFiltergetFilter ()
 Return sound filter or NULL. More...
 

Private Attributes

float m_lowGain
 
float m_lowCutoff
 
float m_mid1Gain
 
float m_mid1Center
 
float m_mid1Width
 
float m_mid2Gain
 
float m_mid2Center
 
float m_mid2Width
 
float m_highGain
 
float m_highCutoff
 

Additional Inherited Members

- Protected Attributes inherited from FIFE::SoundEffect
ALuint m_effect
 Effect object id. More...
 
ALuint m_slot
 Effect slot id;. More...
 
SoundEffectType m_effectType
 Sound effect type. More...
 
bool m_enabled
 Effect enabled. More...
 
SoundFilterm_filter
 Additional filter effect. More...
 

Detailed Description

The Equalizer providing tonal control over four different adjustable frequency ranges.

Low, Mid1, Mid2 and High.

Definition at line 810 of file soundeffect.h.

Constructor & Destructor Documentation

FIFE::Equalizer::Equalizer ( )

Member Function Documentation

float FIFE::Equalizer::getHighCutoff ( ) const

Return high cutoff frequency.

Definition at line 928 of file soundeffect.cpp.

References m_highCutoff.

float FIFE::Equalizer::getHighGain ( ) const

Return high gain.

Definition at line 917 of file soundeffect.cpp.

References m_highGain.

float FIFE::Equalizer::getLowCutoff ( ) const

Return low cutoff.

Definition at line 840 of file soundeffect.cpp.

References m_lowCutoff.

float FIFE::Equalizer::getLowGain ( ) const

Return low gain.

Definition at line 829 of file soundeffect.cpp.

References m_lowGain.

float FIFE::Equalizer::getMid1Center ( ) const

Return mid1 center frequency.

Definition at line 862 of file soundeffect.cpp.

References m_mid1Center.

float FIFE::Equalizer::getMid1Gain ( ) const

Return mid1 gain.

Definition at line 851 of file soundeffect.cpp.

References m_mid1Gain.

float FIFE::Equalizer::getMid1Width ( ) const

Return mid1 width.

Definition at line 873 of file soundeffect.cpp.

References m_mid1Width.

float FIFE::Equalizer::getMid2Center ( ) const

Return mid2 center frequency.

Definition at line 895 of file soundeffect.cpp.

References m_mid2Center.

float FIFE::Equalizer::getMid2Gain ( ) const

Return mid1 gain.

Definition at line 884 of file soundeffect.cpp.

References m_mid2Gain.

float FIFE::Equalizer::getMid2Width ( ) const

Return mid2 width.

Definition at line 906 of file soundeffect.cpp.

References m_mid2Width.

void FIFE::Equalizer::setHighCutoff ( float  value)

Sets high cutoff, the high frequency above which signal will be cut off.

Parameters
valueRange 4000.0 to 16000.0, default 6000.0.

Definition at line 921 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_highCutoff.

void FIFE::Equalizer::setHighGain ( float  value)

Sets high gain, cut / boost signal on the “high” range.

Parameters
valueRange 0.126 to 7.943, default 1.0.

Definition at line 910 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_highGain.

void FIFE::Equalizer::setLowCutoff ( float  value)

Sets low cutoff, the low frequency below which signal will be cut off.

Parameters
valueRange 50.0 to 800.0, default 200.0.

Definition at line 833 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_lowCutoff.

void FIFE::Equalizer::setLowGain ( float  value)

Sets low gain, the amount of cut or boost on the low frequency range.

Parameters
valueRange 0.126 to 7.943, default 1.0.

Definition at line 822 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_lowGain.

void FIFE::Equalizer::setMid1Center ( float  value)

Sets mid1 center, the center frequency for the “mid1” range.

Parameters
valueRange 200.0 to 3000.0, default 500.0.

Definition at line 855 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid1Center.

void FIFE::Equalizer::setMid1Gain ( float  value)

Sets mid1 gain, cut / boost signal on the “mid1” range.

Parameters
valueRange 0.126 to 7.943, default 1.0.

Definition at line 844 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid1Gain.

void FIFE::Equalizer::setMid1Width ( float  value)

Sets mid1 width, the width of the “mid1” range.

Parameters
valueRange 0.01 to 1.0, default 1.0.

Definition at line 866 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid1Width.

void FIFE::Equalizer::setMid2Center ( float  value)

Sets mid2 center, the center frequency for the “mid2” range.

Parameters
valueRange 1000.0 to 8000.0, default 3000.0.

Definition at line 888 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid2Center.

void FIFE::Equalizer::setMid2Gain ( float  value)

Sets mid2 gain, cut / boost signal on the “mid2” range.

Parameters
valueRange 0.126 to 7.943, default 1.0.

Definition at line 877 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid2Gain.

void FIFE::Equalizer::setMid2Width ( float  value)

Sets mid2 width, the width of the “mid2” range.

Parameters
valueRange 0.01 to 1.0, default 1.0.

Definition at line 899 of file soundeffect.cpp.

References FIFE::alEffectf, FIFE::SoundEffect::m_effect, and m_mid2Width.

Member Data Documentation

float FIFE::Equalizer::m_highCutoff
private

Definition at line 916 of file soundeffect.h.

Referenced by getHighCutoff(), and setHighCutoff().

float FIFE::Equalizer::m_highGain
private

Definition at line 915 of file soundeffect.h.

Referenced by getHighGain(), and setHighGain().

float FIFE::Equalizer::m_lowCutoff
private

Definition at line 908 of file soundeffect.h.

Referenced by getLowCutoff(), and setLowCutoff().

float FIFE::Equalizer::m_lowGain
private

Definition at line 907 of file soundeffect.h.

Referenced by getLowGain(), and setLowGain().

float FIFE::Equalizer::m_mid1Center
private

Definition at line 910 of file soundeffect.h.

Referenced by getMid1Center(), and setMid1Center().

float FIFE::Equalizer::m_mid1Gain
private

Definition at line 909 of file soundeffect.h.

Referenced by getMid1Gain(), and setMid1Gain().

float FIFE::Equalizer::m_mid1Width
private

Definition at line 911 of file soundeffect.h.

Referenced by getMid1Width(), and setMid1Width().

float FIFE::Equalizer::m_mid2Center
private

Definition at line 913 of file soundeffect.h.

Referenced by getMid2Center(), and setMid2Center().

float FIFE::Equalizer::m_mid2Gain
private

Definition at line 912 of file soundeffect.h.

Referenced by getMid2Gain(), and setMid2Gain().

float FIFE::Equalizer::m_mid2Width
private

Definition at line 914 of file soundeffect.h.

Referenced by getMid2Width(), and setMid2Width().


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