3 lines
7.5 KiB
HTML
3 lines
7.5 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>Walkmap 0.1.0-SNAPSHOT</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 current"><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="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.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.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"><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="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Walkmap</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://www.eclipse.org/legal/epl-2.0/">EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0</a></h5><div class="doc"><p>A Clojure library designed to assist in computing walkmaps for games.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[walkmap "0.1.0-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="intro.html">Introduction to walkmap</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="walkmap.core.html">walkmap.core</a></h3><div class="doc"><div class="markdown"><p>At this stage, primarily utility functions dealing with stereolithography (STL) files. Not a stable API yet!</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.core.html#var-*sea-level*">*sea-level*</a> </li><li> <a href="walkmap.core.html#var-binary-stl-file-.3Esvg">binary-stl-file->svg</a> </li><li> <a href="walkmap.core.html#var-cull-ocean-facets">cull-ocean-facets</a> </li><li> <a href="walkmap.core.html#var-ocean.3F">ocean?</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.edge.html">walkmap.edge</a></h3><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be an edge. An edge is a line segment having just a start and an end, with no intervening nodes.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.edge.html#var-edge.3F">edge?</a> </li><li> <a href="walkmap.edge.html#var-path-.3Eedges">path->edges</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.geometry.html">walkmap.geometry</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.geometry.html#var-collinear.3F">collinear?</a> </li><li> <a href="walkmap.geometry.html#var-on.3F">on?</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.path.html">walkmap.path</a></h3><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be path.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.path.html#var-path.3F">path?</a> </li><li> <a href="walkmap.path.html#var-polygon-.3Epath">polygon->path</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.polygon.html">walkmap.polygon</a></h3><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be polygons.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.polygon.html#var-polygon.3F">polygon?</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.stl.html">walkmap.stl</a></h3><div class="doc"><div class="markdown"><p>Utility functions dealing with stereolithography (STL) files. Not a stable API yet!</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.stl.html#var-binary-stl">binary-stl</a> </li><li> <a href="walkmap.stl.html#var-binary-stl-to-ascii">binary-stl-to-ascii</a> </li><li> <a href="walkmap.stl.html#var-decode-binary-stl">decode-binary-stl</a> </li><li> <a href="walkmap.stl.html#var-facet">facet</a> </li><li> <a href="walkmap.stl.html#var-stl-.3Eascii">stl->ascii</a> </li><li> <a href="walkmap.stl.html#var-stl.3F">stl?</a> </li><li> <a href="walkmap.stl.html#var-vect">vect</a> </li><li> <a href="walkmap.stl.html#var-write-ascii-stl">write-ascii-stl</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.svg.html">walkmap.svg</a></h3><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="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.svg.html#var-stl-.3Esvg">stl->svg</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.vertex.html">walkmap.vertex</a></h3><div class="doc"><div class="markdown"><p>Essentially the specification for things we shall consider to be vertices.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.vertex.html#var-ensure2d">ensure2d</a> </li><li> <a href="walkmap.vertex.html#var-ensure3d">ensure3d</a> </li><li> <a href="walkmap.vertex.html#var-vertex.3F">vertex?</a> </li></ul></div></div></div></body></html> |