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/bang-help.pd | 278 +++++++++++++++++++++++++------------------------- 1 file changed, 138 insertions(+), 140 deletions(-) (limited to 'doc/pddp/bang-help.pd') diff --git a/doc/pddp/bang-help.pd b/doc/pddp/bang-help.pd index 9de0c5c0..4a450974 100644 --- a/doc/pddp/bang-help.pd +++ b/doc/pddp/bang-help.pd @@ -1,140 +1,138 @@ -#N canvas 12 2 916 656 10; -#X obj 502 191 print; -#X obj 22 14 bang; -#X msg 514 133 walk the cat; -#X msg 501 112 45; -#X obj 502 166 bang; -#X text 110 13 - SEND "BANG" MESSAGE; -#X obj 76 14 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X text 22 38 The bang object is one of the basic building blocks of -PD and are normally used to activate events. The bang object can be -created in two different ways.; -#X obj 45 83 bang; -#X text 22 82 1; -#X text 21 141 2; -#X obj 45 142 bng 15 250 50 0 empty empty empty 18 7 0 8 -262144 -1 --1; -#X text 45 107 This version uses minimal CPU but serves essentially -the same purpose as the GUI version.; -#X text 43 286 1 Size; -#X obj 122 289 bng 8 250 50 0 empty empty 8 10 4 0 8 -262144 -1 -1 -; -#X obj 147 282 bng 15 250 50 0 empty empty 15 17 9 0 8 -262144 -1 -1 -; -#X obj 182 272 bng 25 250 50 0 empty empty 25 27 20 0 8 -262144 -1 --1; -#X text 69 304 Default size is 15 pixels. The minimum size is 8 and -it does not have a maximum size.; -#X text 41 465 3 Hold; -#X obj 111 465 bng 15 50 10 0 empty empty 50 17 8 0 8 -262144 -1 -1 -; -#X obj 146 465 bng 15 750 50 0 empty empty 750 17 8 0 8 -262144 -1 --1; -#X text 41 538 4 Receive Symbol/Send Symbol; -#X text 67 553 This object can act as its own send or receive object. -; -#X obj 69 575 bng 15 250 50 0 link_this_bang empty This_one_sends_a_bang -17 8 128 8 -262144 -1 -1; -#X obj 69 596 bng 15 250 50 0 empty link_this_bang This_one_receives_it. -17 8 64 8 -262144 -1 -1; -#X text 280 567 Here is the alternative method.; -#X text 44 644 5 GUI Options; -#X obj 506 368 bng 8 250 50 0 empty empty empty 0 -6 0 12 -262144 -1 --1; -#X msg 679 359 label Name_that_bang; -#X msg 692 383 label Rename_that_bang; -#X msg 719 405 size 8; -#X text 67 666 The other properties are 'name' \, 'x/y offset' \, 'font -size' \, and colours (for the background \, front \, and labels [name]) -; -#X obj 471 19 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X obj 471 659 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X text 495 55 WHAT CAN IT DO?; -#X text 495 67 The bang object outputs "bang" when it receives something -in its inlet or its 'internal' receive symbol (GUI version only).; -#X text 547 190 The output window will print "bang" to demonstrate. -; -#X obj 647 162 print; -#X msg 647 116 walk the cat; -#X obj 647 141 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X text 502 215 It is important to note that "bang" is not boolean. -It's neither a zero or a one \; it's not true or false \; it's just -"bang". For a boolean object \, you should check out the toggle.; -#X obj 502 487 loadbang; -#X obj 643 487 tgl 15 0 empty empty Toggle 0 -6 0 8 -262144 -1 -1 0 -1; -#X obj 557 487 trigger; -#X obj 606 487 bang~; -#X text 502 290 OTHER HELPFUL INFO; -#X msg 735 427 size 25; -#X text 502 312 The label and size properties of the bng object (from -IEM library) can be updated dynamically by sending messages to its -inlet.; -#X text 512 461 RELATED OBJECTS; -#X text 44 165 This version uses a little more CPU than its cousin -because it lights-up when it receives a message or is clicked on and -can be coloured \, resized \, or renamed. It is sometimes 'friendlier' -as well because it can act as its own send and receive object (see -properties...). This object can be put in a Pd patch either by keyboard -shortcut: ALT+B or by creating and object (CTRL+1) called "bng".; -#X text 66 482 The default hold is 250 milliseconds. The hold value -controls the length of time that the bng object stays "lit". Note that -bng sends its message immediately regardless of the hold value.; -#X obj 261 621 s linked_bngs; -#X obj 370 583 r linked_bngs; -#X text 40 334 2 Interrupt (milliseconds); -#X text 66 348 If the bng object is "lit" and holding (see "hold" below) -\, then receives another message before the hold time has passed \, -the bng will quickly flash again for the duration you set in this interrupt -property.; -#X obj 42 421 bng 15 1000 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X text 65 405 This bng will hold for 1000 milliseconds \, but interrupt -for 50 milliseconds if it gets a second message during its "hold". -Click it once...wait. Then click it multiple times rather quickly to -see the effect.; -#X obj 261 603 bang; -#X obj 370 602 bang; -#X msg 261 584 send a message; -#X obj 370 620 print; -#X text 69 143 a.k.a. "bng"; -#X text 43 264 PROPERTIES OF BNG; -#X text 497 548 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.; -#N canvas 4 24 432 275 related_objects_from_other_libraries 0; -#X obj 8 10 pddp/pddplink ../../extra/mjlib/metroplus-help.pd -text mjlib/metroplus; -#X obj 8 30 pddp/pddplink ../../extra/unauthorized/exciter-help.pd -text unauthorized/exciter; -#X obj 8 50 pddp/pddplink ../../extra/ggee/toddle-help.pd -text ggee/toddle; -#X obj 8 70 pddp/pddplink ../../extra/iemlib/init-help.pd -text iemlib/init; -#X obj 198 10 pddp/pddplink ../../extra/cyclone/counter-help.pd -text cyclone/counter; -#X obj 198 30 pddp/pddplink ../../extra/markex/oneshot-help.pd -text markex/oneshot; -#X obj 198 50 pddp/pddplink ../../extra/unauthorized/countund-help.pd -text unauthorized/countund; -#X text 18 86 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 17 135 The best places to find information about Pd's libraries -is:; -#X text 14 157 www.puredata.org and click on "Downloads" then "Software" -; -#X text 15 173 or; -#X text 16 187 iem.kug.ac.at/pdb/; -#X restore 501 513 pd related_objects_from_other_libraries; -#X connect 2 0 4 0; -#X connect 3 0 4 0; -#X connect 4 0 0 0; -#X connect 28 0 27 0; -#X connect 29 0 27 0; -#X connect 30 0 27 0; -#X connect 32 0 33 0; -#X connect 38 0 39 0; -#X connect 39 0 37 0; -#X connect 46 0 27 0; -#X connect 52 0 58 0; -#X connect 57 0 51 0; -#X connect 58 0 60 0; -#X connect 59 0 57 0; +#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 bang 3 12 0 18 -204280 +-1 0; +#X obj 0 329 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 49 244 494 366 META 0; +#X text 12 125 PLATFORM windows macosx gnulinux; +#X text 12 185 LIBRARY internal; +#X text 12 225 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 12 85 LICENSE SIBSD; +#X text 12 205 AUTHOR Miller Puckette; +#X text 12 285 HELP_PATCH_AUTHORS This document was updated for Pd +version 0.35 test 28 by Dave Sabine as part of a project called pddp +proposed by Krzysztof Czaja to build comprehensive documentation for +Pd. Revised by Jonathan Wilkes to conform to the PDDP template for +Pd version 0.42.; +#X text 12 5 GENRE help; +#X text 12 105 DESCRIPTION output a "bang" message whatever the input +; +#X text 12 145 INLET_0 anything; +#X text 12 165 OUTLET_0 bang; +#X text 12 45 ALIAS b; +#X text 12 25 NAME bang; +#X text 12 65 KEYWORDS control bang_op; +#X text 12 245 RELEASE_DATE 2009; +#X text 12 265 RELEASE_VERSION; +#X restore 500 597 pd META; +#X obj 0 373 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj 0 409 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#X obj 0 437 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +0 13 -228856 -1 0; +#X obj 78 338 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 98 413 (none); +#N canvas 40 482 428 108 Related_objects 0; +#X obj 21 42 trigger; +#X obj 191 43 loadbang; +#X msg 91 43; +#X obj 262 43 until; +#X obj 144 43 bang; +#X obj 312 43 metro; +#X obj 0 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 7 1 [bang] Related Objects; +#X restore 101 598 pd Related_objects; +#X text 98 381 bang; +#X obj 78 381 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X obj 465 20 pddp/pddplink http://wiki.puredata.info/en/bang -text +pdpedia: bang; +#X obj 469 3 bang; +#X obj 139 224 print; +#X msg 152 171 walk the cat; +#X msg 139 145 45; +#X obj 139 199 bang; +#X obj 288 199 print; +#X msg 288 147 walk the cat; +#X obj 288 175 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X text 310 173 <- gui "bng" object; +#X text 98 337 anything; +#N canvas 57 48 428 509 More_bang_objects 0; +#X obj 23 42 bang; +#X obj 66 42 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X obj 43 116 bang; +#X text 20 115 1; +#X text 19 172 2; +#X obj 43 173 bng 15 250 50 0 empty empty empty 18 7 0 8 -262144 -1 +-1; +#X text 178 42 - sending "bang" messages; +#X obj 140 42 t b; +#X msg 92 42 bang; +#X text 19 288 3; +#X msg 45 289 bang; +#X msg 98 342 bang \, bang; +#X obj 98 368 f; +#X obj 131 368 + 1; +#X floatatom 98 393 5 0 0 0 - - -; +#X msg 46 342 bang; +#X text 19 418 4; +#X obj 43 419 trigger bang; +#X text 151 419 Abbrevation:; +#X obj 253 419 t b; +#X obj 271 471 b; +#X text 43 138 This version uses minimal CPU but serves essentially +the same purpose as the GUI version below.; +#X text 42 309 The word "bang" in a message box (CTRL+2) makes a clickable +bang object. Use commas to send multiple messages:; +#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 [bang] Common Objects for Sending bang Messages; +#X text 20 65 The [bang] object is one of the basic building blocks +of PD and is normally used to activate events. The four basic ways +to send a "bang" message are:; +#X text 42 441 When given a single argument of "bang" \, the trigger +object is essentially the same as #1 above \, so in this case it's +preferable (and less typing) to use:; +#X text 67 174 a.k.a. [bng]; +#X text 42 191 This version uses a little more CPU than its cousin +because it lights up when it receives a message or is clicked on and +can be coloured \, resized \, or renamed. It is sometimes 'friendlier' +as well because it can act as its own send and receive object (see +properties...). This object can be put in a Pd patch either by keyboard +shortcut: ALT+SHIFT+B or by creating an object (CTRL+1) and naming +it "bng".; +#X connect 11 0 12 0; +#X connect 12 0 13 0; +#X connect 12 0 14 0; +#X connect 13 0 12 1; +#X connect 15 0 12 0; +#X restore 100 473 pd More_bang_objects; +#X text 98 441 Many objects in Pd output a "bang" message. Click the +subpatch below to read about the most common ones:; +#X obj 100 569 tgl 15 0 empty empty empty 17 7 0 10 -262144 -1 -1 0 +1; +#X text 98 498 It is important to note that "bang" is not boolean. +It's neither a zero or a one \; it's not true or false \; it's just +"bang". For a boolean object \, you should check out [toggle]:; +#X text 11 23 output a "bang" message whatever the input; +#X text 122 567 <- Right click and choose "Help" for [toggle] helpfile. +; +#X text 168 381 - the [bang] object always outputs a bang message. +; +#X text 168 337 - [bang] takes any message supplied to its inlet and +outputs a bang message in response.; +#X obj 4 597 pddp/pddplink pddp/help.pd -text help; +#X obj 521 3 b; +#X text 501 3 or; +#X connect 15 0 17 0; +#X connect 16 0 17 0; +#X connect 17 0 14 0; +#X connect 19 0 20 0; +#X connect 20 0 18 0; -- cgit v1.2.1