com.vwp.sound.mod.modplay.player.autoeffect
Interface AutoEffect

All Known Subinterfaces:
Envelope
All Known Implementing Classes:
AutoVibrato, Fadeout, PanningEnvelope, VolumeEnvelope, XmAutoEffects

public interface AutoEffect

Interface inplemented by all autoefects. The .XM format defines autoeffects for each instrument and new instances of the effects are created for each time the instrument is played. This means that there ar maximum numberOfTracks autoeffects of a given type active for a given instrument at any one time. All AutoEffect objects are associated with an instrument and each AutoEffect object handles numberOfTracks instances of that spesific autoeffect, one for each track.


Method Summary
 void doEffect(TrackState state, int track)
          perform the effect
 void keyOff(int track)
          signal to the autoeffect that a key-off note/effect was played
 void newNote(double note, int track)
          tells the autoeffect that a new note is played.
 void reset(int track)
          reset the effect in the given track
 void setNumberOfTracks(int tracks)
          sets the number of track in a module
 

Method Detail

setNumberOfTracks

void setNumberOfTracks(int tracks)
sets the number of track in a module

Parameters:
tracks - the number of tracks in a module

newNote

void newNote(double note,
             int track)
tells the autoeffect that a new note is played.

Parameters:
note - the new note
track - the track where the note is played

doEffect

void doEffect(TrackState state,
              int track)
perform the effect

Parameters:
state - the state of the track where the effect is used
track - the number of the track where effect is used

reset

void reset(int track)
reset the effect in the given track

Parameters:
track -

keyOff

void keyOff(int track)
signal to the autoeffect that a key-off note/effect was played

Parameters:
track -