diff options
Diffstat (limited to 'doc/pddp')
| -rw-r--r-- | doc/pddp/append-help.pd | 29 | ||||
| -rw-r--r-- | doc/pddp/drawpolygon-help.pd | 110 | ||||
| -rw-r--r-- | doc/pddp/drawsymbol-help.pd | 10 | ||||
| -rw-r--r-- | doc/pddp/element-help.pd | 6 | ||||
| -rw-r--r-- | doc/pddp/get-help.pd | 18 | ||||
| -rw-r--r-- | doc/pddp/getsize-help.pd | 7 | ||||
| -rw-r--r-- | doc/pddp/plot-help.pd | 37 | ||||
| -rw-r--r-- | doc/pddp/struct-help.pd | 33 |
8 files changed, 136 insertions, 114 deletions
diff --git a/doc/pddp/append-help.pd b/doc/pddp/append-help.pd index 4928908c..d70480f1 100644 --- a/doc/pddp/append-help.pd +++ b/doc/pddp/append-help.pd @@ -5,7 +5,7 @@ -204280 -1 0; #X obj 0 226 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 -228856 -1 0; -#N canvas 53 247 494 344 META 0; +#N canvas 56 334 494 344 META 0; #X text 12 145 LIBRARY internal; #X text 12 185 WEBSITE http://crca.ucsd.edu/~msp/; #X text 12 25 LICENSE SIBSD; @@ -14,12 +14,12 @@ Wilkes revised the patch to conform to the PDDP template for Pd version 0.42.; #X text 12 5 KEYWORDS control data_structure; -#X text 12 45 DESCRIPTION add item to a list; #X text 12 105 INLET_R pointer; #X text 12 125 OUTLET_0 pointer; #X text 12 65 INLET_0 float list; #X text 12 85 INLET_N float; #X text 12 205 RELEASE_DATE 1997; +#X text 12 45 DESCRIPTION add a scalar to a canvas; #X restore 500 597 pd META; #X obj 0 392 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 13 -228856 -1 0; @@ -48,27 +48,26 @@ Wilkes revised the patch to conform to the PDDP template for Pd version #X obj 484 3 append; #X obj 455 20 pddp/pddplink http://wiki.puredata.info/en/append -text pdpedia: append; -#N canvas 114 104 428 109 help-append-template1 0; +#N canvas 116 162 428 109 help-append-template1 0; #X obj 22 69 filledpolygon z z 0 0 0 20 0 20 30 0 30; #X obj 22 42 struct help-append-template1 float x float y float z; #X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 7 1 [append] Template for "help-append-template1"; #X restore 372 196 pd help-append-template1; -#N canvas 98 282 428 207 help-append-data 0; +#N canvas 554 168 428 207 help-append-data 0; #X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 7 1 [append] Data Window; #X restore 372 174 pd help-append-data; -#X obj 261 104 pointer; -#X msg 261 80 traverse pd-help-append-data \, bang; -#X obj 60 152 append help-append-template1 x y z; -#X floatatom 60 95 5 20 400 0 - - -; -#X obj 60 115 t f f; +#X obj 281 104 pointer; +#X msg 281 80 traverse pd-help-append-data \, bang; +#X obj 80 152 append help-append-template1 x y z; +#X floatatom 80 95 5 26 400 0 - - -; +#X obj 80 115 t f f; #X msg 372 138 \; pd-help-append-data clear; #X text 98 234 float; #X text 98 264 list; -#X msg 18 95 5 6 7; #X obj 78 401 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; #X text 98 401 pointer; @@ -77,7 +76,6 @@ pdpedia: append; #X text 98 360 pointer; #X text 98 531 You may append objects of different templates using different [append] objects.; -#X text 11 23 add item to a list; #X text 168 360 - the final inlet takes a pointer to a scalar (or to the head of a list).; #X text 168 234 - a float to the left inlet initializes the field(s) @@ -93,7 +91,7 @@ be stored for later use.; \, it outputs a pointer to the new scalar that has been created.; #X text 15 74 2) ...then here; #X text 224 174 3) result is in here ->; -#X text 259 56 1) go to (and output) "head" of the list; +#X text 279 56 1) go to (and output) "head" of the list; #X text 168 482 - all subsequent arguments are names of fields to initialize. At least one field must be specified in order to append a new scalar. ; @@ -101,15 +99,18 @@ At least one field must be specified in order to append a new scalar. #X text 80 482 n) symbol atom; #X text 168 455 - a [struct] name that specifies the template of a new scalar to append.; -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 98 572 pddp/pddplink ../4.data.structures/04.append.pd -text doc/4.data.structures/04.append.pd; #X obj 98 557 pddp/pddplink all_about_z_order.pd; #X obj 325 557 pddp/pddplink scalar-help.pd; +#X text 11 23 add a scalar to a canvas; +#X msg 18 95 10 75 2; #X connect 15 0 17 3; #X connect 16 0 15 0; #X connect 18 0 19 0; #X connect 19 0 17 0; #X connect 19 1 17 1; #X connect 19 1 17 2; -#X connect 23 0 17 0; +#X connect 45 0 17 0; diff --git a/doc/pddp/drawpolygon-help.pd b/doc/pddp/drawpolygon-help.pd index 5938cd27..2cb8c112 100644 --- a/doc/pddp/drawpolygon-help.pd +++ b/doc/pddp/drawpolygon-help.pd @@ -5,7 +5,7 @@ dog float cat float vis; 14 -228856 -66577 0; #X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header drawpolygon 3 12 0 18 -204280 -1 0; -#X obj 0 152 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +#X obj 0 147 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 -228856 -1 0; #N canvas 50 246 494 344 META 0; #X text 12 85 LIBRARY internal; @@ -23,13 +23,13 @@ for Pd version 0.42.; ; #X text 12 65 INLET_0 float; #X restore 500 597 pd META; -#X obj 0 227 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +#X obj 0 222 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 13 -228856 -1 0; -#X obj 0 255 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +#X obj 0 250 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 0 13 -228856 -1 0; #X obj 0 516 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 0 13 -228856 -1 0; -#N canvas 102 422 428 169 Related_objects 0; +#N canvas 71 454 428 156 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 obj 92 42 struct; @@ -46,18 +46,18 @@ for Pd version 0.42.; #X obj 22 112 pointer; #X text 7 1 [drawpolygon] Related Objects; #X restore 101 597 pd Related_objects; -#X obj 78 161 cnv 17 3 55 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +#X obj 78 156 cnv 17 3 55 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 -162280 0; -#X text 99 162 float; -#X text 168 159 - [drawnumber] has a single inlet to toggle visibility +#X text 99 157 float; +#X text 168 154 - [drawnumber] has a single inlet to toggle visibility of the number. A zero makes it invisible. Any nonzero value makes it visible.; -#X text 98 231 (none); +#X text 98 226 (none); #X text 179 80 <- subpatch to display the data structures; #X obj 449 3 drawpolygon; #X obj 420 20 pddp/pddplink http://wiki.puredata.info/en/drawpolygon -text pdpedia: drawpolygon; -#N canvas 31 185 428 280 drawpolygon-help-data 0; +#N canvas 23 258 428 340 drawpolygon-help-data 0; #X scalar drawpolygon-help-template 101 41 0 60 100 1 \;; #X scalar drawpolygon-help-template 301 44 1 80 100 1 \;; #X obj 1 1 cnv 15 425 20 empty empty empty 20 12 2 14 -204280 -195568 @@ -70,67 +70,68 @@ and "cat" are the top left and right x-values for the red "v".; #X text 21 111 Each scalar consists of a set of numbers \, one triangle \, and one red "v". In editmode you can click on a polygon to get a blue bounding box around the scalar.; -#X text 21 216 In runmode you can click on each of these regions of +#X text 21 226 In runmode you can click on each of these regions of the polygons to alter their appearance. You may also scroll the displayed values with the mouse to change them.; +#X text 21 276 Additionally \, you can right-click a scalar and select +"Properties" and edit the data in the text window that pops up.; #X restore 28 82 pd drawpolygon-help-data; -#N canvas 116 47 428 563 drawpolygon-help-template 0; -#X obj 23 66 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1 +#N canvas 102 75 428 563 drawpolygon-help-template 0; +#X obj 23 115 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1 ; -#N canvas 478 354 428 162 init 0; -#X obj 20 99 pointer; -#X obj 20 126 outlet; +#N canvas 69 268 428 162 init 0; +#X obj 20 75 pointer; +#X obj 20 99 outlet; #X obj 20 30 loadbang; -#X obj 20 51 t b b; -#X msg 20 77 traverse pd-drawpolygon-help-data \, next; +#X msg 20 53 traverse pd-drawpolygon-help-data \, next; #X obj 0 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 6 1 [drawpolygon] Initialization subpatch; +#X text 81 80 This just locates the first scalar in the subpatch "drawpolygon-help-data" +and outputs a pointer to it.; #X connect 0 0 1 0; #X connect 2 0 3 0; -#X connect 3 0 4 0; -#X connect 4 0 0 0; -#X restore 217 244 pd init; -#X obj 22 224 tgl 15 0 empty empty empty 17 7 0 10 -262144 -1 -1 0 +#X connect 3 0 0 0; +#X restore 217 316 pd init; +#X obj 22 298 tgl 15 0 empty empty empty 17 7 0 10 -262144 -1 -1 0 1; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; -#X text 19 400 This object defines the fields for this template. Their -values are initialized in the "init" subwindow. You can see them by -right-clicking on the object in the "data" window and selecting "properties." -; #X text 7 1 [drawpolygon] subpatch; -#X obj 23 95 drawpolygon 0 4 0 40 40 40 20 weasel 0 40; -#X obj 22 367 struct drawpolygon-help-template float x float y float +#X obj 23 141 drawpolygon 0 4 0 40 40 40 20 weasel 0 40; +#X obj 22 27 struct drawpolygon-help-template float x float y float weasel float dog float cat float vis; -#X text 42 65 "0" in inlet makes all instances of this polygon invisible +#X text 42 114 "0" in inlet makes all instances of this polygon invisible ; -#X text 40 221 "0" in inlet makes a single instance of this polygon +#X text 40 295 "0" in inlet makes a single instance of this polygon invisible; -#X obj 22 268 set drawpolygon-help-template vis; -#X text 20 33 [drawpolygon] is used below to display a black triangle -and a red "v".; -#X obj 23 497 drawnumber weasel -60 0 0 weasel=; -#X obj 23 517 drawnumber dog -60 15 0 dog=; -#X obj 23 538 drawnumber cat -60 30 0 cat=; -#X obj 23 135 drawpolygon -v vis 900 3 dog weasel 80 40 cat weasel -; -#X text 19 453 For convenience \, the following [drawnumber] objects -display the values of each field used in the drawing instructions above: +#X obj 22 340 set drawpolygon-help-template vis; +#X obj 23 491 drawnumber weasel -60 0 0 weasel=; +#X obj 23 511 drawnumber dog -60 15 0 dog=; +#X obj 23 532 drawnumber cat -60 30 0 cat=; +#X obj 23 199 drawpolygon -v vis 900 3 dog weasel 80 40 cat weasel ; -#X text 19 154 The next [drawpolygon] object uses the -v flag. This +#X text 19 218 The next [drawpolygon] object uses the -v flag. This flag controls visilibility of the polygon for only one instance of a data structure. "-v vis" means that the value of field "vis" determines whether the red "v" polygon is visible or not.; -#X text 19 287 Using the [set] object \, we can turn visibility on +#X text 19 360 Using the [set] object \, we can turn visibility on and off for an instance of this polygon by changing the value of the field "vis". Notice when you click the toggle above \, visibility only changes for the red "v" furthest to the right. Once you use the -v flag \, however \, you can no longer use the inlet to [drawpolygon] to set visibility globally.; -#X connect 0 0 6 0; -#X connect 1 0 10 1; -#X connect 2 0 10 0; +#X text 19 447 Finally \, for convenience \, the following [drawnumber] +objects display the values of each field used in the drawing instructions +above:; +#X text 20 159 [drawpolygon] is used above to display a black triangle +and a red "v".; +#X text 19 60 The [struct] object defines the fields for this template. +You can see and edit the values by right-clicking the scalar in the +"data" subpatch and selecting "Properties."; +#X connect 0 0 5 0; +#X connect 1 0 9 1; +#X connect 2 0 9 0; #X restore 28 109 pd drawpolygon-help-template; #X text 98 471 Note: you cannot use the -n and -v flag together. When using the -v flag \, the polygon is initially invisible by default. @@ -141,29 +142,32 @@ shape.; #X text 201 109 <- click this subpatch to see how [drawpolygon] is used.; #X text 11 23 display a polygon in a data structure instance; -#X text 168 200 - a list will be truncated to the first element.; +#X text 168 195 - a list will be truncated to the first element.; #X text 168 363 - RGB color (0=black \, 999=white \, 900=red \, 90=green \, 9=blue \, 555=grey \, etc.); #X text 168 390 - line width.; #X text 168 414 - two or more (x \, y) pairs giving coordinates.; -#X text 80 275 0-3 flags; -#X text 168 275 - "-n" flag to make the polygon initially invisible. +#X text 168 270 - "-n" flag to make the polygon initially invisible. ; -#X text 168 294 - a "-v [variable]" flag to assign a variable to make +#X text 168 289 - a "-v [variable]" flag to assign a variable to make the polygon visible/invisible.; -#X text 168 323 - "-x" flag to inhibit selecting the object when the -shape is clicked on in "edit" mode.; #X text 80 390 2) *; #X text 80 364 1) *; #X text 80 414 n) *; #X text 98 442 * Any of these can be numbers (float) or field names (symbol atom).; -#X text 98 200 list; -#X text 80 294 (symbol atoms); -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X text 98 195 list; +#X text 80 309 (symbol atoms); +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 316 557 pddp/pddplink ../4.data.structures/09.scaling.pd -text doc/4.data.structure/09.scaling.pd; #X obj 316 572 pddp/pddplink ../4.data.structures/10.onoff.pd -text doc/4.data.structures/10.onoff.pd; #X obj 99 572 pddp/pddplink all_about_z_order.pd; #X obj 99 557 pddp/pddplink scalar-help.pd; +#X text 80 270 0-3 flags; +#X text 80 290 (optional); +#X text 168 318 - "-x" flag to inhibit selecting the object when the +shape is clicked on in "edit" mode or clicked-and-dragged in "run mode". +; diff --git a/doc/pddp/drawsymbol-help.pd b/doc/pddp/drawsymbol-help.pd index 1d2236fd..83ed00dd 100644 --- a/doc/pddp/drawsymbol-help.pd +++ b/doc/pddp/drawsymbol-help.pd @@ -25,7 +25,7 @@ Wilkes revised the patch to conform to the PDDP template for Pd version 13 -228856 -1 0; #X obj 0 216 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 0 13 -228856 -1 0; -#X obj 0 445 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +#X obj 0 440 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 0 13 -228856 -1 0; #N canvas 55 423 428 169 Related_objects 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 @@ -53,7 +53,7 @@ Wilkes revised the patch to conform to the PDDP template for Pd version #X obj 458 3 drawsymbol; #X obj 430 20 pddp/pddplink http://wiki.puredata.info/en/drawsymbol -text pdpedia: drawsymbol; -#X text 98 449 Keyboard entry is not yet supported for drawsymbol. +#X text 98 444 Keyboard entry is not yet supported for drawsymbol. ; #N canvas 32 180 428 164 drawsymbol-help-data 0; #X scalar drawsymbol-help-template 101 61 whiskers rex 1 \;; @@ -119,7 +119,7 @@ to.; #X text 201 84 <- click this subpatch to see how [drawsymbol] is used. ; #X text 11 23 display a symbolic field of a template; -#X text 98 465 Note: Attempting to scroll a symbol like a number will +#X text 98 460 Note: Attempting to scroll a symbol like a number will output the following message to the console (for each pixel scrolled!): drawnumber_motion: symbol; #X text 98 503 Unfortunately \, [append] does not accept symbols. Currently @@ -127,7 +127,7 @@ drawnumber_motion: symbol; like those shown in the "drawsymbol-help-template" subpatch above. ; #X text 168 161 - a list will be truncated to the first element.; -#X text 98 425 Note: you cannot use both the -n and -v flag.; +#X text 98 420 Note: you cannot use both the -n and -v flag.; #X text 80 236 0-2 flags; #X text 168 341 - RGB color (0=black \, 999=white \, 900=red \, 90=green \, 9=blue \, 555=grey \, etc.).; @@ -148,7 +148,7 @@ visible.; #X text 79 253 (symbol atoms); #X text 80 292 1) symbol atom; #X text 80 369 5) symbol atom; -#X text 98 393 * Any of these can be numbers (float) or field names +#X text 98 388 * Any of these can be numbers (float) or field names (symbol atom).; #X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide ; diff --git a/doc/pddp/element-help.pd b/doc/pddp/element-help.pd index 61e194e0..dda82ecd 100644 --- a/doc/pddp/element-help.pd +++ b/doc/pddp/element-help.pd @@ -115,7 +115,6 @@ the nearest endpoint.; -1 -1 0; #X text 155 93 index (0-8); #X floatatom 81 135 5 0 0 0 - - -; -#X text 299 63 Click here first; #X text 11 23 get pointer to an element of an array; #X text 168 527 - field name. The field name must be an array.; #X text 168 398 - a list will be truncated to the first element.; @@ -124,9 +123,12 @@ the nearest endpoint.; scalar.; #X text 80 512 1) symbol atom; #X text 80 527 2) symbol atom; -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 98 557 pddp/pddplink all_about_arrays.pd; #X obj 98 572 pddp/pddplink scalar-help.pd; +#X text 125 75 2 ... then here; +#X text 299 63 1 Click here first...; #X connect 23 0 28 1; #X connect 27 0 23 0; #X connect 28 0 29 0; diff --git a/doc/pddp/get-help.pd b/doc/pddp/get-help.pd index a59f8ee7..3c2206e2 100644 --- a/doc/pddp/get-help.pd +++ b/doc/pddp/get-help.pd @@ -65,7 +65,7 @@ pdpedia: get; #X text 166 183 bang when there are no more items; #X text 11 23 get values from a scalar; #X text 221 283 <- Click here to see the data; -#N canvas 103 43 428 248 get-help-data 0; +#N canvas 111 75 428 272 get-help-data 0; #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 [get] Data Window; @@ -73,25 +73,26 @@ pdpedia: get; #X scalar get-help-template 79 87 jo_napot_kivanok \;; #X text 62 42 Each blue rectangle is a scalar. Their appearance and data structure are defined by the template "get-help-template".; -#X text 27 124 The values of the fields "x" and "y" specify the screen -coordinates for the top left corner of each rectangle. In editmode -you can click and drag each rectangle to change these values.; -#X text 27 177 In addition to using the [get] object \, you can right-click +#X text 27 187 In addition to using the [get] object \, you can right-click on a rectangle and choose "Properties" to view the field values of the scalar. (You can also change them-- once you are finished \, click "Ok" to update the values.); +#X text 27 124 The "x" and "y" fields in a [struct] are special: they +always specify the screen coordinates for the top left corner of each +rectangle. In editmode you can click and drag each rectangle to change +these values.; #X restore 106 283 pd get-help-data; #X msg 106 116 traverse pd-get-help-data \, next; #X obj 106 208 get get-help-template x y s; -#N canvas 111 383 428 175 get-help-template 0; +#N canvas 105 219 428 175 get-help-template 0; #X obj 23 118 filledpolygon 9 0 1 0 0 20 0 20 30 0 30; #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 [get] Template subpatch; #X text 19 69 This [struct] just defines a simple data structure. The values for the fields were set when this help patch was created.; -#X text 21 137 (Draw a blue rectangle); #X obj 21 42 struct get-help-template float x float y symbol s; +#X text 21 137 Draw a blue rectangle with a black border.; #X restore 106 305 pd get-help-template; #X text 168 383 - one outlet is created for each field specified in the creation arguments. When [get] receives a pointer at its inlet @@ -109,7 +110,8 @@ before sending to [get]. (See pointer-help.pd for more information.) ; #X text 80 457 1) symbol atom; #X text 80 472 n) symbol atom; -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 97 563 pddp/pddplink ../04.data.structures/02.getting.data.pd -text doc/04.data.structures/02.getting.data.pd; #X obj 97 578 pddp/pddplink scalar-help.pd; diff --git a/doc/pddp/getsize-help.pd b/doc/pddp/getsize-help.pd index c29f4ced..48796410 100644 --- a/doc/pddp/getsize-help.pd +++ b/doc/pddp/getsize-help.pd @@ -52,7 +52,7 @@ pdpedia: getsize; #X obj 78 140 pointer; #X floatatom 78 200 5 0 0 0 - - -; #X obj 78 171 getsize help-getsize-template array1; -#N canvas 82 384 428 146 help-getsize-template 0; +#N canvas 75 373 428 146 help-getsize-template 0; #X obj 21 82 plot array1 500 1 10 15 20; #X obj 21 109 filledpolygon 509 509 0 -10 -10 10 -10 10 10 -10 10; #X obj 21 42 struct help-getsize-template float x float y array array1 @@ -61,7 +61,7 @@ help-getsize-array1-template; 14 -204280 -1 0; #X text 7 1 [getsize] Data Structure; #X restore 78 233 pd help-getsize-template; -#N canvas 83 405 428 138 help-getsize-array1-template 0; +#N canvas 78 372 428 138 help-getsize-array1-template 0; #X obj 21 69 filledpolygon 0 0 0 -5 0 0 5 5 0 0 -5; #X obj 21 42 struct help-getsize-array1-template float y; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 @@ -85,7 +85,8 @@ array.; #X text 119 200 here we just get the size of the array "array1".; #X text 168 519 - the name of a field within that template. (The field must be an array.); -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 98 557 pddp/pddplink all_about_arrays.pd; #X obj 98 572 pddp/pddplink scalar-help.pd; #X scalar help-getsize-template 349 282 \; 8 \; 14 \; -5 \; 10 \; 21 diff --git a/doc/pddp/plot-help.pd b/doc/pddp/plot-help.pd index 91d62507..15667312 100644 --- a/doc/pddp/plot-help.pd +++ b/doc/pddp/plot-help.pd @@ -54,7 +54,7 @@ Wilkes revised the patch to conform to the PDDP template for Pd version #X obj 491 3 plot; #X obj 465 20 pddp/pddplink http://wiki.puredata.info/en/plot -text pdpedia: plot; -#N canvas 119 152 428 287 plot-help-data 0; +#N canvas 92 134 428 403 plot-help-data 0; #X scalar plot-help-template 32 98 \; 2 \; -32 \; 12 \; -54 \; -9 \; \; 0 0 \; 7 14 \; 27 -10 \; 0 -30 \; -40 0 \; 0 50 \; 60 0 \; \; 11 7 \; 20 5 \; 22 14 \; -20 5 \; 20 11 \; -11 8 \; -17 16 \; \;; @@ -64,17 +64,23 @@ pdpedia: plot; contains three arrays \, each of which has an associated [plot] object that determines how they will be displayed.; #X text 7 1 [plot] Window to Display Data Structures; -#X text 19 248 To see the data itself \, select "properties" for the -scalar by right clicking on the purple square.; +#X text 19 256 You can click and drag control points that correspond +to the elements of an array.; +#X text 19 286 If the [struct] that defines the array elements has +a "y" field but no "x" field \, then you can click on one control point +\, then drag horizontally to change multiple elements in one swipe +(as you can with the "Put" menu array).; +#X text 19 345 To see/edit the data itself \, select "properties" for +the scalar by right clicking on the purple square.; #X restore 371 58 pd plot-help-data; -#N canvas 110 167 428 402 plot-help-template 0; +#N canvas 96 163 428 436 plot-help-template 0; #X obj 22 42 plot array1 500 1 10 15 20; #X text 19 67 This first example plots the red trace (500) \, width 1 \, at point (10 \, 15) \, with horizontal spacing 20 The black diamonds come from the template of the array1 element itself.; #X text 19 228 If a "w" variable is present in the template as for array3 \, it is added to the line width.; -#X obj 21 365 filledpolygon 509 509 0 -10 -10 10 -10 10 10 -10 10; +#X obj 21 374 filledpolygon 509 509 0 -10 -10 10 -10 10 10 -10 10; #X obj 22 292 struct plot-help-template float x float y array array1 plot-help-array1-template array array2 plot-help-array2-template array array3 plot-help-array3-template; @@ -88,13 +94,15 @@ array3 plot-help-array3-template; location (100 \, 0). Since the template for array2 contains an "x" variable \, play ignores x spacing requests and takes x from the data itself.; +#X text 18 397 Purple square to mark the left upper corner of the scalar +; #X restore 371 81 pd plot-help-template; -#N canvas 18 119 428 228 plot-help-array1-template 0; +#N canvas 25 161 428 241 plot-help-array1-template 0; #X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 7 1 [plot] Element of "array1" in "plot-help-template"; -#X obj 24 188 filledpolygon 0 0 0 -5 0 0 5 5 0 0 -5; -#X obj 23 158 struct plot-help-array1-template float y; +#X obj 24 198 filledpolygon 0 0 0 -5 0 0 5 5 0 0 -5; +#X obj 23 168 struct plot-help-array1-template float y; #X text 20 38 The following data structure is defined as an element of "array1" in the data structure "plot-help-template". It defines one "y" field \, which is a reserved field that controls the y-value @@ -104,11 +112,11 @@ click on one of the elements (i.e. \, the small black squares defined by [filledpolygon]) and drag horizontally to change the y-value for other elements as well.; #X restore 12 51 pd plot-help-array1-template; -#N canvas 17 141 428 146 plot-help-array2-template 0; +#N canvas 18 155 428 183 plot-help-array2-template 0; #X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 7 1 [plot] Element of "array2" in "plot-help-template"; -#X obj 22 114 struct plot-help-array2-template float x float y; +#X obj 22 134 struct plot-help-array2-template float x float y; #X text 20 36 This data structure is defined as an element for "array2" in "plot-help-template". No drawing instructions are associated with this [struct]. The only graphic visible in the "plot-help-data" subwindow @@ -116,11 +124,11 @@ is the trace itself. The thickness and color of the line are defined solely using the 2nd [plot] object in the "plot-help-template" subwindow. ; #X restore 12 73 pd plot-help-array2-template; -#N canvas 17 164 428 235 plot-help-array3-template 0; +#N canvas 19 222 428 285 plot-help-array3-template 0; #X obj 0 0 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 7 1 [plot] Element of "array3" in "plot-help-template"; -#X obj 22 193 struct plot-help-array3-template float y float w; +#X obj 22 223 struct plot-help-array3-template float y float w; #X text 19 36 This data structure is defined as the element for "array3" in "plot-help-template". Since the reserved "w" field is defined here \, you can adjust the width of the line at each element (the mouse @@ -129,7 +137,7 @@ that allows you to change the width). The graphical result is the wavy blue line in the "plot-help-data" window. For both width and y-value \, you can click an element and drag horizontally to select and adjust other elements.; -#X text 19 144 For both width and y-value \, you can click an element +#X text 19 174 For both width and y-value \, you can click an element and drag horizontally to select and adjust other elements.; #X restore 12 94 pd plot-help-array3-template; #X text 202 82 explanation is in here-->; @@ -169,7 +177,8 @@ of scalars along the path of the plot.; #X text 168 376 - word "curve" to specify bezier.; #X text 80 397 1) symbol atom; #X text 79 263 (symbols atoms); -#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide; +#X obj 4 597 pddp/pddplink all_about_help_patches.pd -text Usage Guide +; #X obj 98 545 pddp/pddplink all_about_arrays.pd; #X obj 98 575 pddp/pddplink ../4.data.structures/05.array.pd -text doc/4.data.structures/05.array.pd; diff --git a/doc/pddp/struct-help.pd b/doc/pddp/struct-help.pd index 8c6c60d0..463a80ca 100644 --- a/doc/pddp/struct-help.pd +++ b/doc/pddp/struct-help.pd @@ -121,30 +121,22 @@ the patch below:; data will be visualized. Two data structures- "struct-1" and "struct-2"- are defined below in subpatches:; #X text 169 393 - the name of the struct; -#N canvas 81 487 429 105 struct_names 0; +#N canvas 72 401 429 220 struct_names 0; #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 14 -204280 -1 0; #X text 8 2 [struct] Struct Names; -#X text 20 39 You can't use "float" as a struct name because Pd has -a hidden data structure named "float" used for [table] and "Put menu -arrays".; +#X text 20 39 You can't use "float" or "_float_array" as struct names +because Pd has hidden data structures named "float" and "_float_array" +\, which are used for [table] and "Put menu arrays".; +#X msg 23 134 \; pd-_float vis 1 \; pd-_float_array vis 1; +#X text 20 99 You can click below to reveal the canvases that contain +them:; #X restore 102 541 pd struct_names; -#X text 172 295 - clicking the object with the mouse in run mode.; -#X text 172 310 - changing the value of a field in run mode.; -#X text 172 325 - selecting the object in edit mode.; -#X text 172 340 - deselecting an object in edit mode.; -#X text 172 355 - moving a selected object in edit mode.; #X text 188 461 - "float foo"; #X text 188 476 - "symbol foo"; #X text 188 491 - "array foo bar" \, where "bar" is the name of another data structure to be used as a template for elements of the array. ; -#X text 99 217 When a scalar is moved or edited with the mouse \, data -is sent to the outlet of the respective [struct] object. This data -consists of: a selector that describes the mouse action that was performed -\, a pointer to the scalar \, and-- optionally-- a number (usually -an x-coordinate). The selectors below correspond to the following mouse -actions:; #X text 169 411 - all subsequent arguments are used to declare fields. Fields may be one of three types-- float \, symbol \, or array. To create the field "foo" \, use the syntax below for each type:; @@ -158,3 +150,14 @@ create the field "foo" \, use the syntax below for each type:; doc/4.data.structures/06.file.pd; #X obj 257 576 pddp/pddplink ../4.data.structures/08.selection.pd -text doc/4.data.structures/08.selection.pd; +#X text 99 217 When a scalar is moved or edited with the mouse \, data +is sent to the outlet of the respective [struct] object. This data +consists of: a selector that describes the mouse action that was performed +\, a pointer to the scalar \, and-- optionally-- a number (usually +a y-coordinate). The selectors below correspond to the following mouse +actions:; +#X text 172 295 - (run mode) clicking the object with the mouse.; +#X text 172 310 - (run mode) changing the value of a field.; +#X text 172 325 - (edit mode) selecting the object.; +#X text 172 340 - (edit mode) deselecting an object.; +#X text 172 355 - (edit mode) moving a selected object.; |