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

Definition of synthesizer source. More...

Inheritance diagram for SDSource:
SDSourceChain SDSourceGroup SDSourceSound SDSourceSynthesizer SDSourceWave

Public Member Functions

void addEffect (SDEffect effect)
 Add effect. More...
 
void addTargetLink (SDSourceTargetLink targetLink)
 Add target link. More...
 
void debug (Console console)
 
void forEachEffect (Block ablock)
 Visit effects using a block. More...
 
void forEachTarget (Block ablock)
 Visit targets with a block. More...
 
float getBlendFactor ()
 Blend factor. More...
 
SDEffect getEffectAt (int index)
 Effect at index. More...
 
int getEffectCount ()
 Number of effects. More...
 
float getMaxPanning ()
 Maximum panning. More...
 
float getMaxVolume ()
 Maximum volume. More...
 
float getMinPanning ()
 Minimum panning. More...
 
float getMinVolume ()
 Minimum volume. More...
 
int getMixMode ()
 Mix mode. More...
 
String getName ()
 Name of source. More...
 
SDSourceTargetLink getTargetLinkAt (int index)
 Target link at index. More...
 
int getTargetLinkCount ()
 Number of target links. More...
 
SDSource new ()
 Create synthesizer source definition. More...
 
void removeAllEffects ()
 Remove all effects. More...
 
void removeEffect (SDEffect effect)
 Remove effect. More...
 
void setBlendFactor (float factor)
 Set blend factor. More...
 
void setEnabled (bool enabled)
 Set if source is enabled. More...
 
void setMaxPanning (float panning)
 Set maximum panning. More...
 
void setMaxVolume (float volume)
 Set maximum volume. More...
 
void setMinPanning (float panning)
 Set minimum panning. More...
 
void setMinVolume (float volume)
 Set minimum volume. More...
 
void setMixMode (int mode)
 Set mix mode. More...
 
void setName (String name)
 Set name of source. More...
 

Protected Member Functions

String debugCommon (Console console, String type)
 

Detailed Description

Definition of synthesizer source.

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

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addEffect()

void addEffect ( SDEffect  effect)

Add effect.

§ addTargetLink()

void addTargetLink ( SDSourceTargetLink  targetLink)

Add target link.

§ debug()

void debug ( Console  console)

§ debugCommon()

String debugCommon ( Console  console,
String  type 
)
protected

§ forEachEffect()

void forEachEffect ( Block  ablock)

Visit effects using a block.

§ forEachTarget()

void forEachTarget ( Block  ablock)

Visit targets with a block.

§ getBlendFactor()

float getBlendFactor ( )

Blend factor.

§ getEffectAt()

SDEffect getEffectAt ( int  index)

Effect at index.

§ getEffectCount()

int getEffectCount ( )

Number of effects.

§ getMaxPanning()

float getMaxPanning ( )

Maximum panning.

§ getMaxVolume()

float getMaxVolume ( )

Maximum volume.

§ getMinPanning()

float getMinPanning ( )

Minimum panning.

§ getMinVolume()

float getMinVolume ( )

Minimum volume.

§ getMixMode()

int getMixMode ( )

Mix mode.

§ getName()

String getName ( )

Name of source.

§ getTargetLinkAt()

SDSourceTargetLink getTargetLinkAt ( int  index)

Target link at index.

§ getTargetLinkCount()

int getTargetLinkCount ( )

Number of target links.

§ new()

SDSource new ( )

Create synthesizer source definition.

§ removeAllEffects()

void removeAllEffects ( )

Remove all effects.

§ removeEffect()

void removeEffect ( SDEffect  effect)

Remove effect.

§ setBlendFactor()

void setBlendFactor ( float  factor)

Set blend factor.

§ setEnabled()

void setEnabled ( bool  enabled)

Set if source is enabled.

§ setMaxPanning()

void setMaxPanning ( float  panning)

Set maximum panning.

§ setMaxVolume()

void setMaxVolume ( float  volume)

Set maximum volume.

§ setMinPanning()

void setMinPanning ( float  panning)

Set minimum panning.

§ setMinVolume()

void setMinVolume ( float  volume)

Set minimum volume.

§ setMixMode()

void setMixMode ( int  mode)

Set mix mode.

§ setName()

void setName ( String  name)

Set name of source.


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