de.sciss.jcollider.gui
Class ControlSpec

java.lang.Object
  extended by de.sciss.jcollider.gui.ControlSpec

public class ControlSpec
extends java.lang.Object

Specification for a control input such as a synth control. This is a quite direct translation from the SClang class. Specs are immutable though (minVal and maxVal can't be changed).

Version:
0.28, 29-Jul-06
Author:
Hanns Holger Rutz

Field Summary
static ControlSpec defaultSpec
           
 
Constructor Summary
ControlSpec()
           
ControlSpec(double minVal, double maxVal)
           
ControlSpec(double minVal, double maxVal, Warp warp)
           
ControlSpec(double minVal, double maxVal, Warp warp, double step)
           
ControlSpec(double minVal, double maxVal, Warp warp, double step, double defaultVal)
           
ControlSpec(double minVal, double maxVal, Warp warp, double step, double defaultVal, java.lang.String units)
           
 
Method Summary
 double constrain(double value)
           
 double getClipHi()
           
 double getClipLo()
           
 double getDefaultVal()
           
 double getMaxVal()
           
 double getMinVal()
           
 double getRange()
           
 double getRatio()
           
 double getStep()
           
 java.lang.String getUnits()
           
 Warp getWarp()
           
 double map(double value)
           
 double unmap(double value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

defaultSpec

public static final ControlSpec defaultSpec
Constructor Detail

ControlSpec

public ControlSpec()

ControlSpec

public ControlSpec(double minVal,
                   double maxVal)

ControlSpec

public ControlSpec(double minVal,
                   double maxVal,
                   Warp warp)

ControlSpec

public ControlSpec(double minVal,
                   double maxVal,
                   Warp warp,
                   double step)

ControlSpec

public ControlSpec(double minVal,
                   double maxVal,
                   Warp warp,
                   double step,
                   double defaultVal)

ControlSpec

public ControlSpec(double minVal,
                   double maxVal,
                   Warp warp,
                   double step,
                   double defaultVal,
                   java.lang.String units)
Method Detail

getMinVal

public double getMinVal()

getMaxVal

public double getMaxVal()

getClipLo

public double getClipLo()

getClipHi

public double getClipHi()

getDefaultVal

public double getDefaultVal()

getStep

public double getStep()

getWarp

public Warp getWarp()

getUnits

public java.lang.String getUnits()

constrain

public double constrain(double value)

getRange

public double getRange()

getRatio

public double getRatio()

map

public double map(double value)

unmap

public double unmap(double value)