@vcmap/core 5.0.0-rc.9 → 5.0.1

package/dist/src/util/mapCollection.js

@@ -0,0 +1,312 @@
+import { check, checkMaybe } from '@vcsuite/check';
+import { getLogger } from '@vcsuite/logger';
+import VcsEvent from '../vcsEvent.js';
+import Collection from './collection.js';
+import EventHandler from '../interaction/eventHandler.js';
+import LayerCollection from './layerCollection.js';
+import ClippingObjectManager from './clipping/clippingObjectManager.js';
+async function setCesiumToOLViewpoint(cesiumMap, olMap) {
+    const viewpoint = cesiumMap.getViewpointSync();
+    if (!viewpoint) {
+        return;
+    }
+    const northDownVp = viewpoint.clone();
+    northDownVp.heading = 0;
+    northDownVp.pitch = -90;
+    if (viewpoint && !viewpoint.equals(northDownVp)) {
+        if (olMap.fixedNorthOrientation) {
+            viewpoint.heading = 0;
+        }
+        viewpoint.pitch = -90;
+        viewpoint.animate = true;
+        viewpoint.duration = 1;
+        if (viewpoint.groundPosition) {
+            viewpoint.cameraPosition = null;
+        }
+        await cesiumMap.gotoViewpoint(viewpoint);
+    }
+}
+// ignored do to static issues, see https://github.com/microsoft/TypeScript/issues/4628
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+class MapCollection extends Collection {
+    /**
+     * Creates a MapCollection from an iterable of maps, such as an Array.
+     */
+    static from(iterable) {
+        const collection = new MapCollection();
+        if (iterable) {
+            // eslint-disable-next-line no-restricted-syntax
+            for (const map of iterable) {
+                collection.add(map);
+            }
+        }
+        return collection;
+    }
+    _activeMap = null;
+    _target = null;
+    /**
+     * if the active map is removed the last viewpoint is cached for the next mapActivation.
+     */
+    _cachedViewpoint = null;
+    /**
+     * The map pointer event handler. The EventHandler is shared amongst all maps within the collection.
+     */
+    eventHandler = new EventHandler();
+    /**
+     * Collection of layers shared amongst the maps within this collection,
+     * layers will be rendered if supported on the currently active map.
+     */
+    _layerCollection = new LayerCollection();
+    /**
+     * Called, if a map fails to initialize. The map causing the error will be removed from the collection.
+     */
+    initializeError = new VcsEvent();
+    /**
+     * Called, when a map (typically an oblique map) cannot show the current viewpoint. Is passed
+     * the map which cannot show the current viewpoint.
+     */
+    fallbackMapActivated = new VcsEvent();
+    /**
+     * Called, when a map is activated. Is passed the activated map.
+     */
+    mapActivated = new VcsEvent();
+    /**
+     * Manages the clipping object for the maps in this collection.
+     */
+    clippingObjectManager;
+    _mapPointerListeners = [];
+    _splitPosition = 0.5;
+    /**
+     * Event raised when the maps split position changes. It passed the position as its only argument.
+     */
+    splitPositionChanged = new VcsEvent();
+    _postRender = new VcsEvent();
+    // eslint-disable-next-line class-methods-use-this
+    _postRenderListener = () => { };
+    constructor() {
+        super();
+        this.clippingObjectManager = new ClippingObjectManager(this._layerCollection);
+    }
+    /**
+     * The currently active map
+     */
+    get activeMap() {
+        return this._activeMap;
+    }
+    /**
+     * The currently set HTML element in which to render the maps
+     */
+    get target() {
+        return this._target;
+    }
+    /**
+     * The current layer collection
+     */
+    get layerCollection() {
+        return this._layerCollection;
+    }
+    /**
+     * Set the layer collection for these maps.
+     */
+    set layerCollection(layerCollection) {
+        check(layerCollection, LayerCollection);
+        this._layerCollection = layerCollection;
+        this._array.forEach((map) => {
+            map.layerCollection = this._layerCollection;
+        });
+    }
+    /**
+     * The current splitPosition
+     */
+    get splitPosition() {
+        return this._splitPosition;
+    }
+    /**
+     * Set the splitPosition for these maps.
+     */
+    set splitPosition(position) {
+        check(position, Number);
+        if (position < 0 || position > 1) {
+            throw new Error('Position must be between 0 and 1');
+        }
+        if (Math.abs(this._splitPosition - position) > 0.0001) {
+            this._splitPosition = position;
+            this._array.forEach((map) => {
+                map.splitPosition = this._splitPosition;
+            });
+            this.splitPositionChanged.raiseEvent(position);
+        }
+    }
+    /**
+     * Raised on the active maps post render event
+     */
+    get postRender() {
+        return this._postRender;
+    }
+    /**
+     * Adds a map to the collection. This will set the collections target
+     * and the collections  on the map.
+     * It will add map event listeners and pass them to the event handler of this collection.
+     */
+    add(map) {
+        const added = super.add(map);
+        if (added !== null) {
+            this._mapPointerListeners.push(map.pointerInteractionEvent.addEventListener(this.eventHandler.handleMapEvent.bind(this.eventHandler)));
+            map.layerCollection = this._layerCollection;
+            map.setTarget(this._target);
+        }
+        return added;
+    }
+    _remove(map) {
+        if (this._activeMap === map) {
+            this._postRenderListener();
+            this._postRenderListener = () => { };
+            this._cachedViewpoint = map.getViewpointSync();
+            if (this._target) {
+                const mapClassName = this._activeMap.className;
+                this._target.classList.remove(mapClassName);
+            }
+            this._activeMap = null;
+        }
+        if (this.has(map)) {
+            map.setTarget(null);
+            map.layerCollection = new LayerCollection();
+        }
+        return super._remove(map);
+    }
+    _setActiveMapCSSClass() {
+        if (this._target && this._activeMap) {
+            const mapClassName = this._activeMap.className;
+            this._target.classList.add(mapClassName);
+        }
+    }
+    /**
+     * Set the target for these maps.
+     */
+    setTarget(target) {
+        checkMaybe(target, [String, HTMLElement]);
+        this._target =
+            typeof target === 'string' ? document.getElementById(target) : target;
+        this._array.forEach((map) => {
+            map.setTarget(this._target);
+        });
+        this._setActiveMapCSSClass();
+    }
+    _getFallbackMap(map) {
+        const { fallbackMap } = map;
+        if (fallbackMap) {
+            const fMap = this.getByKey(fallbackMap);
+            if (fMap && fMap !== map) {
+                return fMap;
+            }
+            else {
+                getLogger().warning(`the fallback map with the name: ${fallbackMap} is missconfigured`);
+            }
+        }
+        return null;
+    }
+    _getFallbackMapOrDefault(map) {
+        const fallbackMap = this._getFallbackMap(map);
+        return fallbackMap || this.getByType('OpenlayersMap')[0] || this._array[0];
+    }
+    /**
+     * Sets the active map. This will 1. get the current viewpoint of an acitve map (if one is set) 2.
+     * determine that the map to be activated can show this viewpoint or has no fallback map set and 3.
+     * activates the map 4. calls gotoViewpoint with the previous maps viewpoint
+     */
+    async setActiveMap(mapName) {
+        const map = this.getByKey(mapName);
+        if (!map) {
+            getLogger('MapCollection').warning(`could not find map with name ${mapName}`);
+            return Promise.resolve();
+        }
+        if (this._activeMap &&
+            this._activeMap.className === 'CesiumMap' &&
+            map.className === 'OpenlayersMap') {
+            await setCesiumToOLViewpoint(this._activeMap, map);
+        }
+        try {
+            await map.initialize();
+        }
+        catch (error) {
+            // typically unsupported webGL and cesium map
+            getLogger('MapCollection').error(String(error));
+            this.remove(map);
+            const fallbackMap = this._getFallbackMapOrDefault(map);
+            this.initializeError.raiseEvent({
+                map,
+                error: error,
+            });
+            if (fallbackMap) {
+                this.fallbackMapActivated.raiseEvent(map);
+                return this.setActiveMap(fallbackMap.name);
+            }
+            throw new Error('cannot activate a single map');
+        }
+        let viewpoint;
+        if (this._activeMap || this._cachedViewpoint) {
+            if (this._activeMap === map) {
+                return map.activate();
+            }
+            viewpoint = this._activeMap
+                ? await this._activeMap.getViewpoint()
+                : this._cachedViewpoint;
+            const canShow = await map.canShowViewpoint(viewpoint);
+            if (!canShow) {
+                const fallbackMap = this._getFallbackMap(map);
+                if (fallbackMap) {
+                    this.fallbackMapActivated.raiseEvent(map);
+                    return this.setActiveMap(fallbackMap.name);
+                }
+            }
+            this._cachedViewpoint = null;
+            if (this._activeMap) {
+                this._activeMap.deactivate();
+                if (this._target) {
+                    const mapClassName = this._activeMap.className;
+                    this._target.classList.remove(mapClassName);
+                }
+            }
+        }
+        this._activeMap = map;
+        await this._activeMap.activate();
+        this._setActiveMapCSSClass();
+        if (viewpoint) {
+            await this._activeMap.gotoViewpoint(viewpoint);
+        }
+        this.clippingObjectManager.mapActivated(map);
+        this._postRenderListener();
+        this._postRenderListener = this._activeMap.postRender.addEventListener((event) => {
+            this.postRender.raiseEvent(event);
+        });
+        this.mapActivated.raiseEvent(map);
+        return Promise.resolve();
+    }
+    /**
+     * Returns all maps of a specified type
+     */
+    getByType(type) {
+        return this._array.filter((m) => m.className === type);
+    }
+    destroy() {
+        super.destroy();
+        [...this._layerCollection].forEach((l) => {
+            l.destroy();
+        });
+        this._layerCollection.destroy();
+        this.eventHandler.destroy();
+        this.mapActivated.destroy();
+        this.clippingObjectManager.destroy();
+        this.splitPositionChanged.destroy();
+        this.fallbackMapActivated.destroy();
+        this.initializeError.destroy();
+        this._mapPointerListeners.forEach((cb) => {
+            cb();
+        });
+        this._mapPointerListeners = [];
+        this._target = null;
+    }
+}
+export default MapCollection;
+//# sourceMappingURL=mapCollection.js.map

package/dist/src/util/mapCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapCollection.js","sourceRoot":"","sources":["../../../src/util/mapCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAC1D,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,qBAAqB,MAAM,qCAAqC,CAAC;AAaxE,KAAK,UAAU,sBAAsB,CACnC,SAAoB,EACpB,KAAoB;IAEpB,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;IAC/C,IAAI,CAAC,SAAS,EAAE;QACd,OAAO;KACR;IACD,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;IACtC,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC;IACxB,WAAW,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;IACxB,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;QAC/C,IAAI,KAAK,CAAC,qBAAqB,EAAE;YAC/B,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SACvB;QAED,SAAS,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACtB,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC;QACzB,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEvB,IAAI,SAAS,CAAC,cAAc,EAAE;YAC5B,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC;SACjC;QAED,MAAM,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;KAC1C;AACH,CAAC;AAED,uFAAuF;AACvF,6DAA6D;AAC7D,aAAa;AACb,MAAM,aAAc,SAAQ,UAAkB;IAC5C;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,QAA0B;QACpC,MAAM,UAAU,GAAG,IAAI,aAAa,EAAE,CAAC;QAEvC,IAAI,QAAQ,EAAE;YACZ,gDAAgD;YAChD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;gBAC1B,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aACrB;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,UAAU,GAAkB,IAAI,CAAC;IAEjC,OAAO,GAAuB,IAAI,CAAC;IAE3C;;OAEG;IACK,gBAAgB,GAAqB,IAAI,CAAC;IAElD;;OAEG;IACH,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;IAElC;;;OAGG;IACK,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;IAEjD;;OAEG;IACH,eAAe,GAA+C,IAAI,QAAQ,EAAE,CAAC;IAE7E;;;OAGG;IACH,oBAAoB,GAAqB,IAAI,QAAQ,EAAE,CAAC;IAExD;;OAEG;IACH,YAAY,GAAqB,IAAI,QAAQ,EAAE,CAAC;IAEhD;;OAEG;IACH,qBAAqB,CAAwB;IAErC,oBAAoB,GAAmB,EAAE,CAAC;IAE1C,cAAc,GAAG,GAAG,CAAC;IAE7B;;OAEG;IACH,oBAAoB,GAAqB,IAAI,QAAQ,EAAE,CAAC;IAEhD,WAAW,GAAG,IAAI,QAAQ,EAAwC,CAAC;IAE3E,kDAAkD;IAC1C,mBAAmB,GAAe,GAAG,EAAE,GAAE,CAAC,CAAC;IAEnD;QACE,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,qBAAqB,GAAG,IAAI,qBAAqB,CACpD,IAAI,CAAC,gBAAgB,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,eAAe,CAAC,eAAgC;QAClD,KAAK,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QAExC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC1B,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,aAAa,CAAC,QAAgB;QAChC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxB,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACrD;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,MAAM,EAAE;YACrD,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1B,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SAChD;IACH,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAW;QACb,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAC5B,GAAG,CAAC,uBAAuB,CAAC,gBAAgB,CAC1C,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CACzD,CACF,CAAC;YACF,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC;YAC5C,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAES,OAAO,CAAC,GAAW;QAC3B,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,EAAE;YAC3B,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,IAAI,CAAC,mBAAmB,GAAG,GAAS,EAAE,GAAE,CAAC,CAAC;YAC1C,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,EAAE,CAAC;YAC/C,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SACxB;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACjB,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpB,GAAG,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;SAC7C;QACD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEO,qBAAqB;QAC3B,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,EAAE;YACnC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;SAC1C;IACH,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,MAA4B;QACpC,UAAU,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QAE1C,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC1B,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAEO,eAAe,CAAC,GAAW;QACjC,MAAM,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC;QAC5B,IAAI,WAAW,EAAE;YACf,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,IAAI,IAAI,IAAI,KAAK,GAAG,EAAE;gBACxB,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,SAAS,EAAE,CAAC,OAAO,CACjB,mCAAmC,WAAW,oBAAoB,CACnE,CAAC;aACH;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAAC,GAAW;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,WAAW,IAAI,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,CAAC,GAAG,EAAE;YACR,SAAS,CAAC,eAAe,CAAC,CAAC,OAAO,CAChC,gCAAgC,OAAO,EAAE,CAC1C,CAAC;YACF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QAED,IACE,IAAI,CAAC,UAAU;YACf,IAAI,CAAC,UAAU,CAAC,SAAS,KAAK,WAAW;YACzC,GAAG,CAAC,SAAS,KAAK,eAAe,EACjC;YACA,MAAM,sBAAsB,CAC1B,IAAI,CAAC,UAAuB,EAC5B,GAAoB,CACrB,CAAC;SACH;QAED,IAAI;YACF,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;SACxB;QAAC,OAAO,KAAK,EAAE;YACd,6CAA6C;YAC7C,SAAS,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjB,MAAM,WAAW,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YACvD,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;gBAC9B,GAAG;gBACH,KAAK,EAAE,KAAc;aACtB,CAAC,CAAC;YACH,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;aAC5C;YACD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,IAAI,SAAS,CAAC;QACd,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAC5C,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;aACvB;YAED,SAAS,GAAG,IAAI,CAAC,UAAU;gBACzB,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE;gBACtC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAE1B,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,gBAAgB,CAAC,SAAsB,CAAC,CAAC;YACnE,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;gBAC9C,IAAI,WAAW,EAAE;oBACf,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;iBAC5C;aACF;YACD,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAC7B,IAAI,IAAI,CAAC,UAAU,EAAE;gBACnB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;gBAC7B,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;oBAC/C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;iBAC7C;aACF;SACF;QAED,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QACjC,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE7B,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;SAChD;QAED,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,gBAAgB,CACpE,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC,CACF,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvC,CAAC,CAAC,OAAO,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAChC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;QAE/B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACvC,EAAE,EAAE,CAAC;QACP,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAE/B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;CACF;AAED,eAAe,aAAa,CAAC"}

package/dist/src/util/math.d.ts

@@ -0,0 +1,45 @@
+import { Cartesian3, Cartographic } from '@vcmap-cesium/engine';
+import type { Coordinate } from 'ol/coordinate.js';
+/**
+ * returns a new coordinate ([lon, lat] in degrees) from a distance, bearing and starting coordinate
+ * @param  coord [lon, lat] in degrees
+ * @param  d distance in m to new coordinate
+ * @param  brng bearing in degrees ( 0 == north, 90° == east)
+ * @returns ;
+ */
+export declare function coordinateAtDistance(coord: number[], d: number, brng: number): number[];
+/**
+ * returns the initial bearing in degrees (0-360) between two coordinates
+ * @param  coords1 [lon, lat] in degrees
+ * @param  coords2 [lon, lat] in degrees
+ * @returns ;
+ */
+export declare function initialBearingBetweenCoords(coords1: number[], coords2: number[]): number;
+/**
+ * @param  p1 - mercator
+ * @param  p2 - mercator
+ * @returns  in radians
+ */
+export declare function getCartesianBearing(p1: Coordinate, p2: Coordinate): number;
+/**
+ * returns distance between two coordinates
+ * @param  point0
+ * @param  point1
+ */
+export declare function cartesian2DDistance(point0: Coordinate, point1: Coordinate): number;
+export declare function cartesian3DDistance(p1: Coordinate, p2: Coordinate): number;
+/**
+ * Avoid JS negative number modulo bug.
+ */
+export declare function modulo(n: number, m: number): number;
+export declare function cartographicToWgs84(cartographic: Cartographic): number[];
+export declare function mercatorToCartesian(mercatorCoordinates: Coordinate, result?: Cartesian3): Cartesian3;
+export declare function cartesianToMercator(cartesian: Cartesian3): Coordinate;
+export declare function getMidPoint(p1: Coordinate, p2: Coordinate): Coordinate;
+/**
+ * Gets the pitch between two points in degrees.
+ * @param  p1 - mercator
+ * @param  p2 - mercator
+ * @returns  in degrees
+ */
+export declare function getCartesianPitch(p1: Coordinate, p2: Coordinate): number;

package/dist/src/util/math.js

@@ -0,0 +1,136 @@
+import { Math as CesiumMath, Cartesian3, Cartographic, } from '@vcmap-cesium/engine';
+import Projection from './projection.js';
+/**
+ * returns a new coordinate ([lon, lat] in degrees) from a distance, bearing and starting coordinate
+ * @param  coord [lon, lat] in degrees
+ * @param  d distance in m to new coordinate
+ * @param  brng bearing in degrees ( 0 == north, 90° == east)
+ * @returns ;
+ */
+export function coordinateAtDistance(coord, d, brng) {
+    const R = 6371000;
+    const brngRadians = CesiumMath.toRadians(brng);
+    const lat1 = CesiumMath.toRadians(coord[1]);
+    const lon1 = CesiumMath.toRadians(coord[0]);
+    const lat2 = Math.asin(Math.sin(lat1) * Math.cos(d / R) +
+        Math.cos(lat1) * Math.sin(d / R) * Math.cos(brngRadians));
+    const lon2 = lon1 +
+        Math.atan2(Math.sin(brngRadians) * Math.sin(d / R) * Math.cos(lat1), Math.cos(d / R) - Math.sin(lat1) * Math.sin(lat2));
+    return [
+        parseFloat(CesiumMath.toDegrees(lon2).toFixed(5)),
+        parseFloat(CesiumMath.toDegrees(lat2).toFixed(5)),
+    ];
+}
+/**
+ * returns the initial bearing in degrees (0-360) between two coordinates
+ * @param  coords1 [lon, lat] in degrees
+ * @param  coords2 [lon, lat] in degrees
+ * @returns ;
+ */
+export function initialBearingBetweenCoords(coords1, coords2) {
+    // long
+    const l1 = CesiumMath.toRadians(coords1[0]);
+    // lat
+    const f1 = CesiumMath.toRadians(coords1[1]);
+    // long
+    const l2 = CesiumMath.toRadians(coords2[0]);
+    // lat
+    const f2 = CesiumMath.toRadians(coords2[1]);
+    const y = Math.sin(l2 - l1) * Math.cos(f2);
+    const x = Math.cos(f1) * Math.sin(f2) -
+        Math.sin(f1) * Math.cos(f2) * Math.cos(l2 - l1);
+    let brng = CesiumMath.toDegrees(Math.atan2(y, x));
+    brng = (brng + 360) % 360;
+    return brng;
+}
+/**
+ * @param  p1 - mercator
+ * @param  p2 - mercator
+ * @returns  in radians
+ */
+export function getCartesianBearing(p1, p2) {
+    let theta = Math.atan2(p2[0] - p1[0], p2[1] - p1[1]);
+    theta = theta < 0 ? theta + CesiumMath.TWO_PI : theta;
+    return theta;
+}
+/**
+ * returns distance between two coordinates
+ * @param  point0
+ * @param  point1
+ */
+export function cartesian2DDistance(point0, point1) {
+    const distX = point0[0] - point1[0];
+    const distY = point0[1] - point1[1];
+    return Math.sqrt(distX ** 2 + distY ** 2);
+}
+export function cartesian3DDistance(p1, p2) {
+    const point0 = Cartesian3.fromElements(p1[0], p1[1], p1[2]);
+    const point1 = Cartesian3.fromElements(p2[0], p2[1], p2[2]);
+    return Cartesian3.distance(point0, point1);
+}
+/**
+ * Avoid JS negative number modulo bug.
+ */
+export function modulo(n, m) {
+    return ((n % m) + m) % m;
+}
+export function cartographicToWgs84(cartographic) {
+    return [
+        CesiumMath.toDegrees(cartographic.longitude),
+        CesiumMath.toDegrees(cartographic.latitude),
+        cartographic.height,
+    ];
+}
+export function mercatorToCartesian(mercatorCoordinates, result) {
+    const wgs84Coords = Projection.mercatorToWgs84(mercatorCoordinates);
+    return Cartesian3.fromDegrees(wgs84Coords[0], wgs84Coords[1], wgs84Coords[2], undefined, result ?? new Cartesian3());
+}
+export function cartesianToMercator(cartesian) {
+    const cartographic = Cartographic.fromCartesian(cartesian);
+    const wgs84 = cartographicToWgs84(cartographic);
+    return Projection.wgs84ToMercator(wgs84);
+}
+export function getMidPoint(p1, p2) {
+    if (p1.length < 3 && p2.length < 3) {
+        return [p1[0] + (p2[0] - p1[0]) / 2, p1[1] + (p2[1] - p1[1]) / 2, 0];
+    }
+    return [
+        p1[0] + (p2[0] - p1[0]) / 2,
+        p1[1] + (p2[1] - p1[1]) / 2,
+        p1[2] + (p2[2] - p1[2]) / 2,
+    ];
+}
+/**
+ * Gets the pitch between two points in degrees.
+ * @param  p1 - mercator
+ * @param  p2 - mercator
+ * @returns  in degrees
+ */
+export function getCartesianPitch(p1, p2) {
+    let thirdPoint;
+    if (p1[2] > p2[2]) {
+        thirdPoint = p1.slice();
+        thirdPoint[2] = p2[2];
+    }
+    else {
+        thirdPoint = p2.slice();
+        thirdPoint[2] = p1[2];
+    }
+    const scratch1 = mercatorToCartesian(p1);
+    const scratch2 = mercatorToCartesian(p2);
+    const scratch3 = mercatorToCartesian(thirdPoint);
+    Cartesian3.subtract(scratch2, scratch1, scratch2);
+    Cartesian3.subtract(scratch3, scratch1, scratch3);
+    Cartesian3.normalize(scratch2, scratch2);
+    Cartesian3.normalize(scratch3, scratch3);
+    let pitch;
+    if (p1[2] > p2[2]) {
+        pitch =
+            CesiumMath.toDegrees(Math.acos(Cartesian3.dot(scratch2, scratch3))) - 90;
+    }
+    else {
+        pitch = CesiumMath.toDegrees(Math.acos(Cartesian3.dot(scratch2, scratch3)));
+    }
+    return pitch;
+}
+//# sourceMappingURL=math.js.map

package/dist/src/util/math.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"math.js","sourceRoot":"","sources":["../../../src/util/math.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,IAAI,UAAU,EAClB,UAAU,EACV,YAAY,GACb,MAAM,sBAAsB,CAAC;AAE9B,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAe,EACf,CAAS,EACT,IAAY;IAEZ,MAAM,CAAC,GAAG,OAAO,CAAC;IAClB,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAC3D,CAAC;IACF,MAAM,IAAI,GACR,IAAI;QACJ,IAAI,CAAC,KAAK,CACR,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EACxD,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAClD,CAAC;IACJ,OAAO;QACL,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACjD,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KAClD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAAiB,EACjB,OAAiB;IAEjB,OAAO;IACP,MAAM,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM;IACN,MAAM,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,OAAO;IACP,MAAM,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM;IACN,MAAM,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5C,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,CAAC,GACL,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAClD,IAAI,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,IAAI,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;IAC1B,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAAc,EAAE,EAAc;IAChE,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IACtD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAkB,EAClB,MAAkB;IAElB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,EAAc,EAAE,EAAc;IAChE,MAAM,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,OAAO,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,MAAM,CAAC,CAAS,EAAE,CAAS;IACzC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,YAA0B;IAC5D,OAAO;QACL,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC;QAC5C,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC;QAC3C,YAAY,CAAC,MAAM;KACpB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,mBAA+B,EAC/B,MAAmB;IAEnB,MAAM,WAAW,GAAG,UAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC;IACpE,OAAO,UAAU,CAAC,WAAW,CAC3B,WAAW,CAAC,CAAC,CAAC,EACd,WAAW,CAAC,CAAC,CAAC,EACd,WAAW,CAAC,CAAC,CAAC,EACd,SAAS,EACT,MAAM,IAAI,IAAI,UAAU,EAAE,CAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,SAAqB;IACvD,MAAM,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAChD,OAAO,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAc,EAAE,EAAc;IACxD,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;QAClC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;KACtE;IACD,OAAO;QACL,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3B,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3B,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;KAC5B,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAc,EAAE,EAAc;IAC9D,IAAI,UAAU,CAAC;IACf,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE;QACjB,UAAU,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QACxB,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;KACvB;SAAM;QACL,UAAU,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QACxB,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;KACvB;IACD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAEjD,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAElD,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACzC,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAEzC,IAAI,KAAK,CAAC;IACV,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE;QACjB,KAAK;YACH,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;KAC5E;SAAM;QACL,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;KAC7E;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/src/util/overrideCollection.d.ts

@@ -0,0 +1,58 @@
+import Collection from './collection.js';
+import VcsEvent from '../vcsEvent.js';
+import { moduleIdSymbol } from '../moduleIdSymbol.js';
+export interface ReplacedEvent<T> {
+    new: T;
+    old: T;
+}
+/**
+ * A symbol added to override collections.
+ */
+export declare const isOverrideCollection: unique symbol;
+export type OverrideCollectionItem = {
+    toJSON?: () => object & {
+        [moduleIdSymbol]?: string;
+    };
+    destroy?: () => void;
+    [moduleIdSymbol]?: string;
+} & object;
+/**
+ * The override collection adds the ability to override a unique item and re-creating it, should the override
+ * be removed. This does change some flow of called events. 1) if you override an item, removed is not called for the
+ * removed current item. 2) added can be called more the once for the same unique id. 3) replaced is called for items
+ * which where replaced. replaced is called after added has been called for the item.
+ */
+export type OverrideCollectionInterface<T> = {
+    /**
+     * replaced is called after added
+     */
+    replaced: VcsEvent<ReplacedEvent<T>>;
+    shadowMap: Map<string, (object & {
+        [moduleIdSymbol]?: string;
+    })[]>;
+    /**
+     * returns the overriden item or null if the item could not be inserted (this would be the result of a race condition)
+     */
+    override: (item: T) => T | null;
+    parseItems: (items: (object & {
+        type?: string;
+    })[] | undefined, moduleId: string) => Promise<void>;
+    getSerializedByKey: (key: string) => object | undefined;
+    removeModule: (moduleId: string) => void;
+    serializeModule: (moduleId: string) => object[];
+    [isOverrideCollection]: boolean;
+    uniqueKey: keyof T;
+};
+export type OverrideCollection<T extends OverrideCollectionItem, C extends Collection<T> = Collection<T>> = C & OverrideCollectionInterface<T>;
+/**
+ * @param  collection
+ * @param  getDynamicModuleId - function to get the current dynamic module id
+ * @param  serializeItem - optional function to serialize an item, defaults to returning item.toJSON or item: i => (i.toJSON || i)
+ * @param  deserializeItem - optional deserialization function. defaults to returning the passed object: i => i
+ * @param  ctor - optional constructor to validate deserialized items against. if passed, deserializeItem must be an instance of ctor.
+ * @param  determineShadowIndex - return the index where a shadow should be inserted. only has relevance, if the collection is indexed. previous and current index may be null.
+ */
+declare function makeOverrideCollection<T extends OverrideCollectionItem, C extends Collection<T>>(collection: C, getDynamicModuleId: () => string, serializeItem?: (item: T) => object & {
+    [moduleIdSymbol]?: string;
+}, deserializeItem?: (item: object) => T | Promise<T> | null, ctor?: new (...args: any[]) => T, determineShadowIndex?: (item: T, shadow?: T, index?: number) => number | null | undefined): OverrideCollection<T, C>;
+export default makeOverrideCollection;