SCDoc: Use proper static string constants instead of comparing string literals.
[supercollider.git] / HelpSource / Reference / softVol_.schelp
blobe91df32316530c744905fc6daf259a80aedf6a04
1 title:: softVol_
2 summary:: set a nodeproxy's vol conditionally
3 categories:: Libraries>JITLib>GUI
4 related:: Reference/softSet, Reference/softPut
6 description::
7 Extension method to link::Classes/NodeProxy:: to set vol conditionally.
9 method:: softVol
10 setter.
12 argument:: val
13 the volume value to set to
14 argument:: within
15 the normalized range within which the set is accepted
16 argument:: pause
17 a flag whether to pause the nodeproxy when volume is 0.
18 waits for 0.2 seconds for volume to go down first.
19 argument:: lastVal
20 the previous value that the controller has set - can be
21 argument:: spec
22 a link::Classes/ControlSpec:: can be passed in. if nil, code::\amp.asSpec:: is used.
24 Examples::
25 code::
26 Ndef(\test, { |freq=200| Splay.ar(SinOsc.ar(freq * Array.rand(12, 0.95, 1.05))) });
27 Ndef(\test).play(vol: 0.1);
29         // example of softSet, softSet which knows lastVal,
30         // softVol_ and softVol_ which knows lastVol:
32 w = Window("softVol", Rect(500, 200, 400, 240)).front;
33 w.view.addFlowLayout;
34 NdefGui(Ndef(\test), 2, w);
36         // same for volume - not too safe
37 EZSlider(w, 340@30, \softVol, \amp, { |sl|
38         Ndef(\test).softVol_(sl.value, 0.05)
39 });
40         // safer
41 EZSlider(w, 340@30, \knowLastV, \amp, Routine { |sl|
42         var newVal, lastVal;
43         loop {
44                 newVal = sl.value;
45                 Ndef(\test).softVol_(sl.value, 0.05, lastVal: lastVal);
46                 lastVal = newVal;
47                 \dummy.yield;
48         }
49 });