From 7d6affca746f49f5ffb2818b8a9ccf9d91388e8f Mon Sep 17 00:00:00 2001 From: Jonathan Wilkes Date: Wed, 25 Aug 2010 00:31:27 +0000 Subject: revised help docs that conform to the PDDP template svn path=/trunk/; revision=13942 --- doc/pddp/gatom-help.pd | 148 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 doc/pddp/gatom-help.pd (limited to 'doc/pddp/gatom-help.pd') diff --git a/doc/pddp/gatom-help.pd b/doc/pddp/gatom-help.pd new file mode 100644 index 00000000..e98d7473 --- /dev/null +++ b/doc/pddp/gatom-help.pd @@ -0,0 +1,148 @@ +#N canvas 0 0 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 gatom 3 12 0 18 +-204280 -1 0; +#X obj 0 248 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 52 247 494 344 META 0; +#X text 12 115 PLATFORM windows macosx gnulinux; +#X text 12 175 LIBRARY internal; +#X text 12 215 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 12 75 LICENSE SIBSD; +#X text 12 195 AUTHOR Miller Puckette; +#X text 12 275 HELP_PATCH_AUTHORS Updated for Pd version 0.34. Jonathan +Wilkes revised the patch to conform to the PDDP template for Pd version +0.42.; +#X text 12 5 GENRE help; +#X text 12 25 NAME gatom; +#X text 12 135 INLET_0 float bang symbol set; +#X text 12 155 OUTLET_0 float; +#X text 12 95 DESCRIPTION atom (number box); +#X text 12 45 KEYWORDS control storage GUI nonlocal symbol_op needs_work +(what about symbol box?); +#X text 12 235 RELEASE_DATE 1997; +#X text 12 255 RELEASE_VERSION; +#X restore 500 597 pd META; +#X obj 0 413 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj 0 456 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#X obj 0 485 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +0 13 -228856 -1 0; +#X text 98 460 (none); +#N canvas 93 480 428 109 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 text 47 1 Related Objects; +#X floatatom 9 3 5 0 0 0 - - -; +#X obj 21 42 float; +#X obj 61 42 list; +#X obj 102 45 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256; +#X obj 169 42 drawnumber; +#X restore 102 597 pd Related_objects; +#X obj 78 257 cnv 17 3 145 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 98 421 float; +#X obj 78 422 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X floatatom 486 3 5 0 0 0 - - -; +#X obj 455 20 pddp/pddplink http://wiki.puredata.info/en/gatom -text +pdpedia: gatom; +#X floatatom 86 73 0 0 0 0 - - -; +#X floatatom 86 111 0 0 0 0 - - -; +#X msg 25 148 set 45; +#X floatatom 25 176 0 0 0 0 - - -; +#X floatatom 25 205 0 0 0 0 - - -; +#X text 132 67 Number boxes allow you to display numbers or to enter +numbers using the mouse and keyboard. When a number arrives at the +number box's inlet \, it is displayed and sent to the outlet. You can +click on a number box and drag upward or downward to change the value +continuously.; +#X text 98 256 bang; +#X text 168 256 - a bang to the inlet of a number box outputs its current +value.; +#X text 98 286 float; +#X text 168 286 - a float sets the current value and outputs it.; +#X text 98 306 list; +#X text 98 326 symbol; +#X text 168 326 - sending a symbol to a number box sets the value to +zero and outputs it.; +#X text 98 356 set; +#X text 79 143 the "set" message sets the number box's value but does +not send it to the outlet.; +#X text 168 356 - the set message updates the value of the number box +without outputting it (e.g. \, "set 23" sets the value to 23). Sending +a set message without a value does not change the current value in +the number box.; +#X text 168 421 - a number box outputs a float for each message it +receives (except set).; +#N canvas 102 43 430 514 Number_box_properties 0; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X floatatom 70 102 12 0 0 0 - - -; +#X floatatom 71 223 1 0 0 0 - - -; +#X text 50 2 Properties for gatom; +#X text 20 38 Right click on a number box and choose "Properties" to +change the following:; +#X text 19 69 width; +#X text 69 69 - width of the number box (in characters). By default +the width is 5 characters.; +#X text 148 102 width = 12 characters; +#X floatatom 70 123 2 0 0 0 - - -; +#X text 148 123 width = 2 characters; +#X text 69 164 If you select a width of 0 \, the number box will grow +as needed to hold the number--BUT BEWARE \, THIS IS EXPENSIVE IN CPU +TIME. In a production patch \, you'll want to set a specific width. +; +#X floatatom 70 143 0 0 0 0 - - -; +#X text 148 143 width = 0 characters (read below); +#X text 69 240 A width of one gives a clickable toggle switch ala Max. +; +#X text 88 223 width = 1 character: toggle between 0 and 1; +#X text 19 260 limits; +#X floatatom 71 282 5 0 127 0 - - -; +#X text 109 281 numbers between 0 and 127; +#X text 69 260 - set lower and upper limits for scrolling the number +box; +#X text 68 300 This only affects scrolling- you can still send values +to the number box that are outside these limits.; +#X floatatom 71 353 5 0 127 1 my_number_box - -; +#X text 19 331 label; +#X text 69 331 - give the number box a visible name; +#X text 68 371 Use the radio buttons to reposition the label to the +left \, right \, top \, or bottom of the number box. Spaces in the +label will automatically be converted to underscores.; +#X text 19 413 messages; +#X text 69 413 - nonlocal send and receive; +#X floatatom 193 532 5 0 0 2 Number_box_7 gatom-help-rcv gatom-help-snd +; +#X obj 276 540 r gatom-help-snd; +#X obj 71 516 s gatom-help-rcv; +#X msg 71 490 28; +#X text 68 433 As an alternative to using wires \, you can set send +and receive names to send messages through the number box. "Number-box-7" +below is set to receive messages to "gatom-help-rcv" \, and send messages +to "gatom-help-snd"; +#X floatatom 276 563 5 0 0 0 - - -; +#X text 68 583 Notice that you cannot make local connections with wires +to "Number_box_7" when using non-local send and receive names. If you +want to use both \, see the [nbx] object:; +#X obj 71 626 nbx 5 14 -1e+37 1e+37 0 0 empty empty empty 0 -8 0 10 +-262144 -1 -1 0 256; +#X floatatom 13 3 5 0 0 0 - - -; +#X connect 27 0 31 0; +#X connect 29 0 28 0; +#X restore 102 567 pd Number_box_properties; +#X text 100 489 You can shift-click and drag to change the number by +hundredths instead of units. Alt clicking toggles the value between +0 and the last nonzero value.; +#X text 99 530 You can also type in values by clicking and typing a +number followed by "enter."; +#X text 168 306 - a list is truncated to the first item.; +#X text 11 23 atom (number box); +#X obj 4 597 pddp/pddplink pddp/help.pd -text help; +#X connect 14 0 15 0; +#X connect 16 0 17 0; +#X connect 17 0 18 0; -- cgit v1.2.1