Almost ready for a release

svn path=/trunk/externals/tof/; revision=12430

6 files changed, 156 insertions, 75 deletions

diff --git a/test/param-abs.pd b/test/param-abs.pd
index 42a8146..b0b38a9 100644
--- a/test/param-abs.pd
+++ b/test/param-abs.pd
@@ -1,5 +1,5 @@
 #N canvas 1024 0 1018 716 10;
-#X obj 222 468 outlet~;
+#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.
@@ -11,13 +11,13 @@
 #X obj 224 359 osc~;
 #X obj 56 97 print PARAM_NOTFOUND;
 #X obj 223 171 loadbang;
-#X obj 229 418 *~;
-#X obj 298 421 line~;
-#X msg 299 397 \$1 100;
-#X obj 300 346 loadbang;
-#X obj 300 370 param /volume 0 /gui slider 0 1;
+#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 261 302 param2-abs /id modulation;
+#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;
diff --git a/test/param-help.pd b/test/param-help.pd
index 26d99b0..b1938a7 100644
--- a/test/param-help.pd
+++ b/test/param-help.pd
@@ -32,12 +32,8 @@ data can be accessed through a unique symbolic path.;
 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 623 617 Build a PD gui for all params that have values for
-the "/gui" keyword.;
 #X text 100 590 Sends values to params using a relative path.;
-#X text 624 538 Dumps all params children of the root patch.;
 #X obj 34 620 OSCToParam;
-#X text 107 620 Routes OSC messages to matching params;
 #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.;
@@ -45,8 +41,6 @@ the "/gui" 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 text 99 541 Saves and restores all params chilren of the root patch
-to/from a file with optionnal presets.;
 #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
@@ -59,31 +53,37 @@ to/from a file with optionnal presets.;
 #X obj 555 569 print DUMP;
 #X text 268 490 --------------------- SEE ALSO -----------------------
 ;
-#X obj 477 414 param-abs /id FM_MOD;
 #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 624 1;
+/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 400 1;
+/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 16 256;
+-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 66 256;
+-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 800 1;
+-1 -1 0 1;
 #X msg 514 389 volume \$1;
-#X connect 0 0 47 0;
-#X connect 7 0 39 0;
-#X connect 14 0 37 0;
-#X connect 34 0 8 0;
-#X connect 35 0 6 0;
-#X connect 36 0 6 1;
-#X connect 38 0 7 0;
-#X connect 41 0 42 0;
-#X connect 41 0 42 1;
-#X connect 47 0 41 0;
-#X connect 48 0 49 0;
-#X connect 49 0 41 0;
+#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/test/paramDump-help.pd b/test/paramDump-help.pd
new file mode 100644
index 0000000..1606ddd
--- /dev/null
+++ b/test/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/test/paramFile-help.pd b/test/paramFile-help.pd
index 72296ae..4bca30f 100644
--- a/test/paramFile-help.pd
+++ b/test/paramFile-help.pd
@@ -1,30 +1,52 @@
-#N canvas 1024 0 1018 716 10;
-#X obj 265 196 hradio 15 1 0 8 empty empty empty 0 -8 0 10 -262144
+#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 316 247 hradio 15 1 0 8 empty empty empty 0 -8 0 10 -262144
+#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 252 paramFile;
-#X obj 30 171 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
+#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 211 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -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 169 Save preset "000";
-#X text 108 207 Load preset "000";
-#X obj 265 295 paramFile;
-#X floatatom 265 220 5 0 0 0 - - -;
-#X floatatom 316 269 5 0 0 0 - - -;
-#X text 305 218 Save preset N;
-#X text 354 268 Load preset N;
-#X connect 0 0 13 0;
-#X connect 1 0 14 0;
+#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 13 0 12 0;
-#X connect 14 0 12 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/test/paramGui-help.pd b/test/paramGui-help.pd
index 8e07d8e..353d4cc 100644
--- a/test/paramGui-help.pd
+++ b/test/paramGui-help.pd
@@ -1,35 +1,30 @@
-#N canvas 228 199 663 465 10;
-#X obj 34 424 paramGui;
+#N canvas 198 148 663 465 10;
+#X obj 10 241 paramGui;
 #X obj -13 32 cnv 15 400 100 empty empty empty 20 12 0 14 -249661 -66577
 0;
 #X text -8 84 author: mrtoftrash@gmail.com;
-#X text -9 105 version: 2009-04-14 (initial release);
 #X text -8 31 description: builds interfaces out of pd guis for params.
 ;
 #X text -9 63 tags: param gui;
-#X obj 34 338 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
+#X obj 10 206 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
 -1;
-#X obj 52 221 param /pGUIexample 0 /gui nbx;
-#X floatatom 52 242 5 0 0 0 - - -;
-#X text -10 152 gui flag: when creating a param object \, you can append
-a gui flag (/gui) that will indicate the type of pd object that will
-be created and linked to that param. For example \, the following will
-create a number box:;
-#X text 388 215 Current /gui options:;
-#X text 390 238 /gui nbx;
-#X text 390 253 /gui bng;
-#X text 391 288 /gui hsl (min) (max);
-#X text 391 270 /gui tgl;
-#X text 389 305 /gui symbolatom;
-#X msg 65 357 /;
-#X text 55 337 Bang: build guis for all params that have a gui flag.
+#X text 406 216 /gui options:;
+#X text 31 205 Bang: build guis for all params that have /gui options.
 ;
-#X text 93 357 /: builds guis for all params that have a gui flag and
-that are at the root level.;
-#X msg 91 390 /id;
-#X text 125 390 /(id): builds guis for all params that have a gui flag
-and that are inside the abstraction with this id.;
-#X connect 6 0 0 0;
-#X connect 7 0 8 0;
-#X connect 16 0 0 0;
-#X connect 19 0 0 0;
+#X text 97 369 --------------------- SEE ALSO -----------------------
+;
+#X text 71 390 See the help for the param external to expand your mind:
+;
+#X obj 69 412 param /numerical 100 /gui nbx;
+#X text 108 277 -- SUPER IMPORTANT --;
+#X text 415 238 nbx: creates a numberbox;
+#X text 414 257 slider min max: creates a slider with the indicated
+minimum and maximum;
+#X text 414 286 bng: creates a bang;
+#X text 414 304 tgl: creates a toggle;
+#X text 416 322 symbolatom: creates a symbol box;
+#X obj 278 411 param /slip 100 /gui slider 0 127;
+#X text 14 293 You have to copy the created guis into your root patch
+(or a subpatch of it) for them to work with their target params!;
+#X text -9 105 version: 2009-09-19 (localized version);
+#X connect 5 0 0 0;
diff --git a/test/paramRoute-help.pd b/test/paramRoute-help.pd
new file mode 100644
index 0000000..a201d06
--- /dev/null
+++ b/test/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;