mirror of
https://github.com/noncomputable/AgentMaps.git
synced 2026-01-18 16:27:05 +00:00
94 lines
5.1 KiB
HTML
94 lines
5.1 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Home</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Home</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3> </h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article><h1>AgentMaps Documentation</h1><p>For a basic walkthrough on using AgentMaps, see <a href="https://noncomputable.github.io/AgentMaps/#basic-walkthrough">this</a> section of the README.</p>
|
|
<p>The sidebar of this page contains a list of classes and namespaces used by Agentmaps.
|
|
Click them to see their methods and properties, their purposes, and their intended types.
|
|
If you are looking at the [normal docs] (https://noncomputable.github.io/AgentMaps/docs),
|
|
you will only see the items necessary for using AgentMaps. However, if you are looking at
|
|
the [developer docs] (https://noncomputable.github.io/AgentMaps/devdocs/), you will see
|
|
everything, including functions used only in the internal implementation of AgentMaps.</p>
|
|
<p>Here I'll explain some features of AgentMaps that the auto-generated docs probably aren't sufficiently helpful to.</p>
|
|
<h4>Table of Contents</h4><p><a href="#basic-structure">Basic Structure of Agentmaps</a>
|
|
<a href="#neighbors">Neighbors</a>
|
|
<a href="#intersections">Intersections</a>
|
|
<a href="#agentfeaturemakers">AgentFeatureMakers</a></p>
|
|
<h2>Basic Structure</h2><p>AgentMap functions as an extension of Leaflet.
|
|
Since everything in Leaflet is in the L namespace (e.g. L.Map, L.latLng), everything in AgentMaps is in its own namespace A inside that namespace: L.A.</p>
|
|
<p>The main object of AgentMaps is an Agentmap (L.A.Agentmap).
|
|
Since AgentMaps is built on top of Leaflet, the Agentmap constructor requires a Leaflet map as an argument.
|
|
All the classes in AgentMaps have lowercase factory functions that return instances of them given their
|
|
constructor's arguments (L.A.agentmap).</p>
|
|
<p>The Agentmap keeps track of its units, streets, and agents as Leaflet FeatureGroups (Agentmap.units, Agentmap.streets, and Agentmap.agents).
|
|
These FeatureGroups can be looped through like any other Leaflet FeatureGroup (using the LayerGroup.eachLayer() method).</p>
|
|
<h2>Neighbors</h2><p>Every unit has a neighbors property (unit.neighbors): a three element array of layer IDs representing the previous unit, the next unit, and the
|
|
unit directly across the street respectively.</p>
|
|
<h2>Intersections</h2><p>Every street has an intersections property (street.intersections): an object mapping street IDs to an array of their intersections with the
|
|
street in question, where the intersections themselves are 2-element arrays whose first elements are the coordinates of the intersections,
|
|
and whose second elements are the indices of the intersections in each street's own coordinate arrays. </p>
|
|
<h2>AgentFeatureMakers</h2></article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Agent.html">Agent</a></li><li><a href="Agentmap.html">Agentmap</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addStreetLayerIntersections">addStreetLayerIntersections</a></li><li><a href="global.html#agent">agent</a></li><li><a href="global.html#agentify">agentify</a></li><li><a href="global.html#agentmap">agentmap</a></li><li><a href="global.html#buildingify">buildingify</a></li><li><a href="global.html#decodeCoordString">decodeCoordString</a></li><li><a href="global.html#encodeLatLng">encodeLatLng</a></li><li><a href="global.html#generateUnitFeatures">generateUnitFeatures</a></li><li><a href="global.html#getIntersections">getIntersections</a></li><li><a href="global.html#getPath">getPath</a></li><li><a href="global.html#getPathFinder">getPathFinder</a></li><li><a href="global.html#getStreetFeatures">getStreetFeatures</a></li><li><a href="global.html#getUnitAnchors">getUnitAnchors</a></li><li><a href="global.html#getUnitFeatures">getUnitFeatures</a></li><li><a href="global.html#getUnitNeighborLayerIDs">getUnitNeighborLayerIDs</a></li><li><a href="global.html#isPointCoordinates">isPointCoordinates</a></li><li><a href="global.html#noOverlaps">noOverlaps</a></li><li><a href="global.html#pointToCoordinateArray">pointToCoordinateArray</a></li><li><a href="global.html#reversedCoordinates">reversedCoordinates</a></li><li><a href="global.html#setupStreetFeatures">setupStreetFeatures</a></li><li><a href="global.html#setupUnitFeatures">setupUnitFeatures</a></li><li><a href="global.html#streetsToGraph">streetsToGraph</a></li><li><a href="global.html#unitsOutOfStreets">unitsOutOfStreets</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Aug 10 2018 01:13:41 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html> |