From 6a5c6a517019456eb945c64a340c4c4509570dd1 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 22 Oct 2009 22:37:13 +0000 Subject: Added common~-help and modified a few help files svn path=/trunk/externals/tof/; revision=12647 --- help/argument-abs.pd | 32 +++++---- help/argument-help.pd | 85 ++++++++++++------------ help/common~-help.pd | 39 +++++++++++ help/get~-help.pd | 48 -------------- help/param-help.pd | 180 +++++++++++++++++++++++++++----------------------- help/put~-help.pd | 48 -------------- 6 files changed, 194 insertions(+), 238 deletions(-) create mode 100644 help/common~-help.pd delete mode 100644 help/get~-help.pd delete mode 100644 help/put~-help.pd diff --git a/help/argument-abs.pd b/help/argument-abs.pd index 0e209a4..3826748 100644 --- a/help/argument-abs.pd +++ b/help/argument-abs.pd @@ -1,29 +1,27 @@ -#N canvas 336 203 614 414 10; +#N canvas 336 203 651 389 10; #X obj 158 36 inlet; #X obj 158 92 t b b b; #X text 220 105 first; #X text 159 192 second; #X text 73 282 third; -#X obj 11 303 argument 3 500; -#X obj 210 130 argument 1; -#X text 279 131 <-Outputs the first parent argument "symbol a"; +#X text 305 127 <-Outputs the first parent argument "symbol a"; #X obj 158 67 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 -1; -#X obj 134 213 argument 2 100; -#X text 231 208 <-Outputs "100" because the types of the second argument +#X text 256 207 <-Outputs "100" because the types of the second argument ("symbol b") and the default argument ("float 100") do not match.; -#X text 200 29 Please note that the current parent arguments are: a -b; -#X text 101 305 <- Outputs "500" because there is not third parent +#X text 130 300 <- Outputs "500" because there is not third parent argument; #X obj 210 166 print arg1; #X obj 129 258 print arg2; #X obj 11 342 print arg3; -#X connect 0 0 8 0; -#X connect 1 0 5 0; -#X connect 1 1 9 0; -#X connect 1 2 6 0; -#X connect 5 0 15 0; -#X connect 6 0 13 0; -#X connect 8 0 1 0; -#X connect 9 0 14 0; +#X obj 210 130 tof/argument 1; +#X obj 134 213 tof/argument 2 100; +#X obj 11 303 tof/argument 3 500; +#X connect 0 0 6 0; +#X connect 1 0 14 0; +#X connect 1 1 13 0; +#X connect 1 2 12 0; +#X connect 6 0 1 0; +#X connect 12 0 9 0; +#X connect 13 0 10 0; +#X connect 14 0 11 0; diff --git a/help/argument-help.pd b/help/argument-help.pd index c274ce8..2cc035f 100644 --- a/help/argument-help.pd +++ b/help/argument-help.pd @@ -1,47 +1,50 @@ -#N canvas 305 118 476 537 10; -#X obj 66 482 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +#N canvas 1064 8 505 644 10; +#X obj 82 587 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 -1; #X obj -11 19 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 0; -#X text -6 75 author: mrtoftrash@gmail.com; -#X text -6 96 version: 2009-04-14 (initial release); -#X text -7 60 tags: initialization; -#X text -6 18 description: outputs an inital argument. Outputs a default -one if no initial argument is set. Can also check that an argument -is of a particular type.; -#X obj 13 187 argument 1; -#X text 5 247 If a second argument is set \, its value will be used -as the default value. The default value is used only if there is no -parent argument OR if the type of the parent argument does not match -the type of the default one.; -#X obj 4 322 argument 1 32; -#X obj 12 167 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +#X text -3 68 author: mrtoftrash@gmail.com; +#X text -5 89 version: 2009-04-14 (initial release); +#X text -4 47 tags: initialization; +#X obj 8 257 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 -1; -#X obj 4 298 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +#X obj 5 346 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 -1; -#X obj 4 349 print; -#X obj 13 208 print; -#X text 6 135 The first argument selects the nth parent argument to -output.; -#X text 92 321 <-Will output 32 because there are no parent arguments. +#X obj 5 397 print; +#X obj 8 305 print; +#X obj 8 429 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +-1; +#X obj 8 477 print; +#X text 204 608 <- open it; +#X obj 8 280 tof/argument 1; +#X obj 5 370 tof/argument 1 32; +#X obj 8 451 tof/argument; +#X obj 82 611 ./argument-abs a b; +#X text 106 127 [argument n default]; +#X text -4 17 description: Outputs the patch's creation arguments individually. +; +#X text 6 154 [argument] outputs the n-th creation argument.; +#X text 9 174 If the n-th creation argument is not defined \, [argument] +can optionally output a default one.; +#X text 102 273 This help patch is a file and therefore has no creation +arguments. The [argument] to the left has no default value \, so nothing +will be outputed.; +#X text 100 449 With no arguments \, [argument] outputs the patch's +\$0 as symbol.; +#X text 13 533 Inside the following abstraction \, three [argument] +objects output the creation arguments. Look inside for an explenation +of the printed output.; +#X text 103 586 <- bang to print; +#X text 120 363 As stated before \, this help patch is a file and has +no creation arguments. But the [argument] to the left has a default +value and will output it.; +#X text 7 209 Also \, if the n-th creation argument is not of the same +type as the default value \, the default value will be outputed instead. ; -#X text 87 183 <-Should output the first parent argument. But in this -case \, the parent (the containing patch) has no arguments and this -example will not output anything.; -#X text 137 428 -- Example --; -#X text 5 449 Inside the following abstraction \, three [argument] -objects are linked to arguments 1 \, 2 and 3; -#X obj 158 347 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 --1 -1; -#X obj 158 369 argument; -#X obj 158 395 print; -#X text 218 370 <-Outputs the \$0 as symbol; -#X text 172 506 <- open it; -#X obj 66 506 argument-abs a b; -#X connect 0 0 23 0; -#X connect 6 0 12 0; -#X connect 8 0 11 0; -#X connect 9 0 6 0; -#X connect 10 0 8 0; -#X connect 18 0 19 0; -#X connect 19 0 20 0; +#X connect 0 0 15 0; +#X connect 5 0 12 0; +#X connect 6 0 13 0; +#X connect 9 0 14 0; +#X connect 12 0 8 0; +#X connect 13 0 7 0; +#X connect 14 0 10 0; diff --git a/help/common~-help.pd b/help/common~-help.pd new file mode 100644 index 0000000..225c5c8 --- /dev/null +++ b/help/common~-help.pd @@ -0,0 +1,39 @@ +#N canvas 162 106 780 541 10; +#X obj 56 302 tof/common~ patrick; +#X obj 278 305 tof/common~ patrick; +#X obj 55 266 sig~; +#X floatatom 55 241 5 0 0 0 - - -; +#X obj 277 271 sig~; +#X floatatom 277 244 5 0 0 0 - - -; +#X obj 29 23 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 +0; +#X text 34 71 author: mrtoftrash@gmail.com; +#X text 33 49 tags: mix~ control~; +#X text 34 92 version: 2009-10-22; +#X text 34 23 description: "many to many" nonlocal signal connections. +; +#X text 35 129 All common~ objects of the same name share the same +output.; +#X text 35 152 The output is the sum of all the inputs from the previous +dsp block.; +#X text 35 193 common~ only works for the default block size (64) and +delays the input by one block.; +#X obj 181 354 metro 1000; +#X obj 57 389 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256; +#X obj 278 384 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256; +#X obj 57 346 snapshot~; +#X obj 278 347 snapshot~; +#X obj 182 323 loadbang; +#X connect 0 0 17 0; +#X connect 1 0 18 0; +#X connect 2 0 0 0; +#X connect 3 0 2 0; +#X connect 4 0 1 0; +#X connect 5 0 4 0; +#X connect 14 0 17 0; +#X connect 14 0 18 0; +#X connect 17 0 15 0; +#X connect 18 0 16 0; +#X connect 19 0 14 0; diff --git a/help/get~-help.pd b/help/get~-help.pd deleted file mode 100644 index 1b50e9a..0000000 --- a/help/get~-help.pd +++ /dev/null @@ -1,48 +0,0 @@ -#N canvas 1165 85 541 614 10; -#X obj 9 39 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 -0; -#X text 14 87 author: mrtoftrash@gmail.com; -#X text 14 39 description: many to many nonlocal signal connections. -; -#X text 13 65 tags: flow~; -#X text 14 108 version: 2009-09-30 (initial release); -#X obj 46 260 tof/put~ A; -#X obj 312 262 tof/put~ B; -#X obj 45 205 osc~ 800; -#X obj 311 225 noise~; -#X obj 45 232 *~ 0.5; -#X obj 155 263 tof/put~ A; -#X obj 154 235 *~ 0.5; -#X obj 154 208 osc~ 600; -#X obj 70 476 dac~; -#X obj 77 383 tof/get~; -#X msg 77 330 set A; -#X msg 150 333 set B; -#X msg 385 224 set A; -#X msg 407 252 set B; -#X obj 78 432 *~ 0.1; -#X obj 148 399 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 --1 -1 0 1; -#X msg 225 345 set C; -#X text 50 507 All put~ objects copy their input to a local buffer -which all receive~ objects of the same name read from. They may be -in different windows or even different patches. Any number of get~ -objects may be associated with any number of put~ objects . Because -of the buffer \, the signal is delayed by one block.; -#X text 33 152 Argument: the name.; -#X text 32 168 get~ takes "set" messages to switch between put~ objects. -; -#X connect 7 0 9 0; -#X connect 8 0 6 0; -#X connect 9 0 5 0; -#X connect 11 0 10 0; -#X connect 12 0 11 0; -#X connect 14 0 19 0; -#X connect 15 0 14 0; -#X connect 16 0 14 0; -#X connect 17 0 6 0; -#X connect 18 0 6 0; -#X connect 19 0 13 0; -#X connect 19 0 13 1; -#X connect 20 0 19 1; -#X connect 21 0 14 0; diff --git a/help/param-help.pd b/help/param-help.pd index 85aae8e..4661e58 100644 --- a/help/param-help.pd +++ b/help/param-help.pd @@ -1,99 +1,111 @@ -#N canvas 1024 24 1018 688 10; -#X floatatom 504 237 5 0 0 0 - - -; +#N canvas 1086 33 780 563 10; #X obj -23 2 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 0; #X text -18 54 author: mrtoftrash@gmail.com; -#X text -18 1 description: param is a state saving and message routing -system.; #X text -19 75 version: 2009-09-19 (localized release); -#X text -19 33 tags: state routing param; -#X text 179 122 argument 1: param name (must start with a slash); -#X text 612 141 nbx: creates a numberbox; -#X text 611 160 slider min max: creates a slider with the indicated -minimum and maximum; -#X text 611 189 bng: creates a bang; -#X text 611 207 tgl: creates a toggle; -#X text 613 225 symbolatom: creates a symbol box; -#X text 68 355 (\$0)/abstraction's name/.../param's name; -#X text 5 210 If the param object is created directly in the root patch -(as the my_name example above) \, its path is as follows:; -#X text 7 172 A param object creates a storage area for anything. This -data can be accessed through a unique symbolic path.; -#X text 60 245 (\$0)/param's name; -#X text 7 279 If the param is inside an abstraction (or inside an abstraction -contained inside another abstraction an so forth) \, the path starts -at the root and follows every child patch (abstraction) until it reaches -the param object \, at which point the param's name is appended:; -#X text 40 414 If an abstraction's arguments contains the "/id" keyword +#N canvas 237 177 542 366 all 0; +#X text 210 53 argument 1: param name (must start with a slash); +#X obj 21 56 tof/param /my_name my_value; +#X text 210 70 argument 2...: param value (can be anything; +#X text 210 86 argument ...: special keywords; +#X text 85 303 (\$0)/abstraction's name/.../param's name; +#X text 22 158 If the param object is created directly in the root +patch (as the my_name example above) \, its path is as follows:; +#X text 24 120 A param object creates a storage area for anything. +This data can be accessed through a unique symbolic path.; +#X text 77 193 (\$0)/param's name; +#X text 24 227 If the param is inside an abstraction (or inside an +abstraction contained inside another abstraction an so forth) \, the +path starts at the root and follows every child patch (abstraction) +until it reaches the param object \, at which point the param's name +is appended:; +#X restore -16 164 pd all about [param /name]; +#N canvas 0 0 525 231 all 0; +#X text 63 67 If an abstraction's arguments contains the "/id" keyword \, the symbol following the "/id" keyword \, instead of the abstraction's name \, will be used to build the path. See an example to the right. ; -#X floatatom 556 110 5 0 0 0 - - -; -#X text 53 475 --------------------- SEE ALSO ----------------------- +#X text 26 42 Abstraction /id:; +#X restore -14 326 pd all about /id; +#N canvas 0 0 450 300 all 0; +#X restore -16 187 pd all about [param custom /name]; +#N canvas 0 0 975 555 all 0; +#X text 565 152 nbx: creates a numberbox; +#X text 564 171 slider min max: creates a slider with the indicated +minimum and maximum; +#X text 564 200 bng: creates a bang; +#X text 564 218 tgl: creates a toggle; +#X text 566 236 symbolatom: creates a symbol box; +#X floatatom 509 121 5 0 0 0 - - -; +#X obj 509 95 tof/param /number 30 /g nbx; +#X text 506 137 /g options:; +#X text 509 55 When you create a param \, you can optinally use the +"/g" keyword to flag the param with gui options.; +#X floatatom 162 129 5 0 0 0 - - -; +#X obj 162 106 tof/param /test 50 /nlb; +#X text 49 63 A param automatically ouputs its value when it is created. +You can disable this behavior with the "/nlb" (no loadbang) keyword. +; +#X text 451 38 /g keyword: GUI options; +#X text 18 41 /nlb keyword: No loadbang; +#X text 24 155 /wfb keyword: Wait for bang; +#X text 56 177 This param will only output its contents on a bang. +; +#X obj 49 227 tof/param /waiting 50 /wfb; +#X floatatom 49 200 5 0 0 0 - - -; +#X floatatom 49 250 5 0 0 0 - - -; +#X obj 93 203 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +-1; +#X text 36 296 /ns keyword: No save; +#X text 67 317 This param will never be saved.; +#X obj 177 298 tof/param /nope 50 /ns; +#X text 249 449 /nps keyword: No preset save; +#X text 280 471 This param will never be saved in a preset file.; +#X obj 448 449 tof/param /noPresets 67 /nps; +#X text 284 411 Special keywords for [param /name] and [param custom] ; -#X obj 496 359 dac~; -#X obj 717 280 hsl 100 15 0 1 0 0 \$0/FM_MOD/volume \$0/FM_MOD/volume_ +#X text 350 5 Special keywords for [param /name]; +#X connect 6 0 5 0; +#X connect 10 0 9 0; +#X connect 16 0 18 0; +#X connect 17 0 16 0; +#X connect 19 0 16 0; +#X restore 150 164 pd all about keywords; +#X text -18 1 description: [param] is a state saving and message routing +system.; +#X text -19 33 tags: state routing; +#N canvas 0 0 450 300 all 0; +#X restore -16 258 pd all about [param file]; +#N canvas 0 0 450 300 all 0; +#X restore -16 280 pd all about [param route]; +#N canvas 0 0 450 300 all 0; +#X restore -15 302 pd all about [param gui]; +#N canvas 0 0 450 300 all 0; +#X restore -16 235 pd all about [param dump]; +#N canvas 0 0 450 300 all 0; +#X restore -16 210 pd all about [param id]; +#X text -17 106 [param] is to state saving what [list] is to lists +:); +#X floatatom 98 383 5 0 0 0 - - -; +#X obj 90 505 dac~; +#X obj 341 417 hsl 100 15 0 1 0 0 \$0/FM_MOD/volume \$0/FM_MOD/volume_ /FM_MOD/volume 105 7 0 10 -262144 -1 -1 0 1; -#X obj 717 300 hsl 100 15 200 2000 0 0 \$0/FM_MOD/carrier \$0/FM_MOD/carrier_ +#X obj 341 437 hsl 100 15 200 2000 0 0 \$0/FM_MOD/carrier \$0/FM_MOD/carrier_ /FM_MOD/carrier 105 7 0 10 -262144 -1 -1 2200 1; -#X obj 715 339 nbx 5 14 -1e+37 1e+37 0 0 \$0/FM_MOD/modulation/index +#X obj 339 476 nbx 5 14 -1e+37 1e+37 0 0 \$0/FM_MOD/modulation/index \$0/FM_MOD/modulation/index_ /FM_MOD/modulation/index 57 7 0 10 -262144 -1 -1 20 256; -#X obj 715 320 nbx 5 14 -1e+37 1e+37 0 0 \$0/FM_MOD/modulation/freq +#X obj 339 457 nbx 5 14 -1e+37 1e+37 0 0 \$0/FM_MOD/modulation/freq \$0/FM_MOD/modulation/freq_ /FM_MOD/modulation/freq 57 7 0 10 -262144 -1 -1 3 256; -#X obj 544 283 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 +#X obj 138 429 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 -1 -1 0 1; -#X obj 556 84 tof/param /number 30 /g nbx; -#X obj 22 503 tof/paramFile; -#X obj 118 503 tof/paramRoute; -#X obj 217 503 tof/OSCToParam; -#X obj 322 503 tof/paramDump; -#X obj 25 527 tof/paramGui; -#X obj -10 149 print loadbang; -#X obj -10 125 tof/param /my_name my_value; -#X text 553 126 /g options:; -#X text 556 44 When you create a param \, you can optinally use the -"/g" keyword to flag the param with gui options.; -#X obj 504 330 param-abs /id FM_MOD /carrier 600; -#X floatatom 613 481 5 0 0 0 - - -; -#X obj 613 458 tof/param /test 50 /nlb; -#X text 500 415 A param automatically ouputs its value when it is created. -You can disable this behavior with the "/nlb" (no loadbang) keyword. -; -#X msg 504 259 /modulation/index \$1; -#X msg 541 305 /volume \$1; -#X text 179 139 argument 2...: param value (can be anything; -#X text 3 389 Abstraction /id:; -#X text 498 27 /g keyword: GUI options; -#X text 4 577 /ns keyword: No save; -#X text 469 393 /nlb keyword: No loadbang; -#X text 35 598 This param will never be saved.; -#X text 179 155 argument ...: special keywords; -#X text 475 507 /wfb keyword: Wait for bang; -#X text 507 529 This param will only output its contents on a bang. -; -#X obj 152 576 tof/param /nope 50 /ns; -#X obj 500 579 tof/param /waiting 50 /wfb; -#X floatatom 500 552 5 0 0 0 - - -; -#X floatatom 500 602 5 0 0 0 - - -; -#X obj 544 555 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 --1 -1; -#X text 544 8 -------------- SPECIAL KEYWORDS (continued) -------------- -; -#X text 71 553 -------------- SPECIAL KEYWORDS --------------; -#X text 4 630 /nps keyword: No preset save; -#X text 35 652 This param will never be saved in a preset file.; -#X obj 203 630 tof/param /noPresets 67 /nps; -#X connect 0 0 40 0; -#X connect 25 0 41 0; -#X connect 26 0 18 0; -#X connect 33 0 32 0; -#X connect 36 0 20 0; -#X connect 36 0 20 1; -#X connect 38 0 37 0; -#X connect 40 0 36 0; -#X connect 41 0 36 0; -#X connect 52 0 54 0; -#X connect 53 0 52 0; -#X connect 55 0 52 0; +#X msg 98 405 /modulation/index \$1; +#X msg 135 451 /volume \$1; +#X obj 98 476 ./param-abs /id FM_MOD /carrier 600; +#X connect 15 0 22 0; +#X connect 21 0 23 0; +#X connect 22 0 24 0; +#X connect 23 0 24 0; +#X connect 24 0 16 0; +#X connect 24 0 16 1; diff --git a/help/put~-help.pd b/help/put~-help.pd deleted file mode 100644 index eaef8b6..0000000 --- a/help/put~-help.pd +++ /dev/null @@ -1,48 +0,0 @@ -#N canvas 206 49 525 620 10; -#X obj -1 29 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 -0; -#X text 4 77 author: mrtoftrash@gmail.com; -#X text 4 29 description: many to many nonlocal signal connections. -; -#X text 3 55 tags: flow~; -#X text 4 98 version: 2009-09-30 (initial release); -#X obj 36 250 tof/put~ A; -#X obj 302 252 tof/put~ B; -#X obj 35 195 osc~ 800; -#X obj 301 215 noise~; -#X obj 35 222 *~ 0.5; -#X obj 145 253 tof/put~ A; -#X obj 144 225 *~ 0.5; -#X obj 144 198 osc~ 600; -#X obj 60 466 dac~; -#X obj 67 373 tof/get~; -#X msg 67 320 set A; -#X msg 140 323 set B; -#X msg 375 214 set A; -#X msg 397 242 set B; -#X obj 68 422 *~ 0.1; -#X obj 138 389 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 --1 -1 800 1; -#X msg 215 335 set C; -#X text 40 497 All put~ objects copy their input to a local buffer -which all receive~ objects of the same name read from. They may be -in different windows or even different patches. Any number of get~ -objects may be associated with any number of put~ objects . Because -of the buffer \, the signal is delayed by one block.; -#X text 23 142 Argument: the name.; -#X text 23 160 put~ takes "set" messages to switch between get~ objects. -; -#X connect 7 0 9 0; -#X connect 8 0 6 0; -#X connect 9 0 5 0; -#X connect 11 0 10 0; -#X connect 12 0 11 0; -#X connect 14 0 19 0; -#X connect 15 0 14 0; -#X connect 16 0 14 0; -#X connect 17 0 6 0; -#X connect 18 0 6 0; -#X connect 19 0 13 0; -#X connect 19 0 13 1; -#X connect 20 0 19 1; -#X connect 21 0 14 0; -- cgit v1.2.1