/usr/share/doc/mlpost/html/Mlpost.Arrow.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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | <!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.Box.html">
<link rel="next" href="Mlpost.Helpers.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="Drawing Arrows" rel="Section" href="#2_DrawingArrows">
<link title="Built-in Kinds" rel="Section" href="#2_BuiltinKinds">
<link title="Heads" rel="Section" href="#2_Heads">
<link title="Building Your Own Kinds" rel="Section" href="#2_BuildingYourOwnKinds">
<link title="Miscellaneous" rel="Section" href="#2_Miscellaneous">
<title>Mlpost.Arrow</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mlpost.Box.html" title="Mlpost.Box">Previous</a>
<a class="up" href="Mlpost.html" title="Mlpost">Up</a>
<a class="post" href="Mlpost.Helpers.html" title="Mlpost.Helpers">Next</a>
</div>
<h1>Module <a href="type_Mlpost.Arrow.html">Mlpost.Arrow</a></h1>
<pre><span class="keyword">module</span> Arrow: <code class="code">sig</code> <a href="Mlpost.Arrow.html">..</a> <code class="code">end</code></pre><div class="info module top">
Draw arrows and build new forms of arrows.<br>
</div>
<hr width="100%">
<br>
Draw simple or complex arrows.<br>
<br>
To draw an arrow, choose your arrow <code class="code">kind</code>, then call the <code class="code">draw</code> function
(giving the path that the arrow will follow) or the <code class="code">draw2</code> function
(giving the starting and ending points of the arrow). If your favorite
arrow <code class="code">kind</code> does not exist, use the tools from this module to build your
own!<br>
<pre><span id="TYPEkind"><span class="keyword">type</span> <code class="type"></code>kind</span> </pre>
<div class="info ">
The abstract type for arrow kinds.<br>
</div>
<br>
<h2 id="2_DrawingArrows">Drawing Arrows</h2><br>
<br>
If you need to place a label which is not TeX but any picture, if
you need to place it at a symbolic position on the path,
or if you need to place more than one label, you cannot do it directly
using the <code class="code">draw</code> commands. First draw the arrow, then use functions such
as <a href="Mlpost.Command.html#VALlabel"><code class="code">Command.label</code></a>.<br>
<pre><span id="VALsimple"><span class="keyword">val</span> simple</span> : <code class="type">?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?dashed:Dash.t -> <a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Draw a simple arrow following the given path.<br>
</div>
<div class="param_info"><code class="code">color</code> : the color of the arrow</div>
<div class="param_info"><code class="code">pen</code> : the pen to use to draw the body of the arrow</div>
<div class="param_info"><code class="code">dashed</code> : the dash pattern to use to draw the body of the arrow</div>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type">?kind:<a href="Mlpost.Arrow.html#TYPEkind">kind</a> -><br> ?tex:string -><br> ?pos:float -><br> ?anchor:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -> <a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Draw an arrow following the given path.<br>
</div>
<div class="param_info"><code class="code">kind</code> : the kind of arrow (default is <a href="Mlpost.Arrow.html#VALtriangle_full"><code class="code">Arrow.triangle_full</code></a>)</div>
<div class="param_info"><code class="code">tex</code> : add a LaTeX label</div>
<div class="param_info"><code class="code">pos</code> : label position on the path</div>
<div class="param_info"><code class="code">anchor</code> : label anchor</div>
<pre><span id="VALpoint_to_point"><span class="keyword">val</span> point_to_point</span> : <code class="type">?kind:<a href="Mlpost.Arrow.html#TYPEkind">kind</a> -><br> ?tex:string -><br> ?pos:float -><br> ?anchor:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -><br> ?outd:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?ind:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Use <code class="code">point_to_point a b</code> to draw an arrow from <code class="code">a</code> to <code class="code">b</code>.<br>
</div>
<div class="param_info"><code class="code">kind</code> : the kind of arrow (default is <a href="Mlpost.Arrow.html#VALtriangle_full"><code class="code">Arrow.triangle_full</code></a>)</div>
<div class="param_info"><code class="code">tex</code> : add a LaTeX label</div>
<div class="param_info"><code class="code">pos</code> : label position on the path</div>
<div class="param_info"><code class="code">anchor</code> : label anchor</div>
<div class="param_info"><code class="code">outd</code> : the outgoing direction, at the beginning of the arrow</div>
<div class="param_info"><code class="code">ind</code> : the ingoing direction, at the end of the arrow</div>
<pre><span id="VALbox_to_box"><span class="keyword">val</span> box_to_box</span> : <code class="type">?kind:<a href="Mlpost.Arrow.html#TYPEkind">kind</a> -><br> ?tex:string -><br> ?pos:float -><br> ?anchor:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -><br> ?outd:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?ind:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Use <code class="code">box_to_box</code> to draw an arrow from <code class="code">a</code> to <code class="code">b</code>, stopping at the
box boundaries. The arguments are the same as those of
<code class="code">point_to_point</code>.<br>
</div>
<pre><span id="VALpoint_to_box"><span class="keyword">val</span> point_to_box</span> : <code class="type">?kind:<a href="Mlpost.Arrow.html#TYPEkind">kind</a> -><br> ?tex:string -><br> ?pos:float -><br> ?anchor:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -><br> ?outd:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?ind:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Use <code class="code">point_to_box</code> to draw an arrow from <code class="code">a</code> to <code class="code">b</code>, stopping at the
box boundaries. The arguments are the same as those of
<code class="code">point_to_point</code>.<br>
</div>
<pre><span id="VALbox_to_point"><span class="keyword">val</span> box_to_point</span> : <code class="type">?kind:<a href="Mlpost.Arrow.html#TYPEkind">kind</a> -><br> ?tex:string -><br> ?pos:float -><br> ?anchor:<a href="Mlpost.Command.html#TYPEposition">Command.position</a> -><br> ?outd:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?ind:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> <a href="Mlpost.Box.html#TYPEt">Box.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Use <code class="code">box_to_point</code> to draw an arrow from <code class="code">a</code> to <code class="code">b</code>, stopping at the
box boundaries. The arguments are the same as those of
<code class="code">point_to_point</code>.<br>
</div>
<br>
<h2 id="2_BuiltinKinds">Built-in Kinds</h2><br>
<pre><span id="VALclassic"><span class="keyword">val</span> classic</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
A simple arrow with one line and two straight lines for the head.<br>
</div>
<pre><span id="VALtriangle"><span class="keyword">val</span> triangle</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
A simple arrow with a triangular head. Same as <code class="code">classic</code> but with an
extra line and some clipping.<br>
</div>
<pre><span id="VALtriangle_full"><span class="keyword">val</span> triangle_full</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
A simple arrow with a triangular head filled with black.<br>
</div>
<pre><span id="VALimplies"><span class="keyword">val</span> implies</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
An arrow made of two parallel lines and a classic head.<br>
</div>
<pre><span id="VALiff"><span class="keyword">val</span> iff</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
An arrow made of two parallel lines, a classic head and a classic
foot.<br>
</div>
<br>
<h2 id="2_Heads">Heads</h2><br>
<pre><span id="TYPEhead_description"><span class="keyword">type</span> <code class="type"></code>head_description</span> </pre>
<div class="info ">
The type of head descriptions (see <code class="code">make_head</code> and <code class="code">head</code> below).<br>
</div>
<pre><span id="VALmake_head"><span class="keyword">val</span> make_head</span> : <code class="type">?cut:<a href="Mlpost.Path.html#TYPEt">Path.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a> -> <a href="Mlpost.Arrow.html#TYPEhead_description">head_description</a></code></pre><div class="info ">
Head description constructor. The command parameter is used to draw
the head.<br>
</div>
<div class="param_info"><code class="code">cut</code> : a path that can be used to cut the arrow body lines
(only used by heads and feet, not by belts)</div>
<pre><span id="TYPEhead"><span class="keyword">type</span> <code class="type"></code>head</span> = <code class="type"><a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Arrow.html#TYPEhead_description">head_description</a></code> </pre>
<div class="info ">
If <code class="code">h</code> is a head, <code class="code">h p d</code> returns a head description used to
draw the head at point <code class="code">p</code> with direction <code class="code">d</code>. Direction <code class="code">d</code>
is normalized before being given to the function.<br>
</div>
<pre><span id="VALhead_classic"><span class="keyword">val</span> head_classic</span> : <code class="type">?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?dashed:Dash.t -><br> ?angle:float -> ?size:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Arrow.html#TYPEhead">head</a></code></pre><div class="info ">
A simple head with two straight lines.<br>
</div>
<div class="param_info"><code class="code">color</code> : the color of the head; default is black</div>
<div class="param_info"><code class="code">pen</code> : the pen used to draw the head; default is
<code class="code">Brush.Pen.default</code></div>
<div class="param_info"><code class="code">dashed</code> : if given, the head is drawn using that dash_style</div>
<div class="param_info"><code class="code">angle</code> : the angle between the two lines in degrees, default is 60
degrees</div>
<div class="param_info"><code class="code">size</code> : the length of the two lines, default is 4bp</div>
<pre><span id="VALhead_triangle"><span class="keyword">val</span> head_triangle</span> : <code class="type">?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?pen:Pen.t -><br> ?dashed:Dash.t -><br> ?angle:float -> ?size:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Arrow.html#TYPEhead">head</a></code></pre><div class="info ">
Same as <code class="code">head_classic</code> except that the two lines are joined together
to form a triangle.<br>
</div>
<pre><span id="VALhead_triangle_full"><span class="keyword">val</span> head_triangle_full</span> : <code class="type">?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?angle:float -> ?size:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Arrow.html#TYPEhead">head</a></code></pre><div class="info ">
Same as <code class="code">head_triangle</code> except that the triangle is not drawn (hence the
absence of pen properties) but is filled with the given <code class="code">color</code>.<br>
</div>
<br>
<h2 id="2_BuildingYourOwnKinds">Building Your Own Kinds</h2><br>
<br>
Start from the empty kind <code class="code">empty</code> and add features to it using
<code class="code">add_line</code>, <code class="code">add_head</code>, ...<br>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type"><a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
The empty kind with no line nor head.<br>
</div>
<pre><span id="VALadd_line"><span class="keyword">val</span> add_line</span> : <code class="type">?brush:<a href="Mlpost.Brush.html#TYPEt">Brush.t</a> -><br> ?dashed:Dash.t -><br> ?color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?pen:Pen.t -><br> ?from_point:float -><br> ?to_point:float -><br> ?dist:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
Add a line to a body. The line will be parallel to the path used
to draw the arrow.<br>
</div>
<div class="param_info"><code class="code">dashed</code> : the dash style used to draw the line (default is plain)</div>
<div class="param_info"><code class="code">color</code> : the color of the line (default is black)</div>
<div class="param_info"><code class="code">pen</code> : the pen used to draw the line
(default is <code class="code">Brush.Pen.default</code>)</div>
<div class="param_info"><code class="code">from_point</code> : from <code class="code">0.</code> (foot of the arrow) to <code class="code">1.</code> (head of the
arrow), the line will start from this point</div>
<div class="param_info"><code class="code">to_point</code> : from <code class="code">0.</code> (foot of the arrow) to <code class="code">1.</code> (head of the
arrow), the line will end at this point</div>
<div class="param_info"><code class="code">dist</code> : the distance between the path of the arrow and this line
(positive values are on the right of the arrows)</div>
<pre><span id="VALadd_head"><span class="keyword">val</span> add_head</span> : <code class="type">?head:<a href="Mlpost.Arrow.html#TYPEhead">head</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
Add a head at the end of the arrow.<br>
</div>
<div class="param_info"><code class="code">head</code> : the kind of head to add (default is <a href="Mlpost.Arrow.html#VALhead_classic"><code class="code">Arrow.head_classic</code></a>)</div>
<pre><span id="VALadd_foot"><span class="keyword">val</span> add_foot</span> : <code class="type">?head:<a href="Mlpost.Arrow.html#TYPEhead">head</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
Add a foot (an inverted head) at the beginning of the arrow.<br>
</div>
<div class="param_info"><code class="code">head</code> : the kind of head to add (default is <a href="Mlpost.Arrow.html#VALhead_classic"><code class="code">Arrow.head_classic</code></a>)</div>
<pre><span id="VALadd_belt"><span class="keyword">val</span> add_belt</span> : <code class="type">?clip:bool -><br> ?rev:bool -><br> ?point:float -><br> ?head:<a href="Mlpost.Arrow.html#TYPEhead">head</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a> -> <a href="Mlpost.Arrow.html#TYPEkind">kind</a></code></pre><div class="info ">
Add an arrow head at any point of an arrow.<br>
</div>
<div class="param_info"><code class="code">clip</code> : if <code class="code">true</code>, the arrow lines will be clipped after the belt
(or before if the <code class="code">rev</code> is <code class="code">true</code>) (default is <code class="code">false</code>)</div>
<div class="param_info"><code class="code">rev</code> : if <code class="code">true</code>, the head will be drawn in the opposite direction
(default is <code class="code">false</code>)</div>
<div class="param_info"><code class="code">point</code> : the point where to draw the arrow (<code class="code">0.</code> for the beginning,
and <code class="code">1.</code> for the end, or any number in-between) (default is <code class="code">0.5</code>)</div>
<div class="param_info"><code class="code">head</code> : the kind of head to add (default is <a href="Mlpost.Arrow.html#VALhead_classic"><code class="code">Arrow.head_classic</code></a>)</div>
<br>
<h2 id="2_Miscellaneous">Miscellaneous</h2><br>
<br>
Warning: the following functions might be either deleted, modified
and / or moved somewhere else. Don't use them if you need some backward
compatibility.<br>
<pre><span id="VALdraw_thick"><span class="keyword">val</span> draw_thick</span> : <code class="type">?style:<a href="Mlpost.Path.html#TYPEjoint">Path.joint</a> -><br> ?boxed:bool -><br> ?line_color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?fill_color:<a href="Mlpost.Color.html#TYPEt">Color.t</a> -><br> ?outd:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?ind:<a href="Mlpost.Path.html#TYPEdirection">Path.direction</a> -><br> ?width:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?head_length:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> ?head_width:<a href="Mlpost.Num.html#TYPEt">Num.t</a> -><br> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Point.html#TYPEt">Point.t</a> -> <a href="Mlpost.Command.html#TYPEt">Command.t</a></code></pre><div class="info ">
Draw a thick arrow.<br>
</div>
</body></html>
|