First version of files. help-key.pd serves as a reference document for the "key" family of objects: [keyup] [key] and [keyname]. keyboard_fun.txt serves as a data file which is used by help-key.pd.

svn path=/trunk/; revision=945

2 files changed, 454 insertions, 0 deletions

diff --git a/doc/pddp/help-key.pd b/doc/pddp/help-key.pd
new file mode 100644
index 00000000..e84172e0
--- /dev/null
+++ b/doc/pddp/help-key.pd
@@ -0,0 +1,160 @@
+#N canvas 2 1 615 610 12;
+#X obj 107 517 pddp;
+#X obj 8 8 cnv 15 90 553 empty empty empty 20 12 0 14 -233017 -66577
+0;
+#X text 104 74 This object does not accept arguments of any type.;
+#N canvas 85 2 597 608 More_Info 0;
+#X text 31 23 OBJECT OUTLETS;
+#N canvas 176 3 575 461 reacting_to_user_input 0;
+#X text 27 18 REACTING TO USER INPUT;
+#X text 41 49 Most \, if not all \, programming environments provide
+us with tools to capture 'user initiated' events from the operating
+system. Keyboard input \, mouse clicks \, and mouse movements are the
+most common events in this 'user event' category.;
+#X text 41 125 PD's [key] \, [keyup] \, and [keyname] are complimented
+by the externals such as [gemmouse] and [nimouse] to provide us with
+a full range of tools to gleen a user's activities at the computer.
+;
+#X text 42 201 It's interesting to note that \, with these tools \,
+PD can mimic some of the functions in other languages - Javascript
+for example has:;
+#X text 55 272 onKeyUp;
+#X text 55 253 onKeyDown;
+#X text 55 291 onKeyPress;
+#X text 42 322 hmmm...wouldn't it be great if PD also gave us onChange
+\, onBlur \, onFocus \, onClick \, onDblClick \, onDragDrop \, onLoad
+\, onMouseDown \, onMouseOver \, onMouseOut \, onMouseMove \, onUnload...?
+;
+#X restore 47 506 pd reacting_to_user_input;
+#X obj 37 61 key;
+#X obj 16 135 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X floatatom 37 118 5 0 0 0 - - -;
+#X obj 31 268 keyup;
+#X obj 18 323 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X floatatom 39 306 5 0 0 0 - - -;
+#X text 88 208 Also note that key combinations \, such as SHIFT+7 produce
+a different result than SHIFT or 7 alone.;
+#X text 88 323 The [key] and [keyup] objects can mimic the functionality
+of the [noteon] and [noteoff] objects. A key combination such as SHIFT+7
+could be considered a 'chord'!;
+#X text 89 54 The number at this outlet represents the numeric "ID"
+of a key on the computer's keyboard. This event occurs when the key
+is pressed down. Only one event is captured at a time.;
+#X text 88 267 The number at this outlets represents the numeric "ID"
+of a key on the computer's keyboard. This even occurs when the key
+is released. Only one event is captured at a time.;
+#X text 89 119 Some keys \, such as SHIFT or the F1-F12 series all
+produce a zero \, but we can see by the [bng] that the event is not
+ignored completely...but the numeric "ID" of the key is not captured
+successfully. (This may produce different results on different systems.)
+;
+#X obj 21 392 keyname;
+#X obj 21 449 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 70 480 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X symbolatom 76 458 10 0 0 0 - - -;
+#X floatatom 18 421 5 0 0 0 - - -;
+#X text 90 388 This object captures both the "keydown" and "keyup"
+events. The left inlet produces a 1 when a key goes down \, and a zero
+when the key goes up. The right outlet produces a symbol which represents
+the name of the key.;
+#N canvas 174 4 571 511 some_keyboard_fun 0;
+#X obj 52 75 loadbang;
+#X msg 23 16 bang;
+#X obj 33 158 qlist;
+#X floatatom 33 185 5 0 0 0 - - -;
+#X obj 388 30 r keyboard_fun;
+#X msg 52 105 read keyboard_fun.txt;
+#X msg 45 51 rewind;
+#X obj 388 112 symbol add2;
+#X obj 388 83 t b s;
+#X obj 388 138 pack s s;
+#X obj 388 164 route list;
+#X msg 47 245 set;
+#X msg 47 278;
+#X obj 388 57 symbol;
+#X text 71 17 Click here to start...;
+#X msg 62 131 tempo 0.8;
+#X obj 47 217 loadbang;
+#X connect 0 0 5 0;
+#X connect 0 0 15 0;
+#X connect 1 0 2 0;
+#X connect 2 0 3 0;
+#X connect 4 0 13 0;
+#X connect 5 0 2 0;
+#X connect 6 0 2 0;
+#X connect 7 0 9 0;
+#X connect 8 0 7 0;
+#X connect 8 1 9 1;
+#X connect 9 0 10 0;
+#X connect 10 0 12 0;
+#X connect 11 0 12 0;
+#X connect 13 0 8 0;
+#X connect 15 0 2 0;
+#X connect 16 0 11 0;
+#X restore 47 532 pd some_keyboard_fun;
+#X connect 2 0 3 0;
+#X connect 2 0 4 0;
+#X connect 5 0 7 0;
+#X connect 5 0 6 0;
+#X connect 13 0 17 0;
+#X connect 13 1 16 0;
+#X connect 16 0 15 0;
+#X connect 17 0 14 0;
+#X restore 107 491 pd More_Info;
+#N canvas 85 2 393 242 Related_Objects 0;
+#X text 25 8 Native PD Objects;
+#X text 25 92 Externals and other object libraries;
+#X text 36 126 [gemmouse];
+#X text 36 150 [grid];
+#X text 35 173 [nimouse];
+#X restore 107 465 pd Related_Objects;
+#X text 38 53 INLETS:;
+#X text 14 75 ARGUMENTS:;
+#X text 29 94 OUTLETS:;
+#X text 20 170 EXAMPLES:;
+#X text 21 463 SEE ALSO:;
+#X obj 8 8 cnv 15 180 30 empty empty empty 20 12 0 14 -233017 -66577
+0;
+#X obj 28 14 key;
+#X obj 63 14 keyup;
+#X obj 114 14 keyname;
+#X text 195 15 - GRAB KEYBOARD;
+#X text 104 53 None;
+#X text 104 94 Please see the following sub-patch called "More_Info"
+for detailed information about the objects' outlets. The outlets of
+this 'object group' provide PD with information about keystrokes on
+your computer's keyboard.;
+#X obj 108 174 key;
+#X floatatom 108 201 3 0 0 0 - - -;
+#X floatatom 147 200 3 0 0 0 - - -;
+#X obj 147 174 keyup;
+#X floatatom 201 200 3 0 0 0 - - -;
+#X obj 201 174 keyname;
+#X symbolatom 252 199 10 0 0 0 - - -;
+#X text 109 248 To see this example in action \, simply type something
+on your keyboard.;
+#X obj 108 225 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 147 225 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 201 225 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X text 110 291 [key] and [keyup] report the (system dependent) numbers
+of "printing" keys of the keyboard. [keyname] gives the symbolic name
+of the key \, with a 1 if it's up or 0 if it's down \, and works with
+non-printing keys like shift or "F1".;
+#X text 111 362 Caveat -- this only works if Pd actually gets the key
+events which can depend on the stacking order of windows and/or the
+pointer location. This is dependent on the system.;
+#X text 155 518 - Dave Sabine \, July 11 \, 2003;
+#X connect 17 0 18 0;
+#X connect 18 0 25 0;
+#X connect 19 0 26 0;
+#X connect 20 0 19 0;
+#X connect 21 0 27 0;
+#X connect 22 0 21 0;
+#X connect 22 1 23 0;
diff --git a/doc/pddp/keyboard_fun.txt b/doc/pddp/keyboard_fun.txt
new file mode 100644
index 00000000..076768f9
--- /dev/null
+++ b/doc/pddp/keyboard_fun.txt
@@ -0,0 +1,294 @@
+keyboard_fun I;
+193.016 keyboard_fun _;
+245.261 keyboard_fun t;
+34.8299 keyboard_fun y;
+91.4286 keyboard_fun p;
+214.785 keyboard_fun e;
+177.052 keyboard_fun d;
+134.966 keyboard_fun _;
+100.136 keyboard_fun t;
+47.8912 keyboard_fun h;
+172.698 keyboard_fun i;
+47.8912 keyboard_fun s;
+134.966 keyboard_fun _;
+291.701 keyboard_fun m;
+7.25624 keyboard_fun e;
+301.859 keyboard_fun s;
+190.113 keyboard_fun s;
+26.1224 keyboard_fun a;
+133.515 keyboard_fun g;
+74.0136 keyboard_fun e;
+232.2 keyboard_fun _;
+245.22 keyboard_fun i;
+191.565 keyboard_fun n;
+441.179 keyboard_fun _;
+224.943 keyboard_fun J;
+222.041 keyboard_fun u;
+153.832 keyboard_fun l;
+119.002 keyboard_fun y;
+216.236 keyboard_fun .;
+303.311 keyboard_fun _;
+399.093 keyboard_fun Y;
+165.442 keyboard_fun e;
+59.5011 keyboard_fun s;
+245.8299 keyboard_fun ,;
+134.966 keyboard_fun _;
+181.406 keyboard_fun I;
+222.041 keyboard_fun ';
+91.4286 keyboard_fun m;
+224.943 keyboard_fun _;
+326.531 keyboard_fun u;
+13.0612 keyboard_fun p;
+224.943 keyboard_fun _;
+253.968 keyboard_fun l;
+11.61 keyboard_fun a;
+203.175 keyboard_fun t;
+58.0499 keyboard_fun e;
+152.381 keyboard_fun _;
+168.345 keyboard_fun a;
+29.0249 keyboard_fun g;
+229.297 keyboard_fun a;
+62.4036 keyboard_fun i;
+94.5624 keyboard_fun n;
+245.5261 keyboard_fun _;
+75.4649 keyboard_fun p;
+195.918 keyboard_fun l;
+62.4036 keyboard_fun a;
+92.8798 keyboard_fun y;
+44.9887 keyboard_fun i;
+153.832 keyboard_fun n;
+62.4036 keyboard_fun g;
+152.381 keyboard_fun _;
+62.4036 keyboard_fun w;
+95.7823 keyboard_fun i;
+26.1224 keyboard_fun t;
+152.381 keyboard_fun h;
+166.893 keyboard_fun _;
+142.222 keyboard_fun P;
+123.356 keyboard_fun D;
+639.592 keyboard_fun .;
+366.893 keyboard_fun _;
+104.49 keyboard_fun I;
+161.088 keyboard_fun _;
+14.5125 keyboard_fun w;
+200.272 keyboard_fun r;
+242.358 keyboard_fun o;
+60.9524 keyboard_fun t;
+127.71 keyboard_fun e;
+162.54 keyboard_fun _;
+169.796 keyboard_fun t;
+75.4649 keyboard_fun h;
+132.063 keyboard_fun i;
+32.063 keyboard_fun s;
+100.136 keyboard_fun _;
+21.7687 keyboard_fun m;
+137.868 keyboard_fun e;
+261.224 keyboard_fun s;
+20.3175 keyboard_fun s;
+207.528 keyboard_fun a;
+171.247 keyboard_fun g;
+36.2812 keyboard_fun e;
+188.662 keyboard_fun _;
+97.2336 keyboard_fun a;
+46.4399 keyboard_fun n;
+101.587 keyboard_fun d;
+79.8186 keyboard_fun _;
+296.054 keyboard_fun s;
+59.5011 keyboard_fun e;
+198.821 keyboard_fun n;
+110.295 keyboard_fun t;
+79.8186 keyboard_fun _;
+423.764 keyboard_fun k;
+92.8798 keyboard_fun e;
+29.0249 keyboard_fun y;
+79.8186 keyboard_fun _;
+242.358 keyboard_fun s;
+117.551 keyboard_fun t;
+7.25624 keyboard_fun r;
+168.345 keyboard_fun o;
+341.043 keyboard_fun k;
+88.5261 keyboard_fun e;
+319.274 keyboard_fun s;
+208.98 keyboard_fun _;
+36.2812 keyboard_fun t;
+120.454 keyboard_fun o;
+84.1723 keyboard_fun _;
+776.417 keyboard_fun q;
+59.5011 keyboard_fun l;
+168.345 keyboard_fun i;
+47.8912 keyboard_fun s;
+541.315 keyboard_fun t;
+210.431 keyboard_fun _;
+30.4762 keyboard_fun a;
+126.259 keyboard_fun n;
+92.8798 keyboard_fun d;
+79.8186 keyboard_fun _;
+236.553 keyboard_fun n;
+33.3787 keyboard_fun o;
+71.1111 keyboard_fun w;
+79.8186 keyboard_fun _;
+220.59 keyboard_fun P;
+126.259 keyboard_fun D;
+217.687 keyboard_fun _;
+208.98 keyboard_fun i;
+43.5374 keyboard_fun s;
+79.8186 keyboard_fun _;
+84.1723 keyboard_fun r;
+208.98 keyboard_fun e;
+211.882 keyboard_fun -;
+285.896 keyboard_fun w;
+113.197 keyboard_fun r;
+146.576 keyboard_fun i;
+134.966 keyboard_fun t;
+53.6961 keyboard_fun i;
+116.1 keyboard_fun n;
+34.8299 keyboard_fun g;
+137.868 keyboard_fun _;
+39.1837 keyboard_fun t;
+159.637 keyboard_fun h;
+24.6712 keyboard_fun i;
+165.442 keyboard_fun s;
+137.868 keyboard_fun _;
+2.90249 keyboard_fun m;
+265.578 keyboard_fun e;
+294.603 keyboard_fun s;
+410.703 keyboard_fun s;
+47.8912 keyboard_fun a;
+377.324 keyboard_fun g;
+81.2698 keyboard_fun e;
+240.907 keyboard_fun _;
+161.088 keyboard_fun f;
+24.6712 keyboard_fun o;
+95.7823 keyboard_fun r;
+68.2086 keyboard_fun _;
+29.0249 keyboard_fun m;
+203.175 keyboard_fun e;
+88.5261 keyboard_fun _;
+37.7324 keyboard_fun o;
+242.358 keyboard_fun n;
+89.9773 keyboard_fun _;
+214.785 keyboard_fun y;
+39.1837 keyboard_fun o;
+71.1111 keyboard_fun u;
+33.3787 keyboard_fun r;
+142.222 keyboard_fun _;
+39.1837 keyboard_fun c;
+245.261 keyboard_fun o;
+50.7937 keyboard_fun m;
+119.002 keyboard_fun p;
+72.5624 keyboard_fun u;
+195.918 keyboard_fun t;
+55.1474 keyboard_fun e;
+74.0136 keyboard_fun r;
+142.222 keyboard_fun _;
+252.517 keyboard_fun s;
+155.283 keyboard_fun c;
+37.7324 keyboard_fun r;
+206.077 keyboard_fun e;
+219.138 keyboard_fun e;
+132.063 keyboard_fun n;
+137.868 keyboard_fun .;
+559.637 keyboard_fun _;
+588.662 keyboard_fun _;
+530.612 keyboard_fun D;
+56.5986 keyboard_fun o;
+220.59 keyboard_fun n;
+168.345 keyboard_fun ';
+220.59 keyboard_fun  t;
+220.59 keyboard_fun _;
+161.088 keyboard_fun w;
+121.905 keyboard_fun o;
+100.136 keyboard_fun r;
+161.088 keyboard_fun r;
+2.90249 keyboard_fun y;
+119.002 keyboard_fun _;
+34.8299 keyboard_fun i;
+278.639 keyboard_fun t;
+220.59 keyboard_fun ';
+94.3311 keyboard_fun s;
+193.016 keyboard_fun _;
+249.615 keyboard_fun n;
+44.9887 keyboard_fun o;
+104.49 keyboard_fun t;
+113.197 keyboard_fun _;
+2.90249 keyboard_fun a;
+113.197 keyboard_fun _;
+238.005 keyboard_fun l;
+44.9887 keyboard_fun o;
+146.576 keyboard_fun n;
+177.052 keyboard_fun g;
+105.941 keyboard_fun _;
+159.637 keyboard_fun m;
+114.649 keyboard_fun e;
+211.882 keyboard_fun s;
+216.236 keyboard_fun s;
+185.76 keyboard_fun a;
+76.9161 keyboard_fun g;
+17.415 keyboard_fun e;
+294.603 keyboard_fun .;
+528.254 keyboard_fun .;
+827.211 keyboard_fun .;
+24.6712 keyboard_fun i;
+669.025 keyboard_fun t;
+207.528 keyboard_fun ';
+110.295 keyboard_fun s;
+105.941 keyboard_fun _;
+303.311 keyboard_fun a;
+529.705 keyboard_fun l;
+129.161 keyboard_fun m;
+34.8299 keyboard_fun o;
+108.844 keyboard_fun s;
+139.32 keyboard_fun t;
+150.93 keyboard_fun _;
+15.9637 keyboard_fun o;
+140.771 keyboard_fun v;
+63.8549 keyboard_fun e;
+216.236 keyboard_fun r;
+203.175 keyboard_fun .;
+737.234 keyboard_fun _;
+1034.74 keyboard_fun I;
+185.76 keyboard_fun _;
+169.796 keyboard_fun h;
+40.6349 keyboard_fun a;
+101.587 keyboard_fun v;
+60.9524 keyboard_fun e;
+177.052 keyboard_fun _;
+39.1837 keyboard_fun o;
+240.907 keyboard_fun n;
+62.4036 keyboard_fun l;
+179.955 keyboard_fun y;
+84.1723 keyboard_fun _;
+60.9524 keyboard_fun o;
+179.955 keyboard_fun n;
+79.8186 keyboard_fun e;
+84.1723 keyboard_fun _;
+232.2 keyboard_fun m;
+15.9637 keyboard_fun o;
+137.868 keyboard_fun r;
+58.0499 keyboard_fun e;
+84.1723 keyboard_fun _;
+26.1224 keyboard_fun t;
+172.698 keyboard_fun h;
+55.1474 keyboard_fun i;
+174.15 keyboard_fun n;
+97.2336 keyboard_fun g;
+95.7823 keyboard_fun _;
+75.4649 keyboard_fun t;
+229.297 keyboard_fun o;
+95.7823 keyboard_fun _;
+2.90249 keyboard_fun s;
+177.052 keyboard_fun a;
+108.844 keyboard_fun y;
+130.612 keyboard_fun :;
+607.528 keyboard_fun _;
+448.299 keyboard_fun g;
+114.649 keyboard_fun o;
+195.918 keyboard_fun o;
+92.8798 keyboard_fun d;
+507.528 keyboard_fun _;
+262.676 keyboard_fun n;
+245.125 keyboard_fun i;
+229.161 keyboard_fun g;
+207.392 keyboard_fun h;
+262.54 keyboard_fun t;
+233.651 keyboard_fun .;
\ No newline at end of file