autumnplot-gl 3.2.0 → 4.0.0

package/lib/Grid.d.ts

@@ -1,5 +1,5 @@
 import { WGLBuffer, WGLTexture } from "autumn-wgl";
-import { WebGLAnyRenderingContext } from "./AutumnTypes";
+import { TypedArray, WebGLAnyRenderingContext } from "./AutumnTypes";
 interface EarthCoords {
     lons: Float32Array;
     lats: Float32Array;
@@ -8,41 +8,68 @@ interface GridCoords {
     x: Float32Array;
     y: Float32Array;
 }
-type GridType = 'latlon' | 'latlonrot' | 'lcc';
+type GridType = 'latlon' | 'latlonrot' | 'lcc' | 'unstructured';
+/** The base class for grid types */
 declare abstract class Grid {
     readonly type: GridType;
     readonly ni: number;
     readonly nj: number;
     readonly is_conformal: boolean;
-    private readonly buffer_cache;
     private readonly billboard_buffer_cache;
     private readonly vector_rotation_cache;
     constructor(type: GridType, is_conformal: boolean, ni: number, nj: number);
-    abstract copy(opts?: {
-        ni?: number;
-        nj?: number;
-    }): Grid;
     abstract getEarthCoords(): EarthCoords;
     abstract getGridCoords(): GridCoords;
     abstract transform(x: number, y: number, opts?: {
         inverse?: boolean;
     }): [number, number];
-    abstract getThinnedGrid(thin_x: number, thin_y: number): Grid;
-    getWGLBuffers(gl: WebGLAnyRenderingContext): Promise<{
+    abstract sampleNearestGridPoint(lon: number, lat: number, ary: TypedArray): {
+        sample: number;
+        sample_lon: number;
+        sample_lat: number;
+    };
+    abstract getThinnedGrid(thin_fac: number, map_max_zoom: number): Grid;
+    abstract thinDataArray<ArrayType extends TypedArray>(original_grid: Grid, ary: ArrayType): ArrayType;
+    abstract getMinVisibleZoom(thin_fac: number): Uint8Array;
+    getWGLBillboardBuffers(gl: WebGLAnyRenderingContext, thin_fac: number, max_zoom: number): Promise<{
         vertices: WGLBuffer;
         texcoords: WGLBuffer;
-        cellsize: WGLBuffer;
     }>;
-    getWGLBillboardBuffers(gl: WebGLAnyRenderingContext, thin_fac: number, max_zoom: number): Promise<{
+    abstract copy(): Grid;
+    getVectorRotationAtPoint(lon: number, lat: number): number;
+    getVectorRotationTexture(gl: WebGLAnyRenderingContext, data_are_earth_relative: boolean): {
+        rotation: WGLTexture;
+    };
+}
+/** A structured grid (in this case meaning a cartesian grid with i and j coordinates) */
+declare abstract class StructuredGrid extends Grid {
+    private readonly buffer_cache;
+    protected readonly thin_x: number;
+    protected readonly thin_y: number;
+    constructor(type: GridType, is_conformal: boolean, ni: number, nj: number, thin_x?: number, thin_y?: number);
+    abstract getEarthCoords(ni?: number, nj?: number): EarthCoords;
+    /** @internal */
+    protected xyThinFromMaxZoom(thin_fac: number, map_max_zoom: number): [number, number];
+    /** @internal */
+    getMinVisibleZoom(thin_fac: number): Uint8Array;
+    /** @internal */
+    thinDataArray<ArrayType extends TypedArray>(original_grid: StructuredGrid, ary: ArrayType): ArrayType;
+    abstract copy(opts?: {
+        ni?: number;
+        nj?: number;
+    }): Grid;
+    getWGLBuffers(gl: WebGLAnyRenderingContext): Promise<{
         vertices: WGLBuffer;
         texcoords: WGLBuffer;
     }>;
-    getVectorRotationTexture(gl: WebGLAnyRenderingContext): {
-        rotation: WGLTexture;
+    sampleNearestGridPoint(lon: number, lat: number, ary: TypedArray): {
+        sample: number;
+        sample_lon: number;
+        sample_lat: number;
     };
 }
 /** A plate carree (a.k.a. lat/lon) grid with uniform grid spacing */
-declare class PlateCarreeGrid extends Grid {
+declare class PlateCarreeGrid extends StructuredGrid {
     readonly ll_lon: number;
     readonly ll_lat: number;
     readonly ur_lon: number;
@@ -58,7 +85,8 @@ declare class PlateCarreeGrid extends Grid {
      * @param ur_lon - The longitude of the upper right corner of the grid
      * @param ur_lat - The latitude of the upper right corner of the grid
      */
-    constructor(ni: number, nj: number, ll_lon: number, ll_lat: number, ur_lon: number, ur_lat: number);
+    constructor(ni: number, nj: number, ll_lon: number, ll_lat: number, ur_lon: number, ur_lat: number, thin_x?: number, thin_y?: number);
+    /** @internal */
     copy(opts?: {
         ni?: number;
         nj?: number;
@@ -68,17 +96,21 @@ declare class PlateCarreeGrid extends Grid {
         ur_lat?: number;
     }): PlateCarreeGrid;
     /**
+     * @internal
      * Get a list of longitudes and latitudes on the grid (internal method)
      */
-    getEarthCoords(): EarthCoords;
+    getEarthCoords(ni?: number, nj?: number): EarthCoords;
+    /** @internal */
     getGridCoords(): GridCoords;
+    /** @internal */
     transform(x: number, y: number, opts?: {
         inverse?: boolean;
     }): [number, number];
-    getThinnedGrid(thin_x: number, thin_y: number): PlateCarreeGrid;
+    /** @internal */
+    getThinnedGrid(thin_fac: number, map_max_zoom: number): PlateCarreeGrid;
 }
 /** A rotated lat-lon (plate carree) grid with uniform grid spacing */
-declare class PlateCarreeRotatedGrid extends Grid {
+declare class PlateCarreeRotatedGrid extends StructuredGrid {
     readonly np_lon: number;
     readonly np_lat: number;
     readonly lon_shift: number;
@@ -101,7 +133,8 @@ declare class PlateCarreeRotatedGrid extends Grid {
      * @param ur_lon    - The longitude of the upper right corner of the grid (on the rotated earth)
      * @param ur_lat    - The latitude of the upper right corner of the grid (on the rotated earth)
      */
-    constructor(ni: number, nj: number, np_lon: number, np_lat: number, lon_shift: number, ll_lon: number, ll_lat: number, ur_lon: number, ur_lat: number);
+    constructor(ni: number, nj: number, np_lon: number, np_lat: number, lon_shift: number, ll_lon: number, ll_lat: number, ur_lon: number, ur_lat: number, thin_x?: number, thin_y?: number);
+    /** @internal */
     copy(opts?: {
         ni?: number;
         nj?: number;
@@ -111,17 +144,21 @@ declare class PlateCarreeRotatedGrid extends Grid {
         ur_lat?: number;
     }): PlateCarreeRotatedGrid;
     /**
-     * Get a list of longitudes and latitudes on the grid (internal method)
+     * @internal
+     * Get a list of longitudes and latitudes on the grid
      */
-    getEarthCoords(): EarthCoords;
+    getEarthCoords(ni?: number, nj?: number): EarthCoords;
+    /** @internal */
     getGridCoords(): GridCoords;
+    /** @internal */
     transform(x: number, y: number, opts?: {
         inverse?: boolean;
     }): [number, number];
-    getThinnedGrid(thin_x: number, thin_y: number): PlateCarreeRotatedGrid;
+    /** @internal */
+    getThinnedGrid(thin_fac: number, map_max_zoom: number): PlateCarreeRotatedGrid;
 }
 /** A Lambert conformal conic grid with uniform grid spacing */
-declare class LambertGrid extends Grid {
+declare class LambertGrid extends StructuredGrid {
     readonly lon_0: number;
     readonly lat_0: number;
     readonly lat_std: [number, number];
@@ -129,11 +166,13 @@ declare class LambertGrid extends Grid {
     readonly ll_y: number;
     readonly ur_x: number;
     readonly ur_y: number;
+    readonly a: number;
+    readonly b: number;
     private readonly lcc;
     private readonly ll_cache;
     private readonly gc_cache;
     /**
-     * Create a Lambert conformal conic grid
+     * Create a Lambert conformal conic grid from the lower-left and upper-right corner x/y values.
      * @param ni      - The number of grid points in the i (longitude) direction
      * @param nj      - The number of grid points in the j (latitude) direction
      * @param lon_0   - The standard longitude for the projection; this is also the center longitude for the projection
@@ -143,9 +182,27 @@ declare class LambertGrid extends Grid {
      * @param ll_y    - The y coordinate in projection space of the lower-left corner of the grid
      * @param ur_x    - The x coordinate in projection space of the upper-right corner of the grid
      * @param ur_y    - The y coordinate in projection space of the upper-right corner of the grid
+     * @param a       - The semimajor axis of the assumed shape of Earth in meters
+     * @param b       - The semiminor axis of the assumed shape of Earth in meters
+     */
+    constructor(ni: number, nj: number, lon_0: number, lat_0: number, lat_std: [number, number], ll_x: number, ll_y: number, ur_x: number, ur_y: number, a?: number, b?: number, thin_x?: number, thin_y?: number);
+    /**
+     * Create a Lambert conformal conic grid from the lower-left grid point coordinate and a dx and dy.
+     * @param ni      - The number of grid points in the i (longitude) direction
+     * @param nj      - The number of grid points in the j (latitude) direction
+     * @param lon_0   - The standard longitude for the projection; this is also the center longitude for the projection
+     * @param lat_0   - The center latitude for the projection
+     * @param lat_std - The standard latitudes for the projection
+     * @param ll_lon  - The longitude of the lower-left corner of the grid
+     * @param ll_lat  - The latitude of the lower-left corner of the grid
+     * @param dx      - The grid dx in meters
+     * @param dy      - The grid dy in meters
+     * @param a       - The semimajor axis of the assumed shape of Earth in meters
+     * @param b       - The semiminor axis of the assumed shape of Earth in meters
+     * @returns
      */
-    constructor(ni: number, nj: number, lon_0: number, lat_0: number, lat_std: [number, number], ll_x: number, ll_y: number, ur_x: number, ur_y: number);
-    static fromLLCornerLonLat(ni: number, nj: number, lon_0: number, lat_0: number, lat_std: [number, number], ll_lon: number, ll_lat: number, dx: number, dy: number): LambertGrid;
+    static fromLLCornerLonLat(ni: number, nj: number, lon_0: number, lat_0: number, lat_std: [number, number], ll_lon: number, ll_lat: number, dx: number, dy: number, a?: number, b?: number): LambertGrid;
+    /** @internal */
     copy(opts?: {
         ni?: number;
         nj?: number;
@@ -155,14 +212,59 @@ declare class LambertGrid extends Grid {
         ur_y?: number;
     }): LambertGrid;
     /**
-     * Get a list of longitudes and latitudes on the grid (internal method)
+     * @internal
+     * Get a list of longitudes and latitudes on the grid
      */
-    getEarthCoords(): EarthCoords;
+    getEarthCoords(ni?: number, nj?: number): EarthCoords;
+    /** @internal */
     getGridCoords(): GridCoords;
+    /** @internal */
     transform(x: number, y: number, opts?: {
         inverse?: boolean;
     }): [number, number];
-    getThinnedGrid(thin_x: number, thin_y: number): LambertGrid;
+    /** @internal */
+    getThinnedGrid(thin_fac: number, map_max_zoom: number): LambertGrid;
+}
+/** An unstructured grid defined by a list of latitudes and longitudes */
+declare class UnstructuredGrid extends Grid {
+    readonly coords: {
+        lon: number;
+        lat: number;
+    }[];
+    private readonly zoom_cache;
+    private readonly zoom_arg;
+    /**
+     * Create an unstructured grid
+     * @param coords - The lat/lon coordinates of the grid points
+     */
+    constructor(coords: {
+        lon: number;
+        lat: number;
+    }[], zoom?: Uint8Array);
+    /** @internal */
+    copy(): UnstructuredGrid;
+    /** @internal */
+    getEarthCoords(): {
+        lons: Float32Array;
+        lats: Float32Array;
+    };
+    /** @internal */
+    getGridCoords(): GridCoords;
+    /** @internal */
+    transform(x: number, y: number, opts?: {
+        inverse?: boolean;
+    }): [number, number];
+    /** @internal */
+    getMinVisibleZoom(thin_fac: number): Uint8Array;
+    /** @internal */
+    getThinnedGrid(thin_fac: number, map_max_zoom: number): UnstructuredGrid;
+    /** @internal */
+    thinDataArray<ArrayType extends TypedArray>(original_grid: UnstructuredGrid, ary: ArrayType): ArrayType;
+    sampleNearestGridPoint(lon: number, lat: number, ary: TypedArray): {
+        sample: number;
+        sample_lon: number;
+        sample_lat: number;
+    };
 }
-export { Grid, PlateCarreeGrid, PlateCarreeRotatedGrid, LambertGrid };
+export { Grid, StructuredGrid, PlateCarreeGrid, PlateCarreeRotatedGrid, LambertGrid, UnstructuredGrid };
 export type { GridType };