@immugio/three-math-extensions 0.2.20 → 0.2.22

package/types/Line2D.d.ts

@@ -3,6 +3,7 @@ import { Vector2 } from "three";
 import { Vec2 } from "./Vec2";
 import { Line3D } from "./Line3D";
 export declare class Line2D {
+    #private;
     start: Vec2;
     end: Vec2;
     index: number;
@@ -55,6 +56,18 @@ export declare class Line2D {
      * Endpoints are not cloned.
      */
     get endpoints(): Vec2[];
+    /**
+     * Check that this line segment contains provided point.
+     * @param p
+     * @param tolerance
+     */
+    containsPoint(p: Vector2, tolerance?: number): boolean;
+    /**
+     * Distance from this line to the provided point.
+     * @param param
+     * @param clampToLine
+     */
+    distanceToPoint(p: Vector2, clampToLine?: boolean): number;
     /**
      * Returns the direction of this line.
      */
@@ -117,7 +130,7 @@ export declare class Line2D {
     /**
      * Returns true if there is any overlap between this line and the @other line section.
      */
-    overlaps(other: Line2D): boolean;
+    overlaps(other: Line2D, distanceTolerance?: number, parallelTolerance?: number): boolean;
     /**
      * Logical AND of this and the other line section.
      * @param other
@@ -139,6 +152,12 @@ export declare class Line2D {
      * @param lines
      */
     static joinLines(lines: Line2D[]): Line2D[];
+    /**
+     * Checks if the current line covers another line.
+     * A line is considered to cover another line if they are parallel and both the start and end points of the other line are contained within the current line.
+     * Both distance and angle tolerance can be provided.
+     */
+    covers(other: Line2D, tolerance?: number, parallelTolerance?: number): boolean;
     /**
      * Returns a new line that is the projection of this line onto @other. Uses `closestPointToPoint` to find the projection.
      * @param other
@@ -241,7 +260,7 @@ export declare class Line2D {
      * @returns A new Line3D instance.
      */
     in3DSpace(y?: number): Line3D;
-    equals(other: Line2D): boolean;
+    equals(other: Line2D, tolerance?: number): boolean;
     /**
      * Deep clone of this line
      */

package/types/Line3D.d.ts

@@ -94,7 +94,7 @@ export declare class Line3D extends Line3 {
      */
     containsPoint(p: Vector3, tolerance?: number): boolean;
     /**
-     * Distance from this line to provided point.
+     * Distance from this line to the provided point.
      * @param p
      * @param clampToLine
      */

package/docs/README.md

@@ -1,90 +0,0 @@
-@immugio/three-math-extensions / [Exports](modules.md)
-
-# Set of utilities for 2d and 3d 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)
-
-[@immugio/three-math-extensions](README.md) / Exports
-
-# @immugio/three-math-extensions
-
-## Table of contents
-
-### Classes
-
-- [BoundingBox](docs/classes/BoundingBox.md)
-- [Line2D](docs/classes/Line2D.md)
-- [Line3D](docs/classes/Line3D.md)
-- [Polygon](docs/classes/Polygon.md)
-- [Rectangle](docs/classes/Rectangle.md)
-- [Size2](docs/classes/Size2.md)
-- [Vec2](docs/classes/Vec2.md)
-- [Vec3](docs/classes/Vec3.md)
-
-### Interfaces
-
-- [Point2](docs/interfaces/Point2.md)
-- [Point3](docs/interfaces/Point3.md)
-
-### Variables
-
-- [TwoPI](docs/modules.md#twopi)
-
-### Functions
-
-- [normalizeAngleDegrees](docs/modules.md#normalizeangledegrees)
-- [normalizeAngleRadians](docs/modules.md#normalizeangleradians)
-
-## Variables
-
-### TwoPI
-
-• `Const` **TwoPI**: `number`
-
-#### Defined in
-
-[src/MathConstants.ts:1](https://github.com/Immugio/three-math-extensions/blob/151f214/src/MathConstants.ts#L1)
-
-## Functions
-
-### normalizeAngleDegrees
-
-▸ **normalizeAngleDegrees**(`angle`): `number`
-
-Normalizes an angle in degrees to the range [0, 360].
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `angle` | `number` | in degrees |
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/normalizeAngleDegrees.ts:5](https://github.com/Immugio/three-math-extensions/blob/151f214/src/normalizeAngleDegrees.ts#L5)
-
-___
-
-### normalizeAngleRadians
-
-▸ **normalizeAngleRadians**(`angle`): `number`
-
-Normalize an angle in radians to the range of 0 to 2π.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `angle` | `number` | in radians |
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/normalizeAngleRadians.ts:7](https://github.com/Immugio/three-math-extensions/blob/151f214/src/normalizeAngleRadians.ts#L7)