3 lines
7.2 KiB
HTML
3 lines
7.2 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>walkmap.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.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"><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 current"><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.svg.html#var-*preferred-svg-render*"><div class="inner"><span>*preferred-svg-render*</span></div></a></li><li class="depth-1"><a href="walkmap.svg.html#var-binary-stl-file-.3Esvg"><div class="inner"><span>binary-stl-file->svg</span></div></a></li><li class="depth-1"><a href="walkmap.svg.html#var-dali-stl-.3Esvg"><div class="inner"><span>dali-stl->svg</span></div></a></li><li class="depth-1"><a href="walkmap.svg.html#var-hiccup-stl-.3Esvg"><div class="inner"><span>hiccup-stl->svg</span></div></a></li><li class="depth-1"><a href="walkmap.svg.html#var-stl-.3Esvg"><div class="inner"><span>stl->svg</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">walkmap.svg</h1><div class="doc"><div class="markdown"><p>Utility functions for writing stereolithography (STL) files (and possibly, later, other geometry files of interest to us) as scalable vector graphics (SVG).</p></div></div><div class="public anchor" id="var-*preferred-svg-render*"><h3>*preferred-svg-render*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Mainly for debugging dali; switch SVG renderer to use. Expected values: <code>:dali</code>, <code>:hiccup</code>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/svg.clj#L14">view source</a></div></div><div class="public anchor" id="var-binary-stl-file-.3Esvg"><h3>binary-stl-file->svg</h3><div class="usage"><code>(binary-stl-file->svg in-filename)</code><code>(binary-stl-file->svg in-filename out-filename)</code></div><div class="doc"><div class="markdown"><p>Given only an <code>in-filename</code>, parse the indicated file, expected to be binary STL, and return an equivalent SVG structure. Given both <code>in-filename</code> and <code>out-filename</code>, as side-effect write the SVG to the indicated output file.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/svg.clj#L95">view source</a></div></div><div class="public anchor" id="var-dali-stl-.3Esvg"><h3>dali-stl->svg</h3><div class="usage"><code>(dali-stl->svg stl minx maxx miny maxy)</code></div><div class="doc"><div class="markdown"><p>Format this <code>stl</code> as SVG for the <code>dali</code> renderer on a page with these bounds.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/svg.clj#L31">view source</a></div></div><div class="public anchor" id="var-hiccup-stl-.3Esvg"><h3>hiccup-stl->svg</h3><div class="usage"><code>(hiccup-stl->svg stl minx maxx miny maxy)</code></div><div class="doc"><div class="markdown"><p>Format this <code>stl</code> as SVG for the <code>hiccup</code> renderer on a page with these bounds.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/svg.clj#L48">view source</a></div></div><div class="public anchor" id="var-stl-.3Esvg"><h3>stl->svg</h3><div class="usage"><code>(stl->svg stl)</code></div><div class="doc"><div class="markdown"><p>Convert this in-memory <code>stl</code> structure, as read by <code>decode-binary-stl</code>, into an in-memory hiccup representation of SVG structure, and return it.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/walkmap/blob/master/src/walkmap/svg.clj#L65">view source</a></div></div></div></body></html> |