UNPKG

odin

Version:

Node.js Canvas/WebGL Javascript Game Framework

2,646 lines (716 loc) 31.5 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Mat2</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: Mat2</h1> <section> <header> <h2> Mat2 </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Mat2"><span class="type-signature"></span>new Mat2<span class="signature">(Number, Number, Number, 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">m11</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m12</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m21</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m22</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line15">line 15</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="this.elements"><span class="type-signature">&lt;static> </span>this.elements<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>Float32Array</code></td> <td class="type"> </td> <td class="description last">elements</td> </tr> </tbody> </table></dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line30">line 30</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="clone"><span class="type-signature">&lt;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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line40">line 40</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Mat2 </div> </dd> <dt> <h4 class="name" id="copy"><span class="type-signature">&lt;static> </span>copy<span class="signature">(Mat2)</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>Mat2</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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line55">line 55</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="determinant"><span class="type-signature">&lt;static> </span>determinant<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line229">line 229</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">&lt;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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line425">line 425</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="fromMat3"><span class="type-signature">&lt;static> </span>fromMat3<span class="signature">(Mat3)</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>Mat3</code></td> <td class="type"> </td> <td class="description last">m</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line387">line 387</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="fromMat4"><span class="type-signature">&lt;static> </span>fromMat4<span class="signature">(Mat4)</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>Mat4</code></td> <td class="type"> </td> <td class="description last">m</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line406">line 406</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="getRotation"><span class="type-signature">&lt;static> </span>getRotation<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line349">line 349</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> Number </div> </dd> <dt> <h4 class="name" id="identity"><span class="type-signature">&lt;static> </span>identity<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line195">line 195</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="inverse"><span class="type-signature">&lt;static> </span>inverse<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line241">line 241</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="inverseMat"><span class="type-signature">&lt;static> </span>inverseMat<span class="signature">(Mat2)</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>Mat2</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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line267">line 267</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="mmul"><span class="type-signature">&lt;static> </span>mmul<span class="signature">(Mat2, Mat2)</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>Mat2</code></td> <td class="type"> </td> <td class="description last">a</td> </tr> <tr> <td class="name"><code>Mat2</code></td> <td class="type"> </td> <td class="description last">b</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line125">line 125</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="mul"><span class="type-signature">&lt;static> </span>mul<span class="signature">(Mat2)</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>Mat2</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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line95">line 95</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="rotate"><span class="type-signature">&lt;static> </span>rotate<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">angle</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line361">line 361</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="sdiv"><span class="type-signature">&lt;static> </span>sdiv<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line175">line 175</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="set"><span class="type-signature">&lt;static> </span>set<span class="signature">(Number, Number, Number, 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">m11</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m12</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m21</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">m22</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line74">line 74</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="setRotation"><span class="type-signature">&lt;static> </span>setRotation<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">angle</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line329">line 329</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="setTrace"><span class="type-signature">&lt;static> </span>setTrace<span class="signature">(Number, 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">x</td> </tr> <tr> <td class="name"><code>Number</code></td> <td class="type"> </td> <td class="description last">y</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line312">line 312</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="smul"><span class="type-signature">&lt;static> </span>smul<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line157">line 157</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">&lt;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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line444">line 444</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">&lt;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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line464">line 464</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> String </div> </dd> <dt> <h4 class="name" id="transpose"><span class="type-signature">&lt;static> </span>transpose<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line295">line 295</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> this </div> </dd> <dt> <h4 class="name" id="zero"><span class="type-signature">&lt;static> </span>zero<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="mat2.js.html">math/mat2.js</a>, <a href="mat2.js.html#line212">line 212</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>