com.vwp.sound.mod.modplay.loader
Class XmUnits

java.lang.Object
  extended by com.vwp.sound.mod.modplay.loader.XmUnits
All Implemented Interfaces:
ModuleUnits

public class XmUnits
extends java.lang.Object
implements ModuleUnits

Conversions between notes, rates and periods used by .XMs


Field Summary
static double MAX_NOTE
          The maximum note value used by .XMs
static double MIN_NOTE
          The minimum note value used by .XMs
 
Constructor Summary
XmUnits()
           
 
Method Summary
 double addPeriod(double note, double period)
          adds a period value to a note value
 double getLowerNoteLimit()
          gets the lowest note that can be played in a module
 java.lang.String getName()
           
 double getUpperNoteLimit()
          gets the highest note that can be played in a module
 double note2period(double note)
          converts a note value to a period value
 double note2rate(double note)
          converts a note value to a rate value
 double period2note(double period)
          converts a period value to a note value
 double period2rate(double period)
           
 double rate2note(double rate)
          converts a rate value to a note value
 double rate2period(double rate)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX_NOTE

public static final double MAX_NOTE
The maximum note value used by .XMs

See Also:
Constant Field Values

MIN_NOTE

public static final double MIN_NOTE
The minimum note value used by .XMs

See Also:
Constant Field Values
Constructor Detail

XmUnits

public XmUnits()
Method Detail

period2rate

public double period2rate(double period)

rate2period

public double rate2period(double rate)

period2note

public double period2note(double period)
Description copied from interface: ModuleUnits
converts a period value to a note value

Specified by:
period2note in interface ModuleUnits

note2period

public double note2period(double note)
Description copied from interface: ModuleUnits
converts a note value to a period value

Specified by:
note2period in interface ModuleUnits

note2rate

public double note2rate(double note)
Description copied from interface: ModuleUnits
converts a note value to a rate value

Specified by:
note2rate in interface ModuleUnits

rate2note

public double rate2note(double rate)
Description copied from interface: ModuleUnits
converts a rate value to a note value

Specified by:
rate2note in interface ModuleUnits

addPeriod

public double addPeriod(double note,
                        double period)
Description copied from interface: ModuleUnits
adds a period value to a note value

Specified by:
addPeriod in interface ModuleUnits

getUpperNoteLimit

public double getUpperNoteLimit()
Description copied from interface: ModuleUnits
gets the highest note that can be played in a module

Specified by:
getUpperNoteLimit in interface ModuleUnits

getLowerNoteLimit

public double getLowerNoteLimit()
Description copied from interface: ModuleUnits
gets the lowest note that can be played in a module

Specified by:
getLowerNoteLimit in interface ModuleUnits

getName

public java.lang.String getName()
Specified by:
getName in interface ModuleUnits