@itowns/geographic 2.45.1-next.0 → 2.45.1-next.1

package/lib/Extent.d.ts

@@ -0,0 +1,246 @@
+import * as THREE from 'three';
+import Coordinates from './Coordinates';
+import type { ProjectionLike } from './Crs';
+export interface ExtentLike {
+    readonly west: number;
+    readonly east: number;
+    readonly south: number;
+    readonly north: number;
+}
+/**
+ * A class representing a geographical extent.
+ *
+ * An extent is a geographical bounding rectangle defined by 4 limits: west,
+ * east, south and north.
+ *
+ * **Warning**: Using a geocentric projection is not suitable for representing a
+ * geographical extent. Please use a geographic projection.
+ */
+declare class Extent {
+    /**
+     * Read-only flag to check if a given object is of type `Extent`.
+     */
+    readonly isExtent: true;
+    /**
+     * A default or user-defined CRS (see {@link ProjectionLike}).
+     */
+    crs: ProjectionLike;
+    /**
+     * West longitude bound of this extent.
+     */
+    west: number;
+    /**
+     * East longitude bound of this extent.
+     */
+    east: number;
+    /**
+     * South latitude bound of this extent.
+     */
+    south: number;
+    /**
+     * North latitude bound of this extent.
+     */
+    north: number;
+    /**
+     * @param crs - A default or user-defined CRS (see {@link ProjectionLike}).
+     * @param west - the `west` value of this extent. Default is 0.
+     * @param east - the `east` value of this extent. Default is 0.
+     * @param south - the `south` value of this extent. Default is 0.
+     * @param north - the `north` value of this extent. Default is 0.
+     */
+    constructor(crs: ProjectionLike, west?: number, east?: number, south?: number, north?: number);
+    /**
+     * Returns a new extent with the same bounds and crs as this one.
+     */
+    clone(): Extent;
+    /**
+     * Projects this extent to the specified projection.
+     *
+     * @param crs - target's projection.
+     * @param target - The target to store the projected extent. If this not
+     * provided a new extent will be created.
+     */
+    as(crs: string, target?: Extent): Extent;
+    /**
+     * Returns the center of the extent.
+     *
+     * @param target - The target to store the center coordinate. If this not
+     * provided a new coordinate will be created.
+     */
+    center(target?: Coordinates): Coordinates;
+    /**
+     * Returns the planar dimensions as two-vector planar distances west/east
+     * and south/north.
+     * The planar distance is a straight-line Euclidean distance calculated in a
+     * 2D Cartesian coordinate system.
+     *
+     * @param target - optional target
+     */
+    planarDimensions(target?: THREE.Vector2): THREE.Vector2;
+    /**
+     * Returns the geodetic dimensions as two-vector planar distances west/east
+     * and south/north.
+     * Geodetic distance is calculated in an ellispoid space as the distance
+     * across the curved surface of the ellipsoid.
+     *
+     * @param target - optional target
+     */
+    geodeticDimensions(target?: THREE.Vector2): THREE.Vector2;
+    /**
+     *  Returns the spatial euclidean dimensions as a two-vector spatial
+     *  euclidean distances between west/east corner and south/north corner.
+     *  Spatial euclidean distance chord is calculated in an ellispoid space.
+     *
+     * @param target - optional target
+     */
+    spatialEuclideanDimensions(target?: THREE.Vector2): THREE.Vector2;
+    /**
+     * Checks whether a coordinates is inside the extent.
+     *
+     * @param coord - the given coordinates.
+     * @param epsilon - error margin when comparing to the coordinates.
+     * Default is 0.
+     */
+    isPointInside(coord: Coordinates, epsilon?: number): boolean;
+    /**
+     * Checks whether another extent is inside the extent.
+     *
+     * @param extent - the extent to check
+     * @param epsilon - error margin when comparing the extent bounds.
+     */
+    isInside(extent: Extent, epsilon?: number): boolean;
+    /**
+     * Return the translation and scale to transform this extent to the input
+     * extent.
+     *
+     * @param extent - input extent
+     * @param target - copy the result to target.
+     * @returns A {@link THREE.Vector4} where the `x` property encodes the
+     * translation on west-east, the `y` property the translation on
+     * south-north, the `z` property the scale on west-east, the `w` property
+     * the scale on south-north.
+     */
+    offsetToParent(extent: Extent, target?: THREE.Vector4): THREE.Vector4;
+    /**
+     * Checks wheter this bounding box intersects with the given extent
+     * parameter.
+     * @param extent - the provided extent
+     */
+    intersectsExtent(extent: Extent): boolean;
+    static intersectsExtent(extentA: Extent, extentB: Extent): boolean;
+    /**
+     * Returns the intersection of this extent with another one.
+     * @param extent - extent to intersect
+     */
+    intersect(extent: Extent): Extent;
+    /**
+     * Set west, east, south and north values.
+     *
+     * @param v0 - the `west` value of this extent. Default is 0.
+     * @param v1 - the `east` value of this extent. Default is 0.
+     * @param v2 - the `south` value of this extent. Default is 0.
+     * @param v3 - the `north` value of this extent. Default is 0.
+     */
+    set(v0: number, v1: number, v2: number, v3: number): this;
+    /**
+     * Sets this extent `west` property to `array[offset + 0]`, `east` property
+     * to `array[offset + 1]`, `south` property to `array[offset + 2]` and
+     * `north` property to `array[offset + 3]`.
+     * @param array - the source array
+     * @param offset - offset into the array. Default is 0.
+     */
+    setFromArray(array: ArrayLike<number>, offset?: number): this;
+    /**
+     * Sets this extent `west`, `east`, `south` and `north` properties from an
+     * `extent` bounds.
+     * @param extent - the source extent
+     */
+    setFromExtent(extent: ExtentLike): this;
+    /**
+     * Copies the passed extent to this extent.
+     * @param extent - extent to copy.
+     */
+    copy(extent: Extent): this;
+    /**
+     * Union this extent with the input extent.
+     * @param extent - the extent to union.
+     */
+    union(extent: Extent): void;
+    /**
+     * expandByCoordinates perfoms the minimal extension
+     * for the coordinates to belong to this Extent object
+     * @param coordinates - The coordinates to belong
+     */
+    expandByCoordinates(coordinates: Coordinates): void;
+    /**
+    * expandByValuesCoordinates perfoms the minimal extension
+    * for the coordinates values to belong to this Extent object
+    * @param we - The coordinate on west-east
+    * @param sn - The coordinate on south-north
+    *
+    */
+    expandByValuesCoordinates(we: number, sn: number): void;
+    /**
+     * Instance Extent with THREE.Box3.
+     *
+     * If crs is a geocentric projection, the `box3.min` and `box3.max`
+     * should be the geocentric coordinates of `min` and `max` of a `box3`
+     * in local tangent plane.
+     *
+     * @param crs - Projection of extent to instancied.
+     * @param box - Bounding-box
+     */
+    static fromBox3(crs: ProjectionLike, box: THREE.Box3): Extent;
+    /**
+     * Return values of extent in string, separated by the separator input.
+     * @param sep - string separator
+     */
+    toString(sep?: string): string;
+    /**
+     * Subdivide equally an extent from its center to return four extents:
+     * north-west, north-east, south-west and south-east.
+     *
+     * @returns An array containing the four sections of the extent. The order
+     * of the sections is [NW, NE, SW, SE].
+     */
+    subdivision(): Extent[];
+    /**
+     * subdivise extent by scheme.x on west-east and scheme.y on south-north.
+     *
+     * @param scheme - The scheme to subdivise.
+     * @returns subdivised extents.
+     */
+    subdivisionByScheme(scheme?: THREE.Vector2): Extent[];
+    /**
+     * Multiplies all extent `coordinates` (with an implicit 1 in the 4th
+     * dimension) and `matrix`.
+     *
+     * @param matrix - The matrix
+     * @returns return this extent instance.
+     */
+    applyMatrix4(matrix: THREE.Matrix4): this;
+    /**
+     * clamp south and north values
+     *
+     * @param south - The min south
+     * @param north - The max north
+     * @returns this extent
+     */
+    clampSouthNorth(south?: number, north?: number): this;
+    /**
+     * clamp west and east values
+     *
+     * @param west - The min west
+     * @param east - The max east
+     * @returns this extent
+     */
+    clampWestEast(west?: number, east?: number): this;
+    /**
+     * clamp this extent by passed extent
+     *
+     * @param extent - The maximum extent.
+     * @returns this extent.
+     */
+    clampByExtent(extent: ExtentLike): this;
+}
+export default Extent;