HelpSource/Classes/VarLag.schelp

   1 class:: VarLag
   2 summary:: Variable shaped lag
   3 related:: Classes/Lag, Classes/Ramp, Classes/Slew
   4 categories::  UGens>Filters>Linear
   5
   6
   7 Description::
   8 Similar to link::Classes/Lag:: but with other curve shapes than exponential.
   9 A change on the input will take the specified time to reach the new value.
  10 Useful for smoothing out control signals.
  11
  12 classmethods::
  13
  14 method::ar, kr
  15
  16 argument::in
  17
  18 The input signal.
  19
  20
  21 argument::time
  22
  23 Lag time in seconds.
  24
  25 argument::curvature
  26 Control curvature if strong::warp:: input is 5 (default).
  27 0 means linear, positive and negative numbers curve the segment up and down.
  28
  29 argument::warp
  30 Determines the shape. The possible values are:
  31 table::
  32 ## code::\step:: || || flat segment
  33 ## code::\linear:: || code::\lin:: || linear segment, the default
  34 ## code::\exponential:: || code::\exp:: || natural exponential growth and decay. In this case, the levels must all be nonzero and the have the same sign.
  35 ## code::\sine:: || code::\sin:: || sinusoidal S shaped segment.
  36 ## code::\welch:: || code::\wel:: || sinusoidal segment shaped like the sides of a Welch window.
  37 ## code::\squared::  || code::\sqr:: || squared segment
  38 ## code::\cubed:: || code::\cub:: || cubed segment
  39 ::
  40
  41 All values above will ignore strong::curvature:: input.
  42
  43 note::
  44 When controlling this from the outside, use code::Env.shapeNumber(symbol):: to get the numeric value for each shape.
  45 ::
  46
  47 argument::start
  48 Initial value. If not specified, same as the input signal.
  49
  50 argument::mul
  51
  52 Output will be multiplied by this value.
  53
  54
  55 argument::add
  56
  57 This value will be added to the output.
  58
  59
  60 Examples::
  61
  62 code::
  63 (
  64 // used to lag pitch
  65 {
  66     SinOsc.ar(                              // sine wave
  67         VarLag.kr(                            // lag the modulator
  68             LFPulse.kr(1).range(100,400),   // frequency modulator
  69             0.2,                            // lag time
  70             Line.kr(-8, 8, 15, doneAction:2) // modulate shape
  71         ),
  72         0,                                  // sine phase
  73         0.3                                 // sine amplitude
  74     )
  75 }.play
  76 )
  77 ::
  78
  79 code::
  80 (
  81 x = play { |amp=0, time=0, curve=0, warp=5|
  82     PinkNoise.ar(VarLag.kr(amp, time, curve, warp) ! 2)
  83 }
  84 )
  85
  86 x.set(\amp, 1, \time, 5, \warp, Env.shapeNumber(\sin)) // s-shaped curve up
  87 x.set(\amp, 0, \time, 1, \warp, Env.shapeNumber(\lin)) // linear down
  88
  89 x.set(\amp, 1, \time, 2, \warp, 5, \curve, 7); // slow curvature
  90 x.set(\amp, 0, \time, 0);
  91
  92 x.set(\amp, 1, \time, 2, \warp, 5, \curve, -7); // fast curvature
  93 x.set(\amp, 0, \time, 0);
  94
  95 x.free;
  96 ::
  97