flatten-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>classes/matrix.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="Flatten.Arc.html">Arc</a></li><li class="nav-item">F<a href="Flatten.Arc.html#breakToFunctional">breakToFunctional</a></li><li class="nav-item">F<a href="Flatten.Arc.html#chordHeight">chordHeight</a></li><li class="nav-item">F<a href="Flatten.Arc.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Arc.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Arc.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Arc.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Arc.html#middle">middle</a></li><li class="nav-item">F<a href="Flatten.Arc.html#reverse">reverse</a></li><li class="nav-item">F<a href="Flatten.Arc.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Arc.html#split">split</a></li><li class="nav-item">F<a href="Flatten.Arc.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Arc.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Flatten.Arc.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Flatten.Arc.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Flatten.Arc.html#transform">transform</a></li><li class="nav-item">F<a href="Flatten.Arc.html#translate">translate</a></li><li class="nav-heading">C<a href="Flatten.Box.html">Box</a></li><li class="nav-item">F<a href="Flatten.Box.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Box.html#equal_to">equal_to</a></li><li class="nav-item">F<a href="Flatten.Box.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Box.html#less_than">less_than</a></li><li class="nav-item">F<a href="Flatten.Box.html#merge">merge</a></li><li class="nav-item">F<a href="Flatten.Box.html#not_intersect">not_intersect</a></li><li class="nav-item">F<a href="Flatten.Box.html#set">set</a></li><li class="nav-item">F<a href="Flatten.Box.html#svg">svg</a></li><li class="nav-heading">C<a href="Flatten.Circle.html">Circle</a></li><li class="nav-item">F<a href="Flatten.Circle.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Circle.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Circle.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Circle.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Circle.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Circle.html#toArc">toArc</a></li><li class="nav-item">F<a href="Flatten.Circle.html#toJSON">toJSON</a></li><li class="nav-heading">C<a href="Flatten.Edge.html">Edge</a></li><li class="nav-item">F<a href="Flatten.Edge.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Edge.html#middle">middle</a></li><li class="nav-item">F<a href="Flatten.Edge.html#setInclusion">setInclusion</a></li><li class="nav-item">F<a href="Flatten.Edge.html#setOverlap">setOverlap</a></li><li class="nav-heading">C<a href="Flatten.Face.html">Face</a></li><li class="nav-item">F<a href="Flatten.Face.html#append">append</a></li><li class="nav-item">F<a href="Flatten.Face.html#area">area</a></li><li class="nav-item">F<a href="Flatten.Face.html#insert">insert</a></li><li class="nav-item">F<a href="Flatten.Face.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="Flatten.Face.html#isSimple">isSimple</a></li><li class="nav-item">F<a href="Flatten.Face.html#orientation">orientation</a></li><li class="nav-item">F<a href="Flatten.Face.html#remove">remove</a></li><li class="nav-item">F<a href="Flatten.Face.html#reverse">reverse</a></li><li class="nav-item">F<a href="Flatten.Face.html#setArcLength">setArcLength</a></li><li class="nav-item">F<a href="Flatten.Face.html#signedArea">signedArea</a></li><li class="nav-item">F<a href="Flatten.Face.html#svg">svg</a></li><li class="nav-heading">C<a href="Flatten.Image.html">Image</a></li><li class="nav-heading">C<a href="Flatten.Line.html">Line</a></li><li class="nav-item">F<a href="Flatten.Line.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Line.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Line.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Line.html#incidentTo">incidentTo</a></li><li class="nav-item">F<a href="Flatten.Line.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Line.html#parallelTo">parallelTo</a></li><li class="nav-item">F<a href="Flatten.Line.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Line.html#toJSON">toJSON</a></li><li class="nav-heading">C<a href="Flatten.Matrix.html">Matrix</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#multiply">multiply</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#scale">scale</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#transform">transform</a></li><li class="nav-item">F<a href="Flatten.Matrix.html#translate">translate</a></li><li class="nav-heading">C<a href="Flatten.PlanarSet.html">PlanarSet</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#add">add</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#clear">clear</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#delete">delete</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#hit">hit</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#search">search</a></li><li class="nav-item">F<a href="Flatten.PlanarSet.html#svg">svg</a></li><li class="nav-heading">C<a href="Flatten.Point.html">Point</a></li><li class="nav-item">F<a href="Flatten.Point.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Point.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Point.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Flatten.Point.html#leftTo">leftTo</a></li><li class="nav-item">F<a href="Flatten.Point.html#lessThan">lessThan</a></li><li class="nav-item">F<a href="Flatten.Point.html#on">on</a></li><li class="nav-item">F<a href="Flatten.Point.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Flatten.Point.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Point.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Point.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Flatten.Point.html#transform">transform</a></li><li class="nav-item">F<a href="Flatten.Point.html#translate">translate</a></li><li class="nav-heading">C<a href="Flatten.Polygon.html">Polygon</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#addFace">addFace</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#addVertex">addVertex</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#area">area</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#deleteFace">deleteFace</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#isValid">isValid</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#removeChain">removeChain</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#transform">transform</a></li><li class="nav-item">F<a href="Flatten.Polygon.html#translate">translate</a></li><li class="nav-heading">C<a href="Flatten.Ray.html">Ray</a></li><li class="nav-item">F<a href="Flatten.Ray.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Ray.html#intersect">intersect</a></li><li class="nav-heading">C<a href="Flatten.Segment.html">Segment</a></li><li class="nav-item">F<a href="Flatten.Segment.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Segment.html#contains">contains</a></li><li class="nav-item">F<a href="Flatten.Segment.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Flatten.Segment.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Flatten.Segment.html#intersect">intersect</a></li><li class="nav-item">F<a href="Flatten.Segment.html#isZeroLength">isZeroLength</a></li><li class="nav-item">F<a href="Flatten.Segment.html#middle">middle</a></li><li class="nav-item">F<a href="Flatten.Segment.html#reverse">reverse</a></li><li class="nav-item">F<a href="Flatten.Segment.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Segment.html#split">split</a></li><li class="nav-item">F<a href="Flatten.Segment.html#svg">svg</a></li><li class="nav-item">F<a href="Flatten.Segment.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Flatten.Segment.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Flatten.Segment.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Flatten.Segment.html#transform">transform</a></li><li class="nav-item">F<a href="Flatten.Segment.html#translate">translate</a></li><li class="nav-heading">C<a href="Flatten.Vector.html">Vector</a></li><li class="nav-item">F<a href="Flatten.Vector.html#add">add</a></li><li class="nav-item">F<a href="Flatten.Vector.html#angleTo">angleTo</a></li><li class="nav-item">F<a href="Flatten.Vector.html#clone">clone</a></li><li class="nav-item">F<a href="Flatten.Vector.html#cross">cross</a></li><li class="nav-item">F<a href="Flatten.Vector.html#dot">dot</a></li><li class="nav-item">F<a href="Flatten.Vector.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Flatten.Vector.html#invert">invert</a></li><li class="nav-item">F<a href="Flatten.Vector.html#multiply">multiply</a></li><li class="nav-item">F<a href="Flatten.Vector.html#normalize">normalize</a></li><li class="nav-item">F<a href="Flatten.Vector.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Flatten.Vector.html#rotate">rotate</a></li><li class="nav-item">F<a href="Flatten.Vector.html#rotate90CCW">rotate90CCW</a></li><li class="nav-item">F<a href="Flatten.Vector.html#rotate90CW">rotate90CW</a></li><li class="nav-item">F<a href="Flatten.Vector.html#subtract">subtract</a></li><li class="nav-item">F<a href="Flatten.Vector.html#toJSON">toJSON</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">M<a href="global.html#DP_TOL">DP_TOL</a></li> </nav> <div id="main"> <h1 class="page-title">classes/matrix.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>"use strict"; module.exports = function(Flatten) { /** * Class representing an affine transformation 3x3 matrix: * <pre> * [ a c tx * A = b d ty * 0 0 1 ] * </pre * @type {Matrix} */ Flatten.Matrix = class Matrix { /** * Construct new instance of affine transformation matrix * If parameters omitted, construct identity matrix a = 1, d = 1 * @param {number} a - position(0,0) sx*cos(alpha) * @param {number} b - position (0,1) sx*sin(alpha) * @param {number} c - position (1,0) -sy*sin(alpha) * @param {number} d - position (1,1) sy*cos(alpha) * @param {number} tx - position (2,0) translation by x * @param {number} ty - position (2,1) translation by y */ constructor(a=1,b=0,c=0,d=1,tx=0,ty=0) { this.a = a; this.b = b; this.c = c; this.d = d; this.tx = tx; this.ty = ty; } /** * Returns a clone of the Matrix instance. * @return {Matrix} **/ clone() { return new Matrix(this.a, this.b, this.c, this.d, this.tx, this.ty); }; /** * Transform vector [x,y] using transformation matrix. * Vector [x,y] is an abstract array[2] of numbers and not a FlattenJS object * The result is also an abstract vector [x',y'] = A * [x,y]: * <code> * [x' [ ax + by + tx * y' = cx + dy + ty * 1] 1 ] * </code> * @param {number[]} vector - array[2] of numbers * @returns {number[]} transformation result - array[2] of numbers */ transform(vector) { return [ vector[0]*this.a+vector[1]*this.c+this.tx, vector[0]*this.b+vector[1]*this.d+this.ty ] }; /** * Returns result of multiplication of this matrix by other matrix * @param {Matrix} other_matrix - matrix to multiply by * @returns {Matrix} */ multiply(other_matrix) { return new Matrix( this.a*other_matrix.a + this.c*other_matrix.b, this.b*other_matrix.a + this.d*other_matrix.b, this.a*other_matrix.c + this.c*other_matrix.d, this.b*other_matrix.c + this.d*other_matrix.d, this.a*other_matrix.tx + this.c*other_matrix.ty + this.tx, this.b*other_matrix.tx + this.d*other_matrix.ty + this.ty ) }; /** * Return new matrix as a result of multiplication of the current matrix * by the matrix(1,0,0,1,tx,ty) * @param {number} tx - translation by x * @param {number} ty - translation by y * @returns {Matrix} */ translate(...args) { let tx, ty; if (args.length == 1 && (args[0] instanceof Flatten.Vector)) { tx = args[0].x; ty = args[0].y; } else if (args.length == 2 && typeof(args[0]) == "number" && typeof(args[1]) == "number") { tx = args[0]; ty = args[1]; } else { throw Flatten.Errors.ILLEGAL_PARAMETERS; } return this.multiply(new Matrix(1,0,0,1,tx,ty)) }; /** * Return new matrix as a result of multiplication of the current matrix * by the matrix that defines rotation by given angle (in radians) around * point (0,0) in counter clockwise direction * @param angle * @returns {Matrix} */ rotate(angle) { let cos = Math.cos(angle); let sin = Math.sin(angle); return this.multiply(new Matrix(cos,sin,-sin,cos,0,0)); }; /** * Return new matrix as a result of multiplication of the current matrix * by the matrix (sx,0,0,sy,0,0) that defines scaling * @param sx * @param sy * @returns {Matrix} */ scale(sx, sy) { return this.multiply(new Matrix(sx,0,0,sy,0,0)); }; /** * Returns true if two matrix are equal parameter by parameter * @param {Matrix} matrix - other matrix * @returns {boolean} true if equal, false otherwise */ equalTo(matrix) { if (!Flatten.Utils.EQ(this.tx, matrix.tx)) return false; if (!Flatten.Utils.EQ(this.ty, matrix.ty)) return false; if (!Flatten.Utils.EQ(this.a, matrix.a)) return false; if (!Flatten.Utils.EQ(this.b, matrix.b)) return false; if (!Flatten.Utils.EQ(this.c, matrix.c)) return false; if (!Flatten.Utils.EQ(this.d, matrix.d)) return false; return true; }; }; /** * Function to create matrix equivalent to "new" constructor * @param args */ Flatten.matrix = (...args) => new Flatten.Matrix(...args); }; </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Dec 07 2018 09:41:42 GMT+0200 (Jerusalem Standard Time) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>