import type { Credit, Event, ImageryLayerFeatureInfo, ImageryProvider, ImageryTypes, Proxy, Rectangle, Request, TileDiscardPolicy, TilingScheme, } from 'cesium'; import type {Map} from 'ol'; import type {Projection} from 'ol/proj.js'; import {type TileImage} from 'ol/source.js'; import {attributionsFunctionToCredits} from '../core.js'; import {getSourceProjection} from '../util.js'; export function createEmptyCanvas(): HTMLCanvasElement { const canvas = document.createElement('canvas'); canvas.width = 1; canvas.height = 1; return canvas; } export default class OLImageryProvider implements ImageryProvider /* should not extend Cesium.ImageryProvider */ { private source_: TileImage; private projection_: Projection | undefined; private fallbackProj_: Projection | undefined; private map_: Map; private shouldRequestNextLevel: boolean; private emptyCanvas_: HTMLCanvasElement = createEmptyCanvas(); private emptyCanvasPromise_: Promise = Promise.resolve( this.emptyCanvas_, ); private tilingScheme_: TilingScheme; private ready_: boolean; private rectangle_: Rectangle; /** * When true, this model is ready to render, i.e., the external binary, image, * and shader files were downloaded and the WebGL resources were created. */ get ready(): boolean { return this.ready_; } /** * Gets the rectangle, in radians, of the imagery provided by the instance. */ get rectangle() { return this.rectangle_; } /** * Gets the tiling scheme used by the provider. */ get tilingScheme(): TilingScheme { return this.tilingScheme_; } /** * Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing * to the event, you will be notified of the error and can potentially recover from it. Event listeners * are passed an instance of {@link Cesium.TileProviderError}. */ readonly errorEvent: Event = new Cesium.Event(); /** * Gets the credit to display when this imagery provider is active. Typically this is used to credit * the source of the imagery. */ readonly credit: Credit; /** * Gets the proxy used by this provider. */ readonly proxy: Proxy; get _ready(): boolean { return this.ready_; } /** * Gets the width of each tile, in pixels. */ get tileWidth(): number { const tileGrid = this.source_.getTileGrid(); if (tileGrid) { const tileSizeAtZoom0 = tileGrid.getTileSize(0); if (Array.isArray(tileSizeAtZoom0)) { return tileSizeAtZoom0[0]; } return tileSizeAtZoom0; // same width and height } return 256; } /** * Gets the height of each tile, in pixels. */ get tileHeight(): number { const tileGrid = this.source_.getTileGrid(); if (tileGrid) { const tileSizeAtZoom0 = tileGrid.getTileSize(0); if (Array.isArray(tileSizeAtZoom0)) { return tileSizeAtZoom0[1]; } return tileSizeAtZoom0; // same width and height } return 256; } /** * Gets the maximum level-of-detail that can be requested. */ get maximumLevel(): number { const tileGrid = this.source_.getTileGrid(); if (tileGrid) { return tileGrid.getMaxZoom(); } return 18; // some arbitrary value } // FIXME: to implement, we could check the number of tiles at minzoom (for this rectangle) and return 0 if too big /** * Gets the minimum level-of-detail that can be requested. Generally, * a minimum level should only be used when the rectangle of the imagery is small * enough that the number of tiles at the minimum level is small. An imagery * provider with more than a few tiles at the minimum level will lead to * rendering problems. */ get minimumLevel() { // WARNING: Do not use the minimum level (at least until the extent is // properly set). Cesium assumes the minimumLevel to contain only // a few tiles and tries to load them all at once -- this can // freeze and/or crash the browser ! return 0; //var tg = this.source_.getTileGrid(); //return tg ? tg.getMinZoom() : 0; } /** * Gets the tile discard policy. If not undefined, the discard policy is responsible * for filtering out "missing" tiles via its shouldDiscardImage function. If this function * returns undefined, no tiles are filtered. */ get tileDiscardPolicy(): TileDiscardPolicy { return undefined; } // FIXME: this might be exposed /** * Gets a value indicating whether or not the images provided by this imagery provider * include an alpha channel. If this property is false, an alpha channel, if present, will * be ignored. If this property is true, any images without an alpha channel will be treated * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. */ get hasAlphaChannel() { return true; } // FIXME: this could be implemented by proxying to OL /** * Asynchronously determines what features, if any, are located at a given longitude and latitude within * a tile. * This function is optional, so it may not exist on all ImageryProviders. * @param x The tile X coordinate. * @param y The tile Y coordinate. * @param level The tile level. * @param longitude The longitude at which to pick features. * @param latitude The latitude at which to pick features. * @return A promise for the picked features that will resolve when the asynchronous * picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo} * instances. The array may be empty if no features are found at the given location. * It may also be undefined if picking is not supported. */ pickFeatures( x: number, y: number, level: number, longitude: number, latitude: number, ): Promise | undefined { return undefined; } /** * Special class derived from Cesium.ImageryProvider * that is connected to the given ol.source.TileImage. * @param olMap OL map * @param source Tile image source * @param [opt_fallbackProj] Projection to assume if source has no projection */ constructor(olMap: Map, source: TileImage, opt_fallbackProj: Projection) { this.source_ = source; this.projection_ = null; this.ready_ = false; this.fallbackProj_ = opt_fallbackProj || null; // cesium v107+ don't wait for ready anymore so we put somehing here while it loads this.tilingScheme_ = new Cesium.WebMercatorTilingScheme(); this.rectangle_ = null; this.map_ = olMap; this.shouldRequestNextLevel = false; const proxy = this.source_.get('olcs_proxy'); if (proxy) { if (typeof proxy === 'function') { // Duck typing a proxy this.proxy = { 'getURL': proxy, } as Proxy; } else if (typeof proxy === 'string') { this.proxy = new Cesium.DefaultProxy(proxy); } } this.source_.on('change', (e) => { this.handleSourceChanged_(); }); this.handleSourceChanged_(); } /** * Checks if the underlying source is ready and cached required data. */ private handleSourceChanged_() { if (!this.ready_ && this.source_.getState() == 'ready') { this.projection_ = getSourceProjection(this.source_) || this.fallbackProj_; const options = {numberOfLevelZeroTilesX: 1, numberOfLevelZeroTilesY: 1}; if (this.source_.getTileGrid() !== null) { // Get the number of tiles at level 0 if it is defined this.source_ .getTileGrid() .forEachTileCoord( this.projection_.getExtent(), 0, ([zoom, xIndex, yIndex]) => { options.numberOfLevelZeroTilesX = xIndex + 1; options.numberOfLevelZeroTilesY = yIndex + 1; }, ); } if (this.projection_.getCode() === 'EPSG:4326') { // Cesium zoom level 0 is OpenLayers zoom level 1 for layer in EPSG:4326 with a single tile on level 0 this.shouldRequestNextLevel = options.numberOfLevelZeroTilesX === 1 && options.numberOfLevelZeroTilesY === 1; this.tilingScheme_ = new Cesium.GeographicTilingScheme(options); } else if (this.projection_.getCode() === 'EPSG:3857') { this.shouldRequestNextLevel = false; this.tilingScheme_ = new Cesium.WebMercatorTilingScheme(options); } else { return; } this.rectangle_ = this.tilingScheme_.rectangle; this.ready_ = true; } } /** * Generates the proper attributions for a given position and zoom * level. * @param x * @param y * @param level */ getTileCredits(x: number, y: number, level: number): Credit[] { const attributionsFunction = this.source_.getAttributions(); if (!attributionsFunction) { return []; } const extent = this.map_.getView().calculateExtent(this.map_.getSize()); const center = this.map_.getView().getCenter(); const zoom = this.shouldRequestNextLevel ? level + 1 : level; return attributionsFunctionToCredits( attributionsFunction, zoom, center, extent, ); } requestImage( x: number, y: number, level: number, request?: Request, ): Promise | undefined { const tileUrlFunction = this.source_.getTileUrlFunction(); if (tileUrlFunction && this.projection_) { const z_ = this.shouldRequestNextLevel ? level + 1 : level; let url = tileUrlFunction.call( this.source_, [z_, x, y], 1, this.projection_, ); if (this.proxy) { url = this.proxy.getURL(url); } if (url) { // It is probably safe to cast here return Cesium.ImageryProvider.loadImage( this, url, ) as Promise; } return this.emptyCanvasPromise_; } // return empty canvas to stop Cesium from retrying later return this.emptyCanvasPromise_; } }