plotboilerplate 1.27.1 → 1.28.0

package/src/_cjs/Polygon.d.ts

@@ -0,0 +1,520 @@
+/**
+ * @author   Ikaros Kappler
+ * @date     2018-04-14
+ * @modified 2018-11-17 Added the containsVert function.
+ * @modified 2018-12-04 Added the toSVGString function.
+ * @modified 2019-03-20 Added JSDoc tags.
+ * @modified 2019-10-25 Added the scale function.
+ * @modified 2019-11-06 JSDoc update.
+ * @modified 2019-11-07 Added toCubicBezierPath(number) function.
+ * @modified 2019-11-22 Added the rotate(number,Vertex) function.
+ * @modified 2020-03-24 Ported this class from vanilla-JS to Typescript.
+ * @modified 2020-10-30 Added the `addVertex` function.
+ * @modified 2020-10-31 Added the `getVertexAt` function.
+ * @modified 2020-11-06 Added the `move` function.
+ * @modified 2020-11-10 Added the `getBounds` function.
+ * @modified 2020-11-11 Generalized `move(Vertex)` to `move(XYCoords)`.
+ * @modified 2021-01-20 Added UID.
+ * @modified 2021-01-29 Added the `signedArea` function (was global function in the demos before).
+ * @modified 2021-01-29 Added the `isClockwise` function.
+ * @modified 2021-01-29 Added the `area` function.
+ * @modified 2021-01-29 Changed the param type for `containsVert` from Vertex to XYCoords.
+ * @modified 2021-12-14 Added the `perimeter()` function.
+ * @modified 2021-12-16 Added the `getEvenDistributionPolygon()` function.
+ * @modified 2022-02-02 Added the `destroy` method.
+ * @modified 2022-02-02 Cleared the `Polygon.toSVGString` function (deprecated). Use `drawutilssvg` instead.
+ * @modified 2022-03-08 Added the `Polygon.clone()` function.
+ * @modified 2023-09-25 Added the `Polygon.getInterpolationPolygon(number)` function.
+ * @modified 2023-09-25 Added the `Polygon.lineIntersections(Line,boolean)` function.
+ * @modified 2023-09-29 Added the `Polygon.closestLineIntersection(Line,boolean)` function.
+ * @modified 2023-11-24 Added the `Polygon.containsPolygon(Polygon)' function.
+ * @modified 2024-10-12 Added the `getEdgeAt` method.
+ * @modified 2024-10-30 Added the `getEdges` method.
+ * @modified 2024-12-02 Added the `elimitateColinearEdges` method.
+ * @modified 2025-02-12 Added the `containsVerts` method to test multiple vertices for containment.
+ * @modified 2025-03-28 Added the `Polygon.utils.locateLineIntersecion` static helper method.
+ * @modified 2025-03-28 Added the `Polygon.lineIntersectionTangents` method.
+ * @modified 2025-04-09 Added the `Polygon.getCentroid` method.
+ * @modified 2025-05-16 Class `Polygon` now implements `IBounded`.
+ * @modified 2025-05-20 Tweaking `Polygon.getInnerAngleAt` and `Polygo.isAngleAcute` to handle indices out of array bounds as well.
+ * @modified 2025-06-07 Adding `Polygon.closestLineIntersectionIndex` to determine line intersections plus detected edge index.
+ * @version 1.16.0
+ *
+ * @file Polygon
+ * @public
+ **/
+import { BezierPath } from "./BezierPath";
+import { Bounds } from "./Bounds";
+import { Line } from "./Line";
+import { Vector } from "./Vector";
+import { VertTuple } from "./VertTuple";
+import { Vertex } from "./Vertex";
+import { XYCoords, SVGSerializable, UID, Intersectable, IBounded, PolygonIntersectionTuple } from "./interfaces";
+/**
+ * @classdesc A polygon class. Any polygon consists of an array of vertices; polygons can be open or closed.
+ *
+ * @requires BezierPath
+ * @requires Bounds
+ * @requires SVGSerializabe
+ * @requires UID
+ * @requires UIDGenerator
+ * @requires Vertex
+ * @requires XYCoords
+ */
+export declare class Polygon implements IBounded, Intersectable, SVGSerializable {
+    /**
+     * Required to generate proper CSS classes and other class related IDs.
+     **/
+    readonly className: string;
+    /**
+     * The UID of this drawable object.
+     *
+     * @member {UID}
+     * @memberof Polygon
+     * @instance
+     * @readonly
+     */
+    readonly uid: UID;
+    /**
+     * @member {Array<Vertex>}
+     * @memberof Polygon
+     * @type {Array<Vertex>}
+     * @instance
+     */
+    vertices: Array<Vertex>;
+    /**
+     * @member {boolean}
+     * @memberof Polygon
+     * @type {boolean}
+     * @instance
+     */
+    isOpen: boolean;
+    /**
+     * @member isDestroyed
+     * @memberof Polygon
+     * @type {boolean}
+     * @instance
+     */
+    isDestroyed: boolean;
+    /**
+     * The constructor.
+     *
+     * @constructor
+     * @name Polygon
+     * @param {Vertex[]} vertices - An array of 2d vertices that shape the polygon.
+     * @param {boolean} isOpen - Indicates if the polygon should be rendered as an open or closed shape.
+     **/
+    constructor(vertices?: Array<Vertex>, isOpen?: boolean);
+    /**
+     * Add a vertex to the end of the `vertices` array.
+     *
+     * @method addVertex
+     * @param {Vertex} vert - The vertex to add.
+     * @instance
+     * @memberof Polygon
+     **/
+    addVertex(vert: Vertex): void;
+    /**
+     * Add a vertex at a particular position of the `vertices` array.
+     *
+     * @method addVertexAt
+     * @param {Vertex} vert - The vertex to add.
+     * @param {number} index - The position to add the vertex at. Will be handled modulo.
+     * @instance
+     * @memberof Polygon
+     **/
+    addVertexAt(vert: Vertex, index: number): void;
+    /**
+     * Get a new instance of the line at the given start index. The returned line will consist
+     * of the vertex at `vertIndex` and `vertIndex+1` (will be handled modulo).
+     *
+     * @method getEdgeAt
+     * @param {number} vertIndex - The vertex index of the line to start.
+     * @instance
+     * @memberof Polygon
+     * @return {Line}
+     **/
+    getEdgeAt(vertIndex: number): Line;
+    /**
+     * Converts this polygon into a sequence of lines. Please note that each time
+     * this method is called new lines are created. The underlying line vertices are no clones
+     * (instances).
+     *
+     * @method getEdges
+     * @instance
+     * @memberof Polygon
+     * @return {Array<Line>}
+     */
+    getEdges(): Array<Line>;
+    /**
+     * Checks if the angle at the given polygon vertex (index) is acute. Please not that this is
+     * only working for clockwise polygons. If this polygon is not clockwise please use the
+     * `isClockwise` method and reverse polygon vertices if needed.
+     *
+     * @method isAngleAcute
+     * @instance
+     * @memberof Polygon
+     * @param {number} vertIndex - The index of the polygon vertex to check.
+     * @returns {boolean} `true` is angle is acute, `false` is obtuse.
+     */
+    getInnerAngleAt(vertIndex: number): number;
+    /**
+     * Checks if the angle at the given polygon vertex (index) is acute.
+     *
+     * @method isAngleAcute
+     * @instance
+     * @memberof Polygon
+     * @param {number} vertIndex - The index of the polygon vertex to check.
+     * @returns {boolean} `true` is angle is acute, `false` is obtuse.
+     */
+    isAngleAcute(vertIndex: number): boolean;
+    /**
+     * Get the polygon vertex at the given position (index).
+     *
+     * The index may exceed the total vertex count, and will be wrapped around then (modulo).
+     *
+     * For k >= 0:
+     *  - getVertexAt( vertices.length )     == getVertexAt( 0 )
+     *  - getVertexAt( vertices.length + k ) == getVertexAt( k )
+     *  - getVertexAt( -k )                  == getVertexAt( vertices.length -k )
+     *
+     * @method getVertexAt
+     * @param {number} index - The index of the desired vertex.
+     * @instance
+     * @memberof Polygon
+     * @return {Vertex} At the given index.
+     **/
+    getVertexAt(index: number): Vertex;
+    /**
+     * Move the polygon's vertices by the given amount.
+     *
+     * @method move
+     * @param {XYCoords} amount - The amount to move.
+     * @instance
+     * @memberof Polygon
+     * @return {Polygon} this for chaining
+     **/
+    move(amount: XYCoords): Polygon;
+    /**
+     * Check if the given vertex is inside this polygon.<br>
+     * <br>
+     * Ray-casting algorithm found at<br>
+     *    https://stackoverflow.com/questions/22521982/check-if-point-inside-a-polygon
+     *
+     * @method containsVert
+     * @param {XYCoords} vert - The vertex to check.
+     * @return {boolean} True if the passed vertex is inside this polygon. The polygon is considered closed.
+     * @instance
+     * @memberof Polygon
+     **/
+    containsVert(vert: XYCoords): boolean;
+    /**
+     * Check if all given vertices are inside this polygon.<br>
+     * <br>
+     * This method just uses the `Polygon.containsVert` method.
+     *
+     * @method containsVerts
+     * @param {XYCoords[]} verts - The vertices to check.
+     * @return {boolean} True if all passed vertices are inside this polygon. The polygon is considered closed.
+     * @instance
+     * @memberof Polygon
+     **/
+    containsVerts(verts: XYCoords[]): boolean;
+    /**
+     * Check if the passed polygon is completly contained inside this polygon.
+     *
+     * This means:
+     *  - all polygon's vertices must be inside this polygon.
+     *  - the polygon has no edge intersections with this polygon.
+     *
+     * @param {Polygon} polygon - The polygon to check if contained.
+     * @return {boolean}
+     */
+    containsPolygon(polygon: Polygon): boolean;
+    /**
+     * Calculate the area of the given polygon (unsigned).
+     *
+     * Note that this does not work for self-intersecting polygons.
+     *
+     * @method area
+     * @instance
+     * @memberof Polygon
+     * @return {number}
+     */
+    area(): number;
+    /**
+     * Calulate the signed polyon area by interpreting the polygon as a matrix
+     * and calculating its determinant.
+     *
+     * @method signedArea
+     * @instance
+     * @memberof Polygon
+     * @return {number}
+     */
+    signedArea(): number;
+    /**
+     * Get the winding order of this polgon: clockwise or counterclockwise.
+     *
+     * @method isClockwise
+     * @instance
+     * @memberof Polygon
+     * @return {boolean}
+     */
+    isClockwise(): boolean;
+    /**
+     * Get the perimeter of this polygon.
+     * The perimeter is the absolute length of the outline.
+     *
+     * If this polygon is open then the last segment (connecting the first and the
+     * last vertex) will be skipped.
+     *
+     * @method perimeter
+     * @instance
+     * @memberof Polygon
+     * @return {number}
+     */
+    perimeter(): number;
+    /**
+     * Scale the polygon relative to the given center.
+     *
+     * @method scale
+     * @param {number} factor - The scale factor.
+     * @param {Vertex} center - The center of scaling.
+     * @return {Polygon} this, for chaining.
+     * @instance
+     * @memberof Polygon
+     **/
+    scale(factor: number, center: Vertex): Polygon;
+    /**
+     * Rotate the polygon around the given center.
+     *
+     * @method rotate
+     * @param {number} angle  - The rotation angle.
+     * @param {Vertex} center - The center of rotation.
+     * @instance
+     * @memberof Polygon
+     * @return {Polygon} this, for chaining.
+     **/
+    rotate(angle: number, center: Vertex): Polygon;
+    /**
+     * Get the mean `center` of this polygon by calculating the mean value of all vertices.
+     *
+     * Mean: (v[0] + v[1] + ... v[n-1]) / n
+     *
+     * @method getMeanCenter
+     * @instance
+     * @memberof Polygon
+     * @return {Vertex|null} `null` is no vertices are available.
+     */
+    getMeanCenter(): Vertex | null;
+    /**
+     * Get centroid.
+     * Centroids define the barycenter of any non self-intersecting convex polygon.
+     *
+     * If the polygon is self intersecting or non konvex then the barycenter is not well defined.
+     *
+     * https://mathworld.wolfram.com/PolygonCentroid.html
+     *
+     * @method getCentroid
+     * @instance
+     * @memberof Polygon
+     * @returns {Vertex|null}
+     */
+    getCentroid(): Vertex | null;
+    /**
+     * Get all line intersections with this polygon.
+     *
+     * This method returns all intersections (as vertices) with this shape. The returned array of vertices is in no specific order.
+     *
+     * See demo `47-closest-vector-projection-on-polygon` for how it works.
+     *
+     * @param {VertTuple} line - The line to find intersections with.
+     * @param {boolean} inVectorBoundsOnly - If set to true only intersecion points on the passed vector are returned (located strictly between start and end vertex).
+     * @returns {Array<Vertex>} - An array of all intersections within the polygon bounds.
+     */
+    lineIntersections(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Array<Vertex>;
+    /**
+     * Get all line intersections of this polygon and their tangents along the shape.
+     *
+     * This method returns all intersection tangents (as vectors) with this shape. The returned array of vectors is in no specific order.
+     *
+     * @param line
+     * @param inVectorBoundsOnly
+     * @returns
+     */
+    lineIntersectionTangents(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Array<Vector>;
+    /**
+     * Get all line intersections of this polygon and their tangents along the shape.
+     *
+     * This method returns all intersection tangents (as vectors) with this shape. The returned array of vectors is in no specific order.
+     *
+     * @param line
+     * @param inVectorBoundsOnly
+     * @returns
+     */
+    lineIntersectionTangentsIndices(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Array<PolygonIntersectionTuple<Vector>>;
+    /**
+     * Get the closest line-polygon-intersection point (closest the line point A).
+     *
+     * See demo `47-closest-vector-projection-on-polygon` for how it works.
+     *
+     * @param {VertTuple} line - The line to find intersections with.
+     * @param {boolean} inVectorBoundsOnly - If set to true only intersecion points on the passed vector are considered (located strictly between start and end vertex).
+     * @returns {Vertex | null} - The intersection point within the polygon bounds.
+     */
+    closestLineIntersection(line: VertTuple<any>, inVectorBoundsOnly?: boolean): Vertex | null;
+    /**
+     * Get the closest line-polygon-intersection point (closest the line point A) plus the edge index..
+     *
+     * See demo `63-measure-angles-on-polygon` for how it works.
+     *
+     * @param {VertTuple} line - The line to find intersections with.
+     * @param {boolean} inVectorBoundsOnly - If set to true only intersecion points on the passed vector are considered (located strictly between start and end vertex).
+     * @returns {PolygonIntersectionTuple| null} - A pair containing the intersection point and the affected polygon edge index.
+     */
+    closestLineIntersectionIndex(line: VertTuple<any>, inVectorBoundsOnly?: boolean): PolygonIntersectionTuple<Vertex> | null;
+    /**
+     * Construct a new polygon from this polygon with more vertices on each edge. The
+     * interpolation count determines the number of additional vertices on each edge.
+     * An interpolation count of `0` will return a polygon that equals the source
+     * polygon.
+     *
+     * @param {number} interpolationCount
+     * @returns {Polygon} A polygon with `interpolationCount` more vertices (as as factor).
+     */
+    getInterpolationPolygon(interpolationCount: number): Polygon;
+    /**
+     * Convert this polygon into a new polygon with n evenly distributed vertices.
+     *
+     * @param {number} pointCount - Must not be negative.
+     */
+    getEvenDistributionPolygon(pointCount: number): Polygon;
+    /**
+     * Get the bounding box (bounds) of this polygon.
+     *
+     * @method getBounds
+     * @instance
+     * @memberof Polygon
+     * @return {Bounds} The rectangular bounds of this polygon.
+     **/
+    getBounds(): Bounds;
+    /**
+     * Create a deep copy of this polygon.
+     *
+     * @method clone
+     * @instance
+     * @memberof Polygon
+     * @return {Polygon} The cloned polygon.
+     */
+    clone(): Polygon;
+    /**
+     * Create a new polygon without colinear adjacent edges. This method does not midify the current polygon
+     * but creates a new one.
+     *
+     * Please note that this method does NOT create deep clones of the vertices. Use Polygon.clone() if you need to.
+     *
+     * Please also note that the `tolerance` may become really large here, as the denominator of two closely
+     * parallel lines is usually pretty large. See the demo `57-eliminate-colinear-polygon-edges` to get
+     * an impression of how denominators work.
+     *
+     * @method elimitateColinearEdges
+     * @instance
+     * @memberof Polygon
+     * @param {number?} tolerance - (default is 1.0) The epsilon to detect co-linear edges.
+     * @return {Polygon} A new polygon without co-linear adjacent edges – respective the given epsilon.
+     */
+    elimitateColinearEdges(tolerance?: number): Polygon;
+    /**
+     * Convert this polygon to a sequence of quadratic Bézier curves.<br>
+     * <br>
+     * The first vertex in the returned array is the start point.<br>
+     * The following sequence are pairs of control-point-and-end-point:
+     * <pre>startPoint, controlPoint0, pathPoint1, controlPoint1, pathPoint2, controlPoint2, ..., endPoint</pre>
+     *
+     * @method toQuadraticBezierData
+     * @return {Vertex[]}  An array of 2d vertices that shape the quadratic Bézier curve.
+     * @instance
+     * @memberof Polygon
+     **/
+    toQuadraticBezierData(): Array<Vertex>;
+    /**
+     * Convert this polygon to a quadratic bezier curve, represented as an SVG data string.
+     *
+     * @method toQuadraticBezierSVGString
+     * @return {string} The 'd' part for an SVG 'path' element.
+     * @instance
+     * @memberof Polygon
+     **/
+    toQuadraticBezierSVGString(): string;
+    /**
+     * Convert this polygon to a sequence of cubic Bézier curves.<br>
+     * <br>
+     * The first vertex in the returned array is the start point.<br>
+     * The following sequence are triplets of (first-control-point, secnond-control-point, end-point):<br>
+     * <pre>startPoint, controlPoint0_0, controlPoint1_1, pathPoint1, controlPoint1_0, controlPoint1_1, ..., endPoint</pre>
+     *
+     * @method toCubicBezierData
+     * @param {number=} threshold - An optional threshold (default=1.0) how strong the curve segments
+     *                              should over-/under-drive. Should be between 0.0 and 1.0 for best
+     *                              results but other values are allowed.
+     * @return {Vertex[]}  An array of 2d vertices that shape the cubic Bézier curve.
+     * @instance
+     * @memberof Polygon
+     **/
+    toCubicBezierData(threshold: number | undefined): Array<Vertex>;
+    /**
+     * Convert this polygon to a cubic bezier curve, represented as an SVG data string.
+     *
+     * @method toCubicBezierSVGString
+     * @return {string} The 'd' part for an SVG 'path' element.
+     * @instance
+     * @memberof Polygon
+     **/
+    toCubicBezierSVGString(threshold: number): string;
+    /**
+     * Convert this polygon to a cubic bezier path instance.
+     *
+     * @method toCubicBezierPath
+     * @param {number} threshold - The threshold, usually from 0.0 to 1.0.
+     * @return {BezierPath}      - A bezier path instance.
+     * @instance
+     * @memberof Polygon
+     **/
+    toCubicBezierPath(threshold: number): BezierPath;
+    /**
+     * This function should invalidate any installed listeners and invalidate this object.
+     * After calling this function the object might not hold valid data any more and
+     * should not be used.
+     */
+    destroy(): void;
+    static utils: {
+        /**
+         * Calculate the area of the given polygon (unsigned).
+         *
+         * Note that this does not work for self-intersecting polygons.
+         *
+         * @name area
+         * @return {number}
+         */
+        area(vertices: Array<XYCoords>): number;
+        isClockwise(vertices: Array<XYCoords>): boolean;
+        /**
+         * Calulate the signed polyon area by interpreting the polygon as a matrix
+         * and calculating its determinant.
+         *
+         * @name signedArea
+         * @return {number}
+         */
+        signedArea(vertices: Array<XYCoords>): number;
+        /**
+         * Find intersections of a line with a polygon (vertices).
+         *
+         * @param {VertTuple<any>} line - The line to find intersections with.
+         * @param {Array<Vertex>} vertices - The polygon's vertices.
+         * @param {boolean} isOpen - True if the polygon is open, false otherwise.
+         * @param {boolean} inVectorBoundsOnly - If only intersections in strict vector bounds should be returned.
+         * @returns
+         */
+        locateLineIntersecion(line: VertTuple<any>, vertices: Array<Vertex>, isOpen: boolean, inVectorBoundsOnly: boolean): Array<PolygonIntersectionTuple<Vertex>>;
+    };
+}