3 lines
17 KiB
HTML
3 lines
17 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="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"><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="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">[journeyman-cc/walkmap "0.1.0-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="dali-performance.html">Dali performance</a></li><li><a href="intro.html">Introduction to walkmap</a></li></ul><h2>Namespaces</h2><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-centre">centre</a> </li><li> <a href="walkmap.edge.html#var-collinear2d.3F">collinear2d?</a> </li><li> <a href="walkmap.edge.html#var-collinear.3F">collinear?</a> </li><li> <a href="walkmap.edge.html#var-edge">edge</a> </li><li> <a href="walkmap.edge.html#var-edge.3F">edge?</a> </li><li> <a href="walkmap.edge.html#var-intersection2d">intersection2d</a> </li><li> <a href="walkmap.edge.html#var-length">length</a> </li><li> <a href="walkmap.edge.html#var-minimaxd">minimaxd</a> </li><li> <a href="walkmap.edge.html#var-on2d.3F">on2d?</a> </li><li> <a href="walkmap.edge.html#var-on.3F">on?</a> </li><li> <a href="walkmap.edge.html#var-overlaps2d.3F">overlaps2d?</a> </li><li> <a href="walkmap.edge.html#var-parallel.3F">parallel?</a> </li><li> <a href="walkmap.edge.html#var-unit-vector">unit-vector</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.id.html">walkmap.id</a></h3><div class="doc"><div class="markdown"><p>The namespace within which the privileged keyword <code>:walkmap.id/id</code> is defined.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.id.html#var-id">id</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.microworld.html">walkmap.microworld</a></h3><div class="doc"><div class="markdown"><p>An interface between walkmap and microworld, to allow use of microworld functionality to model things like rainfall, soil fertility, settlement and so on.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.microworld.html#var-cell-.3Epolygon">cell->polygon</a> </li><li> <a href="walkmap.microworld.html#var-load-microworld-edn">load-microworld-edn</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.ocean.html">walkmap.ocean</a></h3><div class="doc"><div class="markdown"><p>Deal with (specifically, at this stage, cull) ocean areas</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.ocean.html#var-*sea-level*">*sea-level*</a> </li><li> <a href="walkmap.ocean.html#var-cull-ocean-facets">cull-ocean-facets</a> </li><li> <a href="walkmap.ocean.html#var-ocean.3F">ocean?</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. <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="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.path.html#var-check-path">check-path</a> </li><li> <a href="walkmap.path.html#var-check-paths">check-paths</a> </li><li> <a href="walkmap.path.html#var-length">length</a> </li><li> <a href="walkmap.path.html#var-path">path</a> </li><li> <a href="walkmap.path.html#var-path-.3Eedges">path->edges</a> </li><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-centre">centre</a> </li><li> <a href="walkmap.polygon.html#var-check-polygon">check-polygon</a> </li><li> <a href="walkmap.polygon.html#var-check-polygons">check-polygons</a> </li><li> <a href="walkmap.polygon.html#var-check-triangle">check-triangle</a> </li><li> <a href="walkmap.polygon.html#var-gradient">gradient</a> </li><li> <a href="walkmap.polygon.html#var-on2d.3F">on2d?</a> </li><li> <a href="walkmap.polygon.html#var-on2drectangle.3F">on2drectangle?</a> </li><li> <a href="walkmap.polygon.html#var-on2dtriangle.3F">on2dtriangle?</a> </li><li> <a href="walkmap.polygon.html#var-polygon">polygon</a> </li><li> <a href="walkmap.polygon.html#var-polygon.3F">polygon?</a> </li><li> <a href="walkmap.polygon.html#var-rectangle">rectangle</a> </li><li> <a href="walkmap.polygon.html#var-triangle-centre">triangle-centre</a> </li><li> <a href="walkmap.polygon.html#var-triangle.3F">triangle?</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.read-svg.html">walkmap.read-svg</a></h3><div class="doc"><div class="markdown"><p>Utility functions for scalable vector graphics (SVG) into walkmap structures.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.read-svg.html#var-command-string-.3Evertices">command-string->vertices</a> </li><li> <a href="walkmap.read-svg.html#var-match-.3Evertex">match->vertex</a> </li><li> <a href="walkmap.read-svg.html#var-path-elt-.3Epath">path-elt->path</a> </li><li> <a href="walkmap.read-svg.html#var-progeny">progeny</a> </li><li> <a href="walkmap.read-svg.html#var-read-svg">read-svg</a> </li><li> <a href="walkmap.read-svg.html#var-upper-case.3F">upper-case?</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.routing.html">walkmap.routing</a></h3><div class="doc"><div class="markdown"><p>Finding optimal routes to traverse a map.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.routing.html#var-*gradient-exponent*">*gradient-exponent*</a> </li><li> <a href="walkmap.routing.html#var-*traversals-exponent*">*traversals-exponent*</a> </li><li> <a href="walkmap.routing.html#var-barriers-crossed">barriers-crossed</a> </li><li> <a href="walkmap.routing.html#var-best-road">best-road</a> </li><li> <a href="walkmap.routing.html#var-crossing-penalty">crossing-penalty</a> </li><li> <a href="walkmap.routing.html#var-extend-frontier">extend-frontier</a> </li><li> <a href="walkmap.routing.html#var-gradient-cost">gradient-cost</a> </li><li> <a href="walkmap.routing.html#var-path-traversal-cost">path-traversal-cost</a> </li><li> <a href="walkmap.routing.html#var-road-bonus">road-bonus</a> </li><li> <a href="walkmap.routing.html#var-route">route</a> </li><li> <a href="walkmap.routing.html#var-traversable.3F">traversable?</a> </li><li> <a href="walkmap.routing.html#var-traversal-cost">traversal-cost</a> </li><li> <a href="walkmap.routing.html#var-vertices-traversal-cost">vertices-traversal-cost</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-canonicalise">canonicalise</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.superstructure.html">walkmap.superstructure</a></h3><div class="doc"><div class="markdown"><p>single indexing structure for walkmap objects</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.superstructure.html#var-in-retrieve">in-retrieve</a> </li><li> <a href="walkmap.superstructure.html#var-in-store-find-objects">in-store-find-objects</a> </li><li> <a href="walkmap.superstructure.html#var-in-store-replace-with-keys">in-store-replace-with-keys</a> </li><li> <a href="walkmap.superstructure.html#var-index-vertex">index-vertex</a> </li><li> <a href="walkmap.superstructure.html#var-index-vertices">index-vertices</a> </li><li> <a href="walkmap.superstructure.html#var-nearest">nearest</a> </li><li> <a href="walkmap.superstructure.html#var-neighbour-ids">neighbour-ids</a> </li><li> <a href="walkmap.superstructure.html#var-neighbours">neighbours</a> </li><li> <a href="walkmap.superstructure.html#var-retrieve">retrieve</a> </li><li> <a href="walkmap.superstructure.html#var-search-vertices">search-vertices</a> </li><li> <a href="walkmap.superstructure.html#var-store">store</a> </li><li> <a href="walkmap.superstructure.html#var-touching">touching</a> </li><li> <a href="walkmap.superstructure.html#var-vertex-index">vertex-index</a> </li><li> <a href="walkmap.superstructure.html#var-vertices">vertices</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-*preferred-svg-render*">*preferred-svg-render*</a> </li><li> <a href="walkmap.svg.html#var-binary-stl-file-.3Esvg">binary-stl-file->svg</a> </li><li> <a href="walkmap.svg.html#var-dali-stl-.3Esvg">dali-stl->svg</a> </li><li> <a href="walkmap.svg.html#var-hiccup-stl-.3Esvg">hiccup-stl->svg</a> </li><li> <a href="walkmap.svg.html#var-stl-.3Esvg">stl->svg</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.tag.html">walkmap.tag</a></h3><div class="doc"><div class="markdown"><p>Code for tagging, untagging, and finding tags on objects. Note the use of the namespaced keyword, <code>:walkmap.tag/tags</code>, denoted in this file <code>::tags</code>. This is in an attempt to avoid name clashes with other uses of this key.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.tag.html#var-tag">tag</a> </li><li> <a href="walkmap.tag.html#var-tagged.3F">tagged?</a> </li><li> <a href="walkmap.tag.html#var-tags">tags</a> </li><li> <a href="walkmap.tag.html#var-untag">untag</a> </li></ul></div></div><div class="namespace"><h3><a href="walkmap.utils.html">walkmap.utils</a></h3><div class="doc"><div class="markdown"><p>Miscellaneous utility functions.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="walkmap.utils.html#var-.3Dish">=ish</a> </li><li> <a href="walkmap.utils.html#var-check-kind-type">check-kind-type</a> </li><li> <a href="walkmap.utils.html#var-check-kind-type-seq">check-kind-type-seq</a> </li><li> <a href="walkmap.utils.html#var-deep-merge">deep-merge</a> </li><li> <a href="walkmap.utils.html#var-kind-type">kind-type</a> </li><li> <a href="walkmap.utils.html#var-load-edn">load-edn</a> </li><li> <a href="walkmap.utils.html#var-not-yet-implemented">not-yet-implemented</a> </li><li> <a href="walkmap.utils.html#var-truncate">truncate</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-canonicalise">canonicalise</a> </li><li> <a href="walkmap.vertex.html#var-check-vertex">check-vertex</a> </li><li> <a href="walkmap.vertex.html#var-check-vertices">check-vertices</a> </li><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">vertex</a> </li><li> <a href="walkmap.vertex.html#var-vertex*">vertex*</a> </li><li> <a href="walkmap.vertex.html#var-vertex-key">vertex-key</a> </li><li> <a href="walkmap.vertex.html#var-vertex.3D">vertex=</a> </li><li> <a href="walkmap.vertex.html#var-vertex.3F">vertex?</a> </li><li> <a href="walkmap.vertex.html#var-within-box.3F">within-box?</a> </li></ul></div></div></div></body></html> |