flatten-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>classes/circle.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/circle.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * Created by Alex Bol on 3/6/2017. */ "use strict"; module.exports = function(Flatten) { let {Arc,vector} = Flatten; /** * Class representing a circle * @type {Circle} */ Flatten.Circle = class Circle { /** * * @param {Point} pc - circle center point * @param {number} r - circle radius */ constructor(...args) { /** * Circle center * @type {Point} */ this.pc = new Flatten.Point(); /** * Circle radius * @type {number} */ this.r = 1; if (args.length == 1 && args[0] instanceof Object && args[0].name === "circle") { let {pc, r} = args[0]; this.pc = new Flatten.Point(pc); this.r = r; return; } else { let [pc, r] = [...args]; if (pc && pc instanceof Flatten.Point) this.pc = pc.clone(); if (r !== undefined) this.r = r; return; } throw Flatten.Errors.ILLEGAL_PARAMETERS; } /** * Method clone returns new instance of a Circle * @returns {Circle} */ clone() { return new Flatten.Circle(this.pc.clone(), this.r); } /** * Circle center * @returns {Point} */ get center() { return this.pc; } /** * Circle bounding box * @returns {Box} */ get box() { return new Flatten.Box( this.pc.x - this.r, this.pc.y - this.r, this.pc.x + this.r, this.pc.y + this.r ); } /** * Return true if circle contains point * @param {Point} pt - test point * @returns {boolean} */ contains(pt) { return Flatten.Utils.LE(pt.distanceTo(this.center)[0], this.r); } /** * Transform circle to closed arc * @param {boolean} counterclockwise * @returns {Arc} */ toArc(counterclockwise=true) { return new Flatten.Arc(this.center, this.r, Math.PI, -Math.PI, counterclockwise); } /** * Returns array of intersection points between circle and other shape * @param {Shape} shape Shape of the one of supported types * @returns {Point[]} */ intersect(shape) { if (shape instanceof Flatten.Point) { return this.contains(shape) ? [shape] : []; } if (shape instanceof Flatten.Line) { return shape.intersect(this); } if (shape instanceof Flatten.Segment) { return shape.intersect(this); } if (shape instanceof Flatten.Circle) { return Circle.intersectCirle2Circle(this, shape); } if (shape instanceof Flatten.Arc) { return shape.intersect(this); } if (shape instanceof Flatten.Polygon) { return Flatten.Polygon.intersectShape2Polygon(this, shape); } } /** * Calculate distance and shortest segment from circle to shape and return 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 circle to shape * @returns {Segment} shortest segment between circle and shape (started at circle, ended at shape) */ distanceTo(shape) { let {Distance} = Flatten; let {point2circle, circle2circle, circle2line, segment2circle, arc2circle} = Distance; if (shape instanceof Flatten.Point) { let [distance, shortest_segment] = point2circle(shape, this); shortest_segment = shortest_segment.reverse(); return [distance, shortest_segment]; } if (shape instanceof Flatten.Circle) { let [distance, shortest_segment] = circle2circle(this, shape); return [distance, shortest_segment]; } if (shape instanceof Flatten.Line) { let [distance, shortest_segment] = circle2line(this, shape); return [distance, shortest_segment]; } if (shape instanceof Flatten.Segment) { let [distance, shortest_segment] = segment2circle(shape, this); shortest_segment = shortest_segment.reverse(); return [distance, shortest_segment]; } if (shape instanceof Flatten.Arc) { let [distance, shortest_segment] = arc2circle(shape, this); shortest_segment = shortest_segment.reverse(); return [distance, shortest_segment]; } if (shape instanceof Flatten.Polygon) { let [distance, shortest_segment] = Distance.shape2polygon(this, shape); return [distance, shortest_segment]; } if (shape instanceof Flatten.PlanarSet) { let [dist, shortest_segment] = Distance.shape2planarSet(this, shape); return [dist, shortest_segment]; } } static intersectCirle2Circle(circle1, circle2) { let ip = []; if (circle1.box.not_intersect(circle2.box)) { return ip; } let vec = new Flatten.Vector(circle1.pc, circle2.pc); let r1 = circle1.r; let r2 = circle2.r; // Degenerated circle if (Flatten.Utils.EQ_0(r1) || Flatten.Utils.EQ_0(r2)) return ip; // In case of equal circles return one leftmost point if (Flatten.Utils.EQ_0(vec.x) && Flatten.Utils.EQ_0(vec.y) && Flatten.Utils.EQ(r1, r2)) { ip.push(circle1.pc.translate(-r1, 0)); return ip; } let dist = circle1.pc.distanceTo(circle2.pc)[0]; if (Flatten.Utils.GT(dist, r1 + r2)) // circles too far, no intersections return ip; if (Flatten.Utils.LT(dist, Math.abs(r1 - r2))) // one circle is contained within another, no intersections return ip; // Normalize vector. vec.x /= dist; vec.y /= dist; let pt; // Case of touching from outside or from inside - single intersection point // TODO: check this specifically not sure if correct if (Flatten.Utils.EQ(dist, r1 + r2) || Flatten.Utils.EQ(dist, Math.abs(r1 - r2))) { pt = circle1.pc.translate(r1*vec.x, r1*vec.y); ip.push(pt); return ip; } // Case of two intersection points // Distance from first center to center of common chord: // a = (r1^2 - r2^2 + d^2) / 2d // Separate for better accuracy let a = (r1*r1)/(2*dist) - (r2*r2)/(2*dist) + dist/2; let mid_pt = circle1.pc.translate(a*vec.x, a*vec.y); let h = Math.sqrt(r1*r1 - a*a); // let norm; // norm = vec.rotate90CCW().multiply(h); pt = mid_pt.translate(vec.rotate90CCW().multiply(h)); ip.push(pt); // norm = vec.rotate90CW(); pt = mid_pt.translate(vec.rotate90CW().multiply(h)); ip.push(pt); return ip; } /** * Return string to draw circle in svg * @param {Object} attrs - an object with attributes of svg circle element, * like "stroke", "strokeWidth", "fill" * Defaults are stroke:"black", strokeWidth:"1", fill:"none" * @returns {string} */ svg(attrs = {}) { let {stroke, strokeWidth, fill, fillOpacity, 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.pc.x}" cy="${this.pc.y}" r="${this.r}" stroke="${stroke || "black"}" stroke-width="${strokeWidth || 1}" fill="${fill || "none"}" fill-opacity="${fillOpacity || 1.0}" ${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:"circle"}); } }; /** * Shortcut to create new circle * @param args */ Flatten.circle = (...args) => new Flatten.Circle(...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>