de.sciss.jcollider
Class Control

java.lang.Object
  extended by de.sciss.jcollider.UGen
      extended by de.sciss.jcollider.Control
All Implemented Interfaces:
Constants, GraphElem
Direct Known Subclasses:
LagControl, TrigControl

public class Control
extends UGen

Class for the Control UGen. This class is recognized by SynthDef in the building process. Controls should be created en bloc per rate (scalar or control), therefore the constructor takes an array of names and corresponding default values. For the sake of clarity, scalar control names should begin with a small 'i' letter, though this is not obligatory.

Individual controls are accessed by calling the getChannel method.

Note that when reading a synthdef from harddisc, the SynthDef class (as of version 0.25) will not create Control instances but merely plain UGen objects.

Version:
0.33, 21-Apr-09
Author:
Hanns Holger Rutz

Field Summary
protected  ControlDesc[] descs
           
 
Fields inherited from interface de.sciss.jcollider.Constants
kAddAfter, kAddBefore, kAddReplace, kAddToHead, kAddToTail, kAudioRate, kControlRate, kDemandRate, kDoneFree, kDoneFreeAll, kDoneFreeAllPred, kDoneFreeAllSucc, kDoneFreeGroup, kDoneFreePausePred, kDoneFreePauseSucc, kDoneFreePred, kDoneFreePredGroup, kDoneFreePredGroupDeep, kDoneFreeSucc, kDoneFreeSuccGroup, kDoneFreeSuccGroupDeep, kDoneNothing, kDonePause, kDumpBoth, kDumpHex, kDumpOff, kDumpText, kHeaderAIFF, kHeaderIRCAM, kHeaderNeXT, kHeaderRaw, kHeaderWAVE, kSampleALaw, kSampleDouble, kSampleFloat, kSampleInt16, kSampleInt24, kSampleInt32, kSampleInt8, kSampleMuLaw, kScalarRate
 
Constructor Summary
protected Control(java.lang.String name, java.lang.Object rate, int numOutputs, UGenInput[] inputs, int specialIndex)
           
 
Method Summary
 UGenChannel getChannel(java.lang.String name)
           
 ControlDesc getDesc(int idx)
           
 int getNumDescs()
           
static GraphElem ir(java.lang.String name)
           
static Control ir(java.lang.String[] names, float[] values)
           
static Control ir(java.lang.String name, float defaultValue)
           
static Control ir(java.lang.String name, float[] values)
           
static GraphElem kr(java.lang.String name)
           
static Control kr(java.lang.String[] names, float[] values)
           
static Control kr(java.lang.String name, float defaultValue)
           
static Control kr(java.lang.String name, float[] values)
           
 
Methods inherited from class de.sciss.jcollider.UGen
ar, ar, ar, ar, ar, ar, ar, ar, ar, ar, ar, ar, ar, array, array, array, array, asUGenInputs, dr, dr, dr, dr, dr, dr, dr, dr, dr, dr, dr, dr, dumpName, getChannel, getInput, getInputs, getName, getNumInputs, getNumOutputs, getOutput, getOutputRate, getOutputRates, getRate, getSpecialIndex, ir, ir, ir, ir, ir, ir, ir, ir, ir, ir, ir, ir, kr, kr, kr, kr, kr, kr, kr, kr, kr, kr, kr, kr, setSpecialIndex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

descs

protected final ControlDesc[] descs
Constructor Detail

Control

protected Control(java.lang.String name,
                  java.lang.Object rate,
                  int numOutputs,
                  UGenInput[] inputs,
                  int specialIndex)
Method Detail

getChannel

public UGenChannel getChannel(java.lang.String name)

getDesc

public ControlDesc getDesc(int idx)

getNumDescs

public int getNumDescs()

ir

public static GraphElem ir(java.lang.String name)

ir

public static Control ir(java.lang.String name,
                         float defaultValue)
Warning:
make sure the defaultValue is float and not int since otherwise a wrong (illegal) signature is called!

ir

public static Control ir(java.lang.String[] names,
                         float[] values)

ir

public static Control ir(java.lang.String name,
                         float[] values)

kr

public static GraphElem kr(java.lang.String name)

kr

public static Control kr(java.lang.String name,
                         float defaultValue)

kr

public static Control kr(java.lang.String[] names,
                         float[] values)

kr

public static Control kr(java.lang.String name,
                         float[] values)