Merge pull request #12373 from mike-000/patch-1

Rework TileDebug to allow TMS coordinates and to fix reprojection

src/ol/ImageTile.js

@@ -72,6 +72,17 @@ class ImageTile extends Tile {
     return this.image_;
   }
 
+  /**
+   * Sets an HTML image element for this tile (may be a Canvas or preloaded Image).
+   * @param {HTMLCanvasElement|HTMLImageElement} element Element.
+   */
+  setImage(element) {
+    this.image_ = element;
+    this.state = TileState.LOADED;
+    this.unlistenImage_();
+    this.changed();
+  }
+
   /**
    * Tracks loading or read errors.
    *

src/ol/reproj/Tile.js

@@ -334,15 +334,15 @@ class ReprojTile extends Tile {
         }.bind(this)
       );
 
-      this.sourceTiles_.forEach(function (tile, i, arr) {
-        const state = tile.getState();
-        if (state == TileState.IDLE) {
-          tile.load();
-        }
-      });
-
       if (leftToLoad === 0) {
         setTimeout(this.reproject_.bind(this), 0);
+      } else {
+        this.sourceTiles_.forEach(function (tile, i, arr) {
+          const state = tile.getState();
+          if (state == TileState.IDLE) {
+            tile.load();
+          }
+        });
       }
     }
   }

src/ol/source/TileDebug.js

@@ -2,82 +2,10 @@
  * @module ol/source/TileDebug
  */
 
-import Tile from '../Tile.js';
-import TileState from '../TileState.js';
 import XYZ from './XYZ.js';
 import {createCanvasContext2D} from '../dom.js';
-import {getKeyZXY} from '../tilecoord.js';
 import {toSize} from '../size.js';
 
-class LabeledTile extends Tile {
-  /**
-   * @param {import("../tilecoord.js").TileCoord} tileCoord Tile coordinate.
-   * @param {import("../size.js").Size} tileSize Tile size.
-   * @param {string} text Text.
-   */
-  constructor(tileCoord, tileSize, text) {
-    super(tileCoord, TileState.LOADED);
-
-    /**
-     * @private
-     * @type {import("../size.js").Size}
-     */
-    this.tileSize_ = tileSize;
-
-    /**
-     * @private
-     * @type {string}
-     */
-    this.text_ = text;
-
-    /**
-     * @private
-     * @type {HTMLCanvasElement}
-     */
-    this.canvas_ = null;
-  }
-
-  /**
-   * Get the image element for this tile.
-   * @return {HTMLCanvasElement} Image.
-   */
-  getImage() {
-    if (this.canvas_) {
-      return this.canvas_;
-    } else {
-      const tileSize = this.tileSize_;
-      const context = createCanvasContext2D(tileSize[0], tileSize[1]);
-
-      context.strokeStyle = 'grey';
-      context.strokeRect(0.5, 0.5, tileSize[0] + 0.5, tileSize[1] + 0.5);
-
-      context.fillStyle = 'grey';
-      context.strokeStyle = 'white';
-      context.textAlign = 'center';
-      context.textBaseline = 'middle';
-      context.font = '24px sans-serif';
-      context.lineWidth = 4;
-      context.strokeText(
-        this.text_,
-        tileSize[0] / 2,
-        tileSize[1] / 2,
-        tileSize[0]
-      );
-      context.fillText(
-        this.text_,
-        tileSize[0] / 2,
-        tileSize[1] / 2,
-        tileSize[0]
-      );
-
-      this.canvas_ = context.canvas;
-      return context.canvas;
-    }
-  }
-
-  load() {}
-}
-
 /**
  * @typedef {Object} Options
  * @property {import("../proj.js").ProjectionLike} [projection='EPSG:3857'] Optional projection.
@@ -88,6 +16,8 @@ class LabeledTile extends Tile {
  * the view resolution does not match any resolution of the tile source. If 0, the nearest
  * resolution will be used. If 1, the nearest lower resolution will be used. If -1, the
  * nearest higher resolution will be used.
+ * @property {string} [template='z:{z} x:{x} y:{y}'] Template for labeling the tiles.
+ * Should include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
  */
 
 /**
@@ -95,8 +25,6 @@ class LabeledTile extends Tile {
  * A pseudo tile source, which does not fetch tiles from a server, but renders
  * a grid outline for the tile grid/projection along with the coordinates for
  * each tile. See examples/canvas-tiles for an example.
- *
- * Uses Canvas context2d, so requires Canvas support.
  * @api
  */
 class TileDebug extends XYZ {
@@ -115,39 +43,29 @@ class TileDebug extends XYZ {
       tileGrid: options.tileGrid,
       wrapX: options.wrapX !== undefined ? options.wrapX : true,
       zDirection: options.zDirection,
-    });
-  }
+      url: options.template || 'z:{z} x:{x} y:{y}',
+      tileLoadFunction: (tile, text) => {
+        const z = tile.getTileCoord()[0];
+        const tileSize = toSize(this.tileGrid.getTileSize(z));
+        const context = createCanvasContext2D(tileSize[0], tileSize[1]);
 
-  /**
-   * @param {number} z Tile coordinate z.
-   * @param {number} x Tile coordinate x.
-   * @param {number} y Tile coordinate y.
-   * @return {!LabeledTile} Tile.
-   */
-  getTile(z, x, y) {
-    const tileCoordKey = getKeyZXY(z, x, y);
-    if (this.tileCache.containsKey(tileCoordKey)) {
-      return /** @type {!LabeledTile} */ (this.tileCache.get(tileCoordKey));
-    } else {
-      const tileSize = toSize(this.tileGrid.getTileSize(z));
-      const tileCoord = [z, x, y];
-      const textTileCoord = this.getTileCoordForTileUrlFunction(tileCoord);
-      let text;
-      if (textTileCoord) {
-        text =
-          'z:' +
-          textTileCoord[0] +
-          ' x:' +
-          textTileCoord[1] +
-          ' y:' +
-          textTileCoord[2];
-      } else {
-        text = 'none';
-      }
-      const tile = new LabeledTile(tileCoord, tileSize, text);
-      this.tileCache.set(tileCoordKey, tile);
-      return tile;
-    }
+        context.strokeStyle = 'grey';
+        context.strokeRect(0.5, 0.5, tileSize[0] + 0.5, tileSize[1] + 0.5);
+
+        context.fillStyle = 'grey';
+        context.strokeStyle = 'white';
+        context.textAlign = 'center';
+        context.textBaseline = 'middle';
+        context.font = '24px sans-serif';
+        context.lineWidth = 4;
+        context.strokeText(text, tileSize[0] / 2, tileSize[1] / 2, tileSize[0]);
+        context.fillText(text, tileSize[0] / 2, tileSize[1] / 2, tileSize[0]);
+
+        /** @type {import("../ImageTile.js").default} */ (tile).setImage(
+          context.canvas
+        );
+      },
+    });
   }
 }