walkmap/docs/codox/walkmap.polygon.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>walkmap.polygon documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Walkmap</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="dali-performance.html"><div class="inner"><span>Dali performance</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to walkmap</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>walkmap</span></div></div></li><li class="depth-2 branch"><a href="walkmap.edge.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>edge</span></div></a></li><li class="depth-2 branch"><a href="walkmap.id.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>id</span></div></a></li><li class="depth-2 branch"><a href="walkmap.microworld.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>microworld</span></div></a></li><li class="depth-2 branch"><a href="walkmap.ocean.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ocean</span></div></a></li><li class="depth-2 branch"><a href="walkmap.path.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>path</span></div></a></li><li class="depth-2 branch current"><a href="walkmap.polygon.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>polygon</span></div></a></li><li class="depth-2 branch"><a href="walkmap.read-svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>read-svg</span></div></a></li><li class="depth-2 branch"><a href="walkmap.routing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routing</span></div></a></li><li class="depth-2 branch"><a href="walkmap.stl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stl</span></div></a></li><li class="depth-2 branch"><a href="walkmap.superstructure.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>superstructure</span></div></a></li><li class="depth-2 branch"><a href="walkmap.svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>svg</span></div></a></li><li class="depth-2 branch"><a href="walkmap.tag.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tag</span></div></a></li><li class="depth-2 branch"><a href="walkmap.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="walkmap.vertex.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vertex</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="walkmap.polygon.html#var-centre"><div class="inner"><span>centre</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-polygon"><div class="inner"><span>check-polygon</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-polygons"><div class="inner"><span>check-polygons</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-triangle"><div class="inner"><span>check-triangle</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-gradient"><div class="inner"><span>gradient</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2d.3F"><div class="inner"><span>on2d?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2drectangle.3F"><div class="inner"><span>on2drectangle?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2dtriangle.3F"><div class="inner"><span>on2dtriangle?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-polygon"><div class="inner"><span>polygon</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-polygon.3F"><div class="inner"><span>polygon?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-rectangle"><div class="inner"><span>rectangle</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-triangle-centre"><div class="inner"><span>triangle-centre</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-triangle.3F"><div class="inner"><span>triangle?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.polygon</h1><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be polygons.</p></div></div><div class="public anchor" id="var-centre"><h3>centre</h3><div class="usage"><code>(centre poly)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L122">view source</a></div></div><div class="public anchor" id="var-check-polygon"><h3>check-polygon</h3><h4 class="type">macro</h4><div class="usage"><code>(check-polygon o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a polygon, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L26">view source</a></div></div><div class="public anchor" id="var-check-polygons"><h3>check-polygons</h3><h4 class="type">macro</h4><div class="usage"><code>(check-polygons o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a sequence of polygons, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L33">view source</a></div></div><div class="public anchor" id="var-check-triangle"><h3>check-triangle</h3><h4 class="type">macro</h4><div class="usage"><code>(check-triangle o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a triangle, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L48">view source</a></div></div><div class="public anchor" id="var-gradient"><h3>gradient</h3><div class="usage"><code>(gradient triangle)</code></div><div class="doc"><div class="markdown"><p>Return a polygon like <code>triangle</code> but with a key <code>:gradient</code> whose value is a unit vector representing the gradient across <code>triangle</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L93">view source</a></div></div><div class="public anchor" id="var-on2d.3F"><h3>on2d?</h3><h4 class="type">macro</h4><div class="usage"><code>(on2d? vertex poly)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this polygon <code>poly</code> on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L147">view source</a></div></div><div class="public anchor" id="var-on2drectangle.3F"><h3>on2drectangle?</h3><div class="usage"><code>(on2drectangle? vertex rectangle)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this rectangle on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L137">view source</a></div></div><div class="public anchor" id="var-on2dtriangle.3F"><h3>on2dtriangle?</h3><h4 class="type">macro</h4><div class="usage"><code>(on2dtriangle? vertex poly)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this triangle on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L131">view source</a></div></div><div class="public anchor" id="var-polygon"><h3>polygon</h3><div class="usage"><code>(polygon &amp; vertices)</code></div><div class="doc"><div class="markdown"><p>Return a polygon constructed from these <code>vertices</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L55">view source</a></div></div><div class="public anchor" id="var-polygon.3F"><h3>polygon?</h3><div class="usage"><code>(polygon? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>o</code> satisfies the conditions for a polygon. A polygon shall be a map which has a value for the key <code>:vertices</code>, where that value is a sequence of vertices.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L12">view source</a></div></div><div class="public anchor" id="var-rectangle"><h3>rectangle</h3><div class="usage"><code>(rectangle vsw vne)</code></div><div class="doc"><div class="markdown"><p>Return a rectangle, with edges aligned east-west and north-south, whose south-west corner is the vertex <code>vsw</code> and whose north-east corner is the vertex <code>vne</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L66">view source</a></div></div><div class="public anchor" id="var-triangle-centre"><h3>triangle-centre</h3><div class="usage"><code>(triangle-centre facet)</code></div><div class="doc"><div class="markdown"><p>Return a canonicalised <code>facet</code> (i.e. a triangular polygon) with an added key <code>:centre</code> whose value represents the centre of this facet in 3 dimensions. This only works for triangles, so is here not in <code>walkmap.polygon</code>. It is an error (although no exception is currently thrown) if the object past is not a triangular polygon.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L103">view source</a></div></div><div class="public anchor" id="var-triangle.3F"><h3>triangle?</h3><div class="usage"><code>(triangle? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>o</code> satisfies the conditions for a triangle. A triangle shall be a polygon with exactly three vertices.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L40">view source</a></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>walkmap.polygon documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Walkmap</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="dali-performance.html"><div class="inner"><span>Dali performance</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to walkmap</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>walkmap</span></div></div></li><li class="depth-2 branch"><a href="walkmap.edge.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>edge</span></div></a></li><li class="depth-2 branch"><a href="walkmap.id.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>id</span></div></a></li><li class="depth-2 branch"><a href="walkmap.microworld.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>microworld</span></div></a></li><li class="depth-2 branch"><a href="walkmap.ocean.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ocean</span></div></a></li><li class="depth-2 branch"><a href="walkmap.path.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>path</span></div></a></li><li class="depth-2 branch current"><a href="walkmap.polygon.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>polygon</span></div></a></li><li class="depth-2 branch"><a href="walkmap.read-svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>read-svg</span></div></a></li><li class="depth-2 branch"><a href="walkmap.routing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routing</span></div></a></li><li class="depth-2 branch"><a href="walkmap.stl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stl</span></div></a></li><li class="depth-2 branch"><a href="walkmap.superstructure.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>superstructure</span></div></a></li><li class="depth-2 branch"><a href="walkmap.svg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>svg</span></div></a></li><li class="depth-2 branch"><a href="walkmap.tag.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tag</span></div></a></li><li class="depth-2 branch"><a href="walkmap.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="walkmap.vertex.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vertex</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="walkmap.polygon.html#var-centre"><div class="inner"><span>centre</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-polygon"><div class="inner"><span>check-polygon</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-polygons"><div class="inner"><span>check-polygons</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-check-triangle"><div class="inner"><span>check-triangle</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-gradient"><div class="inner"><span>gradient</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2d.3F"><div class="inner"><span>on2d?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2drectangle.3F"><div class="inner"><span>on2drectangle?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-on2dtriangle.3F"><div class="inner"><span>on2dtriangle?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-polygon"><div class="inner"><span>polygon</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-polygon.3F"><div class="inner"><span>polygon?</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-rectangle"><div class="inner"><span>rectangle</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-triangle-centre"><div class="inner"><span>triangle-centre</span></div></a></li><li class="depth-1"><a href="walkmap.polygon.html#var-triangle.3F"><div class="inner"><span>triangle?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.polygon</h1><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be polygons.</p></div></div><div class="public anchor" id="var-centre"><h3>centre</h3><div class="usage"><code>(centre poly)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L122">view source</a></div></div><div class="public anchor" id="var-check-polygon"><h3>check-polygon</h3><h4 class="type">macro</h4><div class="usage"><code>(check-polygon o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a polygon, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L26">view source</a></div></div><div class="public anchor" id="var-check-polygons"><h3>check-polygons</h3><h4 class="type">macro</h4><div class="usage"><code>(check-polygons o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a sequence of polygons, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L33">view source</a></div></div><div class="public anchor" id="var-check-triangle"><h3>check-triangle</h3><h4 class="type">macro</h4><div class="usage"><code>(check-triangle o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is not a triangle, throw an <code>IllegalArgumentException</code> with an appropriate message; otherwise, returns <code>o</code>. Macro, so exception is thrown from the calling function.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L48">view source</a></div></div><div class="public anchor" id="var-gradient"><h3>gradient</h3><div class="usage"><code>(gradient triangle)</code></div><div class="doc"><div class="markdown"><p>Return a polygon like <code>triangle</code> but with a key <code>:gradient</code> whose value is a unit vector representing the gradient across <code>triangle</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L93">view source</a></div></div><div class="public anchor" id="var-on2d.3F"><h3>on2d?</h3><h4 class="type">macro</h4><div class="usage"><code>(on2d? vertex poly)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this polygon <code>poly</code> on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L147">view source</a></div></div><div class="public anchor" id="var-on2drectangle.3F"><h3>on2drectangle?</h3><div class="usage"><code>(on2drectangle? vertex rectangle)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this rectangle on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L137">view source</a></div></div><div class="public anchor" id="var-on2dtriangle.3F"><h3>on2dtriangle?</h3><h4 class="type">macro</h4><div class="usage"><code>(on2dtriangle? vertex poly)</code></div><div class="doc"><div class="markdown"><p>Is the projection of this <code>vertex</code> on the x, y plane within the projection of this triangle on that plane?</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L131">view source</a></div></div><div class="public anchor" id="var-polygon"><h3>polygon</h3><div class="usage"><code>(polygon & vertices)</code></div><div class="doc"><div class="markdown"><p>Return a polygon constructed from these <code>vertices</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L55">view source</a></div></div><div class="public anchor" id="var-polygon.3F"><h3>polygon?</h3><div class="usage"><code>(polygon? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>o</code> satisfies the conditions for a polygon. A polygon shall be a map which has a value for the key <code>:vertices</code>, where that value is a sequence of vertices.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L12">view source</a></div></div><div class="public anchor" id="var-rectangle"><h3>rectangle</h3><div class="usage"><code>(rectangle vsw vne)</code></div><div class="doc"><div class="markdown"><p>Return a rectangle, with edges aligned east-west and north-south, whose south-west corner is the vertex <code>vsw</code> and whose north-east corner is the vertex <code>vne</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L66">view source</a></div></div><div class="public anchor" id="var-triangle-centre"><h3>triangle-centre</h3><div class="usage"><code>(triangle-centre facet)</code></div><div class="doc"><div class="markdown"><p>Return a canonicalised <code>facet</code> (i.e. a triangular polygon) with an added key <code>:centre</code> whose value represents the centre of this facet in 3 dimensions. This only works for triangles, so is here not in <code>walkmap.polygon</code>. It is an error (although no exception is currently thrown) if the object past is not a triangular polygon.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L103">view source</a></div></div><div class="public anchor" id="var-triangle.3F"><h3>triangle?</h3><div class="usage"><code>(triangle? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>o</code> satisfies the conditions for a triangle. A triangle shall be a polygon with exactly three vertices.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/polygon.clj#L40">view source</a></div></div></div></body></html>