@immugio/three-math-extensions 0.0.11 → 0.0.13

package/types/Line2D.d.ts

@@ -1,222 +1,222 @@
-import { Point2 } from "./Point2";
-import { Vector2 } from "three";
-import { Vec2 } from "./Vec2";
-export declare class Line2D {
-    start: Vec2;
-    end: Vec2;
-    index: number;
-    constructor(start: Vec2, end: Vec2, index?: number);
-    static fromCoordinates(x1: number, y1: number, x2: number, y2: number, index?: number): Line2D;
-    static fromPoints(p1: Point2, p2: Point2, index?: number): Line2D;
-    /**
-     * 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: Point2[], forceClosedPolygon?: boolean): Line2D[];
-    static fromLength(length: number): Line2D;
-    get center(): Vec2;
-    /**
-     * Set the center of the line to the provided point. Length and direction remain unchanged.
-     * Modifies this line.
-     * @param value
-     */
-    set center(value: Point2);
-    /**
-     * Set the center of the line to the provided point. Length and direction remain unchanged.
-     * Modifies this line.
-     * @param value
-     */
-    setCenter(value: Point2): Line2D;
-    resize(amount: number): Line2D;
-    moveStartPoint(amount: number): Line2D;
-    /**
-     * Moves end point on the line by the given amount. Plus values move the point further away from the center.
-     * Modifies this line.
-     */
-    moveEndPoint(amount: number): Line2D;
-    private movePointOnThisLine;
-    /**
-     * Set the length of this line. Center and direction remain unchanged.
-     * Modifies this line.
-     * @param l
-     */
-    set length(l: number);
-    get length(): number;
-    /**
-     * Set the length of this line. Center and direction remain unchanged.
-     * @param length
-     */
-    setLength(length: number): this;
-    /**
-     * Returns the start and end points of the line as an array.
-     * Endpoints are not cloned.
-     */
-    get endpoints(): Vec2[];
-    /**
-     * Returns the direction of this line.
-     */
-    get direction(): Vec2;
-    /**
-     * Inverts the direction of the line.
-     * Modifies this line.
-     */
-    flip(): Line2D;
-    /**
-     * Rotates the line around the center by the given angle in radians.
-     * Modifies this line.
-     * @param radians Positive values rotate counter-clockwise.
-     * @param center
-     */
-    rotate(radians: number, center?: Vec2): Line2D;
-    /**
-     * Move the line by the given vector.
-     * Modifies this line.
-     */
-    translate(value: Point2): Line2D;
-    /**
-     * Move the line to its left by the given amount.
-     * Modifies this line.
-     */
-    translateLeft(amount: number): Line2D;
-    /**
-     * Move the line to its right by the given amount.
-     * Modifies this line.
-     */
-    translateRight(amount: number): Line2D;
-    /**
-     * Returns true when the point is actually inside the (finite) line segment.
-     * https://jsfiddle.net/c06zdxtL/2/
-     * https://stackoverflow.com/questions/6865832/detecting-if-a-point-is-of-a-line-segment/6877674
-     * @param point: Point2
-     */
-    isPointOnLineSection(point: Point2): boolean;
-    /**
-     * Returns true when the point is beside the line **segment** and within the maxDistance.
-     * @param point
-     * @param maxDistance
-     */
-    isPointCloseToAndBesideLineSection(point: Point2, maxDistance: number): boolean;
-    /**
-     * Returns true when the point is beside the line **segment**
-     * @param point
-     */
-    isPointBesideLineSection(point: Point2): boolean;
-    /**
-     * Returns true when the point is on the **infinite** line.
-     * @param point
-     */
-    isPointOnInfiniteLine(point: Point2): boolean;
-    /**
-     * Returns true if other line is collinear and overlaps or at least touching this line.
-     * @param other
-     */
-    isCollinearWithTouchOrOverlap(other: Line2D): boolean;
-    /**
-     * Returns true if there is any overlap between this line and the @other line section.
-     */
-    overlaps(other: Line2D): boolean;
-    /**
-     * Logical AND of this and the other line section.
-     * @param other
-     */
-    getOverlap(other: Line2D): Line2D;
-    /**
-     * Joins a copy of @line with the @other line.
-     * Other must be parallel to this line.
-     * Returns null if there is no overlap
-     * Clones the line, does not modify.
-     * @param line
-     * @param other
-     */
-    static joinLine(line: Line2D, other: Line2D): Line2D;
-    /**
-     * Joins provided lines into several joined lines.
-     * Lines must be parallel for joining.
-     * Clone the lines, does not modify.
-     * @param lines
-     */
-    static joinLines(lines: Line2D[]): Line2D[];
-    /**
-     * Divides the Line3D into a number of segments of the given length.
-     * Clone the line, does not modify.
-     * @param maxSegmentLength number
-     */
-    chunk(maxSegmentLength: number): Line2D[];
-    /**
-     * Returns the closest point parameter on the **infinite** line to the given point.
-     * @param point
-     */
-    closestPointToPointParameterOnInfiniteLine(point: Vector2): number;
-    /**
-     * Returns the closest point on the **infinite** line to the given point.
-     * @param point
-     */
-    closestPointOnInfiniteLine(point: Vector2): Vec2;
-    /**
-     * Returns the closest point on the line **section** to the given point.
-     * @param point
-     */
-    closestPointOnLine(point: Vector2): Vec2;
-    /**
-     * Returns the distance between the **infinite** line and the point.
-     * @param point
-     */
-    distanceToPointOnInfiniteLine(point: Point2): number;
-    /**
-     * Returns lines that are the result of clipping @source line by the @clips.
-     * Clips must be parallel to this line.
-     * Clones the line, does not modify this.
-     * @param source
-     * @param clips
-     */
-    static clipLines(source: Line2D, clips: Line2D[]): Line2D[];
-    /**
-     * Returns the original line section split into two parts, if the line **sections** overlap, otherwise null
-     */
-    splitAtIntersection(other: Line2D, tolerance?: number): Line2D[];
-    /**
-     * If lines **sections** overlap, returns the original line section split into two parts, sorted by length
-     * Else, if the **infinite** lines intersect, returns a new line extended to the intersection point
-     * Otherwise, null if the lines are parallel and do not intersect
-     */
-    splitAtOrExtendToIntersection(other: Line2D): Line2D[];
-    private static order;
-    private static subtractSingle;
-    /**
-     * If other line is not contained within this line, the excess is trimmed.
-     * Does not create a copy. Provided line is modified.
-     * @param lineToTrim
-     */
-    trimExcess(lineToTrim: Line2D): void;
-    /**
-     * If other line is shorter than this, endpoints are moved to extend other
-     * Does not create a copy. Provided line is modified.
-     * @param lineToExtend
-     * @param tolerance
-     */
-    extendToEnds(lineToExtend: Line2D, tolerance: number): void;
-    /**
-     * If there is an intersection between this and other, this line is extended to the intersection point. Lines are assumed to be infinite.
-     * Modifies this line.
-     * @param other
-     * @param maxDistanceToIntersection
-     */
-    extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection?: number): Line2D;
-    /**
-     * Returns the intersection point of two lines. The lines are assumed to be infinite.
-     */
-    intersect(other: Line2D): Vec2;
-    /**
-     * Check that the infinite lines intersect and that they are in the specified angle to each other
-     * @param other Line
-     * @param expectedAngleInRads number
-     */
-    hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number): Vec2;
-    /**
-     * Deep clone of this line
-     */
-    clone(): Line2D;
-    toString(): string;
-    equals(other: Line2D): boolean;
-}
+import { Point2 } from "./Point2";
+import { Vector2 } from "three";
+import { Vec2 } from "./Vec2";
+export declare class Line2D {
+    start: Vec2;
+    end: Vec2;
+    index: number;
+    constructor(start: Vec2, end: Vec2, index?: number);
+    static fromCoordinates(x1: number, y1: number, x2: number, y2: number, index?: number): Line2D;
+    static fromPoints(p1: Point2, p2: Point2, index?: number): Line2D;
+    /**
+     * 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: Point2[], forceClosedPolygon?: boolean): Line2D[];
+    static fromLength(length: number): Line2D;
+    get center(): Vec2;
+    /**
+     * Set the center of the line to the provided point. Length and direction remain unchanged.
+     * Modifies this line.
+     * @param value
+     */
+    set center(value: Point2);
+    /**
+     * Set the center of the line to the provided point. Length and direction remain unchanged.
+     * Modifies this line.
+     * @param value
+     */
+    setCenter(value: Point2): Line2D;
+    resize(amount: number): Line2D;
+    moveStartPoint(amount: number): Line2D;
+    /**
+     * Moves end point on the line by the given amount. Plus values move the point further away from the center.
+     * Modifies this line.
+     */
+    moveEndPoint(amount: number): Line2D;
+    private movePointOnThisLine;
+    /**
+     * Set the length of this line. Center and direction remain unchanged.
+     * Modifies this line.
+     * @param l
+     */
+    set length(l: number);
+    get length(): number;
+    /**
+     * Set the length of this line. Center and direction remain unchanged.
+     * @param length
+     */
+    setLength(length: number): this;
+    /**
+     * Returns the start and end points of the line as an array.
+     * Endpoints are not cloned.
+     */
+    get endpoints(): Vec2[];
+    /**
+     * Returns the direction of this line.
+     */
+    get direction(): Vec2;
+    /**
+     * Inverts the direction of the line.
+     * Modifies this line.
+     */
+    flip(): Line2D;
+    /**
+     * Rotates the line around the center by the given angle in radians.
+     * Modifies this line.
+     * @param radians Positive values rotate counter-clockwise.
+     * @param center
+     */
+    rotate(radians: number, center?: Vec2): Line2D;
+    /**
+     * Move the line by the given vector.
+     * Modifies this line.
+     */
+    translate(value: Point2): Line2D;
+    /**
+     * Move the line to its left by the given amount.
+     * Modifies this line.
+     */
+    translateLeft(amount: number): Line2D;
+    /**
+     * Move the line to its right by the given amount.
+     * Modifies this line.
+     */
+    translateRight(amount: number): Line2D;
+    /**
+     * Returns true when the point is actually inside the (finite) line segment.
+     * https://jsfiddle.net/c06zdxtL/2/
+     * https://stackoverflow.com/questions/6865832/detecting-if-a-point-is-of-a-line-segment/6877674
+     * @param point: Point2
+     */
+    isPointOnLineSection(point: Point2): boolean;
+    /**
+     * Returns true when the point is beside the line **segment** and within the maxDistance.
+     * @param point
+     * @param maxDistance
+     */
+    isPointCloseToAndBesideLineSection(point: Point2, maxDistance: number): boolean;
+    /**
+     * Returns true when the point is beside the line **segment**
+     * @param point
+     */
+    isPointBesideLineSection(point: Point2): boolean;
+    /**
+     * Returns true when the point is on the **infinite** line.
+     * @param point
+     */
+    isPointOnInfiniteLine(point: Point2): boolean;
+    /**
+     * Returns true if other line is collinear and overlaps or at least touching this line.
+     * @param other
+     */
+    isCollinearWithTouchOrOverlap(other: Line2D): boolean;
+    /**
+     * Returns true if there is any overlap between this line and the @other line section.
+     */
+    overlaps(other: Line2D): boolean;
+    /**
+     * Logical AND of this and the other line section.
+     * @param other
+     */
+    getOverlap(other: Line2D): Line2D;
+    /**
+     * Joins a copy of @line with the @other line.
+     * Other must be parallel to this line.
+     * Returns null if there is no overlap
+     * Clones the line, does not modify.
+     * @param line
+     * @param other
+     */
+    static joinLine(line: Line2D, other: Line2D): Line2D;
+    /**
+     * Joins provided lines into several joined lines.
+     * Lines must be parallel for joining.
+     * Clone the lines, does not modify.
+     * @param lines
+     */
+    static joinLines(lines: Line2D[]): Line2D[];
+    /**
+     * Divides the Line3D into a number of segments of the given length.
+     * Clone the line, does not modify.
+     * @param maxSegmentLength number
+     */
+    chunk(maxSegmentLength: number): Line2D[];
+    /**
+     * Returns the closest point parameter on the **infinite** line to the given point.
+     * @param point
+     */
+    closestPointToPointParameterOnInfiniteLine(point: Vector2): number;
+    /**
+     * Returns the closest point on the **infinite** line to the given point.
+     * @param point
+     */
+    closestPointOnInfiniteLine(point: Vector2): Vec2;
+    /**
+     * Returns the closest point on the line **section** to the given point.
+     * @param point
+     */
+    closestPointOnLine(point: Vector2): Vec2;
+    /**
+     * Returns the distance between the **infinite** line and the point.
+     * @param point
+     */
+    distanceToPointOnInfiniteLine(point: Point2): number;
+    /**
+     * Returns lines that are the result of clipping @source line by the @clips.
+     * Clips must be parallel to this line.
+     * Clones the line, does not modify this.
+     * @param source
+     * @param clips
+     */
+    static clipLines(source: Line2D, clips: Line2D[]): Line2D[];
+    /**
+     * Returns the original line section split into two parts, if the line **sections** overlap, otherwise null
+     */
+    splitAtIntersection(other: Line2D, tolerance?: number): Line2D[];
+    /**
+     * If lines **sections** overlap, returns the original line section split into two parts, sorted by length
+     * Else, if the **infinite** lines intersect, returns a new line extended to the intersection point
+     * Otherwise, null if the lines are parallel and do not intersect
+     */
+    splitAtOrExtendToIntersection(other: Line2D): Line2D[];
+    private static order;
+    private static subtractSingle;
+    /**
+     * If other line is not contained within this line, the excess is trimmed.
+     * Does not create a copy. Provided line is modified.
+     * @param lineToTrim
+     */
+    trimExcess(lineToTrim: Line2D): void;
+    /**
+     * If other line is shorter than this, endpoints are moved to extend other
+     * Does not create a copy. Provided line is modified.
+     * @param lineToExtend
+     * @param tolerance
+     */
+    extendToEnds(lineToExtend: Line2D, tolerance: number): void;
+    /**
+     * If there is an intersection between this and other, this line is extended to the intersection point. Lines are assumed to be infinite.
+     * Modifies this line.
+     * @param other
+     * @param maxDistanceToIntersection
+     */
+    extendToOrTrimAtIntersection(other: Line2D, maxDistanceToIntersection?: number): Line2D;
+    /**
+     * Returns the intersection point of two lines. The lines are assumed to be infinite.
+     */
+    intersect(other: Line2D): Vec2;
+    /**
+     * Check that the infinite lines intersect and that they are in the specified angle to each other
+     * @param other Line
+     * @param expectedAngleInRads number
+     */
+    hasIntersectionWithAngle(other: Line2D, expectedAngleInRads: number): Vec2;
+    /**
+     * Deep clone of this line
+     */
+    clone(): Line2D;
+    toString(): string;
+    equals(other: Line2D): boolean;
+}