@immugio/three-math-extensions 0.0.2 → 0.0.4

package/.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to NPM
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Building
+        run: npm run build
+
+      - name: Publish to NPM
+        run: |
+          npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+      - name: Package lib
+        run: npm pack
+
+      - name: Release
+        uses: docker://antonyurchenko/git-release:v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ALLOW_EMPTY_CHANGELOG: "false"
+          ALLOW_TAG_PREFIX: "true"
+        with:
+          args: |
+            three-math-extensions-*.tgz

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+## 0.0.4 - 2022-11-21
+
+### Commits
+
+- Automatic publish with change log [`a70c99d`](https://github.com/Immugio/three-math-extensions/commit/a70c99d0d42e60411ce01bcdb8dd4f3f489bb949)
+- Switch to npm [`ed47a17`](https://github.com/Immugio/three-math-extensions/commit/ed47a1787522db3bde5a2112bfd02480fe2edc54)
+- Initial commit [`3d1bf9e`](https://github.com/Immugio/three-math-extensions/commit/3d1bf9ef015570830007c9be99140c8c8d760d7f)
+- Add Line2D [`9a1dd0f`](https://github.com/Immugio/three-math-extensions/commit/9a1dd0f58352b7b25828693c688aa4770e95c174)
+- Readme, npm info [`dda4a28`](https://github.com/Immugio/three-math-extensions/commit/dda4a282a71a00308dcae858ffe53d67d4185be8)
+- Run tests in CI on commit [`e3f77ca`](https://github.com/Immugio/three-math-extensions/commit/e3f77ca76e25f4d99eef0130e5779b5e7c5aec6b)
+- Remove babel.config.js [`c9a1e16`](https://github.com/Immugio/three-math-extensions/commit/c9a1e1607cffec8a3d74adcca644320a79ca4c43)
+- Initial changelog [`6c98aa6`](https://github.com/Immugio/three-math-extensions/commit/6c98aa6ad631cf5e73d32dd76276f99b3ba5089f)
+- Release 0.0.4 [`bdac840`](https://github.com/Immugio/three-math-extensions/commit/bdac840f33261a3f39ef33bc05c80772169cfe87)
+- Add test badge [`37c62e8`](https://github.com/Immugio/three-math-extensions/commit/37c62e809bdcdfc63f7fe135469fd131f190f950)
+- Edit publish script condition [`dc77d89`](https://github.com/Immugio/three-math-extensions/commit/dc77d8978d87daab8732d6429ad1b01ba0ca6f97)
+- CI to use node version 16 [`dc42650`](https://github.com/Immugio/three-math-extensions/commit/dc426508939de922cc0316b7652bbd09aeed4610)
+- Action rename [`26a1f01`](https://github.com/Immugio/three-math-extensions/commit/26a1f014827faab2c02d30ca8ed18dac8f9ff8af)
+- Release 0.0.4 - tag pattern 4 [`ab9ad4e`](https://github.com/Immugio/three-math-extensions/commit/ab9ad4e49477a991482ed6d4d3a3ca4687a70b44)
+- Release 0.0.4 - tag pattern 3 [`d7d4c8f`](https://github.com/Immugio/three-math-extensions/commit/d7d4c8f546e6550868ddd06a5213fdec6c68bcd2)
+- Release 0.0.4 - tag pattern 2 [`0dcf801`](https://github.com/Immugio/three-math-extensions/commit/0dcf80190bd67a3ca93d45131a403201ab39e00f)
+- Release 0.0.4 - tag pattern [`e7f2f76`](https://github.com/Immugio/three-math-extensions/commit/e7f2f76aa247e1c51f0522c300a7aaf07253039c)
+- Release 0.0.5 [`c80d6bd`](https://github.com/Immugio/three-math-extensions/commit/c80d6bd12c25ddad0f67610cdf5c804d5759f084)
+- Status badge update [`370843e`](https://github.com/Immugio/three-math-extensions/commit/370843ed0a28b024761555572b7d51ccbdb4b77d)
+- Run tests in CI on commit [`aee8c55`](https://github.com/Immugio/three-math-extensions/commit/aee8c556ae1cab9025dbe0984dd17278fe6275a1)
+- Add Line2D to index [`a5fb6bd`](https://github.com/Immugio/three-math-extensions/commit/a5fb6bdeee5d9f07f325bfffc31ef96f0ce167d1)

package/README.md

@@ -1 +1,3 @@
-Set of utilities for 2d and 3d line math built on top of three.js
+# Set of utilities for 2d and 3d line math built on top of three.js
+
+[![Build](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml/badge.svg)](https://github.com/Immugio/three-math-extensions/actions/workflows/build.yml)

package/cjs/Line2D.js

@@ -18,14 +18,23 @@ class Line2D {
     static fromPoints(p1, p2, index = 0) {
         return new Line2D(new Vec2_1.Vec2(p1.x, p1.y), new Vec2_1.Vec2(p2.x, p2.y), index);
     }
-    static fromPolygon(polygon) {
-        if (polygon[0].x === polygon[polygon.length - 1].x && polygon[0].y === polygon[polygon.length - 1].y) {
-            polygon = polygon.slice(0, polygon.length - 1);
+    /**
+     * Creates a polygon formed by an array of lines from points provided.
+     * The polygon will only be closed if either
+     * 1) the first and last points are the same or 2) `forceClosedPolygon` is true.
+     */
+    static fromPolygon(polygon, forceClosedPolygon = false) {
+        if (!polygon || polygon.length < 2) {
+            return [];
         }
-        return polygon.map((p, i) => {
-            const next = polygon[(i + 1) % polygon.length];
-            return Line2D.fromPoints(p, next, i);
-        });
+        if (forceClosedPolygon && (polygon[0].x !== polygon.at(-1).x || polygon[0].y !== polygon.at(-1).y)) {
+            polygon = [...polygon, polygon[0]];
+        }
+        const lines = [];
+        for (let i = 0; i < polygon.length - 1; i++) {
+            lines.push(Line2D.fromPoints(polygon[i], polygon[i + 1], i));
+        }
+        return lines;
     }
     static fromLength(length) {
         return Line2D.fromCoordinates(-length / 2, 0, length / 2, 0);
@@ -101,6 +110,14 @@ class Line2D {
     get length() {
         return this.start.distanceTo(this.end);
     }
+    /**
+     * Set the length of this line. Center and direction remain unchanged.
+     * @param length
+     */
+    setLength(length) {
+        this.length = length;
+        return this;
+    }
     /**
      * Returns the start and end points of the line as an array.
      * Endpoints are not cloned.

package/cjs/Line3D.js

@@ -5,13 +5,32 @@ const three_1 = require("three");
 const Vec3_1 = require("./Vec3");
 const Line2D_1 = require("./Line2D");
 class Line3D extends three_1.Line3 {
-    #target = new Vec3_1.Vec3();
+    #target;
     constructor(start, end) {
         super(start, end);
+        this.#target = new Vec3_1.Vec3();
     }
     static fromPoints(start, end) {
         return new Line3D(new Vec3_1.Vec3(start.x, start.y, start.z), new Vec3_1.Vec3(end.x, end.y, end.z));
     }
+    /**
+     * Creates a polygon formed by an array of lines from points provided.
+     * The polygon will only be closed if either
+     * 1) the first and last points are the same or 2) `forceClosedPolygon` is true.
+     */
+    static fromPolygon(polygon, forceClosedPolygon = false) {
+        if (!polygon || polygon.length < 2) {
+            return [];
+        }
+        if (forceClosedPolygon && (polygon[0].x !== polygon.at(-1).x || polygon[0].y !== polygon.at(-1).y || polygon[0].z !== polygon.at(-1).z)) {
+            polygon = [...polygon, polygon[0]];
+        }
+        const lines = [];
+        for (let i = 0; i < polygon.length - 1; i++) {
+            lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1]));
+        }
+        return lines;
+    }
     /**
      * Returns lines that are the result of clipping this line by the @other line.
      * Clips must be parallel to this line.

package/cjs/Vec2.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Vec2 = void 0;
 const three_1 = require("three");
+const Vec3_1 = require("./Vec3");
 class Vec2 extends three_1.Vector2 {
     static fromPoint(point) {
         return new Vec2(point.x, point.y);
@@ -15,5 +16,8 @@ class Vec2 extends three_1.Vector2 {
         }
         return this;
     }
+    in3DSpace(z = 0) {
+        return new Vec3_1.Vec3(this.x, z, this.y);
+    }
 }
 exports.Vec2 = Vec2;

package/package.json

@@ -1,29 +1,46 @@
 {
   "name": "@immugio/three-math-extensions",
-  "version": "0.0.2",
-  "description": "Set of utilities for 2d and 3d line math built on top of threejs",
-  "author": "Jan Mikeska",
+  "version": "0.0.4",
+  "description": "Set of utilities for 2d and 3d line math built on top of three.js",
+  "author": "Jan Mikeska <janmikeska@gmail.com>",
   "license": "ISC",
+  "keywords": [
+    "threejs",
+    "three",
+    "math"
+  ],
+  "bugs": {
+    "url": "https://github.com/Immugio/three-math-extensions/issues"
+  },
+  "homepage": "https://github.com/Immugio/three-math-extensions#readme",
   "sideEffects": false,
   "source": "src/index.ts",
   "main": "cjs/index.js",
   "module": "esm/index.js",
   "types": "types/index.d.ts",
+  "auto-changelog": {
+    "commitLimit": false,
+    "template": "keepachangelog"
+  },
   "scripts": {
     "test": "npx jest",
     "build:esm": "tsc",
     "build:cjs": "tsc -p tsconfig-cjs.json",
     "clean": "rimraf types cjs esm",
-    "build": "npm run clean && npm run build:esm && npm run build:cjs"
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "preversion": "npm run clean && npm run build && npm run test",
+    "version": "auto-changelog -p && git add CHANGELOG.md",
+    "postversion": "git push && git push --tags"
   },
   "devDependencies": {
     "@types/jest": "^29.2.1",
-    "@types/three": "0.130.1",
     "@types/offscreencanvas": "2019.7.0",
+    "@types/three": "0.130.1",
+    "auto-changelog": "^2.4.0",
     "jest": "^29.2.2",
+    "rimraf": "^3.0.2",
     "ts-jest": "^29.0.0",
-    "typescript": "4.7.4",
-    "rimraf": "^3.0.2"
+    "typescript": "4.7.4"
   },
   "peerDependencies": {
     "three": "^0.130.1"
@@ -31,14 +48,5 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Immugio/three-math-extensions.git"
-  },
-  "keywords": [
-    "threejs",
-    "three",
-    "math"
-  ],
-  "bugs": {
-    "url": "https://github.com/Immugio/three-math-extensions/issues"
-  },
-  "homepage": "https://github.com/Immugio/three-math-extensions#readme"
+  }
 }

package/src/Line2D.ts

@@ -15,15 +15,26 @@ export class Line2D {
         return new Line2D(new Vec2(p1.x, p1.y), new Vec2(p2.x, p2.y), index);
     }
 
-    public static fromPolygon(polygon: Point2[]): Line2D[] {
-        if (polygon[0].x === polygon[polygon.length - 1].x && polygon[0].y === polygon[polygon.length - 1].y) {
-            polygon = polygon.slice(0, polygon.length - 1);
+    /**
+     * Creates a polygon formed by an array of lines from points provided.
+     * The polygon will only be closed if either
+     * 1) the first and last points are the same or 2) `forceClosedPolygon` is true.
+     */
+    public static fromPolygon(polygon: Point2[], forceClosedPolygon: boolean = false): Line2D[] {
+        if (!polygon || polygon.length < 2) {
+            return [];
         }
 
-        return polygon.map((p, i) => {
-            const next = polygon[(i + 1) % polygon.length];
-            return Line2D.fromPoints(p, next, i);
-        });
+        if (forceClosedPolygon && (polygon[0].x !== polygon.at(-1).x || polygon[0].y !== polygon.at(-1).y)) {
+            polygon = [...polygon, polygon[0]];
+        }
+
+        const lines: Line2D[] = [];
+        for (let i = 0; i < polygon.length - 1; i++) {
+            lines.push(Line2D.fromPoints(polygon[i], polygon[i + 1], i));
+        }
+
+        return lines;
     }
 
     public static fromLength(length: number): Line2D {
@@ -113,6 +124,15 @@ export class Line2D {
         return this.start.distanceTo(this.end);
     }
 
+    /**
+     * Set the length of this line. Center and direction remain unchanged.
+     * @param length
+     */
+    public setLength(length: number): this {
+        this.length = length;
+        return this;
+    }
+
     /**
      * Returns the start and end points of the line as an array.
      * Endpoints are not cloned.

package/src/Line3D.ts

@@ -8,16 +8,39 @@ export class Line3D extends Line3 {
     public declare start: Vec3;
     public declare end: Vec3;
 
-    #target = new Vec3();
+    readonly #target: Vec3;
 
     constructor(start: Vec3, end: Vec3) {
         super(start, end);
+        this.#target = new Vec3();
     }
 
     public static fromPoints(start: Point3, end: Point3): Line3D {
         return new Line3D(new Vec3(start.x, start.y, start.z), new Vec3(end.x, end.y, end.z));
     }
 
+    /**
+     * Creates a polygon formed by an array of lines from points provided.
+     * The polygon will only be closed if either
+     * 1) the first and last points are the same or 2) `forceClosedPolygon` is true.
+     */
+    public static fromPolygon(polygon: Point3[], forceClosedPolygon: boolean = false): Line3D[] {
+        if (!polygon || polygon.length < 2) {
+            return [];
+        }
+
+        if (forceClosedPolygon && (polygon[0].x !== polygon.at(-1).x || polygon[0].y !== polygon.at(-1).y || polygon[0].z !== polygon.at(-1).z)) {
+            polygon = [...polygon, polygon[0]];
+        }
+
+        const lines: Line3D[] = [];
+        for (let i = 0; i < polygon.length - 1; i++) {
+            lines.push(Line3D.fromPoints(polygon[i], polygon[i + 1]));
+        }
+
+        return lines;
+    }
+
     /**
      * Returns lines that are the result of clipping this line by the @other line.
      * Clips must be parallel to this line.

package/src/Vec2.ts

@@ -1,8 +1,10 @@
 import { Vector2 } from "three";
+import { Vec3 } from "./Vec3";
+import { Point2 } from "./Point2";
 
 export class Vec2 extends Vector2 {
 
-    public static fromPoint(point: { x: number, y: number }): Vec2 {
+    public static fromPoint(point: Point2): Vec2 {
         return new Vec2(point.x, point.y);
     }
 
@@ -15,4 +17,8 @@ export class Vec2 extends Vector2 {
         }
         return this;
     }
+
+    public in3DSpace(z: number = 0): Vec3 {
+        return new Vec3(this.x, z, this.y);
+    }
 }

package/src/__tests__/Line2D.spec.ts

@@ -3,7 +3,7 @@ import { Vector2 } from "three";
 import { Vec2 } from "../Vec2";
 import { Point2 } from "../Point2";
 
-describe("Line", () => {
+describe("Line2D", () => {
     it("should be created", () => {
         const start = new Vec2(1, 2);
         const end = new Vec2(3, 4);
@@ -27,6 +27,35 @@ describe("Line", () => {
         expect(line).toEqual(new Line2D(new Vec2(1, 2), new Vec2(3, 4), 10));
     });
 
+    it("should create a single line polygon from a 2 points polygon", () => {
+        const start = new Vec2(1, 2);
+        const end = new Vec2(3, 4);
+        const lines = Line2D.fromPolygon([start, end]);
+        expect(lines.length).toEqual(1);
+        expect(lines[0]).toEqual(new Line2D(start, end));
+    });
+
+    it("should create a 2 lines polygon from a 3 points polygon", () => {
+        const p1 = new Vec2(1, 2);
+        const p2 = new Vec2(3, 4);
+        const p3 = new Vec2(5, 2);
+        const lines = Line2D.fromPolygon([p1, p2, p3]);
+        expect(lines.length).toEqual(2);
+        expect(lines[0]).toEqual(new Line2D(p1, p2, 0));
+        expect(lines[1]).toEqual(new Line2D(p2, p3, 1));
+    });
+
+    it("should create a closed 3 lines polygon from a 3 points polygon", () => {
+        const p1 = new Vec2(1, 2);
+        const p2 = new Vec2(3, 4);
+        const p3 = new Vec2(5, 2);
+        const lines = Line2D.fromPolygon([p1, p2, p3], true);
+        expect(lines.length).toEqual(3);
+        expect(lines[0]).toEqual(new Line2D(p1, p2, 0));
+        expect(lines[1]).toEqual(new Line2D(p2, p3, 1));
+        expect(lines[2]).toEqual(new Line2D(p3, p1, 2));
+    });
+
     test("center should return the center of the line", () => {
         const line = Line2D.fromCoordinates(-2, -2, 2, 2);
         expect(line.center.x).toEqual(0);

package/src/__tests__/Line3D.spec.ts

@@ -10,6 +10,35 @@ describe("Line3d", () => {
         expect(line.end).toEqual(new Vec3(4, 5, 6));
     });
 
+    it("should create a single line polygon from a 2 points polygon", () => {
+        const start = new Vec3(1, 2, 20);
+        const end = new Vec3(3, 4, 20);
+        const lines = Line3D.fromPolygon([start, end]);
+        expect(lines.length).toEqual(1);
+        expect(lines[0]).toEqual(new Line3D(start, end));
+    });
+
+    it("should create a 2 lines polygon from a 3 points polygon", () => {
+        const p1 = new Vec3(1, 2, 20);
+        const p2 = new Vec3(3, 4, 20);
+        const p3 = new Vec3(5, 2, 20);
+        const lines = Line3D.fromPolygon([p1, p2, p3]);
+        expect(lines.length).toEqual(2);
+        expect(lines[0]).toEqual(new Line3D(p1, p2));
+        expect(lines[1]).toEqual(new Line3D(p2, p3));
+    });
+
+    it("should create a closed 3 lines polygon from a 3 points polygon", () => {
+        const p1 = new Vec3(1, 2, 20);
+        const p2 = new Vec3(3, 4, 20);
+        const p3 = new Vec3(5, 2, 20);
+        const lines = Line3D.fromPolygon([p1, p2, p3], true);
+        expect(lines.length).toEqual(3);
+        expect(lines[0]).toEqual(new Line3D(p1, p2));
+        expect(lines[1]).toEqual(new Line3D(p2, p3));
+        expect(lines[2]).toEqual(new Line3D(p3, p1));
+    });
+
     it("should return the expected center", () => {
         const line = defaultLine();
         expect(line.center).toEqual(new Vec3(0, 0, 0));