isard 1.1.0 → 1.3.0

package/dist/map/workers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workers.js","sourceRoot":"","sources":["../../src/map/workers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,oBAAoB,EAAwC,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAI9E,iDAAiD;AACjD,MAAM,OAAO,UAAU;IACrB,iCAAiC;IACxB,GAAG,CAAe;IACV,OAAO,CAA2B;IACnD,gEAAgE;IAC/C,IAAI,CAAgB;IACrC,8DAA8D;IAC7C,KAAK,CAAS;IAC/B,4CAA4C;IACpC,MAAM,CAA6B;IAC3C;mDAC+C;IAC9B,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;IAEnE,4EAA4E;IAC5E,YAAY,GAAiB,EAAE,OAAiC,EAAE,IAAmB,EAAE,KAAa;QAClG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,KAAc,EAAE,GAAkB;QACrC,MAAM,MAAM,GAAG,kBAAkB,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,IAAI,MAAM,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QAElC,IAAI,OAAO,KAAK,MAAM,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACjE,IAAI,CAAC,MAAM,KAAK,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAErD,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC3C,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IACrE,CAAC;IAED,4BAA4B;IAC5B,SAAS;QACP,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,oEAAoE;IAC3D,kBAAkB,GAAuB,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CACtE,IAAI,CAAC,YAAY,EAAE,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAEhE,kGAAkG;IACzF,aAAa,GAAG,CAAC,GAAW,EAAE,QAAqB,EAAE,KAAc,EAAiB,EAAE;QAC7F,MAAM,GAAG,GAAG,GAAG,QAAQ,IAAI,KAAK,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;QAE1B,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAE9E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAErC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEe,aAAa,GAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CACrF,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IAE/E;;;OAGG;IACK,YAAY;QAClB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QAClG,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,eAAe,KAAK,WAAW;YAAE,OAAO,SAAS,CAAC;QAE9F,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/**\n * A map's workers: the pool drawing vector tiles, shared by the map's `VectorTiles`, which also decodes the relief and\n * reprojects rasters off the page; and the loaders of the relief, one per tile source.\n */\n\nimport type { RemoteReprojection } from '../basemap/grid.ts';\nimport { encodedTerrainLoader, type PngEncoding, type RemoteHeights } from '../basemap/terrain.ts';\nimport { BasemapWorkers, defaultWorkerCount } from '../basemap/workerpool.ts';\nimport type { TerrainLoader } from '../settings.ts';\nimport type { GeoMapOptions } from '../types.ts';\n\n/** The workers of a map, created on first use */\nexport class MapWorkers {\n  /** URL of the workers' script */\n  readonly url: string | URL;\n  private readonly workers: GeoMapOptions['workers'];\n  /** The map is destroyed: nothing more is sent to the workers */\n  private readonly gone: () => boolean;\n  /** Whose requests the workers' answer (cancelled together) */\n  private readonly owner: object;\n  /** The shared pool, created on first use */\n  private shared: BasemapWorkers | undefined;\n  /** The loaders of the relief by encoding, URL and floor: the same loader for the same tiles (the engine keeps its\n   * tiles when only the exaggeration changes) */\n  private readonly terrainLoaders = new Map<string, TerrainLoader>();\n\n  /** `workers`: the map's option (false or 0, no worker); `owner`: the map */\n  constructor(url: string | URL, workers: GeoMapOptions['workers'], gone: () => boolean, owner: object) {\n    this.url = url;\n    this.workers = workers;\n    this.gone = gone;\n    this.owner = owner;\n  }\n\n  /**\n   * The workers for a `VectorTiles`: the shared pool, or a pool of its own (`own`, to stop with it) when it asks for\n   * another count or URL\n   */\n  pool(count?: number, url?: string | URL): { pool: BasemapWorkers; own: boolean } {\n    const shared = defaultWorkerCount();\n    const workers = Math.max(1, count ?? shared);\n    const workerUrl = url ?? this.url;\n\n    if (workers === shared && String(workerUrl) === String(this.url)) {\n      this.shared ??= new BasemapWorkers(shared, this.url);\n\n      return { pool: this.shared, own: false };\n    }\n\n    return { pool: new BasemapWorkers(workers, workerUrl), own: true };\n  }\n\n  /** Stops the shared pool */\n  terminate(): void {\n    this.shared?.terminate();\n    this.shared = undefined;\n  }\n\n  /** Rasters reprojected by the workers (in the page without them) */\n  readonly remoteReprojection: RemoteReprojection = (job, tile, signal) =>\n    this.decodingPool()?.reproject(job, tile, signal, this.owner);\n\n  /** The loader of the relief tiles of `url` in a PNG encoding (one per URL, encoding and floor) */\n  readonly terrainLoader = (url: string, encoding: PngEncoding, floor?: number): TerrainLoader => {\n    const key = `${encoding} ${floor ?? ''} ${url}`;\n    const cached = this.terrainLoaders.get(key);\n\n    if (cached) return cached;\n\n    const loader = encodedTerrainLoader(url, encoding, floor, this.remoteHeights);\n\n    this.terrainLoaders.set(key, loader);\n\n    return loader;\n  };\n\n  private readonly remoteHeights: RemoteHeights = (url, encoding, floor, tile, signal) =>\n    this.decodingPool()?.heights(url, encoding, floor, tile, signal, this.owner);\n\n  /**\n   * The workers decoding the relief and reprojecting rasters: the shared pool, unless the map has no workers\n   * (`workers: false` or 0, or none in this browser): that is done in the page then\n   */\n  private decodingPool(): BasemapWorkers | undefined {\n    const workers = this.workers;\n\n    if (this.gone() || workers === false || (workers !== undefined && workers <= 0)) return undefined;\n    if (typeof Worker === 'undefined' || typeof OffscreenCanvas === 'undefined') return undefined;\n\n    return this.pool().pool;\n  }\n}\n"]}

package/dist/map.d.ts

@@ -2,109 +2,79 @@
  * The map: canvas, camera, layers, events, overlays, credits and the frame loop. Frames are drawn on demand only: an
  * idle map costs nothing. Hover events are coalesced to one per frame, so the values computed for a mouse position are
  * drawn in the same frame. The engine's loading is in engine-loader.ts, its settings from the options in settings.ts,
- * the camera animations in animation.ts.
+ * the camera animations in animation.ts; the parts of the map with a state of their own (the drawing order of the
+ * layers, the overlays and controls, the frame loop, the hover picking, the workers…) in map/.
  */
-import { type PmtilesOptions, VectorTiles, type VectorTilesOptions } from './basemap/vectortiles.ts';
+import { type PmtilesOptions } from './basemap/pmtileslayer.ts';
+import { VectorTiles, type VectorTilesOptions } from './basemap/vectortiles.ts';
 import { ExtrusionLayer, type ExtrusionOptions } from './layers/extrusions.ts';
 import { CircleLayer, type CircleOptions, FillLayer, type FillOptions, LineLayer, type LineOptions } from './layers/features.ts';
-import { type ImageOptions, type Pixels } from './layers/icons.ts';
+import type { ImageOptions, Pixels } from './layers/icons.ts';
 import { CustomLayer, type CustomLayerInterface, GroundLayer, type GroundOptions, type Layer, ModelLayer, type ModelOptions, NetworkLayer, RasterLayer, Tiles3dLayer } from './layers/layers.ts';
 import { type PanoramaOptions, type Panoramas } from './layers/panoramas.ts';
 import { PointCloudLayer, type PointCloudOptions } from './layers/pointclouds.ts';
 import { SymbolLayer, type SymbolOptions } from './layers/symbols.ts';
-import type { AnimationOptions, AtmosphereOptions, Basemap, FeatureHit, FirstPersonView, FlyToOptions, GeoMapOptions, LoadingMode, LonLat, MapEvents, NetworkOptions, Point, Projection, RasterOptions, SwipeOptions, TerrainModel, TerrainOptions, Tiles3dOptions, ViewshedOptions } from './types.ts';
+import { type HoverPicking } from './map/hover-pick.ts';
+import { type LayerSpec } from './map/layer-spec.ts';
+import type { AnimationOptions, AtmosphereOptions, Basemap, FeatureHit, FirstPersonView, FlyToOptions, GeoMapOptions, LoadingMode, LonLat, MapEvents, NetworkOptions, Point, Projection, RasterOptions, SunOptions, SwipeOptions, TerrainModel, TerrainOptions, Tiles3dOptions, ViewshedOptions } from './types.ts';
 import { type Control, type ControlPosition } from './ui/controls.ts';
 import type { Camera, PickHit, RasterLayerStats } from './wasm/isard.js';
+export type { LayerSpec } from './map/layer-spec.ts';
 /** A map (see `GeoMap.create`); layers take it as their host */
 export declare class GeoMap {
     #private;
     readonly canvas: HTMLCanvasElement;
-    /** Layers new layers go under */
-    private readonly onTop;
-    /** The vector basemap, if any: its tiles' workers and its labels */
-    private vector;
-    private readonly glyphsUrl;
-    private readonly basemapWorkerUrl;
-    /** Texture size of the vector basemap's tiles */
-    private readonly basemapTileSize;
+    /** The engine class (core, or with 3D Tiles) and the engine with 3D Tiles loaded when needed */
+    private readonly engines;
+    /** The layers in drawing order and those kept on top */
+    private readonly stack;
+    /** The basemap and the hillshade */
+    private readonly basemaps;
+    /** The glyphs and icons of the symbol layers */
+    private readonly atlases;
+    /** The workers of the vector tiles, the relief and the reprojected rasters */
+    private readonly workers;
     private readonly container;
-    /** Markers and popups, over the canvas */
-    private readonly overlay;
-    private readonly corners;
-    private readonly controls;
-    private readonly positioned;
-    /** Canvas size in CSS pixels, kept on resize so placing overlays never reads the layout */
-    private size;
-    /** Layers in drawing order (bottom first), to recreate them after a context loss */
-    private readonly layers;
+    /** The canvas in the container, the markers and popups over it, the controls in its corners */
+    private readonly overlays;
     private readonly settings;
     /** The WebGL context is lost: nothing is drawn until it is restored */
     private lost;
+    private gone;
     private readonly listeners;
+    /** Frames drawn on demand, with their events */
+    private readonly frames;
     private readonly resizeObserver;
     private readonly interaction;
-    private loader;
-    /** The class of the engine: without 3D Tiles until a 3D Tiles layer is added, unless asked for from the start */
-    private engineClass;
-    /** The module of the engine with 3D Tiles once it runs this map (the decoding workers run it too) */
-    private tiles3dModule;
-    /** The engine with 3D Tiles is loading, for the 3D Tiles layers added on the core engine */
-    private upgrading;
-    /** What loading the engine with 3D Tiles and its workers needs */
-    private readonly tiles3dOptions;
-    private gone;
     /** The map is of the Earth: a basemap by default */
     private readonly earth;
     /** The body, as the option named it */
     private readonly body;
-    private basemap;
-    private hillshade;
-    /** Called when the credits of the layers or relief change (the attribution controls) */
-    private readonly attributionListeners;
-    /** Credits of the raster layers that have some (basemaps, hillshade, the Géoplateforme's rasters…) */
-    private readonly rasterCredits;
-    private animation;
-    private hoverPoint;
-    /** Frame polling the engine for the answer of the hover picking, 0 if none */
-    private hoverPoll;
-    /** Polls of the hover picking under way: given up after `MAX_POLLS` (an answer that never comes) */
-    private hoverPolls;
+    /** Credits of the raster layers that have some, and the attribution controls told when they change */
+    private readonly credits;
+    /** The picking for 'hoverfeature', its answer emitted on a later frame */
+    private readonly hoverPick;
     /** What 'hoverfeature' looks for: within `radius` CSS pixels, in `layers` only if given */
-    hoverPicking: {
-        radius?: number;
-        layers?: readonly Layer[];
-    };
-    private frameRequest;
-    private lastCamera;
-    /** The camera moved since the last 'moveend' */
-    private moving;
-    /** The last frame found everything loaded ('idle' sent) */
-    private settled;
-    private inFrame;
-    /** The camera of the frame being drawn: what `getCamera` gives the custom layers while the engine is busy */
-    private frameCamera;
+    hoverPicking: HoverPicking;
     /** Vector tiles made by `vectorTiles()`, destroyed with the map */
     private readonly vectorSets;
-    /** The workers drawing vector tiles, shared by every `VectorTiles` of the map; created on first use */
-    private basemapPool;
     /** Stops watching the device pixel ratio */
-    private unwatchRatio;
+    private readonly unwatchRatio;
     /** Stops following the page's request headers (`setRequestHeaders`) */
     private unwatchHeaders;
     /** Stops listening to the canvas's context loss and restoration */
     private readonly unwatchContext;
-    /** The loaders of the relief by encoding, URL and floor: the same loader for the same tiles (the engine keeps its
-     * tiles when only the exaggeration changes) */
-    private readonly terrainLoaders;
     /** Loads the engine (once per page) and creates a map filling `container` */
     static create(container: HTMLElement, given?: GeoMapOptions): Promise<GeoMap>;
     private constructor();
     /** The element the map was created in */
     getContainer(): HTMLElement;
     getCanvas(): HTMLCanvasElement;
+    /** Layers in drawing order (bottom first) */
+    private get layers();
+    /** Layers new layers go under */
+    private get onTop();
     private createEngine;
-    /** The decoding workers of 3D Tiles, with the engine that has them (they run its module) and unless turned off */
-    private startLoader;
     /** A 3D Tiles layer or a model on the core engine: loads the engine with 3D Tiles, then rebuilds the map on it
      * (camera, settings and layers kept, as after a context loss); the layer is created then */
     private upgrade;
@@ -126,17 +96,12 @@ export declare class GeoMap {
     /**
      * Compares two states of a place: `layers` shown on one side of a vertical line only, at `position` CSS pixels
      * from the left of the map (left of it by default, `side: 'right'` for the other), the layers beneath them on the
-     * other side. Set again as the line moves (a slider, a drag); undefined stops
+     * other side; `other`: layers shown on the other side only (two meshes of a place, each on its side). Set again as
+     * the line moves (a slider, a drag); undefined stops
      */
     setSwipe(options: SwipeOptions | undefined): void;
     private applySwipe;
-    /** Takes a layer out of the drawing order (to put it back elsewhere, or for good) */
-    private unlist;
     private addLayer;
-    /** Index in the engine of the layer at `index`: the layers waiting for the engine with 3D Tiles are not in it yet */
-    private engineIndex;
-    /** Moves a layer under all the others */
-    private toBottom;
     /** Listens to an event; returns the function that stops listening */
     on<K extends keyof MapEvents>(type: K, listener: (event: MapEvents[K]) => void): () => void;
     /**
@@ -171,9 +136,10 @@ export declare class GeoMap {
         readonly elevationAt: (lonLat: LonLat) => number | undefined;
         readonly metersPerPixel: (point?: Point) => number | undefined;
     };
-    /** What is drawn over the scene, together: `viewshed` (`setViewshed`), `swipe` (`setSwipe`) */
+    /** What is drawn over the scene, together: `viewshed` (`setViewshed`), `sun` (`setSun`), `swipe` (`setSwipe`) */
     readonly effects: {
         readonly viewshed: (options: ViewshedOptions | readonly ViewshedOptions[] | undefined) => void;
+        readonly sun: (options: SunOptions | undefined) => void;
         readonly swipe: (options: SwipeOptions | undefined) => void;
     };
     getCamera(): Camera;
@@ -199,18 +165,29 @@ export declare class GeoMap {
     setLoading(mode: LoadingMode): void;
     /** Space behind the globe (stars, atmosphere halo) */
     setSky(enabled: boolean): void;
+    /** The viewshed set, set again in a new engine */
+    private viewshed;
+    /** The sun set, set again in a new engine */
+    private sun;
+    /**
+     * The sun casting shadows: the buildings, trees, models, 3D Tiles and the relief shade the ground and one another,
+     * the walls turned away from it are in their own shade; the labels stay over them. The sun stands where it is at
+     * `date` over the map's center (now by default), or at `azimuth` and `altitude`. As it sets the night falls (`night`
+     * to set it by hand): the scene tinted in its blue, the windows of the buildings and the streets of `vectors()` lit,
+     * the labels light on dark.
+     * The shadows cover the ground around the view's center, fading out away from it, and cost two more depth passes
+     * of the solid scene each frame. Undefined removes them
+     */
+    setSun(options: SunOptions | undefined): void;
     /** Tints what can be seen from a point and what is hidden from it, within a range, all around or within a cone
      * (`direction`): the relief, extrusions, 3D Tiles and models hide what lies behind them (only what the map has
      * loaded for its view). Several observers (16 at most): what any of them sees is seen, what is hidden from all those
      * that reach it is hidden, in the colors and opacity of the first. Undefined or none removes it */
-    /** The viewshed set, set again in a new engine */
-    private viewshed;
     setViewshed(options: ViewshedOptions | readonly ViewshedOptions[] | undefined): void;
     /** Relief under the basemap: true for the body's terrain model (on the Earth the worldwide Terrain Tiles, NASA's
      * on the Moon and Mars), one of the Earth's models by name (`'ign'`), its options, or false; on another body, its
      * options with a `url` */
     setTerrain(terrain: boolean | TerrainModel | TerrainOptions): void;
-    private attributionChanged;
     /** Color behind the map, a CSS color (its alpha ignored) */
     setBackground(color: string): void;
     /** Tile counters of the raster layers, for diagnostics */
@@ -232,10 +209,6 @@ export declare class GeoMap {
     }): FeatureHit | undefined;
     /** A hit with its layer handle and feature; undefined if the layer is gone */
     private featureHit;
-    /** Asks the engine what is under the pointer; its answer, read without waiting for the GPU, comes on a later frame */
-    private requestHoverPick;
-    private readonly pollHoverPick;
-    private cancelHoverPick;
     /** Screen point (CSS pixels) of a position on the ground (the relief), or `height` metres above it, undefined
      * behind the camera */
     project(lonLat: LonLat, height?: number): Point | undefined;
@@ -321,19 +294,10 @@ export declare class GeoMap {
     removeImage(name: string): void;
     /**
      * Vector tiles with a MapLibre style (OpenFreeMap's Positron by default): `tiles.raster(…)` draws its fills and lines
-     * (or a subset) as a raster layer, `tiles.labels(…)` its labels. `setBasemap('osm-positron')` does both for the
-     * basemap.
+     * (or a subset) as a raster layer, `tiles.vectors(…)` as geometry, `tiles.labels(…)` its labels.
+     * `setBasemap('osm-positron')` draws the basemap with a raster layer and the labels.
      */
     vectorTiles(options?: VectorTilesOptions): VectorTiles;
-    /**
-     * The workers decoding the relief and reprojecting rasters: the map's pool, unless the map has no workers
-     * (`workers: false` or 0, or none in this browser): that is done in the page then
-     */
-    private decodingPool;
-    private readonly remoteHeights;
-    private readonly remoteReprojection;
-    /** The loader of the relief tiles of `url` in a PNG encoding (one per URL, encoding and floor) */
-    private readonly terrainLoader;
     /** Adds a layer, under `before` if given */
     private place;
     /** Textured meshes in 3D Tiles (photogrammetry, buildings), drawn with depth over the basemap */
@@ -358,42 +322,6 @@ export declare class GeoMap {
     }): CustomLayer;
     /** Asks for a frame; several calls before the next frame draw it once */
     requestRender(): void;
-    private frame;
-    private drawFrame;
-    /** Resizes when the device pixel ratio changes (browser zoom, a window moved to another screen) */
-    private watchRatio;
     private resize;
     destroy(): void;
 }
-/** A layer by its type and the options of its `add…` method (`GeoMap.add`) */
-export type LayerSpec<P = Record<string, unknown>> = ({
-    type: 'lines';
-} & LineOptions<P>) | ({
-    type: 'circles';
-} & CircleOptions<P>) | ({
-    type: 'fills';
-} & FillOptions<P>) | ({
-    type: 'symbols';
-} & SymbolOptions<P>) | ({
-    type: 'extrusions';
-} & ExtrusionOptions<P>) | ({
-    type: 'raster';
-} & RasterOptions & {
-    before?: Layer;
-}) | ({
-    type: 'ground';
-} & GroundOptions & {
-    before?: Layer;
-}) | ({
-    type: 'network';
-} & NetworkOptions) | ({
-    type: 'tiles3d';
-} & Tiles3dOptions) | ({
-    type: 'pointcloud';
-} & PointCloudOptions & {
-    before?: Layer;
-}) | ({
-    type: 'models';
-} & ModelOptions & {
-    before?: Layer;
-});