Drag[en]gine Script Module DragonScript Script API  1.0
SDEffect Class Referenceabstract

Definition of synthesizer effect. More...

Inheritance diagram for SDEffect:
SDEffectStretch

Public Member Functions

void addTargetLink (SDSourceTargetLink targetLink)
 Add target link. More...
 
SynthesizerEffect buildEffect (Synthesizer synthesizer)
 Build engine synthesizer effect using the stored definition. More...
 
void debug (Console console)
 
void forEachTarget (Block ablock)
 Visit targets with a block. More...
 
float getStrength ()
 Strength of effect. More...
 
SDSourceTargetLink getTargetLinkAt (int index)
 Target link at index. More...
 
int getTargetLinkCount ()
 Number of target links. More...
 
SDEffect new ()
 Create synthesizer effect definition. More...
 
void setEnabled (bool enabled)
 Set if effect is enabled. More...
 
void setStrength (float strength)
 Set strength of effect. More...
 

Protected Member Functions

String debugCommon (String type)
 

Detailed Description

Definition of synthesizer effect.

Once defined a effect can be added to an synthesizer using the stored definition. This is the base effect class with the properties shared amongst all effect types.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addTargetLink()

void addTargetLink ( SDSourceTargetLink  targetLink)

Add target link.

§ buildEffect()

SynthesizerEffect buildEffect ( Synthesizer  synthesizer)

Build engine synthesizer effect using the stored definition.

§ debug()

void debug ( Console  console)

§ debugCommon()

String debugCommon ( String  type)
protected

§ forEachTarget()

void forEachTarget ( Block  ablock)

Visit targets with a block.

§ getStrength()

float getStrength ( )

Strength of effect.

§ getTargetLinkAt()

SDSourceTargetLink getTargetLinkAt ( int  index)

Target link at index.

§ getTargetLinkCount()

int getTargetLinkCount ( )

Number of target links.

§ new()

SDEffect new ( )

Create synthesizer effect definition.

§ setEnabled()

void setEnabled ( bool  enabled)

Set if effect is enabled.

§ setStrength()

void setStrength ( float  strength)

Set strength of effect.


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