diff options
Diffstat (limited to 'doc/pddp')
| -rw-r--r-- | doc/pddp/TODO | 3 | ||||
| -rw-r--r-- | doc/pddp/int-help.pd | 173 | ||||
| -rw-r--r-- | doc/pddp/pddp_dsp-help.pd | 23 | ||||
| -rw-r--r-- | doc/pddp/pddp_dsp.pd | 30 | ||||
| -rw-r--r-- | doc/pddp/pddp_print.pd | 11 | ||||
| -rw-r--r-- | doc/pddp/pddp_print_long.pd | 11 | ||||
| -rw-r--r-- | doc/pddp/standard_gui_elements.pd | 17 |
7 files changed, 178 insertions, 90 deletions
diff --git a/doc/pddp/TODO b/doc/pddp/TODO index 225de73a..5b42a561 100644 --- a/doc/pddp/TODO +++ b/doc/pddp/TODO @@ -1,4 +1,7 @@ +- create message-help.pd, namecanvas-help.pd and all_about_messages which + include [namecanvas] and the additional/pd-msg docs + - update route-help.pd to discuss the three modes of [route]: float mode, symbol mode, and data type mode. diff --git a/doc/pddp/int-help.pd b/doc/pddp/int-help.pd index 4d9ec1a8..17b1d9c9 100644 --- a/doc/pddp/int-help.pd +++ b/doc/pddp/int-help.pd @@ -1,83 +1,90 @@ -#N canvas 9 19 907 630 10;
-#X msg 33 230 bang;
-#X floatatom 23 313 0 0 0;
-#X floatatom 23 208 0 0 0;
-#X floatatom 47 255 0 0 0;
-#X text 71 230 You can force the object to output the stored number.
-;
-#X text 68 208 You can set and output the value simoultaneously.;
-#X text 105 255 You can store the number \, without outputting it.
-;
-#X text 488 142 NOTE;
-#X obj 450 8 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
--1;
-#X obj 450 547 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
--1;
-#X text 284 568 This document was updated for Pd version 0.35 test
-24 by Dave Sabine as part of a project called pddp proposed by Krzysztof
-Czaja to build comprehensive documentation for Pd.;
-#X text 482 480 RELATED OBJECTS;
-#X obj 529 507 symbol;
-#X text 97 11 - STORE AN INTEGER;
-#X obj 55 12 int;
-#X text 19 41 The int object stores an integer (which is set either
-by its creation argument or by the right inlet) and then outputs that
-number when it receives a "bang" message or a new number in its left
-inlet.;
-#X text 18 98 This object acts exactly as its nearest cousin:;
-#X obj 307 97 float;
-#X text 495 159 All numbers in Pd are kept in 32-bit floating point
-and can represent real numbers between -8 \, 388 \, 608 and 8 \, 388
-\, 608 Hence \, the [int] object takes about as much CPU as the [float]
-object \; but is useful when numbers need to be truncated and/or when
-patches are being designed to be compatible with Pd and MAX/MSP.;
-#X text 18 160 Tip: Press and hold SHIFT while click-n-dragging these
-number boxes to see how the [int] object truncates the number - drops
-decimal places.;
-#X obj 23 287 int 6.5;
-#X text 17 114 with only one exception: All decimal places are dropped!
-All fractions will be truncated \; they will not be 'rounded off'.
-;
-#X obj 491 507 float;
-#X obj 573 506 random;
-#X text 487 10 WHAT IS AN INTEGER?;
-#X text 493 29 Integers are "whole" numbers - numbers which do not
-contain fractions. The following are examples of whole numbers:;
-#X text 494 59 1;
-#X text 494 74 -544;
-#X text 494 103 10024;
-#X text 493 88 420;
-#N canvas 0 0 414 279 related_objects_from_other_libraries 0;
-#X obj 22 19 list2int;
-#X obj 77 19 i2l;
-#X obj 104 19 probalizer;
-#X text 20 56 These objects are offered in Pd only if you have downloaded
-and properly installed the appropriate library. These objects may or
-may not exist in a single library.;
-#X text 19 105 The best places to find information about Pd's libraries
-is:;
-#X text 16 127 www.puredata.org and click on "Downloads" then "Software"
-;
-#X text 18 157 iem.kug.ac.at/pdb/;
-#X restore 490 529 pd related_objects_from_other_libraries;
-#X text 496 283 The [int] object can be used as a basis for building
-simple counter mechanisms in Pd. In the example below \, the [int]
-object's stored value is incremented by 1 with each "bang".;
-#X text 87 281 The creation argument initializes the object and stores
-the number until the value is reset. The creation argument is optional.
-If no creation argument is provided \, the object defaults to zero.
-;
-#X msg 511 340 bang;
-#X obj 511 369 int;
-#X obj 539 369 + 1;
-#X floatatom 511 395 5 0 0;
-#X text 486 263 EXAMPLE: BUILDING A COUNTER;
-#X connect 0 0 20 0;
-#X connect 2 0 20 0;
-#X connect 3 0 20 1;
-#X connect 8 0 9 0;
-#X connect 20 0 1 0;
-#X connect 33 0 34 0;
-#X connect 34 0 35 0;
-#X connect 34 0 36 0;
-#X connect 35 0 34 1;
+#N canvas 9 22 906 517 10; +#X msg 23 230 bang; +#X floatatom 13 313 0 0 0 0 - - -; +#X floatatom 13 208 0 0 0 0 - - -; +#X floatatom 56 264 0 0 0 0 - - -; +#X text 61 230 You can force the object to output the stored number. +; +#X text 58 208 You can set and output the value simoultaneously.; +#X text 71 288 You can store the number \, without outputting it.; +#X text 458 142 NOTE; +#X text 10 452 This document was updated for Pd version 0.35 test 24 +by Dave Sabine as part of a project called pddp proposed by Krzysztof +Czaja to build comprehensive documentation for Pd.; +#X text 456 415 RELATED OBJECTS; +#X obj 546 442 symbol; +#X obj 45 12 int; +#X text 9 41 The int object stores an integer (which is set either +by its creation argument or by the right inlet) and then outputs that +number when it receives a "bang" message or a new number in its left +inlet.; +#X text 8 98 This object acts exactly as its nearest cousin:; +#X obj 297 97 float; +#X text 465 159 All numbers in Pd are kept in 32-bit floating point +and can represent real numbers between -8 \, 388 \, 608 and 8 \, 388 +\, 608 Hence \, the [int] object takes about as much CPU as the [float] +object \; but is useful when numbers need to be truncated and/or when +patches are being designed to be compatible with Pd and MAX/MSP.; +#X text 8 160 Tip: Press and hold SHIFT while click-n-dragging these +number boxes to see how the [int] object truncates the number - drops +decimal places.; +#X obj 13 287 int 6.5; +#X text 7 114 with only one exception: All decimal places are dropped! +All fractions will be truncated \; they will not be 'rounded off'. +; +#X obj 465 442 float; +#X obj 603 442 random; +#X text 457 10 WHAT IS AN INTEGER?; +#X text 463 29 Integers are "whole" numbers - numbers which do not +contain fractions. The following are examples of whole numbers:; +#X text 464 59 1; +#X text 464 74 -544; +#X text 464 103 10024; +#X text 463 88 420; +#N canvas 0 22 414 279 related_objects_from_other_libraries 0; +#X obj 22 19 list2int; +#X obj 77 19 i2l; +#X obj 104 19 probalizer 200 200 100 100 1 0 10 1 10 2 10 3 10 4 10 +5 10 6 10 7 10 8 10 9 10 10 10 11 10 12 10 13 10 14 10 15 10 16 10 +17 10 18 10 19 10 20 10 21 10 22 10 23 10 24 10 25 10 26 10 27 10 28 +10 29 10 30 10 31 10 32 10 33 10 34 10 35 10 36 10 37 10 38 10 39 10 +40 10 41 10 42 10 43 10 44 10 45 10 46 10 47 10 48 10 49 10 50 10 51 +10 52 10 53 10 54 10 55 10 56 10 57 10 58 10 59 10 60 10 61 10 62 10 +63 10 64 10 65 10 66 10 67 10 68 10 69 10 70 10 71 10 72 10 73 10 74 +10 75 10 76 10 77 10 78 10 79 10 80 10 81 10 82 10 83 10 84 10 85 10 +86 10 87 10 88 10 89 10 90 10 91 10 92 10 93 10 94 10 95 10 96 10 97 +10 98 10 99 10; +#X text 20 56 These objects are offered in Pd only if you have downloaded +and properly installed the appropriate library. These objects may or +may not exist in a single library.; +#X text 19 105 The best places to find information about Pd's libraries +is:; +#X text 16 127 www.puredata.org and click on "Downloads" then "Software" +; +#X text 18 157 iem.kug.ac.at/pdb/; +#X restore 464 464 pd related_objects_from_other_libraries; +#X text 466 283 The [int] object can be used as a basis for building +simple counter mechanisms in Pd. In the example below \, the [int] +object's stored value is incremented by 1 with each "bang".; +#X text 11 334 The creation argument initializes the object and stores +the number until the value is reset. The creation argument is optional. +If no creation argument is provided \, the object defaults to zero. +; +#X msg 481 340 bang; +#X obj 481 369 int; +#X obj 509 369 + 1; +#X floatatom 481 395 5 0 0 0 - - -; +#X text 456 263 EXAMPLE: BUILDING A COUNTER; +#X obj 244 12 i; +#X obj 436 3 cnv 10 2 500 empty empty empty 20 12 0 14 -166441 -262144 +0; +#X obj 506 442 f; +#X text 87 11 - STORE AN INTEGER -; +#X connect 0 0 17 0; +#X connect 2 0 17 0; +#X connect 3 0 17 1; +#X connect 17 0 1 0; +#X connect 30 0 31 0; +#X connect 31 0 32 0; +#X connect 31 0 33 0; +#X connect 32 0 31 1; diff --git a/doc/pddp/pddp_dsp-help.pd b/doc/pddp/pddp_dsp-help.pd new file mode 100644 index 00000000..34ed7505 --- /dev/null +++ b/doc/pddp/pddp_dsp-help.pd @@ -0,0 +1,23 @@ +#N canvas 682 78 460 426 10; +#X obj 30 212 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1 +; +#X obj 2 2 cnv 15 450 20 empty empty [object_name] 2 11 1 18 -233017 +-66577 0; +#X obj 418 3 pddp; +#X text 16 39 [pddp_dsp] is a GUI object to turn on and off the audio +processing \, aka "DSP". It also shows the status of the DSP \, green +means DSP is on \, grey means DSP is off.; +#X msg 30 236 \; pd dsp \$1; +#X text 18 103 Click in the box to the left in the object to turn on/off +the DSP:; +#X text 16 182 [pddp_dsp] is basically a fancy version of this:; +#X text 23 279 Notice that if you use the the above message \, [pddp_dsp] +still responds to the change in DSP status. [pddp_dsp] also responds +to the keyboard shortcuts.; +#X text 138 343 On Mac OS X: Cmd-. and Cmd-/; +#X text 47 329 On Windows and GNU/Linux: Ctrl-. and Ctrl-/; +#X text 239 397 released under the GNU GPL; +#X text 22 383 (C) Copyright 2005 Hans-Christoph Steiner <hans@at.or.at> +; +#X obj 34 142 pddp_dsp; +#X connect 0 0 4 0; diff --git a/doc/pddp/pddp_dsp.pd b/doc/pddp/pddp_dsp.pd new file mode 100644 index 00000000..89c5f4d1 --- /dev/null +++ b/doc/pddp/pddp_dsp.pd @@ -0,0 +1,30 @@ +#N canvas 358 124 60 18 10; +#X obj 19 1 cnv 16 40 16 empty pddp_dsp_canvas dsp 7 8 0 14 -233017 +-33289 0; +#X obj 0 0 tgl 18 0 empty pddp_dsp empty 1 8 1 9 -233017 -33289 -33289 +0 1; +#X obj 82 146 select 0 1; +#X msg 127 179 76; +#X msg 92 180 10; +#X msg 61 228 \; pddp_dsp color \$1 12 12 \; pddp_dsp_canvas color +\$1 12 12; +#X obj 81 16 r pd; +#X obj 81 37 route dsp; +#X obj 82 75 f; +#X msg 109 100 \; pddp_dsp set \$1; +#X msg 2 82 \; pd dsp \$1; +#X text 239 298 released under the GNU GPL; +#X text 22 284 (C) Copyright 2005 Hans-Christoph Steiner <hans@at.or.at> +; +#X text 154 2 [pddp_dsp]; +#X connect 1 0 8 0; +#X connect 1 0 10 0; +#X connect 2 0 4 0; +#X connect 2 1 3 0; +#X connect 3 0 5 0; +#X connect 4 0 5 0; +#X connect 6 0 7 0; +#X connect 7 0 8 0; +#X connect 8 0 9 0; +#X connect 8 0 2 0; +#X coords 0 0 1 1 60 18 1; diff --git a/doc/pddp/pddp_print.pd b/doc/pddp/pddp_print.pd new file mode 100644 index 00000000..5ffcb9ea --- /dev/null +++ b/doc/pddp/pddp_print.pd @@ -0,0 +1,11 @@ +#N canvas 273 236 140 203 10; +#X obj 0 0 cnv 15 100 20 empty \$0-pddp_print empty 5 11 1 16 -233017 +-33289 0; +#X obj 10 156 s \$0-pddp_print; +#X obj 10 130 prepend label; +#X obj 9 48 inlet; +#X obj 9 78 list2symbol; +#X connect 2 0 1 0; +#X connect 3 0 4 0; +#X connect 4 0 2 0; +#X coords 0 0 1 1 100 20 1; diff --git a/doc/pddp/pddp_print_long.pd b/doc/pddp/pddp_print_long.pd new file mode 100644 index 00000000..78c2cfb8 --- /dev/null +++ b/doc/pddp/pddp_print_long.pd @@ -0,0 +1,11 @@ +#N canvas 273 236 233 186 10; +#X obj 0 0 cnv 15 200 20 empty \$0-pddp_print 61 5 10 1 14 -233017 +-33289 0; +#X obj 62 130 s \$0-pddp_print; +#X obj 62 104 prepend label; +#X obj 62 47 inlet; +#X obj 62 77 list2symbol; +#X connect 2 0 1 0; +#X connect 3 0 4 0; +#X connect 4 0 2 0; +#X coords 0 0 1 1 200 20 1; diff --git a/doc/pddp/standard_gui_elements.pd b/doc/pddp/standard_gui_elements.pd index 6cb5c4d3..5b8298ac 100644 --- a/doc/pddp/standard_gui_elements.pd +++ b/doc/pddp/standard_gui_elements.pd @@ -1,5 +1,4 @@ -#N canvas 218 38 480 568 10; -#X msg 22 188 \; pd dsp \$1; +#N canvas 89 34 488 576 10; #X obj 2 2 cnv 15 450 20 empty empty [object_name] 2 11 1 18 -233017 -66577 0; #X obj 21 133 tgl 30 0 empty empty start 1 15 1 12 -90049 -1 -1 0 1 @@ -7,9 +6,9 @@ #X obj 369 143 vsl 20 128 0 1 0 0 empty empty amp -1 -8 1 12 -225271 -1 -1 0 1; #X obj 194 466 grouping patch; -#X obj 113 268 nbx 5 20 -1e+37 1e+37 0 0 empty empty display_number_box +#X obj 100 241 nbx 5 20 -1e+37 1e+37 0 0 empty empty display_number_box 0 -6 1 16 -199729 -1 -1 0 256; -#X text 17 301 The idea behind these objects is to have a color scheme +#X text 19 337 The idea behind these objects is to have a color scheme which consistently represents various ideas. Also \, having GUI objects highlighted by color signals the user that they should play with that object \, while plain white objects are part of the implementation. @@ -22,17 +21,21 @@ object \, while plain white objects are part of the implementation. #X text 14 37 [object_name] is an example patch for the PDDP style guide.; #X obj 223 132 bng 30 250 50 0 empty empty open 1 15 1 12 -4080 -1 --373; +-228; #X obj 129 133 bng 30 250 50 0 empty empty stop 2 15 1 12 -212999 -1 -1; #X obj 271 196 hsl 60 18 0 1 0 1 empty empty pan 2 9 1 12 -257472 -1 -1 2950 0; #X obj 55 133 bng 30 250 50 0 empty empty start 1 15 1 12 -90049 -1 -1; -#X obj 28 389 comment 400 12 Times ? 0 0 0 0 This is Times 12pt; -#X obj 33 418 comment 400 14 Times ? 0 0 0 0 comment; +#X obj 28 409 comment 400 12 Times ? 0 0 0 0 This is Times 12pt; +#X obj 33 438 comment 400 14 Times ? 0 0 0 0 comment; #X obj 255 132 bng 30 250 50 0 empty empty save 1 15 1 12 -512 -1 -4015 ; #X text 14 65 The colors used should not be the standard "quick pick" colors. PDDP should have distinct colors so that PDDP patches look distinct from regular Pd patches.; +#X obj 466 43 cnv 10 2 500 empty empty empty 20 12 0 14 -166441 -262144 +0; +#X text 332 312 page separator -->; +#X obj 22 184 pddp_dsp; |