@vcmap/core 5.0.0-rc.9 → 5.0.1

package/dist/src/featureProvider/abstractFeatureProvider.js

@@ -0,0 +1,133 @@
+import { v4 as uuidv4 } from 'uuid';
+import { parseBoolean } from '@vcsuite/parsers';
+import { vcsLayerName } from '../layer/layerSymbols.js';
+import VcsObject from '../vcsObject.js';
+import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
+import { defaultVectorStyle } from '../style/vectorStyleItem.js';
+import VectorProperties from '../layer/vectorProperties.js';
+import { isProvidedFeature } from './featureProviderSymbols.js';
+/**
+ * An abstract class providing features for {@link Layer}s which cannot provide features directly, but can provide features for
+ * a given location, e.g. WmsLayer with a getFeatureInfo configuration. In this case, a feature provider can be created for this layer.
+ */
+class AbstractFeatureProvider extends VcsObject {
+    static get className() {
+        return 'AbstractFeatureProvider';
+    }
+    static getDefaultOptions() {
+        return {
+            vectorProperties: {
+                allowPicking: false,
+            },
+            showGeometry: false,
+            mapTypes: [],
+        };
+    }
+    /**
+     * The layer name of the associated layer
+     */
+    layerName;
+    /**
+     * The style set on features created by this provider
+     */
+    style;
+    /**
+     * Whether to show the geometry on selection.
+     */
+    showGeometry;
+    /**
+     * The vector properties assigned to features created by this provider
+     */
+    vectorProperties;
+    /**
+     * Map ClassNames Can be used to only apply this featureProvider to the specified maps
+     */
+    mapTypes;
+    constructor(layerName, options) {
+        super(options);
+        const defaultOptions = AbstractFeatureProvider.getDefaultOptions();
+        this.layerName = layerName;
+        this.style = options.style
+            ? getStyleOrDefaultStyle(options.style, defaultVectorStyle.clone())
+            : undefined;
+        this.showGeometry = parseBoolean(options.showGeometry, defaultOptions.showGeometry);
+        this.vectorProperties =
+            options.vectorProperties instanceof VectorProperties
+                ? options.vectorProperties
+                : new VectorProperties({
+                    ...defaultOptions.vectorProperties,
+                    ...options.vectorProperties,
+                });
+        this.mapTypes = Array.isArray(options.mapTypes)
+            ? options.mapTypes
+            : defaultOptions.mapTypes;
+    }
+    /**
+     * checks if the featureProvider is supported for provided Map
+     */
+    isSupported(map) {
+        return (map &&
+            (this.mapTypes.length === 0 || this.mapTypes.includes(map.className)));
+    }
+    /**
+     * Ensures the feature has an ID, applies all vectorProperties and adds style and the vcsLayerName
+     * and isProvidedFeature symbols to the feature
+     */
+    getProviderFeature(feature) {
+        if (!feature.getId()) {
+            feature.setId(uuidv4());
+        }
+        if (this.style) {
+            feature.setStyle(this.style.style);
+        }
+        feature[vcsLayerName] = this.layerName;
+        feature[isProvidedFeature] = true;
+        Object.entries(this.vectorProperties.getValues()).forEach(([key, value]) => {
+            const olcsKey = `olcs_${key}`;
+            if (feature.get(olcsKey) === undefined && value !== undefined) {
+                feature.set(olcsKey, value);
+            }
+        });
+        return feature;
+    }
+    /**
+     * This method must be overwritten by any implementations. Before returning the array of features, be sure to use the getProviderFeature
+     * on each feature to ensure all properties and symbols required by the VCM architecture
+     * to handle your feature is called: (e.g. <code>return features.map(f => this.getProviderFeature(f)</code>);
+     * @param coordinate - in mercator
+     * @param resolution - meters per pixel for the given location
+     */
+    // eslint-disable-next-line no-unused-vars,class-methods-use-this
+    getFeaturesByCoordinate(_coordinate, _resolution) {
+        return Promise.resolve([]);
+    }
+    /**
+     * Returns the object required to configure this feature provider.
+     */
+    toJSON() {
+        const config = super.toJSON();
+        const defaultOptions = AbstractFeatureProvider.getDefaultOptions();
+        delete config.name; // the name is irrelevant, since its the layers name
+        if (this.showGeometry !== defaultOptions.showGeometry) {
+            config.showGeometry = this.showGeometry;
+        }
+        if (this.style) {
+            config.style = this.style.toJSON();
+        }
+        const vectorPropertiesConfig = this.vectorProperties.getVcsMeta({
+            ...VectorProperties.getDefaultOptions(),
+            ...defaultOptions.vectorProperties,
+        });
+        if (Object.keys(vectorPropertiesConfig).length > 0) {
+            config.vectorProperties = vectorPropertiesConfig;
+        }
+        return config;
+    }
+    destroy() {
+        this.style = undefined;
+        this.vectorProperties.destroy();
+        super.destroy();
+    }
+}
+export default AbstractFeatureProvider;
+//# sourceMappingURL=abstractFeatureProvider.js.map

package/dist/src/featureProvider/abstractFeatureProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractFeatureProvider.js","sourceRoot":"","sources":["../../../src/featureProvider/abstractFeatureProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIhD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,SAAoC,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,gBAEN,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAuBhE;;;GAGG;AACH,MAAM,uBAAwB,SAAQ,SAAS;IAC7C,MAAM,KAAK,SAAS;QAClB,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO;YACL,gBAAgB,EAAE;gBAChB,YAAY,EAAE,KAAK;aACpB;YACD,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,EAAE;SACb,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS,CAAS;IAElB;;OAEG;IACH,KAAK,CAAwB;IAE7B;;OAEG;IACH,YAAY,CAAU;IAEtB;;OAEG;IACH,gBAAgB,CAAmB;IAEnC;;OAEG;IACH,QAAQ,CAAW;IAEnB,YAAY,SAAiB,EAAE,OAAuC;QACpE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,cAAc,GAAG,uBAAuB,CAAC,iBAAiB,EAAE,CAAC;QAEnE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK;YACxB,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,EAAE,CAAC;YACnE,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,CAAC,YAAY,GAAG,YAAY,CAC9B,OAAO,CAAC,YAAY,EACpB,cAAc,CAAC,YAAY,CAC5B,CAAC;QAEF,IAAI,CAAC,gBAAgB;YACnB,OAAO,CAAC,gBAAgB,YAAY,gBAAgB;gBAClD,CAAC,CAAC,OAAO,CAAC,gBAAgB;gBAC1B,CAAC,CAAC,IAAI,gBAAgB,CAAC;oBACnB,GAAG,cAAc,CAAC,gBAAgB;oBAClC,GAAG,OAAO,CAAC,gBAAgB;iBAC5B,CAAC,CAAC;QAET,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC7C,CAAC,CAAC,OAAO,CAAC,QAAQ;YAClB,CAAC,CAAE,cAAc,CAAC,QAAqB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,GAAW;QACrB,OAAO,CACL,GAAG;YACH,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,OAAgB;QACjC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;SACzB;QACD,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACvC,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;QAClC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CACvD,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACf,MAAM,OAAO,GAAG,QAAQ,GAAG,EAAE,CAAC;YAC9B,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE;gBAC7D,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aAC7B;QACH,CAAC,CACF,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,iEAAiE;IACjE,uBAAuB,CACrB,WAAuB,EACvB,WAAmB;QAEnB,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,MAAM,GAAmC,KAAK,CAAC,MAAM,EAAE,CAAC;QAE9D,MAAM,cAAc,GAAG,uBAAuB,CAAC,iBAAiB,EAAE,CAAC;QACnE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,oDAAoD;QAExE,IAAI,IAAI,CAAC,YAAY,KAAK,cAAc,CAAC,YAAY,EAAE;YACrD,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;SACzC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;SACpC;QAED,MAAM,sBAAsB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;YAC9D,GAAG,gBAAgB,CAAC,iBAAiB,EAAE;YACvC,GAAG,cAAc,CAAC,gBAAgB;SACnC,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAClD,MAAM,CAAC,gBAAgB,GAAG,sBAAsB,CAAC;SAClD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAChC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,eAAe,uBAAuB,CAAC"}

package/dist/src/featureProvider/featureProviderSymbols.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Added to ol.Feature, if they are not part of a layer, but provided by an {@link AbstractFeatureProvider}.
+ */
+export declare const isProvidedFeature: unique symbol;

package/dist/src/featureProvider/featureProviderSymbols.js

@@ -0,0 +1,6 @@
+/**
+ * Added to ol.Feature, if they are not part of a layer, but provided by an {@link AbstractFeatureProvider}.
+ */
+// eslint-disable-next-line import/prefer-default-export
+export const isProvidedFeature = Symbol('isProvidedFeature');
+//# sourceMappingURL=featureProviderSymbols.js.map

package/dist/src/featureProvider/featureProviderSymbols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureProviderSymbols.js","sourceRoot":"","sources":["../../../src/featureProvider/featureProviderSymbols.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wDAAwD;AACxD,MAAM,CAAC,MAAM,iBAAiB,GAAkB,MAAM,CAAC,mBAAmB,CAAC,CAAC"}

package/dist/src/featureProvider/tileProviderFeatureProvider.d.ts

@@ -0,0 +1,19 @@
+import type { Coordinate } from 'ol/coordinate.js';
+import type { Feature } from 'ol/index.js';
+import AbstractFeatureProvider, { type AbstractFeatureProviderOptions } from './abstractFeatureProvider.js';
+import type TileProvider from '../layer/tileProvider/tileProvider.js';
+export type TileProviderFeatureProviderOptions = AbstractFeatureProviderOptions & {
+    tileProvider: TileProvider;
+};
+declare class TileProviderFeatureProvider extends AbstractFeatureProvider {
+    static get className(): string;
+    tileProvider: TileProvider;
+    /**
+     * @param  layerName
+     * @param  options
+     */
+    constructor(layerName: string, options: TileProviderFeatureProviderOptions);
+    getFeaturesByCoordinate(coordinate: Coordinate, resolution: number): Promise<Feature[]>;
+    destroy(): void;
+}
+export default TileProviderFeatureProvider;

package/dist/src/featureProvider/tileProviderFeatureProvider.js

@@ -0,0 +1,30 @@
+import AbstractFeatureProvider from './abstractFeatureProvider.js';
+import { featureProviderClassRegistry } from '../classRegistry.js';
+class TileProviderFeatureProvider extends AbstractFeatureProvider {
+    static get className() {
+        return 'TileProviderFeatureProvider';
+    }
+    tileProvider;
+    /**
+     * @param  layerName
+     * @param  options
+     */
+    constructor(layerName, options) {
+        super(layerName, options);
+        this.mapTypes = ['CesiumMap'];
+        this.tileProvider = options.tileProvider;
+    }
+    async getFeaturesByCoordinate(coordinate, resolution) {
+        const features = await this.tileProvider.getFeaturesByCoordinate(coordinate, resolution);
+        return features.filter((feature) => {
+            return this.vectorProperties.getAllowPicking(feature);
+        });
+    }
+    destroy() {
+        this.tileProvider.destroy();
+        super.destroy();
+    }
+}
+export default TileProviderFeatureProvider;
+featureProviderClassRegistry.registerClass(TileProviderFeatureProvider.className, TileProviderFeatureProvider);
+//# sourceMappingURL=tileProviderFeatureProvider.js.map

package/dist/src/featureProvider/tileProviderFeatureProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tileProviderFeatureProvider.js","sourceRoot":"","sources":["../../../src/featureProvider/tileProviderFeatureProvider.ts"],"names":[],"mappings":"AAEA,OAAO,uBAEN,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AAQnE,MAAM,2BAA4B,SAAQ,uBAAuB;IAC/D,MAAM,KAAK,SAAS;QAClB,OAAO,6BAA6B,CAAC;IACvC,CAAC;IAED,YAAY,CAAe;IAE3B;;;OAGG;IACH,YAAY,SAAiB,EAAE,OAA2C;QACxE,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE1B,IAAI,CAAC,QAAQ,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,uBAAuB,CAC3B,UAAsB,EACtB,UAAkB;QAElB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAC9D,UAAU,EACV,UAAU,CACX,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,eAAe,2BAA2B,CAAC;AAC3C,4BAA4B,CAAC,aAAa,CACxC,2BAA2B,CAAC,SAAS,EACrC,2BAA2B,CAC5B,CAAC"}

package/dist/src/featureProvider/wmsFeatureProvider.d.ts

@@ -0,0 +1,91 @@
+import GML2 from 'ol/format/GML2.js';
+import type { Options as GMLOptions } from 'ol/format/GMLBase.js';
+import { type GeoJSONObject, type Options as GeoJSONOptions } from 'ol/format/GeoJSON.js';
+import GML3 from 'ol/format/GML3.js';
+import type { Size } from 'ol/size.js';
+import type { Feature } from 'ol/index.js';
+import type { Coordinate } from 'ol/coordinate.js';
+import type { TileWMS } from 'ol/source.js';
+import type FeatureFormat from 'ol/format/Feature.js';
+import AbstractFeatureProvider, { AbstractFeatureProviderOptions } from './abstractFeatureProvider.js';
+import Projection, { ProjectionOptions } from '../util/projection.js';
+import Extent, { ExtentOptions } from '../util/extent.js';
+import { TilingScheme } from '../layer/rasterLayer.js';
+export type FormatOptions = GeoJSONOptions & GMLOptions & Record<string, unknown> & {
+    gmlFormat?: keyof typeof gmlFormats;
+};
+export type WMSFeatureProviderOptions = AbstractFeatureProviderOptions & {
+    /**
+     * the response type for the feature info
+     * @default 'text/xml'
+     */
+    responseType?: string;
+    /**
+     * format options for the GeojsonLayer, WfsLayer or GML format. To overwrite the gmlFormat option in WfsLayer format, use 'GML', 'GML2' or 'GML3' as string
+     */
+    formatOptions?: FormatOptions;
+    /**
+     * the projection of the data, if not encoded in the response
+     */
+    projection?: ProjectionOptions;
+    url: string;
+    /**
+     * @default {@link TilingScheme.GEOGRAPHIC}
+     */
+    tilingSchema?: TilingScheme;
+    /**
+     * @default 18
+     */
+    maxLevel?: number;
+    /**
+     * @default 0
+     */
+    minLevel?: number;
+    /**
+     * @default [256, 256]
+     */
+    tileSize?: Size;
+    extent?: Extent | ExtentOptions;
+    parameters: Record<string, string>;
+    /**
+     * @default '1.1.1'
+     */
+    version?: string;
+};
+declare const gmlFormats: {
+    GML: typeof GML3;
+    GML2: typeof GML2;
+    GML3: typeof GML3;
+};
+export declare function getFormat(responseType: string, options?: FormatOptions): null | FeatureFormat;
+declare class WMSFeatureProvider extends AbstractFeatureProvider {
+    static get className(): string;
+    static getDefaultOptions(): WMSFeatureProviderOptions;
+    extent: Extent | null;
+    private _wmsSourceOptions;
+    /**
+     * The WmsLayer Source used to generate getFeatureInfo urls
+     */
+    private _wmsSource;
+    /**
+     * The response type of the get feature info response, e.g. text/xml
+     */
+    featureInfoResponseType: string;
+    private _formatOptions;
+    /**
+     * The feature response format determined by the response type. Use formatOptions to configure the underlying ol.format.Feature
+     */
+    featureFormat: FeatureFormat | null;
+    /**
+     * The feature response projection, if not present in the response format.
+     */
+    projection: Projection | undefined;
+    constructor(layerName: string, options: WMSFeatureProviderOptions);
+    get wmsSource(): TileWMS;
+    set wmsSource(source: TileWMS);
+    featureResponseCallback(data: GeoJSONObject, coordinate: Coordinate): Feature[];
+    getFeaturesByCoordinate(coordinate: Coordinate, resolution: number): Promise<Feature[]>;
+    toJSON(): WMSFeatureProviderOptions;
+    destroy(): void;
+}
+export default WMSFeatureProvider;

package/dist/src/featureProvider/wmsFeatureProvider.js

@@ -0,0 +1,214 @@
+import GML2 from 'ol/format/GML2.js';
+import WFS from 'ol/format/WFS.js';
+import GeoJSON from 'ol/format/GeoJSON.js';
+import GML3 from 'ol/format/GML3.js';
+import Point from 'ol/geom/Point.js';
+import { getTransform } from 'ol/proj.js';
+import { parseInteger } from '@vcsuite/parsers';
+import AbstractFeatureProvider from './abstractFeatureProvider.js';
+import Projection, { mercatorProjection, } from '../util/projection.js';
+import { getWMSSource } from '../layer/wmsHelpers.js';
+import Extent from '../util/extent.js';
+import { requestJson } from '../util/fetch.js';
+import { featureProviderClassRegistry } from '../classRegistry.js';
+import { TilingScheme } from '../layer/rasterLayer.js';
+const gmlFormats = {
+    GML: GML3,
+    GML2,
+    GML3,
+};
+const geojsonFormats = [
+    'application/geojson',
+    'application/json',
+    'application/vnd.geo+json',
+    'application/geo+json',
+];
+export function getFormat(responseType, options = {}) {
+    if (responseType === 'text/xml') {
+        const gmlFormat = options.gmlFormat
+            ? new gmlFormats[options.gmlFormat]()
+            : new GML2();
+        return new WFS({ ...options, gmlFormat });
+    }
+    if (geojsonFormats.includes(responseType)) {
+        return new GeoJSON(options);
+    }
+    if (responseType === 'application/vnd.ogc.gml') {
+        return new GML2(options);
+    }
+    if (responseType === 'application/vnd.ogc.gml/3.1.1' ||
+        responseType === 'text/xml; subtype=gml/3.1.1') {
+        return new GML3(options);
+    }
+    return null;
+}
+class WMSFeatureProvider extends AbstractFeatureProvider {
+    static get className() {
+        return 'WMSFeatureProvider';
+    }
+    static getDefaultOptions() {
+        return {
+            ...AbstractFeatureProvider.getDefaultOptions(),
+            responseType: 'text/xml',
+            style: undefined,
+            formatOptions: undefined,
+            projection: undefined,
+            url: '',
+            tilingSchema: TilingScheme.GEOGRAPHIC,
+            version: '1.1.1',
+            maxLevel: 0,
+            minLevel: 0,
+            tileSize: [256, 256],
+            parameters: {},
+            extent: undefined,
+        };
+    }
+    extent = null;
+    _wmsSourceOptions;
+    /**
+     * The WmsLayer Source used to generate getFeatureInfo urls
+     */
+    _wmsSource;
+    /**
+     * The response type of the get feature info response, e.g. text/xml
+     */
+    featureInfoResponseType;
+    _formatOptions;
+    /**
+     * The feature response format determined by the response type. Use formatOptions to configure the underlying ol.format.Feature
+     */
+    featureFormat;
+    /**
+     * The feature response projection, if not present in the response format.
+     */
+    projection;
+    constructor(layerName, options) {
+        super(layerName, options);
+        const defaultOptions = WMSFeatureProvider.getDefaultOptions();
+        if (options.extent) {
+            if (options.extent instanceof Extent) {
+                this.extent = options.extent;
+            }
+            else {
+                this.extent = new Extent(options.extent);
+            }
+        }
+        this._wmsSourceOptions = {
+            url: options.url,
+            tilingSchema: options.tilingSchema || defaultOptions.tilingSchema,
+            maxLevel: parseInteger(options.maxLevel, defaultOptions.maxLevel),
+            minLevel: parseInteger(options.minLevel, defaultOptions.minLevel),
+            tileSize: options.tileSize || defaultOptions.tileSize,
+            parameters: options.parameters,
+            version: options.version || defaultOptions.version,
+        };
+        this._wmsSource = getWMSSource(this._wmsSourceOptions);
+        this.featureInfoResponseType =
+            options.responseType || defaultOptions.responseType;
+        this._formatOptions = options.formatOptions || defaultOptions.formatOptions;
+        this.featureFormat = getFormat(this.featureInfoResponseType, options.formatOptions);
+        this.projection = options.projection
+            ? new Projection(options.projection)
+            : undefined;
+    }
+    get wmsSource() {
+        if (!this._wmsSource) {
+            throw new Error('Accessing destroyed WMSFeatureProvider');
+        }
+        return this._wmsSource;
+    }
+    set wmsSource(source) {
+        this._wmsSource = source;
+    }
+    featureResponseCallback(data, coordinate) {
+        let features;
+        try {
+            features = this.featureFormat.readFeatures(data, {
+                dataProjection: this.projection ? this.projection.proj : undefined,
+                featureProjection: mercatorProjection.proj,
+            });
+        }
+        catch (ex) {
+            this.getLogger().warning('Features could not be read, please verify the featureInfoResponseType with the capabilities from the server');
+            return [];
+        }
+        if (Array.isArray(features)) {
+            features.forEach((feature) => {
+                const geometry = feature.getGeometry();
+                if (!geometry) {
+                    feature.setGeometry(new Point(coordinate));
+                }
+            });
+            return features;
+        }
+        return [];
+    }
+    async getFeaturesByCoordinate(coordinate, resolution) {
+        const projection = this.wmsSource.getProjection();
+        let coords = coordinate;
+        if (projection) {
+            const transform = getTransform(mercatorProjection.proj, projection);
+            // error in TransformFunction type definition, remove undefined after openlayer fixed the type
+            coords = transform(coordinate.slice(), undefined, undefined);
+        }
+        const metersPerUnit = 111194.87428468118;
+        const url = this.wmsSource.getFeatureInfoUrl(coords, resolution / metersPerUnit, projection, { INFO_FORMAT: this.featureInfoResponseType });
+        if (url) {
+            let data;
+            try {
+                data = await requestJson(url);
+            }
+            catch (ex) {
+                this.getLogger().error(`Failed fetching WMS FeatureInfo ${url}`);
+                return [];
+            }
+            return this.featureResponseCallback(data, coordinate).map((f) => this.getProviderFeature(f));
+        }
+        return [];
+    }
+    toJSON() {
+        const config = super.toJSON();
+        const defaultOptions = WMSFeatureProvider.getDefaultOptions();
+        if (this.featureInfoResponseType !== defaultOptions.responseType) {
+            config.responseType = this.featureInfoResponseType;
+        }
+        if (this._formatOptions !== defaultOptions.formatOptions) {
+            config.formatOptions = { ...this._formatOptions };
+        }
+        if (this.projection) {
+            config.projection = this.projection.toJSON();
+        }
+        config.url = this._wmsSourceOptions.url;
+        config.parameters = { ...this._wmsSourceOptions.parameters };
+        if (this._wmsSourceOptions.tilingSchema !== defaultOptions.tilingSchema) {
+            config.tilingSchema = this._wmsSourceOptions.tilingSchema;
+        }
+        if (this._wmsSourceOptions.maxLevel !== defaultOptions.maxLevel) {
+            config.maxLevel = this._wmsSourceOptions.maxLevel;
+        }
+        if (this._wmsSourceOptions.minLevel !== defaultOptions.minLevel) {
+            config.minLevel = this._wmsSourceOptions.minLevel;
+        }
+        if (this._wmsSourceOptions.version !== defaultOptions.version) {
+            config.version = this._wmsSourceOptions.version;
+        }
+        if (this._wmsSourceOptions.tileSize[0] !== defaultOptions?.tileSize?.[0] ||
+            this._wmsSourceOptions.tileSize[1] !== defaultOptions?.tileSize?.[1]) {
+            config.tileSize = this._wmsSourceOptions.tileSize.slice();
+        }
+        if (this.extent) {
+            config.extent = this.extent.toJSON();
+        }
+        return config;
+    }
+    destroy() {
+        this._wmsSource = undefined;
+        this.featureFormat = null;
+        this.projection = undefined;
+        this._formatOptions = undefined;
+        super.destroy();
+    }
+}
+export default WMSFeatureProvider;
+featureProviderClassRegistry.registerClass(WMSFeatureProvider.className, WMSFeatureProvider);
+//# sourceMappingURL=wmsFeatureProvider.js.map

package/dist/src/featureProvider/wmsFeatureProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wmsFeatureProvider.js","sourceRoot":"","sources":["../../../src/featureProvider/wmsFeatureProvider.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,mBAAmB,CAAC;AAErC,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,OAGN,MAAM,sBAAsB,CAAC;AAC9B,OAAO,IAAI,MAAM,mBAAmB,CAAC;AACrC,OAAO,KAAK,MAAM,kBAAkB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAmC,MAAM,YAAY,CAAC;AAM3E,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,uBAEN,MAAM,8BAA8B,CAAC;AACtC,OAAO,UAAU,EAAE,EACjB,kBAAkB,GAEnB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,MAAyB,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AA6CvD,MAAM,UAAU,GAAG;IACjB,GAAG,EAAE,IAAI;IACT,IAAI;IACJ,IAAI;CACL,CAAC;AAEF,MAAM,cAAc,GAAG;IACrB,qBAAqB;IACrB,kBAAkB;IAClB,0BAA0B;IAC1B,sBAAsB;CACvB,CAAC;AAEF,MAAM,UAAU,SAAS,CACvB,YAAoB,EACpB,UAAyB,EAAE;IAE3B,IAAI,YAAY,KAAK,UAAU,EAAE;QAC/B,MAAM,SAAS,GAAgB,OAAO,CAAC,SAAS;YAC9C,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACrC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,GAAG,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;KAC3C;IACD,IAAI,cAAc,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;QACzC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;KAC7B;IACD,IAAI,YAAY,KAAK,yBAAyB,EAAE;QAC9C,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;KAC1B;IACD,IACE,YAAY,KAAK,+BAA+B;QAChD,YAAY,KAAK,6BAA6B,EAC9C;QACA,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;KAC1B;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,kBAAmB,SAAQ,uBAAuB;IACtD,MAAM,KAAK,SAAS;QAClB,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,iBAAiB;QACtB,OAAO;YACL,GAAG,uBAAuB,CAAC,iBAAiB,EAAE;YAC9C,YAAY,EAAE,UAAU;YACxB,KAAK,EAAE,SAAS;YAChB,aAAa,EAAE,SAAS;YACxB,UAAU,EAAE,SAAS;YACrB,GAAG,EAAE,EAAE;YACP,YAAY,EAAE,YAAY,CAAC,UAAU;YACrC,OAAO,EAAE,OAAO;YAChB,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACpB,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,SAAS;SAClB,CAAC;IACJ,CAAC;IAED,MAAM,GAAkB,IAAI,CAAC;IAErB,iBAAiB,CAAmB;IAE5C;;OAEG;IACK,UAAU,CAAsB;IAExC;;OAEG;IACH,uBAAuB,CAAS;IAExB,cAAc,CAA4B;IAElD;;OAEG;IACH,aAAa,CAAuB;IAEpC;;OAEG;IACH,UAAU,CAAyB;IAEnC,YAAY,SAAiB,EAAE,OAAkC;QAC/D,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC1B,MAAM,cAAc,GAAG,kBAAkB,CAAC,iBAAiB,EAAE,CAAC;QAE9D,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,IAAI,OAAO,CAAC,MAAM,YAAY,MAAM,EAAE;gBACpC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;aAC9B;iBAAM;gBACL,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aAC1C;SACF;QACD,IAAI,CAAC,iBAAiB,GAAG;YACvB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,YAAY,EACV,OAAO,CAAC,YAAY,IAAK,cAAc,CAAC,YAA6B;YACvE,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;YACjE,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;YACjE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAK,cAAc,CAAC,QAAiB;YAC/D,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAK,cAAc,CAAC,OAAkB;SAC/D,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACvD,IAAI,CAAC,uBAAuB;YAC1B,OAAO,CAAC,YAAY,IAAK,cAAc,CAAC,YAAuB,CAAC;QAElE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC,aAAa,CAAC;QAC5E,IAAI,CAAC,aAAa,GAAG,SAAS,CAC5B,IAAI,CAAC,uBAAuB,EAC5B,OAAO,CAAC,aAAa,CACtB,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU;YAClC,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC;YACpC,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,IAAI,SAAS;QACX,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;SAC3D;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,CAAC,MAAe;QAC3B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;IAED,uBAAuB,CACrB,IAAmB,EACnB,UAAsB;QAEtB,IAAI,QAAmB,CAAC;QAExB,IAAI;YACF,QAAQ,GAAG,IAAI,CAAC,aAAc,CAAC,YAAY,CAAC,IAAI,EAAE;gBAChD,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;gBAClE,iBAAiB,EAAE,kBAAkB,CAAC,IAAI;aAC3C,CAAc,CAAC;SACjB;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,SAAS,EAAE,CAAC,OAAO,CACtB,6GAA6G,CAC9G,CAAC;YACF,OAAO,EAAE,CAAC;SACX;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC3B,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,EAAE;oBACb,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;iBAC5C;YACH,CAAC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;SACjB;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,uBAAuB,CAC3B,UAAsB,EACtB,UAAkB;QAElB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAkB,CAAC;QAClE,IAAI,MAAM,GAAG,UAAU,CAAC;QACxB,IAAI,UAAU,EAAE;YACd,MAAM,SAAS,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACpE,8FAA8F;YAC9F,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;SAC9D;QAED,MAAM,aAAa,GAAG,kBAAkB,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC1C,MAAM,EACN,UAAU,GAAG,aAAa,EAC1B,UAAU,EACV,EAAE,WAAW,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAC9C,CAAC;QAEF,IAAI,GAAG,EAAE;YACP,IAAI,IAAmB,CAAC;YACxB,IAAI;gBACF,IAAI,GAAG,MAAM,WAAW,CAAgB,GAAG,CAAC,CAAC;aAC9C;YAAC,OAAO,EAAE,EAAE;gBACX,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,mCAAmC,GAAG,EAAE,CAAC,CAAC;gBACjE,OAAO,EAAE,CAAC;aACX;YACD,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC9D,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAC3B,CAAC;SACH;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAuC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClE,MAAM,cAAc,GAAG,kBAAkB,CAAC,iBAAiB,EAAE,CAAC;QAC9D,IAAI,IAAI,CAAC,uBAAuB,KAAK,cAAc,CAAC,YAAY,EAAE;YAChE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC;SACpD;QAED,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,aAAa,EAAE;YACxD,MAAM,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;SACnD;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;SAC9C;QAED,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC;QACxC,MAAM,CAAC,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;QAE7D,IAAI,IAAI,CAAC,iBAAiB,CAAC,YAAY,KAAK,cAAc,CAAC,YAAY,EAAE;YACvE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;SAC3D;QACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,EAAE;YAC/D,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;SACnD;QACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,EAAE;YAC/D,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;SACnD;QACD,IAAI,IAAI,CAAC,iBAAiB,CAAC,OAAO,KAAK,cAAc,CAAC,OAAO,EAAE;YAC7D,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;SACjD;QACD,IACE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EACpE;YACA,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;SAC3D;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;SACtC;QAED,OAAO,MAAmC,CAAC;IAC7C,CAAC;IAED,OAAO;QACL,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,eAAe,kBAAkB,CAAC;AAClC,4BAA4B,CAAC,aAAa,CACxC,kBAAkB,CAAC,SAAS,EAC5B,kBAAkB,CACnB,CAAC"}

package/dist/src/interaction/abstractInteraction.d.ts

@@ -0,0 +1,117 @@
+import type { Cartesian2, Cesium3DTileFeature, Cesium3DTilePointFeature, Entity, Ray } from '@vcmap-cesium/engine';
+import type { Coordinate } from 'ol/coordinate.js';
+import type { Feature } from 'ol';
+import { EventType, ModificationKeyType, PointerEventType, PointerKeyType } from './interactionType.js';
+import type VcsMap from '../map/vcsMap.js';
+export type MapEvent = {
+    pointerEvent: PointerEventType;
+    map: VcsMap;
+    windowPosition: Cartesian2;
+    key: ModificationKeyType;
+    pointer: PointerKeyType;
+    /**
+     * position in web mercator coordinates
+     */
+    position?: Coordinate;
+    /**
+     * position in web mercator coordinates or image coordinates in ObliqueMap Map Mode
+     */
+    positionOrPixel?: Coordinate;
+    multipleTouch?: boolean;
+    time?: number | null;
+};
+export type ObliqueParameters = {
+    /**
+     * the image pixel clicked
+     */
+    pixel: import('ol/coordinate.js').Coordinate;
+    /**
+     * true if the terrain could not be taken into account
+     */
+    estimate?: boolean;
+};
+export type EventFeature = Feature | Cesium3DTileFeature | Cesium3DTilePointFeature | Entity;
+export type InteractionEvent = MapEvent & {
+    type: EventType;
+    /**
+     * a potential feature at said location
+     */
+    feature?: EventFeature;
+    /**
+     * if set to true, the event chain is interrupted
+     */
+    stopPropagation?: boolean;
+    /**
+     * additional parameters from oblique if obliquemode is active
+     */
+    obliqueParameters?: ObliqueParameters;
+    ray?: Ray;
+    /**
+     * whether the position is exact, eg with translucentDepthPicking on
+     */
+    exactPosition?: boolean;
+};
+export type EventAfterEventHandler = Omit<InteractionEvent, 'position' | 'positionOrPixel'> & {
+    position: Coordinate;
+    positionOrPixel: Coordinate;
+};
+/**
+ * An abstract interface for all interactions
+ * @group Interaction
+ */
+declare class AbstractInteraction {
+    /**
+     * A unique identifier for this interaction
+     */
+    id: string;
+    private _defaultActive;
+    /**
+     * The current active bitmask for {@link EventType}
+     */
+    active: number;
+    private _defaultModificationKey;
+    /**
+     * The current active {@link ModificationKeyType}
+     */
+    modificationKey: ModificationKeyType;
+    private _defaultPointerKey;
+    /**
+     * The currently active {@link PointerKeyType}
+     */
+    pointerKey: PointerKeyType;
+    /**
+     * @param  [defaultActive=EventType.NONE] - A bitmask representing the default  to listen to
+     * @param  [defaultModificationKey=ModificationKeyType.NONE] - A bitmask representing the default  keys to listen to
+     * @param  [defaultPointerKey=PointerKeyType.LEFT] - A bitmask representing the  pointer key to listen to
+     */
+    constructor(defaultActive?: EventType, defaultModificationKey?: ModificationKeyType, defaultPointerKey?: PointerKeyType);
+    /**
+     * Main function, called when an event is raised for this interaction
+     */
+    pipe(event: InteractionEvent): Promise<InteractionEvent>;
+    /**
+     * Called when the modifier keys have changed.
+     */
+    modifierChanged(_modifier: ModificationKeyType): void;
+    /**
+     * Sets the interaction active.
+     * Use boolean (true|false) to toggle default behavior.
+     * Pass it a bitmask of {@link EventType}
+     * to change the active state.
+     * Call without arguments to reset the default active, modification key and pointer Key behavior
+     */
+    setActive(active?: boolean | number): void;
+    /**
+     * Sets the modification key to listen to or the default modification key if none is provided.
+     */
+    setModification(mod?: ModificationKeyType): void;
+    /**
+     * Sets the pointer key for this interaction or the default pointer if none is provided.
+     */
+    setPointer(pointer?: PointerKeyType): void;
+    /**
+     * destroys the implementation, removing any created resources
+     */
+    destroy(): void;
+}
+export default AbstractInteraction;