Explicitly include a boost "windows" folder even on linux
[supercollider.git] / HelpSource / Classes / InRect.schelp
blob9341c13e8cd80f35e647a50c09aa9a7856b09632
1 class:: InRect
2 summary:: Test if a point is within a given rectangle.
3 related:: Classes/InRange, Classes/Schmidt
4 categories::  UGens>Maths
7 Description::
8 A pair of signals x and y are treated as a point (x,y) in 2-D; if they fall within the bounds of the rectangle, then this UGen outputs a one; else it outputs zero.
11 classmethods::
12 method::ar, kr
14 argument::x
15 X component signal
17 argument::y
18 Y component signal
20 argument::rect
21 A link::Classes/Rect:: which defines the rectangular region to monitor; note that Rects are in screen co-ordinates, so the top is smaller than the bottom. The Rect is created once and cannot be modulated.
23 examples::
24 code::
25 //we'll hear the sawtooth wave when the two sine oscillators are both in the region x = 0.0 to 0.5, y = 0.5 to 1.0
26 {InRect.ar(SinOsc.ar(1),SinOsc.ar(1.3),Rect(0,0.5,0.5,0.5))*LFSaw.ar(44,0,0.1) }.play
28 //stereo effect
29 {(InRect.ar(LFNoise0.ar([140,141]),LFNoise0.ar(143),Rect(0,0,0.5,1)).lag(0.1))*LFSaw.ar(SinOsc.ar(10,0,5,400),0,0.1) }.play
32 //for the Rect, create as left, 'top', width, height;
33 r= Rect(0,0,1,1)
35 r.left
36 r.right
37 r.top
38 r.bottom