FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::SoundEffect Class Reference

Base class for Efx sound effects. More...

#include <soundeffect.h>

+ Inheritance diagram for FIFE::SoundEffect:
+ Collaboration diagram for FIFE::SoundEffect:

Public Member Functions

 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...
 

Protected Attributes

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

Base class for Efx sound effects.

Definition at line 46 of file soundeffect.h.

Constructor & Destructor Documentation

FIFE::SoundEffect::SoundEffect ( )

Constructor.

Definition at line 45 of file soundeffect.cpp.

References FIFE::alGenEffects, and m_effect.

FIFE::SoundEffect::~SoundEffect ( )
virtual

Destructor.

Definition at line 55 of file soundeffect.cpp.

References FIFE::alDeleteEffects, and m_effect.

Member Function Documentation

ALuint FIFE::SoundEffect::getEffectId ( ) const

Return the OpenAL effect handle.

Definition at line 59 of file soundeffect.cpp.

References m_effect.

Referenced by FIFE::SoundEffectManager::enableSoundEffect().

+ Here is the caller graph for this function:

SoundEffectType FIFE::SoundEffect::getEffectType ( ) const

Return sound effect type.

See also
SoundEffectType

Definition at line 71 of file soundeffect.cpp.

References m_effectType.

SoundFilter * FIFE::SoundEffect::getFilter ( )

Return sound filter or NULL.

Definition at line 87 of file soundeffect.cpp.

References m_filter.

Referenced by FIFE::SoundEffectManager::activateEffect(), FIFE::SoundEffectManager::addSoundFilterToSoundEffect(), FIFE::SoundEffectManager::deleteSoundEffect(), and FIFE::SoundEffectManager::enableSoundEffect().

+ Here is the caller graph for this function:

ALuint FIFE::SoundEffect::getSlotId ( )

Return the OpenAL auxiliary slot handle.

Definition at line 67 of file soundeffect.cpp.

References m_slot.

Referenced by FIFE::SoundEffectManager::activateEffect(), and FIFE::SoundEffectManager::disableSoundEffect().

+ Here is the caller graph for this function:

bool FIFE::SoundEffect::isEnabled ( ) const
void FIFE::SoundEffect::setEnabled ( bool  enabled)

Enables or disables the effect.

Parameters
enabledA bool to indicate if the effect is enabled or disabled.

Definition at line 75 of file soundeffect.cpp.

References m_enabled.

Referenced by FIFE::SoundEffectManager::disableSoundEffect(), and FIFE::SoundEffectManager::enableSoundEffect().

+ Here is the caller graph for this function:

void FIFE::SoundEffect::setFilter ( SoundFilter filter)

Sets the additional sound filter.

Parameters
filterThe SoundFilter or NULL.

Definition at line 83 of file soundeffect.cpp.

References m_filter.

Referenced by FIFE::SoundEffectManager::addSoundFilterToSoundEffect(), and FIFE::SoundEffectManager::removeSoundFilterFromSoundEffect().

+ Here is the caller graph for this function:

void FIFE::SoundEffect::setSlotId ( ALuint  slot)

Sets the OpenAL auxiliary slot handle.

Definition at line 63 of file soundeffect.cpp.

References m_slot.

Referenced by FIFE::SoundEffectManager::disableSoundEffect(), and FIFE::SoundEffectManager::enableSoundEffect().

+ Here is the caller graph for this function:

Member Data Documentation

ALuint FIFE::SoundEffect::m_effect
protected

Effect object id.

Definition at line 93 of file soundeffect.h.

Referenced by FIFE::Autowah::Autowah(), FIFE::Chorus::Chorus(), FIFE::Compressor::Compressor(), FIFE::Distortion::Distortion(), FIFE::EaxReverb::EaxReverb(), FIFE::Echo::Echo(), FIFE::Equalizer::Equalizer(), FIFE::Flanger::Flanger(), FIFE::FrequencyShifter::FrequencyShifter(), getEffectId(), FIFE::PitchShifter::PitchShifter(), FIFE::Reverb::Reverb(), FIFE::RingModulator::RingModulator(), FIFE::Reverb::setAirAbsorptionGainHf(), FIFE::EaxReverb::setAirAbsorptionGainHf(), FIFE::Autowah::setAttackTime(), FIFE::PitchShifter::setCoarseTune(), FIFE::Compressor::setCompressor(), FIFE::Echo::setDamping(), FIFE::Reverb::setDecayHfLimit(), FIFE::EaxReverb::setDecayHfLimit(), FIFE::Reverb::setDecayHfRatio(), FIFE::EaxReverb::setDecayHfRatio(), FIFE::EaxReverb::setDecayLfRatio(), FIFE::Reverb::setDecayTime(), FIFE::EaxReverb::setDecayTime(), FIFE::Chorus::setDelay(), FIFE::Echo::setDelay(), FIFE::Flanger::setDelay(), FIFE::Reverb::setDensity(), FIFE::EaxReverb::setDensity(), FIFE::Chorus::setDepth(), FIFE::Flanger::setDepth(), FIFE::Reverb::setDiffusion(), FIFE::EaxReverb::setDiffusion(), FIFE::EaxReverb::setEchoDepth(), FIFE::EaxReverb::setEchoTime(), FIFE::Distortion::setEdge(), FIFE::Distortion::setEqBandwidth(), FIFE::Distortion::setEqCenter(), FIFE::Chorus::setFeedback(), FIFE::Echo::setFeedback(), FIFE::Flanger::setFeedback(), FIFE::PitchShifter::setFineTune(), FIFE::FrequencyShifter::setFrequency(), FIFE::RingModulator::setFrequency(), FIFE::Reverb::setGain(), FIFE::Distortion::setGain(), FIFE::EaxReverb::setGain(), FIFE::Reverb::setGainHf(), FIFE::EaxReverb::setGainHf(), FIFE::EaxReverb::setGainLf(), FIFE::EaxReverb::setHfReference(), FIFE::Equalizer::setHighCutoff(), FIFE::Equalizer::setHighGain(), FIFE::RingModulator::setHighpassCutoff(), FIFE::Reverb::setLateReverbDelay(), FIFE::EaxReverb::setLateReverbDelay(), FIFE::Reverb::setLateReverbGain(), FIFE::EaxReverb::setLateReverbGain(), FIFE::EaxReverb::setLateReverbPan(), FIFE::FrequencyShifter::setLeftDirection(), FIFE::EaxReverb::setLfReference(), FIFE::Equalizer::setLowCutoff(), FIFE::Equalizer::setLowGain(), FIFE::Distortion::setLowpassCutoff(), FIFE::Echo::setLrDelay(), FIFE::Equalizer::setMid1Center(), FIFE::Equalizer::setMid1Gain(), FIFE::Equalizer::setMid1Width(), FIFE::Equalizer::setMid2Center(), FIFE::Equalizer::setMid2Gain(), FIFE::Equalizer::setMid2Width(), FIFE::EaxReverb::setModulationDepth(), FIFE::EaxReverb::setModulationTime(), FIFE::Autowah::setPeakGain(), FIFE::Chorus::setPhase(), FIFE::Flanger::setPhase(), FIFE::VocalMorpher::setPhonemeA(), FIFE::VocalMorpher::setPhonemeB(), FIFE::VocalMorpher::setPhonemeCoarseA(), FIFE::VocalMorpher::setPhonemeCoarseB(), FIFE::Chorus::setRate(), FIFE::Flanger::setRate(), FIFE::VocalMorpher::setRate(), FIFE::Reverb::setReflectionsDelay(), FIFE::EaxReverb::setReflectionsDelay(), FIFE::Reverb::setReflectionsGain(), FIFE::EaxReverb::setReflectionsGain(), FIFE::EaxReverb::setReflectionsPan(), FIFE::Autowah::setReleaseTime(), FIFE::Autowah::setResonance(), FIFE::FrequencyShifter::setRightDirection(), FIFE::Reverb::setRoomRolloffFactor(), FIFE::EaxReverb::setRoomRolloffFactor(), FIFE::Echo::setSpread(), FIFE::VocalMorpher::setWaveform(), FIFE::RingModulator::setWaveform(), FIFE::Chorus::setWaveformTriangle(), FIFE::Flanger::setWaveformTriangle(), SoundEffect(), FIFE::VocalMorpher::VocalMorpher(), and ~SoundEffect().

bool FIFE::SoundEffect::m_enabled
protected

Effect enabled.

Definition at line 99 of file soundeffect.h.

Referenced by isEnabled(), and setEnabled().

SoundFilter* FIFE::SoundEffect::m_filter
protected

Additional filter effect.

Definition at line 101 of file soundeffect.h.

Referenced by getFilter(), and setFilter().

ALuint FIFE::SoundEffect::m_slot
protected

Effect slot id;.

Definition at line 95 of file soundeffect.h.

Referenced by getSlotId(), and setSlotId().


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