FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::Echo Class Reference

The echo effect generates discrete, delayed instances of the input signal. More...

#include <soundeffect.h>

+ Inheritance diagram for FIFE::Echo:
+ Collaboration diagram for FIFE::Echo:

Public Member Functions

 Echo ()
 Constructor. More...
 
void setDelay (float value)
 Sets the delay between the original sound and the first ‘tap’, or echo instance. More...
 
float getDelay () const
 Return delay. More...
 
void setLrDelay (float value)
 Sets the delay between the first ‘tap’ and the second ‘tap’. More...
 
float getLrDelay () const
 Return LR delay. More...
 
void setDamping (float value)
 Sets damping, the amount of high frequency damping applied to each echo. More...
 
float getDamping () const
 Return damping. More...
 
void setFeedback (float value)
 Sets feedback, the amount of feedback the output signal fed back into the input. More...
 
float getFeedback () const
 Return feedback. More...
 
void setSpread (float value)
 Sets spread, that defines how hard panned the individual echoes are. More...
 
float getSpread () const
 Return spread. 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_delay
 
float m_lrDelay
 
float m_damping
 
float m_feedback
 
float m_spread
 

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 echo effect generates discrete, delayed instances of the input signal.

The amount of delay and feedback is controllable.

Definition at line 395 of file soundeffect.h.

Constructor & Destructor Documentation

FIFE::Echo::Echo ( )

Member Function Documentation

float FIFE::Echo::getDamping ( ) const

Return damping.

Definition at line 438 of file soundeffect.cpp.

References m_damping.

float FIFE::Echo::getDelay ( ) const

Return delay.

Definition at line 416 of file soundeffect.cpp.

References m_delay.

float FIFE::Echo::getFeedback ( ) const

Return feedback.

Definition at line 449 of file soundeffect.cpp.

References m_feedback.

float FIFE::Echo::getLrDelay ( ) const

Return LR delay.

Definition at line 427 of file soundeffect.cpp.

References m_lrDelay.

float FIFE::Echo::getSpread ( ) const

Return spread.

Definition at line 460 of file soundeffect.cpp.

References m_spread.

void FIFE::Echo::setDamping ( float  value)

Sets damping, the amount of high frequency damping applied to each echo.

Parameters
valueRange 0.0 to 0.99, default 0.5.

Definition at line 431 of file soundeffect.cpp.

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

void FIFE::Echo::setDelay ( float  value)

Sets the delay between the original sound and the first ‘tap’, or echo instance.

Parameters
valueRange 0.0 to 0.207, default 0.1.

Definition at line 409 of file soundeffect.cpp.

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

void FIFE::Echo::setFeedback ( float  value)

Sets feedback, the amount of feedback the output signal fed back into the input.

Parameters
valueRange 0.0 to 1.0, default 0.5.

Definition at line 442 of file soundeffect.cpp.

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

void FIFE::Echo::setLrDelay ( float  value)

Sets the delay between the first ‘tap’ and the second ‘tap’.

Parameters
valueRange 0.0 to 0.404, default 0.1.

Definition at line 420 of file soundeffect.cpp.

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

void FIFE::Echo::setSpread ( float  value)

Sets spread, that defines how hard panned the individual echoes are.

Parameters
valueRange -1.0 to 1.0, default -1.0.

Definition at line 453 of file soundeffect.cpp.

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

Member Data Documentation

float FIFE::Echo::m_damping
private

Definition at line 449 of file soundeffect.h.

Referenced by getDamping(), and setDamping().

float FIFE::Echo::m_delay
private

Definition at line 447 of file soundeffect.h.

Referenced by getDelay(), and setDelay().

float FIFE::Echo::m_feedback
private

Definition at line 450 of file soundeffect.h.

Referenced by getFeedback(), and setFeedback().

float FIFE::Echo::m_lrDelay
private

Definition at line 448 of file soundeffect.h.

Referenced by getLrDelay(), and setLrDelay().

float FIFE::Echo::m_spread
private

Definition at line 451 of file soundeffect.h.

Referenced by getSpread(), and setSpread().


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