/usr/share/doc/mlpost/html/Mlpost.Picture.html is in libmlpost-ocaml-doc 0.8.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mlpost.Transform.html">
<link rel="next" href="Mlpost.Command.html">
<link rel="Up" href="Mlpost.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mlpost" rel="Chapter" href="Mlpost.html">
<link title="Mlpost_dot" rel="Chapter" href="Mlpost_dot.html">
<link title="Mlpost_lablgtk" rel="Chapter" href="Mlpost_lablgtk.html"><link title="Special points of the bounding box of a picture" rel="Section" href="#2_Specialpointsoftheboundingboxofapicture">
<link title="Special points of the bounding box of a picture (Deprecated)" rel="Section" href="#2_SpecialpointsoftheboundingboxofapictureDeprecated">
<link title="Dimensions" rel="Section" href="#2_Dimensions">
<title>Mlpost.Picture</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Transform.html" title="Mlpost.Transform">Previous</a>
<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
<a class="post" href="Mlpost.Command.html" title="Mlpost.Command">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Picture.html">Mlpost.Picture</a></h1>
<pre><span class="keyword">module</span> Picture: <code class="code">sig</code> <a href="Mlpost.Picture.html">..</a> <code class="code">end</code></pre><div class="info module top">
Functions to manipulate commands as if they were pictures<br>
</div>
<hr width="100%">
<br>
Pictures are a powerful way to reuse and modify parts of a figure<br>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type"><a href="Mlpost.Command.html#TYPEt">Command.t</a></code> </pre>
<div class="info ">
The abstract type of pictures<br>
</div>
<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type"><a href="Mlpost.Command.html#TYPEt">Command.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Make a picture from a drawing command<br>
</div>
<pre><span id="VALtex"><span class="keyword">val</span> tex</span> : <code class="type">string -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Take a string in Latex format and transform it into a picture<br>
</div>
<pre><span id="VALtransform"><span class="keyword">val</span> transform</span> : <code class="type"><a href="Mlpost.Transform.html#TYPEt">Transform.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Apply a transformation to a picture<br>
</div>
<pre><span id="VALbbox"><span class="keyword">val</span> bbox</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Path.html#TYPEt">Path.t</a></code></pre><div class="info ">
Get the bounding box of a picture (with default padding, as
in MetaPost)<br>
</div>
<pre><span id="VALcorner_bbox"><span class="keyword">val</span> corner_bbox</span> : <code class="type">?dx:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> ?dy:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Path.html#TYPEt">Path.t</a></code></pre><div class="info ">
Get the bounding box of a picture, according to its corners
and supplied padding <code class="code">dx</code> and <code class="code">dy</code>.<br>
</div>
<pre><span id="VALcenter"><span class="keyword">val</span> center</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Place a picture centered at some point<br>
</div>
<pre><span id="VALplace_up_left"><span class="keyword">val</span> place_up_left</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Place a picture with its upper left corner at some point<br>
</div>
<pre><span id="VALplace_up_right"><span class="keyword">val</span> place_up_right</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Place a picture with its upper right corner at some point<br>
</div>
<pre><span id="VALplace_bot_left"><span class="keyword">val</span> place_bot_left</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Place a picture with its bottom left corner at some point<br>
</div>
<pre><span id="VALplace_bot_right"><span class="keyword">val</span> place_bot_right</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
Place a picture with its bottom right corner at some point<br>
</div>
<pre><span id="VALbeside"><span class="keyword">val</span> beside</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">beside p1 p2</code> returns a picture in which <code class="code">p2</code> is placed right
to <code class="code">p1</code><br>
</div>
<pre><span id="VALbelow"><span class="keyword">val</span> below</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">below p1 p2</code> returns a picture in which <code class="code">p2</code> is placed below <code class="code">p1</code><br>
</div>
<br>
<h2 id="2_Specialpointsoftheboundingboxofapicture">Special points of the bounding box of a picture</h2><br>
<pre><span id="VALctr"><span class="keyword">val</span> ctr</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="ctr.png" src="img/ctr.png"/></div>
<pre><span id="VALnorth"><span class="keyword">val</span> north</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="north.png" src="img/north.png"/></div>
<pre><span id="VALsouth"><span class="keyword">val</span> south</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="south.png" src="img/south.png"/></div>
<pre><span id="VALwest"><span class="keyword">val</span> west</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="west.png" src="img/west.png"/></div>
<pre><span id="VALeast"><span class="keyword">val</span> east</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="east.png" src="img/east.png"/></div>
<pre><span id="VALnorth_west"><span class="keyword">val</span> north_west</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="north_west.png" src="img/north_west.png"/></div>
<pre><span id="VALsouth_west"><span class="keyword">val</span> south_west</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="south_west.png" src="img/south_west.png"/></div>
<pre><span id="VALnorth_east"><span class="keyword">val</span> north_east</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="north_east.png" src="img/north_east.png"/></div>
<pre><span id="VALsouth_east"><span class="keyword">val</span> south_east</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
<img alt="south_east.png" src="img/south_east.png"/></div>
<pre><span id="VALcorner"><span class="keyword">val</span> corner</span> : <code class="type"><a href="Mlpost.Command.html#TYPEposition">Command.position</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><br>
<h2 id="2_SpecialpointsoftheboundingboxofapictureDeprecated">Special points of the bounding box of a picture (Deprecated)</h2><br>
<pre><span id="VALulcorner"><span class="keyword">val</span> ulcorner</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre><div class="info ">
These have been superseded by the preceding functions<br>
</div>
<pre><span id="VALllcorner"><span class="keyword">val</span> llcorner</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre>
<pre><span id="VALurcorner"><span class="keyword">val</span> urcorner</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre>
<pre><span id="VALlrcorner"><span class="keyword">val</span> lrcorner</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a></code></pre>
<pre><span id="VALclip"><span class="keyword">val</span> clip</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">clip pic path</code> limits <code class="code">pic</code> to the cyclic path <code class="code">path</code>; all elements
outside of <code class="code">path</code> are cut off.<br>
</div>
<br>
<h2 id="2_Dimensions">Dimensions</h2><br>
<pre><span id="VALwidth"><span class="keyword">val</span> width</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">Num.t</a></code></pre>
<pre><span id="VALheight"><span class="keyword">val</span> height</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Num.html#TYPEt">Num.t</a></code></pre><br>
Predefined Transformations<br>
<pre><span id="VALscale"><span class="keyword">val</span> scale</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="VALrotate"><span class="keyword">val</span> rotate</span> : <code class="type">float -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="VALshift"><span class="keyword">val</span> shift</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="VALyscale"><span class="keyword">val</span> yscale</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="VALxscale"><span class="keyword">val</span> xscale</span> : <code class="type"><a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="VALspin"><span class="keyword">val</span> spin</span> : <code class="type">float -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre>
<pre><span id="TYPEescaped"><span class="keyword">type</span> <code class="type"></code>escaped</span> = <code class="type">[ `Backslash | `Underscore ]</code> </pre>
<pre><span id="VALescape_latex"><span class="keyword">val</span> escape_latex</span> : <code class="type"><a href="Mlpost.Picture.html#TYPEescaped">escaped</a> list -> string -> string</code></pre>
<pre><span id="VALescape_all"><span class="keyword">val</span> escape_all</span> : <code class="type">string -> string</code></pre>
<pre><span id="VALset_pos"><span class="keyword">val</span> set_pos</span> : <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a> -> <a href="Mlpost.Picture.html#TYPEt">t</a></code></pre><div class="info ">
alias of center<br>
</div>
</body></html>
|