5 lines
7.4 KiB
HTML
5 lines
7.4 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
||
"">
|
||
<html><head><meta charset="UTF-8" /><title>walkmap.path 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.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></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.geometry.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>geometry</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 current"><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"><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.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.path.html#var-length"><div class="inner"><span>length</span></div></a></li><li class="depth-1"><a href="walkmap.path.html#var-path"><div class="inner"><span>path</span></div></a></li><li class="depth-1"><a href="walkmap.path.html#var-path-.3Eedges"><div class="inner"><span>path->edges</span></div></a></li><li class="depth-1"><a href="walkmap.path.html#var-path.3F"><div class="inner"><span>path?</span></div></a></li><li class="depth-1"><a href="walkmap.path.html#var-polygon-.3Epath"><div class="inner"><span>polygon->path</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.path</h1><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be path. <strong>Note that</strong> for these purposes <code>path</code> means any continuous linear feature, where such features specifically include watercourses.</p></div></div><div class="public anchor" id="var-length"><h3>length</h3><div class="usage"><code>(length path)</code></div><div class="doc"><div class="markdown"><p>Return the length of this path, in metres. <strong>Note that</strong> 1. This is not the same as the distance from the start to the end of the path, which, except for absolutely straight paths, will be shorter; 2. It is not even quite the same as the length of the path <em>as rendered</em>, since paths will generally be rendered as spline curves.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/path.clj#L68">view source</a></div></div><div class="public anchor" id="var-path"><h3>path</h3><div class="usage"><code>(path & vertices)</code></div><div class="doc"><div class="markdown"><p>Return a path 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/path.clj#L23">view source</a></div></div><div class="public anchor" id="var-path-.3Eedges"><h3>path->edges</h3><div class="usage"><code>(path->edges o)</code></div><div class="doc"><div class="markdown"><p>if <code>o</code> is a path, a polygon, or a sequence of vertices, return a sequence of edges representing that path, polygon or sequence.</p>
|
||
<p>Throws <code>IllegalArgumentException</code> if <code>o</code> is not a path, a polygon, or sequence of vertices.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/path.clj#L44">view source</a></div></div><div class="public anchor" id="var-path.3F"><h3>path?</h3><div class="usage"><code>(path? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>o</code> satisfies the conditions for a path. A path shall be a map having the key <code>:vertices</code>, whose value shall be a sequence of vertices as defined in <code>walkmap.vertex</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/path.clj#L9">view source</a></div></div><div class="public anchor" id="var-polygon-.3Epath"><h3>polygon->path</h3><div class="usage"><code>(polygon->path o)</code></div><div class="doc"><div class="markdown"><p>If <code>o</code> is a polygon, return an equivalent path. What’s different about a path is that in polygons there is an implicit edge between the first vertex and the last. In paths, there isn’t, so we need to add that edge explicitly.</p>
|
||
<p>If <code>o</code> is not a polygon, will throw an exception.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/path.clj#L31">view source</a></div></div></div></body></html> |