mirror of
https://github.com/Leaflet/Leaflet.git
synced 2025-07-25 15:38:54 +00:00
TileStitcher class (anti-gap TileLayer)
Signed-off-by: Iván Sánchez Ortega <ivan@sanchezortega.es>
This commit is contained in:
Iván Sánchez Ortega
204
debug/tests/tile-stitcher.html
Normal file
204
debug/tests/tile-stitcher.html
Normal file
@ -0,0 +1,204 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
<title>Leaflet debug page - Tile Events</title>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=0" />
|
||||||
|
<link rel="stylesheet" href="../../dist/leaflet.css" />
|
||||||
|
<link rel="stylesheet" href="../css/screen.css" />
|
||||||
|
<style>
|
||||||
|
#map {
|
||||||
|
margin: 0;
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.redTile {
|
||||||
|
border: red 1px solid;
|
||||||
|
line-height: 256px;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
table th,
|
||||||
|
table td {
|
||||||
|
border: 1px #444 solid;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script type="importmap">
|
||||||
|
{
|
||||||
|
"imports": {
|
||||||
|
"leaflet": "../../dist/leaflet-src.js"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p>
|
||||||
|
Keep track of how many tileload/tileunload events are being fired. The
|
||||||
|
counts should always match. See
|
||||||
|
<a href="https://github.com/Leaflet/Leaflet/issues/4093">#4093</a>,
|
||||||
|
<a href="https://github.com/Leaflet/Leaflet/issues/4193">#4193</a>
|
||||||
|
</p>
|
||||||
|
<div id="map"></div>
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th></th>
|
||||||
|
<th>Start</th>
|
||||||
|
<th>Load</th>
|
||||||
|
<th>Error</th>
|
||||||
|
<th>Unload</th>
|
||||||
|
<th>Visible</th>
|
||||||
|
<th>
|
||||||
|
Grid load
|
||||||
|
<tr>
|
||||||
|
<th>Grid</th>
|
||||||
|
<td id="grid-tileloadstart"></td>
|
||||||
|
<td id="grid-tileload"></td>
|
||||||
|
<td id="grid-tileerror"></td>
|
||||||
|
<td id="grid-tileunload"></td>
|
||||||
|
<td id="grid-visible"></td>
|
||||||
|
<td id="grid-load">
|
||||||
|
<tr>
|
||||||
|
<th>Positron</th>
|
||||||
|
<td id="positron-tileloadstart"></td>
|
||||||
|
<td id="positron-tileload"></td>
|
||||||
|
<td id="positron-tileerror"></td>
|
||||||
|
<td id="positron-tileunload"></td>
|
||||||
|
<td id="positron-visible"></td>
|
||||||
|
<td id="positron-load"></td>
|
||||||
|
</tr>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<p>start = unload + visible on screen</p>
|
||||||
|
<div><button id="dc">DC</button>(flyTo)</div>
|
||||||
|
<div><button id="sf">SF</button>(setView, 5 sec)</div>
|
||||||
|
<div><button id="trd">TRD</button>(flyTo 20 sec)</div>
|
||||||
|
<div><button id="lnd">LND</button>(fract. zoom)</div>
|
||||||
|
<div><button id="kyiv">KIEV</button>(setView, fract. zoom)</div>
|
||||||
|
<div><button id="mad">MAD</button>(fitBounds)</div>
|
||||||
|
<div><button id="nul">NUL</button>(image overlay)</div>
|
||||||
|
<div><button id="stop">stop</button></div>
|
||||||
|
<script type="module">
|
||||||
|
import {Map, TileStitcher, TileLayer, GridLayer, Point, DomUtil} from 'leaflet';
|
||||||
|
|
||||||
|
const kyiv = [50.5, 30.5];
|
||||||
|
const lnd = [51.51, -0.12];
|
||||||
|
const sf = [37.77, -122.42];
|
||||||
|
const dc = [38.91, -77.04];
|
||||||
|
const trd = [63.41, 10.41];
|
||||||
|
const madBounds = [
|
||||||
|
[40.7, -4.19],
|
||||||
|
[40.12, -3.31],
|
||||||
|
];
|
||||||
|
|
||||||
|
const map = new Map('map', {
|
||||||
|
center: [35, -122],
|
||||||
|
zoom: 5.75,
|
||||||
|
// zoom: 5,
|
||||||
|
zoomSnap: 0.25,
|
||||||
|
fadeAnimation: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
const positron = new TileLayer('https://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png');
|
||||||
|
|
||||||
|
const grid = window.grid = new TileStitcher({
|
||||||
|
attribution: 'Grid Layer',
|
||||||
|
// tileSize: new Point(150, 80)
|
||||||
|
tileSize: new Point(256, 256),
|
||||||
|
zIndex: 5,
|
||||||
|
});
|
||||||
|
|
||||||
|
grid.createTile = function(coords, done) {
|
||||||
|
var canvas = document.createElement('canvas');
|
||||||
|
|
||||||
|
var tileSize = grid.getTileSize();
|
||||||
|
canvas.setAttribute('width', tileSize.x);
|
||||||
|
canvas.setAttribute('height', tileSize.y);
|
||||||
|
|
||||||
|
var ctx = canvas.getContext('2d');
|
||||||
|
ctx.fillStyle = 'rgba(245,245,220,0.3)';
|
||||||
|
ctx.fillRect(0, 0, tileSize.x, tileSize.y);
|
||||||
|
|
||||||
|
ctx.strokeStyle = 'green';
|
||||||
|
ctx.fillStyle = 'green';
|
||||||
|
|
||||||
|
ctx.strokeRect(2, 2, tileSize.x - 4, tileSize.y - 4);
|
||||||
|
|
||||||
|
ctx.font = (tileSize.x / 10) + "px Sans"
|
||||||
|
ctx.fillText( coords.x + "," + coords.y + "," + coords.z,
|
||||||
|
tileSize.x / 4 + Math.random() * 10,
|
||||||
|
tileSize.y * 3/4 + Math.random() * 10);
|
||||||
|
|
||||||
|
// return canvas.toDataURL();
|
||||||
|
setTimeout(()=>{done(null, canvas)}, Math.random() * 500);
|
||||||
|
return canvas;
|
||||||
|
};
|
||||||
|
|
||||||
|
const gridCounts = {
|
||||||
|
tileload: 0,
|
||||||
|
tileerror: 0,
|
||||||
|
tileloadstart: 0,
|
||||||
|
tileunload: 0,
|
||||||
|
load: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
const positronCounts = {
|
||||||
|
tileload: 0,
|
||||||
|
tileerror: 0,
|
||||||
|
tileloadstart: 0,
|
||||||
|
tileunload: 0,
|
||||||
|
load: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
grid.on('tileerror', (ev) => {
|
||||||
|
debugger;
|
||||||
|
});
|
||||||
|
|
||||||
|
grid.on('tileload tileunload tileerror tileloadstart load', (ev) => {
|
||||||
|
document.getElementById(`grid-${ev.type}`).innerHTML = ++gridCounts[ev.type];
|
||||||
|
document.getElementById('grid-visible').innerHTML = grid._container.querySelectorAll('.leaflet-tile').length;
|
||||||
|
});
|
||||||
|
|
||||||
|
positron.on('tileload tileunload tileerror tileloadstart load', (ev) => {
|
||||||
|
document.getElementById(`positron-${ev.type}`).innerHTML = ++positronCounts[ev.type];
|
||||||
|
document.getElementById('positron-visible').innerHTML = positron._container.querySelectorAll('.leaflet-tile').length;
|
||||||
|
});
|
||||||
|
|
||||||
|
map.addLayer(positron);
|
||||||
|
map.addLayer(grid);
|
||||||
|
|
||||||
|
document.getElementById('dc').onclick = function () {
|
||||||
|
map.flyTo(dc, 10);
|
||||||
|
};
|
||||||
|
document.getElementById('sf').onclick = function () {
|
||||||
|
map.setView(sf, 10, {duration: 5, animate: true});
|
||||||
|
};
|
||||||
|
document.getElementById('trd').onclick = function () {
|
||||||
|
map.flyTo(trd, 10, {duration: 20});
|
||||||
|
};
|
||||||
|
document.getElementById('lnd').onclick = function () {
|
||||||
|
map.flyTo(lnd, 9.25);
|
||||||
|
};
|
||||||
|
document.getElementById('kyiv').onclick = function () {
|
||||||
|
map.setView(kyiv, 9.25);
|
||||||
|
};
|
||||||
|
document.getElementById('nul').onclick = function () {
|
||||||
|
map.flyTo([0, 0], 10);
|
||||||
|
};
|
||||||
|
document.getElementById('mad').onclick = function () {
|
||||||
|
map.fitBounds(madBounds);
|
||||||
|
};
|
||||||
|
document.getElementById('stop').onclick = function () {
|
||||||
|
map.stop();
|
||||||
|
};
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
235
src/layer/tile/TileStitcher.js
Normal file
235
src/layer/tile/TileStitcher.js
Normal file
@ -0,0 +1,235 @@
|
|||||||
|
import {GridLayer} from './GridLayer.js';
|
||||||
|
import {TileLayer} from './TileLayer.js';
|
||||||
|
import * as DomUtil from '../../dom/DomUtil.js';
|
||||||
|
import {Point} from '../../geometry/Point.js';
|
||||||
|
import {Bounds} from '../../geometry/Bounds.js';
|
||||||
|
import Browser from '../../core/Browser.js';
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
* @class TileStitcher
|
||||||
|
* @inherits TileLayer
|
||||||
|
*
|
||||||
|
* Works as `TileLayer`, but implements logic to avoid [1-px gaps between tiles](https://github.com/Leaflet/Leaflet/issues/3575).
|
||||||
|
*
|
||||||
|
* Tiles are internally stitched into a 2D canvas (one such canvas per zoom level).
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
export const TileStitcher = TileLayer.extend({
|
||||||
|
|
||||||
|
_onUpdateLevel(z, zoom) {
|
||||||
|
this._levels[z].canvas.style.zIndex = this.options.maxZoom - Math.abs(zoom - z);
|
||||||
|
},
|
||||||
|
|
||||||
|
_onRemoveLevel(z) {
|
||||||
|
this._levels[z].canvas.remove();
|
||||||
|
},
|
||||||
|
|
||||||
|
_onCreateLevel(level) {
|
||||||
|
level.canvas = DomUtil.create(
|
||||||
|
'canvas',
|
||||||
|
'leaflet-tile-container leaflet-zoom-animated',
|
||||||
|
this._container
|
||||||
|
);
|
||||||
|
level.ctx = level.canvas.getContext('2d');
|
||||||
|
this._resetCanvasSize(level);
|
||||||
|
},
|
||||||
|
|
||||||
|
_removeTile(key) {
|
||||||
|
const tile = this._tiles[key],
|
||||||
|
level = this._levels[tile.coords.z],
|
||||||
|
tileSize = this.getTileSize();
|
||||||
|
|
||||||
|
if (level) {
|
||||||
|
// Where in the canvas should this tile go?
|
||||||
|
const offset = new Point(tile.coords.x, tile.coords.y)
|
||||||
|
.subtract(level.canvasRange.min)
|
||||||
|
.scaleBy(this.getTileSize());
|
||||||
|
|
||||||
|
level.ctx.clearRect(offset.x, offset.y, tileSize.x, tileSize.y);
|
||||||
|
}
|
||||||
|
|
||||||
|
GridLayer.prototype._removeTile.call(this, key);
|
||||||
|
},
|
||||||
|
|
||||||
|
_resetCanvasSize(level) {
|
||||||
|
|
||||||
|
const buff = this.options.keepBuffer,
|
||||||
|
pixelBounds = this._getTiledPixelBounds(this._map.getCenter()),
|
||||||
|
tileRange = this._pxBoundsToTileRange(pixelBounds),
|
||||||
|
tileSize = this.getTileSize();
|
||||||
|
|
||||||
|
tileRange.min = tileRange.min.subtract([buff, buff]); // This adds the no-prune buffer
|
||||||
|
tileRange.max = tileRange.max.add([buff + 1, buff + 1]);
|
||||||
|
|
||||||
|
const pixelRange = new Bounds(
|
||||||
|
tileRange.min.scaleBy(tileSize),
|
||||||
|
tileRange.max.add([1, 1]).scaleBy(tileSize) // This prevents an off-by-one when checking if tiles are inside
|
||||||
|
),
|
||||||
|
neededSize = pixelRange.max.subtract(pixelRange.min);
|
||||||
|
|
||||||
|
let mustRepositionCanvas = false;
|
||||||
|
|
||||||
|
// Resize the canvas, if needed, and only to make it bigger.
|
||||||
|
if (
|
||||||
|
neededSize.x > level.canvas.width ||
|
||||||
|
neededSize.y > level.canvas.height
|
||||||
|
) {
|
||||||
|
// Resizing canvases erases the currently drawn content, I'm afraid.
|
||||||
|
// To keep it, dump the pixels to another canvas, then display it on
|
||||||
|
// top. This could be done with getImageData/putImageData, but that
|
||||||
|
// would break for tainted canvases (in non-CORS tilesets)
|
||||||
|
const oldSize = {x: level.canvas.width, y: level.canvas.height};
|
||||||
|
// console.info('Resizing canvas from ', oldSize, 'to ', neededSize);
|
||||||
|
|
||||||
|
const tmpCanvas = DomUtil.create('canvas');
|
||||||
|
tmpCanvas.style.width = `${tmpCanvas.width = oldSize.x }px`;
|
||||||
|
tmpCanvas.style.height = `${tmpCanvas.height = oldSize.y }px`;
|
||||||
|
tmpCanvas.getContext('2d').drawImage(level.canvas, 0, 0);
|
||||||
|
// var data = level.ctx.getImageData(0, 0, oldSize.x, oldSize.y);
|
||||||
|
|
||||||
|
level.canvas.style.width = `${level.canvas.width = neededSize.x }px`;
|
||||||
|
level.canvas.style.height = `${level.canvas.height = neededSize.y }px`;
|
||||||
|
level.ctx.drawImage(tmpCanvas, 0, 0);
|
||||||
|
// level.ctx.putImageData(data, 0, 0, 0, 0, oldSize.x, oldSize.y);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Translate the canvas contents if it's moved around
|
||||||
|
if (level.canvasRange) {
|
||||||
|
const offset = level.canvasRange.min
|
||||||
|
.subtract(tileRange.min)
|
||||||
|
.scaleBy(this.getTileSize());
|
||||||
|
|
||||||
|
// console.info('Offsetting by ', offset);
|
||||||
|
|
||||||
|
if (!Browser.safari) {
|
||||||
|
// By default, canvases copy things "on top of" existing pixels, but we want
|
||||||
|
// this to *replace* the existing pixels when doing a drawImage() call.
|
||||||
|
// This will also clear the sides, so no clearRect() calls are needed to make room
|
||||||
|
// for the new tiles.
|
||||||
|
level.ctx.globalCompositeOperation = 'copy';
|
||||||
|
level.ctx.drawImage(level.canvas, offset.x, offset.y);
|
||||||
|
level.ctx.globalCompositeOperation = 'source-over';
|
||||||
|
} else {
|
||||||
|
// Safari clears the canvas when copying from itself :-(
|
||||||
|
if (!this._tmpCanvas) {
|
||||||
|
const t = (this._tmpCanvas = DomUtil.create('canvas'));
|
||||||
|
t.width = level.canvas.width;
|
||||||
|
t.height = level.canvas.height;
|
||||||
|
this._tmpContext = t.getContext('2d');
|
||||||
|
}
|
||||||
|
this._tmpContext.clearRect(
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
level.canvas.width,
|
||||||
|
level.canvas.height
|
||||||
|
);
|
||||||
|
this._tmpContext.drawImage(level.canvas, 0, 0);
|
||||||
|
level.ctx.clearRect(0, 0, level.canvas.width, level.canvas.height);
|
||||||
|
level.ctx.drawImage(this._tmpCanvas, offset.x, offset.y);
|
||||||
|
}
|
||||||
|
|
||||||
|
mustRepositionCanvas = true; // Wait until new properties are set
|
||||||
|
}
|
||||||
|
|
||||||
|
level.canvasRange = tileRange;
|
||||||
|
level.canvasPxRange = pixelRange;
|
||||||
|
level.canvasOrigin = pixelRange.min;
|
||||||
|
|
||||||
|
// console.log('Canvas tile range: ', level, tileRange.min, tileRange.max );
|
||||||
|
// console.log('Canvas pixel range: ', pixelRange.min, pixelRange.max );
|
||||||
|
// console.log('Level origin: ', level.origin );
|
||||||
|
|
||||||
|
if (mustRepositionCanvas) {
|
||||||
|
this._setCanvasZoomTransform(
|
||||||
|
level,
|
||||||
|
this._map.getCenter(),
|
||||||
|
this._map.getZoom()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// / set transform/position of canvas, in addition to the transform/position of the individual tile container
|
||||||
|
_setZoomTransform(level, center, zoom) {
|
||||||
|
TileLayer.prototype._setZoomTransform.call(this, level, center, zoom);
|
||||||
|
if (level.canvas) {
|
||||||
|
this._setCanvasZoomTransform(level, center, zoom);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// This will get called twice:
|
||||||
|
// * From _setZoomTransform
|
||||||
|
// * When the canvas has shifted due to a new tile being loaded
|
||||||
|
_setCanvasZoomTransform(level, center, zoom) {
|
||||||
|
const scale = this._map.getZoomScale(zoom, level.zoom),
|
||||||
|
translate = level.canvasOrigin
|
||||||
|
.multiplyBy(scale)
|
||||||
|
.subtract(this._map._getNewPixelOrigin(center, zoom))
|
||||||
|
.round();
|
||||||
|
|
||||||
|
DomUtil.setTransform(level.canvas, translate, scale);
|
||||||
|
},
|
||||||
|
|
||||||
|
_onOpaqueTile(tile) {
|
||||||
|
// Guard against an NS_ERROR_NOT_AVAILABLE (or similar) exception
|
||||||
|
// when a non-image-tile has been loaded (e.g. a WMS error).
|
||||||
|
// Checking for tile.el.complete is not enough, as it has been
|
||||||
|
// already marked as loaded and ready somehow.
|
||||||
|
try {
|
||||||
|
this.dumpPixels(tile.coords, tile.el);
|
||||||
|
} catch (ex) {
|
||||||
|
return this.fire('tileerror', {
|
||||||
|
error: `Could not copy tile pixels: ${ ex}`,
|
||||||
|
tile,
|
||||||
|
coods: tile.coords,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// If dumping the pixels was successful, then hide the tile.
|
||||||
|
// Do not remove the tile itself, as it is needed to check if the whole
|
||||||
|
// level (and its canvas) should be removed (via level.el.children.length)
|
||||||
|
tile.el.style.display = 'none';
|
||||||
|
},
|
||||||
|
|
||||||
|
// @section Extension methods
|
||||||
|
// @uninheritable
|
||||||
|
|
||||||
|
// @method dumpPixels(coords: Object, imageSource: CanvasImageSource): this
|
||||||
|
// Dumps pixels from the given `CanvasImageSource` into the layer, into
|
||||||
|
// the space for the tile represented by the `coords` tile coordinates (an object
|
||||||
|
// like `{x: Number, y: Number, z: Number}`; the image source must have the
|
||||||
|
// same size as the `tileSize` option for the layer.
|
||||||
|
dumpPixels(coords, imageSource) {
|
||||||
|
|
||||||
|
const level = this._levels[coords.z],
|
||||||
|
tileSize = this.getTileSize();
|
||||||
|
|
||||||
|
if (!level.canvasRange) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if the tile is inside the currently visible map bounds
|
||||||
|
// There is a possible race condition when tiles are loaded after they
|
||||||
|
// have been panned outside of the map.
|
||||||
|
if (!level.canvasRange.contains(coords)) {
|
||||||
|
this._resetCanvasSize(level);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Where in the canvas should this tile go?
|
||||||
|
const offset = new Point(coords.x, coords.y)
|
||||||
|
.subtract(level.canvasRange.min)
|
||||||
|
.scaleBy(this.getTileSize());
|
||||||
|
|
||||||
|
level.ctx.drawImage(imageSource, offset.x, offset.y, tileSize.x, tileSize.y);
|
||||||
|
|
||||||
|
// Consider the tile as complete - should happen automatically for images,
|
||||||
|
// but canvases (or `CanvasImageSource`s other than `HTMLImageElement`s)
|
||||||
|
// need this property to be set manually in order for pruning to work.
|
||||||
|
imageSource.complete ??= true;
|
||||||
|
|
||||||
|
// TODO: Clear the pixels of other levels' canvases where they overlap
|
||||||
|
// this newly dumped tile.
|
||||||
|
return this;
|
||||||
|
},
|
||||||
|
});
|
||||||
@ -3,3 +3,4 @@ import {TileLayer} from './TileLayer.js';
|
|||||||
import {TileLayerWMS} from './TileLayer.WMS.js';
|
import {TileLayerWMS} from './TileLayer.WMS.js';
|
||||||
TileLayer.WMS = TileLayerWMS;
|
TileLayer.WMS = TileLayerWMS;
|
||||||
export {TileLayer};
|
export {TileLayer};
|
||||||
|
export {TileStitcher} from './TileStitcher.js';
|
||||||
|
|||||||
Reference in New Issue
Block a user