deSynthesizerEffect Class Reference

Synthesizer effect. More...

#include <deSynthesizerEffect.h>

Inheritance diagram for deSynthesizerEffect:

Public Types
typedef deTObjectReference< deSynthesizerEffect >	Ref
	Type holding strong reference. More...
Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deSynthesizer *	GetSynthesizer () const
	Parent synthesizer. More...
void	SetSynthesizer (deSynthesizer *synthesizer)
	Set parent synthesizer. More...
bool	GetEnabled () const
	Effect is enabled. More...
void	SetEnabled (bool enabled)
	Set if effect is enabled. More...
float	GetStrength () const
	Strength. More...
void	SetStrength (float strength)
	Set strength. More...
deSynthesizerControllerTarget &	GetTargetStrength ()
	Strength target. More...
const deSynthesizerControllerTarget &	GetTargetStrength () const
Visiting
virtual void	Visit (deSynthesizerEffectVisitor &visitor)
	Visit effect. More...
Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...
void	AddReference ()
	Add reference increasing reference count by 1. More...
void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...
	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deSynthesizerEffect ()
	Create synthesizer effect. More...
virtual	~deSynthesizerEffect ()
	Clean up synthesizer effect. More...

Additional Inherited Members
Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Synthesizer effect.

Member Typedef Documentation

Ref

typedef deTObjectReference<deSynthesizerEffect> deSynthesizerEffect::Ref

Type holding strong reference.

Constructor & Destructor Documentation

deSynthesizerEffect()

deSynthesizerEffect::deSynthesizerEffect

(

)

Create synthesizer effect.

~deSynthesizerEffect()

virtual deSynthesizerEffect::~deSynthesizerEffect ( )

protectedvirtual

Clean up synthesizer effect.

Note

Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

GetEnabled()

bool deSynthesizerEffect::GetEnabled ( ) const

inline

Effect is enabled.

GetStrength()

float deSynthesizerEffect::GetStrength ( ) const

inline

Strength.

GetSynthesizer()

deSynthesizer* deSynthesizerEffect::GetSynthesizer ( ) const

inline

Parent synthesizer.

GetTargetStrength() [1/2]

deSynthesizerControllerTarget& deSynthesizerEffect::GetTargetStrength ( )

inline

Strength target.

GetTargetStrength() [2/2]

const deSynthesizerControllerTarget& deSynthesizerEffect::GetTargetStrength ( ) const

inline

SetEnabled()

void deSynthesizerEffect::SetEnabled

(

bool

enabled

)

Set if effect is enabled.

SetStrength()

void deSynthesizerEffect::SetStrength

(

float

strength

)

Set strength.

SetSynthesizer()

void deSynthesizerEffect::SetSynthesizer

(

deSynthesizer *

synthesizer

)

Set parent synthesizer.

This function has to be used only by the deSynthesizer class to assign itself as a parent. Do not call this function directly.

Visit()

virtual void deSynthesizerEffect::Visit ( deSynthesizerEffectVisitor &  visitor )

virtual

Visit effect.

Reimplemented in deSynthesizerEffectStretch.

---

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

• deSynthesizerEffect.h