From 219aab4488b61944b80655ae0e75e318845b942d Mon Sep 17 00:00:00 2001 From: Jonathan Wilkes <jancsika@yahoo.com> Date: Sun, 5 Oct 2014 18:51:54 -0400 Subject: [PATCH] Updated documentation for *info classes --- pd/doc/5.reference/canvasinfo-help.pd | 59 ++++++++------- pd/doc/5.reference/classinfo-help.pd | 28 ++++---- pd/doc/5.reference/objectinfo-help.pd | 75 ++++++++++--------- pd/doc/5.reference/pdinfo-help.pd | 100 +++++++++++++------------- 4 files changed, 130 insertions(+), 132 deletions(-) diff --git a/pd/doc/5.reference/canvasinfo-help.pd b/pd/doc/5.reference/canvasinfo-help.pd index 58202f6ca..c3f8db62f 100644 --- a/pd/doc/5.reference/canvasinfo-help.pd +++ b/pd/doc/5.reference/canvasinfo-help.pd @@ -3,7 +3,7 @@ 14 -228856 -66577 0; #X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header canvasinfo 3 12 0 18 -204280 -1 0; -#X obj 0 431 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +#X obj 0 451 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 -228856 -1 0; #N canvas 48 165 482 332 META 0; #X text 12 145 LIBRARY internal; @@ -24,7 +24,7 @@ filename hitbox name pointer posonparent screenpos toplevel vis; 0 13 -228856 -1 0; #X obj 0 563 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 0 13 -228856 -1 0; -#X obj 78 439 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +#X obj 78 459 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; #N canvas 196 385 428 108 Related_objects 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 @@ -36,15 +36,8 @@ filename hitbox name pointer posonparent screenpos toplevel vis; #X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide ; #X msg 39 48 print; -#X text 80 47 print all attributes to the console; -#X text 98 438 print; -#X text 168 438 - print out each available message (other than "print") -followed by a semicolon and the output for that method.; -#X text 168 464 pdinfo's availabe methods are shown above \, with audio-device -and midi-device message in subpatches.; +#X text 98 458 print; #X text 99 503 list; -#X text 169 503 - output varies depending on the message sent to [pdinfo]. -; #X obj 483 5 canvasinfo; #X text 11 20 get info about a canvas; #X obj 39 390 canvasinfo; @@ -72,8 +65,6 @@ it was saved (0 = no \, 1 = yes); #X text 233 328 screen position of a visible canvas; #X msg 175 368 vis; #X text 203 368 whether a canvas is visible on the screen; -#X text 132 89 full text of the object box for an abstraction or subpatch -; #X text 181 244 see whether a coordinate lies on an object in the canvas ; #X text 123 130 directory for this canvas' environment; @@ -130,8 +121,6 @@ so on (if they exist); #X connect 11 0 20 0; #X connect 19 0 11 0; #X restore 101 573 pd canvas_environment; -#X text 111 68 list of dollarsign arguments for this canvas' environment -; #N canvas 139 127 428 435 hitbox_and_coords 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; @@ -198,20 +187,28 @@ on the canvas that includes the "x y" coordinates you send it:; #X text 81 541 1) float; #X text 169 541 - canvas stacking level (0 = this canvas \, 1 = parent \, etc.); -#X connect 11 0 20 0; -#X connect 20 0 48 0; -#X connect 21 0 20 0; -#X connect 22 0 20 0; -#X connect 23 0 20 0; -#X connect 25 0 20 0; -#X connect 26 0 20 0; -#X connect 28 0 20 0; -#X connect 29 0 20 0; -#X connect 31 0 20 0; -#X connect 32 0 20 0; -#X connect 33 0 20 0; -#X connect 36 0 20 0; -#X connect 37 0 20 0; -#X connect 38 0 20 0; -#X connect 41 0 20 0; -#X connect 49 0 20 0; +#X text 132 89 text of the object box for an abstraction or subpatch +(raw); +#X text 111 68 list of dollarsign argument values for this canvas; +#X text 80 47 print all attributes directly to the console; +#X text 168 458 - print all "method: value(s)" pairs directly to the +console; +#X text 169 503 - varies depending on the message sent to [canvasinfo] +; +#X connect 11 0 16 0; +#X connect 16 0 43 0; +#X connect 17 0 16 0; +#X connect 18 0 16 0; +#X connect 19 0 16 0; +#X connect 21 0 16 0; +#X connect 22 0 16 0; +#X connect 24 0 16 0; +#X connect 25 0 16 0; +#X connect 27 0 16 0; +#X connect 28 0 16 0; +#X connect 29 0 16 0; +#X connect 32 0 16 0; +#X connect 33 0 16 0; +#X connect 34 0 16 0; +#X connect 37 0 16 0; +#X connect 44 0 16 0; diff --git a/pd/doc/5.reference/classinfo-help.pd b/pd/doc/5.reference/classinfo-help.pd index 972146fd5..327691048 100644 --- a/pd/doc/5.reference/classinfo-help.pd +++ b/pd/doc/5.reference/classinfo-help.pd @@ -1,4 +1,4 @@ -#N canvas 425 49 555 619 10; +#N canvas 0 19 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 classinfo 3 12 0 @@ -36,7 +36,6 @@ #X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide ; #X msg 53 61 print; -#X text 94 60 print all attributes to the console; #X text 98 358 print; #X text 168 358 - print out each available message (other than "print") followed by a semicolon and the output for that method.; @@ -45,7 +44,6 @@ followed by a semicolon and the output for that method.; ; #X msg 83 81 args; #X obj 53 264 print; -#X text 11 20 get info about a class; #X obj 462 3 classinfo; #X obj 140 264 print reject_outlet; #X text 125 81 list of argument types accepted by the object; @@ -98,14 +96,16 @@ as an argument; #X text 81 541 1) symbol; #X floatatom 96 210 5 0 0 0 - - -, f 5; #X msg 340 201 symbol canvas; -#X connect 11 0 29 0; -#X connect 17 0 29 0; -#X connect 23 0 29 0; -#X connect 25 0 29 0; -#X connect 27 0 29 0; -#X connect 29 0 18 0; -#X connect 29 1 21 0; -#X connect 30 0 29 1; -#X connect 33 0 29 1; -#X connect 50 0 29 0; -#X connect 51 0 29 1; +#X text 11 20 get info about a Pure Data class; +#X text 94 60 print all attributes directly to the console; +#X connect 11 0 27 0; +#X connect 16 0 27 0; +#X connect 21 0 27 0; +#X connect 23 0 27 0; +#X connect 25 0 27 0; +#X connect 27 0 17 0; +#X connect 27 1 19 0; +#X connect 28 0 27 1; +#X connect 31 0 27 1; +#X connect 48 0 27 0; +#X connect 49 0 27 1; diff --git a/pd/doc/5.reference/objectinfo-help.pd b/pd/doc/5.reference/objectinfo-help.pd index ad0ff73c9..ab76eeb69 100644 --- a/pd/doc/5.reference/objectinfo-help.pd +++ b/pd/doc/5.reference/objectinfo-help.pd @@ -1,9 +1,9 @@ -#N canvas 0 19 555 619 10; +#N canvas -9 19 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 objectinfo 3 12 0 18 -204280 -1 0; -#X obj 0 403 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +#X obj 0 396 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 -228856 -1 0; #N canvas 456 104 482 506 META 0; #X text 12 175 LIBRARY internal; @@ -21,13 +21,13 @@ to conform to the PDDP template for Pd version 0.42.; #X text 12 115 INLET_2 float; #X text 12 155 OUTLET_1 bang; #X restore 500 597 pd META; -#X obj 0 478 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +#X obj 0 491 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 13 -228856 -1 0; -#X obj 0 515 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +#X obj 0 528 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 0 13 -228856 -1 0; -#X obj 0 555 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +#X obj 0 565 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 0 13 -228856 -1 0; -#X obj 78 411 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +#X obj 78 404 cnv 17 3 55 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; #N canvas 102 481 428 108 Related_objects 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 @@ -37,22 +37,21 @@ to conform to the PDDP template for Pd version 0.42.; #X obj 72 36 classinfo; #X obj 142 36 canvasinfo; #X restore 101 597 pd Related_objects; -#X obj 78 487 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +#X obj 78 500 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; #X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide ; #X msg 39 62 print; #X text 80 61 print all attributes to the console; -#X msg 101 232 version; -#X text 98 410 print; -#X text 168 410 - print out each available message (other than "print") +#X text 98 403 print; +#X text 168 403 - print out each available message (other than "print") followed by a semicolon and the output for that method.; -#X text 99 487 list; -#X text 169 487 - output varies depending on the message sent to [pdinfo] +#X text 99 500 list; +#X text 169 500 - output varies depending on the message sent to [pdinfo] ; #X text 11 20 get info about a Pd object; #X obj 473 7 objectinfo; -#X obj 39 323 objectinfo; +#X obj 39 303 objectinfo; #X msg 72 92 bbox; #X text 114 91 list of coordinates-- x1 y1 x2 y2-- for the bounding rectangle of the object on the canvas.; @@ -60,30 +59,28 @@ rectangle of the object on the canvas.; #X text 137 121 list of atoms that appear in the object box; #X msg 89 152 class; #X text 136 152 class of the object; -#X msg 92 182 inlets; -#X text 141 181 number of inlets the object has; -#X msg 95 209 outlets; -#X text 151 208 number of outlets the object has; -#X floatatom 98 269 5 0 0 0 - - -, f 5; -#X text 141 269 index number of the object you want to inspect; -#X floatatom 104 299 5 0 0 0 - - -, f 5; -#X text 141 299 canvas level: '0' for this canvas \, '1' for the parent -canvas \, etc.; -#X text 201 347 outputs a bang if there isn't an object at this index +#X msg 112 212 inlets; +#X text 161 211 number of inlets the object has; +#X msg 115 239 outlets; +#X text 171 238 number of outlets the object has; +#X text 201 327 outputs a bang if there isn't an object at this index ; -#X obj 39 372 print object-info; -#X obj 96 347 print no-object; -#X text 168 450 objectinfo's available methods are shown above.; -#X text 81 532 1) float; -#X text 169 532 canvas level; -#X connect 11 0 20 0; -#X connect 13 0 20 0; -#X connect 20 0 36 0; -#X connect 20 1 37 0; -#X connect 21 0 20 0; -#X connect 23 0 20 0; -#X connect 25 0 20 0; -#X connect 27 0 20 0; -#X connect 29 0 20 0; -#X connect 31 0 20 1; -#X connect 33 0 20 2; +#X obj 39 352 print object-info; +#X obj 96 327 print no-object; +#X text 168 438 objectinfo's available methods are shown above.; +#X msg 99 182 index; +#X text 146 182 z-order index of the object on the canvas; +#X obj 78 464 cnv 17 3 25 empty \$0-pddp.cnv.let.0 1 5 9 0 16 -228856 +-162280 0; +#X text 98 463 pointer; +#X text 168 463 pointer to an object on the canvas; +#X text 81 545 none; +#X connect 11 0 19 0; +#X connect 19 0 31 0; +#X connect 19 1 32 0; +#X connect 20 0 19 0; +#X connect 22 0 19 0; +#X connect 24 0 19 0; +#X connect 26 0 19 0; +#X connect 28 0 19 0; +#X connect 34 0 19 0; diff --git a/pd/doc/5.reference/pdinfo-help.pd b/pd/doc/5.reference/pdinfo-help.pd index 848c77827..dcb3cc7de 100644 --- a/pd/doc/5.reference/pdinfo-help.pd +++ b/pd/doc/5.reference/pdinfo-help.pd @@ -1,9 +1,9 @@ -#N canvas -9 19 555 619 10; +#N canvas 0 19 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 pdinfo 3 12 0 18 -204280 -1 0; -#X obj 0 353 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +#X obj 0 363 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 -228856 -1 0; #N canvas 34 81 482 506 META 0; #X text 12 175 LIBRARY internal; @@ -33,7 +33,7 @@ version; 0 13 -228856 -1 0; #X obj 0 527 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 0 13 -228856 -1 0; -#X obj 78 361 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +#X obj 78 371 cnv 17 3 70 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; #N canvas 102 481 428 108 Related_objects 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 @@ -45,24 +45,20 @@ version; -162280 0; #X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide ; -#X text 11 20 get info from the global Pd instance that's running; #X obj 503 7 pdinfo; -#X obj 39 291 pdinfo; +#X obj 39 284 pdinfo; #X msg 39 60 print; -#X text 80 59 print all attributes to the console; -#X msg 101 230 version; -#X obj 39 322 print pd-version; -#X text 155 229 version of Pd that's running (MAJOR MINOR TEST); -#X msg 95 207 samplerate; -#X text 169 206 global samplerate; -#X msg 78 120 dir; -#X text 107 119 directory of the Pd executable; -#X msg 72 90 blocksize; -#X text 144 89 global blocksize; -#X msg 92 180 pi; -#X text 121 179 value of Pi; -#X msg 89 150 dsp-status; -#X text 164 150 whether dsp is turned on (0 = off \, 1 = on); +#X msg 89 201 version; +#X obj 39 315 print pd-version; +#X text 143 200 version of Pd that's running (MAJOR MINOR TEST); +#X msg 83 178 samplerate; +#X text 157 177 global samplerate; +#X msg 70 116 dir; +#X text 99 115 directory of the Pd executable; +#X msg 64 86 blocksize; +#X text 136 85 global blocksize; +#X msg 77 146 dsp-status; +#X text 152 146 whether dsp is turned on (0 = off \, 1 = on); #N canvas 100 44 428 514 audio-attributes 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; @@ -73,7 +69,6 @@ version; #X text 94 37 audio api that is currently in use; #X msg 42 72 audio-apilist; #X text 134 71 list of available audio apis; -#X msg 65 102 audio-apilist-raw; #X text 179 102 audio apis for all platforms; #X msg 79 132 audio-inchannels; #X text 184 132 number of incoming audio channels; @@ -94,20 +89,21 @@ version; #X text 193 414 list of output device names; #X text 179 203 returns: device_index no_of_channels; #X text 183 391 returns: device_index no_of_channels; +#X msg 65 102 audio-apilist-all; #X connect 2 0 3 0; #X connect 4 0 2 0; #X connect 6 0 2 0; -#X connect 8 0 2 0; -#X connect 10 0 2 0; -#X connect 13 0 14 0; +#X connect 9 0 2 0; +#X connect 12 0 13 0; +#X connect 13 0 2 0; #X connect 14 0 2 0; -#X connect 15 0 2 0; -#X connect 17 0 2 0; -#X connect 20 0 2 0; -#X connect 22 0 2 0; -#X connect 24 0 22 0; -#X connect 25 0 2 0; -#X restore 206 322 pd audio-attributes; +#X connect 16 0 2 0; +#X connect 19 0 2 0; +#X connect 21 0 2 0; +#X connect 23 0 21 0; +#X connect 24 0 2 0; +#X connect 28 0 2 0; +#X restore 156 340 pd audio-attributes; #N canvas 125 83 428 395 midi-attributes 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; @@ -139,29 +135,37 @@ version; #X connect 15 0 2 0; #X connect 16 0 2 0; #X connect 17 0 2 0; -#X restore 346 322 pd midi-attributes; -#X text 98 360 print; -#X text 168 360 - print out each available message (other than "print") +#X restore 296 340 pd midi-attributes; +#X text 98 370 print; +#X text 168 370 - print out each available message (other than "print") followed by a semicolon and the output for that method.; #X text 99 459 list; #X text 81 504 none; -#X text 168 400 pdinfo's available methods are shown above \, with +#X text 168 410 pdinfo's available methods are shown above \, with audio-device and midi-device message in subpatches.; #X text 169 459 - output varies depending on the message sent to [pdinfo] ; -#X msg 101 260 classtable; -#X text 81 547 When using the "classtable" message \, note that some +#X msg 101 253 classlist; +#X text 155 305 Audio and MIDI specific messages are in the subpatches +below:; +#X text 81 547 When using the "classlist" message \, note that some external Pd classes don't have a name. These are currently listed simply as "anonymous-class" in the output.; -#X text 175 259 (long) list of all classes that have been loaded in -the running instance of Pd. (Note: not all classes can be created in -an object box.); -#X connect 13 0 17 0; -#X connect 14 0 13 0; -#X connect 16 0 13 0; -#X connect 19 0 13 0; -#X connect 21 0 13 0; -#X connect 23 0 13 0; -#X connect 25 0 13 0; -#X connect 27 0 13 0; -#X connect 37 0 13 0; +#X text 175 252 (long) list of all class names that have been loaded +in the running instance of Pd. (Note: not all classes can be created +in an object box.); +#X msg 92 227 canvaslist; +#X text 166 226 list of pointers to toplevel canvases in running Pd +instance; +#X text 80 59 print all attributes directly to the console; +#X text 11 20 get info from the Pd instance that is running your patch +; +#X connect 12 0 15 0; +#X connect 13 0 12 0; +#X connect 14 0 12 0; +#X connect 17 0 12 0; +#X connect 19 0 12 0; +#X connect 21 0 12 0; +#X connect 23 0 12 0; +#X connect 33 0 12 0; +#X connect 37 0 12 0; -- GitLab