Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / Pbrown.schelp
blob693055c8eff391d1ea1e9cf952d19acd91a52f79
1 class:: Pbrown
2 summary:: brownian motion pattern
3 related:: Classes/BrownNoise, Classes/Pgbrown
4 categories:: Streams-Patterns-Events>Patterns>Random
6 description::
8 Returns a stream that behaves like a brownian motion.
10 ClassMethods::
12 method::new
14 argument::lo
15 lower boundary of values.
17 argument::hi
18 upper boundary of values.
20 argument::step
21 maximum change per step - the distribution is xrand2.
23 argument::length
24 number of values produced.
26 Examples::
28 code::
30 var a;
31 a = Pbrown(0.0, 1.0, 0.1, inf);
32 c = a.asStream.nextN(500);
33 w = Window.new("Pbrown", Rect(10, 10, 540, 800));
34 // plot the values
35 c.plot(bounds: Rect(10, 10, 520, 380), discrete: true, parent: w);
36 // a histogram of the values
37 c.histo(500).plot(bounds: Rect(10, 410, 520, 380), parent: w);
41 var a;
42 a = Pbrown(0.0, 1.0, 0.2, inf);
43 a.asStream.nextN(1000).plot2;
47 code::
48 // sound example
50 SynthDef(\help_sinegrain,
51         { arg out=0, freq=440, sustain=0.05;
52                 var env;
53                 env = EnvGen.kr(Env.perc(0.01, sustain, 0.2), doneAction:2);
54                 Out.ar(out, SinOsc.ar(freq, 0, env))
55         }).add;
60 var a;
61 a = Pbrown(0.0, 1.0, 0.1, inf).asStream;
63         loop {
64                 Synth(\help_sinegrain, [\freq, a.next * 600 + 300]);
65                 0.02.wait;
66         }
67 }.fork;
72 // parallel browninan motions
74 var a, x, f;
75 a = Pbrown(0.0, 1.0, 0.1, inf);
77 f = { |pattern, dt=0.02, min=300, max=900|
78         {
79                 var x = pattern.asStream;
80                 loop {
81                         Synth.grain(\help_sinegrain, [\freq, x.next.linexp(0, 1, min, max), \sustain, dt]);
82                         dt.wait;
83                 }
84         }.fork;
85 }.flop;
87 // 3 parallel motions
88 f.(a, [0.02, 0.08, 0.16]);