@vcmap/core 6.2.4 → 6.3.0-rc.2

package/dist/src/layer/i3sLayer.js

@@ -0,0 +1,242 @@
+import { Cartesian3, Color } from '@vcmap-cesium/engine';
+import { parseBoolean, parseInteger } from '@vcsuite/parsers';
+import { check, is, maybe, oneOf } from '@vcsuite/check';
+import AbstractFeatureProvider from '../featureProvider/abstractFeatureProvider.js';
+import I3SCesiumImpl from './cesium/i3sCesiumImpl.js';
+import FeatureLayer from './featureLayer.js';
+import { layerClassRegistry } from '../classRegistry.js';
+import CesiumMap from '../map/cesiumMap.js';
+import BaseCesiumMap from '../map/baseCesiumMap.js';
+import PanoramaMap from '../map/panoramaMap.js';
+import Extent from '../util/extent.js';
+import { isMobile } from '../util/isMobile.js';
+import { mercatorProjection } from '../util/projection.js';
+import { rectangleToMercatorExtent } from '../util/math.js';
+import { cesiumColorToColor, getStringColor } from '../style/styleHelpers.js';
+import VectorStyleItem from '../style/vectorStyleItem.js';
+import I3SAttributeProvider from '../featureProvider/i3sAttributeProvider.js';
+import AbstractAttributeProvider from '../featureProvider/abstractAttributeProvider.js';
+import CompositeFeatureProvider from '../featureProvider/compositeFeatureProvider.js';
+import { getProviderForOption } from '../featureProvider/featureProviderFactory.js';
+class I3SLayer extends FeatureLayer {
+    static get className() {
+        return 'I3SLayer';
+    }
+    static getDefaultOptions() {
+        return {
+            ...FeatureLayer.getDefaultOptions(),
+            adjustMaterialAlphaMode: false,
+            applySymbology: false,
+            calculateNormals: false,
+            showFeatures: false,
+            cesium3dTilesetOptions: undefined,
+            lightColor: undefined,
+            outlineColor: undefined,
+            screenSpaceError: 16,
+            screenSpaceErrorMobile: 32,
+            highlightStyle: undefined,
+            hasBatchTable: true,
+        };
+    }
+    adjustMaterialAlphaMode;
+    applySymbology;
+    calculateNormals;
+    showFeatures;
+    cesium3dTilesetOptions;
+    lightColor;
+    outlineColor;
+    screenSpaceError;
+    screenSpaceErrorMobile;
+    highlightStyle = null;
+    hasBatchTable;
+    _supportedMaps = [CesiumMap.className, PanoramaMap.className];
+    _attributeProvider;
+    constructor(options) {
+        const defaultOptions = I3SLayer.getDefaultOptions();
+        super({ ...defaultOptions, ...options });
+        this.adjustMaterialAlphaMode = parseBoolean(options.adjustMaterialAlphaMode ?? defaultOptions.adjustMaterialAlphaMode);
+        this.applySymbology = parseBoolean(options.applySymbology ?? defaultOptions.applySymbology);
+        this.calculateNormals = parseBoolean(options.calculateNormals ?? defaultOptions.calculateNormals);
+        this.showFeatures = parseBoolean(options.showFeatures ?? defaultOptions.showFeatures);
+        this.screenSpaceError = parseInteger(options.screenSpaceError, defaultOptions.screenSpaceError);
+        this.screenSpaceErrorMobile = parseInteger(options.screenSpaceErrorMobile, defaultOptions.screenSpaceErrorMobile);
+        this.hasBatchTable = parseBoolean(options.hasBatchTable ?? defaultOptions.hasBatchTable);
+        if (options.highlightStyle) {
+            this.highlightStyle =
+                options.highlightStyle instanceof VectorStyleItem
+                    ? options.highlightStyle
+                    : new VectorStyleItem(options.highlightStyle);
+        }
+        const cesium3dTilesetOptions = options.cesium3dTilesetOptions || defaultOptions.cesium3dTilesetOptions;
+        this.cesium3dTilesetOptions = {
+            maximumScreenSpaceError: isMobile()
+                ? this.screenSpaceErrorMobile
+                : this.screenSpaceError,
+            ...cesium3dTilesetOptions,
+            ...(options.lightColor && {
+                lightColor: new Cartesian3(options.lightColor.x, options.lightColor.y, options.lightColor.z),
+            }),
+            ...(options.outlineColor && {
+                outlineColor: Color.fromCssColorString(options.outlineColor),
+            }),
+        };
+        const attributeProvider = getProviderForOption(options.attributeProvider);
+        if (this.hasBatchTable) {
+            if (is(attributeProvider, oneOf(CompositeFeatureProvider, AbstractAttributeProvider))) {
+                this._attributeProvider = attributeProvider;
+            }
+            else {
+                this._attributeProvider = new I3SAttributeProvider({});
+            }
+        }
+        else if (this.allowPicking) {
+            if (is(this.featureProvider, AbstractFeatureProvider)) {
+                this.attributeProvider = new CompositeFeatureProvider({
+                    featureProviders: [this.featureProvider],
+                    attributeProviders: [new I3SAttributeProvider({})],
+                });
+            }
+            else {
+                this.featureProvider = new I3SAttributeProvider({});
+            }
+        }
+    }
+    get attributeProvider() {
+        return this._attributeProvider;
+    }
+    set attributeProvider(provider) {
+        check(provider, maybe(oneOf(AbstractAttributeProvider, CompositeFeatureProvider)));
+        if (this._attributeProvider !== provider) {
+            this._attributeProvider = provider;
+            this.forceRedraw().catch((e) => {
+                this.getLogger().error(`Error forcing redraw after setting attribute provider: ${String(e)}`);
+            });
+        }
+    }
+    getImplementationOptions() {
+        return {
+            ...super.getImplementationOptions(),
+            allowPicking: this.allowPicking,
+            adjustMaterialAlphaMode: this.adjustMaterialAlphaMode,
+            applySymbology: this.applySymbology,
+            calculateNormals: this.calculateNormals,
+            showFeatures: this.showFeatures,
+            cesium3dTilesetOptions: this.cesium3dTilesetOptions,
+            hasBatchTable: this.hasBatchTable,
+            attributeProvider: this._attributeProvider,
+        };
+    }
+    createImplementationsForMap(map) {
+        if (map instanceof BaseCesiumMap) {
+            return [new I3SCesiumImpl(map, this.getImplementationOptions())];
+        }
+        return [];
+    }
+    getZoomToExtent() {
+        const metaExtent = super.getZoomToExtent();
+        if (metaExtent) {
+            return metaExtent;
+        }
+        const impl = this.getImplementations()[0];
+        if (impl?.data) {
+            const coordinates = rectangleToMercatorExtent(impl.data.extent);
+            const extent = new Extent({
+                projection: mercatorProjection.toJSON(),
+                coordinates,
+            });
+            if (extent.isValid()) {
+                return extent;
+            }
+        }
+        return null;
+    }
+    /**
+     * set the maximum screenspace error of this layer
+     */
+    setMaximumScreenSpaceError(value) {
+        this.getImplementations().forEach((impl) => {
+            if (impl.data) {
+                impl.data.layers.forEach(({ tileset }) => {
+                    if (tileset) {
+                        tileset.maximumScreenSpaceError = value;
+                    }
+                });
+            }
+        });
+    }
+    toJSON(defaultOptions = I3SLayer.getDefaultOptions()) {
+        const config = super.toJSON(defaultOptions);
+        if (this.adjustMaterialAlphaMode !== defaultOptions.adjustMaterialAlphaMode) {
+            config.adjustMaterialAlphaMode = this.adjustMaterialAlphaMode;
+        }
+        if (this.applySymbology !== defaultOptions.applySymbology) {
+            config.applySymbology = this.applySymbology;
+        }
+        if (this.calculateNormals !== defaultOptions.calculateNormals) {
+            config.calculateNormals = this.calculateNormals;
+        }
+        if (this.showFeatures !== defaultOptions.showFeatures) {
+            config.showFeatures = this.showFeatures;
+        }
+        if (this.screenSpaceError !== defaultOptions.screenSpaceError) {
+            config.screenSpaceError = this.screenSpaceError;
+        }
+        if (this.screenSpaceErrorMobile !== defaultOptions.screenSpaceErrorMobile) {
+            config.screenSpaceErrorMobile = this.screenSpaceErrorMobile;
+        }
+        if (this.hasBatchTable !== defaultOptions.hasBatchTable) {
+            config.hasBatchTable = this.hasBatchTable;
+        }
+        if (this.highlightStyle) {
+            config.highlightStyle = this.highlightStyle.toJSON();
+        }
+        const tilesetOptions = { ...this.cesium3dTilesetOptions };
+        if (tilesetOptions.outlineColor) {
+            config.outlineColor = getStringColor(cesiumColorToColor(tilesetOptions.outlineColor));
+        }
+        delete tilesetOptions.outlineColor;
+        if (tilesetOptions.lightColor) {
+            config.lightColor = {
+                x: tilesetOptions.lightColor.x,
+                y: tilesetOptions.lightColor.y,
+                z: tilesetOptions.lightColor.z,
+            };
+        }
+        delete tilesetOptions.lightColor;
+        const usedScreenSpaceError = isMobile()
+            ? this.screenSpaceErrorMobile
+            : this.screenSpaceError;
+        if (tilesetOptions.maximumScreenSpaceError === usedScreenSpaceError) {
+            delete tilesetOptions.maximumScreenSpaceError;
+        }
+        if (Object.keys(tilesetOptions).length > 0) {
+            config.cesium3dTilesetOptions = structuredClone(tilesetOptions);
+        }
+        if (this._attributeProvider &&
+            !(this._attributeProvider instanceof I3SAttributeProvider) &&
+            !(this._attributeProvider instanceof AbstractFeatureProvider)) {
+            config.attributeProvider = this._attributeProvider.toJSON();
+            if (this._attributeProvider instanceof CompositeFeatureProvider) {
+                const { featureProviders, attributeProviders } = this._attributeProvider.toJSON();
+                config.featureProvider = featureProviders[0];
+                if (!(attributeProviders[0] instanceof I3SAttributeProvider)) {
+                    config.attributeProvider = attributeProviders[0];
+                }
+            }
+            else {
+                config.attributeProvider = this._attributeProvider.toJSON();
+            }
+        }
+        return config;
+    }
+    /**
+     * disposes of this layer, removes instances from the current maps and the framework
+     */
+    destroy() {
+        this.attributeProvider?.destroy();
+        super.destroy();
+    }
+}
+layerClassRegistry.registerClass(I3SLayer.className, I3SLayer);
+export default I3SLayer;
+//# sourceMappingURL=i3sLayer.js.map

package/dist/src/layer/i3sLayer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i3sLayer.js","sourceRoot":"","sources":["../../../src/layer/i3sLayer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,uBAAuB,MAAM,+CAA+C,CAAC;AACpF,OAAO,aAAa,MAAM,2BAA2B,CAAC;AACtD,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAI7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,SAAS,MAAM,qBAAqB,CAAC;AAC5C,OAAO,aAAa,MAAM,yBAAyB,CAAC;AACpD,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAEhD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE9E,OAAO,eAAe,MAAM,6BAA6B,CAAC;AAC1D,OAAO,oBAAoB,MAAM,4CAA4C,CAAC;AAE9E,OAAO,yBAAyB,MAAM,iDAAiD,CAAC;AACxF,OAAO,wBAAwB,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AA+BpF,MAAM,QAAS,SAAQ,YAA2B;IAChD,MAAM,KAAK,SAAS;QAClB,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO;YACL,GAAG,YAAY,CAAC,iBAAiB,EAAE;YACnC,uBAAuB,EAAE,KAAK;YAC9B,cAAc,EAAE,KAAK;YACrB,gBAAgB,EAAE,KAAK;YACvB,YAAY,EAAE,KAAK;YACnB,sBAAsB,EAAE,SAAS;YACjC,UAAU,EAAE,SAAS;YACrB,YAAY,EAAE,SAAS;YACvB,gBAAgB,EAAE,EAAE;YACpB,sBAAsB,EAAE,EAAE;YAC1B,cAAc,EAAE,SAAS;YACzB,aAAa,EAAE,IAAI;SACpB,CAAC;IACJ,CAAC;IAED,uBAAuB,CAAU;IACjC,cAAc,CAAU;IACxB,gBAAgB,CAAU;IAC1B,YAAY,CAAU;IACtB,sBAAsB,CAER;IACd,UAAU,CAAkD;IAC5D,YAAY,CAAqB;IACjC,gBAAgB,CAAS;IACzB,sBAAsB,CAAS;IAC/B,cAAc,GAA2B,IAAI,CAAC;IAC9C,aAAa,CAAU;IACb,cAAc,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAChE,kBAAkB,CAAqB;IAE/C,YAAY,OAAmB;QAC7B,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACpD,KAAK,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAEzC,IAAI,CAAC,uBAAuB,GAAG,YAAY,CACzC,OAAO,CAAC,uBAAuB,IAAI,cAAc,CAAC,uBAAuB,CAC1E,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,YAAY,CAChC,OAAO,CAAC,cAAc,IAAI,cAAc,CAAC,cAAc,CACxD,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAClC,OAAO,CAAC,gBAAgB,IAAI,cAAc,CAAC,gBAAgB,CAC5D,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,YAAY,CAC9B,OAAO,CAAC,YAAY,IAAI,cAAc,CAAC,YAAY,CACpD,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAClC,OAAO,CAAC,gBAAgB,EACxB,cAAc,CAAC,gBAAgB,CAChC,CAAC;QAEF,IAAI,CAAC,sBAAsB,GAAG,YAAY,CACxC,OAAO,CAAC,sBAAsB,EAC9B,cAAc,CAAC,sBAAsB,CACtC,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,YAAY,CAC/B,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC,aAAa,CACtD,CAAC;QAEF,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,IAAI,CAAC,cAAc;gBACjB,OAAO,CAAC,cAAc,YAAY,eAAe;oBAC/C,CAAC,CAAC,OAAO,CAAC,cAAc;oBACxB,CAAC,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,sBAAsB,GAC1B,OAAO,CAAC,sBAAsB,IAAI,cAAc,CAAC,sBAAsB,CAAC;QAE1E,IAAI,CAAC,sBAAsB,GAAG;YAC5B,uBAAuB,EAAE,QAAQ,EAAE;gBACjC,CAAC,CAAC,IAAI,CAAC,sBAAsB;gBAC7B,CAAC,CAAC,IAAI,CAAC,gBAAgB;YACzB,GAAG,sBAAsB;YACzB,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI;gBACxB,UAAU,EAAE,IAAI,UAAU,CACxB,OAAO,CAAC,UAAU,CAAC,CAAC,EACpB,OAAO,CAAC,UAAU,CAAC,CAAC,EACpB,OAAO,CAAC,UAAU,CAAC,CAAC,CACrB;aACF,CAAC;YACF,GAAG,CAAC,OAAO,CAAC,YAAY,IAAI;gBAC1B,YAAY,EAAE,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC;aAC7D,CAAC;SACH,CAAC;QAEF,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC1E,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IACE,EAAE,CACA,iBAAiB,EACjB,KAAK,CAAC,wBAAwB,EAAE,yBAAyB,CAAC,CAC3D,EACD,CAAC;gBACD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,kBAAkB,GAAG,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,uBAAuB,CAAC,EAAE,CAAC;gBACtD,IAAI,CAAC,iBAAiB,GAAG,IAAI,wBAAwB,CAAC;oBACpD,gBAAgB,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;oBACxC,kBAAkB,EAAE,CAAC,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;iBACnD,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,eAAe,GAAG,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED,IAAI,iBAAiB,CAAC,QAAuC;QAC3D,KAAK,CACH,QAAQ,EACR,KAAK,CAAC,KAAK,CAAC,yBAAyB,EAAE,wBAAwB,CAAC,CAAC,CAClE,CAAC;QAEF,IAAI,IAAI,CAAC,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC;YACnC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;gBACtC,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CACpB,0DAA0D,MAAM,CAAC,CAAC,CAAC,EAAE,CACtE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,wBAAwB;QACtB,OAAO;YACL,GAAG,KAAK,CAAC,wBAAwB,EAAE;YACnC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;SAC3C,CAAC;IACJ,CAAC;IAED,2BAA2B,CAAC,GAAW;QACrC,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,eAAe;QACb,MAAM,UAAU,GAAG,KAAK,CAAC,eAAe,EAAE,CAAC;QAC3C,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;YACf,MAAM,WAAW,GAAG,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;gBACxB,UAAU,EAAE,kBAAkB,CAAC,MAAM,EAAE;gBACvC,WAAW;aACZ,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;gBACrB,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,0BAA0B,CAAC,KAAa;QACtC,IAAI,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;oBACvC,IAAI,OAAO,EAAE,CAAC;wBACZ,OAAO,CAAC,uBAAuB,GAAG,KAAK,CAAC;oBAC1C,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,iBAAiB,EAAE;QAClD,MAAM,MAAM,GAAe,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACxD,IACE,IAAI,CAAC,uBAAuB,KAAK,cAAc,CAAC,uBAAuB,EACvE,CAAC;YACD,MAAM,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;QAChE,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,cAAc,EAAE,CAAC;YAC1D,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAC9C,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAC9D,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,KAAK,cAAc,CAAC,YAAY,EAAE,CAAC;YACtD,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC1C,CAAC;QAED,IAAI,IAAI,CAAC,gBAAgB,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAC9D,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,CAAC;QACD,IAAI,IAAI,CAAC,sBAAsB,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;YAC1E,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,KAAK,cAAc,CAAC,aAAa,EAAE,CAAC;YACxD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC5C,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QACvD,CAAC;QAED,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1D,IAAI,cAAc,CAAC,YAAY,EAAE,CAAC;YAChC,MAAM,CAAC,YAAY,GAAG,cAAc,CAClC,kBAAkB,CAAC,cAAc,CAAC,YAAY,CAAC,CAChD,CAAC;QACJ,CAAC;QACD,OAAO,cAAc,CAAC,YAAY,CAAC;QAEnC,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC;YAC9B,MAAM,CAAC,UAAU,GAAG;gBAClB,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;gBAC9B,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;gBAC9B,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;aAC/B,CAAC;QACJ,CAAC;QACD,OAAO,cAAc,CAAC,UAAU,CAAC;QAEjC,MAAM,oBAAoB,GAAG,QAAQ,EAAE;YACrC,CAAC,CAAC,IAAI,CAAC,sBAAsB;YAC7B,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAC1B,IAAI,cAAc,CAAC,uBAAuB,KAAK,oBAAoB,EAAE,CAAC;YACpE,OAAO,cAAc,CAAC,uBAAuB,CAAC;QAChD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,sBAAsB,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;QAClE,CAAC;QAED,IACE,IAAI,CAAC,kBAAkB;YACvB,CAAC,CAAC,IAAI,CAAC,kBAAkB,YAAY,oBAAoB,CAAC;YAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,YAAY,uBAAuB,CAAC,EAC7D,CAAC;YACD,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YAC5D,IAAI,IAAI,CAAC,kBAAkB,YAAY,wBAAwB,EAAE,CAAC;gBAChE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAC5C,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;gBACnC,MAAM,CAAC,eAAe,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;gBAC7C,IAAI,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,oBAAoB,CAAC,EAAE,CAAC;oBAC7D,MAAM,CAAC,iBAAiB,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,CAAC;QAClC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,kBAAkB,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAC/D,eAAe,QAAQ,CAAC"}

package/dist/src/layer/layer.d.ts

@@ -7,7 +7,8 @@ import VcsEvent from '../vcsEvent.js';
 import GlobalHider from './globalHider.js';
 import type VcsMap from '../map/vcsMap.js';
 import type LayerImplementation from './layerImplementation.js';
-import type AbstractFeatureProvider from '../featureProvider/abstractFeatureProvider.js';
+import { type default as AbstractFeatureProvider, type AbstractFeatureProviderOptions } from '../featureProvider/abstractFeatureProvider.js';
+import type { default as AbstractAttributeProvider, AbstractAttributeProviderOptions } from '../featureProvider/abstractAttributeProvider.js';
 export type CopyrightOptions = {
     provider?: string;
     url?: string;
@@ -50,6 +51,14 @@ export type LayerOptions = VcsObjectOptions & {
      * Optional Request Headers which will be sent with each request.
      */
     headers?: Record<string, string>;
+    /**
+     * if true, the layer types of the map will be ignored when checking if the layer is supported
+     */
+    ignoreMapLayerTypes?: boolean;
+    /**
+     * An optional feature or attribute provider to provide or augment features on click events.
+     */
+    featureProvider?: AbstractFeatureProvider | AbstractAttributeProvider | AbstractFeatureProviderOptions | AbstractAttributeProviderOptions;
 };
 export type LayerImplementationOptions = {
     name: string;
@@ -71,12 +80,8 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
     private _state;
     private _loadingPromise;
     private _initialized;
-    /**
-     * if provided, the layer will only be shown in the given MapNames.
-     * An empty array will show the layer in all configured maps.
-     * Changes require calling layer.redraw() to take effect.
-     */
-    mapNames: string[];
+    private _mapNames;
+    readonly mapNamesChanged: VcsEvent<string[]>;
     /**
      * The class names of the supported maps.
      */
@@ -105,9 +110,9 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
      */
     stateChanged: VcsEvent<LayerState>;
     /**
-     * An optional feature provider to provider features based on click events.
+     * An optional feature or attribute provider to provide or augment features on click events.
      */
-    featureProvider: AbstractFeatureProvider | undefined;
+    featureProvider: AbstractFeatureProvider | AbstractAttributeProvider | undefined;
     private _locale;
     protected _headers?: Record<string, string>;
     /**
@@ -115,6 +120,7 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
      * to other sources of data.
      */
     datasourceId?: string;
+    private _ignoreMapLayerTypes;
     constructor(options: LayerOptions);
     /**
      * True if this layer has been initialized, typically after its first activation.
@@ -133,6 +139,13 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
     get hiddenObjectIds(): string[];
     set hiddenObjectIds(hiddenObjectIds: string[]);
     get globalHider(): GlobalHider | undefined;
+    get mapNames(): string[];
+    /**
+     * if provided, the layer will only be shown in the given MapNames.
+     * An empty array will show the layer in all configured maps.
+     * Changes will call reload on the layer.
+     */
+    set mapNames(mapNames: string[]);
     setGlobalHider(globalHider?: GlobalHider): void;
     /**
      * Indicates, that this layer is part of an exclusiveGroup
@@ -162,6 +175,12 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
      * sets the locale and reloads the layer the if the URL is a locale aware Object.
      */
     set locale(value: string);
+    get ignoreMapLayerTypes(): boolean;
+    /**
+     * if set to true, the layer types of the map will be ignored when checking if the layer is supported.
+     * Changes will call reload on the layer.
+     */
+    set ignoreMapLayerTypes(value: boolean);
     /**
      * creates an array of layer implementations for the given map.
      * @param  _map Map
@@ -236,7 +255,7 @@ declare class Layer<I extends LayerImplementation<VcsMap> = LayerImplementation<
      * Deactivates a layer, changing the internal view state
      */
     deactivate(): void;
-    toJSON(): LayerOptions;
+    toJSON(defaultOptions?: LayerOptions): LayerOptions;
     /**
      * disposes of this layer, removes instances from the current maps and the framework
      */

package/dist/src/layer/layer.js

@@ -7,6 +7,7 @@ import LayerState from './layerState.js';
 import VcsEvent from '../vcsEvent.js';
 import { layerClassRegistry } from '../classRegistry.js';
 import GlobalHider from './globalHider.js';
+import { getProviderForOption } from '../featureProvider/featureProviderFactory.js';
 /**
  * Abstract base class for Layers.
  * To create a layer Implementation the function `createImplementationsForMap` has to be implemented.
@@ -30,7 +31,9 @@ class Layer extends VcsObject {
             copyright: undefined,
             datasourceId: undefined,
             headers: undefined,
+            ignoreMapLayerTypes: false,
             zIndex: 0,
+            featureProvider: undefined,
         };
     }
     extent;
@@ -39,12 +42,8 @@ class Layer extends VcsObject {
     _state;
     _loadingPromise;
     _initialized;
-    /**
-     * if provided, the layer will only be shown in the given MapNames.
-     * An empty array will show the layer in all configured maps.
-     * Changes require calling layer.redraw() to take effect.
-     */
-    mapNames;
+    _mapNames;
+    mapNamesChanged = new VcsEvent();
     /**
      * The class names of the supported maps.
      */
@@ -66,14 +65,14 @@ class Layer extends VcsObject {
      */
     exclusiveGroupsChanged;
     copyright;
-    _implementations;
-    _activeMaps;
+    _implementations = new Map();
+    _activeMaps = new Set();
     /**
      * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
      */
     stateChanged;
     /**
-     * An optional feature provider to provider features based on click events.
+     * An optional feature or attribute provider to provide or augment features on click events.
      */
     featureProvider;
     _locale;
@@ -83,16 +82,18 @@ class Layer extends VcsObject {
      * to other sources of data.
      */
     datasourceId;
+    _ignoreMapLayerTypes;
     constructor(options) {
-        super(options);
         const defaultOptions = Layer.getDefaultOptions();
+        super({ ...defaultOptions, ...options });
         this.extent = options.extent ? new Extent(options.extent) : null;
         this.activeOnStartup = parseBoolean(options.activeOnStartup, defaultOptions.activeOnStartup);
         this._allowPicking = parseBoolean(options.allowPicking, defaultOptions.allowPicking);
         this._state = LayerState.INACTIVE;
         this._loadingPromise = null;
         this._initialized = false;
-        this.mapNames = options.mapNames ?? defaultOptions.mapNames;
+        this._mapNames =
+            options.mapNames?.slice() ?? defaultOptions.mapNames;
         this._supportedMaps = [];
         this._url = options.url;
         this._zIndex = parseInteger(options.zIndex, defaultOptions.zIndex);
@@ -106,13 +107,12 @@ class Layer extends VcsObject {
             : defaultOptions.exclusiveGroups;
         this.exclusiveGroupsChanged = new VcsEvent();
         this.copyright = options.copyright || defaultOptions.copyright;
-        this._implementations = new Map();
-        this._activeMaps = new Set();
         this.stateChanged = new VcsEvent();
-        this.featureProvider = undefined;
         this._locale = 'en';
         this.datasourceId = options.datasourceId || defaultOptions.datasourceId;
         this._headers = structuredClone(options.headers);
+        this._ignoreMapLayerTypes = parseBoolean(options.ignoreMapLayerTypes, defaultOptions.ignoreMapLayerTypes);
+        this.featureProvider = getProviderForOption(options.featureProvider);
     }
     /**
      * True if this layer has been initialized, typically after its first activation.
@@ -175,6 +175,26 @@ class Layer extends VcsObject {
     get globalHider() {
         return this._globalHider;
     }
+    get mapNames() {
+        return this._mapNames.slice();
+    }
+    /**
+     * if provided, the layer will only be shown in the given MapNames.
+     * An empty array will show the layer in all configured maps.
+     * Changes will call reload on the layer.
+     */
+    set mapNames(mapNames) {
+        check(mapNames, [String]);
+        if (mapNames.length !== this._mapNames.length ||
+            !mapNames.every((m) => this._mapNames.includes(m))) {
+            this._mapNames = mapNames.slice();
+            this.mapNamesChanged.raiseEvent(this._mapNames.slice());
+            this.forceRedraw().catch((err) => {
+                this.getLogger().error('failed to reload after mapNames setting');
+                this.getLogger().error(String(err));
+            });
+        }
+    }
     setGlobalHider(globalHider) {
         check(globalHider, maybe(GlobalHider));
         if (globalHider && this.active) {
@@ -253,6 +273,23 @@ class Layer extends VcsObject {
             }
         }
     }
+    get ignoreMapLayerTypes() {
+        return this._ignoreMapLayerTypes;
+    }
+    /**
+     * if set to true, the layer types of the map will be ignored when checking if the layer is supported.
+     * Changes will call reload on the layer.
+     */
+    set ignoreMapLayerTypes(value) {
+        check(value, Boolean);
+        if (this._ignoreMapLayerTypes !== value) {
+            this._ignoreMapLayerTypes = value;
+            this.reload().catch((err) => {
+                this.getLogger().error('failed to reload after setting ignoreMapLayerTypes');
+                this.getLogger().error(String(err));
+            });
+        }
+    }
     /**
      * creates an array of layer implementations for the given map.
      * @param  _map Map
@@ -269,20 +306,51 @@ class Layer extends VcsObject {
      */
     getImplementationsForMap(map) {
         if (!this._implementations.has(map)) {
+            let currentlySupported = this.isSupported(map);
+            let destroy;
+            const layerTypesChangedListener = map.layerTypesChanged.addEventListener(() => {
+                const nowSupported = this.isSupported(map);
+                if (currentlySupported !== nowSupported) {
+                    currentlySupported = nowSupported;
+                    // either destroy current implementation or remove the empty array for unsupported layers.
+                    // either way we have to reset this map if the inclusion changes
+                    destroy();
+                    if (this.initialized &&
+                        map.active &&
+                        (this.active || this.loading)) {
+                        this.getImplementationsForMap(map);
+                        if (nowSupported) {
+                            this._activateImplsForMap(map).catch(() => {
+                                this.getLogger().error(`Layer ${this.name} could not activate impl for map ${map.name} after layerTypesChanged`);
+                            });
+                        }
+                    }
+                }
+            });
+            destroy = () => {
+                layerTypesChangedListener();
+                this._implementations.get(map)?.implementations?.forEach((i) => {
+                    i.destroy();
+                });
+                this._implementations.delete(map);
+            };
             if (this.isSupported(map)) {
-                this._implementations.set(map, this.createImplementationsForMap(map));
+                this._implementations.set(map, {
+                    implementations: this.createImplementationsForMap(map),
+                    destroy,
+                });
             }
             else {
-                this._implementations.set(map, []);
+                this._implementations.set(map, { implementations: [], destroy });
             }
         }
-        return this._implementations.get(map);
+        return this._implementations.get(map).implementations;
     }
     /**
      * Returns all implementation of this layer for all maps
      */
     getImplementations() {
-        return [...this._implementations.values()].flat();
+        return [...this._implementations.values()].flatMap((i) => i.implementations);
     }
     getImplementationOptions() {
         return {
@@ -367,19 +435,22 @@ class Layer extends VcsObject {
      */
     removedFromMap(map) {
         this._activeMaps.delete(map);
-        this.getImplementationsForMap(map).forEach((impl) => {
-            impl.destroy();
-        });
-        this._implementations.delete(map);
+        this._implementations.get(map)?.destroy();
     }
     /**
      * checks if the currently active map supports this layer
      * @param  map
      */
     isSupported(map) {
-        return (map &&
-            this._supportedMaps.includes(map.className) &&
-            (this.mapNames.length === 0 || this.mapNames.indexOf(map.name) >= 0));
+        if (!map) {
+            return false;
+        }
+        const isSupportedMap = () => this._supportedMaps.includes(map.className);
+        const isAllowedMapName = () => this._mapNames.length === 0 || this._mapNames.includes(map.name);
+        const isAllowedLayerType = () => this._ignoreMapLayerTypes ||
+            map.layerTypes.length === 0 ||
+            map.layerTypes.includes(this.className);
+        return (!!map && isSupportedMap() && isAllowedMapName() && isAllowedLayerType());
     }
     async _activateImplsForMap(map) {
         const impls = this.getImplementationsForMap(map);
@@ -389,9 +460,12 @@ class Layer extends VcsObject {
         catch (err) {
             this.getLogger().error(`Layer ${this.name} could not activate impl for map ${map.name}`);
             this.getLogger().error(String(err));
-            this._implementations.set(map, []);
-            impls.forEach((i) => {
-                i.destroy();
+            this._implementations.get(map)?.destroy();
+            this._implementations.set(map, {
+                implementations: [],
+                destroy: () => {
+                    this._implementations.delete(map);
+                },
             });
         }
     }
@@ -407,7 +481,7 @@ class Layer extends VcsObject {
         if (this._state !== LayerState.LOADING) {
             return;
         }
-        await Promise.all([...this._activeMaps].map((m) => this._activateImplsForMap(m)));
+        await Promise.all([...this._activeMaps.keys()].map((m) => this._activateImplsForMap(m)));
         if (this._state !== LayerState.LOADING) {
             return;
         }
@@ -467,17 +541,16 @@ class Layer extends VcsObject {
             }
         }
     }
-    toJSON() {
-        const config = super.toJSON();
-        const defaultOptions = Layer.getDefaultOptions();
+    toJSON(defaultOptions = Layer.getDefaultOptions()) {
+        const config = super.toJSON(defaultOptions);
         if (this.activeOnStartup !== defaultOptions.activeOnStartup) {
             config.activeOnStartup = this.activeOnStartup;
         }
         if (this.allowPicking !== defaultOptions.allowPicking) {
             config.allowPicking = this.allowPicking;
         }
-        if (this.mapNames.length > 0) {
-            config.mapNames = this.mapNames.slice();
+        if (this._mapNames.length > 0) {
+            config.mapNames = this._mapNames.slice();
         }
         if (this.hiddenObjectIds.length > 0) {
             config.hiddenObjectIds = this.hiddenObjectIds.slice();
@@ -503,6 +576,12 @@ class Layer extends VcsObject {
         if (this._zIndex !== defaultOptions.zIndex) {
             config.zIndex = this._zIndex;
         }
+        if (this._ignoreMapLayerTypes !== defaultOptions.ignoreMapLayerTypes) {
+            config.ignoreMapLayerTypes = this._ignoreMapLayerTypes;
+        }
+        if (this.featureProvider) {
+            config.featureProvider = this.featureProvider.toJSON();
+        }
         return config;
     }
     /**
@@ -522,6 +601,7 @@ class Layer extends VcsObject {
         this.stateChanged.destroy();
         this.zIndexChanged.destroy();
         this.exclusiveGroupsChanged.destroy();
+        this.mapNamesChanged.destroy();
     }
 }
 layerClassRegistry.registerClass(Layer.className, Layer);