Merge pull request #160 from alexbol99/111_contains_relation_between_…

…point_and_box Add method 'contains' to Box
alexbol99 · Dec 23, 2023 · b89e303 · b89e303
2 parents 4903aa3 + 649b34b
commit b89e303
Show file tree

Hide file tree

Showing 60 changed files with 639 additions and 202 deletions.
diff --git a/dist/main.cjs b/dist/main.cjs
@@ -3983,28 +3983,35 @@ class PlanarSet extends Set {
      * This happens with no error, it is possible to use <i>size</i> property to check if
      * a shape was actually added.<br/>
      * Method returns planar set object updated and may be chained
-     * @param {Shape} shape - shape to be added, should have valid <i>box</i> property
+     * @param {AnyShape | {Box, AnyShape}} entry - shape to be added, should have valid <i>box</i> property
+     * Another option to transfer as an object {key: Box, value: AnyShape}
      * @returns {PlanarSet}
      */
-    add(shape) {
+    add(entry) {
         let size = this.size;
+        const {key, value} = entry;
+        const box = key || entry.box;
+        const shape = value || entry;
         super.add(shape);
         // size not changed - item not added, probably trying to add same item twice
         if (this.size > size) {
-            this.index.insert(shape.box, shape);
+            this.index.insert(box, shape);
         }
         return this;         // in accordance to Set.add interface
     }
 
     /**
      * Delete shape from planar set. Returns true if shape was actually deleted, false otherwise
-     * @param {Shape} shape - shape to be deleted
+     * @param {AnyShape | {Box, AnyShape}} entry - shape to be deleted
      * @returns {boolean}
      */
-    delete(shape) {
+    delete(entry) {
+        const {key, value} = entry;
+        const box = key || entry.box;
+        const shape = value || entry;
         let deleted = super.delete(shape);
         if (deleted) {
-            this.index.remove(shape.box, shape);
+            this.index.remove(box, shape);
         }
         return deleted;
     }
@@ -4021,7 +4028,7 @@ class PlanarSet extends Set {
      * 2d range search in planar set.<br/>
      * Returns array of all shapes in planar set which bounding box is intersected with query box
      * @param {Box} box - query box
-     * @returns {Shapes[]}
+     * @returns {AnyShape[]}
      */
     search(box) {
         let resp = this.index.search(box);
@@ -4031,7 +4038,7 @@ class PlanarSet extends Set {
     /**
      * Point location test. Returns array of shapes which contains given point
      * @param {Point} point - query point
-     * @returns {Array}
+     * @returns {AnyShape[]}
      */
     hit(point) {
         let box = new Flatten.Box(point.x - 1, point.y - 1, point.x + 1, point.y + 1);
@@ -4302,14 +4309,18 @@ let Point$1 = class Point extends 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
+     * @param {Shape} shape
      * @returns {boolean}
      */
     on(shape) {
         if (shape instanceof Flatten.Point) {
             return this.equalTo(shape);
         }
 
+        if (shape instanceof Flatten.Box) {
+            return shape.contains(this);
+        }
+
         if (shape instanceof Flatten.Line) {
             return shape.contains(this);
         }
@@ -6330,6 +6341,46 @@ class Box extends Shape {
             (new_box, pt) => new_box.merge(pt.box), new Box())
     }
 
+    /**
+     * Return true if box contains shape: no point of shape lies outside the box
+     * @param {AnyShape} shape - test shape
+     * @returns {boolean}
+     */
+    contains(shape) {
+        if (shape instanceof Flatten.Point) {
+            return (shape.x >= this.xmin) && (shape.x <= this.xmax) && (shape.y >= this.ymin) && (shape.y <= this.ymax);
+        }
+
+        if (shape instanceof Flatten.Segment) {
+            return shape.vertices.every(vertex => this.contains(vertex))
+        }
+
+        if (shape instanceof Flatten.Box) {
+            return shape.toSegments().every(segment => this.contains(segment))
+        }
+
+        if (shape instanceof Flatten.Circle) {
+            return this.contains(shape.box)
+        }
+
+        if (shape instanceof Flatten.Arc) {
+            return shape.vertices.every(vertex => this.contains(vertex)) &&
+                shape.toSegments().every(segment => intersectSegment2Arc(segment, shape).length === 0)
+        }
+
+        if (shape instanceof Flatten.Line || shape instanceof Flatten.Ray) {
+            return false
+        }
+
+        if (shape instanceof Flatten.Multiline) {
+            return shape.toShapes().every(shape => this.contains(shape))
+        }
+
+        if (shape instanceof Flatten.Polygon) {
+            return this.contains(shape.box)
+        }
+    }
+
     get name() {
         return "box"
     }

diff --git a/dist/main.mjs b/dist/main.mjs
@@ -3979,28 +3979,35 @@ class PlanarSet extends Set {
      * This happens with no error, it is possible to use <i>size</i> property to check if
      * a shape was actually added.<br/>
      * Method returns planar set object updated and may be chained
-     * @param {Shape} shape - shape to be added, should have valid <i>box</i> property
+     * @param {AnyShape | {Box, AnyShape}} entry - shape to be added, should have valid <i>box</i> property
+     * Another option to transfer as an object {key: Box, value: AnyShape}
      * @returns {PlanarSet}
      */
-    add(shape) {
+    add(entry) {
         let size = this.size;
+        const {key, value} = entry;
+        const box = key || entry.box;
+        const shape = value || entry;
         super.add(shape);
         // size not changed - item not added, probably trying to add same item twice
         if (this.size > size) {
-            this.index.insert(shape.box, shape);
+            this.index.insert(box, shape);
         }
         return this;         // in accordance to Set.add interface
     }
 
     /**
      * Delete shape from planar set. Returns true if shape was actually deleted, false otherwise
-     * @param {Shape} shape - shape to be deleted
+     * @param {AnyShape | {Box, AnyShape}} entry - shape to be deleted
      * @returns {boolean}
      */
-    delete(shape) {
+    delete(entry) {
+        const {key, value} = entry;
+        const box = key || entry.box;
+        const shape = value || entry;
         let deleted = super.delete(shape);
         if (deleted) {
-            this.index.remove(shape.box, shape);
+            this.index.remove(box, shape);
         }
         return deleted;
     }
@@ -4017,7 +4024,7 @@ class PlanarSet extends Set {
      * 2d range search in planar set.<br/>
      * Returns array of all shapes in planar set which bounding box is intersected with query box
      * @param {Box} box - query box
-     * @returns {Shapes[]}
+     * @returns {AnyShape[]}
      */
     search(box) {
         let resp = this.index.search(box);
@@ -4027,7 +4034,7 @@ class PlanarSet extends Set {
     /**
      * Point location test. Returns array of shapes which contains given point
      * @param {Point} point - query point
-     * @returns {Array}
+     * @returns {AnyShape[]}
      */
     hit(point) {
         let box = new Flatten.Box(point.x - 1, point.y - 1, point.x + 1, point.y + 1);
@@ -4298,14 +4305,18 @@ let Point$1 = class Point extends 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
+     * @param {Shape} shape
      * @returns {boolean}
      */
     on(shape) {
         if (shape instanceof Flatten.Point) {
             return this.equalTo(shape);
         }
 
+        if (shape instanceof Flatten.Box) {
+            return shape.contains(this);
+        }
+
         if (shape instanceof Flatten.Line) {
             return shape.contains(this);
         }
@@ -6326,6 +6337,46 @@ class Box extends Shape {
             (new_box, pt) => new_box.merge(pt.box), new Box())
     }
 
+    /**
+     * Return true if box contains shape: no point of shape lies outside the box
+     * @param {AnyShape} shape - test shape
+     * @returns {boolean}
+     */
+    contains(shape) {
+        if (shape instanceof Flatten.Point) {
+            return (shape.x >= this.xmin) && (shape.x <= this.xmax) && (shape.y >= this.ymin) && (shape.y <= this.ymax);
+        }
+
+        if (shape instanceof Flatten.Segment) {
+            return shape.vertices.every(vertex => this.contains(vertex))
+        }
+
+        if (shape instanceof Flatten.Box) {
+            return shape.toSegments().every(segment => this.contains(segment))
+        }
+
+        if (shape instanceof Flatten.Circle) {
+            return this.contains(shape.box)
+        }
+
+        if (shape instanceof Flatten.Arc) {
+            return shape.vertices.every(vertex => this.contains(vertex)) &&
+                shape.toSegments().every(segment => intersectSegment2Arc(segment, shape).length === 0)
+        }
+
+        if (shape instanceof Flatten.Line || shape instanceof Flatten.Ray) {
+            return false
+        }
+
+        if (shape instanceof Flatten.Multiline) {
+            return shape.toShapes().every(shape => this.contains(shape))
+        }
+
+        if (shape instanceof Flatten.Polygon) {
+            return this.contains(shape.box)
+        }
+    }
+
     get name() {
         return "box"
     }

diff --git a/dist/main.umd.js b/dist/main.umd.js
@@ -3985,28 +3985,35 @@
          * This happens with no error, it is possible to use <i>size</i> property to check if
          * a shape was actually added.<br/>
          * Method returns planar set object updated and may be chained
-         * @param {Shape} shape - shape to be added, should have valid <i>box</i> property
+         * @param {AnyShape | {Box, AnyShape}} entry - shape to be added, should have valid <i>box</i> property
+         * Another option to transfer as an object {key: Box, value: AnyShape}
          * @returns {PlanarSet}
          */
-        add(shape) {
+        add(entry) {
             let size = this.size;
+            const {key, value} = entry;
+            const box = key || entry.box;
+            const shape = value || entry;
             super.add(shape);
             // size not changed - item not added, probably trying to add same item twice
             if (this.size > size) {
-                this.index.insert(shape.box, shape);
+                this.index.insert(box, shape);
             }
             return this;         // in accordance to Set.add interface
         }
 
         /**
          * Delete shape from planar set. Returns true if shape was actually deleted, false otherwise
-         * @param {Shape} shape - shape to be deleted
+         * @param {AnyShape | {Box, AnyShape}} entry - shape to be deleted
          * @returns {boolean}
          */
-        delete(shape) {
+        delete(entry) {
+            const {key, value} = entry;
+            const box = key || entry.box;
+            const shape = value || entry;
             let deleted = super.delete(shape);
             if (deleted) {
-                this.index.remove(shape.box, shape);
+                this.index.remove(box, shape);
             }
             return deleted;
         }
@@ -4023,7 +4030,7 @@
          * 2d range search in planar set.<br/>
          * Returns array of all shapes in planar set which bounding box is intersected with query box
          * @param {Box} box - query box
-         * @returns {Shapes[]}
+         * @returns {AnyShape[]}
          */
         search(box) {
             let resp = this.index.search(box);
@@ -4033,7 +4040,7 @@
         /**
          * Point location test. Returns array of shapes which contains given point
          * @param {Point} point - query point
-         * @returns {Array}
+         * @returns {AnyShape[]}
          */
         hit(point) {
             let box = new Flatten.Box(point.x - 1, point.y - 1, point.x + 1, point.y + 1);
@@ -4304,14 +4311,18 @@
 
         /**
          * 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
+         * @param {Shape} shape
          * @returns {boolean}
          */
         on(shape) {
             if (shape instanceof Flatten.Point) {
                 return this.equalTo(shape);
             }
 
+            if (shape instanceof Flatten.Box) {
+                return shape.contains(this);
+            }
+
             if (shape instanceof Flatten.Line) {
                 return shape.contains(this);
             }
@@ -6332,6 +6343,46 @@
                 (new_box, pt) => new_box.merge(pt.box), new Box())
         }
 
+        /**
+         * Return true if box contains shape: no point of shape lies outside the box
+         * @param {AnyShape} shape - test shape
+         * @returns {boolean}
+         */
+        contains(shape) {
+            if (shape instanceof Flatten.Point) {
+                return (shape.x >= this.xmin) && (shape.x <= this.xmax) && (shape.y >= this.ymin) && (shape.y <= this.ymax);
+            }
+
+            if (shape instanceof Flatten.Segment) {
+                return shape.vertices.every(vertex => this.contains(vertex))
+            }
+
+            if (shape instanceof Flatten.Box) {
+                return shape.toSegments().every(segment => this.contains(segment))
+            }
+
+            if (shape instanceof Flatten.Circle) {
+                return this.contains(shape.box)
+            }
+
+            if (shape instanceof Flatten.Arc) {
+                return shape.vertices.every(vertex => this.contains(vertex)) &&
+                    shape.toSegments().every(segment => intersectSegment2Arc(segment, shape).length === 0)
+            }
+
+            if (shape instanceof Flatten.Line || shape instanceof Flatten.Ray) {
+                return false
+            }
+
+            if (shape instanceof Flatten.Multiline) {
+                return shape.toShapes().every(shape => this.contains(shape))
+            }
+
+            if (shape instanceof Flatten.Polygon) {
+                return this.contains(shape.box)
+            }
+        }
+
         get name() {
             return "box"
         }

diff --git a/docs/Arc.html b/docs/Arc.html
diff --git a/docs/Box.html b/docs/Box.html
diff --git a/docs/Circle.html b/docs/Circle.html
diff --git a/docs/CircularLinkedList.html b/docs/CircularLinkedList.html
diff --git a/docs/DE9IM.html b/docs/DE9IM.html
diff --git a/docs/Edge.html b/docs/Edge.html
diff --git a/docs/Errors.html b/docs/Errors.html
diff --git a/docs/Face.html b/docs/Face.html
diff --git a/docs/Inversion.html b/docs/Inversion.html
diff --git a/docs/Line.html b/docs/Line.html
diff --git a/docs/LinkedList.html b/docs/LinkedList.html
diff --git a/docs/Matrix.html b/docs/Matrix.html
diff --git a/docs/Multiline.html b/docs/Multiline.html
diff --git a/docs/PlanarSet.html b/docs/PlanarSet.html
diff --git a/docs/Point.html b/docs/Point.html
diff --git a/docs/Polygon.html b/docs/Polygon.html
diff --git a/docs/Ray.html b/docs/Ray.html
diff --git a/docs/Segment.html b/docs/Segment.html
diff --git a/docs/Shape.html b/docs/Shape.html
diff --git a/docs/Vector.html b/docs/Vector.html
diff --git a/docs/algorithms_boolean_op.js.html b/docs/algorithms_boolean_op.js.html
diff --git a/docs/algorithms_distance.js.html b/docs/algorithms_distance.js.html
diff --git a/docs/algorithms_ray_shooting.js.html b/docs/algorithms_ray_shooting.js.html
diff --git a/docs/algorithms_relation.js.html b/docs/algorithms_relation.js.html
diff --git a/docs/classes_arc.js.html b/docs/classes_arc.js.html
diff --git a/docs/classes_box.js.html b/docs/classes_box.js.html
diff --git a/docs/classes_circle.js.html b/docs/classes_circle.js.html
diff --git a/docs/classes_edge.js.html b/docs/classes_edge.js.html
diff --git a/docs/classes_face.js.html b/docs/classes_face.js.html
diff --git a/docs/classes_inversion.js.html b/docs/classes_inversion.js.html
diff --git a/docs/classes_line.js.html b/docs/classes_line.js.html
diff --git a/docs/classes_matrix.js.html b/docs/classes_matrix.js.html
diff --git a/docs/classes_multiline.js.html b/docs/classes_multiline.js.html
diff --git a/docs/classes_point.js.html b/docs/classes_point.js.html
diff --git a/docs/classes_polygon.js.html b/docs/classes_polygon.js.html
diff --git a/docs/classes_ray.js.html b/docs/classes_ray.js.html
diff --git a/docs/classes_segment.js.html b/docs/classes_segment.js.html
diff --git a/docs/classes_shape.js.html b/docs/classes_shape.js.html
diff --git a/docs/classes_vector.js.html b/docs/classes_vector.js.html
diff --git a/docs/data_structures_circular_linked_list.js.html b/docs/data_structures_circular_linked_list.js.html
diff --git a/docs/data_structures_de9im.js.html b/docs/data_structures_de9im.js.html
diff --git a/docs/data_structures_linked_list.js.html b/docs/data_structures_linked_list.js.html
diff --git a/docs/data_structures_planar_set.js.html b/docs/data_structures_planar_set.js.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-BooleanOperations.html b/docs/module-BooleanOperations.html
diff --git a/docs/module-RayShoot.html b/docs/module-RayShoot.html
diff --git a/docs/module-Relation.html b/docs/module-Relation.html
diff --git a/docs/utils_constants.js.html b/docs/utils_constants.js.html
diff --git a/docs/utils_errors.js.html b/docs/utils_errors.js.html
diff --git a/docs/utils_utils.js.html b/docs/utils_utils.js.html