[Gridflow-cvs] [svn] commit: r5244 - in /trunk/doc: index.pd locale/english.tcl

svn-gridflow at artengine.ca svn-gridflow at artengine.ca
Sun Mar 28 15:45:44 EDT 2010


Author: matju
Date: Sun Mar 28 15:45:44 2010
New Revision: 5244

Log:
new "GridFlow Index"

Modified:
    trunk/doc/index.pd
    trunk/doc/locale/english.tcl

Modified: trunk/doc/index.pd
==============================================================================
--- trunk/doc/index.pd (original)
+++ trunk/doc/index.pd Sun Mar 28 15:45:44 2010
@@ -75,34 +75,34 @@
 #X text 180 1241 apply hue shift by rotating the color wheel;
 #X obj 114 1273 #import;
 #X text 180 1273 convert float \,  list, or symbol ASCII codes, to a grid;
-#X obj 90 1305 #import_pix;
-#X text 180 1305 old name of #from_pix;
-#X obj 138 1337 #in;
-#X text 180 1337 open file or device for reading or download;
-#X obj 120 1369 #inner;
-#X text 180 1369 scalar ("dot") product \,  matrix product, tensor contraction, image channel remapping, etc.;
-#X obj 102 1401 #io.aalib;
-#X text 180 1401 open an aalib window;
-#X obj 96 1433 #io.dc1394;
-#X text 180 1433 open a faiawaia "DC" camera (not DV) using a Linux-compatible OS;
-#X obj 108 1465 #io.grid;
-#X text 180 1465 read or write a .grid file (GridFlow storage format);
-#X obj 108 1497 #io.jpeg;
-#X text 180 1497 read or write a .jpeg file;
-#X obj 108 1529 #io.mpeg;
-#X text 180 1529 read a .mpeg video file;
-#X obj 114 1561 #io.png;
-#X text 180 1561 read a .png image file;
-#X obj 114 1593 #io.ppm;
-#X text 180 1593 read or write a .pbm or .pgm or .ppm image file;
+#X obj 138 1305 #in;
+#X text 180 1305 open file or device for reading or download;
+#X obj 120 1337 #inner;
+#X text 180 1337 scalar ("dot") product \,  matrix product, tensor contraction, image channel remapping, etc.;
+#X obj 102 1369 #io.aalib;
+#X text 180 1369 open an aalib window;
+#X obj 96 1401 #io.dc1394;
+#X text 180 1401 open a faiawaia "DC" camera (not DV) using a Linux-compatible OS;
+#X obj 108 1433 #io.grid;
+#X text 180 1433 read or write a .grid file (GridFlow storage format);
+#X obj 108 1465 #io.jpeg;
+#X text 180 1465 read or write a .jpeg file;
+#X obj 108 1497 #io.mpeg;
+#X text 180 1497 read a .mpeg video file;
+#X obj 114 1529 #io.png;
+#X text 180 1529 read a .png image file;
+#X obj 114 1561 #io.ppm;
+#X text 180 1561 read a .pbm or .pgm or .ppm image file or write a .ppm image file;
+#X obj 96 1593 #io.quartz;
+#X text 180 1593 open a Quartz window (OSX);
 #X obj 78 1625 #io.quicktime;
 #X text 180 1625 read a .mov video file (or perhaps .avi);
 #X obj 114 1657 #io.sdl;
-#X text 180 1657 open a SDL window;
+#X text 180 1657 open a SDL window (Windows \, Linux,OSX);
 #X obj 84 1689 #io.videodev;
-#X text 180 1689 open a V4L1 device (Linux interface for video cameras and video digitisers);
+#X text 180 1689 open a V4L1 device (Linux-only interface for video cameras and video digitisers);
 #X obj 114 1721 #io.x11;
-#X text 180 1721 open a X11 window;
+#X text 180 1721 open a X11 window (Linux \, etc);
 #X obj 126 1753 #join;
 #X text 180 1753 join two grids together along any dimension;
 #X obj 96 1785 #labelling;
@@ -251,94 +251,164 @@
 #X text 180 4134 OpenCV invert matrix;
 #X obj 96 4166 cv/#KMeans;
 #X text 180 4166 OpenCV K-Means clusteriser;
-#X obj 96 4198 cv/#Kalman;
-#X text 180 4198 OpenCV (future use);
-#X obj 114 4230 cv/#Mul;
-#X text 180 4230 OpenCV multiplication;
-#X obj 120 4262 cv/#Or;
-#X text 180 4262 OpenCV bitwise OR;
-#X obj 114 4294 cv/#SVD;
-#X text 180 4294 OpenCV singular value decomposition (eigendecomposition);
-#X obj 114 4326 cv/#Sub;
-#X text 180 4326 OpenCV subtraction;
-#X obj 114 4358 cv/#Xor;
-#X text 180 4358 OpenCV bitwise XOR;
-#X obj 138 4390 display;
-#X text 180 4390 [display]: print message or grid inside of the patch;
-#X obj 55 4422 doremi;
-#X text 180 4422 [doremi]: gui object for displaying midi notes;
-#X obj 120 4511 expect;
-#X text 180 4511 currently does like list.== (will do more than that in the future);
-#X obj 138 4543 for;
-#X text 180 4543 make sequence of float messages for each number in a range with specified stepping;
-#X obj 114 4575 foreach;
-#X text 180 4575 convert a list to a sequence of atom messages;
-#X obj 138 4607 fps;
-#X text 180 4607 measure frames per second and make statistics;
-#X obj 108 4639 gf.error;
-#X text 180 4639 emit error message from the perspective of the current abstraction instance in its parent patch;
-#X obj 72 4671 gf.io_generate;
-#X text 180 4671 for internal use by #in and #out;
-#X obj 96 4703 gf.oneshot;
-#X text 180 4703 spigot that shuts itself down after each message;
-#X obj 60 4735 gf.suffix_lookup;
-#X text 180 4735 find the objectclass corresponding ;
-#X obj 84 4767 gf/mouse_spy;
-#X text 180 4767 tell mouse/key events of a single patch window in [#out window] format;
-#X obj 72 4799 hpgl_find_bbox;
-#X text 180 4799 find the bounding box of a sequence of hpgl commands;
-#X obj 60 4831 hpgl_font_render;
-#X text 180 4831 include hpgl files from disk for drawing text;
-#X obj 114 4863 hpgl_op;
-#X text 180 4863 use [#] on hpgl commands;
-#X obj 42 4895 hpgl_track_position;
-#X text 180 4895 remember last mentioned hpgl coordinate;
-#X obj 60 4927 interval_overlap;
-#X text 180 4927 test whether two intervals of floats overlap;
-#X obj 132 4959 inv*;
-#X text 180 4959 swapped /;
-#X obj 132 4991 inv+;
-#X text 180 4991 swapped -;
-#X obj 114 5023 list.==;
-#X text 180 5023 test two lists of floats and/or symbols for equality;
-#X obj 108 5055 listfind;
-#X text 180 5055 find index of an element in a list;
-#X obj 90 5087 listflatten;
-#X text 180 5087 merge all nested lists together \,  depth-first;
-#X obj 108 5119 listread;
-#X text 180 5119 find element at an index in a list;
-#X obj 90 5151 listreverse;
-#X text 180 5151 mirror image of a list;
-#X obj 102 5183 norecurse;
-#X text 180 5183 simple spigot for preventing control-recursion;
-#X obj 78 5215 parallel_port;
-#X text 180 5215 send to and receive from a DB25 parallel port;
-#X obj 108 5247 pingpong;
-#X text 180 5247 turns value of a counter into a zigzag between 0 and a given value;
-#X obj 66 5279 plotter_control;
-#X text 180 5279 make HPGL commands;
-#X obj 72 5311 plotter_parser;
-#X text 180 5311 interprets ascii codes as HPGL commands and output them as messages;
-#X obj 84 5343 qwerty_piano;
-#X text 180 5343 imitation of [notein] using [key] and [keyup];
-#X obj 126 5375 range;
-#X text 180 5375 multiple moses in cascade;
-#X obj 84 5407 receives \$0-;
-#X text 180 5407 multiple receives with common outlet and other outlet telling the name of intended destination;
-#X obj 120 5439 route2;
-#X text 180 5439 route messages but keep them intact (does not remove selector);
-#X obj 108 5471 seq_fold;
-#X text 180 5471 cascade the use of an object on all elements of an incoming message sequence;
-#X obj 126 5503 shunt;
-#X text 180 5503 demultiplexer: send input to separately specified outlet;
-#X obj 96 5535 systemtime;
-#X text 180 5535 time spent by process in kernel mode \,  as measured by the OS;
-#X obj 114 5567 tsctime;
-#X text 180 5567 high-resolution real time \,  as measured by the CPU;
-#X obj 102 5599 unix_time;
-#X text 180 5599 real time as measured by the OS \,  including date;
-#X obj 108 5631 usertime;
-#X text 180 5631 time spent by process in non-kernel mode \,  as measured by the OS;
-#X obj 126 5663 var.#;
-#X text 180 5663 like [f] for grids;
-#X text 0 5695 171 classes are listed in this index.;
+#X obj 114 4198 cv/#Mul;
+#X text 180 4198 OpenCV multiplication;
+#X obj 120 4230 cv/#Or;
+#X text 180 4230 OpenCV bitwise OR;
+#X obj 114 4262 cv/#SVD;
+#X text 180 4262 OpenCV singular value decomposition (eigendecomposition);
+#X obj 114 4294 cv/#Sub;
+#X text 180 4294 OpenCV subtraction;
+#X obj 114 4326 cv/#Xor;
+#X text 180 4326 OpenCV bitwise XOR;
+#X obj 138 4358 display;
+#X text 180 4358 [display]: print message or grid inside of the patch;
+#X text 102 4390 [doc_add];
+#X text 180 4390 add a [doc_m] in the parent of the parent canvas;
+#X text 96 4422 [doc_also];
+#X text 180 4422 GFDP subheader for listing related classes;
+#X text 90 4454 [doc_below];
+#X text 180 4454 instruct [doc_layout] to put a GFDP element below another one;
+#X text 84 4486 [doc_bottom];
+#X text 180 4486 find the bottom of a GFDP element;
+#X text 114 4518 [doc_c];
+#X text 180 4518 GFDP subheader for creation arguments documentation;
+#X text 108 4550 [doc_cc];
+#X text 180 4550 GFDP subsubheader for creation arguments documentation;
+#X text 96 4582 [doc_demo];
+#X text 180 4582 header of an example patch;
+#X text 72 4614 [doc_editmode];
+#X text 180 4614 automatically move [cnv] and [bng] when switching from/to edit mode;
+#X text 90 4646 [doc_exist];
+#X text 180 4646 check whether a certain GFDP component already exists in the help patch;
+#X text 114 4678 [doc_f];
+#X text 180 4678 footer of a GFDP help patch;
+#X text 114 4710 [doc_h];
+#X text 180 4710 header of a GFDP help patch;
+#X text 114 4742 [doc_i];
+#X text 180 4742 GFDP subheader for inlet documentation;
+#X text 108 4774 [doc_ii];
+#X text 180 4774 GFDP subsubheader for inlet documentation;
+#X text 84 4806 [doc_layout];
+#X text 180 4806 enforce correct layout of the abstraction containing it \,  in the parent's abstraction;
+#X text 114 4838 [doc_m];
+#X text 180 4838 GFDP subsubsubheader for one method or one creation argument;
+#X text 96 4870 [doc_make];
+#X text 180 4870 add GFDP subsubheaders in the parent of the parent canvas;
+#X text 114 4902 [doc_o];
+#X text 180 4902 GFDP subheader for outlet documentation;
+#X text 108 4934 [doc_oo];
+#X text 180 4934 GFDP subsubheader for outlet documentation;
+#X text 96 4966 [doc_same];
+#X text 180 4966 GFDP pseudo-comment for saying a method is same as a creation argument;
+#X obj 55 4998 doremi;
+#X text 180 4998 [doremi]: gui object for displaying midi notes;
+#X obj 120 5087 expect;
+#X text 180 5087 currently does like list.== (will do more than that in the future);
+#X obj 138 5119 for;
+#X text 180 5119 make sequence of float messages for each number in a range with specified stepping;
+#X obj 114 5151 foreach;
+#X text 180 5151 convert a list to a sequence of atom messages;
+#X obj 138 5183 fps;
+#X text 180 5183 measure frames per second and make statistics;
+#X obj 108 5215 gf.error;
+#X text 180 5215 emit error message from the perspective of the current abstraction instance in its parent patch;
+#X obj 72 5247 gf.io_generate;
+#X text 180 5247 for internal use by #in and #out;
+#X obj 96 5279 gf.oneshot;
+#X text 180 5279 spigot that shuts itself down after each message;
+#X obj 60 5311 gf.suffix_lookup;
+#X text 180 5311 find the objectclass corresponding ;
+#X obj 66 5343 gf/canvas_count;
+#X text 180 5343 tell total number of objects in a canvas;
+#X obj 36 5375 gf/canvas_dollarzero;
+#X text 180 5375 tell the \$0 of an uplevel canvas;
+#X obj 42 5407 gf/canvas_edit_mode;
+#X text 180 5407 tell the edit mode of a canvas;
+#X obj 48 5439 gf/canvas_filename;
+#X text 180 5439 tell the filename of a canvas;
+#X obj 60 5471 gf/canvas_getpos;
+#X text 180 5471 tell the position of a canvas in its parent canvas;
+#X obj 66 5503 gf/canvas_index;
+#X text 180 5503 tell the index of a canvas in its parent canvas;
+#X obj 36 5535 gf/canvas_isselected;
+#X text 180 5535 tell whether a canvas is selected in its parent canvas;
+#X obj 48 5567 gf/canvas_loadbang;
+#X text 180 5567 send loadbang to the most recently created objects of a canvas;
+#X obj 60 5599 gf/canvas_setgop;
+#X text 180 5599 set GOP options of a canvas;
+#X obj 60 5631 gf/canvas_setpos;
+#X text 180 5631 set the position of a canvas in its parent canvas;
+#X obj 78 5663 gf/canvas_xid;
+#X text 180 5663 tell the x11 id of a canvas \,  its window, and tell the tk id of a canvas;
+#X obj 84 5695 gf/find_file;
+#X text 180 5695 find a file the same way that [#in] does;
+#X obj 102 5727 gf/getcwd;
+#X text 180 5727 tell the current working directory (as set by the "cd" shell command);
+#X obj 102 5759 gf/getpid;
+#X text 180 5759 tell the process id of the pd server;
+#X obj 84 5791 gf/mouse_spy;
+#X text 180 5791 tell mouse/key events of a single patch window in [#out window] format;
+#X obj 90 5823 gf/selector;
+#X text 180 5823 report the true selector of the incoming message;
+#X obj 90 5855 gf/string_<;
+#X text 180 5855 compare two strings;
+#X obj 54 5887 gf/string_replace;
+#X text 180 5887 search and replace substrings in a symbol;
+#X obj 72 5919 hpgl_find_bbox;
+#X text 180 5919 find the bounding box of a sequence of hpgl commands;
+#X obj 60 5951 hpgl_font_render;
+#X text 180 5951 include hpgl files from disk for drawing text;
+#X obj 114 5983 hpgl_op;
+#X text 180 5983 use [#] on hpgl commands;
+#X obj 42 6015 hpgl_track_position;
+#X text 180 6015 remember last mentioned hpgl coordinate;
+#X obj 60 6047 interval_overlap;
+#X text 180 6047 test whether two intervals of floats overlap;
+#X obj 132 6079 inv*;
+#X text 180 6079 swapped /;
+#X obj 132 6111 inv+;
+#X text 180 6111 swapped -;
+#X obj 114 6143 list.==;
+#X text 180 6143 test two lists of floats and/or symbols for equality;
+#X obj 108 6175 listfind;
+#X text 180 6175 find index of an element in a list;
+#X obj 90 6207 listflatten;
+#X text 180 6207 merge all nested lists together \,  depth-first;
+#X obj 108 6239 listread;
+#X text 180 6239 find element at an index in a list;
+#X obj 90 6271 listreverse;
+#X text 180 6271 mirror image of a list;
+#X obj 102 6303 norecurse;
+#X text 180 6303 simple spigot for preventing control-recursion;
+#X obj 78 6335 parallel_port;
+#X text 180 6335 send to and receive from a DB25 parallel port;
+#X obj 108 6367 pingpong;
+#X text 180 6367 turns value of a counter into a zigzag between 0 and a given value;
+#X obj 66 6399 plotter_control;
+#X text 180 6399 make HPGL commands;
+#X obj 72 6431 plotter_parser;
+#X text 180 6431 interprets ascii codes as HPGL commands and output them as messages;
+#X obj 84 6463 qwerty_piano;
+#X text 180 6463 imitation of [notein] using [key] and [keyup];
+#X obj 126 6495 range;
+#X text 180 6495 multiple moses in cascade;
+#X obj 84 6527 receives \$0-;
+#X text 180 6527 multiple receives with common outlet and other outlet telling the name of intended destination;
+#X obj 120 6559 route2;
+#X text 180 6559 route messages but keep them intact (does not remove selector);
+#X obj 108 6591 seq_fold;
+#X text 180 6591 cascade the use of an object on all elements of an incoming message sequence;
+#X obj 126 6623 shunt;
+#X text 180 6623 demultiplexer: send input to separately specified outlet;
+#X obj 96 6655 systemtime;
+#X text 180 6655 time spent by process in kernel mode \,  as measured by the OS;
+#X obj 114 6687 tsctime;
+#X text 180 6687 high-resolution real time \,  as measured by the CPU;
+#X obj 102 6719 unix_time;
+#X text 180 6719 real time as measured by the OS \,  including date;
+#X obj 108 6751 usertime;
+#X text 180 6751 time spent by process in non-kernel mode \,  as measured by the OS;
+#X obj 126 6783 var.#;
+#X text 180 6783 like [f] for grids;
+#X text 0 6815 206 classes are listed in this index.;

Modified: trunk/doc/locale/english.tcl
==============================================================================
--- trunk/doc/locale/english.tcl (original)
+++ trunk/doc/locale/english.tcl Sun Mar 28 15:45:44 2010
@@ -34,7 +34,6 @@
 say #fold            "compute the sum of each row, product of each row, and other similar operations"
 say #for             "make a grid from all numbers or coordinates in a certain range"
 say #from_pix        "convert pix (GEM) to grid"
-say #import_pix      "old name of #from_pix"
 say #grade           "make an index of the sorting of a grid"
 say #import          "convert float, list, or symbol ASCII codes, to a grid"
 say #inner           "scalar (\"dot\") product, matrix product, tensor contraction, image channel remapping, etc."
@@ -47,11 +46,12 @@
 say #io.jpeg         "read or write a .jpeg file"
 say #io.mpeg         "read a .mpeg video file"
 say #io.png          "read a .png image file"
-say #io.ppm          "read or write a .pbm or .pgm or .ppm image file"
+say #io.ppm          "read a .pbm or .pgm or .ppm image file or write a .ppm image file"
+say #io.quartz       "open a Quartz window (OSX)"
 say #io.quicktime    "read a .mov video file (or perhaps .avi)"
-say #io.sdl          "open a SDL window"
-say #io.videodev     "open a V4L1 device (Linux interface for video cameras and video digitisers)"
-say #io.x11          "open a X11 window"
+say #io.sdl          "open a SDL window (Windows,Linux,OSX)"
+say #io.videodev     "open a V4L1 device (Linux-only interface for video cameras and video digitisers)"
+say #io.x11          "open a X11 window (Linux,etc)"
 say parallel_port    "send to and receive from a DB25 parallel port"
 say plotter_control  "make HPGL commands"
 
@@ -181,7 +181,7 @@
 say cv/#Ellipse       "OpenCV draw ellipse"
 say cv/#KMeans        "OpenCV K-Means clusteriser"
 say cv/#HaarDetectObjects "OpenCV (future use)"
-say cv/#Kalman        "OpenCV (future use)"
+#say cv/#Kalman        "OpenCV (future use)"
 say cv/#ApproxPoly    "OpenCV polygon approximator"
 say cv/#CornerHarris  "OpenCV Harris corner-detector"
 
@@ -220,51 +220,60 @@
   say cv/#CalcOpticalFlowPyrLK
 }
 
-# doc: many of them can't even be listed normally in the doc index
+category "GFDP" ;# many of them can't even be listed normally in the doc index
+say doc_add      "add a \[doc_m\] in the parent of the parent canvas"
+say doc_also     "GFDP subheader for listing related classes"
+say doc_below    "instruct \[doc_layout\] to put a GFDP element below another one"
+say doc_bottom   "find the bottom of a GFDP element"
+say doc_c        "GFDP subheader for creation arguments documentation"
+say doc_cc       "GFDP subsubheader for creation arguments documentation"
+say doc_demo     "header of an example patch"
+say doc_editmode "automatically move \[cnv\] and \[bng\] when switching from/to edit mode"
+say doc_exist    "check whether a certain GFDP component already exists in the help patch"
+say doc_f        "footer of a GFDP help patch"
+say doc_h        "header of a GFDP help patch"
+say doc_i        "GFDP subheader for inlet documentation"
+say doc_ii       "GFDP subsubheader for inlet documentation"
+say doc_layout   "enforce correct layout of the abstraction containing it, in the parent's abstraction"
+say doc_m        "GFDP subsubsubheader for one method or one creation argument"
+say doc_make     "add GFDP subsubheaders in the parent of the parent canvas"
+say doc_o        "GFDP subheader for outlet documentation"
+say doc_oo       "GFDP subsubheader for outlet documentation"
+say doc_same     "GFDP pseudo-comment for saying a method is same as a creation argument"
+
+# experimental new stuff
+
 if 0 {
-say doc_add
-say doc_also
-say doc_below
-say doc_bottom
-say doc_c
-say doc_cc
-say doc_editmode
-say doc_exist
-say doc_f
-say doc_h
-say doc_i
-say doc_ii
-say doc_layout
-say doc_m
-say doc_make
-say doc_o
-say doc_oo
-say doc_same
-}
-
-# experimental undocumented
-
+# say gf.display
+# say gf.nbxhsl
+# say gf.not_open
+# say gf.print
+}
+
+#io.quartz #to_array doc_add doc_also doc_below doc_bottom doc_c doc_cc doc_demo doc_editmode doc_exist doc_f doc_h doc_i doc_ii doc_layout doc_m 
+#doc_make doc_o doc_oo doc_same inv0x2a inv0x2b memstat
+
+say gf/canvas_count      "tell total number of objects in a canvas"
+say gf/canvas_dollarzero "tell the \$0 of an uplevel canvas"
+say gf/canvas_edit_mode  "tell the edit mode of a canvas"
+say gf/canvas_filename   "tell the filename of a canvas"
+say gf/canvas_getpos     "tell the position of a canvas in its parent canvas"
+# say gf/canvas_hehehe      
+# say gf/canvas_hohoho
+say gf/canvas_index      "tell the index of a canvas in its parent canvas"
+say gf/canvas_isselected "tell whether a canvas is selected in its parent canvas"
+say gf/canvas_loadbang   "send loadbang to the most recently created objects of a canvas"
+say gf/canvas_setgop     "set GOP options of a canvas"
+say gf/canvas_setpos     "set the position of a canvas in its parent canvas"
+say gf/canvas_xid        "tell the x11 id of a canvas, its window, and tell the tk id of a canvas"
+say gf/find_file         "find a file the same way that \[#in\] does"
+say gf/getcwd            "tell the current working directory (as set by the \"cd\" shell command)"
+say gf/getpid            "tell the process id of the pd server"
+# say gf/lol
+say gf/selector          "report the true selector of the incoming message"
+say gf/string_<          "compare two strings"
+say gf/string_replace    "search and replace substrings in a symbol"
 if 0 {
-say gf.display
-say gf.nbxhsl
-say gf.not_open
-say gf.print
-say gf/canvas_count
-say gf/canvas_dollarzero
-say gf/canvas_edit_mode
-say gf/canvas_filename
-say gf/canvas_getpos
-say gf/canvas_hehehe
-say gf/canvas_hohoho
-say gf/canvas_is_selected
-say gf/canvas_loadbang
-say gf/canvas_setgop
-say gf/canvas_setpos
-say gf/canvas_xid
-say gf/getpid
-say gf/lol
-say gf/string_<
-say gf/string_replace
 say memstat
 say setargs
 }



More information about the Gridflow-cvs mailing list