odin
Version:
Node.js Canvas/WebGL Javascript Game Framework
2,041 lines (575 loc) • 24.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: AABB2</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: AABB2</h1>
<section>
<header>
<h2>
AABB2
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="AABB2"><span class="type-signature"></span>new AABB2<span class="signature">(Vec2, Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">min</td>
</tr>
<tr>
<td class="name"><code>Vec2</code></td>
<td class="type">
</td>
<td class="description last">max</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line12">line 12</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="this.max"><span class="type-signature"><static> </span>this.max<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Vec2</code></td>
<td class="type">
</td>
<td class="description last">max</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="this.min"><span class="type-signature"><static> </span>this.min<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Vec2</code></td>
<td class="type">
</td>
<td class="description last">min</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.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"><static> </span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line132">line 132</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="clone"><span class="type-signature"><static> </span>clone<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
AABB2
</div>
</dd>
<dt>
<h4 class="name" id="contains"><span class="type-signature"><static> </span>contains<span class="signature">(Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">point</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line146">line 146</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Boolean
</div>
</dd>
<dt>
<h4 class="name" id="copy"><span class="type-signature"><static> </span>copy<span class="signature">(AABB2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>AABB2</code></td>
<td class="type">
</td>
<td class="description last">other</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="expandPoint"><span class="type-signature"><static> </span>expandPoint<span class="signature">(Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">v</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="expandScalar"><span class="type-signature"><static> </span>expandScalar<span class="signature">(Number)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Number</code></td>
<td class="type">
</td>
<td class="description last">s</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line103">line 103</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="expandVec"><span class="type-signature"><static> </span>expandVec<span class="signature">(Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">v</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="fromCenterSize"><span class="type-signature"><static> </span>fromCenterSize<span class="signature">(Vec2, Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">center</td>
</tr>
<tr>
<td class="name"><code>Vec2</code></td>
<td class="type">
</td>
<td class="description last">size</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line221">line 221</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="fromJSON"><span class="type-signature"><static> </span>fromJSON<span class="signature">(Object)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Object</code></td>
<td class="type">
</td>
<td class="description last">json</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line246">line 246</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="fromPoints"><span class="type-signature"><static> </span>fromPoints<span class="signature">(Array)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Array</code></td>
<td class="type">
</td>
<td class="description last">points</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line184">line 184</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="intersects"><span class="type-signature"><static> </span>intersects<span class="signature">(AABB2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>AABB2</code></td>
<td class="type">
</td>
<td class="description last">other</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Boolean
</div>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"><static> </span>set<span class="signature">(Vec2, Vec2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Vec2</code></td>
<td class="type">
</td>
<td class="description last">min</td>
</tr>
<tr>
<td class="name"><code>Vec2</code></td>
<td class="type">
</td>
<td class="description last">max</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
<dt>
<h4 class="name" id="toJSON"><span class="type-signature"><static> </span>toJSON<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line261">line 261</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Object
</div>
</dd>
<dt>
<h4 class="name" id="toString"><span class="type-signature"><static> </span>toString<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line276">line 276</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
String
</div>
</dd>
<dt>
<h4 class="name" id="union"><span class="type-signature"><static> </span>union<span class="signature">(AABB2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>AABB2</code></td>
<td class="type">
</td>
<td class="description last">aabb</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="aabb2.js.html">math/aabb2.js</a>, <a href="aabb2.js.html#line117">line 117</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
this
</div>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="AABB2.html">AABB2</a></li><li><a href="AABB3.html">AABB3</a></li><li><a href="Canvas.html">Canvas</a></li><li><a href="Color.html">Color</a></li><li><a href="GUIObject.html">GUIObject</a></li><li><a href="Mat2.html">Mat2</a></li><li><a href="Mat3.html">Mat3</a></li><li><a href="Mat4.html">Mat4</a></li><li><a href="Mat32.html">Mat32</a></li><li><a href="Mathf.html">Mathf</a></li><li><a href="MeshFilter.html">MeshFilter</a></li><li><a href="Odin.html">Odin</a></li><li><a href="Odin.Class.html">Class</a></li><li><a href="Odin.EventEmitter.html">EventEmitter</a></li><li><a href="Odin.GameObject.html">GameObject</a></li><li><a href="Odin.Scene.html">Scene</a></li><li><a href="P2Contact.html">P2Contact</a></li><li><a href="P2Equation.html">P2Equation</a></li><li><a href="P2Friction.html">P2Friction</a></li><li><a href="P2Solver.html">P2Solver</a></li><li><a href="ParticleSystem.html">ParticleSystem</a></li><li><a href="Quat.html">Quat</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="SpriteAnimation.html">SpriteAnimation</a></li><li><a href="Vec2.html">Vec2</a></li><li><a href="Vec3.html">Vec3</a></li><li><a href="Vec4.html">Vec4</a></li><li><a href="WebGLRenderer.html">WebGLRenderer</a></li><li><a href="WebGLRenderer2D.html">WebGLRenderer2D</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Feb 12 2014 11:57:19 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>