flatten-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>classes/point.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/point.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * Created by Alex Bol on 2/18/2017. */ /** * * @param Flatten */ module.exports = function(Flatten) { /** * * Class representing a point * @type {Point} */ Flatten.Point = class Point { /** * Point may be constructed by two numbers, or by array of two numbers * @param {number} x - x-coordinate (float number) * @param {number} y - y-coordinate (float number) */ constructor(...args) { /** * x-coordinate (float number) * @type {number} */ this.x = 0; /** * y-coordinate (float number) * @type {number} */ this.y = 0; if (args.length === 0) { return; } if (args.length === 1 && args[0] instanceof Array && args[0].length === 2) { let arr = args[0]; if (typeof(arr[0]) == "number" && typeof(arr[1]) == "number") { this.x = arr[0]; this.y = arr[1]; return; } } if (args.length === 1 && args[0] instanceof Object && args[0].name === "point") { let {x, y} = args[0]; this.x = x; this.y = y; return; } if (args.length === 2) { if (typeof(args[0]) == "number" && typeof(args[1]) == "number") { this.x = args[0]; this.y = args[1]; return; } } throw Flatten.Errors.ILLEGAL_PARAMETERS; } /** * Returns bounding box of a point * @returns {Box} */ get box() { return new Flatten.Box(this.x, this.y, this.x, this.y); } /** * Method clone returns new copied instance of point * @returns {Point} */ clone() { return new Flatten.Point(this.x, this.y); } get vertices() { return [this.clone()]; } /** * Returns true if points are equal up to [Flatten.Utils.DP_TOL]{@link DP_TOL} tolerance * @param {Point} pt Query point * @returns {boolean} */ equalTo(pt) { return Flatten.Utils.EQ(this.x, pt.x) && Flatten.Utils.EQ(this.y, pt.y); } /** * Defines predicate "less than" between points. Returns true if the point is less than query points, false otherwise * By definition point1 < point2 if {point1.y < point2.y || point1.y == point2.y && point1.x < point2.y * Numeric values compared with [Flatten.Utils.DP_TOL]{@link DP_TOL} tolerance * @param {Point} pt Query point * @returns {boolean} */ lessThan(pt) { if (Flatten.Utils.LT(this.y, pt.y)) return true; if (Flatten.Utils.EQ(this.y, pt.y) && Flatten.Utils.LT(this.x, pt.x)) return true; return false; } /** * Returns new point rotated by given angle around given center point. * If center point is omitted, rotates around zero point (0,0). * Positive value of angle defines rotation in counter clockwise direction, * negative angle defines rotation in clockwise clockwise direction * @param {number} angle - angle in radians * @param {Point} [center=(0,0)] center * @returns {Point} */ rotate(angle, center = {x:0, y:0}) { var x_rot = center.x + (this.x - center.x) * Math.cos(angle) - (this.y - center.y) * Math.sin(angle); var y_rot = center.y + (this.x - center.x) * Math.sin(angle) + (this.y - center.y) * Math.cos(angle); return new Flatten.Point(x_rot, y_rot); } /** * Returns new point translated by given vector. * Translation vector may by also defined by a pair of numbers. * @param {Vector} vector - Translation vector defined as Flatten.Vector or * @param {number|number} - Translation vector defined as pair of numbers * @returns {Point} */ translate(...args) { if (args.length == 1 && (args[0] instanceof Flatten.Vector)) { return new Flatten.Point(this.x + args[0].x, this.y + args[0].y); } if (args.length == 2 && typeof(args[0]) == "number" && typeof(args[1]) == "number") { return new Flatten.Point(this.x + args[0], this.y + args[1]); } throw Flatten.Errors.ILLEGAL_PARAMETERS; } /** * Return new point transformed by affine transformation matrix m * @param {Matrix} m - affine transformation matrix (a,b,c,d,tx,ty) * @returns {Point} */ transform(m) { // let [x,y] = m.transform([this.x,this.y]); return new Flatten.Point(m.transform([this.x,this.y])) } /** * Returns projection point on given line * @param {Line} line Line this point be projected on * @returns {Point} */ projectionOn(line) { if (this.equalTo(line.pt)) // this point equal to line anchor point return this.clone(); let vec = new Flatten.Vector(this, line.pt); if (Flatten.Utils.EQ_0(vec.cross(line.norm))) // vector to point from anchor point collinear to normal vector return line.pt.clone(); let dist = vec.dot(line.norm); // signed distance let proj_vec = line.norm.multiply(dist); return this.translate(proj_vec); } /** * Returns true if point belongs to the "left" semi-plane, which means, point belongs to the same semi plane where line normal vector points to * Return false if point belongs to the "right" semi-plane or to the line itself * @param {Line} line Query line * @returns {boolean} */ leftTo(line) { let vec = new Flatten.Vector(line.pt, this); let onLeftSemiPlane = Flatten.Utils.GT(vec.dot(line.norm), 0); return onLeftSemiPlane; } /** * Calculate distance and shortest segment from point to shape and return as array [distance, shortest segment] * @param {Shape} shape Shape of the one of supported types Point, Line, Circle, Segment, Arc, Polygon or Planar Set * @returns {number} distance from point to shape * @returns {Segment} shortest segment between point and shape (started at point, ended at shape) */ distanceTo(shape) { let {Distance} = Flatten; if (shape instanceof Point) { let dx = shape.x - this.x; let dy = shape.y - this.y; return [Math.sqrt(dx*dx + dy*dy), new Flatten.Segment(this, shape)]; } if (shape instanceof Flatten.Line) { return Distance.point2line(this, shape); } if (shape instanceof Flatten.Circle) { return Distance.point2circle(this, shape); } if (shape instanceof Flatten.Segment) { return Distance.point2segment(this, shape); } if (shape instanceof Flatten.Arc) { // let [dist, ...rest] = Distance.point2arc(this, shape); // return dist; return Distance.point2arc(this, shape); } if (shape instanceof Flatten.Polygon) { // let [dist, ...rest] = Distance.point2polygon(this, shape); // return dist; return Distance.point2polygon(this, shape); } if (shape instanceof Flatten.PlanarSet) { return Distance.shape2planarSet(this, shape); } } /** * Returns true if point is on a shape, false otherwise * @param {Shape} shape Shape of the one of supported types Point, Line, Circle, Segment, Arc, Polygon * @returns {boolean} */ on(shape) { if (shape instanceof Flatten.Point) { return this.equalTo(shape); } if (shape instanceof Flatten.Line) { return shape.contains(this); } if (shape instanceof Flatten.Circle) { return shape.contains(this); } if (shape instanceof Flatten.Segment) { return shape.contains(this); } if (shape instanceof Flatten.Arc) { return shape.contains(this); } if (shape instanceof Flatten.Polygon) { return shape.contains(this); } } /** * Return string to draw point in svg as circle with radius "r" * Accept any valid attributes of svg elements as svg object * Defaults attribues are: * { * r:"3", * stroke:"black", * strokeWidth:"1", * fill:"red" * } * @param {Object} attrs - Any valid attributes of svg circle element, like "r", "stroke", "strokeWidth", "fill" * @returns {String} */ svg(attrs = {}) { let {r, stroke, strokeWidth, fill, id, className} = attrs; // let rest_str = Object.keys(rest).reduce( (acc, key) => acc += ` ${key}="${rest[key]}"`, ""); let id_str = (id && id.length > 0) ? `id="${id}"` : ""; let class_str = (className && className.length > 0) ? `class="${className}"` : ""; return `\n<circle cx="${this.x}" cy="${this.y}" r="${r || 3}" stroke="${stroke || "black"}" stroke-width="${strokeWidth || 1}" fill="${fill || "red"}" ${id_str} ${class_str} />`; } /** * This method returns an object that defines how data will be * serialized when called JSON.stringify() method * @returns {Object} */ toJSON() { return Object.assign({},this,{name:"point"}); } }; /** * Function to create point equivalent to "new" constructor * @param args */ Flatten.point = (...args) => new Flatten.Point(...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>