com.vwp.sound.mod.modplay.player.effect
Class LocalEffects

java.lang.Object
  extended by com.vwp.sound.mod.modplay.player.effect.LocalEffects
All Implemented Interfaces:
Effect

public class LocalEffects
extends java.lang.Object
implements Effect

Local effects are effects that only effects the track they are invoked in


Field Summary
 double noteSlide
           
 double noteTune
           
 double panningSlide
          Panning slide, accumulator
static int SAWTOOTH_TREMOLO
           
static int SAWTOOTH_VIBRATO
           
static int SINE_TREMOLO
           
static int SINE_VIBRATO
           
static int SQUARE_TREMOLO
           
static int SQUARE_VIBRATO
           
 double tremoloValue
           
 double volumeSlide
           
 
Fields inherited from interface com.vwp.sound.mod.modplay.player.effect.Effect
MOD_ARPEGGIO, MOD_EXTENDED_CUT_SAMPLE, MOD_EXTENDED_DELAY_PATTERN, MOD_EXTENDED_DELAY_SAMPLE, MOD_EXTENDED_FINE_SLIDE_DOWN, MOD_EXTENDED_FINE_SLIDE_UP, MOD_EXTENDED_FINE_VOLUME_SLIDE_DOWN, MOD_EXTENDED_FINE_VOLUME_SLIDE_UP, MOD_EXTENDED_FINETUNE, MOD_EXTENDED_INVERT_LOOP, MOD_EXTENDED_LOOP, MOD_EXTENDED_RETRIGGER_SAMPLE, MOD_EXTENDED_ROUGH_PANNING, MOD_EXTENDED_SET_FILTER, MOD_EXTENDED_SET_GLISSANDO, MOD_EXTENDED_SET_TREMOLO_WAVEFORM, MOD_EXTENDED_SET_VIBRATO_WAVEFORM, MOD_PANNING, MOD_PATTERN_BREAK, MOD_POSITION_JUMP, MOD_SET_SAMPLE_OFFSET, MOD_SET_SPEED, MOD_SET_VOLUME, MOD_SLIDE_DOWN, MOD_SLIDE_TO_NOTE, MOD_SLIDE_TO_NOTE_AND_VOLUME_SLIDE, MOD_SLIDE_UP, MOD_TREMOLO, MOD_VIBRATO, MOD_VIBRATO_AND_VOLUME_SLIDE, MOD_VOLUME_SLIDE, NO_EFFECT, S3M_TREMOR, XM_EXTENDED_FINE_SLIDE_DOWN, XM_EXTENDED_FINE_SLIDE_UP, XM_EXTENDED_FINE_VOLUME_SLIDE_DOWN, XM_EXTENDED_FINE_VOLUME_SLIDE_UP, XM_EXTRA_FINE_SLIDE_DOWN, XM_EXTRA_FINE_SLIDE_UP, XM_GLOBAL_VOLUME_SLIDE, XM_KEY_OFF, XM_MULTI_RETRIGGER_NOTE, XM_PANNING_SLIDE, XM_SET_ENVELOPE_POSITION, XM_SET_GLOBAL_VOLUME, XM_SLIDE_DOWN, XM_SLIDE_TO_NOTE, XM_SLIDE_UP, XM_VOLUME_SLIDE, XM_W
 
Constructor Summary
LocalEffects()
           
 
Method Summary
 void doEffect(TrackState state, int track, int pattern, int division, int tick, int effectNumber, int arg1, int arg2)
          do the effect
 void keyOff(TrackState state, int track, int tick)
           
 void modTremolo(TrackState state, int track, int tick, int effectNumber, int arg1, int arg2)
           
 void newInstrument(int instrument)
           
 void newNote(int note)
           
 void newNoteAndInstrument(int note, int instrument)
           
 void postEffect(TrackState state, int track, int pattern, int division, int tick, int effectNumber, int arg1, int arg2)
          do whatever needs to be done after the tick is played
 void preEffect(TrackState state, int track, int pattern, int division, int tick, int effectNumber, int arg1, int arg2)
          do whatever needs to be done before the track is played
 void reset()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tremoloValue

public double tremoloValue

volumeSlide

public double volumeSlide

panningSlide

public double panningSlide
Panning slide, accumulator


noteTune

public double noteTune

noteSlide

public double noteSlide

SINE_TREMOLO

public static final int SINE_TREMOLO
See Also:
Constant Field Values

SAWTOOTH_TREMOLO

public static final int SAWTOOTH_TREMOLO
See Also:
Constant Field Values

SQUARE_TREMOLO

public static final int SQUARE_TREMOLO
See Also:
Constant Field Values

SINE_VIBRATO

public static final int SINE_VIBRATO
See Also:
Constant Field Values

SAWTOOTH_VIBRATO

public static final int SAWTOOTH_VIBRATO
See Also:
Constant Field Values

SQUARE_VIBRATO

public static final int SQUARE_VIBRATO
See Also:
Constant Field Values
Constructor Detail

LocalEffects

public LocalEffects()
Method Detail

preEffect

public void preEffect(TrackState state,
                      int track,
                      int pattern,
                      int division,
                      int tick,
                      int effectNumber,
                      int arg1,
                      int arg2)
do whatever needs to be done before the track is played

Parameters:
state -
track -
pattern -
division -
tick -
effectNumber -
arg1 -
arg2 -

doEffect

public void doEffect(TrackState state,
                     int track,
                     int pattern,
                     int division,
                     int tick,
                     int effectNumber,
                     int arg1,
                     int arg2)
do the effect

Parameters:
state -
track -
pattern -
division -
tick -
effectNumber -
arg1 -
arg2 -

postEffect

public void postEffect(TrackState state,
                       int track,
                       int pattern,
                       int division,
                       int tick,
                       int effectNumber,
                       int arg1,
                       int arg2)
do whatever needs to be done after the tick is played

Parameters:
state -
track -
pattern -
division -
tick -
effectNumber -
arg1 -
arg2 -

newNote

public void newNote(int note)

newInstrument

public void newInstrument(int instrument)

newNoteAndInstrument

public void newNoteAndInstrument(int note,
                                 int instrument)

reset

public void reset()

modTremolo

public void modTremolo(TrackState state,
                       int track,
                       int tick,
                       int effectNumber,
                       int arg1,
                       int arg2)

keyOff

public void keyOff(TrackState state,
                   int track,
                   int tick)