@flatten-js/core

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>classes/box.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="Arc.html">Arc</a></li><li class="nav-item">F<a href="Arc.html#clone">clone</a></li><li class="nav-item">F<a href="Arc.html#contains">contains</a></li><li class="nav-item">F<a href="Arc.html#split">split</a></li><li class="nav-item">F<a href="Arc.html#middle">middle</a></li><li class="nav-item">F<a href="Arc.html#chordHeight">chordHeight</a></li><li class="nav-item">F<a href="Arc.html#intersect">intersect</a></li><li class="nav-item">F<a href="Arc.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Arc.html#breakToFunctional">breakToFunctional</a></li><li class="nav-item">F<a href="Arc.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Arc.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Arc.html#reverse">reverse</a></li><li class="nav-item">F<a href="Arc.html#translate">translate</a></li><li class="nav-item">F<a href="Arc.html#rotate">rotate</a></li><li class="nav-item">F<a href="Arc.html#scale">scale</a></li><li class="nav-item">F<a href="Arc.html#transform">transform</a></li><li class="nav-item">F<a href="Arc.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Arc.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Arc.html#svg">svg</a></li><li class="nav-heading">C<a href="Box.html">Box</a></li><li class="nav-item">F<a href="Box.html#clone">clone</a></li><li class="nav-item">F<a href="Box.html#not_intersect">not_intersect</a></li><li class="nav-item">F<a href="Box.html#intersect">intersect</a></li><li class="nav-item">F<a href="Box.html#merge">merge</a></li><li class="nav-item">F<a href="Box.html#less_than">less_than</a></li><li class="nav-item">F<a href="Box.html#equal_to">equal_to</a></li><li class="nav-item">F<a href="Box.html#set">set</a></li><li class="nav-item">F<a href="Box.html#toPoints">toPoints</a></li><li class="nav-item">F<a href="Box.html#toSegments">toSegments</a></li><li class="nav-item">F<a href="Box.html#svg">svg</a></li><li class="nav-heading">C<a href="Circle.html">Circle</a></li><li class="nav-item">F<a href="Circle.html#clone">clone</a></li><li class="nav-item">F<a href="Circle.html#contains">contains</a></li><li class="nav-item">F<a href="Circle.html#toArc">toArc</a></li><li class="nav-item">F<a href="Circle.html#intersect">intersect</a></li><li class="nav-item">F<a href="Circle.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Circle.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Circle.html#svg">svg</a></li><li class="nav-heading">C<a href="Edge.html">Edge</a></li><li class="nav-item">F<a href="Edge.html#middle">middle</a></li><li class="nav-item">F<a href="Edge.html#contains">contains</a></li><li class="nav-item">F<a href="Edge.html#setInclusion">setInclusion</a></li><li class="nav-item">F<a href="Edge.html#setOverlap">setOverlap</a></li><li class="nav-heading">C<a href="Face.html">Face</a></li><li class="nav-item">F<a href="Face.html#append">append</a></li><li class="nav-item">F<a href="Face.html#insert">insert</a></li><li class="nav-item">F<a href="Face.html#remove">remove</a></li><li class="nav-item">F<a href="Face.html#reverse">reverse</a></li><li class="nav-item">F<a href="Face.html#setArcLength">setArcLength</a></li><li class="nav-item">F<a href="Face.html#area">area</a></li><li class="nav-item">F<a href="Face.html#signedArea">signedArea</a></li><li class="nav-item">F<a href="Face.html#orientation">orientation</a></li><li class="nav-item">F<a href="Face.html#isSimple">isSimple</a></li><li class="nav-item">F<a href="Face.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Face.html#toPolygon">toPolygon</a></li><li class="nav-item">F<a href="Face.html#svg">svg</a></li><li class="nav-heading">C<a href="Line.html">Line</a></li><li class="nav-item">F<a href="Line.html#clone">clone</a></li><li class="nav-item">F<a href="Line.html#parallelTo">parallelTo</a></li><li class="nav-item">F<a href="Line.html#incidentTo">incidentTo</a></li><li class="nav-item">F<a href="Line.html#contains">contains</a></li><li class="nav-item">F<a href="Line.html#coord">coord</a></li><li class="nav-item">F<a href="Line.html#intersect">intersect</a></li><li class="nav-item">F<a href="Line.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Line.html#split">split</a></li><li class="nav-item">F<a href="Line.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Line.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Line.html#svg">svg</a></li><li class="nav-heading">C<a href="Matrix.html">Matrix</a></li><li class="nav-item">F<a href="Matrix.html#clone">clone</a></li><li class="nav-item">F<a href="Matrix.html#transform">transform</a></li><li class="nav-item">F<a href="Matrix.html#multiply">multiply</a></li><li class="nav-item">F<a href="Matrix.html#translate">translate</a></li><li class="nav-item">F<a href="Matrix.html#rotate">rotate</a></li><li class="nav-item">F<a href="Matrix.html#scale">scale</a></li><li class="nav-item">F<a href="Matrix.html#equalTo">equalTo</a></li><li class="nav-heading">C<a href="Multiline.html">Multiline</a></li><li class="nav-item">F<a href="Multiline.html#clone">clone</a></li><li class="nav-item">F<a href="Multiline.html#addVertex">addVertex</a></li><li class="nav-item">F<a href="Multiline.html#split">split</a></li><li class="nav-item">F<a href="Multiline.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Multiline.html#translate">translate</a></li><li class="nav-item">F<a href="Multiline.html#rotate">rotate</a></li><li class="nav-item">F<a href="Multiline.html#transform">transform</a></li><li class="nav-item">F<a href="Multiline.html#toShapes">toShapes</a></li><li class="nav-item">F<a href="Multiline.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Multiline.html#svg">svg</a></li><li class="nav-heading">C<a href="Point.html">Point</a></li><li class="nav-item">F<a href="Point.html#clone">clone</a></li><li class="nav-item">F<a href="Point.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Point.html#lessThan">lessThan</a></li><li class="nav-item">F<a href="Point.html#rotate">rotate</a></li><li class="nav-item">F<a href="Point.html#translate">translate</a></li><li class="nav-item">F<a href="Point.html#transform">transform</a></li><li class="nav-item">F<a href="Point.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Point.html#leftTo">leftTo</a></li><li class="nav-item">F<a href="Point.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Point.html#on">on</a></li><li class="nav-item">F<a href="Point.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Point.html#svg">svg</a></li><li class="nav-heading">C<a href="Polygon.html">Polygon</a></li><li class="nav-item">F<a href="Polygon.html#clone">clone</a></li><li class="nav-item">F<a href="Polygon.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="Polygon.html#isValid">isValid</a></li><li class="nav-item">F<a href="Polygon.html#area">area</a></li><li class="nav-item">F<a href="Polygon.html#addFace">addFace</a></li><li class="nav-item">F<a href="Polygon.html#deleteFace">deleteFace</a></li><li class="nav-item">F<a href="Polygon.html#removeChain">removeChain</a></li><li class="nav-item">F<a href="Polygon.html#addVertex">addVertex</a></li><li class="nav-item">F<a href="Polygon.html#cut">cut</a></li><li class="nav-item">F<a href="Polygon.html#cutFace">cutFace</a></li><li class="nav-item">F<a href="Polygon.html#findEdgeByPoint">findEdgeByPoint</a></li><li class="nav-item">F<a href="Polygon.html#splitToIslands">splitToIslands</a></li><li class="nav-item">F<a href="Polygon.html#reverse">reverse</a></li><li class="nav-item">F<a href="Polygon.html#contains">contains</a></li><li class="nav-item">F<a href="Polygon.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Polygon.html#intersect">intersect</a></li><li class="nav-item">F<a href="Polygon.html#translate">translate</a></li><li class="nav-item">F<a href="Polygon.html#rotate">rotate</a></li><li class="nav-item">F<a href="Polygon.html#transform">transform</a></li><li class="nav-item">F<a href="Polygon.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Polygon.html#toArray">toArray</a></li><li class="nav-item">F<a href="Polygon.html#svg">svg</a></li><li class="nav-heading">C<a href="Ray.html">Ray</a></li><li class="nav-item">F<a href="Ray.html#clone">clone</a></li><li class="nav-item">F<a href="Ray.html#contains">contains</a></li><li class="nav-item">F<a href="Ray.html#split">split</a></li><li class="nav-item">F<a href="Ray.html#intersect">intersect</a></li><li class="nav-item">F<a href="Ray.html#svg">svg</a></li><li class="nav-heading">C<a href="Segment.html">Segment</a></li><li class="nav-item">F<a href="Segment.html#clone">clone</a></li><li class="nav-item">F<a href="Segment.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Segment.html#contains">contains</a></li><li class="nav-item">F<a href="Segment.html#intersect">intersect</a></li><li class="nav-item">F<a href="Segment.html#distanceTo">distanceTo</a></li><li class="nav-item">F<a href="Segment.html#tangentInStart">tangentInStart</a></li><li class="nav-item">F<a href="Segment.html#tangentInEnd">tangentInEnd</a></li><li class="nav-item">F<a href="Segment.html#reverse">reverse</a></li><li class="nav-item">F<a href="Segment.html#split">split</a></li><li class="nav-item">F<a href="Segment.html#middle">middle</a></li><li class="nav-item">F<a href="Segment.html#translate">translate</a></li><li class="nav-item">F<a href="Segment.html#rotate">rotate</a></li><li class="nav-item">F<a href="Segment.html#transform">transform</a></li><li class="nav-item">F<a href="Segment.html#isZeroLength">isZeroLength</a></li><li class="nav-item">F<a href="Segment.html#sortPoints">sortPoints</a></li><li class="nav-item">F<a href="Segment.html#toJSON">toJSON</a></li><li class="nav-item">F<a href="Segment.html#svg">svg</a></li><li class="nav-heading">C<a href="Vector.html">Vector</a></li><li class="nav-item">F<a href="Vector.html#clone">clone</a></li><li class="nav-item">F<a href="Vector.html#equalTo">equalTo</a></li><li class="nav-item">F<a href="Vector.html#multiply">multiply</a></li><li class="nav-item">F<a href="Vector.html#dot">dot</a></li><li class="nav-item">F<a href="Vector.html#cross">cross</a></li><li class="nav-item">F<a href="Vector.html#normalize">normalize</a></li><li class="nav-item">F<a href="Vector.html#rotate">rotate</a></li><li class="nav-item">F<a href="Vector.html#rotate90CCW">rotate90CCW</a></li><li class="nav-item">F<a href="Vector.html#rotate90CW">rotate90CW</a></li><li class="nav-item">F<a href="Vector.html#invert">invert</a></li><li class="nav-item">F<a href="Vector.html#add">add</a></li><li class="nav-item">F<a href="Vector.html#subtract">subtract</a></li><li class="nav-item">F<a href="Vector.html#angleTo">angleTo</a></li><li class="nav-item">F<a href="Vector.html#projectionOn">projectionOn</a></li><li class="nav-item">F<a href="Vector.html#toJSON">toJSON</a></li><li class="nav-heading">C<a href="CircularLinkedList.html">CircularLinkedList</a></li><li class="nav-item">F<a href="CircularLinkedList.html#append">append</a></li><li class="nav-item">F<a href="CircularLinkedList.html#insert">insert</a></li><li class="nav-item">F<a href="CircularLinkedList.html#remove">remove</a></li><li class="nav-heading">C<a href="DE9IM.html">DE9IM</a></li><li class="nav-item">F<a href="DE9IM.html#toString">toString</a></li><li class="nav-heading">C<a href="LinkedList.html">LinkedList</a></li><li class="nav-item">F<a href="LinkedList.html#toArray">toArray</a></li><li class="nav-item">F<a href="LinkedList.html#append">append</a></li><li class="nav-item">F<a href="LinkedList.html#insert">insert</a></li><li class="nav-item">F<a href="LinkedList.html#remove">remove</a></li><li class="nav-item">F<a href="LinkedList.html#isEmpty">isEmpty</a></li><li class="nav-item">F<a href="LinkedList.html#.testInfiniteLoop">testInfiniteLoop</a></li><li class="nav-heading">C<a href="PlanarSet.html">PlanarSet</a></li><li class="nav-item">F<a href="PlanarSet.html#add">add</a></li><li class="nav-item">F<a href="PlanarSet.html#delete">delete</a></li><li class="nav-item">F<a href="PlanarSet.html#clear">clear</a></li><li class="nav-item">F<a href="PlanarSet.html#search">search</a></li><li class="nav-item">F<a href="PlanarSet.html#hit">hit</a></li><li class="nav-item">F<a href="PlanarSet.html#svg">svg</a></li><li class="nav-heading">C<a href="Errors.html">Errors</a></li><li class="nav-heading">Modules</li><li class="nav-heading">M<a href="module-BooleanOperations.html">BooleanOperations</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.unify">unify</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.subtract">subtract</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.intersect">intersect</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.innerClip">innerClip</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.outerClip">outerClip</a></li><li class="nav-item">F<a href="module-BooleanOperations.html#.calculateIntersections">calculateIntersections</a></li><li class="nav-heading">M<a href="module-RayShoot.html">RayShoot</a></li><li class="nav-item">F<a href="module-RayShoot.html#.ray_shoot">ray_shoot</a></li><li class="nav-heading">M<a href="module-Relation.html">Relation</a></li><li class="nav-item">F<a href="module-Relation.html#.equal">equal</a></li><li class="nav-item">F<a href="module-Relation.html#.intersect">intersect</a></li><li class="nav-item">F<a href="module-Relation.html#.touch">touch</a></li><li class="nav-item">F<a href="module-Relation.html#.disjoint">disjoint</a></li><li class="nav-item">F<a href="module-Relation.html#.inside">inside</a></li><li class="nav-item">F<a href="module-Relation.html#.covered">covered</a></li><li class="nav-item">F<a href="module-Relation.html#.contain">contain</a></li><li class="nav-item">F<a href="module-Relation.html#.cover">cover</a></li><li class="nav-item">F<a href="module-Relation.html#.relate">relate</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">F<a href="global.html#inverse">inverse</a></li><li class="nav-item">M<a href="global.html#arc">arc</a></li><li class="nav-item">M<a href="global.html#box">box</a></li><li class="nav-item">M<a href="global.html#circle">circle</a></li><li class="nav-item">M<a href="global.html#line">line</a></li><li class="nav-item">M<a href="global.html#matrix">matrix</a></li><li class="nav-item">M<a href="global.html#multiline">multiline</a></li><li class="nav-item">M<a href="global.html#point">point</a></li><li class="nav-item">M<a href="global.html#polygon">polygon</a></li><li class="nav-item">M<a href="global.html#segment">segment</a></li><li class="nav-item">M<a href="global.html#vector">vector</a></li><li class="nav-item">M<a href="global.html#CCW">CCW</a></li><li class="nav-item">M<a href="global.html#CW">CW</a></li><li class="nav-item">M<a href="global.html#ORIENTATION">ORIENTATION</a></li><li class="nav-item">M<a href="global.html#DP_TOL">DP_TOL</a></li><li class="nav-item">F<a href="global.html#setTolerance">setTolerance</a></li><li class="nav-item">F<a href="global.html#getTolerance">getTolerance</a></li><li class="nav-item">F<a href="global.html#EQ_0">EQ_0</a></li><li class="nav-item">F<a href="global.html#EQ">EQ</a></li><li class="nav-item">F<a href="global.html#GT">GT</a></li><li class="nav-item">F<a href="global.html#GE">GE</a></li><li class="nav-item">F<a href="global.html#LT">LT</a></li><li class="nav-item">F<a href="global.html#LE">LE</a></li> </nav> <div id="main"> <h1 class="page-title">classes/box.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * Created by Alex Bol on 3/7/2017. */ "use strict"; import Flatten from '../flatten'; /** * Class Box represent bounding box of the shape * @type {Box} */ export class Box { /** * * @param {number} xmin - minimal x coordinate * @param {number} ymin - minimal y coordinate * @param {number} xmax - maximal x coordinate * @param {number} ymax - maximal y coordinate */ constructor(xmin = undefined, ymin = undefined, xmax = undefined, ymax = undefined) { /** * Minimal x coordinate * @type {number} */ this.xmin = xmin; /** * Minimal y coordinate * @type {number} */ this.ymin = ymin; /** * Maximal x coordinate * @type {number} */ this.xmax = xmax; /** * Maximal y coordinate * @type {number} */ this.ymax = ymax; } /** * Return new cloned instance of box * @returns {Box} */ clone() { return new Box(this.xmin, this.ymin, this.xmax, this.ymax); } /** * Property low need for interval tree interface * @returns {Point} */ get low() { return new Flatten.Point(this.xmin, this.ymin); } /** * Property high need for interval tree interface * @returns {Point} */ get high() { return new Flatten.Point(this.xmax, this.ymax); } /** * Property max returns the box itself ! * @returns {Box} */ get max() { return this.clone(); } /** * Return center of the box * @returns {Point} */ get center() { return new Flatten.Point((this.xmin + this.xmax) / 2, (this.ymin + this.ymax) / 2); } /** * Return property box like all other shapes * @returns {Box} */ get box() { return this.clone(); } /** * Returns true if not intersected with other box * @param {Box} other_box - other box to test * @returns {boolean} */ not_intersect(other_box) { return ( this.xmax < other_box.xmin || this.xmin > other_box.xmax || this.ymax < other_box.ymin || this.ymin > other_box.ymax ); } /** * Returns true if intersected with other box * @param {Box} other_box - Query box * @returns {boolean} */ intersect(other_box) { return !this.not_intersect(other_box); } /** * Returns new box merged with other box * @param {Box} other_box - Other box to merge with * @returns {Box} */ merge(other_box) { return new Box( this.xmin === undefined ? other_box.xmin : Math.min(this.xmin, other_box.xmin), this.ymin === undefined ? other_box.ymin : Math.min(this.ymin, other_box.ymin), this.xmax === undefined ? other_box.xmax : Math.max(this.xmax, other_box.xmax), this.ymax === undefined ? other_box.ymax : Math.max(this.ymax, other_box.ymax) ); } /** * Defines predicate "less than" between two boxes. Need for interval index * @param {Box} other_box - other box * @returns {boolean} - true if this box less than other box, false otherwise */ less_than(other_box) { if (this.low.lessThan(other_box.low)) return true; if (this.low.equalTo(other_box.low) && this.high.lessThan(other_box.high)) return true; return false; } /** * Returns true if this box is equal to other box, false otherwise * @param {Box} other_box - query box * @returns {boolean} */ equal_to(other_box) { return (this.low.equalTo(other_box.low) && this.high.equalTo(other_box.high)); } output() { return this.clone(); } static comparable_max(box1, box2) { // return pt1.lessThan(pt2) ? pt2.clone() : pt1.clone(); return box1.merge(box2); } static comparable_less_than(pt1, pt2) { return pt1.lessThan(pt2); } /** * Set new values to the box object * @param {number} xmin - miminal x coordinate * @param {number} ymin - minimal y coordinate * @param {number} xmax - maximal x coordinate * @param {number} ymax - maximal y coordinate */ set(xmin, ymin, xmax, ymax) { this.xmin = xmin; this.ymin = ymin; this.xmax = xmax; this.ymax = ymax; } /** * Transform box into array of points from low left corner in counter clockwise * @returns {Point[]} */ toPoints() { return [ new Flatten.Point(this.xmin, this.ymin), new Flatten.Point(this.xmax, this.ymin), new Flatten.Point(this.xmax, this.ymax), new Flatten.Point(this.xmin, this.ymax) ]; } /** * Transform box into array of segments from low left corner in counter clockwise * @returns {Segment[]} */ toSegments() { let pts = this.toPoints(); return [ new Flatten.Segment(pts[0], pts[1]), new Flatten.Segment(pts[1], pts[2]), new Flatten.Segment(pts[2], pts[3]), new Flatten.Segment(pts[3], pts[0]) ]; } /** * Return string to draw circle in svg * @param {Object} attrs - an object with attributes of svg rectangle element, * like "stroke", "strokeWidth", "fill" * Defaults are stroke:"black", strokeWidth:"1", fill:"none" * @returns {string} */ svg(attrs = {}) { let {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}"` : ""; let width = this.xmax - this.xmin; let height = this.ymax - this.ymin; return `\n<rect x="${this.xmin}" y="${this.ymin}" width=${width} height=${height} stroke="${stroke || "black"}" stroke-width="${strokeWidth || 1}" fill="${fill || "none"}" ${id_str} ${class_str} />`; }; }; Flatten.Box = Box; /** * Shortcut to create new circle * @param args * @returns {Box} */ export const box = (...args) => new Flatten.Box(...args); Flatten.box = box; </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sun May 16 2021 15:05:05 GMT+0300 (Israel Daylight Time) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>