FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::Autowah Class Reference

The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument. More...

#include <soundeffect.h>

+ Inheritance diagram for FIFE::Autowah:
+ Collaboration diagram for FIFE::Autowah:

Public Member Functions

 Autowah ()
 Constructor. More...
 
void setAttackTime (float value)
 Sets attack time, the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal. More...
 
float getAttackTime () const
 Return attack time. More...
 
void setReleaseTime (float value)
 Sets relase time, the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends. More...
 
float getReleaseTime () const
 Return release time. More...
 
void setResonance (float value)
 Sets resonance, the peak, some times known as emphasis or Q, of the auto-wah band-pass filter. More...
 
float getResonance () const
 Return resonance. More...
 
void setPeakGain (float value)
 Sets peak gain, the input signal level at which the band-pass filter will be fully opened. More...
 
float getPeakGain () const
 Return peak gain. 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_attackTime
 
float m_releaseTime
 
float m_resonance
 
float m_peakGain
 

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 Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument.

Definition at line 732 of file soundeffect.h.

Constructor & Destructor Documentation

FIFE::Autowah::Autowah ( )

Member Function Documentation

float FIFE::Autowah::getAttackTime ( ) const

Return attack time.

Definition at line 753 of file soundeffect.cpp.

References m_attackTime.

float FIFE::Autowah::getPeakGain ( ) const

Return peak gain.

Definition at line 786 of file soundeffect.cpp.

References m_peakGain.

float FIFE::Autowah::getReleaseTime ( ) const

Return release time.

Definition at line 764 of file soundeffect.cpp.

References m_releaseTime.

float FIFE::Autowah::getResonance ( ) const

Return resonance.

Definition at line 775 of file soundeffect.cpp.

References m_resonance.

void FIFE::Autowah::setAttackTime ( float  value)

Sets attack time, the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal.

Parameters
valueRange 0.0001 to 1.0, default 0.06.

Definition at line 746 of file soundeffect.cpp.

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

void FIFE::Autowah::setPeakGain ( float  value)

Sets peak gain, the input signal level at which the band-pass filter will be fully opened.

Parameters
valueRange 0.00003 to 31621.0, default 11.22.

Definition at line 779 of file soundeffect.cpp.

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

void FIFE::Autowah::setReleaseTime ( float  value)

Sets relase time, the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends.

Parameters
valueRange 0.0001 to 1.0, default 0.06.

Definition at line 757 of file soundeffect.cpp.

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

void FIFE::Autowah::setResonance ( float  value)

Sets resonance, the peak, some times known as emphasis or Q, of the auto-wah band-pass filter.

Parameters
valueRange 2.0 to 1000.0, default 1000.0.

Definition at line 768 of file soundeffect.cpp.

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

Member Data Documentation

float FIFE::Autowah::m_attackTime
private

Definition at line 779 of file soundeffect.h.

Referenced by getAttackTime(), and setAttackTime().

float FIFE::Autowah::m_peakGain
private

Definition at line 782 of file soundeffect.h.

Referenced by getPeakGain(), and setPeakGain().

float FIFE::Autowah::m_releaseTime
private

Definition at line 780 of file soundeffect.h.

Referenced by getReleaseTime(), and setReleaseTime().

float FIFE::Autowah::m_resonance
private

Definition at line 781 of file soundeffect.h.

Referenced by getResonance(), and setResonance().


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