plotboilerplate

/** * @author Ikaros Kappler * @date 2020-05-11 * @modified 2020-10-30 Added the static computeFromVertices function. * @modified 2020-11-19 Set min, max, width and height to private. * @modified 2021-02-02 Added the `toPolygon` method. * @modified 2021-06-21 (mid-summer) Added `getCenter` method. * @modified 2022-02-01 Added the `toString` function. * @modified 2022-10-09 Added the `fromDimension` function. * @modified 2022-11-28 Added the `clone` method. * @modified 2023-09-29 Added the `randomPoint` method. * @modified 2025-03-23 Added the `getMinDimension` and `getMaxDimension` methods. * @modified 2025-04-18 Change parameter type in `Bounds.computeFromVertices` from `Vertex` to more general `XYCoords`. * @modified 2025-04-19 Added methods to `Bounds` class: `getNorthPoint`, `getSouthPoint`, `getEastPoint` and `getWestPoint`. * @modified 2025-04-26 Added static method `Bounds.computeFromBoundsSet` to calculate containing bounds for a set of bounding boxes. * @version 1.8.0 **/ import { Polygon } from "./Polygon"; import { XYCoords, IBounds, XYDimension } from "./interfaces"; import { Vertex } from "./Vertex"; /** * @classdesc A bounds class with min and max values. Implementing IBounds. * * @requires XYCoords * @requires Vertex * @requires IBounds **/ export declare class Bounds implements IBounds, XYDimension { /** * @member {XYCoords} * @memberof Bounds * @instance * @public */ readonly min: XYCoords; /** * @member {XYCoords} * @memberof Bounds * @instance * @public */ readonly max: XYCoords; /** * @member {number} * @memberof Bounds * @instance * @public */ readonly width: number; /** * @member {number} * @memberof Bounds * @instance * @public */ readonly height: number; /** * The constructor. * * @constructor * @name Bounds * @param {XYCoords} min - The min values (x,y) as a XYCoords tuple. * @param {XYCoords} max - The max values (x,y) as a XYCoords tuple. **/ constructor(min: XYCoords, max: XYCoords); /** * Get the center point of the north bound. * * @method getNorthPoint * @instance * @memberof Bounds * @return {Vertex} The "northmost" centered point of this bounding box. */ getNorthPoint(): Vertex; /** * Get the center point of the south bound. * * @method getNorthPoint * @instance * @memberof Bounds * @return {Vertex} The "southhmost" centered point of this bounding box. */ getSouthPoint(): Vertex; /** * Get the center point of the west bound. * * @method getWestPoint * @instance * @memberof Bounds * @return {Vertex} The "westhmost" centered point of this bounding box. */ getWestPoint(): Vertex; /** * Get the center point of the east bound. * * @method getEastPoint * @instance * @memberof Bounds * @return {Vertex} The "easthmost" centered point of this bounding box. */ getEastPoint(): Vertex; /** * Convert this rectangular bounding box to a polygon with four vertices. * * @method toPolygon * @instance * @memberof Bounds * @return {Polygon} This bound rectangle as a polygon. */ toPolygon(): Polygon; /** * Get the center of this boinding box. * * @method getCenter * @instance * @memberof Bounds * @returns {Vertex} The center of these bounds. */ getCenter(): Vertex; /** * Get the minimum of `width` and `height`. * * @returns {number} The value of Math.min( this.width, this.height ) */ getMinDimension(): number; /** * Get the minimum of `width` and `height`. * * @returns {number} The value of Math.min( this.width, this.height ) */ getMaxDimension(): number; /** * Generate a random point inside this bounds object. Safe areas at the border to avoid * included. * * @method randomPoint * @instance * @memberof Bounds * @param {horizontalSafeArea} - (optional) The horizonal (left and right) safe area. No vertex will be created here. Can be used as percent in (0.0 ... 0.1) interval. * @param {verticalSafeArea} - (optional) The vertical (top and bottom) safe area. No vertex will be created here. Can be used as percent in (0.0 ... 0.1) interval * @returns {Vertex} A pseudo random point inside these bounds. */ randomPoint(horizontalSafeArea?: number, verticalSafeArea?: number): Vertex; /** * Convert these bounds to a human readable form. * * Note: the returned format might change in the future, so please do not * rely on the returned string format. * * @method toString * @instance * @memberof Bounds * @returns {string} Get these bounds in a human readable form. */ toString(): string; /** * Clone this bounds object (create a deep clone). * * @method clone * @instance * @memberof Bounds * @returns {Bounds} Creates a deep clone of this bounds object. */ clone(): Bounds; /** * Compute the minimal bounding box for a given set of vertices. * * An empty vertex array will return an empty bounding box located at (0,0). * * @static * @method computeFromVertices * @memberof Bounds * @param {Array<XYCoords>} vertices - The set of vertices you want to get the bounding box for. * @return The minimal Bounds for the given vertices. **/ static computeFromVertices(vertices: Array<XYCoords>): Bounds; /** * Compute the minimal bounding box for a given set of existing bounding boxes. * * An empty vertex array will return an empty bounding box located at (0,0). * * @static * @method computeFromBoundsSet * @memberof Bounds * @param {Array<IBounds>} boundingBoxes - The set of existing bounding boxes to get the containing bounding box for. * @return The minimal Bounds for the given bounds instances. **/ static computeFromBoundsSet(boundingBoxes: Array<IBounds>): Bounds; /** * Create a new `Bounds` instance just from `width` and `height`, located at (0,0) or the optionally given origin. * * @param {number} width - The width of the bounds * @param {number} height - The height of the bounds * @param {XYCoords={x:0,y:0}} origin - [optional] A origin to locate the new Bounds object at. * @returns {Bounds} A new `Bounds` instance width given width and height, located at (0,0) or the given origin.. */ static fromDimension(width: number, height: number, origin?: XYCoords): Bounds; }