polymorphism: better names for .binaryValue and .booleanValue are .asInteger and...
[supercollider.git] / Help / Libraries / JITLib / GUI / MonitorGui.html
blobb1bf4c9b81d4127040155473de098089c9e8817b
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="1038.29">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #2b30fa}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ee}
15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
16 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #cd0b0b}
17 p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica; min-height: 17.0px}
18 p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
19 p.p10 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
20 p.p11 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
21 p.p12 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
22 p.p13 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica}
23 p.p14 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #2024c7}
24 p.p15 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco}
25 p.p16 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #cd0b0b}
26 p.p17 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
27 span.s1 {font: 18.0px Helvetica}
28 span.s2 {color: #2b30fa}
29 span.s3 {color: #000000}
30 span.s4 {text-decoration: underline}
31 span.s5 {color: #1200c4}
32 span.s6 {text-decoration: underline ; color: #0000ee}
33 span.s7 {color: #2024c7}
34 span.s8 {color: #008417}
35 span.s9 {color: #cd0b0b}
36 span.Apple-tab-span {white-space:pre}
37 </style>
38 </head>
39 <body>
40 <p class="p1"><span class="s1"><b>MonitorGui<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b></span><b>display and control a Monitor</b><span class="s1"><b><span class="Apple-tab-span"> </span></b></span></p>
41 <p class="p2"><br></p>
42 <p class="p1"><b>Inherits from : </b><a href="SC://JITGui"><span class="s2"><b>JITGui</b></span></a></p>
43 <p class="p3"><br></p>
44 <p class="p1">MonitorGui displays the state of a <a href="SC://NodeProxy"><span class="s2">NodeProxy</span></a>'s <a href="SC://Monitor"><span class="s2">Monitor</span></a>.<span class="Apple-converted-space"> </span></p>
45 <p class="p4"><span class="s3">It is used in <a href="NdefGui.html">NdefGui</a>, <a href="SC://ProxyMixer">ProxyMixer</a>, and <a href="SC://NdefMixer">NdefMixer</a>.<span class="Apple-converted-space"> </span></span></p>
46 <p class="p2"><br></p>
47 <p class="p5"><span class="s3"><b>See also:</b> <a href="SC://NodeProxy"><span class="s4">NodeProxy</span></a></span><span class="s5">, <a href="SC://Ndef"><span class="s2">Ndef</span></a>, <a href="SC://JITGui"><span class="s2">JITGui</span></a></span><span class="s2">, <a href="NdefGui.html"><span class="s6">NdefGui</span></a></span></p>
48 <p class="p2"><br></p>
49 <p class="p2"><br></p>
50 <p class="p1"><b>First examples</b></p>
51 <p class="p2"><br></p>
52 <p class="p6">s.boot;</p>
53 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).ar;</p>
54 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\k</span>).kr;</p>
55 <p class="p3"><br></p>
56 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// make a MonitorGui with all bells and whistles</p>
57 <p class="p6">m = <span class="s7">MonitorGui</span>.new(bounds: 500@40, options: [<span class="s8">\playN</span>, <span class="s8">\name, \level, \fade</span>]);</p>
58 <p class="p3"><br></p>
59 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// when it has a kr proxy, it is visible, but disabled</p>
60 <p class="p6">m.object_(<span class="s7">Ndef</span>(<span class="s8">\k</span>));</p>
61 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// with an ar proxy, it is enabled</p>
62 <p class="p6">m.object_(<span class="s7">Ndef</span>(<span class="s8">\a</span>));</p>
63 <p class="p3"><br></p>
64 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// show its play state</p>
65 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).play<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>//<span class="Apple-converted-space"> </span></p>
66 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// and volume</p>
67 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).vol_(0.25);</p>
68 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).stop</p>
69 <p class="p3"><br></p>
70 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// switch to playN mode - spread outputs should show</p>
71 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).playN([0, 2]);</p>
72 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// switch back to play - spread outbox goes back</p>
73 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).stop;</p>
74 <p class="p6"><span class="s7">Ndef</span>(<span class="s8">\a</span>).play(0);</p>
75 <p class="p8"><br></p>
76 <p class="p8"><br></p>
77 <p class="p9"><b>Creation</b></p>
78 <p class="p10"><br></p>
79 <p class="p11"><b><span class="Apple-tab-span"> </span>*new (object, parent, bounds, makeSkip, options)</b></p>
80 <p class="p12"><b><span class="Apple-tab-span"> </span></b></p>
81 <p class="p13"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>object </b>- the nodeproxy whose monitor state will be shown, or nil.</p>
82 <p class="p13"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>parent </b>- a parent view where MonitorGui is to be shown. If nil, a window is made.</p>
83 <p class="p13"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>bounds </b>- bounds where the view (or window) will be shown.</p>
84 <p class="p13"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>makeSkip </b>- a flag whether to create and start a SkipJack for auto-updating.</p>
85 <p class="p13"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>options </b>- an array of symbols for options of what to display.<span class="Apple-converted-space"> </span></p>
86 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
87 <p class="p14"><span class="s3"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>g = </span>MonitorGui<span class="s3">(</span>Ndef<span class="s3">(</span><span class="s8">\a</span><span class="s3">));<span class="Apple-tab-span"> </span></span><span class="s9">// barebones</span></p>
88 <p class="p15">(</p>
89 <p class="p15"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>w = <span class="s7">Window</span>.new.front;<span class="Apple-converted-space"> </span></p>
90 <p class="p15"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>w.addFlowLayout;</p>
91 <p class="p15"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>g = <span class="s7">MonitorGui</span>(<span class="s7">Ndef</span>(<span class="s8">\a</span>), w, 300@40);</p>
92 <p class="p15">)</p>
93 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// different options:<span class="Apple-converted-space"> </span></p>
94 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// a playN dialog button</p>
95 <p class="p6">g = <span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), options: [<span class="s8">\playN</span>])</p>
96 <p class="p10"><br></p>
97 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// bounds<span class="Apple-converted-space"> </span></p>
98 <p class="p6"><span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), bounds: <span class="s7">Rect</span>(100, 100, 400, 30), options: [<span class="s8">\playN</span>])</p>
99 <p class="p6"><span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), bounds: 400@24, options: [<span class="s8">\playN</span>])</p>
100 <p class="p10"><br></p>
101 <p class="p16"><span class="s3"><span class="Apple-tab-span"> </span></span>// level name and numerical value</p>
102 <p class="p6"><span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), options: [<span class="s8">\playN</span>, <span class="s8">\level</span>])</p>
103 <p class="p3"><br></p>
104 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// a nameView and a fadeTime setter box</p>
105 <p class="p6"><span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), options: [<span class="s8">\playN</span>, <span class="s8">\name</span>, <span class="s8">\fade</span>])</p>
106 <p class="p3"><br></p>
107 <p class="p7"><span class="s3"><span class="Apple-tab-span"> </span></span>// all of 'em</p>
108 <p class="p6"><span class="s7">MonitorGui</span>.new(<span class="s7">Ndef</span>(<span class="s8">\a</span>), options: [<span class="s8">\playN</span>, <span class="s8">\level</span>, <span class="s8">\name</span>, <span class="s8">\fade</span>])</p>
109 <p class="p10"><br></p>
110 <p class="p10"><br></p>
111 <p class="p17"><b>Class Variables</b></p>
112 <p class="p12"><span class="Apple-tab-span"> </span></p>
113 <p class="p11"><b><span class="Apple-tab-span"> </span>lastOutBus</b><span class="Apple-tab-span"> </span>the highest outbus number to allow. Default is 99.</p>
114 <p class="p12"><br></p>
115 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
116 <p class="p17"><b>Instance Variables</b></p>
117 <p class="p12"><br></p>
118 <p class="p11"><b><span class="Apple-tab-span"> </span>config<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>some information on what to display</p>
119 <p class="p12"><br></p>
120 <p class="p11"><b><span class="Apple-tab-span"> </span>ampSl<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>an EZSlider for Monitor volume</p>
121 <p class="p12"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
122 <p class="p11"><b><span class="Apple-tab-span"> </span>playBut<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>a play button - shows play or playN<span class="Apple-converted-space"> </span></p>
123 <p class="p12"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
124 <p class="p11"><b><span class="Apple-tab-span"> </span>setOutBox<span class="Apple-tab-span"> </span></b>a numberbox to set output routing</p>
125 <p class="p12"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
126 <p class="p11"><b><span class="Apple-tab-span"> </span>playNDialogBut<span class="Apple-tab-span"> </span></b>opens a dialog window for playN output routing by code</p>
127 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
128 <p class="p11"><b><span class="Apple-tab-span"> </span>fadeBox</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>a numberbox for setting monitor fadeTime.<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
129 <p class="p12"><br></p>
130 <p class="p12"><span class="Apple-tab-span"> </span></p>
131 <p class="p17"><b>Some Methods</b></p>
132 <p class="p12"><br></p>
133 <p class="p12"><span class="Apple-tab-span"> </span></p>
134 <p class="p11"><b><span class="Apple-tab-span"> </span>playNMode_ (flag)<span class="Apple-tab-span"> </span></b>switches between playN mode (true) and play mode (false)</p>
135 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
136 <p class="p11"><b><span class="Apple-tab-span"> </span>checkUpdate<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>compare previous state with current state, and update gui elements.</p>
137 <p class="p12"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b></p>
138 <p class="p10"><br></p>
139 </body>
140 </html>