diff options
Diffstat (limited to 'help')
| -rw-r--r-- | help/param-abs.pd | 33 | ||||
| -rw-r--r-- | help/param-help.pd | 89 | ||||
| -rw-r--r-- | help/param2-abs.pd | 24 | ||||
| -rw-r--r-- | help/paramDump-help.pd | 25 | ||||
| -rw-r--r-- | help/paramFile-help.pd | 52 | ||||
| -rw-r--r-- | help/paramRoute-help.pd | 39 |
6 files changed, 262 insertions, 0 deletions
diff --git a/help/param-abs.pd b/help/param-abs.pd new file mode 100644 index 0000000..b0b38a9 --- /dev/null +++ b/help/param-abs.pd @@ -0,0 +1,33 @@ +#N canvas 1024 0 1018 716 10; +#X obj 225 477 outlet~; +#X obj 55 21 inlet; +#X obj 55 66 paramRoute; +#X text 179 26 This abstraction is an example for the param external. +; +#X floatatom 223 247 0 0 0 0 - - -; +#X obj 223 317 +~; +#X text 153 168 carrier; +#X text 152 186 frequency; +#X obj 224 359 osc~; +#X obj 56 97 print PARAM_NOTFOUND; +#X obj 223 171 loadbang; +#X obj 225 428 *~; +#X obj 315 400 line~; +#X msg 316 376 \$1 100; +#X obj 317 325 loadbang; +#X obj 317 349 param /volume 0 /gui slider 0 1; +#X obj 223 202 param /carrier 800 /gui slider 200 2000; +#X obj 321 300 param2-abs /id modulation; +#X connect 1 0 2 0; +#X connect 2 0 9 0; +#X connect 4 0 5 0; +#X connect 5 0 8 0; +#X connect 8 0 11 0; +#X connect 10 0 16 0; +#X connect 11 0 0 0; +#X connect 12 0 11 1; +#X connect 13 0 12 0; +#X connect 14 0 15 0; +#X connect 15 0 13 0; +#X connect 16 0 4 0; +#X connect 17 0 5 1; diff --git a/help/param-help.pd b/help/param-help.pd new file mode 100644 index 0000000..b1938a7 --- /dev/null +++ b/help/param-help.pd @@ -0,0 +1,89 @@ +#N canvas 1024 0 1018 688 10; +#X floatatom 477 321 5 0 0 0 - - -; +#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 obj 33 546 paramFile; +#X obj 555 541 paramDump; +#X obj 557 620 paramGui; +#X obj 32 592 paramRoute; +#X text 3 389 /id keyword:; +#X obj 14 127 param /my_name my_value; +#X text 169 122 argument 1: param name (must start with a slash); +#X text 169 139 argument 2...: param value (can be a list); +#X obj 525 126 param /number 30 /gui nbx; +#X text 578 181 nbx: creates a numberbox; +#X text 577 200 slider min max: creates a slider with the indicated +minimum and maximum; +#X text 577 229 bng: creates a bang; +#X text 577 247 tgl: creates a toggle; +#X text 579 265 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 100 590 Sends values to params using a relative path.; +#X obj 34 620 OSCToParam; +#X text 515 166 /gui options:; +#X text 526 81 When you create a param \, you can optinally use the +"/gui" keyword to flag the param with gui options.; +#X text 40 414 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 obj 557 599 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 +-1 -1; +#X obj 33 519 bng 15 250 50 0 empty empty save 17 7 0 10 -262144 -1 +-1; +#X obj 99 518 bng 15 250 50 0 empty empty load 17 7 0 10 -262144 -1 +-1; +#X floatatom 525 146 5 0 0 0 - - -; +#X obj 555 519 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 +-1 -1; +#X obj 555 569 print DUMP; +#X text 268 490 --------------------- SEE ALSO ----------------------- +; +#X obj 472 448 dac~; +#X obj 690 364 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 690 384 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 3300 1; +#X obj 688 423 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 688 404 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 msg 477 343 modulation/index \$1; +#X obj 517 367 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 +-1 -1 0 1; +#X msg 514 389 volume \$1; +#X obj 477 414 param-abs /id FM_MOD; +#X text 624 538 Outputs all children params of the root patch.; +#X text 99 541 Saves and restores all chilren params of the root patch +to/from a file with optionnal presets.; +#X text 623 617 Build a PD gui for all children params that have values +for the "/gui" keyword.; +#X text 107 620 Routes OSC messages to matching children params; +#X connect 0 0 42 0; +#X connect 7 0 35 0; +#X connect 14 0 33 0; +#X connect 30 0 8 0; +#X connect 31 0 6 0; +#X connect 32 0 6 1; +#X connect 34 0 7 0; +#X connect 42 0 45 0; +#X connect 43 0 44 0; +#X connect 44 0 45 0; +#X connect 45 0 37 0; +#X connect 45 0 37 1; diff --git a/help/param2-abs.pd b/help/param2-abs.pd new file mode 100644 index 0000000..f793907 --- /dev/null +++ b/help/param2-abs.pd @@ -0,0 +1,24 @@ +#N canvas 1228 134 711 410 10; +#X text 84 2 This abstraction is an example for the param external. +; +#X obj 175 232 *~; +#X floatatom 175 147 0 0 0 0 - - -; +#X floatatom 237 200 0 0 0 0 - - -; +#X text 64 127 frequency; +#X text 63 114 modulation; +#X text 278 216 index; +#X text 280 197 modulation; +#X obj 175 172 osc~; +#X obj 163 341 outlet~; +#X obj 237 172 param /index 20 /gui nbx; +#X obj 174 122 param /freq 3 /gui nbx; +#X obj 172 99 loadbang; +#X obj 238 148 loadbang; +#X connect 1 0 9 0; +#X connect 2 0 8 0; +#X connect 3 0 1 1; +#X connect 8 0 1 0; +#X connect 10 0 3 0; +#X connect 11 0 2 0; +#X connect 12 0 11 0; +#X connect 13 0 10 0; diff --git a/help/paramDump-help.pd b/help/paramDump-help.pd new file mode 100644 index 0000000..1606ddd --- /dev/null +++ b/help/paramDump-help.pd @@ -0,0 +1,25 @@ +#N canvas 238 80 610 462 10; +#X obj 38 195 paramDump; +#X obj 38 228 print; +#X obj 38 129 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +-1; +#X obj 21 12 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 +0; +#X text 26 68 author: mrtoftrash@gmail.com; +#X text 26 89 version: 2009-09-19 (localized version); +#X text 26 13 description: outputs all the children params of the root +patch.; +#X obj 205 227 param-abs /id FM_MOD; +#X text 69 273 --------------------- SEE ALSO ----------------------- +; +#X text 43 294 See the help for the param external to expand your mind: +; +#X obj 148 320 param /another a_value; +#X msg 82 161 guis; +#X text 61 130 A bang will output all the params and their values. +; +#X text 119 158 Guis will output all the optional /gui values.; +#X text 26 47 tags: state param; +#X connect 0 0 1 0; +#X connect 2 0 0 0; +#X connect 11 0 0 0; diff --git a/help/paramFile-help.pd b/help/paramFile-help.pd new file mode 100644 index 0000000..4bca30f --- /dev/null +++ b/help/paramFile-help.pd @@ -0,0 +1,52 @@ +#N canvas 1102 91 735 547 10; +#X obj 423 300 hradio 15 1 0 8 empty empty empty 0 -8 0 10 -262144 +-1 -1 0; +#X obj 474 351 hradio 15 1 0 8 empty empty empty 0 -8 0 10 -262144 +-1 -1 0; +#X obj 11 36 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 +0; +#X text 16 92 author: mrtoftrash@gmail.com; +#X text 16 113 version: 2009-04-14 (initial release); +#X obj 30 372 paramFile; +#X obj 30 291 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +-1; +#X obj 81 331 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1 +-1; +#X text 16 37 description: paramFile is an abstraction than saves and +restores params in individual files on the hard disk.; +#X text 16 71 tags: state file param; +#X text 52 289 Save preset "000"; +#X obj 423 399 paramFile; +#X floatatom 423 324 5 0 0 0 - - -; +#X floatatom 474 373 5 0 0 0 - - -; +#X text 463 322 Save preset N; +#X text 27 138 Please note that only the param children of the same +root patch as the paramFile will be saved/restored.; +#X text 102 328 Restore preset "000"; +#X text 512 372 Restore preset N; +#X text 423 278 You may save and restore up to 127 different presets. +; +#X text 29 178 The data will be saved in the same folder as the root +patch and will include its name and the preset number as follows:; +#X text 85 214 root_patch_name-preset#.param; +#X text 25 234 For example \, if click save on the following bang \, +the file "paramFile-help-000.param" will be created and will store +the param "/something_to_save"; +#X text 202 497 See the help for the param external to expand your +mind.; +#X text 217 480 --------------------- SEE ALSO ----------------------- +; +#X obj 34 445 param /something_to_save symbol i_love_you_mary_jane +; +#X symbolatom 33 468 40 0 0 0 - - -; +#X msg 34 420 symbol banana; +#X msg 128 420 symbol iguana; +#X connect 0 0 12 0; +#X connect 1 0 13 0; +#X connect 6 0 5 0; +#X connect 7 0 5 1; +#X connect 12 0 11 0; +#X connect 13 0 11 1; +#X connect 24 0 25 0; +#X connect 26 0 24 0; +#X connect 27 0 24 0; diff --git a/help/paramRoute-help.pd b/help/paramRoute-help.pd new file mode 100644 index 0000000..a201d06 --- /dev/null +++ b/help/paramRoute-help.pd @@ -0,0 +1,39 @@ +#N canvas 62 155 886 436 10; +#X obj 11 36 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577 +0; +#X text 16 92 author: mrtoftrash@gmail.com; +#X text 16 113 version: 2009-09-19 (localized version); +#X text 16 37 description: routes param messages.; +#X floatatom 389 200 5 0 0 0 - - -; +#X obj 602 243 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 602 263 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 3300 1; +#X obj 600 302 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 600 283 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 msg 389 222 modulation/index \$1; +#X obj 429 246 hsl 128 15 0 1 0 0 empty empty empty -2 -8 0 10 -262144 +-1 -1 0 1; +#X msg 426 268 volume \$1; +#X obj 389 293 param-abs /id FM_MOD; +#X obj 384 327 dac~; +#X text 13 185 paramRoute routes messages to params that are included +inside abstractions. It uses a relative path to simplify things.; +#X text 20 287 Open the "param-abs" abstraction to the right and you +should undertand what that means (I hope).; +#X text 216 357 --------------------- SEE ALSO ----------------------- +; +#X text 190 378 See the help for the param external to expand your +mind:; +#X obj 342 398 param /dummy; +#X text 16 71 tags: state routing param; +#X connect 4 0 9 0; +#X connect 9 0 12 0; +#X connect 10 0 11 0; +#X connect 11 0 12 0; +#X connect 12 0 13 0; +#X connect 12 0 13 1; |