@gisatcz/deckgl-geolib 1.11.0-dev.0 → 1.11.0-dev.10

package/dist/esm/types/cogbitmaplayer/CogBitmapLayer.d.ts

@@ -1,42 +1,87 @@
-import { CompositeLayer } from '@deck.gl/core';
-import { TileLayer } from '@deck.gl/geo-layers';
+import { CompositeLayer, CompositeLayerProps, DefaultProps, TextureSource, UpdateParameters } from '@deck.gl/core';
+import { _Tile2DHeader as Tile2DHeader, _TileLoadProps as TileLoadProps, GeoBoundingBox, NonGeoBoundingBox, TileLayer, TileLayerProps } from '@deck.gl/geo-layers';
 import { BitmapLayer } from '@deck.gl/layers';
-import { _TerrainExtension as TerrainExtension } from '@deck.gl/extensions';
-import CogTiles from '../cogtiles/cogtiles.ts';
+import type { MeshAttributes } from '@loaders.gl/schema';
 import { GeoImageOptions } from '../geoimage/geoimage.ts';
-declare class CogBitmapLayer extends CompositeLayer<any> {
+export type TileBoundingBox = NonGeoBoundingBox | GeoBoundingBox;
+export type ZRange = [minZ: number, maxZ: number];
+export type Bounds = [minX: number, minY: number, maxX: number, maxY: number];
+export type URLTemplate = string | string[] | null;
+export declare const urlType: {
+    type: "object";
+    value: URLTemplate;
+    validate: (value: any, propType: any) => boolean;
+    equal: (value1: any, value2: any) => boolean;
+};
+export type ClampToTerrainOptions = {
+    terrainDrawMode?: string;
+};
+type MeshAndTexture = [MeshAttributes | null, TextureSource | null];
+/** Props added by the CogBitmapLayer */
+type _CogBitmapLayerProps = {
+    /** Image url that encodes raster data. * */
+    rasterData: URLTemplate;
+    /** Bounding box of the bitmap image, [minX, minY, maxX, maxY] in world coordinates. * */
+    bounds: Bounds | null;
+    /** Weather visualise the entire image with specified opacity (0-1) * */
+    opacity?: number;
+    /** Whether the rendered texture should be clamped to terrain * */
+    clampToTerrain?: ClampToTerrainOptions | boolean;
+    /**
+     * TODO
+     */
+    cogBitmapOptions: GeoImageOptions;
+    isTiled: boolean;
+    /**
+     * @deprecated Use `loadOptions.terrain.workerUrl` instead
+     */
+    workerUrl?: string;
+};
+/** All properties supported by CogBitmapLayer */
+export type CogBitmapLayerProps = _CogBitmapLayerProps & TileLayerProps<MeshAndTexture> & CompositeLayerProps;
+/** Render bitmap texture from cog raster images. */
+export default class CogBitmapLayer<ExtraPropsT extends {} = {}> extends CompositeLayer<ExtraPropsT & Required<_CogBitmapLayerProps & Required<TileLayerProps<MeshAndTexture>>>> {
+    static defaultProps: DefaultProps<CogBitmapLayerProps>;
     static layerName: string;
-    id: string;
-    url: string;
-    static displayName: string;
-    cogTiles: CogTiles;
-    tileSize: number;
     minZoom: number;
     maxZoom: number;
-    blurredTexture: boolean;
-    constructor(id: string, url: string, options: GeoImageOptions);
-    initializeState(): void;
-    init(url: string): Promise<void>;
-    renderLayers(): TileLayer<any, {
-        id: `${string}-${string}`;
-        getTileData: (tileData: any) => Promise<string>;
+    state: {
+        initialized: boolean;
+        isTiled?: boolean;
+        terrain?: MeshAttributes;
+        zRange?: ZRange | null;
+        bitmapCogTiles: any;
         minZoom: number;
         maxZoom: number;
-        tileSize: number;
-        maxRequests: 6;
-        extent: [number, number, number, number];
-        renderSubLayers: (props: any) => BitmapLayer<{
-            terrainDrawMode: any;
-            data: null;
-            image: any;
-            bounds: [any, any, any, any];
-            opacity: number;
-            textureParameters: {
-                minFilter: "linear" | "nearest";
-                magFilter: "linear" | "nearest";
+    };
+    initializeState(context: any): Promise<void>;
+    init(): Promise<void>;
+    updateState({ props, oldProps }: UpdateParameters<this>): void;
+    getTiledBitmapData(tile: TileLoadProps): Promise<TextureSource>;
+    renderSubLayers(props: TileLayerProps<TextureSource> & {
+        id: string;
+        data: TextureSource;
+        tile: Tile2DHeader<TextureSource>;
+    }): BitmapLayer<{}>;
+    renderLayers(): TileLayer<any, {
+        getTileData: any;
+        renderSubLayers: any;
+        updateTriggers: {
+            getTileData: {
+                clampToTerrain: boolean | ClampToTerrainOptions;
             };
-            extensions: TerrainExtension[];
-        }>;
+        };
+        extent: any;
+        tileSize: any;
+        minZoom: number;
+        maxZoom: number;
+        maxRequests: number;
+        onTileLoad: (tile: Tile2DHeader<MeshAndTexture>) => void;
+        onTileUnload: (tile: Tile2DHeader<MeshAndTexture>) => void;
+        onTileError: (err: any, tile?: any) => void;
+        maxCacheSize: number;
+        maxCacheByteSize: number;
+        refinementStrategy: import("node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.js").RefinementStrategy;
     }>;
 }
-export default CogBitmapLayer;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gisatcz/deckgl-geolib",
-  "version": "1.11.0-dev.0",
+  "version": "1.11.0-dev.10",
   "private": false,
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -30,18 +30,17 @@
   "dependencies": {
     "@chunkd/source-http": "^11.1.0",
     "@cogeotiff/core": "^9.0.3",
-    "@deck.gl/core": "^9.0.6",
-    "@deck.gl/extensions": "^9.0.6",
-    "@deck.gl/geo-layers": "^9.0.6",
-    "@deck.gl/layers": "^9.0.6",
-    "@deck.gl/mesh-layers": "^9.0.6",
-    "@deck.gl/react": "^9.0.6",
-    "@fortawesome/fontawesome-svg-core": "^6.4.0",
-    "@loaders.gl/loader-utils": "^4.2.0",
-    "@loaders.gl/schema": "^4.2.0",
-    "@luma.gl/constants": "^9.0.9",
+    "@deck.gl/core": "^9.0.33",
+    "@deck.gl/extensions": "^9.0.33",
+    "@deck.gl/geo-layers": "^9.0.33",
+    "@deck.gl/layers": "^9.0.33",
+    "@deck.gl/mesh-layers": "^9.0.33",
+    "@deck.gl/react": "^9.0.33",
+    "@loaders.gl/loader-utils": "^4.3.1",
+    "@loaders.gl/schema": "^4.3.1",
+    "@luma.gl/constants": "^9.0.27",
     "@mapbox/martini": "^0.2.0",
-    "@math.gl/web-mercator": "^4.0.1",
+    "@math.gl/web-mercator": "^4.1.0",
     "chroma-js": "^2.4.2",
     "geotiff": "^2.1.3",
     "jpeg-js": "^0.4.4",

package/src/cogbitmaplayer/CogBitmapLayer.ts

@@ -1,113 +1,330 @@
-import { CompositeLayer } from '@deck.gl/core';
-import { TileLayer } from '@deck.gl/geo-layers';
+import {
+  CompositeLayer, CompositeLayerProps, DefaultProps, log, TextureSource, UpdateParameters,
+} from '@deck.gl/core';
+import {
+  _Tile2DHeader as Tile2DHeader,
+  _TileLoadProps as TileLoadProps,
+  GeoBoundingBox,
+  NonGeoBoundingBox,
+  TileLayer,
+  TileLayerProps,
+} from '@deck.gl/geo-layers';
 import { BitmapLayer } from '@deck.gl/layers';
 import { _TerrainExtension as TerrainExtension } from '@deck.gl/extensions';
-import { GL } from '@luma.gl/constants';
+// import { GL } from '@luma.gl/constants';
 // import GL from '@luma.gl/constants';
 // GL.GL.CLIP_DISTANCE0_WEBGL
+import type { MeshAttributes } from '@loaders.gl/schema';
 import CogTiles from '../cogtiles/cogtiles.ts';
 
 import { GeoImageOptions } from '../geoimage/geoimage.ts';
+// import { TileBoundingBox, ZRange } from '../cogterrainlayer/CogTerrainLayer.js';
+export type TileBoundingBox = NonGeoBoundingBox | GeoBoundingBox;
+
+export type ZRange = [minZ: number, maxZ: number];
 
 // let needsRerender: boolean = false;
 // let extent = [0, 0, 0, 0]
+export type Bounds = [minX: number, minY: number, maxX: number, maxY: number];
 
-class CogBitmapLayer extends CompositeLayer<any> {
-  static layerName = 'CogBitmapLayer';
+export type URLTemplate = string | string[] | null;
 
-  // private _isLoaded: boolean;
+export const urlType = {
+  type: 'object' as const,
+  value: null as URLTemplate,
+  validate: (value, propType) => (propType.optional && value === null)
+      || typeof value === 'string'
+      || (Array.isArray(value) && value.every((url) => typeof url === 'string')),
+  equal: (value1, value2) => {
+    if (value1 === value2) {
+      return true;
+    }
+    if (!Array.isArray(value1) || !Array.isArray(value2)) {
+      return false;
+    }
+    const len = value1.length;
+    if (len !== value2.length) {
+      return false;
+    }
+    for (let i = 0; i < len; i++) {
+      if (value1[i] !== value2[i]) {
+        return false;
+      }
+    }
+    return true;
+  },
+};
+
+export type ClampToTerrainOptions = {
+  terrainDrawMode?: string
+}
+
+const defaultProps: DefaultProps<CogBitmapLayerProps> = {
+  ...TileLayer.defaultProps,
+  // Image url that encodes height data
+  // elevationData: urlType,
+  // Image url to use as texture
+  // texture: { ...urlType, optional: true },
+  // Martini error tolerance in meters, smaller number -> more detailed mesh
+  // meshMaxError: { type: 'number', value: 4.0 },
+  // Bounding box of the terrain image, [minX, minY, maxX, maxY] in world coordinates
+  bounds: {
+    type: 'array', value: null, optional: true, compare: true,
+  },
+  rasterData: urlType,
+  // Color to use if texture is unavailable
+  // color: { type: 'color', value: [255, 255, 255] },
+  blurredTexture: true,
+  opacity: 1,
+  clampToTerrain: false,
+  // Object to decode height data, from (r, g, b) to height in meters
+  // elevationDecoder: {
+  //   type: 'object',
+  //   value: {
+  //     rScaler: 1,
+  //     gScaler: 0,
+  //     bScaler: 0,
+  //     offset: 0,
+  //   },
+  // },
+  // Supply url to local terrain worker bundle. Only required if running offline and cannot access CDN.
+  workerUrl: '',
+  // Same as SimpleMeshLayer wireframe
+  // wireframe: false,
+  // material: true,
+
+  // loaders: [TerrainLoader],
+};
+
+// Turns array of templates into a single string to work around shallow change
+function urlTemplateToUpdateTrigger(template: URLTemplate): string {
+  if (Array.isArray(template)) {
+    return template.join(';');
+  }
+  return template || '';
+}
 
-  id = '';
+type MeshAndTexture = [MeshAttributes | null, TextureSource | null];
 
-  url: string;
+/** Props added by the CogBitmapLayer */
+type _CogBitmapLayerProps = {
+  /** Image url that encodes raster data. * */
+  rasterData: URLTemplate;
 
-  static displayName: string;
+  /** Bounding box of the bitmap image, [minX, minY, maxX, maxY] in world coordinates. * */
+  bounds: Bounds | null;
 
-  cogTiles: CogTiles;
+  /** Weather visualise the entire image with specified opacity (0-1) * */
+  opacity?: number;
 
-  tileSize: number;
+  /** Whether the rendered texture should be clamped to terrain * */
+  clampToTerrain?: ClampToTerrainOptions | boolean, // terrainDrawMode: 'drape',
+
+  /**
+   * TODO
+   */
+  cogBitmapOptions: GeoImageOptions;
+
+  isTiled: boolean;
+
+  /**
+   * @deprecated Use `loadOptions.terrain.workerUrl` instead
+   */
+  workerUrl?: string;
+};
+
+/** All properties supported by CogBitmapLayer */
+export type CogBitmapLayerProps = _CogBitmapLayerProps &
+    TileLayerProps<MeshAndTexture> &
+    CompositeLayerProps;
+
+/** Render bitmap texture from cog raster images. */
+export default class CogBitmapLayer<ExtraPropsT extends {} = {}> extends CompositeLayer<
+  ExtraPropsT & Required<_CogBitmapLayerProps & Required<TileLayerProps<MeshAndTexture>>>
+> {
+  static defaultProps = defaultProps;
+
+  static layerName = 'CogBitmapLayer';
 
   minZoom: number;
 
   maxZoom: number;
 
-  blurredTexture: boolean;
-
-  constructor(id:string, url:string, options:GeoImageOptions) {
-    super({});
-    this.id = id;
-    // this.state = {
-    //   initialized: false,
-    // };
-    // this._isLoaded = false;
-    this.cogTiles = new CogTiles(options);
-    this.blurredTexture = options.blurredTexture;
-    this.url = url;
-    // setTimeout(() => {
-    //   this.init(url);
-    // }, 500);
-  }
+  state!: {
+    initialized: boolean;
+    isTiled?: boolean;
+    terrain?: MeshAttributes;
+    zRange?: ZRange | null;
+    bitmapCogTiles: any;
+    minZoom: number;
+    maxZoom: number;
+  };
+
+  // private _isLoaded: boolean;
+
+  // id = '';
+
+  // url: string;
+
+  // static displayName: string;
 
-  initializeState() {
-    this.state = {
+  // cogTiles: CogTiles;
+  //
+  // tileSize: number;
+  //
+
+  async initializeState(context: any) {
+    super.initializeState(context);
+
+    this.setState({
+      bitmapCogTiles: new CogTiles(this.props.cogBitmapOptions),
       initialized: false,
-    };
+    });
+
+    await this.init();
+  }
+
+  async init() {
+    const cog = await this.state.bitmapCogTiles.initializeCog(this.props.rasterData);
+
+    const zoomRange = this.state.bitmapCogTiles.getZoomRange(cog);
+
+    const [minZoom, maxZoom] = zoomRange;
+
+    this.setState({ initialized: true, minZoom, maxZoom });
+  }
+
+  updateState({ props, oldProps }: UpdateParameters<this>): void {
+    const rasterDataChanged = props.rasterData !== oldProps.rasterData;
+    if (rasterDataChanged) {
+      const { rasterData } = props;
+      const isTiled = rasterData
+          && ((Array.isArray(rasterData)
+              || (rasterData.includes('{x}') && rasterData.includes('{y}'))) || this.props.isTiled);
+      this.setState({ isTiled });
+    }
+
+    // Reloading for single terrain mesh
+    const shouldReload = rasterDataChanged
+        // || props.meshMaxError !== oldProps.meshMaxError
+        // || props.elevationDecoder !== oldProps.elevationDecoder
+        || props.bounds !== oldProps.bounds;
+
+    if (!this.state.isTiled && shouldReload) {
+      // When state.isTiled, elevationData cannot be an array
+      // const terrain = this.loadTerrain(props as TerrainLoadProps);
+      // this.setState({ terrain });
+    }
 
-    this.init(this.url);
+    // TODO - remove in v9
+    // @ts-ignore
+    if (props.workerUrl) {
+      log.removed('workerUrl', 'loadOptions.terrain.workerUrl')();
+    }
   }
 
-  async init(url:string) {
-    const cog = await this.cogTiles.initializeCog(url);
-    this.setState({ initialized: true });
-    this.tileSize = this.cogTiles.getTileSize(cog);
-    const zoomRange = this.cogTiles.getZoomRange(cog);
-    [this.minZoom, this.maxZoom] = zoomRange;
+  async getTiledBitmapData(tile: TileLoadProps): Promise<TextureSource> {
+    // TODO - pass signal to getTile
+    // abort request if signal is aborted
+    const tileData = await this.state.bitmapCogTiles.getTile(
+      tile.index.x,
+      tile.index.y,
+      tile.index.z,
+      // bounds,
+      // this.props.meshMaxError,
+    );
+    return tileData;
+  }
+
+  renderSubLayers(
+    props: TileLayerProps<TextureSource> & {
+        id: string;
+        data: TextureSource;
+        tile: Tile2DHeader<TextureSource>;
+      },
+  ) {
+    const SubLayerClass = this.getSubLayerClass('image', BitmapLayer);
+    const { blurredTexture } = this.state.bitmapCogTiles.options;
+
+    const { opacity, clampToTerrain } = this.props;
+
+    const { data } = props;
+
+    if (!data) {
+      return null;
+    }
+
+    const {
+      bbox: {
+        west, south, east, north,
+      },
+    } = props.tile;
+
+    return new SubLayerClass({ ...props, tileSize: this.state.bitmapCogTiles.tileSize }, {
+      data: null,
+      image: data,
+      _instanced: false,
+      bounds: [west, south, east, north],
+      opacity,
+      textureParameters: {
+        minFilter: blurredTexture ? 'linear' : 'nearest',
+        magFilter: blurredTexture ? 'linear' : 'nearest',
+      },
+      //  TODO check if works!!!
+      extensions: clampToTerrain ? [new TerrainExtension()] : [],
+      ...(clampToTerrain?.terrainDrawMode
+        ? { terrainDrawMode: clampToTerrain.terrainDrawMode }
+        : {}),
+    });
   }
 
   renderLayers() {
-    if (this.cogTiles.cog) {
-      const layer = new TileLayer({
-        id: `${this.id}-${String(performance.now())}`,
-        getTileData: (tileData: any) => this.cogTiles.getTile(
-          tileData.index.x,
-          tileData.index.y,
-          tileData.index.z,
-        ),
-        minZoom: this.minZoom,
-        maxZoom: this.maxZoom,
-        tileSize: this.tileSize,
-        maxRequests: 6,
-        extent: this.cogTiles.cog ? this.cogTiles.getBoundsAsLatLon(this.cogTiles.cog) : null,
-
-        renderSubLayers: (props: any) => {
-          const {
-            bbox: {
-              west, south, east, north,
-            },
-          } = props.tile;
-
-          return new BitmapLayer(props, {
-            data: null,
-            image: props.data,
-            bounds: [west, south, east, north],
-            opacity: 1, // 0.6
-            textureParameters: {
-              minFilter: this.blurredTexture ? 'linear' : 'nearest',
-              magFilter: this.blurredTexture ? 'linear' : 'nearest',
-            },
-            extensions: this.cogTiles?.options?.clampToTerrain ? [new TerrainExtension()] : [],
-            ...(this.cogTiles?.options?.clampToTerrain?.terrainDrawMode
-              ? { terrainDrawMode: this.cogTiles?.options?.clampToTerrain.terrainDrawMode }
-              : {}),
-          });
+    const {
+      rasterData,
+      blurredTexture,
+      opacity,
+      clampToTerrain,
+      // tileSize,
+      maxRequests,
+      onTileLoad,
+      onTileUnload,
+      onTileError,
+      maxCacheSize,
+      maxCacheByteSize,
+      refinementStrategy,
+      cogBitmapOptions,
+    } = this.props;
+    if (this.state.isTiled && this.state.initialized) {
+      const { tileSize } = this.state.bitmapCogTiles;
+
+      return new TileLayer(this.getSubLayerProps({
+        id: 'tiles',
+      }), {
+        getTileData: this.getTiledBitmapData.bind(this),
+        renderSubLayers: this.renderSubLayers.bind(this),
+        updateTriggers: {
+          getTileData: {
+            // rasterData: urlTemplateToUpdateTrigger(rasterData),
+            // blurredTexture,
+            // opacity,
+            // cogBitmapOptions,
+            clampToTerrain,
+          },
         },
+        extent: this.state.bitmapCogTiles.cog
+          ? this.state.bitmapCogTiles.getBoundsAsLatLon(this.state.bitmapCogTiles.cog) : null,
+        tileSize,
+        minZoom: this.state.minZoom,
+        maxZoom: this.state.maxZoom,
+        maxRequests,
+        onTileLoad,
+        onTileUnload,
+        onTileError,
+        maxCacheSize,
+        maxCacheByteSize,
+        refinementStrategy,
       });
-      return layer;
     }
     return null;
   }
 }
-
-CogBitmapLayer.displayName = 'CogBitmapLayer';
-
-export default CogBitmapLayer;

package/src/cogtiles/cogtiles.ts

@@ -17,6 +17,10 @@ export type Bounds = [minX: number, minY: number, maxX: number, maxY: number];
 const EARTH_CIRCUMFERENCE = 40075000.0;
 const EARTH_HALF_CIRCUMFERENCE = 20037500.0;
 
+const CogTilesGeoImageOptionsDefaults = {
+  blurredTexture: true,
+};
+
 class CogTiles {
   cog: Tiff;
 
@@ -37,7 +41,7 @@ class CogTiles {
   options: GeoImageOptions;
 
   constructor(options: GeoImageOptions) {
-    this.options = options;
+    this.options = { ...CogTilesGeoImageOptionsDefaults, ...options };
   }
 
   async initializeCog(url: string) {

package/src/geoimage/geoimage.ts

@@ -435,7 +435,9 @@ export default class GeoImage {
 
     for (let i = 0; i < arrayLength; i += 4) {
       let pixelColor = options.nullColor;
-      if (options.noDataValue === undefined || dataArray[pixel] !== options.noDataValue) {
+      // FIXME
+      // eslint-disable-next-line max-len
+      if ((!Number.isNaN(dataArray[pixel])) && (options.noDataValue === undefined || dataArray[pixel] !== options.noDataValue)) {
         if (
           (options.clipLow != null && dataArray[pixel] <= options.clipLow)
                 || (options.clipHigh != null && dataArray[pixel] >= options.clipHigh)
@@ -468,9 +470,6 @@ export default class GeoImage {
             pixelColor[3] = this.scale(dataArray[pixel], options.colorScaleValueRange[0]!, options.colorScaleValueRange.slice(-1)[0]!, 0, 255);
           }
         }
-        // If pixel has null value
-      } else if (Number.isNaN(dataArray[pixel])) {
-        pixelColor = [0, 0, 0, 0];
       }
       // FIXME
       // eslint-disable-next-line