walkmap/docs/codox/walkmap.read-svg.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>walkmap.read-svg 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"><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 current"><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.read-svg.html#var-command-string-.3Evertices"><div class="inner"><span>command-string-&gt;vertices</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-match-.3Evertex"><div class="inner"><span>match-&gt;vertex</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-path-elt-.3Epath"><div class="inner"><span>path-elt-&gt;path</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-progeny"><div class="inner"><span>progeny</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-read-svg"><div class="inner"><span>read-svg</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-upper-case.3F"><div class="inner"><span>upper-case?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.read-svg</h1><div class="doc"><div class="markdown"><p>Utility functions for scalable vector graphics (SVG) into walkmap structures.</p></div></div><div class="public anchor" id="var-command-string-.3Evertices"><h3>command-string-&gt;vertices</h3><div class="usage"><code>(command-string-&gt;vertices s)</code></div><div class="doc"><div class="markdown"><p>Return the destination of each successive line (<code>l</code>, <code>L</code>) and move (<code>m</code>, <code>M</code>) command in this string <code>s</code>, expected to be an SVG path command string.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L34">view source</a></div></div><div class="public anchor" id="var-match-.3Evertex"><h3>match-&gt;vertex</h3><div class="usage"><code>(match-&gt;vertex match-vector x y)</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/read_svg.clj#L20">view source</a></div></div><div class="public anchor" id="var-path-elt-.3Epath"><h3>path-elt-&gt;path</h3><div class="usage"><code>(path-elt-&gt;path elt)</code></div><div class="doc"><div class="markdown"><p>Given the SVG path element <code>elt</code>, return a walkmap path structure representing the line (<code>l</code>, <code>L</code>) and move (<code>m</code>, <code>M</code>) commands in that path.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L56">view source</a></div></div><div class="public anchor" id="var-progeny"><h3>progeny</h3><div class="usage"><code>(progeny elt predicate)</code></div><div class="doc"><div class="markdown"><p>Return all the nodes in the XML structure below this <code>elt</code> which match this <code>predicate</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L70">view source</a></div></div><div class="public anchor" id="var-read-svg"><h3>read-svg</h3><div class="usage"><code>(read-svg file-name)</code><code>(read-svg file-name map-kind)</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/read_svg.clj#L87">view source</a></div></div><div class="public anchor" id="var-upper-case.3F"><h3>upper-case?</h3><div class="usage"><code>(upper-case? s)</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/read_svg.clj#L16">view source</a></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>walkmap.read-svg 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"><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 current"><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.read-svg.html#var-command-string-.3Evertices"><div class="inner"><span>command-string->vertices</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-match-.3Evertex"><div class="inner"><span>match->vertex</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-path-elt-.3Epath"><div class="inner"><span>path-elt->path</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-progeny"><div class="inner"><span>progeny</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-read-svg"><div class="inner"><span>read-svg</span></div></a></li><li class="depth-1"><a href="walkmap.read-svg.html#var-upper-case.3F"><div class="inner"><span>upper-case?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.read-svg</h1><div class="doc"><div class="markdown"><p>Utility functions for scalable vector graphics (SVG) into walkmap structures.</p></div></div><div class="public anchor" id="var-command-string-.3Evertices"><h3>command-string->vertices</h3><div class="usage"><code>(command-string->vertices s)</code></div><div class="doc"><div class="markdown"><p>Return the destination of each successive line (<code>l</code>, <code>L</code>) and move (<code>m</code>, <code>M</code>) command in this string <code>s</code>, expected to be an SVG path command string.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L34">view source</a></div></div><div class="public anchor" id="var-match-.3Evertex"><h3>match->vertex</h3><div class="usage"><code>(match->vertex match-vector x y)</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/read_svg.clj#L20">view source</a></div></div><div class="public anchor" id="var-path-elt-.3Epath"><h3>path-elt->path</h3><div class="usage"><code>(path-elt->path elt)</code></div><div class="doc"><div class="markdown"><p>Given the SVG path element <code>elt</code>, return a walkmap path structure representing the line (<code>l</code>, <code>L</code>) and move (<code>m</code>, <code>M</code>) commands in that path.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L56">view source</a></div></div><div class="public anchor" id="var-progeny"><h3>progeny</h3><div class="usage"><code>(progeny elt predicate)</code></div><div class="doc"><div class="markdown"><p>Return all the nodes in the XML structure below this <code>elt</code> which match this <code>predicate</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/read_svg.clj#L70">view source</a></div></div><div class="public anchor" id="var-read-svg"><h3>read-svg</h3><div class="usage"><code>(read-svg file-name)</code><code>(read-svg file-name map-kind)</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/read_svg.clj#L87">view source</a></div></div><div class="public anchor" id="var-upper-case.3F"><h3>upper-case?</h3><div class="usage"><code>(upper-case? s)</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/read_svg.clj#L16">view source</a></div></div></div></body></html>