tiny-ecs
Version:
A mean lean Entity-Component-System library.
851 lines (257 loc) • 11.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: QuadTree</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">Class: QuadTree</h1>
<section>
<header>
<h2>
QuadTree
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="QuadTree"><span class="type-signature"></span>new QuadTree<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Effectively store positional and sized objects. Each tree has a position and
size, as well as up to 4 child nodes (other trees) and an array of entries.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="entities"><span class="type-signature"></span>entities<span class="type-signature"> :Array.<{spatial: <a href="Spatial.html">Spatial</a>}></span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<{spatial: <a href="Spatial.html">Spatial</a>}></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="nodes"><span class="type-signature"></span>nodes<span class="type-signature"> :Array.<<a href="QuadTree.html">QuadTree</a>></span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="QuadTree.html">QuadTree</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pool"><span class="type-signature"></span>pool<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Pool that is used for all internal quad trees. Only root node has one, all
others have a refence.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Empty the tree recursively.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">(entity)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Add an entity to the tree
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>entity</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="queryArea"><span class="type-signature"></span>queryArea<span class="signature">(position, hwidth, <span class="optional">out__objects</span>)</span><span class="type-signature"> → {Array.<{spatial: <a href="Spatial.html">Spatial</a>}>}</span></h4>
</dt>
<dd>
<div class="description">
Get all tree entries that are interesected by a rectangle defined with
position and hwidth.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="Vec2.html">Vec2</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>hwidth</code></td>
<td class="type">
<span class="param-type"><a href="Vec2.html">Vec2</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>out__objects</code></td>
<td class="type">
<span class="param-type">Array.<{spatial: <a href="Spatial.html">Spatial</a>}>=</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Return objects.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The out__objects parameter (filled up now)
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.<{spatial: <a href="Spatial.html">Spatial</a>}></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(param)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Remove an entity from this tree.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>param</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">QuadTree.js</a>, <a href="QuadTree.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="EntityManager.html">EntityManager</a></li><li><a href="Group.html">Group</a></li><li><a href="ObjectPool.html">ObjectPool</a></li><li><a href="QuadTree.html">QuadTree</a></li><li><a href="Spatial.html">Spatial</a></li><li><a href="Vec2.html">Vec2</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha3</a> on Wed Jan 29 2014 01:06:20 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>