Log of autodoc.git/traditional_manual/chapter

2002-05-26

2002-05-26 00:46:29 by Martin Nilsson <mani@lysator.liu.se>

1f918f5afc4b64372e333bac897e2510a3da295d (8052 lines) (+1846/-6206) ^{[

Show
| Annotate

]}
Branch: 8.0

Added special functions chapter

Rev: refdoc/chapters/special_functions.xml:1.1
Rev: refdoc/structure/traditional.xml:1.15

1: <!doctype html><html><head><title>Pike Reference Manual</title> <meta charset='utf-8'></head> - <body><dl><dt><h1 class='header'>9. Image Module</h1></dt><dd><dl><dt><h2 class='header'>Class Image.Image</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - - The main object of the <code>Image</code> module, this object - is used as drawing area, mask or result of operations. + <body><dl><dt><h1 class='header'>9. Parsers</h1></dt><dd><dl><dt><h2 class='header'>Module Parser.XML</h2> + </dt><dd><dl><dt><h2 class='header'>Class Parser.XML.Simple</h2> + </dt><dd> - basic: - <code>clear</code>, - <code>clone</code>, - <code>create</code>, - <code>xsize</code>, - <code>ysize</code> - - plain drawing: - <code>box</code>, - <code>circle</code>, - <code>getpixel</code>, - <code>line</code>, - <code>setcolor</code>, - <code>setpixel</code>, - <code>threshold</code>, - <code>polyfill</code> - - operators: - <code>`&</code>, - <code>`*</code>, - <code>`+</code>, - <code>`-</code>, - <code>`==</code>, - <code>`></code>, - <code>`<</code>, - <code>`|</code> - - pasting images: - <code>paste</code>, - <code>paste_alpha</code>, - <code>paste_alpha_color</code>, - <code>paste_mask</code> - - getting subimages, scaling, rotating: - <code>autocrop</code>, - <code>clone</code>, - <code>copy</code>, - <code>dct</code>, - <code>mirrorx</code>, - <code>rotate</code>, - <code>rotate_ccw</code>, - <code>rotate_cw</code>, - <code>rotate_expand</code>, - <code>scale</code>, - <code>skewx</code>, - <code>skewx_expand</code>, - <code>skewy</code>, - <code>skewy_expand</code> - - calculation by pixels: - <code>apply_matrix</code>, - <code>change_color</code>, - <code>color</code>, - <code>distancesq</code>, - <code>grey</code>, - <code>invert</code>, - <code>modify_by_intensity</code>, - <code>outline</code> - <code>select_from</code>, - <code>rgb_to_hsv</code>, - <code>hsv_to_rgb</code>, - - <code>average</code>, - <code>max</code>, - <code>min</code>, - <code>sum</code>, - <code>sumf</code>, - <code>find_min</code>, - <code>find_max</code> - - special pattern drawing: - <code>noise</code>, - <code>turbulence</code>, - <code>test</code>, - <code>tuned_box</code>, - <code>gradients</code>, - <code>random</code> - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image</code>, <code>Image.Font</code>, <code>Image.Colortable</code>, <code>Image.X</code></dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `/ - Method - `% + allow_rxml_entities </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> / <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> / <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> / <code class='class'>value</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> % <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> % <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> % <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>void</code> allow_rxml_entities(<code class='datatype'>bool</code> <code class='argument'>yes_no</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Divides pixel values and creates a new image from the result or - the rest. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to divide with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>if specified as color or value, it will act as a whole - image of that color (or value). + - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - It isn't possible to do a modulo 256 either. (why?) - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`+</code>, <code>`|</code>, <code>`&amp;</code>, <code>`*</code>, <code>Image.Layer</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `& + autoconvert </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> & <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> & <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> & <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>string</code> autoconvert(<code class='datatype'>string</code> <code class='argument'>xml</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - makes a new image out of the minimum pixels values - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to compare with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}).</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`+</code>, <code>`|</code>, <code>`*</code>, <code>Image.Layer</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `* + define_entity </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> * <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> * <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> * <code class='class'>value</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> * <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>void</code> define_entity(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Multiplies pixel values and creates a new image. - This can be useful to lower the values of an image, - making it greyer, for instance: + - <pre>image=image*128+64;</pre> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to multiply with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`+</code>, <code>`|</code>, <code>`&amp;</code>, <code>Image.Layer</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `+ + define_entity_raw </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> + <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> + <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> + <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>void</code> define_entity_raw(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - adds two images; values are truncated at 255. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the image which to add.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}).</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`|</code>, <code>`&amp;</code>, <code>`*</code>, <code>Image.Layer</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `- + parse_dtd </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> - <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> - <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> - <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>mixed</code> parse_dtd(<code class='datatype'>string</code> <code class='argument'>dtd</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extras</code>)</code></dd> + </dl> + </dd></dl><dl><dt><h2 class='header'>Class Parser.XML.Validating</h2> + </dt><dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - makes a new image out of the difference - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to compare with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}).</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`+</code>, <code>`|</code>, <code>`&amp;</code>, <code>`*</code>, <code>Image.Layer</code>, <code>min</code>, <code>max</code>, <code>`==</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - `== - Method - `< - Method - `> + <dt class='head--type'>Inherit + Simple </dt> - <dd><code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> == <code class='class'>operand</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> == <code class='class'>color</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> == <code class='class'>value</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> < <code class='class'>operand</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> < <code class='class'>color</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> < <code class='class'>value</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> > <code class='class'>operand</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> > <code class='class'>color</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Image()</code> > <code class='class'>value</code></code></dd> + <dd><code>inherit Parser.XML.Simple : Simple</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Compares an image with another image or a color. + - Comparision is strict and on pixel-by-pixel basis. - (Means if not all pixel r,g,b values are - correct compared with the corresponding - pixel values, 0 is returned.) - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to compare with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}). - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - true (1) or false (0). - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - `< or `> on empty ("no image") image objects or images - with different size will result in an error. - `== is always true on two empty image objects and - always false if one and only one of the image objects - is empty or the images differs in size. - - a>=b and a<=b between objects is equal to !(a<b) and !(a>b), - which may not be what you want (since both < and > can return - false, comparing the same images). - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`+</code>, <code>`|</code>, <code>`*</code>, <code>`&amp;</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `| + parse </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> | <code class='class'>operand</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> | <code class='class'>color</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Image()</code> | <code class='class'>value</code></code></dd> + <dd><code><code class='datatype'>array</code> parse(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mapping</code>, <code class='datatype'>array</code>|<code class='datatype'>string</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>mixed</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function + </dd></dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - makes a new image out of the maximum pixels values - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>operand</code></dt> - <dd></dd><dd class='body--doc'>the other image to compare with; - the images must have the same size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd><dd class='body--doc'>an array in format ({r,g,b}), this is equal - to using an uniform-colored image.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>equal to ({value,value,value}).</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>`-</code>, <code>`+</code>, <code>`&amp;</code>, <code>`*</code>, <code>Image.Layer</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - apply_curve + parse_dtd </dt> - <dd><code><code class='object unresolved'>object </code> apply_curve(<code class='datatype'>object</code> <code class='argument'>array(int(0..255</code>)</code> - <code><code class='object unresolved'>object </code> apply_curve(<code class='datatype'>object</code> <code class='argument'>array(int(0..255</code>)</code> - <code><code class='object unresolved'>object </code> apply_curve(<code class='datatype'>object</code> <code class='argument'>stringchannel</code>, <code class='datatype'>object</code> <code class='argument'>array(int(0..255</code>)</code></dd> - + <dd><code><code class='datatype'>array</code> parse_dtd(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>function</code>(<code class='datatype'>string</code>, <code class='datatype'>string</code>, <code class='datatype'>mapping</code>, <code class='datatype'>array</code>|<code class='datatype'>string</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>mixed</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + <dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'>Document this function + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Module Parser.XML.NSTree</h2> + </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Apply a lookup-table on all pixels in an image. - If only one curve is passed, use the same curve for red, green and blue. - If 'channel' is specified, the curve is only applied to the - specified channel. + <dd class='body--doc'>A namespace aware version of Parser.XML.Tree. This implementation + does as little validation as possible, so e.g. you can call your + namespace xmlfoo without complaints. + </dd></dl> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>curve_r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>curve_g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>curve_b</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>curve</code></dt> - <dd></dd><dd class='body--doc'>An array with 256 elements, each between 0 and 255. - It is used as a look-up table, if the pixel value is 2 and - curve[2] is 10, the new pixel value will be 10. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>channel</code></dt> - <dd></dd><dd class='body--doc'>one of "red", "green", "blue", "value", "saturation" and "hue". - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>gamma</code>, <code>`*</code>, <code>modify_by_intensity</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - apply_matrix + <dt class='head--type'>Inherit + Tree </dt> - <dd><code><code class='object unresolved'>object </code> apply_matrix(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>)</code> - <code><code class='object unresolved'>object </code> apply_matrix(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> apply_matrix(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>div</code>)</code></dd> + <dd><code>inherit Parser.XML.Tree : Tree</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Applies a pixel-transform matrix, or filter, to the image. + - <pre> - 2 2 - pixel(x,y)= base+ k ( sum sum pixel(x+k-1,y+l-1)*matrix(k,l) ) - k=0 l=0 - </pre> - - 1/k is sum of matrix, or sum of matrix multiplied with div. - base is given by r,g,b and is normally black. - - <table><tr><td rowspan='2'> - blur (ie a 2d gauss function): - <pre> - ({({1,2,1}), - ({2,5,2}), - ({1,2,1})}) - </pre> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.1.png' width='80' /> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.2.png' width='80' /> - </td></tr> - <tr><td></td><td>original</td></tr> - - <tr><td> - sharpen (k>8, preferably 12 or 16): - <pre> - ({({-1,-1,-1}), - ({-1, k,-1}), - ({-1,-1,-1})}) - </pre> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.3.png' width='80' /> - </td></tr> - - <tr><td> - edge detect: - <pre> - ({({1, 1,1}), - ({1,-8,1}), - ({1, 1,1})}) - </pre> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.4.png' width='80' /> - </td></tr> - - <tr><td> - horisontal edge detect (get the idea): - <pre> - ({({0, 0,0}), - ({1,-2,1}), - ({0, 0,0})}) - </pre> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.5.png' width='80' /> - </td></tr> - - <tr><td rowspan='2'> - emboss (might prefer to begin with a <code>grey</code> image): - <pre> - ({({2, 1, 0}), - ({1, 0,-1}), - ({0,-1,-2})}), 128,128,128, 3 - </pre> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.6.png' width='80' /> - </td><td> - <img height='115' src='../images/predef.Image.Image.apply_matrix.7.png' width='80' /> - </td></tr> - <tr><td></td><td>greyed</td></tr></table> - - This function is not very fast. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>array</code></dt> - <dd></dd><dd class='body--doc'>the matrix; innermost is a value or an array with red, green, blue - values for red, green, blue separation.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>base level of result, default is zero</dd> - <dt class='head--doc'>Parameter <code class='parameter'>div</code></dt> - <dd></dd><dd class='body--doc'>division factor, default is 1.0.</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - apply_max + parse_input </dt> - <dd><code><code class='object unresolved'>object </code> apply_max(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>)</code> - <code><code class='object unresolved'>object </code> apply_max(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> apply_max(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>))) <code class='argument'>matrix</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>div</code>)</code></dd> + <dd><code><code class='object unresolved'>NSNode</code> parse_input(<code class='datatype'>string</code> <code class='argument'>data</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is the same as apply_matrix, but it uses the maximum - instead. - - This function is not very fast. - + <dd class='body--doc'>Takes a XML string <code>data</code> and produces a namespace node tree. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>array</code></dt> - <dd></dd><dd class='body--doc'>the matrix; innermost is a value or an array with red, green, blue - values for red, green, blue separation.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>base level of result, default is zero</dd> - <dt class='head--doc'>Parameter <code class='parameter'>div</code></dt> - <dd></dd><dd class='body--doc'>division factor, default is 1.0.</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - experimental status; may not be exact the same - output in later versions + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an <code>error</code> when an error is encountered during XML + parsing. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - autocrop - Method - find_autocrop + visualize </dt> - <dd><code><code class='object unresolved'>object </code> autocrop()</code> - <code><code class='object unresolved'>object </code> autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>)</code> - <code><code class='object unresolved'>object </code> autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>, <code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code> - <code><code class='object unresolved'>object </code> autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>, <code class='datatype'>int</code> <code class='argument'>left</code>, <code class='datatype'>int</code> <code class='argument'>right</code>, <code class='datatype'>int</code> <code class='argument'>top</code>, <code class='datatype'>int</code> <code class='argument'>bottom</code>)</code> - <code><code class='object unresolved'>object </code> autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>, <code class='datatype'>int</code> <code class='argument'>left</code>, <code class='datatype'>int</code> <code class='argument'>right</code>, <code class='datatype'>int</code> <code class='argument'>top</code>, <code class='datatype'>int</code> <code class='argument'>bottom</code>, <code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_autocrop()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_autocrop(<code class='datatype'>int</code> <code class='argument'>border</code>, <code class='datatype'>int</code> <code class='argument'>left</code>, <code class='datatype'>int</code> <code class='argument'>right</code>, <code class='datatype'>int</code> <code class='argument'>top</code>, <code class='datatype'>int</code> <code class='argument'>bottom</code>)</code></dd> + <dd><code><code class='datatype'>string</code> visualize(<code class='object unresolved'>Node</code> <code class='argument'>n</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>indent</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Removes "unneccesary" borders around the image, adds one of - its own if wanted to, in selected directions. - - "Unneccesary" is all pixels that are equal -- ie if all the same pixels - to the left are the same color, that column of pixels are removed. - - The find_autocrop() function simply returns x1,y1,x2,y2 for the - kept area. (This can be used with <code>copy</code> later.) - + <dd class='body--doc'>Makes a visualization of a node graph suitable for + printing out on a terminal. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>border</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>left</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>right</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>top</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>bottom</code></dt> - <dd></dd><dd class='body--doc'>which borders to scan and cut the image; - a typical example is removing the top and bottom unneccesary - pixels: - <pre>img=img->autocrop(0, 0,0,1,1);</pre> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>copy</code></dd></dl> + <dt class='head--doc'>Example</dt> + <dd class='example'><pre>> object x = parse_input("<a><c/>d<e/><f>g</f></a>"); + > write(visualize(x)); + Node(ROOT) + NSNode(ELEMENT,"a") + NSNode(ELEMENT,"b") + NSNode(ELEMENT,"c") + NSNode(TEXT) + NSNode(ELEMENT,"b") + NSNode(ELEMENT,"e") + NSNode(ELEMENT,"f") + NSNode(TEXT) + Result 1: 201 + </pre></dd></dl> + <dl><dt><h2 class='header'>Class Parser.XML.NSTree.NSNode</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Namespace aware node. + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - average - Method - min - Method - max - Method - sum - Method - sumf + diff_namespaces </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>float</code>) average()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) min()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) max()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) sum()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>float</code>) sumf()</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) diff_namespaces()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives back the average, minimum, maximum color value, - and the sum of all pixel's color value. - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - sum() values can wrap! Most systems only have 31 bits - available for positive integers. (Meaning, be careful - with images that have more than 8425104 pixels.) - - average() and sumf() may also wrap, but on a line basis. - (Meaning, be careful with images that are wider - than 8425104 pixels.) These functions may have a precision - problem instead, during to limits in the 'double' C type and/or - 'float' Pike type. + <dd class='body--doc'>Returns the difference between this nodes and its parents namespaces. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - bitscale + get_default_ns </dt> - <dd><code><code class='object unresolved'>object </code> bitscale(<code class='datatype'>float</code> <code class='argument'>factor</code>)</code> - <code><code class='object unresolved'>object </code> bitscale(<code class='datatype'>float</code> <code class='argument'>xfactor</code>, <code class='datatype'>float</code> <code class='argument'>yfactor</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_default_ns()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - scales the image with a factor, without smoothing. - This routine is faster than scale, but gives less correct - results - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>factor</code></dt> - <dd></dd><dd class='body--doc'>factor to use for both x and y</dd> - <dt class='head--doc'>Parameter <code class='parameter'>xfactor</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>yfactor</code></dt> - <dd></dd><dd class='body--doc'>separate factors for x and y - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Returns the default namespace in the current scope. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - bitscale + get_defined_nss </dt> - <dd><code><code class='object unresolved'>object </code> bitscale(<code class='datatype'>int</code> <code class='argument'>newxsize</code>, <code class='datatype'>int</code> <code class='argument'>newysize</code>)</code> - <code><code class='object unresolved'>object </code> bitscale(<code class='argument'>0</code>, <code class='datatype'>int</code> <code class='argument'>newysize</code>)</code> - <code><code class='object unresolved'>object </code> bitscale(<code class='datatype'>int</code> <code class='argument'>newxsize</code>, <code class='argument'>0</code>)</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) get_defined_nss()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - scales the image to a specified new size, - if one of newxsize or newysize is 0, - the image aspect ratio is preserved. + <dd class='body--doc'>Returns a mapping with all the namespaces defined in the current + scope, except the default namespace. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>newxsize</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>newysize</code></dt> - <dd></dd><dd class='body--doc'>new image size in pixels - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> + <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - resulting image will be 1x1 pixels, at least + <dd class='body--doc'>The return mapping is the same as the one in the node, so + destructive changes will affect the node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - box + get_ns </dt> - <dd><code><code class='object unresolved'>object </code> box(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>)</code> - <code><code class='object unresolved'>object </code> box(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> box(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_ns()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws a filled rectangle on the image. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.box.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.box.2.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->box (40,10, 10,80, 0,255,0)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>x2</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y2</code></dt> - <dd></dd><dd class='body--doc'>box corners</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color of the box</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>alpha value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called + <dd class='body--doc'>Returns the namespace in which the current element is defined in. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + get_ns_attributes </dt> - <dd><code>(int)Image.Image() (float)Image.Image() (string)Image.Image() (array)Image.Image() (mapping)Image.Image() (multiset)Image.Image()</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>)) get_ns_attributes()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Cast the image to another datatype. Currently supported - are string ("rgbrgbrgb...") and array (double array - of <code>Image.Color</code> objects). - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image.Color</code>, <code>Image.X</code></dd></dl> + <dd class='body--doc'>Returns all the attributes in all namespaces that is associated with + this node. + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - change_color + get_ns_attributes </dt> - <dd><code><code class='object unresolved'>object </code> change_color(<code class='datatype'>int</code> <code class='argument'>tor</code>, <code class='datatype'>int</code> <code class='argument'>tog</code>, <code class='datatype'>int</code> <code class='argument'>tob</code>)</code> - <code><code class='object unresolved'>object </code> change_color(<code class='datatype'>int</code> <code class='argument'>fromr</code>, <code class='datatype'>int</code> <code class='argument'>fromg</code>, <code class='datatype'>int</code> <code class='argument'>fromb</code>, <code class='datatype'>object</code> <code class='argument'>inttor</code>, <code class='datatype'>int</code> <code class='argument'>tog</code>, <code class='datatype'>int</code> <code class='argument'>tob</code>)</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) get_ns_attributes(<code class='datatype'>string</code> <code class='argument'>namespace</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Changes one color (exakt match) to another. - If non-exakt-match is preferred, check <code>distancesq</code> - and <code>paste_alpha_color</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>tor</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>tog</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>tob</code></dt> - <dd></dd><dd class='body--doc'>destination color and next current color</dd> - <dt class='head--doc'>Parameter <code class='parameter'>fromr</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>fromg</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>fromb</code></dt> - <dd></dd><dd class='body--doc'>source color, default is current color</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new (the destination) image object + <dd class='body--doc'>Returns the attributes in this node that is declared in the provided + namespace. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - circle + get_xml_name </dt> - <dd><code><code class='object unresolved'>object </code> circle(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>rx</code>, <code class='datatype'>int</code> <code class='argument'>ry</code>)</code> - <code><code class='object unresolved'>object </code> circle(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>rx</code>, <code class='datatype'>int</code> <code class='argument'>ry</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> circle(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>rx</code>, <code class='datatype'>int</code> <code class='argument'>ry</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_xml_name()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws a circle on the image. The circle is not antialiased. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.circle.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.circle.2.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->circle (50,50, 30,50, 0,255,255)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>circle center</dd> - <dt class='head--doc'>Parameter <code class='parameter'>rx</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ry</code></dt> - <dd></dd><dd class='body--doc'>circle radius in pixels</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>alpha value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called + <dd class='body--doc'>Returns the element name as it occurs in xml files. E.g. + "zonk:name" for the element "name" defined in a namespace + denoted with "zonk". It will look up a symbol for the namespace + in the symbol tables for the node and its parents. If none is + found a new label will be generated by hashing the namespace. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - clear + <dt class='head--type'>Inherit + Node </dt> - <dd><code><code class='object unresolved'>void </code> clear()</code> - <code><code class='object unresolved'>void </code> clear(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>void </code> clear(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code>inherit Node : Node</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - gives a new, cleared image with the same size of drawing area + - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.clear.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.clear.2.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->clear (0,128,255)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color of the new image</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>new default alpha channel value</dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>copy</code>, <code>clone</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - clone + remove_child </dt> - <dd><code><code class='object unresolved'>object </code> clone()</code> - <code><code class='object unresolved'>object </code> clone(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code> - <code><code class='object unresolved'>object </code> clone(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> clone(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>void</code> remove_child(<code class='object unresolved'>NSNode</code> <code class='argument'>child</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Copies to or initialize a new image object. + <dd class='body--doc'>The remove_child is a not updated to take care of name + space issues. To properly remove all the parents name spaces + from the chid, call <code>remove_node</code> in the child. + </dd></dl> + </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Parser.XML.Tree</h2> + </dt><dd> - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.clone.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.clone.2.png' width='80' /></td> - <td><img height='50' src='../images/predef.Image.Image.clone.3.png' width='50' /></td> - </tr><tr> - <td>original</td> - <td>clone</td> - <td>clone(50,50)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>xsize</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ysize</code></dt> - <dd></dd><dd class='body--doc'>size of (new) image in pixels, called image - is cropped to that size</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>current color of the new image, - default is black. - Will also be the background color if the cloned image - is empty (no drawing area made).</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>new default alpha channel value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>copy</code>, <code>create</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - color + <dt class='head--type'>Constant + STOP_WALK </dt> - <dd><code><code class='object unresolved'>object </code> color()</code> - <code><code class='object unresolved'>object </code> color(<code class='datatype'>int</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>object </code> color(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>STOP_WALK</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Colorize an image. + - The red, green and blue values of the pixels are multiplied - with the given value(s). This works best on a grey image... - - The result is divided by 255, giving correct pixel values. - - If no arguments are given, the current color is used as factors. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.color.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.color.2.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->color(128,128,255);</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>red, green, blue factors</dd> - <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> - <dd></dd><dd class='body--doc'>factor - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>grey</code>, <code>`*</code>, <code>modify_by_intensity</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - copy + <dt class='head--type'>Constant + XML_ATTR </dt> - <dd><code><code class='object unresolved'>object </code> copy()</code> - <code><code class='object unresolved'>object </code> copy(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>)</code> - <code><code class='object unresolved'>object </code> copy(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> copy(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ATTR</code></code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Copies this part of the image. The requested area can - be smaller, giving a cropped image, or bigger - - the new area will be filled with the given or current color. + <dd class='body--doc'>Attribute nodes are created on demand + </dd></dl> - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.copy.1.png' width='80' /></td> - <td><img height='105' src='../images/predef.Image.Image.copy.2.png' width='70' /></td> - <td><img height='125' src='../images/predef.Image.Image.copy.3.png' width='90' /></td> - </tr><tr> - <td>original</td> - <td>->copy (5,5, XSIZE-6,YSIZE-6)</td> - <td>->copy (-5,-5, XSIZE+4,YSIZE+4, 10,75,10)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>x2</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y2</code></dt> - <dd></dd><dd class='body--doc'>The requested new area. Default is the old image size.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color of the new image</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>new default alpha channel value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - <code>clone</code>(void) and <code>copy</code>(void) does the same - operation - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>clone</code>, <code>autocrop</code></dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - create + <dt class='head--type'>Constant + XML_COMMENT </dt> - <dd><code>Image.Image Image.Image()</code> - <code>Image.Image Image.Image(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code> - <code>Image.Image Image.Image(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code> - <code>Image.Image Image.Image(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code>Image.Image Image.Image(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code> - <code>Image.Image Image.Image(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>string</code> <code class='argument'>method</code>, <code class='object unresolved'>method</code> <code class='argument'>...</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_COMMENT</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Initializes a new image object. + - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.create.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.create.2.png' width='80' /></td> - </tr><tr> - <td>Image.Image (XSIZE,YSIZE)</td> - <td>Image.Image (XSIZE,YSIZE,255,128,0)</td> - </tr></table> - - The image can also be calculated from some special methods, - for convinience: - - <pre> - channel modes; followed by a number of 1-char-per-pixel strings - or image objects (where red channel will be used), - or an integer value: - "grey" : make a grey image (needs 1 source: grey) - "rgb" : make an rgb image (needs 3 sources: red, green and blue) - "cmyk" : make a rgb image from cmyk (cyan, magenta, yellow, black) - - generate modes; all extra arguments is given to the - generation function. These has the same name as the method: - "<ref>test</ref>," - "<ref>gradients</ref>" - "<ref>noise</ref>" - "<ref>turbulence</ref>" - "<ref>random</ref>" - "<ref>randomgrey</ref>" - specials cases: - "<ref>tuned_box</ref>" (coordinates is automatic) - </pre> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>xsize</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ysize</code></dt> - <dd></dd><dd class='body--doc'>size of (new) image in pixels</dd> - <dt class='head--doc'>Parameter <code class='parameter'>color</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>background color (will also be current color), - default color is black</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>default alpha channel value</dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'> - SIGSEGVS can be caused if the size is too big, due - to unchecked overflow - - (xsize*ysize)&MAXINT is small enough to allocate. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>copy</code>, <code>clone</code>, <code>Image.Image</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - dct + <dt class='head--type'>Constant + XML_DOCTYPE </dt> - <dd><code><code class='object unresolved'>object </code> dct(<code class='datatype'>int</code> <code class='argument'>newx</code>, <code class='datatype'>int</code> <code class='argument'>newy</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_DOCTYPE</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Scales the image to a new size. + - Method for scaling is rather complex; - the image is transformed via a cosine transform, - and then resampled back. - - This gives a quality-conserving upscale, - but the algorithm used is n*n+n*m, where n - and m is pixels in the original and new image. - - Recommended wrapping algorithm is to scale - overlapping parts of the image-to-be-scaled. - - This functionality is actually added as an - true experiment, but works... - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>newx</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>newy</code></dt> - <dd></dd><dd class='body--doc'>new image size in pixels - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Do NOT use this function if you don't know what - you're dealing with! Read some signal theory first... - - It write's dots on stderr, to indicate some sort - of progress. It doesn't use any fct (compare: fft) - algorithms. - </dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - distancesq + <dt class='head--type'>Constant + XML_ELEMENT </dt> - <dd><code><code class='object unresolved'>object </code> distancesq()</code> - <code><code class='object unresolved'>object </code> distancesq(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ELEMENT</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Makes an grey-scale image, for alpha-channel use. + - The given value (or current color) are used for coordinates - in the color cube. Each resulting pixel is the - distance from this point to the source pixel color, - in the color cube, squared, rightshifted 8 steps: - - <pre> - p = pixel color - o = given color - d = destination pixel - d.red=d.blue=d.green= - ((o.red-p.red)²+(o.green-p.green)²+(o.blue-p.blue)²)>>8 - </pre> - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.distancesq.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.distancesq.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.distancesq.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.distancesq.4.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>distance² to cyan</td> - <td>...to purple</td> - <td>...to yellow</td> - </tr></table> - - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>red, green, blue coordinates - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>select_from</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - find_min - Method - find_max + <dt class='head--type'>Constant + XML_HEADER </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_min()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_max()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_min(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_max(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_HEADER</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives back the position of the minimum or maximum - pixel value, weighted to grey. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>weight of color, default is r=87,g=127,b=41, same - as the <code>grey</code>() method.</dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - gamma + <dt class='head--type'>Constant + XML_NODE </dt> - <dd><code><code class='object unresolved'>object </code> gamma(<code class='datatype'>float</code> <code class='argument'>g</code>)</code> - <code><code class='object unresolved'>object </code> gamma(<code class='datatype'>float</code> <code class='argument'>gred</code>, <code class='datatype'>object</code> <code class='argument'>floatggreen</code>, <code class='datatype'>object</code> <code class='argument'>floatgblue</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> Parser.XML.Tree.<code class='constant'>XML_NODE</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Calculate pixels in image by gamma curve. + - Intensity of new pixels are calculated by: - i' = i^g - - For example, you are viewing your image on a screen - with gamma 2.2. To correct your image to the correct - gamma value, do something like: - - <tt>my_display_image(my_image()->gamma(1/2.2);</tt> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>gred</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ggreen</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>gblue</code></dt> - <dd></dd><dd class='body--doc'>gamma value - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>grey</code>, <code>`*</code>, <code>color</code></dd></dl> - - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - getpixel + <dt class='head--type'>Constant + XML_PI </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) getpixel(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_PI</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>position of the pixel</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - color of the requested pixel -- ({int red,int green,int blue}) - </dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - gradients + <dt class='head--type'>Constant + XML_ROOT </dt> - <dd><code><code class='object unresolved'>int </code> gradients(<code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>point</code>, <code class='datatype'>object</code> <code class='argument'>...</code>)</code> - <code><code class='object unresolved'>int </code> gradients(<code class='datatype'>array</code>(<code class='datatype'>int</code>) <code class='argument'>point</code>, <code class='datatype'>object</code> <code class='argument'>...</code>, <code class='datatype'>object</code> <code class='argument'>floatgrad</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_ROOT</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.gradients.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.gradients.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.gradients.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.gradients.4.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.gradients.5.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.gradients.6.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>2 color gradient</td> - <td>10 color gradient</td> - <td>3 colors, grad=4.0</td> - <td>3 colors, grad=1.0</td> - <td>3 colors, grad=0.25</td> - </tr></table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image - </dd></dl> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - grey + <dt class='head--type'>Constant + XML_TEXT </dt> - <dd><code><code class='object unresolved'>object </code> grey()</code> - <code><code class='object unresolved'>object </code> grey(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Parser.XML.Tree.<code class='constant'>XML_TEXT</code></code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Makes a grey-scale image (with weighted values). + - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.grey.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.grey.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.grey.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->grey();</td> - <td>->grey(0,0,255);</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>weight of color, default is r=87,g=127,b=41, - which should be pretty accurate of what the eyes see... - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>color</code>, <code>`*</code>, <code>modify_by_intensity</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rgb_to_hsv - Method - hsv_to_rgb + parse_file </dt> - <dd><code><code class='object unresolved'>object </code> rgb_to_hsv()</code> - <code><code class='object unresolved'>object </code> hsv_to_rgb()</code></dd> + <dd><code><code class='object unresolved'>Node</code> parse_file(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Converts RGB data to HSV data, or the other way around. - When converting to HSV, the resulting data is stored like this: - pixel.r = h; pixel.g = s; pixel.b = v; - - When converting to RGB, the input data is asumed to be placed in - the pixels as above. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.rgb_to_hsv.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.rgb_to_hsv.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.rgb_to_hsv.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->hsv_to_rgb();</td> - <td>->rgb_to_hsv();</td> - </tr><tr valign='center'> - <td></td> - <td></td> - <td></td> - </tr><tr valign='center'> - <td>tuned box (below)</td> - <td>the rainbow (below)</td> - <td>same, but rgb_to_hsv()</td> - </tr></table> - - - HSV to RGB calculation: - <pre> - in = input pixel - out = destination pixel - h=-pos*c_angle*3.1415/(float)NUM_SQUARES; - out.r=(in.b+in.g*cos(in.r)); - out.g=(in.b+in.g*cos(in.r + pi*2/3)); - out.b=(in.b+in.g*cos(in.r + pi*4/3)); - </pre> - - RGB to HSV calculation: Hmm. - <pre> - </pre> - - Example: Nice rainbow. - <pre> - object i = Image.Image(200,200); - i = i->tuned_box(0,0, 200,200, - ({ ({ 255,255,128 }), ({ 0,255,128 }), - ({ 255,255,255 }), ({ 0,255,255 })})) - ->hsv_to_rgb(); - </pre> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Loads the XML file <code>path</code>, creates a node tree representation and + returns the root node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - invert + parse_input </dt> - <dd><code><code class='object unresolved'>object </code> invert()</code></dd> + <dd><code><code class='object unresolved'>Node</code> parse_input(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>no_fallback</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>force_lowercase</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Invert an image. Each pixel value gets to be 255-x, where x - is the old value. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.invert.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.invert.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.invert.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->invert();</td> - <td>->rgb_to_hsv()->invert()->hsv_to_rgb();</td> - </tr></table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Takes a XML string and produces a node tree. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - line + parse_xml_callback </dt> - <dd><code><code class='object unresolved'>object </code> line(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>)</code> - <code><code class='object unresolved'>object </code> line(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> line(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>mixed</code> parse_xml_callback(<code class='datatype'>string</code> <code class='argument'>type</code>, <code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code>|<code class='datatype'>array</code> <code class='argument'>contents</code>, <code class='datatype'>mixed</code> <code class='argument'>location</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra</code>)</code></dd> + </dl> + <dl><dt><h2 class='header'>Class Parser.XML.Tree.AbstractNode</h2> + </dt><dd> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws a line on the image. The line is not antialiased. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.line.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.line.2.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->line (50,10, 10,50, 255,0,0)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>x2</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y2</code></dt> - <dd></dd><dd class='body--doc'>line endpoints</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>alpha value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - make_ascii + `[] </dt> - <dd><code><code class='object unresolved'>string </code> make_ascii(<code class='datatype'>object</code> <code class='argument'>orient1</code>, <code class='datatype'>object</code> <code class='argument'>objectorient2</code>, <code class='datatype'>object</code> <code class='argument'>objectorient3</code>, <code class='datatype'>object</code> <code class='argument'>objectorient4</code>, <code class='datatype'>object</code> <code class='argument'>int|voidxsize</code>, <code class='datatype'>object</code> <code class='argument'>int|voidysize</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> res = <code class='class'>Parser.XML.Tree.AbstractNode()</code>[ <code class='class'>pos</code> ]</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This method creates a string that looks like - the image. Example: - <pre> - //Stina is an image with a cat. - array(object) Stina4=Stina->orient4(); - Stina4[1]*=215; - Stina4[3]*=215; - string foo=Stina->make_ascii(@Stina4,40,4,8); - </pre> - + <dd class='body--doc'>The [] operator indexes among the node children, so + <code class='expr'>node[0]</code> returns the first node and <code class='expr'>node[-1]</code> the last. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - some nice acsii-art. - </dd> + <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - experimental status; may not be exact the same - output in later versions - <pre> | / - \ - hue= 0 64 128 192 (=red in an hsv image) - </pre> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>orient</code>, <code>orient4</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - map_closest - Method - map_fast - Method - map_fs - Method - select_colors - </dt> - <dd><code><code class='object unresolved'>object </code> map_closest(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colors</code>)</code> - <code><code class='object unresolved'>object </code> map_fast(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colors</code>)</code> - <code><code class='object unresolved'>object </code> map_fs(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colors</code>)</code> - <code><code class='object unresolved'>array </code> select_colors(<code class='datatype'>int</code> <code class='argument'>num</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Compatibility functions. Do not use! - - Replacement examples: - - Old code: - <pre>img=map_fs(img->select_colors(200));</pre> - New code: - <pre>img=Image.Colortable(img,200)->floyd_steinberg()->map(img);</pre> - - Old code: - <pre>img=map_closest(img->select_colors(17)+({({255,255,255}),({0,0,0})}));</pre> - New code: - <pre>img=Image.Colortable(img,19,({({255,255,255}),({0,0,0})}))->map(img);</pre> + <dd class='body--doc'>The [] operator will select a node from all the nodes children, + not just its element children. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - match + add_child </dt> - <dd><code><code class='object unresolved'>object </code> match(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle</code>)</code> - <code><code class='object unresolved'>object </code> match(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle</code>, <code class='datatype'>object</code> <code class='argument'>objecthaystack_cert</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle_cert</code>)</code> - <code><code class='object unresolved'>object </code> match(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle</code>, <code class='datatype'>object</code> <code class='argument'>objecthaystack_avoid</code>, <code class='datatype'>object</code> <code class='argument'>intfoo</code>)</code> - <code><code class='object unresolved'>object </code> match(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle</code>, <code class='datatype'>object</code> <code class='argument'>objecthaystack_cert</code>, <code class='datatype'>object</code> <code class='argument'>objectneedle_cert</code>, <code class='datatype'>object</code> <code class='argument'>objecthaystack_avoid</code>, <code class='datatype'>object</code> <code class='argument'>intfoo</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> add_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>c</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This method creates an image that describes the - match in every pixel in the image and the - needle-Image. - - <pre> - new pixel value = - sum( my_abs(needle_pixel-haystack_pixel)) - </pre> - - The new image only have the red rgb-part set. - - + <dd class='body--doc'>Adds a child node to this node. The child node is + added last in the child list and its parent reference + is updated. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>scale</code></dt> - <dd></dd><dd class='body--doc'>Every pixel is divided with this value. - Note that a proper value here depends on - the size of the neadle. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>needle</code></dt> - <dd></dd><dd class='body--doc'>The image to use for the matching. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>haystack_cert</code></dt> - <dd></dd><dd class='body--doc'>This image should be the same size as - the image itselves. A non-white-part of the - haystack_cert-image modifies the output - by lowering it. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>needle_cert</code></dt> - <dd></dd><dd class='body--doc'>The same, but for the needle-image. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>foo</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>haystack_avoid</code></dt> - <dd></dd><dd class='body--doc'>This image should be the same size as - the image itselves. If foo is less than the red - value in haystack_avoid the corresponding - matching-calculating is not calculated. The avoided parts - are drawn in the color 0,100,0. - </dd> + <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - experimental status; may not be exact the same - output in later versions - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>phasev</code>, <code>phaseh</code></dd></dl> + <dd class='body--doc'>The updated child node is returned. + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - mirrorx + clone </dt> - <dd><code><code class='object unresolved'>object </code> mirrorx()</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> clone(<code class='datatype'>void</code>|<code class='datatype'>int(-1..1)</code> <code class='argument'>direction</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - mirrors an image: - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.mirrorx.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.mirrorx.2.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->mirrorx();</td> - </tr></table> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Returns the corresponding node in a clone of the tree. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - mirrory + count_children </dt> - <dd><code><code class='object unresolved'>object </code> mirrory()</code></dd> + <dd><code><code class='datatype'>int</code> count_children()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - mirrors an image: - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.mirrory.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.mirrory.2.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->mirrory();</td> - </tr></table> - + <dd class='body--doc'>Returns the number of children of the node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - modify_by_intensity + get_ancestors </dt> - <dd><code><code class='object unresolved'>object </code> modify_by_intensity(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>) ... <code class='argument'>vn</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_ancestors(<code class='datatype'>bool</code> <code class='argument'>include_self</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Recolor an image from intensity values. + <dd class='body--doc'>Returns a list of all ancestors, with the top node last. + The list will start with this node if <code>include_self</code> is set. + </dd></dl> - For each color an intensity is calculated, from r, g and b factors - (see <code>grey</code>), this gives a value between 0 and max. + - The color is then calculated from the values given, v1 representing - the intensity value of 0, vn representing max, and colors between - representing intensity values between, linear. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.modify_by_intensity.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.modify_by_intensity.2.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->grey()->modify_by_intensity(1,0,0, 0,({255,0,0}),({0,255,0}));</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>red, green, blue intensity factors</dd> - <dt class='head--doc'>Parameter <code class='parameter'>v1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>vn</code></dt> - <dd></dd><dd class='body--doc'>destination color - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>grey</code>, <code>`*</code>, <code>color</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - noise + get_children </dt> - <dd><code><code class='object unresolved'>void </code> noise(<code class='datatype'>array</code>(<code class='datatype'>float</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colorrange</code>)</code> - <code><code class='object unresolved'>void </code> noise(<code class='datatype'>array</code>(<code class='datatype'>float</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colorrange</code>, <code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>float</code> <code class='argument'>xdiff</code>, <code class='datatype'>float</code> <code class='argument'>ydiff</code>, <code class='datatype'>float</code> <code class='argument'>cscale</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_children()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives a new image with the old image's size, - filled width a 'noise' pattern. + <dd class='body--doc'>Returns all the nodes children. + </dd></dl> - The random seed may be different with each instance of pike. + - Example: - <tt>->noise( ({0,({255,0,0}), 0.3,({0,255,0}), 0.6,({0,0,255}), 0.8,({255,255,0})}), 0.2,0.0,0.0,1.0 );</tt> - <img height='100' src='../images/predef.Image.Image.noise.1.png' width='200' /> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>colorrange</code></dt> - <dd></dd><dd class='body--doc'>colorrange table</dd> - <dt class='head--doc'>Parameter <code class='parameter'>scale</code></dt> - <dd></dd><dd class='body--doc'>default value is 0.1</dd> - <dt class='head--doc'>Parameter <code class='parameter'>xdiff</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ydiff</code></dt> - <dd></dd><dd class='body--doc'>default value is 0,0</dd> - <dt class='head--doc'>Parameter <code class='parameter'>cscale</code></dt> - <dd></dd><dd class='body--doc'>default value is 1</dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>turbulence</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - orient - Method - orient4 + get_descendants </dt> - <dd><code><code class='object unresolved'>object </code> orient(<code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>object</code>) <code class='argument'>something</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>object</code>) orient4()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_descendants(<code class='datatype'>bool</code> <code class='argument'>include_self</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws images describing the orientation - of the current image. - - <tt>orient</tt> gives an HSV image - (run a <code>hsv_to_rgb</code> pass on it - to get a viewable image). - corresponding to the angle of the - orientation: - <pre> | / - \ - hue= 0 64 128 192 (=red in an hsv image) - purple cyan green red - </pre> - Red, green and blue channels are added - and not compared separately. - - If you first use orient4 you can give its - output as input to this function. - - The <tt>orient4</tt> function gives back - 4 image objects, corresponding to the - amount of different directions, see above. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - an image or an array of the four new image objects - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - experimental status; may not be exact the same - output in later versions + <dd class='body--doc'>Returns a list of all descendants in document order. Includes + this node if <code>include_self</code> is set. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - outline - Method - outline_mask + get_following </dt> - <dd><code><code class='object unresolved'>object </code> outline()</code> - <code><code class='object unresolved'>object </code> outline(<code class='datatype'>int</code> <code class='argument'>olr</code>, <code class='datatype'>int</code> <code class='argument'>olg</code>, <code class='datatype'>int</code> <code class='argument'>olb</code>)</code> - <code><code class='object unresolved'>object </code> outline(<code class='datatype'>int</code> <code class='argument'>olr</code>, <code class='datatype'>int</code> <code class='argument'>olg</code>, <code class='datatype'>int</code> <code class='argument'>olb</code>, <code class='datatype'>int</code> <code class='argument'>bkgr</code>, <code class='datatype'>int</code> <code class='argument'>bkgg</code>, <code class='datatype'>int</code> <code class='argument'>bkgb</code>)</code> - <code><code class='object unresolved'>object </code> outline(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>mask</code>)</code> - <code><code class='object unresolved'>object </code> outline(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>olr</code>, <code class='datatype'>int</code> <code class='argument'>olg</code>, <code class='datatype'>int</code> <code class='argument'>olb</code>)</code> - <code><code class='object unresolved'>object </code> outline(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>olr</code>, <code class='datatype'>int</code> <code class='argument'>olg</code>, <code class='datatype'>int</code> <code class='argument'>olb</code>, <code class='datatype'>int</code> <code class='argument'>bkgr</code>, <code class='datatype'>int</code> <code class='argument'>bkgg</code>, <code class='datatype'>int</code> <code class='argument'>bkgb</code>)</code> - <code><code class='object unresolved'>object </code> outline_mask()</code> - <code><code class='object unresolved'>object </code> outline_mask(<code class='datatype'>int</code> <code class='argument'>bkgr</code>, <code class='datatype'>int</code> <code class='argument'>bkgg</code>, <code class='datatype'>int</code> <code class='argument'>bkgb</code>)</code> - <code><code class='object unresolved'>object </code> outline_mask(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>mask</code>)</code> - <code><code class='object unresolved'>object </code> outline_mask(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>bkgr</code>, <code class='datatype'>int</code> <code class='argument'>bkgg</code>, <code class='datatype'>int</code> <code class='argument'>bkgb</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_following()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Makes an outline of this image, ie paints with the - given color around the non-background pixels. - - Default is to paint above, below, to the left and the right of - these pixels. - - You can also run your own outline mask. - - The outline_mask function gives the calculated outline as an - alpha channel image of white and black instead. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.outline.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.outline.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.outline.3.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>masked through threshold</td> - <td>...and outlined with red</td> - </tr></table> - - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mask</code></dt> - <dd></dd><dd class='body--doc'>mask matrix. Default is <tt>({({0,1,0}),({1,1,1}),({0,1,0})})</tt>.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>olr</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>olg</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>olb</code></dt> - <dd></dd><dd class='body--doc'>outline color. Default is current.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>bkgr</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>bkgg</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>bkgb</code></dt> - <dd></dd><dd class='body--doc'>background color (what color to outline to); - default is color of pixel 0,0.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>div</code></dt> - <dd></dd><dd class='body--doc'>division factor, default is 1.0. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - no antialias! + <dd class='body--doc'>Returns all the nodes that follows after the current one. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - paste + get_following_siblings </dt> - <dd><code><code class='object unresolved'>object </code> paste(<code class='datatype'>object</code> <code class='argument'>image</code>)</code> - <code><code class='object unresolved'>object </code> paste(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_following_siblings()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Pastes a given image over the current image. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>image</code></dt> - <dd></dd><dd class='body--doc'>image to paste (may be empty, needs to be an image object)</dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>where to paste the image; default is 0,0 - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>paste_mask</code>, <code>paste_alpha</code>, <code>paste_alpha_color</code></dd></dl> + <dd class='body--doc'>Returns all following siblings, i.e. all siblings present after this node + in the parents children list. + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - paste_alpha + get_last_child </dt> - <dd><code><code class='object unresolved'>object </code> paste_alpha(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> get_last_child()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Pastes a given image over the current image, with - the specified alpha channel value. + <dd class='body--doc'>Returns the last childe node or zero. + </dd></dl> - An alpha channel value of 0 leaves nothing of the original - image in the paste area, 255 is meaningless and makes the - given image invisible. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>image</code></dt> - <dd></dd><dd class='body--doc'>image to paste</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>alpha channel value</dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>where to paste the image; default is 0,0 - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>paste_mask</code>, <code>paste</code>, <code>paste_alpha_color</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - paste_alpha_color + get_parent </dt> - <dd><code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code> - <code><code class='object unresolved'>object </code> paste_alpha_color(<code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='object unresolved'>Color</code> <code class='argument'>color</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> get_parent()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Pastes a given color over the current image, - using the given mask as opaque channel. + <dd class='body--doc'>Returns the parent node. + </dd></dl> - A pixel value of 255 makes the result become the color given, - 0 doesn't change anything. + - The masks red, green and blue values are used separately. - If no color are given, the current is used. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mask</code></dt> - <dd></dd><dd class='body--doc'>mask image</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>what color to paint with; default is current</dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>where to paste the image; default is 0,0 - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>paste_mask</code>, <code>paste_alpha</code>, <code>paste_alpha_color</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - paste_mask + get_preceding </dt> - <dd><code><code class='object unresolved'>object </code> paste_mask(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>object</code> <code class='argument'>mask</code>)</code> - <code><code class='object unresolved'>object </code> paste_mask(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>object</code> <code class='argument'>mask</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_preceding()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Pastes a given image over the current image, - using the given mask as opaque channel. + <dd class='body--doc'>Returns all preceding nodes, excluding this nodes ancestors. + </dd></dl> - A pixel value of 255 makes the result become a pixel - from the given image, 0 doesn't change anything. + - The masks red, green and blue values are used separately. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>image</code></dt> - <dd></dd><dd class='body--doc'>image to paste</dd> - <dt class='head--doc'>Parameter <code class='parameter'>mask</code></dt> - <dd></dd><dd class='body--doc'>mask image</dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>where to paste the image; default is 0,0 - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>paste</code>, <code>paste_alpha</code>, <code>paste_alpha_color</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - phaseh - Method - phasev - Method - phasevh - Method - phasehv + get_preceding_siblings </dt> - <dd><code><code class='object unresolved'>object </code> phaseh()</code> - <code><code class='object unresolved'>object </code> phasev()</code> - <code><code class='object unresolved'>object </code> phasevh()</code> - <code><code class='object unresolved'>object </code> phasehv()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_preceding_siblings()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws images describing the phase - of the current image. phaseh gives the - horizontal phase and phasev the vertical - phase. - - <tt>phaseh</tt> gives an image - where - <pre> - max falling min rising - value= 0 64 128 192 - </pre> - - 0 is set if there is no way to determine - if it is rising or falling. This is done - for the every red, green and blue part of - the image. - - Phase images can be used to create ugly - effects or to find meta-information - in the orginal image. - - <table border='0'> - <tr> - <td><img height='115' src='../images/predef.Image.Image.phaseh.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.phaseh.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.phaseh.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.phaseh.4.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.phaseh.5.png' width='80' /></td> - </tr> - <tr> - <td>original </td> - <td>phaseh() </td> - <td>phasev() </td> - <td>phasevh()</td> - <td>phasehv()</td> - </tr> - </table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - experimental status; may not be exact the same - output in later versions - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'> - 0 should not be set as explained above. + <dd class='body--doc'>Returns all preceding siblings, i.e. all siblings present before this node + in the parents children list. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - polyfill + get_root </dt> - <dd><code><code class='object unresolved'>object </code> polyfill(<code class='datatype'>array</code>(<code class='datatype'>int</code>|<code class='datatype'>float</code>) ... <code class='argument'>curve</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> get_root()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - fills an area with the current color - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>curve</code></dt> - <dd></dd><dd class='body--doc'>curve(s), <tt>({x1,y1,x2,y2,...,xn,yn})</tt>, - automatically closed. + <dd class='body--doc'>Follows all parent pointers and returns the root node. + </dd></dl> - If any given curve is inside another, it - will make a hole. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the current object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Lines in the polygon may not be crossed without - the crossing coordinate specified in both lines. - - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'> - Inverted lines reported on Intel and Alpha processors. - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>setcolor</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - random - Method - randomgrey + get_siblings </dt> - <dd><code><code class='object unresolved'>object </code> random()</code> - <code><code class='object unresolved'>object </code> random(<code class='datatype'>int</code> <code class='argument'>seed</code>)</code> - <code><code class='object unresolved'>object </code> randomgrey()</code> - <code><code class='object unresolved'>object </code> random(<code class='object unresolved'>greyint</code> <code class='argument'>seed</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_siblings()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives a randomized image; - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.random.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.random.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.random.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.random.4.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.random.5.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.random.6.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->random()</td> - <td>->random(17)</td> - <td>greyed (same again)</td> - <td>color(red) (same again)</td> - <td>...red channel </td> - </tr></table> + <dd class='body--doc'>Returns all siblings, including this node. + </dd></dl> - Use with -><code>grey</code>() or -><code>color</code>() - for one-color-results. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new image - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>test</code>, <code>noise</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - write_lsb_rgb - Method - write_lsb_grey - Method - read_lsb_rgb - Method - read_lsb_grey + iterate_children </dt> - <dd><code><code class='object unresolved'>object </code> write_lsb_rgb(<code class='datatype'>string</code> <code class='argument'>what</code>)</code> - <code><code class='object unresolved'>object </code> write_lsb_grey(<code class='datatype'>string</code> <code class='argument'>what</code>)</code> - <code><code class='object unresolved'>string </code> read_lsb_rgb()</code> - <code><code class='object unresolved'>string </code> read_lsb_grey()</code></dd> + <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> iterate_children(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - These functions read/write in the least significant bit - of the image pixel values. The _rgb() functions - read/write on each of the red, green and blue values, - and the grey keeps the same lsb on all three. - - The string is nullpadded or cut to fit. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>what</code></dt> - <dd></dd><dd class='body--doc'>the hidden message</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the current object or the read string + <dd class='body--doc'>Iterates over the nodes children from left to right, calling the callback + function for every node. If the callback function returns <code>STOP_WALK</code> + the iteration is promptly aborted and <code>STOP_WALK</code> is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rotate - Method - rotate_expand + remove_child </dt> - <dd><code><code class='object unresolved'>object </code> rotate(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>angle</code>)</code> - <code><code class='object unresolved'>object </code> rotate(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>angle</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> rotate_expand(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>angle</code>)</code> - <code><code class='object unresolved'>object </code> rotate_expand(<code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>angle</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>void</code> remove_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>c</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Rotates an image a certain amount of degrees (360° is - a complete rotation) counter-clockwise: - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.rotate.1.png' width='80' /></td> - <td><img height='141' src='../images/predef.Image.Image.rotate.2.png' width='113' /></td> - <td><img height='141' src='../images/predef.Image.Image.rotate.3.png' width='113' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate(15,255,0,0);</td> - <td>->rotate_expand(15);</td> - </tr></table> - - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color. - - This rotate uses the <code>skewx</code>() and <code>skewy</code>() functions. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>angle</code></dt> - <dd></dd><dd class='body--doc'>the number of degrees to rotate</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color to fill with; default is current</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Removes all occurences of the provided node from the called nodes + list of children. The removed nodes parent reference is set to null. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rotate_ccw + remove_node </dt> - <dd><code><code class='object unresolved'>object </code> rotate_ccw()</code></dd> + <dd><code><code class='datatype'>void</code> remove_node()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - rotates an image counter-clockwise, 90 degrees. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.rotate_ccw.1.png' width='80' /></td> - <td><img height='80' src='../images/predef.Image.Image.rotate_ccw.2.png' width='115' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate_ccw();</td> - </tr></table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Removes this node from its parent. The parent reference is set to null. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rotate_cw + replace_child </dt> - <dd><code><code class='object unresolved'>object </code> rotate_cw()</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> replace_child(<code class='object unresolved'>AbstractNode</code> <code class='argument'>old</code>, <code class='object unresolved'>AbstractNode</code> <code class='argument'>new</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - rotates an image clockwise, 90 degrees. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.rotate_cw.1.png' width='80' /></td> - <td><img height='80' src='../images/predef.Image.Image.rotate_cw.2.png' width='115' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->rotate_cw();</td> - </tr></table> + <dd class='body--doc'>Replaces the first occurence of the old node child with + the new node child. All parent references are updated. </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Returns the new child node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - scale + replace_children </dt> - <dd><code><code class='object unresolved'>object </code> scale(<code class='datatype'>float</code> <code class='argument'>factor</code>)</code> - <code><code class='object unresolved'>object </code> scale(<code class='argument'>0.5</code>)</code> - <code><code class='object unresolved'>object </code> scale(<code class='datatype'>float</code> <code class='argument'>xfactor</code>, <code class='datatype'>float</code> <code class='argument'>yfactor</code>)</code></dd> + <dd><code><code class='datatype'>void</code> replace_children(<code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) <code class='argument'>children</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - scales the image with a factor, - 0.5 is an optimized case. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>factor</code></dt> - <dd></dd><dd class='body--doc'>factor to use for both x and y</dd> - <dt class='head--doc'>Parameter <code class='parameter'>xfactor</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>yfactor</code></dt> - <dd></dd><dd class='body--doc'>separate factors for x and y - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Replaces the nodes children with the provided ones. All parent + references are updated. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - scale + replace_node </dt> - <dd><code><code class='object unresolved'>object </code> scale(<code class='datatype'>int</code> <code class='argument'>newxsize</code>, <code class='datatype'>int</code> <code class='argument'>newysize</code>)</code> - <code><code class='object unresolved'>object </code> scale(<code class='argument'>0</code>, <code class='datatype'>int</code> <code class='argument'>newysize</code>)</code> - <code><code class='object unresolved'>object </code> scale(<code class='datatype'>int</code> <code class='argument'>newxsize</code>, <code class='argument'>0</code>)</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> replace_node(<code class='object unresolved'>AbstractNode</code> <code class='argument'>new</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - scales the image to a specified new size, - if one of newxsize or newysize is 0, - the image aspect ratio is preserved. + <dd class='body--doc'>Replaces this node with the provided one. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>newxsize</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>newysize</code></dt> - <dd></dd><dd class='body--doc'>new image size in pixels - </dd> + <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - resulting image will be 1x1 pixels, at least + <dd class='body--doc'>Returns the new node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - select_from + set_parent </dt> - <dd><code><code class='object unresolved'>object </code> select_from(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> select_from(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>edge_value</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_parent(<code class='object unresolved'>AbstractNode</code> <code class='argument'>parent</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Makes an grey-scale image, for alpha-channel use. + <dd class='body--doc'>Sets the parent node to <code>parent</code>. + </dd></dl> - This is very close to a floodfill. + - The image is scanned from the given pixel, - filled with 255 if the color is the same, - or 255 minus distance in the colorcube, squared, rightshifted - 8 steps (see <code>distancesq</code>). - - When the edge distance is reached, the scan is stopped. - Default edge value is 30. - This value is squared and compared with the square of the - distance above. - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>originating pixel in the image - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>distancesq</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - setcolor + walk_inorder </dt> - <dd><code><code class='object unresolved'>object </code> setcolor(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> setcolor(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_inorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - set the current color - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>new color</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>new alpha value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called + <dd class='body--doc'>Traverse the node subtree in inorder, left subtree first, then + root node, and finally the remaining subtrees, calling the callback + function for every node. If the callback function returns + <code>STOP_WALK</code> the traverse is promptly aborted and <code>STOP_WALK</code> + is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - setpixel + walk_postorder </dt> - <dd><code><code class='object unresolved'>object </code> setpixel(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> setpixel(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> setpixel(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>alpha</code>)</code></dd> + <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_postorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.setpixel.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.setpixel.2.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->setpixel (10,10, 255,0,0)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>position of the pixel</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color</dd> - <dt class='head--doc'>Parameter <code class='parameter'>alpha</code></dt> - <dd></dd><dd class='body--doc'>alpha value</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called + <dd class='body--doc'>Traverse the node subtree in postorder, first subtrees from left to + right, then the root node, calling the callback function for every + node. If the callback function returns <code>STOP_WALK</code> the traverse + is promptly aborted and <code>STOP_WALK</code> is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - skewx - Method - skewx_expand + walk_preorder </dt> - <dd><code><code class='object unresolved'>object </code> skewx(<code class='datatype'>int</code> <code class='argument'>x</code>)</code> - <code><code class='object unresolved'>object </code> skewx(<code class='datatype'>int</code> <code class='argument'>yfactor</code>)</code> - <code><code class='object unresolved'>object </code> skewx(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewx(<code class='datatype'>int</code> <code class='argument'>yfactor</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewx_expand(<code class='datatype'>int</code> <code class='argument'>x</code>)</code> - <code><code class='object unresolved'>object </code> skewx_expand(<code class='datatype'>int</code> <code class='argument'>yfactor</code>)</code> - <code><code class='object unresolved'>object </code> skewx_expand(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewx_expand(<code class='datatype'>int</code> <code class='argument'>yfactor</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_preorder(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Skews an image an amount of pixels or a factor; - a skew-x is a transformation: - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.skewx.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.skewx.2.png' width='95' /></td> - <td><img height='115' src='../images/predef.Image.Image.skewx.3.png' width='95' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->skewx(15,255,0,0);</td> - <td>->skewx_expand(15);</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd><dd class='body--doc'>the number of pixels - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>yfactor</code></dt> - <dd></dd><dd class='body--doc'>best described as: x=yfactor*this->ysize()</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color to fill with; default is current</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Traverse the node subtree in preorder, root node first, then + subtrees from left to right, calling the callback function + for every node. If the callback function returns <code>STOP_WALK</code> + the traverse is promptly aborted and <code>STOP_WALK</code> is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - skewy - Method - skewy_expand + walk_preorder_2 </dt> - <dd><code><code class='object unresolved'>object </code> skewy(<code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> skewy(<code class='datatype'>int</code> <code class='argument'>xfactor</code>)</code> - <code><code class='object unresolved'>object </code> skewy(<code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewy(<code class='datatype'>int</code> <code class='argument'>xfactor</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewy_expand(<code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> skewy_expand(<code class='datatype'>int</code> <code class='argument'>xfactor</code>)</code> - <code><code class='object unresolved'>object </code> skewy_expand(<code class='datatype'>int</code> <code class='argument'>y</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> skewy_expand(<code class='datatype'>int</code> <code class='argument'>xfactor</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>int</code>|<code class='datatype'>void</code> walk_preorder_2(<code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback_1</code>, <code class='datatype'>function</code>(<code class='object unresolved'>AbstractNode</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>int</code>|<code class='datatype'>void</code>) <code class='argument'>callback_2</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Skews an image an amount of pixels or a factor; - a skew-y is a transformation: - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.skewy.1.png' width='80' /></td> - <td><img height='130' src='../images/predef.Image.Image.skewy.2.png' width='80' /></td> - <td><img height='130' src='../images/predef.Image.Image.skewy.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->skewy(15,255,0,0);</td> - <td>->skewy_expand(15);</td> - </tr></table> - - The "expand" variant of functions stretches the - image border pixels rather then filling with - the given or current color. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd><dd class='body--doc'>the number of pixels</dd> - <dt class='head--doc'>Parameter <code class='parameter'>xfactor</code></dt> - <dd></dd><dd class='body--doc'>best described as: t=xfactor*this->xsize()</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>color to fill with; default is current</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object + <dd class='body--doc'>Traverse the node subtree in preorder, root node first, then + subtrees from left to right. For each node we call callback_1 + before iterating through children, and then callback_2 + (which always gets called even if the walk is aborted earlier). + If the callback function returns <code>STOP_WALK</code> the traverse + decend is aborted and <code>STOP_WALK</code> is returned once all waiting + callback_2 functions has been called. </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - test - </dt> - <dd><code><code class='object unresolved'>object </code> test()</code> - <code><code class='object unresolved'>object </code> test(<code class='datatype'>int</code> <code class='argument'>seed</code>)</code></dd> - + </dd></dl><dl><dt><h2 class='header'>Class Parser.XML.Tree.Node</h2> + </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Generates a test image, currently random gradients. + <dd class='body--doc'>Node in XML tree + </dd></dl> - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.test.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.test.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.test.3.png' width='80' /></td> - </tr><tr> - <td>original</td> - <td>->test()</td> - <td>...and again</td> - </tr></table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - May be subject to change or cease without prior warning. - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>gradients</code>, <code>tuned_box</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - threshold + cast </dt> - <dd><code><code class='object unresolved'>object </code> threshold()</code> - <code><code class='object unresolved'>object </code> threshold(<code class='datatype'>int</code> <code class='argument'>level</code>)</code> - <code><code class='object unresolved'>object </code> threshold(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> threshold(<code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code></dd> + <dd><code>(int)Parser.XML.Tree.Node() (float)Parser.XML.Tree.Node() (string)Parser.XML.Tree.Node() (array)Parser.XML.Tree.Node() (mapping)Parser.XML.Tree.Node() (multiset)Parser.XML.Tree.Node()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Makes a black-white image. + <dd class='body--doc'>It is possible to cast a node to a string, which will return + <code>render_xml()</code> for that node. + </dd></dl> - If any of red, green, blue parts of a pixel - is larger then the given value, the pixel will become - white, else black. + - This method works fine with the grey method. - - If no arguments are given, it will paint all non-black - pixels white. (Ie, default is 0,0,0.) - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.threshold.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.threshold.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.threshold.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>->threshold(100);</td> - <td>->threshold(0,100,0);</td> - </tr></table> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new image object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - The above statement "any ..." was changed from "all ..." - in Pike 0.7 (9906). It also uses 0,0,0 as default input, - instead of current color. This is more useful. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>grey</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - tuned_box + clone </dt> - <dd><code><code class='object unresolved'>object </code> tuned_box(<code class='datatype'>int</code> <code class='argument'>x1</code>, <code class='datatype'>int</code> <code class='argument'>y1</code>, <code class='datatype'>int</code> <code class='argument'>x2</code>, <code class='datatype'>int</code> <code class='argument'>y2</code>, <code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>corner_color</code>)</code></dd> + <dd><code><code class='object unresolved'>Node</code> clone(<code class='datatype'>void</code>|<code class='datatype'>int(-1..1)</code> <code class='argument'>direction</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Draws a filled rectangle with colors (and alpha values) tuned - between the corners. - - Tuning function is (1.0-x/xw)*(1.0-y/yw) where x and y is - the distance to the corner and xw and yw are the sides of the - rectangle. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Image.tuned_box.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.tuned_box.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.tuned_box.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Image.tuned_box.4.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>tuned box</td> - <td>solid tuning (blue,red,green,yellow)</td> - <td>tuning transparency (as left + 255,128,128,0)</td> - </tr></table> - - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y1</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>x2</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y2</code></dt> - <dd></dd><dd class='body--doc'>rectangle corners</dd> - <dt class='head--doc'>Parameter <code class='parameter'>corner_color</code></dt> - <dd></dd><dd class='body--doc'>colors of the corners: - <pre> - ({x1y1,x2y1,x1y2,x2y2}) - </pre> - each of these is an array of integeres: - <pre> - ({r,g,b}) or ({r,g,b,alpha}) - </pre> - Default alpha channel value is 0 (opaque).</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the object called + <dd class='body--doc'>Clones the node, optionally connected to parts of the tree. + If direction is -1 the cloned nodes parent will be set, if + direction is 1 the clone nodes childen will be set. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - turbulence + create </dt> - <dd><code><code class='object unresolved'>void </code> turbulence(<code class='datatype'>array</code>(<code class='datatype'>float</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colorrange</code>)</code> - <code><code class='object unresolved'>void </code> turbulence(<code class='datatype'>array</code>(<code class='datatype'>float</code>|<code class='datatype'>int</code>|<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colorrange</code>, <code class='datatype'>int</code> <code class='argument'>octaves</code>, <code class='datatype'>float</code> <code class='argument'>scale</code>, <code class='datatype'>float</code> <code class='argument'>xdiff</code>, <code class='datatype'>float</code> <code class='argument'>ydiff</code>, <code class='datatype'>float</code> <code class='argument'>cscale</code>)</code></dd> + <dd><code>Parser.XML.Tree.Node Parser.XML.Tree.Node(<code class='datatype'>int</code> <code class='argument'>type</code>, <code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>text</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - gives a new image with the old image's size, - filled width a 'turbulence' pattern + - The random seed may be different with each instance of pike. - - Example: - <tt>->turbulence( ({0,({229,204,204}), 0.9,({229,20,20}), 0.9,Color.black}) );</tt> - <img height='100' src='../images/predef.Image.Image.turbulence.1.png' width='200' /> - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>colorrange</code></dt> - <dd></dd><dd class='body--doc'>colorrange table</dd> - <dt class='head--doc'>Parameter <code class='parameter'>octaves</code></dt> - <dd></dd><dd class='body--doc'>default value is 3</dd> - <dt class='head--doc'>Parameter <code class='parameter'>scale</code></dt> - <dd></dd><dd class='body--doc'>default value is 0.1</dd> - <dt class='head--doc'>Parameter <code class='parameter'>xdiff</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ydiff</code></dt> - <dd></dd><dd class='body--doc'>default value is 0,0</dd> - <dt class='head--doc'>Parameter <code class='parameter'>cscale</code></dt> - <dd></dd><dd class='body--doc'>default value is 1</dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>noise</code>, <code>Image.Color</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - xsize + get_any_name </dt> - <dd><code><code class='object unresolved'>int </code> xsize()</code></dd> + <dd><code><code class='datatype'>string</code> get_any_name()</code></dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the width of the image + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return name of tag or name of attribute node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - ysize + get_attr_name </dt> - <dd><code><code class='object unresolved'>int </code> ysize()</code></dd> + <dd><code><code class='datatype'>string</code> get_attr_name()</code></dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the height of the image - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Image.Layer</h2> - </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - + <dd class='body--doc'>Returns the name of the attribute node. + </dd></dl> - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>layers</code></dd></dl> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_image - Method - image - Method - alpha + get_attribute_nodes </dt> - <dd><code><code class='object unresolved'>object </code> set_image(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>)</code> - <code><code class='object unresolved'>object </code> set_image(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>, <code class='object unresolved'>Image.Image</code> <code class='argument'>alpha_channel</code>)</code> - <code><code class='datatype'>object</code>|<code class='datatype'>int(0..)</code> image()</code> - <code><code class='datatype'>object</code>|<code class='datatype'>int(0..)</code> alpha()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Node</code>) get_attribute_nodes()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set/change/get image and alpha channel for the layer. - You could also cancel the channels giving 0 - instead of an image object. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - image and alpha channel must be of the same size, - or canceled. + <dd class='body--doc'>Creates and returns an array of new nodes; they will not be + added as proper children to the parent node, but the parent + link in the nodes are set so that upwards traversal is made + possible. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_alpha_value - Method - alpha_value + get_attributes </dt> - <dd><code><code class='object unresolved'>object </code> set_alpha_value(<code class='datatype'>float</code> <code class='argument'>value</code>)</code> - <code><code class='object unresolved'>double </code> alpha_value()</code></dd> + <dd><code><code class='datatype'>mapping</code> get_attributes()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set/get the general alpha value of this layer. - This is a float value between 0 and 1, - and is multiplied with the alpha channel. + <dd class='body--doc'>Returns this nodes attributes, which can be altered + destructivly to alter the nodes attributes. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - autocrop - Method - find_autocrop + get_doc_order </dt> - <dd><code><code class='object unresolved'>object </code> autocrop()</code> - <code><code class='object unresolved'>object </code> autocrop(<code class='datatype'>bool</code> <code class='argument'>left</code>, <code class='datatype'>bool</code> <code class='argument'>right</code>, <code class='datatype'>bool</code> <code class='argument'>top</code>, <code class='datatype'>bool</code> <code class='argument'>bottom</code>)</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_autocrop()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) find_autocrop(<code class='datatype'>bool</code> <code class='argument'>left</code>, <code class='datatype'>bool</code> <code class='argument'>right</code>, <code class='datatype'>bool</code> <code class='argument'>top</code>, <code class='datatype'>bool</code> <code class='argument'>bottom</code>)</code></dd> + <dd><code><code class='datatype'>int</code> get_doc_order()</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This crops (of finds) a suitable crop, non-destructive crop. - The layer alpha channel is checked, and edges that is - transparent is removed. + - (What really happens is that the image and alpha channel is checked, - and edges equal the fill setup is cropped away.) - - <code>find_autocrop</code>() returns an array of xoff,yoff,xsize,ysize, - which can be fed to <code>crop</code>(). - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - A tiled image will not be cropped at all. - - <tt>left</tt>...<tt>bottom</tt> arguments can be used - to tell what sides cropping are ok on. - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>crop</code>, <code>Image.Image->autocrop</code></dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_mode - Method - mode - Method - available_modes + get_elements </dt> - <dd><code><code class='object unresolved'>object </code> set_mode(<code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code><code class='object unresolved'>string </code> mode()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>string</code>) available_modes()</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>AbstractNode</code>) get_elements(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set/get layer mode. Mode is one of these: - - "normal", - "add", - "subtract", - "multiply", - "divide", - "modulo", - "invsubtract", - "invdivide", - "invmodulo", - "difference", - "max", - "min", - "bitwise_and", - "bitwise_or", - "bitwise_xor", - - "replace", - "red", - "green", - "blue", - - "replace_hsv", - "hue", - "saturation", - "value", - "color", - - "darken", - "lighten", - - "dissolve", - "behind", - "erase", - - <code>available_modes</code>() simply gives an array - containing the names of these modes. - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - image and alpha channel must be of the same size, - or canceled. + <dd class='body--doc'>Returns all element children to this node. If a <code>name</code> + is provided, only elements with that name is returned. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + get_first_element </dt> - <dd><code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>))Image.Layer()</code></dd> + <dd><code><code class='object unresolved'>AbstractNode</code> get_first_element(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - ([ "xsize":int, - "ysize":int, - "image":image, - "alpha":image, - "xoffset":int, - "yoffset":int, - "fill":image, - "fill_alpha":image - "tiled":int, - "mode":string - ]) + <dd class='body--doc'>Returns the first element child to this node. If a <code>name</code> + is provided, the first element child with that name is + returned. Returns 0 if no matching node was found. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - clone + get_node_type </dt> - <dd><code><code class='object unresolved'>object </code> clone()</code></dd> + <dd><code><code class='datatype'>int</code> get_node_type()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Creates a copy of the called object. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the copy + <dd class='body--doc'>Returns the node type. See defined node type constants. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + get_tag_name </dt> - <dd><code>Image.Layer Image.Layer(<code class='datatype'>object</code> <code class='argument'>image</code>, <code class='datatype'>object</code> <code class='argument'>alpha</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code>Image.Layer Image.Layer(<code class='datatype'>mapping</code> <code class='argument'>info</code>)</code> - <code>Image.Layer Image.Layer()</code> - <code>Image.Layer Image.Layer(<code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>object</code> <code class='argument'>color</code>)</code> - <code>Image.Layer Image.Layer(<code class='datatype'>object</code> <code class='argument'>color</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_tag_name()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - The Layer construct either three arguments, - the image object, alpha channel and mode, or - a mapping with optional elements: - <pre> - "image":image, - // default: black - - "alpha":alpha, - // alpha channel object - // default: full opaque - - "mode":string mode, - // layer mode, see <ref>mode</ref>. - // default: "normal" - - "alpha_value":float(0.0-1.0), - // layer general alpha value - // default is 1.0; this is multiplied - // with the alpha channel. - - "xoffset":int, - "yoffset":int, - // offset of this layer - - "fill":Color, - "fill_alpha":Color, - // fill color, ie what color is used - // "outside" the image. default: black - // and black (full transparency). - - "tiled":int(0|1), - // select tiling; if 1, the image - // will be tiled. deafult: 0, off - </pre> - The layer can also be created "empty", - either giving a size and color - - this will give a filled opaque square, - or a color, which will set the "fill" - values and fill the whole layer with an - opaque color. - - All values can be modified after object creation. - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - image and alpha channel must be of the same size. - + <dd class='body--doc'>Returns the name of the element node, or the nearest element above if + an attribute node. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - crop + get_text </dt> - <dd><code><code class='object unresolved'>object </code> crop(<code class='datatype'>int</code> <code class='argument'>xoff</code>, <code class='datatype'>int</code> <code class='argument'>yoff</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code></dd> + <dd><code><code class='datatype'>string</code> get_text()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Crops this layer at this offset and size. - Offset is not relative the layer offset, so this - can be used to crop a number of layers simuntaneously. - - The <code>fill</code> values are used if the layer is - enlarged. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new layer object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - The new layer object may have the same image object, - if there was no cropping to be done. + <dd class='body--doc'>Returns text content in node. </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - description + <dt class='head--type'>Inherit + AbstractNode </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) description()</code></dd> + <dd><code>inherit AbstractNode : AbstractNode</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Layer descriptions - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_fill - Method - fill - Method - fill_alpha + render_xml </dt> - <dd><code><code class='object unresolved'>object </code> set_fill(<code class='object unresolved'>Color</code> <code class='argument'>color</code>)</code> - <code><code class='object unresolved'>object </code> set_fill(<code class='object unresolved'>Color</code> <code class='argument'>color</code>, <code class='object unresolved'>Color</code> <code class='argument'>alpha</code>)</code> - <code><code class='object unresolved'>object </code> fill()</code> - <code><code class='object unresolved'>object </code> fill_alpha()</code></dd> + <dd><code><code class='datatype'>string</code> render_xml()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set/query fill color and alpha, ie the color used "outside" the - image. This is mostly useful if you want to "frame" - a layer. + <dd class='body--doc'>Creates an XML representation of the nodes sub tree. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_misc_value - Method - get_misc_value + set_doc_order </dt> - <dd><code><code class='object unresolved'>mixed </code> set_misc_value(<code class='datatype'>object</code> <code class='argument'>mixedwhat</code>, <code class='datatype'>object</code> <code class='argument'>mixedto</code>)</code> - <code><code class='object unresolved'>mixed </code> get_misc_value(<code class='datatype'>object</code> <code class='argument'>mixedwhat</code>)</code></dd> + <dd><code><code class='datatype'>void</code> set_doc_order(<code class='datatype'>int</code> <code class='argument'>o</code>)</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set or query misc. attributes for the layer. + - As an example, the XCF and PSD image decoders set the 'name' attribute - to the name the layer had in the source file. - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_offset - Method - xoffset - Method - yoffset + value_of_node </dt> - <dd><code><code class='object unresolved'>object </code> set_offset(<code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>int </code> xoffset()</code> - <code><code class='object unresolved'>int </code> yoffset()</code></dd> + <dd><code><code class='datatype'>string</code> value_of_node()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Set/query layer offset. - + <dd class='body--doc'>If the node is an attribute node or a text node, its value is returned. + Otherwise the child text nodes are concatenated and returned. </dd></dl> - + </dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Class Parser.HTML</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'> + This is a simple parser for SGML structured markups. + It's not really HTML, but it's useful for that + purpose. - + + The simple way to use it is to give it some information + about available tags and containers, and what + callbacks those is to call. - + + The object is easily reused, by calling the <code>clone</code>() + function. + + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'> + <code>add_tag</code>, <code>add_container</code>, <code>clone</code></dd></dl> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - set_tiled - Method - tiled + _inspect </dt> - <dd><code><code class='object unresolved'>object </code> set_tiled(<code class='datatype'>int</code> <code class='argument'>yes</code>)</code> - <code><code class='object unresolved'>int </code> tiled()</code></dd> + <dd><code><code class='object unresolved'>mapping </code> _inspect()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set/query tiled flag. If set, the - image and alpha channel will be tiled rather - then framed by the <code>fill</code> values. + This is a low-level way of debugging a parser. + This gives a mapping of the internal state + of the Parser.HTML object. + + + The format and contents of this mapping may + change without further notice. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - xsize + _set_tag_callback Method - ysize + _set_entity_callback + Method + _set_data_callback </dt> - <dd><code><code class='object unresolved'>int </code> xsize()</code> - <code><code class='object unresolved'>int </code> ysize()</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> _set_tag_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> _set_entity_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> _set_data_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>to_call</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Query layer offset. This is the same as layer - image/alpha image size. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Image.Font</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Short technical documentation on a font file: - This object adds the text-drawing and -creation - capabilities of the <ref>Image</ref> module. - For simple usage, see <code>write</code> and <code>load</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'><pre> - struct file_head - { - unsigned INT32 cookie; - 0x464f4e54 - unsigned INT32 version; - 1 - unsigned INT32 chars; - number of chars - unsigned INT32 height; - height of font - unsigned INT32 baseline; - font baseline - unsigned INT32 o[1]; - position of char_head's - } *fh; - struct char_head - { - unsigned INT32 width; - width of this character - unsigned INT32 spacing; - spacing to next character - unsigned char data[1]; - pixmap data (1byte/pixel) - } *ch; + These functions set up the parser object to + call the given callbacks upon tags, entities + and/or data. - version 2: + + The callbacks will only be called if there isn't + another tag/container/entity handler for these. - + + The function will be called with the parser + object as first argument, and the active string + as second. - On-disk syntax (everything in N.B.O), int is 4 bytes, a byte is 8 bits: + + Note that no parsing of the contents has been done. + Both endtags and normal tags are called, there is + no container parsing. - pos - 0 int cookie = 'FONT'; or 0x464f4e54 - 4 int version = 2; 1 was the old version without the last four chars - 8 int numchars; Always 256 in this version of the dump program - 12 int height; in (whole) pixels - 16 int baseline; in (whole) pixels - 20 char direction; 1==right to left, 0 is left to right - 21 char format; Font format - 22 char colortablep; Colortable format - 23 char kerningtablep; Kerning table format + + The return values from the callbacks are handled in the + same way as the return values from callbacks registered with + <code>add_tag</code> and similar functions. - 24 int offsets[numchars]; pointers into the data, realative to &cookie. - [colortable] - [kerningtable] - - At each offset: - - - 0 int width; in pixels - 4 int spacing; in 1/1000:th of a pixels - 8 char data[]; Enough data to plot width * font->height pixels - Please note that if width is 0, there is no data. - - Font formats: - id type - 0 Raw 8bit data - 1 RLE encoded data, char length, char data, 70% more compact than raw data - 2 ZLib compressed data 60% more compact than RLE - - Colortable types: - 0 No colortable (the data is an alpha channel) - 1 24bit RGB with alpha (index->color, 256*4 bytes, rgba) - 2 8bit Greyscale with alpha (index->color, 256*2 bytes) - - Kerningtable types: - 0 No kerning table - 1 numchars*numchars entries, each a signed char with the kerning value - 2 numchar entries, each with a list of kerning pairs, like this: - int len - len * (short char, short value) - </pre> + + The data callback will be called as seldom as possible with + the longest possible string, as long as it doesn't get called + out of order with any other callback. It will never be called + with a zero length string. + </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Image</code>, <code>Image.Image</code> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'> + the called object </dd></dl> - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - baseline - </dt> - <dd><code><code class='datatype'>int</code> baseline()</code></dd> + - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns font baseline (pixels from top) - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>height</code>, <code>text_extents</code> - </dd></dl> - - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - center + add_tag + Method + add_container + Method + add_entity + Method + add_quote_tag + Method + add_tags + Method + add_containers + Method + add_entities </dt> - <dd><code><code class='datatype'>void</code> center()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function. - </dd></dl> + <dd><code><code class='object unresolved'>Parser.HTML </code> add_tag(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_container(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_entity(<code class='datatype'>string</code> <code class='argument'>entity</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_quote_tag(<code class='datatype'>string</code> <code class='argument'>name</code>, <code class='datatype'>mixed</code> <code class='argument'>to_do</code>, <code class='datatype'>string</code> <code class='argument'>end</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_tags(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>tags</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_containers(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>containers</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> add_entities(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) <code class='argument'>entities</code>)</code></dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>Image.Font Image.Font(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> - + <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Loads a font file to this font object. - Similar to <code>load()</code>. - </dd></dl> + <dd class='body--doc'> + Registers the actions to take when parsing various things. + Tags, containers, entities are as usual. add_quote_tag() adds + a special kind of tag that reads any data until the next + occurrence of the end string immediately before a tag end. - + <tt>to_do</tt> can be: - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - height - </dt> - <dd><code><code class='datatype'>int</code> height()</code></dd> + <ul> + <li>a function to be called. The function is on the form + <pre> + mixed tag_callback(Parser.HTML parser,mapping args,mixed ... extra) + mixed container_callback(Parser.HTML parser,mapping args,string content,mixed ... extra) + mixed entity_callback(Parser.HTML parser,mixed ... extra) + mixed quote_tag_callback(Parser.HTML parser,string content,mixed ... extra) + </pre> + depending on what realm the function is called by.</li><li>a string. This tag/container/entity is then replaced + by the string. The string is normally not reparsed, i.e. it's + equivalent to writing a function that returns the string in an + array (but a lot faster). If <code>reparse_strings</code> is + set the string will be reparsed, though.</li><li>an array. The first element is a function as above. + It will receive the rest of the array as extra arguments. If + extra arguments are given by <code>set_extra</code>(), they will + appear after the ones in this array.</li><li>zero. If there is a tag/container/entity with the + given name in the parser, it's removed.</li></ul> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the font height. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>baseline</code>, <code>text_extents</code> - </dd></dl> + The callback function can return: - + <ul> + <li>a string; this string will be pushed on the parser + stack and be parsed. Be careful not to return anything + in this way that could lead to a infinite recursion.</li><li>an array; the element(s) of the array is the result + of the function. This will not be parsed. This is useful for + avoiding infinite recursion. The array can be of any size, + this means the empty array is the most effective to return if + you don't care about the result. If the parser is operating in + <code>mixed_mode</code>, the array can contain anything. + Otherwise only strings are allowed.</li><li>zero; this means "don't do anything", ie the + item that generated the callback is left as it is, and + the parser continues.</li><li>one; reparse the last item again. This is useful to + parse a tag as a container, or vice versa: just add or remove + callbacks for the tag and return this to jump to the right + callback.</li></ul> - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - left - </dt> - <dd><code><code class='datatype'>void</code> left()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - load - </dt> - <dd><code><code class='object unresolved'>Image.Font</code>|<code class='datatype'>int</code> load(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Loads a font file to this font object. + </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns zero upon failure and a font object upon success. + <dd class='body--doc'> + the called object </dd> - <dt class='head--doc'>Parameter <code class='parameter'>filename</code></dt> - <dd></dd><dd class='body--doc'>The path to the font file. - </dd> + <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>write</code> - </dd></dl> + <dd class='body--doc'> + <code>tags</code>, <code>containers</code>, <code>entities</code></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - right - </dt> - <dd><code><code class='datatype'>void</code> right()</code></dd> - <dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Document this function. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_xspacing_scale + at Method - set_yspacing_scale + at_line + Method + at_char + Method + at_column </dt> - <dd><code><code class='datatype'>void</code> set_xspacing_scale(<code class='datatype'>float</code> <code class='argument'>scale</code>)</code> - <code><code class='datatype'>void</code> set_yspacing_scale(<code class='datatype'>float</code> <code class='argument'>scale</code>)</code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) at()</code> + <code><code class='object unresolved'>int </code> at_line()</code> + <code><code class='object unresolved'>int </code> at_char()</code> + <code><code class='object unresolved'>int </code> at_column()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set spacing scale to write characters closer - or more far away. This does not change scale - of character, only the space between them. - </dd></dl> + <dd class='body--doc'> + Returns the current position. Characters and columns count + from 0, lines count from 1. - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - text_extents - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) text_extents(<code class='datatype'>string</code> <code class='argument'>text</code>, <code class='datatype'>string</code> ... <code class='argument'>more_text_lines</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Calculate extents of a text-image, - that would be created by calling <code>write</code> - with the same arguments. One or more lines - of text may be provided. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'><table class='box'><tr><td colspan='1'>Array</td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>width</code></code></td></tr> - <tr><td><code><code class='datatype'>int</code> <code class='key'>height</code></code></td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>write</code>, <code>height</code>, <code>baseline</code> + + <code>at</code>() gives an array consisting of + ({line,char,column}), in that order. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - write + case_insensitive_tag + Method + ignore_tags + Method + ignore_unknown + Method + lazy_argument_end + Method + lazy_entity_end + Method + match_tag + Method + max_parse_depth + Method + mixed_mode + Method + reparse_strings + Method + ws_before_tag_name + Method + xml_tag_syntax </dt> - <dd><code><code class='object unresolved'>Image.Image</code> write(<code class='datatype'>string</code> <code class='argument'>text</code>, <code class='datatype'>string</code> ... <code class='argument'>more_text_lines</code>)</code></dd> + <dd><code><code class='object unresolved'>int </code> case_insensitive_tag(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> ignore_tags(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> ignore_unknown(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> lazy_argument_end(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> lazy_entity_end(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> match_tag(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> max_parse_depth(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> mixed_mode(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> reparse_strings(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> ws_before_tag_name(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code> + <code><code class='object unresolved'>int </code> xml_tag_syntax(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>value</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Writes some text; thus creating an image object - that can be used as mask or as a complete picture. - One or more text lines may be provided. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>text_extents</code>, <code>load</code>, <code>Image.Image->paste_mask</code>, <code>Image.Image->paste_alpha_color</code> - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Image.Colortable</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> + <dd class='body--doc'> - + Functions to query or set flags. These set the associated flag + to the value if any is given and returns the old value. + - This object keeps colortable information, - mostly for image re-coloring (quantization). + The flags are: - The object has color reduction, quantisation, - mapping and dithering capabilities. + <ul> + <li>case_insensitive_tag: All tags and containers + are matched case insensitively, and argument names are + converted to lowercase. Tags added with + <code>add_quote_tag</code>() are not affected, though. Switching + to case insensitive mode and back won't preserve the case of + registered tags and containers.</li><li>ignore_tags: Do not look for tags at all. + Normally tags are matched even when there's no callbacks for + them at all. When this is set, the tag delimiters '<' and + '>' will be treated as any normal character.</li><li>ignore_unknown: Treat unknown tags and entities + as text data, continuing parsing for tags and entities inside + them.</li><li>lazy_argument_end: A '>' in a tag argument + closes both the argument and the tag, even if the argument is + quoted.</li><li>lazy_entity_end: Normally, the parser search + indefinitely for the entity end character (i.e. ';'). When + this flag is set, the characters '&', '<', '>', '"', + ''', and any whitespace breaks the search for the entity end, + and the entity text is then ignored, i.e. treated as data.</li><li>match_tag: Unquoted nested tag starters and + enders will be balanced when parsing tags. This is the + default.</li><li>max_stack_depth: Maximum recursion depth during + parsing. Recursion occurs when a tag/container/entity/quote + tag callback function returns a string to be reparsed. The + default value is 10.</li><li>mixed_mode: Allow callbacks to return arbitrary + data in the arrays, which will be concatenated in the output.</li><li>reparse_strings: When a plain string is used as + a tag/container/entity/quote tag callback, it's not reparsed + if this flag is unset. Setting it causes all such strings to + be reparsed.</li><li>ws_before_tag_name: Allow whitespace between the + tag start character and the tag name.</li><li>xml_tag_syntax: Whether or not to use XML syntax + to tell empty tags and container tags apart: + + 0: Use HTML syntax only. If there's a '/' last in a + tag, it's just treated as any other argument. + + 1: Use HTML syntax, but ignore a '/' if it comes + last in a tag. This is the default. + + 2: Use XML syntax, but when a tag that does not end + with '/>' is found which only got a non-container tag + callback, treat it as a non-container (i.e. don't start to + seek for the container end). + + 3: Use XML syntax only. If a tag got both container + and non-container callbacks, the non-container callback is + called when the empty element form (i.e. the one ending with + '/>') is used, and the container callback otherwise. If + only a container callback exists, it gets the empty string as + content when there's none to be parsed. If only a + non-container callback exists, it will be called (without the + content argument) for both kinds of tags.</li></ul> </dd> - <dt class='head--doc'>See also</dt> + <dt class='head--doc'>Note</dt> <dd class='body--doc'> - <code>Image</code>, <code>Image.Image</code>, <code>Image.Font</code>, <code>Image.GIF</code></dd></dl> + When functions are specified with + <code>_set_tag_callback</code>() or + <code>_set_entity_callback</code>(), all tags or entities, + respectively, are considered known. However, if one of those + functions return 1 and ignore_unknown is set, they are treated + as text data instead of making another call to the same + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - map + clear_tags Method - `* + clear_containers Method - ``* + clear_entities + Method + clear_quote_tags </dt> - <dd><code><code class='object unresolved'>object </code> map(<code class='datatype'>object</code> <code class='argument'>image</code>)</code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Colortable()</code> * <code class='class'>image</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>image</code> * <code class='class'>Image.Colortable()</code></code> - <code><code class='object unresolved'>object </code> map(<code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code> - <code><code class='object unresolved'>object </code> res = <code class='class'>Image.Colortable()</code> * <code class='class'>data</code></code> - <code><code class='object unresolved'>object </code> res = <code class='class'>data</code> * <code class='class'>Image.Colortable()</code></code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> clear_tags()</code> + <code><code class='object unresolved'>Parser.HTML </code> clear_containers()</code> + <code><code class='object unresolved'>Parser.HTML </code> clear_entities()</code> + <code><code class='object unresolved'>Parser.HTML </code> clear_quote_tags()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Map colors in an image object to the colors in - the colortable, and creates a new image with the - closest colors. - - <table><tr valign='center'> - <td></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.4.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.5.png' width='80' /></td> - <td>no dither</td> - </tr><tr valign='center'> - <td></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.6.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.7.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.8.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.9.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.10.png' width='80' /></td> - <td><code>floyd_steinberg</code> dither</td> - </tr><tr valign='center'> - <td></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.11.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.12.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.13.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.14.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.15.png' width='80' /></td> - <td><code>ordered</code> dither</td> - </tr><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Colortable.map.16.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.17.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.18.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.19.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.20.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.map.21.png' width='80' /></td> - <td><code>randomcube</code> dither</td> - </tr><tr valign='center'> - <td>original</td> - <td>2</td> - <td>4</td> - <td>8</td> - <td>16</td> - <td>32 colors</td> - </tr></table> + Removes all registered definitions in the different + categories. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - a new image object + the called object </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Flat (not cube) colortable and not '<code>full</code>' method: - this method does figure out the data needed for - the lookup method, which may take time the first - use of the colortable - the second use is quicker. - - </dd> + <dt class='head--doc'>See also</dt> <dd class='body--doc'> - <code>cubicles</code>, <code>full</code></dd></dl> + <code>add_tag</code>, <code>add_tags</code>, <code>add_container</code>, <code>add_containers</code>, <code>add_entity</code>, <code>add_entities</code></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `+ + clone </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Colortable()</code> + <code class='class'>with</code></code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> clone(<code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - sums colortables - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>with</code></dt> - <dd></dd><dd class='body--doc'><code>Colortable</code> object with colors to add</dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the resulting new <code>Colortable</code> object - </dd></dl> + Clones the <code>Parser.HTML</code> object. + A new object of the same class is created, + filled with the parse setup from the + old object. - + + This is the simpliest way of flushing a + parse feed/output. - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `- - </dt> - <dd><code><code class='object unresolved'>object </code> res = <code class='class'>Image.Colortable()</code> - <code class='class'>with</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - subtracts colortables + + The arguments to clone is sent to the + new object, simplifying work for custom classes + that inherits <code>Parser.HTML</code>. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>with</code></dt> - <dd></dd><dd class='body--doc'><code>Colortable</code> object with colors to subtract</dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the resulting new <code>Colortable</code> object + the new object. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'> + create is called _before_ the setup is copied. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - create + tags Method - add + containers + Method + entities + Method + quote_tags </dt> - <dd><code>Image.Colortable Image.Colortable()</code> - <code>Image.Colortable Image.Colortable(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colors</code>)</code> - <code>Image.Colortable Image.Colortable(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>number</code>)</code> - <code>Image.Colortable Image.Colortable(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>number</code>, <code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>needed</code>)</code> - <code>Image.Colortable Image.Colortable(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code>Image.Colortable Image.Colortable(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>object</code> <code class='argument'>array(int</code>)</code> - <code><code class='object unresolved'>object </code> add(<code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>colors</code>)</code> - <code><code class='object unresolved'>object </code> add(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>number</code>)</code> - <code><code class='object unresolved'>object </code> add(<code class='object unresolved'>Image.Image</code> <code class='argument'>image</code>, <code class='datatype'>int</code> <code class='argument'>number</code>, <code class='datatype'>array</code>(<code class='datatype'>array</code>(<code class='datatype'>int</code>)) <code class='argument'>needed</code>)</code> - <code><code class='object unresolved'>object </code> add(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> add(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>object</code> <code class='argument'>array(int</code>)</code></dd> + <dd><code><code class='object unresolved'>mapping </code> tags()</code> + <code><code class='object unresolved'>mapping </code> containers()</code> + <code><code class='object unresolved'>mapping </code> entities()</code> + <code><code class='object unresolved'>mapping </code> quote_tags()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - <code>create</code> initiates a colortable object. - Default is that no colors are in the colortable. + Returns the current callback settings. For quote_tags, the + values are arrays ({callback, end_quote}). - <code>add</code> takes the same argument(s) as - <code>create</code>, thus adding colors to the colortable. + + Note that when matching is done case insensitively, all names + will be returned in lowercase. - The colortable is mostly a list of colors, - or more advanced, colors and weight. - - The colortable could also be a colorcube, with or - without additional scales. A colorcube is the by-far - fastest way to find colors. - - Example: - <pre> - ct=colortable(my_image,256); // the best 256 colors - ct=colortable(my_image,256,({0,0,0})); // black and the best other 255 - - ct=colortable(({({0,0,0}),({255,255,255})})); // black and white - - ct=colortable(6,7,6); // a colortable of 252 colors - ct=colortable(7,7,5, ({0,0,0}),({255,255,255}),11); - // a colorcube of 245 colors, and a greyscale of the rest -> 256 - </pre> + + Implementation note: With the exception of quote_tags(), these + run in constant time since they return copy-on-write mappings. + However, quote_tags() allocates a new mapping and thus runs in + linear time. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>colors</code></dt> - <dd></dd><dd class='body--doc'>list of colors</dd> - <dt class='head--doc'>Parameter <code class='parameter'>image</code></dt> - <dd></dd><dd class='body--doc'>source image - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>number</code></dt> - <dd></dd><dd class='body--doc'>number of colors to get from the image - - 0 (zero) gives all colors in the image. - - Default value is 256.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>needed</code></dt> - <dd></dd><dd class='body--doc'>needed colors (to optimize selection of others to these given) - - this will add to the total number of colors (see argument 'number')</dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>size of sides in the colorcube, must (of course) be equal - or larger than 2 - if smaller, the cube is ignored (no colors). - This could be used to have only scales (like a greyscale) - in the output.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>fromi</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>toi</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>stepi</code></dt> - <dd></dd><dd class='body--doc'>This is to add the possibility of adding a scale - of colors to the colorcube; for instance a grayscale - using the arguments <tt>({0,0,0}),({255,255,255}),17</tt>, - adding a scale from black to white in 17 or more steps. - - Colors already in the cube is used again to add the number - of steps, if possible. - - The total number of colors in the table is therefore - <tt>r*b*g+step1+...+stepn</tt>.</dd> - <dt class='head--doc'>Note</dt> + <dt class='head--doc'>See also</dt> <dd class='body--doc'> - max hash size is (probably, set by a <tt>#define</tt>) - 32768 entries, giving - maybe half that number of colors as maximum. - </dd></dl> + <code>add_tag</code>, <code>add_tags</code>, <code>add_container</code>, <code>add_containers</code>, <code>add_entity</code>, <code>add_entities</code></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cast + context </dt> - <dd><code>(int)Image.Colortable() (float)Image.Colortable() (string)Image.Colortable() (array)Image.Colortable() (mapping)Image.Colortable() (multiset)Image.Colortable()</code></dd> + <dd><code><code class='object unresolved'>string </code> context()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - cast the colortable to an array or mapping, - the array consists of <code>Image.Color</code> objects - and are not in index order. The mapping consists of - index:<code>Image.Color</code> pairs, where index is - the index (int) of that color. + Returns the current output context as a string: - example: <tt>(mapping)Image.Colortable(img)</tt> + <ul> + <li>"data": In top level data. This is always returned + when called from tag or container callbacks.</li><li>"arg": In an unquoted argument.</li><li>A single character string: In a quoted argument. + The string contains the starting quote character.</li><li>"splice_arg": In a splice argument.</li></ul> + + + This function is typically only useful in entity callbacks, + which can be called both from text and argument values of + different sorts. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>to</code></dt> - <dd></dd><dd class='body--doc'>must be "string", "array" or "mapping".</dd></dl> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'> + <code>splice_arg</code></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - corners + current </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>object</code>) corners()</code></dd> + <dd><code><code class='object unresolved'>string </code> current()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Gives the eight corners in rgb colorspace as an array. - The "black" and "white" corners are the first two. + Gives the current range of data, ie the whole tag/entity/etc + being parsed in the current callback. Returns zero if there's + no current range, i.e. when the function is not called in a + callback. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - cubicles + feed </dt> - <dd><code><code class='object unresolved'>object </code> cubicles()</code> - <code><code class='object unresolved'>object </code> cubicles(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> cubicles(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>accuracy</code>)</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> feed()</code> + <code><code class='object unresolved'>Parser.HTML </code> feed(<code class='datatype'>string</code> <code class='argument'>s</code>)</code> + <code><code class='object unresolved'>Parser.HTML </code> feed(<code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code> <code class='argument'>do_parse</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set the colortable to use the cubicles algorithm to lookup - the closest color. This is a mostly very fast and very - accurate way to find the correct color, and the default - algorithm. + Feed new data to the <code>Parser.HTML</code> + object. This will start a scan and may result in + callbacks. Note that it's possible that all + data feeded isn't processed - to do that, call + <code>finish</code>(). - The colorspace is divided in small cubes, each cube - containing the colors in that cube. Each cube then gets - a list of the colors in the cube, and the closest from - the corners and midpoints between corners. + If the function is called without arguments, + no data is feeded, but the parser is run. - When a color is needed, the algorithm first finds the - correct cube and then compares with all the colors in - the list for that cube. - - example: <tt>colors=Image.Colortable(img)->cubicles();</tt> - - algorithm time: between O[m] and O[m * n], - where n is numbers of colors and m is number of pixels - - The arguments can be heavy trimmed for the usage - of your colortable; a large number (10×10×10 or bigger) - of cubicles is recommended when you use the colortable - repeatedly, since the calculation takes much - more time than usage. - - recommended values: - - <pre> - image size setup - 100×100 cubicles(4,5,4) (default) - 1000×1000 cubicles(12,12,12) (factor 2 faster than default) - </pre> - - In some cases, the <code>full</code> method is faster. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Colortable.cubicles.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.cubicles.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.cubicles.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>default cubicles, 16 colors</td> - <td>accuracy=200</td> - </tr></table> + + If the string argument is followed by a 0, + <tt>->feed(s,0);</tt>, the string is feeded, + but the parser isn't run. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>Size, ie how much the colorspace is divided. - Note that the size of each cubicle is at least about 8b, - and that it takes time to calculate them. The number of - cubicles are <tt>r*g*b</tt>, and default is 4,5,4, - ie 80 cubicles. This works good for 200±100 colors. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>accuracy</code></dt> - <dd></dd><dd class='body--doc'>Accuracy when checking sides of cubicles. - Default is 16. A value of 1 gives complete accuracy, - ie cubicle() method gives exactly the same result - as full(), but takes (in worst case) 16× the time - to calculate. - </dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> the called object </dd> - <dt class='head--doc'>Note</dt> + <dt class='head--doc'>See also</dt> <dd class='body--doc'> - this method doesn't figure out the cubicles, this is - done on the first use of the colortable. + <code>finish</code>, <code>read</code>, <code>feed_insert</code></dd></dl> - Not applicable to colorcube types of colortable. - </dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - floyd_steinberg + feed_insert </dt> - <dd><code><code class='object unresolved'>object </code> floyd_steinberg()</code> - <code><code class='object unresolved'>object </code> floyd_steinberg(<code class='datatype'>int</code> <code class='argument'>bidir</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>forward</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>downforward</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>down</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>downback</code>, <code class='datatype'>int</code>|<code class='datatype'>float</code> <code class='argument'>factor</code>)</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> feed_insert(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set dithering method to floyd_steinberg. - - The arguments to this method is for fine-tuning of the - algorithm (for computer graphics wizards). - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Colortable.floyd_steinberg.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.floyd_steinberg.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.floyd_steinberg.3.png' width='80' /></td> - </tr><tr valign='center'> - <td>original</td> - <td>floyd_steinberg to a 4×4×4 colorcube</td> - <td>floyd_steinberg to 16 chosen colors</td> - </tr></table> + This pushes a string on the parser stack. + (I'll write more about this mechanism later.) </dd> - <dt class='head--doc'>Parameter <code class='parameter'>bidir</code></dt> - <dd></dd><dd class='body--doc'>Set algorithm direction of forward. - -1 is backward, 1 is forward, 0 for toggle of direction - each line (default).</dd> - <dt class='head--doc'>Parameter <code class='parameter'>forward</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>downforward</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>down</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>downback</code></dt> - <dd></dd><dd class='body--doc'>Set error correction directions. Default is - forward=7, downforward=1, down=5, downback=3.</dd> - <dt class='head--doc'>Parameter <code class='parameter'>factor</code></dt> - <dd></dd><dd class='body--doc'>Error keeping factor. - Error will increase if more than 1.0 and decrease if less than 1.0. - A value of 0.0 will cancel any dither effects. - Default is 0.95.</dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> the called object
3795: <hr /> <dl class='group--doc'> <dt class='head--type'>Method - full + finish </dt> - <dd><code><code class='object unresolved'>object </code> full()</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> finish()</code> + <code><code class='object unresolved'>Parser.HTML </code> finish(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set the colortable to use full scan to lookup the closest color. - - example: <tt>colors=Image.Colortable(img)->full();</tt> - - algorithm time: O[n*m], where n is numbers of colors - and m is number of pixels + Finish a parser pass. A string may be sent here, similar to + feed(). </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'> the called object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Not applicable to colorcube types of colortable. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>cubicles</code>, <code>map</code></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - image - </dt> - <dd><code><code class='object unresolved'>object </code> image()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - cast the colortable to an image object - - each pixel in the image object is an entry in the colortable - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the resulting image object + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - nodither + get_extra </dt> - <dd><code><code class='object unresolved'>object </code> nodither()</code></dd> + <dd><code><code class='object unresolved'>array </code> get_extra()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set no dithering (default). + Gets the extra arguments set by <code>set_extra</code>(). </dd> <dt class='head--doc'>Returns</dt>
3863: <hr /> <dl class='group--doc'> <dt class='head--type'>Method - ordered + parse_tag_args </dt> - <dd><code><code class='object unresolved'>object </code> ordered()</code> - <code><code class='object unresolved'>object </code> ordered(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> ordered(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code> - <code><code class='object unresolved'>object </code> ordered(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>x</code>, <code class='datatype'>int</code> <code class='argument'>y</code>)</code> - <code><code class='object unresolved'>object </code> ordered(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>, <code class='datatype'>int</code> <code class='argument'>rx</code>, <code class='datatype'>int</code> <code class='argument'>ry</code>, <code class='datatype'>int</code> <code class='argument'>gx</code>, <code class='datatype'>int</code> <code class='argument'>gy</code>, <code class='datatype'>int</code> <code class='argument'>bx</code>, <code class='datatype'>int</code> <code class='argument'>by</code>)</code></dd> + <dd><code><code class='object unresolved'>mapping </code> parse_tag_args(<code class='datatype'>string</code> <code class='argument'>tag</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set ordered dithering, which gives a position-dependent error added - to the pixel values. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.3.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.4.png' width='80' /></td> - </tr><tr valign='top'> - <td>original</td> - <td colspan='2'>mapped to <tt>Image.Colortable(6,6,6)-></tt></td> - </tr><tr valign='top'> - <td></td> - <td><tt>ordered (42,42,42,2,2)</tt></td> - <td><tt>ordered()</tt></td> - <td><tt>ordered (42,42,42, 8,8, 0,0, 0,1, 1,0)</tt></td> - </tr><tr valign='top'> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.5.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.6.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.7.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.ordered.8.png' width='80' /></td> - </tr></table> - + Parses the tag arguments from a tag string without the name + and surrounding brackets, i.e. a string on the form + "<tt>some="tag" args</tt>". </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd><dd class='body--doc'>The maximum error. Default is 32, or colorcube steps (256/size). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>xsize</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ysize</code></dt> - <dd></dd><dd class='body--doc'>Size of error matrix. Default is 8×8. - Only values which factors to multiples of 2 and 3 are - possible to choose (2,3,4,6,8,12,...). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>x</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>y</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>rx</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>ry</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>gx</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>gy</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>bx</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>by</code></dt> - <dd></dd><dd class='body--doc'>Offset for the error matrix. <tt>x</tt> and <tt>y</tt> is for - both red, green and blue values, the other is individual. - </dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the called object + a mapping containing the tag arguments </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'> - <code>randomcube</code>, <code>nodither</code>, <code>floyd_steinberg</code>, <code>create</code></dd></dl> + <code>tag_args</code></dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - randomcube - Method - randomgrey + parse_tag_name </dt> - <dd><code><code class='object unresolved'>object </code> randomcube()</code> - <code><code class='object unresolved'>object </code> randomcube(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>object </code> randomgrey()</code> - <code><code class='object unresolved'>object </code> randomgrey(<code class='datatype'>int</code> <code class='argument'>err</code>)</code></dd> + <dd><code><code class='object unresolved'>string </code> parse_tag_name(<code class='datatype'>string</code> <code class='argument'>tag</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set random cube dithering. - Color choosen is the closest one to color in picture - plus (flat) random error; <tt>color±random(error)</tt>. - - The randomgrey method uses the same random error on red, green - and blue and the randomcube method has three random errors. - - <table><tr valign='center'> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.1.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.2.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.3.png' width='80' /></td> - </tr><tr valign='top'> - <td>original</td> - <td colspan='2'>mapped to <tt>Image.Colortable(4,4,4)-></tt></td> - </tr><tr valign='top'> - <td></td> - <td>randomcube()</td> - <td>randomgrey()</td> - </tr><tr valign='top'> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.4.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.5.png' width='80' /></td> - <td><img height='115' src='../images/predef.Image.Colortable.randomcube.6.png' width='80' /></td> - </tr></table> - + Parses the tag name from a tag string without the surrounding + brackets, i.e. a string on the form "<tt>tagname some="tag" + args</tt>". </dd> - <dt class='head--doc'>Parameter <code class='parameter'>r</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>g</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>b</code></dt> - <dd></dd> - <dt class='head--doc'>Parameter <code class='parameter'>err</code></dt> - <dd></dd><dd class='body--doc'>The maximum error. Default is 32, or colorcube step. - </dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the called object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - <code>randomgrey</code> method needs colorcube size to be the same on - red, green and blue sides to work properly. It uses the - red colorcube value as default. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>ordered</code>, <code>nodither</code>, <code>floyd_steinberg</code>, <code>create</code></dd></dl> + the tag name or an empty string if none + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - reduce - Method - reduce_fs + read </dt> - <dd><code><code class='object unresolved'>object </code> reduce(<code class='datatype'>int</code> <code class='argument'>colors</code>)</code> - <code><code class='object unresolved'>object </code> reduce_fs(<code class='datatype'>int</code> <code class='argument'>colors</code>)</code></dd> + <dd><code><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) read()</code> + <code><code class='datatype'>string</code>|<code class='datatype'>array</code>(<code class='datatype'>mixed</code>) read(<code class='datatype'>int</code> <code class='argument'>max_elems</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - reduces the number of colors + Read parsed data from the parser object. - All needed (see <code>create</code>) colors are kept. - - <code>reduce_fs</code> creates and keeps - the outmost corners of the color space, to - improve floyd-steinberg dithering result. - (It doesn't work very well, though.) - + <code>mixed_mode</code>, an array of arbitrary data otherwise. </dd> - <dt class='head--doc'>Parameter <code class='parameter'>colors</code></dt> - <dd></dd><dd class='body--doc'>target number of colors - </dd> + <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the new <code>Colortable</code> object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - this algorithm assumes all colors are different to - begin with (!) + a string of parsed data if the parser isn't in + </dd></dl> - <code>reduce_fs</code> keeps the "corners" as - "needed colors". - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>corners</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rigid + set_extra </dt> - <dd><code><code class='object unresolved'>object </code> rigid()</code> - <code><code class='object unresolved'>object </code> rigid(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> set_extra(<code class='datatype'>mixed</code> <code class='argument'>...args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Set the colortable to use the "rigid" method of - looking up colors. - - This is a very simple way of finding the correct - color. The algorithm initializes a cube with - <tt>r</tt> x <tt>g</tt> x <tt>b</tt> colors, - where every color is chosen by closest match to - the corresponding coordinate. - - This format is not recommended for exact match, - but may be usable when it comes to quickly - view pictures on-screen. - - It has a high init-cost and low use-cost. - The structure is initiated at first usage. + Sets the extra arguments passed to all tag, container and + entity callbacks. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'> the called object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Not applicable to colorcube types of colortable. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>cubicles</code>, <code>map</code>, <code>full</code></dd></dl> + </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - spacefactors + splice_arg </dt> - <dd><code><code class='object unresolved'>object </code> spacefactors(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='object unresolved'>string </code> splice_arg(<code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>name</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Colortable tuning option, this sets the color space - distance factors. This is used when comparing distances - in the colorspace and comparing grey levels. + If given a string, it sets the splice argument name to it. It - Default factors are 3, 4 and 1; blue is much - darker than green. Compare with <code>Image.Image->grey</code>(). - + If a splice argument name is set, it's parsed in all tags, + both those with callbacks and those without. Wherever it + occurs, its value (after being parsed for entities in the + normal way) is inserted directly into the tag. E.g: + <pre> + <foo arg1="val 1" splice="arg2='val 2' arg3" arg4> + </pre> + becomes + <pre> + <foo arg1="val 1" arg2='val 2' arg3 arg4> + </pre> + if "splice" is set as the splice argument name. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the called object - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - This has no sanity check. Some functions may bug - if the factors are to high - color reduction functions - sums grey levels in the image, this could exceed maxint - in the case of high factors. Negative values may - also cause strange effects. *grin* + the old splice argument name. </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Image.Color</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - - This module keeps names and easy handling - for easy color support. It gives you an easy - way to get colors from names. + - A color is here an object, containing color - information and methods for conversion, see below. + - <code>Image.Color</code> can be called to make a color object. - <code>Image.Color()</code> takes the following arguments: - <pre> - Image.Color(string name) // "red" - Image.Color(string prefix_string) // "lightblue" - Image.Color(string hex_name) // "#ff00ff" - Image.Color(string cmyk_string) // "%17,42,0,19.4" - Image.Color(string hsv_string) // "%@327,90,32" - Image.Color(int red, int green, int blue) - </pre> - - The color names available can be listed by using indices - on Image.Color. The colors are available by name directly - as <tt>Image.Color.name</tt>, too: - <pre> - ...Image.Color.red... - ...Image.Color.green... - or, maybe - import Image.Color; - ...red... - ...green... - ...lightgreen... - </pre> - - Giving red, green and blue values is equal to calling - <code>Image.Color.rgb</code>(). - - The prefix_string method is a form for getting modified - colors, it understands all modifiers - (<code>light</code>, - <code>dark</code>, - <code>bright</code>, - <code>dull</code> and - <code>neon</code>). Simply use - "method"+"color"; (as in <tt>lightgreen</tt>, - <tt>dullmagenta</tt>, <tt>lightdullorange</tt>). - - The <tt>hex_name</tt> form is a simple - <tt>#rrggbb</tt> form, as in HTML or X-program argument. - A shorter form (<tt>#rgb</tt>) is also accepted. This - is the inverse to the <code>Image.Color.Color->hex</code>() - method. - - The <tt>cmyk_string</tt> is a string form of giving - cmyk (cyan, magenta, yellow, black) color. These - values are floats representing percent. - - The <tt>hsv_string</tt> is another hue, saturation, value - representation, but in floats; hue is in degree range (0..360), - and saturation and value is given in percent. This is not - the same as returned or given to the <code>hsv</code>() methods! - - - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - <tt>Image.Color["something"]</tt> will never(!) generate an error, - but a zero_type 0, if the color is unknown. This is enough - to give the error "not present in module", if used - as <tt>Image.Color.something</tt>, though. - - If you are using colors from for instance a webpage, you might - want to create the color from <code>Image.Color.guess</code>(), - since that method is more tolerant for mistakes and errors. - - <tt>Image.Color</tt>() is case- and space-sensitive. - Use <code>Image.Color.guess</code>() to catch all variants. - - and subtract with a space (lower_case(x)-" ") to make - sure you get all variants. - - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image.Color.Color->name</code>, <code>Image.Color.Color->rgb</code>, <code>colors</code>, <code>Image.Color.Color</code>, <code>Image.Color.guess</code>, <code>Image</code>, <code>Image.Colortable</code></dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - _indices + tag Method - _values + tag_name + Method + tag_args + Method + tag_content </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) _indices()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>object</code>) _values()</code></dd> + <dd><code><code class='object unresolved'>array </code> tag()</code> + <code><code class='object unresolved'>string </code> tag_name()</code> + <code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) tag_args()</code> + <code><code class='object unresolved'>string </code> tag_content()</code> + <code><code class='object unresolved'>array </code> tag(<code class='datatype'>mixed</code> <code class='argument'>default_value</code>)</code> + <code><code class='object unresolved'>string </code> tag_args(<code class='datatype'>mixed</code> <code class='argument'>default_value</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - (ie as <tt>indices(Image.Color)</tt> or <tt>values(Image.Color)</tt>) - <tt>indices</tt> gives a list of all the known color names, - <tt>values</tt> gives there corresponding objects. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image.Color</code></dd></dl> + These give parsed information about the current thing being + parsed, e.g. the current tag, container or entity. They return + zero if they're not applicable. - + + <tt>tag_name</tt> gives the name of the current tag. If used + from an entity callback, it gives the string inside the + entity. - + + <tt>tag_args</tt> gives the arguments of the current tag, + parsed to a convenient mapping consisting of key:value pairs. + If the current thing isn't a tag, it gives zero. default_value + is used for arguments which have no value in the tag. If + default_value isn't given, the value is set to the same string + as the key. + + + <tt>tag_content</tt> gives the content of the current tag, if + it's a container or quote tag. + + + <tt>tag()</tt> gives the equivalent of + <tt>({tag_name(),tag_args(), tag_content()})</tt>. + </dd></dl> + + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - rgb - Method - hsv - Method - cmyk - Method - greylevel - Method - html + write_out </dt> - <dd><code><code class='object unresolved'>object </code> rgb(<code class='datatype'>int</code> <code class='argument'>red</code>, <code class='datatype'>object</code> <code class='argument'>intgreen</code>, <code class='datatype'>object</code> <code class='argument'>intblue</code>)</code> - <code><code class='object unresolved'>object </code> hsv(<code class='datatype'>int</code> <code class='argument'>hue</code>, <code class='datatype'>object</code> <code class='argument'>intsaturation</code>, <code class='datatype'>object</code> <code class='argument'>intvalue</code>)</code> - <code><code class='object unresolved'>object </code> cmyk(<code class='datatype'>float</code> <code class='argument'>c</code>, <code class='datatype'>float</code> <code class='argument'>m</code>, <code class='datatype'>float</code> <code class='argument'>y</code>, <code class='datatype'>float</code> <code class='argument'>k</code>)</code> - <code><code class='object unresolved'>object </code> greylevel(<code class='datatype'>int</code> <code class='argument'>level</code>)</code> - <code><code class='object unresolved'>object </code> html(<code class='datatype'>string</code> <code class='argument'>html_color</code>)</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML </code> write_out(<code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'> - Creates a new color object from given red, green and blue, - hue, saturation and value, or greylevel, in color value range. - It could also be created from cmyk values in percent. + Send data to the output stream, i.e. it won't be parsed and + it won't be sent to the data callback, if any. - The <code>html</code>() method only understands the HTML color names, - or the <tt>#rrggbb</tt> form. It is case insensitive. + + Any data is allowed when the parser is running in + <code>mixed_mode</code>. Only strings are allowed otherwise. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'> - the created object. + the called object </dd></dl> - + </dd></dl><dl><dt><h2 class='header'>Module Parser</h2> + </dt><dd> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - guess + . </dt> - <dd><code><code class='object unresolved'>object </code> guess(<code class='datatype'>string</code> <code class='argument'>color</code>)</code></dd> + <dd><code> .()</code></dd> + </dl> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is equivalent to - <tt><code>Image.Color</code>(lower_case(str)-" ")</tt>, - and tries the color with a prepending '#' if no - corresponding color is found. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a color object or zero_type - </dd></dl> - <dl><dt><h2 class='header'>Class Image.Color.Color</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is the color object. It has six readable variables, - <tt>r</tt>, <tt>g</tt>, <tt>b</tt>, for the red, - green and blue values, - and <tt>h</tt>, <tt>s</tt>, <tt>v</tt>, for - the hue, saturation anv value values. - </dd></dl> + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - `== + decode_numeric_xml_entity </dt> - <dd><code><code class='object unresolved'>int </code> res = <code class='class'>Image.Color.Color()</code> == <code class='class'>other_color</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Color.Color()</code> == <code class='class'>rgb</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Color.Color()</code> == <code class='class'>greylevel</code></code> - <code><code class='object unresolved'>int </code> res = <code class='class'>Image.Color.Color()</code> == <code class='class'>name</code></code></dd> + <dd><code><code class='datatype'>string</code> decode_numeric_xml_entity(<code class='datatype'>string</code> <code class='argument'>chref</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Compares this object to another color, - or color name. Example: - <pre> - object red=Image.Color.red; - object other=Image.Color. ...; - object black=Image.Color.black; + <dd class='body--doc'>Decodes the numeric XML entity <code>chref</code>, e.g. <tt>"&#x34;"</tt> and + returns the character as a string. <code>chref</code> is the name part of + the entity, i.e. without the leading '&' and trailing ';'. Returns + zero if <code>chref</code> isn't on a recognized form or if the character + number is too large to be represented in a string. + </dd></dl> - if (red==other) ... - if (red==({255,0,0})) ... - if (black==0) ... - if (red=="red") ... - </pre> - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - 1 or 0 - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - The other datatype (not color object) must be to the right! - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>rgb</code>, <code>grey</code>, <code>name</code></dd></dl> + - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - bits + get_xml_parser </dt> - <dd><code><code class='object unresolved'>int </code> bits(<code class='datatype'>object</code> <code class='argument'>intrbits</code>, <code class='datatype'>object</code> <code class='argument'>intgbits</code>, <code class='datatype'>object</code> <code class='argument'>intbbits</code>, <code class='datatype'>object</code> <code class='argument'>intrshift</code>, <code class='datatype'>object</code> <code class='argument'>intgshift</code>, <code class='datatype'>object</code> <code class='argument'>intbshift</code>)</code></dd> + <dd><code><code class='object unresolved'>Parser.HTML</code> get_xml_parser()</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Returns the color as an integer + <dd class='body--doc'>Returns a <code>Parser.HTML</code> initialized for parsing XML. It has all + the flags set properly for XML syntax and callbacks to ignore + comments, CDATA blocks and unknown PI tags, but it has no + registered tags and doesn't decode any entities. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - light + html_entity_parser Method - dark - Method - neon - Method - bright - Method - dull + parse_html_entities </dt> - <dd><code><code class='object unresolved'>object </code> light()</code> - <code><code class='object unresolved'>object </code> dark()</code> - <code><code class='object unresolved'>object </code> neon()</code> - <code><code class='object unresolved'>object </code> bright()</code> - <code><code class='object unresolved'>object </code> dull()</code></dd> + <dd><code><code class='object unresolved'>HTML</code> html_entity_parser()</code> + <code><code class='datatype'>string</code> parse_html_entities(<code class='datatype'>string</code> <code class='argument'>in</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Color modification methods. These returns - a new color. - <table> - <tr><th>method</th><th width='50%'>effect</th> - <th>h</th><th>s</th><th>v</th><th>as</th></tr> - <tr><td>light </td><td>raise light level</td><td>±0</td><td> ±0</td><td>+50</td> - <td><img height='20' src='../images/predef.Image.Color.Color.light.1.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.2.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.3.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.4.png' width='20' /></td></tr> - - <tr><td>dark </td><td>lower light level</td><td>±0</td><td> ±0</td><td>-50</td> - <td><img height='20' src='../images/predef.Image.Color.Color.light.5.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.6.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.7.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.8.png' width='20' /></td></tr> - - <tr><td>bright</td><td>brighter color </td><td>±0</td><td>+50</td><td>+50</td> - <td><img height='20' src='../images/predef.Image.Color.Color.light.9.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.10.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.11.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.12.png' width='20' /></td></tr> - - <tr><td>dull </td><td>greyer color </td><td>±0</td><td>-50</td><td>-50</td> - <td><img height='20' src='../images/predef.Image.Color.Color.light.13.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.14.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.15.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.16.png' width='20' /></td></tr> - - <tr><td>neon </td><td>set to extreme </td><td>±0</td><td>max</td><td>max</td> - <td><img height='20' src='../images/predef.Image.Color.Color.light.17.png' width='20' /> - <img height='20' src='../images/predef.Image.Color.Color.light.18.png' width='20' /></td></tr> - - </table> - - <code>light</code> and <code>dark</code> lower/highers saturation - when value is min-/maximised respective. - + <dd class='body--doc'>Parse any HTML entities in the string to unicode characters. + Either return a complete parser (to build on or use) or parse + a string. Throw an error if there is an unrecognized entity in + the string. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the new color object - </dd> + <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - The opposites may not always take each other out. - The color is maximised at white and black levels, - so, for instance - <code>Image.Color</code>.white-><code>light</code>()-><code>dark</code>() - doesn't give the white color back, but the equal to - <code>Image.Color</code>.white-><code>dark</code>(), since - white can't get any <code>light</code>er. + <dd class='body--doc'>Currently using XHTML 1.0 tables. </dd></dl> - + <dl><dt><h2 class='header'>Class Parser.RCS</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>A RCS file parser that eats a RCS *,v file and presents nice pike + data structures of its contents. + </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - cast + <dt class='head--type'>Variable + access </dt> - <dd><code>(<code class='datatype'>array</code>)Image.Color.Color() </code></dd> + <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) Parser.RCS.access</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - cast the object to an array, representing red, green - and blue (equal to <tt>-><code>rgb</code>()</tt>), or - to a string, giving the name (equal to <tt>-><code>name</code>()</tt>). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - the name as string or rgb as array - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>rgb</code>, <code>name</code></dd></dl> + <dd class='body--doc'>The usernames listed in the ACCESS section of the RCS file + </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - rgb - Method - rgbf - Method - hsv - Method - hsvf - Method - cmyk - Method - greylevel + <dt class='head--type'>Variable + branch </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>int</code>) rgb()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>float</code>) rgbf()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>int</code>) hsv()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>float</code>) hsvf()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>float</code>) cmyk()</code> - <code><code class='object unresolved'>int </code> greylevel()</code> - <code><code class='object unresolved'>int </code> greylevel(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>object</code> <code class='argument'>intg</code>, <code class='datatype'>object</code> <code class='argument'>intb</code>)</code></dd> + <dd><code><code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code> Parser.RCS.branch</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is methods of getting information from an - <code>Image.Color.Color</code> object. + <dd class='body--doc'>The default branch (or revision), if present, <code class='expr'>0</code> otherwise + </dd></dl> - They give an array of - red, green and blue (rgb) values (color value), - hue, saturation and value (hsv) values (range as color value), - cyan, magenta, yellow, black (cmyk) values (in percent) - or the greylevel value (range as color value). + - The greylevel is calculated by weighting red, green - and blue. Default weights are 87, 127 and 41, respective, - and could be given by argument. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - array(int) respective int - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image.Color.Color</code>, <code>grey</code></dd></dl> + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Variable + branches + </dt> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) Parser.RCS.branches</code></dd> - + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Maps branch numbers (indices) to branch names (values) + </dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - create + <dt class='head--type'>Variable + comment </dt> - <dd><code>Image.Color.Color Image.Color.Color(<code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code> Parser.RCS.comment</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - This is the main <code>Image.Color.Color</code> creation - method, mostly for internal use. - + <dd class='body--doc'>The RCS file comment if present, <code class='expr'>0</code> otherwise </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - grey + create </dt> - <dd><code><code class='object unresolved'>object </code> grey()</code> - <code><code class='object unresolved'>object </code> grey(<code class='datatype'>int</code> <code class='argument'>red</code>, <code class='datatype'>int</code> <code class='argument'>green</code>, <code class='datatype'>int</code> <code class='argument'>blue</code>)</code></dd> + <dd><code>Parser.RCS Parser.RCS(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>file_name</code>, <code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code>|<code class='datatype'>void</code> <code class='argument'>file_contents</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Gives a new color, containing a grey color, - which is calculated by the <code>greylevel</code> method. + <dd class='body--doc'>Initializes the RCS object. </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new <code>Image.Color.Color</code> object + <dt class='head--doc'>Parameter <code class='parameter'>file_name</code></dt> + <dd></dd><dd class='body--doc'>The path to the raw RCS file (includes trailing ",v"). Used + mainly for error reporting (truncated RCS file). </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>greylevel</code></dd></dl> + <dt class='head--doc'>Parameter <code class='parameter'>file_contents</code></dt> + <dd></dd><dd class='body--doc'>If a string is provided, that string will be parsed to + initialize the RCS object. If a zero (<code class='expr'>0</code>) is sent, no + initialization will be performed at all. If no value is given at + all, but <code>file_name</code> was provided, that file will be loaded and + parsed for object initialization. + </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - hex - Method - name - Method - html + <dt class='head--type'>Variable + description </dt> - <dd><code><code class='object unresolved'>string </code> hex()</code> - <code><code class='object unresolved'>string </code> hex(<code class='datatype'>int</code> <code class='argument'>n</code>)</code> - <code><code class='object unresolved'>string </code> name()</code> - <code><code class='object unresolved'>string </code> html()</code></dd> + <dd><code><code class='datatype'>string</code> Parser.RCS.description</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Information methods. + <dd class='body--doc'>The RCS file description + </dd></dl> - <code>hex</code>() simply gives a string on the <tt>#rrggbb</tt> - format. If <tt>n</tt> is given, the number of significant - digits is set to this number. - (Ie, <tt>n=3</tt> gives <tt>#rrrgggbbb</tt>.) + - <code>name</code>() is a simplified method; - if the color exists in the database, the name is returned, - per default is the <code>hex</code>() method use. - - <code>html</code>() gives the <tt>HTML</tt> name of - the color, or the <code>hex</code>(2) if it isn't one - of the 16 <tt>HTML</tt> colors. - - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new <code>Image.Color.Color</code> object - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>rgb</code>, <code>hsv</code>, <code>Image.Color</code></dd></dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Image.ANY</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - - This method calls the other decoding methods - and has some heuristics for what type of image - this is. - - Methods: - <code>decode</code>, <code>decode_alpha</code>, - <code>_decode</code> - - - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image</code></dd></dl> - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - _decode - Method - decode - Method - decode_alpha + <dt class='head--type'>Variable + expand </dt> - <dd><code><code class='object unresolved'>mapping </code> _decode(<code class='datatype'>string</code> <code class='argument'>data</code>)</code> - <code><code class='object unresolved'>object </code> decode(<code class='datatype'>string</code> <code class='argument'>data</code>)</code> - <code><code class='object unresolved'>object </code> decode_alpha(<code class='datatype'>string</code> <code class='argument'>data</code>)</code></dd> + <dd><code><code class='datatype'>string</code> Parser.RCS.expand</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Tries heuristics to find the correct method - of decoding the data, then calls that method. - - The result of _decode() is a mapping that contains - <pre> - "type":image data type (ie, "image/jpeg" or similar) - "image":the image object, - "alpha":the alpha channel or 0 if N/A - </pre> - - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'> - Throws upon failure. + <dd class='body--doc'>The keyword expansion options (as named by RCS) if present, + <code class='expr'>0</code> otherwise </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Image</h2> - </dt><dd> + - + <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - load - Method - load_layer - Method - load_layers - Method - _load + <dt class='head--type'>Variable + head </dt> - <dd><code><code class='object unresolved'>Image.Layer</code> load()</code> - <code><code class='object unresolved'>Image.Image</code> load(<code class='datatype'>object</code> <code class='argument'>file</code>)</code> - <code><code class='object unresolved'>Image.Image</code> load(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> load_layer()</code> - <code><code class='object unresolved'>Image.Layer</code> load_layer(<code class='datatype'>object</code> <code class='argument'>file</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> load_layer(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='datatype'>array</code>(<code class='object unresolved'>Image.Layer</code>) load_layers()</code> - <code><code class='datatype'>array</code>(<code class='object unresolved'>Image.Layer</code>) load_layers(<code class='datatype'>object</code> <code class='argument'>file</code>)</code> - <code><code class='datatype'>array</code>(<code class='object unresolved'>Image.Layer</code>) load_layers(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='datatype'>mapping</code> _load()</code> - <code><code class='datatype'>mapping</code> _load(<code class='datatype'>object</code> <code class='argument'>file</code>)</code> - <code><code class='datatype'>mapping</code> _load(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> + <dd><code><code class='datatype'>string</code> Parser.RCS.head</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Helper function to load an image from a file. - If no filename is given, Stdio.stdin is used. - The result is the same as from the decode functions - in <code>Image.ANY</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>All data is read, ie nothing happens until the file is closed. - Throws upon error. + <dd class='body--doc'>Version number of the head version of the file </dd></dl> <hr /> <dl class='group--doc'> - <dt class='head--type'>Method - filled_circle - Method - filled_circle_layer + <dt class='head--type'>Variable + locks </dt> - <dd><code><code class='object unresolved'>Image.Image</code> filled_circle(<code class='datatype'>int</code> <code class='argument'>d</code>)</code> - <code><code class='object unresolved'>Image.Image</code> filled_circle(<code class='datatype'>int</code> <code class='argument'>xd</code>, <code class='datatype'>int</code> <code class='argument'>yd</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>d</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>xd</code>, <code class='datatype'>int</code> <code class='argument'>yd</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>d</code>, <code class='object unresolved'>Image.Color</code> <code class='argument'>color</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>xd</code>, <code class='datatype'>int</code> <code class='argument'>yd</code>, <code class='object unresolved'>Image.Color</code> <code class='argument'>color</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>d</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code> - <code><code class='object unresolved'>Image.Layer</code> filled_circle_layer(<code class='datatype'>int</code> <code class='argument'>xd</code>, <code class='datatype'>int</code> <code class='argument'>yd</code>, <code class='datatype'>int</code> <code class='argument'>r</code>, <code class='datatype'>int</code> <code class='argument'>g</code>, <code class='datatype'>int</code> <code class='argument'>b</code>)</code></dd> + <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) Parser.RCS.locks</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Generates a filled circle of the - dimensions xd x yd (or d x d). - The Image is a white circle on black background; the layer - function defaults to a white circle (the background is transparent). + <dd class='body--doc'>Maps from username to revision for users that have acquired locks + on this file </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method - lay + parse </dt> - <dd><code><code class='object unresolved'>Image.Layer </code> lay(<code class='datatype'>array</code>(<code class='object unresolved'>Image.Layer</code>|<code class='datatype'>mapping</code>) <code class='argument'>layers</code>)</code> - <code><code class='object unresolved'>Image.Layer </code> lay(<code class='datatype'>array</code>(<code class='object unresolved'>Image.Layer</code>|<code class='datatype'>mapping</code>) <code class='argument'>layers</code>, <code class='datatype'>int</code> <code class='argument'>xoffset</code>, <code class='datatype'>int</code> <code class='argument'>yoffset</code>, <code class='datatype'>int</code> <code class='argument'>xsize</code>, <code class='datatype'>int</code> <code class='argument'>ysize</code>)</code></dd> + <dd><code><code class='object unresolved'>this_program</code> parse(<code class='datatype'>string</code> <code class='argument'>raw</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>string</code>:<code class='datatype'>void</code>) <code class='argument'>progress_callback</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Combine layers. + <dd class='body--doc'>Parse the RCS file <code>raw</code> and initialize all members of this object + fully initialized. </dd> - + <dt class='head--doc'>Parameter <code class='parameter'>raw</code></dt> + <dd></dd><dd class='body--doc'>The unprocessed RCS file. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>progress_callback</code></dt> + <dd></dd><dd class='body--doc'>Passed on to <code>parse_deltatext_sections</code>. + </dd> <dt class='head--doc'>Returns</dt> - <dd class='body--doc'> - a new layer object. + <dd class='body--doc'>The fully initialized object (only returned for API convenience; + the object itself is destructively modified to match the data + extracted from <code>raw</code>) </dd> <dt class='head--doc'>See also</dt> - <dd class='body--doc'> - <code>Image.Layer</code></dd></dl> - <dl><dt><h2 class='header'>Module Image.AVS</h2> - </dt><dd> + <dd class='body--doc'><code>parse_admin_section</code>, <code>parse_delta_sections</code>, + <code>parse_deltatext_sections</code>, <code>create</code> + </dd></dl> - + <hr /> <dl class='group--doc'> <dt class='head--type'>Method - decode - Method - _decode - Method - encode + parse_admin_section </dt> - <dd><code><code class='object unresolved'>object </code> decode(<code class='datatype'>string</code> <code class='argument'>data</code>)</code> - <code><code class='object unresolved'>mapping </code> _decode(<code class='datatype'>string</code> <code class='argument'>data</code>)</code> - <code><code class='object unresolved'>string </code> encode(<code class='datatype'>object</code> <code class='argument'>image</code>)</code></dd> + <dd><code><code class='datatype'>string</code> parse_admin_section(<code class='datatype'>string</code> <code class='argument'>raw</code>)</code></dd> <dt class='head--doc'>Description</dt> - <dd class='body--doc'> - Handle encoding and decoding of AVS-X images. - AVS is rather trivial, and not really useful, but: - - An AVS file is a raw (uncompressed) 24 bit image file with alpha. - The alpha channel is 8 bit, and there is no separate alpha for r, - g and b.

autodoc.git/ traditional_manual/ chapter_9.html

2002-05-26

2002-05-26 00:46:29 by Martin Nilsson <mani@lysator.liu.se>