@thi.ng/geom-clip-line 2.1.37 → 2.2.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-30T22:27:37Z
+- **Last updated**: 2022-12-16T12:52:25Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-clip-line@2.2.0) (2022-12-10)
+
+#### 🚀 Features
+
+- add clipPolylinePoly() ([445ccd6](https://github.com/thi-ng/umbrella/commit/445ccd6))
+
 ### [2.1.22](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom-clip-line@2.1.22) (2022-08-06)
 
 #### ⏱ Performance improvements

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![geom-clip-line](https://media.thi.ng/umbrella/banners-20220914/thing-geom-clip-line.svg?8ca4f323)
+# ![@thi.ng/geom-clip-line](https://media.thi.ng/umbrella/banners-20220914/thing-geom-clip-line.svg?8ca4f323)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/geom-clip-line.svg)](https://www.npmjs.com/package/@thi.ng/geom-clip-line)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/geom-clip-line.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -20,7 +20,7 @@ This project is part of the
 
 ## About
 
-2D line clipping (Liang-Barsky). This is a support package for [@thi.ng/geom](https://github.com/thi-ng/umbrella/tree/develop/packages/geom).
+2D line clipping (Liang-Barsky)
 
 Current implementation is based on [toxiclibs](http://toxiclibs.org)
 (Java) and Clojure version [thi.ng/geom-clj](http://thi.ng/geom-clj).
@@ -54,14 +54,11 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const geomClipLine = await import("@thi.ng/geom-clip-line");
+```js
+const geomClipLine = await import("@thi.ng/geom-clip-line");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 522 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 661 bytes
 
 ## Dependencies
 
@@ -99,7 +96,7 @@ liangBarsky2(
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -114,4 +111,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2013 - 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2013 - 2022 Karsten Schmidt // Apache License 2.0

package/clip-poly.d.ts

@@ -6,8 +6,16 @@ import type { ReadonlyVec, Vec } from "@thi.ng/vectors";
  *
  * @param a -
  * @param b -
- * @param pts -
+ * @param poly -
  */
-export declare const clipLinePoly: (a: ReadonlyVec, b: ReadonlyVec, pts: ReadonlyVec[]) => Vec[][] | undefined;
-export declare const clipLineSegmentPoly: (a: ReadonlyVec, b: ReadonlyVec, pts: ReadonlyVec[]) => Vec[][] | undefined;
+export declare const clipLinePoly: (a: ReadonlyVec, b: ReadonlyVec, poly: ReadonlyVec[]) => Vec[][] | undefined;
+export declare const clipLineSegmentPoly: (a: ReadonlyVec, b: ReadonlyVec, poly: ReadonlyVec[]) => Vec[][] | undefined;
+/**
+ * Similar to {@link clipLineSegmentPoly}, but for polylines. Returns array of
+ * new vertex chunks where the given polyline is inside the given bounding poly.
+ *
+ * @param pts
+ * @param poly
+ */
+export declare const clipPolylinePoly: (pts: ReadonlyVec[], poly: ReadonlyVec[]) => ReadonlyVec[][];
 //# sourceMappingURL=clip-poly.d.ts.map

package/clip-poly.js

@@ -9,16 +9,16 @@ import { direction2 } from "@thi.ng/vectors/direction";
  *
  * @param a -
  * @param b -
- * @param pts -
+ * @param poly -
  */
-export const clipLinePoly = (a, b, pts) => {
-    const isecs = intersectRayPolylineAll(a, direction2([], a, b), pts, true).isec;
+export const clipLinePoly = (a, b, poly) => {
+    const isecs = intersectRayPolylineAll(a, direction2([], a, b), poly, true).isec;
     return isecs ? collectSegments(isecs) : undefined;
 };
-export const clipLineSegmentPoly = (a, b, pts) => {
-    const isecs = intersectLinePolylineAll(a, b, pts, true).isec;
-    const isAInside = pointInPolygon2(a, pts);
-    const isBInside = pointInPolygon2(b, pts);
+export const clipLineSegmentPoly = (a, b, poly) => {
+    const isecs = intersectLinePolylineAll(a, b, poly, true).isec;
+    const isAInside = pointInPolygon2(a, poly);
+    const isBInside = pointInPolygon2(b, poly);
     if (!isecs) {
         return isAInside && isBInside ? [[a, b]] : undefined;
     }
@@ -26,6 +26,50 @@ export const clipLineSegmentPoly = (a, b, pts) => {
     isBInside && isecs.push(b);
     return collectSegments(isecs);
 };
+/**
+ * Similar to {@link clipLineSegmentPoly}, but for polylines. Returns array of
+ * new vertex chunks where the given polyline is inside the given bounding poly.
+ *
+ * @param pts
+ * @param poly
+ */
+export const clipPolylinePoly = (pts, poly) => {
+    let res = [];
+    if (pts.length < 2)
+        return res;
+    let isAInside = pointInPolygon2(pts[0], poly);
+    for (let i = 0, n = pts.length - 1; i < n; i++) {
+        const a = pts[i];
+        const b = pts[i + 1];
+        const isBInside = pointInPolygon2(b, poly);
+        const isecs = intersectLinePolylineAll(a, b, poly, true).isec;
+        if (!isecs) {
+            if (isAInside && isBInside) {
+                if (res.length)
+                    res[res.length - 1].push(b);
+                else
+                    res.push([a, b]);
+            }
+        }
+        else {
+            isAInside && isecs.unshift(a);
+            isBInside && isecs.push(b);
+            const [first, ...segments] = collectSegments(isecs);
+            if (isAInside) {
+                if (res.length)
+                    res[res.length - 1].push(first[1]);
+                else
+                    res.push(first);
+            }
+            else {
+                res.push(first);
+            }
+            res.push(...segments);
+        }
+        isAInside = isBInside;
+    }
+    return res;
+};
 const collectSegments = (isecs) => {
     const segments = [];
     for (let i = 0, n = isecs.length - 1; i < n; i += 2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom-clip-line",
-  "version": "2.1.37",
+  "version": "2.2.1",
   "description": "2D line clipping (Liang-Barsky)",
   "type": "module",
   "module": "./index.js",
@@ -21,7 +21,7 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,17 +34,17 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/geom-isec": "^2.1.37",
-    "@thi.ng/vectors": "^7.5.26"
+    "@thi.ng/api": "^8.6.0",
+    "@thi.ng/geom-isec": "^2.1.38",
+    "@thi.ng/vectors": "^7.5.27"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "2d",
@@ -84,5 +84,5 @@
     ],
     "year": 2013
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "f445a9cc8022bcdebbf6ff91fd66ced016d72f01\n"
 }