From 2813e38280292d795115cb0ffaf693beec3e5b1e Mon Sep 17 00:00:00 2001 From: Ivica Ico Bukvic <ico@vt.edu> Date: Mon, 12 Aug 2013 16:00:29 -0400 Subject: [PATCH] improved docs --- pd/doc/5.reference/clip-help.pd | 141 ++++++++++++++++++++++++ pd/doc/5.reference/clip~-help.pd | 116 +++++++++++++++----- pd/doc/5.reference/gatom-help.pd | 182 ++++++++++++++++++++++++++----- 3 files changed, 381 insertions(+), 58 deletions(-) create mode 100644 pd/doc/5.reference/clip-help.pd diff --git a/pd/doc/5.reference/clip-help.pd b/pd/doc/5.reference/clip-help.pd new file mode 100644 index 000000000..a05e73c52 --- /dev/null +++ b/pd/doc/5.reference/clip-help.pd @@ -0,0 +1,141 @@ +#N canvas 398 77 555 619 10; +#X obj 0 595 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0 +14 -228856 -66577 0; +#X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header clip 3 12 0 18 -204280 +-1 0; +#X obj 0 297 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 563 393 378 279 META 0; +#X text 12 145 LIBRARY internal; +#X text 12 185 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 12 25 LICENSE SIBSD; +#X text 12 165 AUTHOR Miller Puckette; +#X text 12 225 HELP_PATCH_AUTHORS Dave Sabine \, April 25 \, 2003 Jonathan +Wilkes revised the patch to conform to the PDDP template for Pd version +0.42.; +#X text 12 5 KEYWORDS control filter; +#X text 12 45 DESCRIPTION force a number to lie between two limits +; +#X text 12 65 INLET_0 float list; +#X text 12 125 OUTLET_0 float; +#X text 12 85 INLET_1 float; +#X text 12 105 INLET_2 float; +#X text 12 205 RELEASE_DATE 2009; +#X restore 502 598 pd META; +#X obj 0 415 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj 0 458 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#X obj 0 533 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +0 13 -228856 -1 0; +#X obj 78 306 cnv 17 3 45 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#N canvas 176 569 428 102 Related_objects 0; +#X obj 202 42 int; +#X obj 233 42 f; +#X obj 22 42 min; +#X obj 53 42 max; +#X obj 84 42 clip~; +#X obj 128 42 min~; +#X obj 165 42 max~; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 7 1 [clip] Related Objects; +#X restore 101 597 pd Related_objects; +#X obj 78 424 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X obj 78 362 cnv 17 3 17 empty \$0-pddp.cnv.let.1 1 5 9 0 16 -228856 +-162280 0; +#X text 98 361 float; +#X obj 78 387 cnv 17 3 17 empty \$0-pddp.cnv.let.2 2 5 9 0 16 -228856 +-162280 0; +#X text 98 386 float; +#X obj 511 5 clip; +#X obj 306 179 clip -50 50; +#X floatatom 306 205 5 0 0 0 - - -; +#X floatatom 306 141 5 0 0 0 - - -; +#X text 383 177 creation arguments; +#X obj 128 179 clip; +#X floatatom 138 140 5 0 0 0 - - -; +#X floatatom 181 140 5 0 0 0 - - -; +#X floatatom 224 140 5 0 0 0 - - -; +#X floatatom 128 205 5 0 0 0 - - -; +#X text 171 179 no arguments; +#X text 205 108 list; +#X msg 128 108 42 100 500; +#X text 98 305 float; +#X text 168 305 - a float at the left inlet will be clipped to the +low and high values stored in the object.; +#X text 98 424 float; +#N canvas 102 355 428 206 clip_vs_min_and_max 0; +#X text 10 70 Consider the following:; +#X floatatom 50 96 5 0 0 0 - - -; +#X floatatom 50 177 5 0 0 0 - - -; +#X obj 50 151 min 50; +#X obj 50 125 max -50; +#X text 137 136 same as; +#X obj 257 148 clip -50 50; +#X floatatom 257 177 5 0 0 0 - - -; +#X text 10 37 [clip] is a tool which combines the functionality of +[min] and [max] into a single object.; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 7 1 [clip] Relationship between [clip] and [min] \, [max]; +#X connect 1 0 4 0; +#X connect 1 0 6 0; +#X connect 3 0 2 0; +#X connect 4 0 3 0; +#X connect 6 0 7 0; +#X restore 101 567 pd clip_vs_min_and_max; +#N canvas 99 243 428 294 low_and_high_values 0; +#X text 35 32 [clip] always assumes that the first argument (second +inlet) is the low extreme of the range and the second argument (third +inlet) is the high extreme. However \, strange behaviour should be +expected if you mix these arguments up.; +#X obj 43 155 clip -50 50; +#X obj 169 149 clip 72 -104; +#X floatatom 43 122 5 0 0 0 - - -; +#X floatatom 43 184 5 0 0 0 - - -; +#X floatatom 169 181 5 0 0 0 - - -; +#X text 174 104 Numbers below 72 are clipped to 72; +#X text 174 124 Numbers above -104 are clipped to -104; +#X floatatom 311 258 5 0 0 0 - - -; +#X obj 311 214 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 +1; +#X obj 311 236 clip 1 -1024; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 7 1 [clip] Low and High Values; +#X text 114 238 This could be used effectively; +#X text 114 253 to toggle between two numbers.; +#X connect 1 0 4 0; +#X connect 2 0 5 0; +#X connect 3 0 1 0; +#X connect 3 0 2 0; +#X connect 9 0 10 0; +#X connect 10 0 8 0; +#X restore 101 542 pd low_and_high_values; +#X text 11 23 force a number to lie between two limits; +#X text 168 424 - outputs a float which is limited to a range within +the high and low values of the middle and last inlet.; +#X text 167 477 - (optional) initial minimum value beyond which to +clip the signal.; +#X text 167 502 - (optional) initial maximum value beyond which to +clip the signal.; +#X text 80 477 1) float; +#X text 80 502 2) float; +#X text 168 386 - maximum value beyond which the incoming signal is +clipped.; +#X text 168 361 - minimum value beyond which the incoming signal is +clipped.; +#X text 98 335 list; +#X text 168 335 - a list is distributed to the inlets of [clip].; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; +#X connect 15 0 16 0; +#X connect 17 0 15 0; +#X connect 19 0 23 0; +#X connect 20 0 19 0; +#X connect 21 0 19 1; +#X connect 22 0 19 2; +#X connect 26 0 19 0; diff --git a/pd/doc/5.reference/clip~-help.pd b/pd/doc/5.reference/clip~-help.pd index 61c222fa1..fe7ee6e1c 100644 --- a/pd/doc/5.reference/clip~-help.pd +++ b/pd/doc/5.reference/clip~-help.pd @@ -1,30 +1,86 @@ -#N canvas 182 132 778 399 12; -#X obj 75 164 clip~ -0.5 0.5; -#X obj 75 104 osc~ 1000; -#X graph graph1 0 1 100 -1 78 280 278 380; -#X array array99 100 float 0; -#X pop; -#X obj 91 213 metro 500; -#X obj 91 188 r metro; -#X text 239 235 <-- graph the output; -#X obj 75 237 tabwrite~ array99; -#X msg 519 69 \; metro 0; -#X msg 515 12 \; pd dsp 1 \; metro 1; -#X text 604 26 <-- Click to start; -#X text 589 73 <-- Click to stop; -#X obj 42 19 clip~; -#X text 88 18 - restrict a signal to lie between two limits; -#X text 243 136 inlets to reset clip range; -#X floatatom 135 136 4 0 0; -#X floatatom 196 137 4 0 0; -#X text 210 164 creation arguments initialize clip range; -#X text 4 55 The clip~ object passes its signal input to its output -\, clipping it to lie between two limits.; -#X text 470 371 updated for Pd version 0.33; -#X connect 0 0 6 0; -#X connect 1 0 0 0; -#X connect 3 0 6 0; -#X connect 4 0 3 0; -#X connect 4 0 3 0; -#X connect 14 0 0 1; -#X connect 15 0 0 2; +#N canvas 334 144 554 442 10; +#X obj -1 420 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0 +14 -233017 -33289 0; +#X obj -1 258 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 440 331 436 231 META 0; +#X text 56 126 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 56 6 LICENSE SIBSD; +#X text 56 106 AUTHOR Miller Puckette; +#X text 56 146 RELEASE_DATE 1997; +#X text 56 -14 KEYWORDS signal constrain clip pass filter range; +#X text 56 26 DESCRIPTION constrains a signal within a certain range +; +#X text 56 46 INLET_0 signal; +#X text 56 66 OUTLET_0 signal; +#X text 56 166 HELP_PATCH_AUTHORS Alex Cleveland updated this patch +for Pd-l2ork version 2013.05.28; +#X text 56 86 LIBRARY internal; +#X restore 500 422 pd META; +#X obj -1 301 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj -1 343 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#N canvas 228 453 427 109 Related_objects 0; +#X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 6 1 Related Objects; +#X obj 50 29 clip; +#X obj 8 29 Clip~; +#X restore 209 422 pd Related_objects; +#X obj 77 313 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X obj -1 0 cnv 15 552 40 empty \$0-pddp.cnv.header clip~ 3 12 0 18 +-204280 -1 0; +#X text 86 353 1) float; +#X text 87 374 2) float; +#X text 11 23 Constrains a signal within a certain range; +#X obj 67 223 tabwrite~ \$0-a; +#N canvas 0 0 450 300 (subpatch) 0; +#X array \$0-a 100 float 3; +#A 0 0.169761 0.183715 0.197062 0.209759 0.221755 0.233017 0.243509 +0.253192 0.262032 0.270007 0.277088 0.283244 0.288464 0.292732 0.296021 +0.298331 0.299656 0.299982 0.299313 0.297655 0.295009 0.291381 0.286791 +0.281251 0.274772 0.267385 0.259116 0.24998 0.240017 0.229262 0.217743 +0.205501 0.192581 0.179021 0.164865 0.150165 0.134968 0.11932 0.103277 +0.086894 0.0702202 0.0533143 0.0362322 0.0190294 0.00176354 -0.0155081 +-0.0327286 -0.0498398 -0.0667862 -0.0835123 -0.099959 -0.116075 -0.131808 +-0.147102 -0.161907 -0.176178 -0.189864 -0.202918 -0.215301 -0.226972 +-0.237885 -0.248012 -0.257321 -0.265768 -0.273337 -0.280004 -0.285736 +-0.290522 -0.294348 -0.297196 -0.299055 -0.299926 -0.299804 -0.298682 +-0.296573 -0.293485 -0.289414 -0.284388 -0.278422 -0.271528 -0.263733 +-0.255068 -0.245555 -0.235225 -0.224118 -0.21227 -0.199712 -0.186495 +-0.172661 -0.158251 -0.143317 -0.12791 -0.112077 -0.0958714 -0.0793497 +-0.0625643 -0.0455707 -0.0284267 -0.0111884 0.00608727; +#X coords 0 1 99 -1 100 75 1; +#X restore 378 114 graph; +#X obj 83 200 metro 150; +#X obj 83 180 tgl 15 1 empty empty empty 17 7 0 10 -262144 -1 -1 1 +1; +#X obj 67 75 osc~ 440; +#X floatatom 136 76 5 0 0 0 - - -; +#X obj 67 130 *~ 0; +#X obj 136 106 / 10; +#X text 105 271 signal; +#X text 179 271 - singal to pass through range filter; +#X text 105 312 signal; +#X text 179 312 - outputs part of signal inside range; +#X text 179 352 - sets minimun number of range \, (default is 0); +#X text 179 374 - sets maximum number of range \, (default is 0); +#X obj 483 49 pddp/dsp; +#X obj 77 271 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 168 67 click and drag tochange signal; +#X text 134 149 Optional arguments set the range. Default is 0 \, +0; +#X obj 7 422 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; +#X obj 510 5 clip~; +#X obj 67 156 clip~ -1 1; +#X connect 13 0 11 0; +#X connect 14 0 13 0; +#X connect 15 0 17 0; +#X connect 16 0 18 0; +#X connect 17 0 31 0; +#X connect 18 0 17 1; +#X connect 31 0 11 0; diff --git a/pd/doc/5.reference/gatom-help.pd b/pd/doc/5.reference/gatom-help.pd index 2dd7ce614..7034a3bac 100644 --- a/pd/doc/5.reference/gatom-help.pd +++ b/pd/doc/5.reference/gatom-help.pd @@ -1,32 +1,158 @@ -#N canvas 138 65 675 508 12; -#X floatatom 107 9 0 0 0; -#X text 155 10 atoms (number boxes); -#X floatatom 38 85 0 0 0; -#X floatatom 38 125 0 0 0; -#X msg 51 260 set 45; -#X floatatom 51 288 0 0 0; -#X floatatom 51 317 0 0 0; -#X text 84 40 Number boxes allow you to display numbers or to enter -numbers using the mouse and keyboard. When a number arrives at the +#N canvas 1 88 555 619 10; +#X obj 0 595 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0 +14 -228856 -66577 0; +#X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header gatom 3 12 0 18 +-204280 -1 0; +#X obj 0 231 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 206 417 392 263 META 0; +#X text 12 115 LIBRARY internal; +#X text 12 155 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 12 35 LICENSE SIBSD; +#X text 12 135 AUTHOR Miller Puckette; +#X text 12 195 HELP_PATCH_AUTHORS Updated for Pd version 0.34. Jonathan +Wilkes revised the patch to conform to the PDDP template for Pd version +0.42.; +#X text 12 75 INLET_0 float bang symbol set; +#X text 12 95 OUTLET_0 float; +#X text 12 175 RELEASE_DATE 1997; +#X text 12 55 DESCRIPTION atom (number box and symbol box); +#X text 12 5 KEYWORDS control storage GUI nonlocal symbol_op; +#X restore 500 597 pd META; +#X obj 0 396 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj 0 470 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#X obj 0 499 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +0 13 -228856 -1 0; +#X text 98 474 (none); +#N canvas 153 570 428 109 Related_objects 0; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 47 1 Related Objects; +#X floatatom 9 3 5 0 0 0 - - -; +#X obj 21 42 float; +#X obj 61 42 list; +#X obj 102 45 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256 0; +#X obj 168 42 drawnumber; +#X restore 102 597 pd Related_objects; +#X obj 78 240 cnv 17 3 145 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 98 404 float; +#X obj 78 405 cnv 17 3 52 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X floatatom 406 3 5 0 0 0 - - -; +#X floatatom 25 58 0 0 0 0 - - -; +#X floatatom 25 96 0 0 0 0 - - -; +#X msg 469 76 set 45; +#X floatatom 469 104 0 0 0 0 - - -; +#X text 98 239 bang; +#X text 98 259 float; +#X text 98 289 list; +#X text 98 309 symbol; +#X text 98 339 set; +#N canvas 98 96 430 514 Number_box_properties 0; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X floatatom 70 102 12 0 0 0 - - -; +#X floatatom 71 223 1 0 0 0 - - -; +#X text 50 2 Properties for gatom; +#X text 20 38 Right click on a number box and choose "Properties" to +change the following:; +#X text 19 69 width; +#X text 69 69 - width of the number box (in characters). By default +the width is 5 characters.; +#X text 148 102 width = 12 characters; +#X floatatom 70 123 2 0 0 0 - - -; +#X text 148 123 width = 2 characters; +#X text 69 164 If you select a width of 0 \, the number box will grow +as needed to hold the number--BUT BEWARE \, THIS IS EXPENSIVE IN CPU +TIME. In a production patch \, you'll want to set a specific width. +; +#X floatatom 70 143 0 0 0 0 - - -; +#X text 148 143 width = 0 characters (read below); +#X text 69 240 A width of one gives a clickable toggle switch ala Max. +; +#X text 88 223 width = 1 character: toggle between 0 and 1; +#X text 19 260 limits; +#X floatatom 71 282 5 0 127 0 - - -; +#X text 109 281 numbers between 0 and 127; +#X text 69 260 - set lower and upper limits for scrolling the number +box; +#X text 68 300 This only affects scrolling- you can still send values +to the number box that are outside these limits.; +#X floatatom 71 353 5 0 127 1 my_number_box - -; +#X text 19 331 label; +#X text 69 331 - give the number box a visible name; +#X text 68 371 Use the radio buttons to reposition the label to the +left \, right \, top \, or bottom of the number box. Spaces in the +label will automatically be converted to underscores.; +#X text 19 413 messages; +#X text 69 413 - nonlocal send and receive; +#X floatatom 193 532 5 0 0 2 Number_box_7 gatom-help-rcv gatom-help-snd +; +#X obj 276 540 r gatom-help-snd; +#X obj 71 516 s gatom-help-rcv; +#X msg 71 490 28; +#X text 68 433 As an alternative to using wires \, you can set send +and receive names to send messages through the number box. "Number-box-7" +below is set to receive messages to "gatom-help-rcv" \, and send messages +to "gatom-help-snd"; +#X floatatom 276 563 5 0 0 0 - - -; +#X text 68 583 Notice that you cannot make local connections with wires +to "Number_box_7" when using non-local send and receive names. If you +want to use both \, see the [nbx] object:; +#X obj 71 626 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256 0; +#X floatatom 13 3 5 0 0 0 - - -; +#X connect 27 0 31 0; +#X connect 29 0 28 0; +#X restore 102 571 pd Number_box_properties; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; +#X symbolatom 25 138 10 0 0 0 - - -; +#X text 11 23 atom (number box and symbol box); +#X symbolatom 486 3 10 0 0 0 - - -; +#X text 450 3 and; +#X symbolatom 25 174 10 0 0 0 - - -; +#X text 61 48 A number box allows you to display a number or enter +a number using the mouse and keyboard. When a number arrives at the number box's inlet \, it is displayed and sent to the outlet. You can click on a number box and drag upward or downward to change the value continuously.; -#X text 88 130 You can shift-click and drag to change the number by -hundredths instead of units. Alt clicking toggles the value between -0 and the last nonzero value.; -#X text 83 184 You can also type in values by clicking and typing a -number followed by "enter."; -#X text 30 220 the "set" message sets the number box's value but does -not send it to the outlet.; -#X text 423 482 updated for Pd version 0.34; -#X text 39 339 You can set the width of the box by right-clicking and -choosing "properties." By default the width is 5 characters. If you -select a width of 0 \, the number box will grow as needed to hold the -number--BUT BEWARE \, THIS IS EXPENSIVE IN CPU TIME. In a production -patch \, you'll want to set a specific width.; -#X floatatom 547 439 1 0 0; -#X text 41 438 A width of one gives a clickable toggle switch ala Max: +#X text 97 134 A symbol box allows you to display a single symbol-atom +or enter one using the mouse and keyboard. Unlike a number box you +cannot change the value by clicking and dragging.; +#X text 96 172 The symbol box is called "Symbol" in the "Put" menu. +; +#X text 168 239 - sends the current value to the outlet.; +#X msg 469 156 set foo; +#X symbolatom 469 180 10 0 0 0 - - -; +#X text 168 309 - symbol box only: an incoming symbol is displayed +and output. (Number box will display and output zero.); +#X text 168 259 - number box only: sets the current value and outputs +it. (Symbol box will display 'float' and output 'symbol float'.); +#X text 168 289 - a list will be truncated to the first item.; +#X text 168 339 - displays the incoming value without outputting it +(e.g. \, "set 23" will cause a number box to display 23). Sending a +set message without a value does not change the current value of a +number box or symbol box.; +#X text 168 404 - number box only: outputs a float for each message +it receives (except set).; +#X text 98 434 symbol; +#X text 168 434 - symbol box only: outputs a symbol message for each +message it receives (except set).; +#X text 100 537 Control-clicking (or command-clicking on a mac) toggles +the value between 0 and the last nonzero value.; +#X floatatom 59 545 5 0 0 0 - - -; +#X text 100 503 You can shift-click a number box and drag to change +the number by hundredths instead of ones.; +#X text 60 113 The number box is called "Number" in the "Put" menu. ; -#X connect 2 0 3 0; -#X connect 4 0 5 0; -#X connect 5 0 6 0; +#X text 67 197 To enter data simply click a number box or symbol box +and begin typing. Then click "Enter" to finish and output it.; +#X connect 13 0 14 0; +#X connect 15 0 16 0; +#X connect 24 0 28 0; +#X connect 33 0 34 0; -- GitLab