Effect Class Reference

#include <Effect.h>

Inherited by Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

List of all members.

Public Member Functions
	Effect (const int &insertion_, REALTYPE *const efxoutl_, REALTYPE *const efxoutr_, FilterParams *filterpars_, const unsigned char &Ppreset_)
virtual	~Effect ()
virtual void	setpreset (unsigned char npreset)
virtual void	changepar (const int &npar, const unsigned char &value)
virtual unsigned char	getpar (const int &npar) const
virtual void	cleanup ()
virtual REALTYPE	getfreqresponse (REALTYPE freq)
Public Attributes
REALTYPE *const	efxoutl
REALTYPE *const	efxoutr
REALTYPE	outvolume
FilterParams *	filterpars
Protected Attributes
const int	insertion

---

Detailed Description

this class is inherited by the all effects(Reverb, Echo, ..)

---

Constructor & Destructor Documentation

Effect::Effect	(	const int &	insertion_,
		REALTYPE *const	efxoutl_,
		REALTYPE *const	efxoutr_,
		FilterParams *	filterpars_,
		const unsigned char &	Ppreset_
	)

Effect Constructor

Parameters:

	insertion_	1 when it is an insertion Effect and 0 when it is not an insertion Effect
	efxoutl_	Effect output buffer Left channel
	efxoutr_	Effect output buffer Right channel
	filterpars_	pointer to FilterParams array
	Ppreset_	chosen preset

Returns:

Initialized Effect object

virtual Effect::~Effect

(

)

[inline, virtual]

Deconstructor

---

Member Function Documentation

virtual void Effect::changepar	(	const int &	npar,
		const unsigned char &	value
	)			[inline, virtual]

Change parameter npar to value

Parameters:

	npar	chosen parameter
	value	chosen new value

Reimplemented in Alienwah, Echo, EQ, and Reverb.

virtual void Effect::cleanup

(

)

[inline, virtual]

Reset the state of the effect

Reimplemented in Alienwah, Echo, EQ, and Reverb.

virtual REALTYPE Effect::getfreqresponse

(

REALTYPE

freq

)

[inline, virtual]

This is only used for EQ (for user interface)

Reimplemented in EQ.

virtual unsigned char Effect::getpar

(

const int &

npar

)

const [inline, virtual]

Get the value of parameter npar

Parameters:

npar

chosen parameter

Returns:

the value of the parameter in an unsigned char or 0 if it does not exist

Reimplemented in Alienwah, Echo, EQ, and Reverb.

virtual void Effect::setpreset

(

unsigned char

npreset

)

[inline, virtual]

Choose a preset

Parameters:

npreset

number of chosen preset

Reimplemented in Alienwah, Echo, EQ, and Reverb.

---

Member Data Documentation

REALTYPE* const Effect::efxoutl

Effect out Left Channel

REALTYPE* const Effect::efxoutr

Effect out Right Channel

FilterParams* Effect::filterpars

Parameters for filters used by Effect

const int Effect::insertion [protected]

If Effect is an insertion effect, insertion=1 otherwise, it should be insertion=0

REALTYPE Effect::outvolume

This is the volume of effect and is public because it is needed in system effects. The out volume of such effects are always 1.0, so this setting tells me how is the volume to the Master Output only.

---

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

• Effects/Effect.h
• Effects/Effect.C