@vcmap/core 5.0.0-rc.3 → 5.0.0-rc.31

package/src/{vcs/vcm/layer/featureStore.js → layer/featureStoreLayer.js}

@@ -1,34 +1,46 @@
-import axios from 'axios';
 import Feature from 'ol/Feature.js';
-import { Cesium3DTileFeature, Cesium3DTilePointFeature, ImagerySplitDirection } from '@vcmap/cesium';
+import {
+  Cesium3DTileFeature,
+  Cesium3DTilePointFeature,
+  SplitDirection,
+} from '@vcmap-cesium/engine';
 import VectorSource from 'ol/source/Vector.js';
 import { createEmpty, extend as extendExtent } from 'ol/extent.js';
 
-import Vector from './vector.js';
-import { featureStoreStateSymbol, featureStoreState } from './featureStoreState.js';
+import VectorLayer from './vectorLayer.js';
+import {
+  featureStoreStateSymbol,
+  FeatureStoreLayerState,
+} from './featureStoreLayerState.js';
 import { parseGeoJSON } from './geojsonHelpers.js';
 import { mercatorProjection } from '../util/projection.js';
-import FeatureStoreChanges from './featureStoreChanges.js';
-import VectorStyleItem, { defaultVectorStyle, vectorStyleSymbol } from '../util/style/vectorStyleItem.js';
+import FeatureStoreLayerChanges from './featureStoreLayerChanges.js';
+import VectorStyleItem, {
+  defaultVectorStyle,
+  vectorStyleSymbol,
+} from '../style/vectorStyleItem.js';
 import FeatureVisibility, {
   FeatureVisibilityAction,
   originalStyle,
   synchronizeFeatureVisibility,
   updateOriginalStyle,
 } from './featureVisibility.js';
-import CesiumTilesetCesium, { getExtentFromTileset } from './cesium/cesiumTilesetCesium.js';
-import CesiumMap from '../maps/cesium.js';
-import Openlayers from '../maps/openlayers.js';
-import Oblique from '../maps/oblique.js';
-import CesiumTileset from './cesiumTileset.js';
+import CesiumTilesetCesiumImpl, {
+  getExtentFromTileset,
+} from './cesium/cesiumTilesetCesiumImpl.js';
+import CesiumMap from '../map/cesiumMap.js';
+import OpenlayersMap from '../map/openlayersMap.js';
+import ObliqueMap from '../map/obliqueMap.js';
+import CesiumTilesetLayer from './cesiumTilesetLayer.js';
 import VectorProperties from './vectorProperties.js';
-import VectorOpenlayers from './openlayers/vectorOpenlayers.js';
+import VectorOpenlayersImpl from './openlayers/vectorOpenlayersImpl.js';
 import Layer from './layer.js';
-import DeclarativeStyleItem from '../util/style/declarativeStyleItem.js';
-import VectorOblique from './oblique/vectorOblique.js';
+import DeclarativeStyleItem from '../style/declarativeStyleItem.js';
+import VectorObliqueImpl from './oblique/vectorObliqueImpl.js';
 import Extent from '../util/extent.js';
 import { isMobile } from '../util/isMobile.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
+import { requestJson } from '../util/fetch.js';
 
 /**
  * @typedef {Object} FeatureStoreStaticRepresentation
@@ -43,7 +55,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @property {Object} properties - the properties bag
  * @property {Object} geometry
  * @property {Object|undefined} vcsMeta
- * @property {featureStoreState} state
+ * @property {FeatureStoreLayerState} state
  * @property {string} type - the featureType
  * @todo write vcsMeta for features
  * @todo set type to be one of an enum
@@ -66,7 +78,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {FeatureStoreLayerSchema} FeatureStoreOptions
- * @property {Function|undefined} injectedFetchDynamicFeatureFunc - injected function for fetching dynamic features from a remote FeatureStore server
+ * @property {Function|undefined} injectedFetchDynamicFeatureFunc - injected function for fetching dynamic features from a remote FeatureStoreLayer server
  * @api
  */
 
@@ -74,14 +86,15 @@ import { VcsClassRegistry } from '../classRegistry.js';
 export const isTiledFeature = Symbol('isTiledFeature');
 
 /**
- * FeatureStore Layer
+ * FeatureStoreLayer Layer
  * @class
- * @export
- * @extends {Vector}
+ * @extends {VectorLayer}
  * @api
  */
-class FeatureStore extends Vector {
-  static get className() { return 'vcs.vcm.layer.FeatureStore'; }
+class FeatureStoreLayer extends VectorLayer {
+  static get className() {
+    return 'FeatureStoreLayer';
+  }
 
   /**
    * @returns {FeatureStoreOptions}
@@ -89,10 +102,10 @@ class FeatureStore extends Vector {
   static getDefaultOptions() {
     return {
       id: '',
-      type: 'vcs.vcm.layer.FeatureStore',
+      type: 'FeatureStoreLayer',
       featureType: 'simple',
       features: [],
-      ...Vector.getDefaultOptions(),
+      ...VectorLayer.getDefaultOptions(),
       projection: mercatorProjection.toJSON(),
       staticRepresentation: {},
       hiddenStaticFeatureIds: [],
@@ -108,7 +121,7 @@ class FeatureStore extends Vector {
    * @param {FeatureStoreOptions} options
    */
   constructor(options) {
-    const defaultOptions = FeatureStore.getDefaultOptions();
+    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
     const vectorOptions = {
       projection: defaultOptions.projection,
       ...options,
@@ -116,8 +129,8 @@ class FeatureStore extends Vector {
     super(vectorOptions);
     this._supportedMaps = [
       CesiumMap.className,
-      Openlayers.className,
-      Oblique.className,
+      OpenlayersMap.className,
+      ObliqueMap.className,
     ];
 
     /**
@@ -130,16 +143,19 @@ class FeatureStore extends Vector {
     this.layerId = options.id;
 
     /** @type {FeatureStoreStaticRepresentation} */
-    this.staticRepresentation = options.staticRepresentation || defaultOptions.staticRepresentation;
+    this.staticRepresentation =
+      options.staticRepresentation || defaultOptions.staticRepresentation;
 
     /** @type {Set<string|number>} */
-    this.hiddenStaticFeatureIds = new Set(options.hiddenStaticFeatureIds || defaultOptions.hiddenStaticFeatureIds);
+    this.hiddenStaticFeatureIds = new Set(
+      options.hiddenStaticFeatureIds || defaultOptions.hiddenStaticFeatureIds,
+    );
 
     /**
-     * @type {FeatureStoreChanges}
+     * @type {FeatureStoreLayerChanges}
      * @api
      */
-    this.changeTracker = new FeatureStoreChanges(this);
+    this.changeTracker = new FeatureStoreLayerChanges(this);
 
     const { vcsMeta } = defaultOptions;
     if (options.vcsMeta) {
@@ -156,12 +172,13 @@ class FeatureStore extends Vector {
     this.screenSpaceError = this.vcsMeta.screenSpaceError;
 
     /**
-     * @type {import("@vcmap/cesium").Event.RemoveCallback}
+     * @type {import("@vcmap-cesium/engine").Event.RemoveCallback}
      * @private
      */
-    this._removeVectorPropertiesChangeHandler = this.vectorProperties.propertyChanged.addEventListener(() => {
-      this.changeTracker.values.changed = true;
-    });
+    this._removeVectorPropertiesChangeHandler =
+      this.vectorProperties.propertyChanged.addEventListener(() => {
+        this.changeTracker.values.changed = true;
+      });
 
     /**
      * a function to retrieve a single feature from the server
@@ -169,7 +186,8 @@ class FeatureStore extends Vector {
      * @returns {Promise<string|Object>}
      * @api
      */
-    this.injectedFetchDynamicFeatureFunc = options.injectedFetchDynamicFeatureFunc;
+    this.injectedFetchDynamicFeatureFunc =
+      options.injectedFetchDynamicFeatureFunc;
     /**
      * @type {FeatureVisibility}
      * @private
@@ -181,10 +199,15 @@ class FeatureStore extends Vector {
      * @private
      */
     this._featureVisibilitySyncListeners = [
-      synchronizeFeatureVisibility(this.featureVisibility, this._staticFeatureVisibility),
+      synchronizeFeatureVisibility(
+        this.featureVisibility,
+        this._staticFeatureVisibility,
+      ),
       this._staticFeatureVisibility.changed.addEventListener(({ action }) => {
         if (action === FeatureVisibilityAction.SHOW) {
-          this._staticFeatureVisibility.hideObjects([...this.hiddenStaticFeatureIds]);
+          this._staticFeatureVisibility.hideObjects([
+            ...this.hiddenStaticFeatureIds,
+          ]);
         }
       }),
     ];
@@ -216,10 +239,10 @@ class FeatureStore extends Vector {
         features: options.features,
         vcsMeta: options.vcsMeta,
       };
-      const { style, features } = parseGeoJSON(
-        featureCollection,
-        { targetProjection: mercatorProjection, dynamicStyle: true },
-      );
+      const { style, features } = parseGeoJSON(featureCollection, {
+        targetProjection: mercatorProjection,
+        dynamicStyle: true,
+      });
       if (style) {
         this._defaultStyle = style;
         this.setStyle(style);
@@ -234,10 +257,11 @@ class FeatureStore extends Vector {
    */
   initialize() {
     if (!this.initialized) {
-      return super.initialize()
-        .then(() => {
-          this._staticFeatureVisibility.hideObjects([...this.hiddenStaticFeatureIds]);
-        });
+      return super.initialize().then(() => {
+        this._staticFeatureVisibility.hideObjects([
+          ...this.hiddenStaticFeatureIds,
+        ]);
+      });
     }
     return super.initialize();
   }
@@ -249,25 +273,26 @@ class FeatureStore extends Vector {
   _loadTwoDim() {
     if (!this._twoDimLoaded) {
       this._twoDimLoaded = (async () => {
-        const { data } = await axios.get(this.staticRepresentation.twoDim);
+        const data = await requestJson(this.staticRepresentation.twoDim);
         const { features } = parseGeoJSON(data, {
           targetProjection: mercatorProjection,
           dynamicStyle: true,
         });
         const isDeclarative = this.style instanceof DeclarativeStyleItem;
-        features
-          .forEach((feature) => {
-            feature[Layer.vcsLayerNameSymbol] = this.name;
-            feature[isTiledFeature] = true;
-            if (isDeclarative && feature[vectorStyleSymbol]) {
-              feature.setStyle();
-            }
-            if (this._setEditing && this._setEditing.featureType != null) {
-              feature[this._setEditing.symbol] = this._setEditing.featureType;
-            }
-          });
+        features.forEach((feature) => {
+          feature[Layer.vcsLayerNameSymbol] = this.name;
+          feature[isTiledFeature] = true;
+          if (isDeclarative && feature[vectorStyleSymbol]) {
+            feature.setStyle();
+          }
+          if (this._setEditing && this._setEditing.featureType != null) {
+            feature[this._setEditing.symbol] = this._setEditing.featureType;
+          }
+        });
         this._twoDimStaticSource.addFeatures(
-          /** @type {Array<import("ol").Feature<import("ol/geom/Geometry").default>>} */ (features),
+          /** @type {Array<import("ol").Feature<import("ol/geom/Geometry").default>>} */ (
+            features
+          ),
         );
       })();
     }
@@ -288,41 +313,60 @@ class FeatureStore extends Vector {
 
   /**
    * @param {import("@vcmap/core").VcsMap} map
-   * @returns {Array<VectorOblique|import("@vcmap/core").VectorCesium|VectorOpenlayers|CesiumTilesetCesium>}
+   * @returns {Array<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>}
    */
   // @ts-ignore
   createImplementationsForMap(map) {
-    const impls = /** @type {Array<import("@vcmap/core").LayerImplementation>} */
+    const impls =
+      /** @type {Array<import("@vcmap/core").LayerImplementation>} */
       (super.createImplementationsForMap(map));
-    if (map instanceof CesiumMap && this.staticRepresentation && this.staticRepresentation.threeDim) {
-      impls.push(new CesiumTilesetCesium(map, /** @type {CesiumTilesetImplementationOptions} */ ({
-        url: this.staticRepresentation.threeDim,
-        tilesetOptions: {
-          maximumScreenSpaceError: isMobile() ? this.screenSpaceErrorMobile : this.screenSpaceError,
-          url: this.staticRepresentation.threeDim,
-        },
-        tilesetProperties: [
-          {
-            key: isTiledFeature,
-            value: true,
-          },
-        ],
-        name: this.name,
-        style: this.style,
-        featureVisibility: this._staticFeatureVisibility,
-        splitDirection: ImagerySplitDirection.NONE,
-        jumpToLocation: false,
-      })));
+    if (
+      map instanceof CesiumMap &&
+      this.staticRepresentation &&
+      this.staticRepresentation.threeDim
+    ) {
+      impls.push(
+        new CesiumTilesetCesiumImpl(
+          map,
+          /** @type {CesiumTilesetImplementationOptions} */ ({
+            url: this.staticRepresentation.threeDim,
+            tilesetOptions: {
+              maximumScreenSpaceError: isMobile()
+                ? this.screenSpaceErrorMobile
+                : this.screenSpaceError,
+              url: this.staticRepresentation.threeDim,
+            },
+            tilesetProperties: [
+              {
+                key: isTiledFeature,
+                value: true,
+              },
+            ],
+            name: this.name,
+            style: this.style,
+            featureVisibility: this._staticFeatureVisibility,
+            globalHider: this.globalHider,
+            splitDirection: SplitDirection.NONE,
+            jumpToLocation: false,
+          }),
+        ),
+      );
     } else if (this.staticRepresentation && this.staticRepresentation.twoDim) {
       this._loadTwoDim();
-      if (map instanceof Openlayers) {
-        impls.push(new VectorOpenlayers(map, this._getTwoDimStaticImplOptions()));
-      } else if (map instanceof Oblique) {
-        impls.push(new VectorOblique(map, this._getTwoDimStaticImplOptions()));
+      if (map instanceof OpenlayersMap) {
+        impls.push(
+          new VectorOpenlayersImpl(map, this._getTwoDimStaticImplOptions()),
+        );
+      } else if (map instanceof ObliqueMap) {
+        impls.push(
+          new VectorObliqueImpl(map, this._getTwoDimStaticImplOptions()),
+        );
       }
     }
     // eslint-disable-next-line max-len
-    return /** @type {Array<VectorOblique|import("@vcmap/core").VectorCesium|VectorOpenlayers|CesiumTilesetCesium>} */ (impls);
+    return /** @type {Array<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>} */ (
+      impls
+    );
   }
 
   /**
@@ -359,19 +403,21 @@ class FeatureStore extends Vector {
       }
 
       const isDeclarative = this.style instanceof DeclarativeStyleItem;
-      this._twoDimStyleChanged = this.style.styleChanged.addEventListener(() => {
-        this._twoDimStaticSource.getFeatures().forEach((f) => {
-          if (isDeclarative || !f[vectorStyleSymbol]) {
-            f.changed();
-          }
-        });
-      });
+      this._twoDimStyleChanged = this.style.styleChanged.addEventListener(
+        () => {
+          this._twoDimStaticSource.getFeatures().forEach((f) => {
+            if (isDeclarative || !f[vectorStyleSymbol]) {
+              f.changed();
+            }
+          });
+        },
+      );
     }
   }
 
   /**
    * @inheritDoc
-   * @param {string|import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
+   * @param {import("ol/style/Style").default|import("ol/style/Style").StyleFunction|import("@vcmap/core").StyleItem} style
    * @param {boolean=} silent
    * @api
    */
@@ -409,7 +455,7 @@ class FeatureStore extends Vector {
    */
   setEditing(symbol, featureType) {
     this.getImplementations().forEach((impl) => {
-      if (impl instanceof CesiumTilesetCesium) {
+      if (impl instanceof CesiumTilesetCesiumImpl) {
         if (impl.initialized) {
           if (featureType != null) {
             impl.cesium3DTileset[symbol] = featureType;
@@ -426,14 +472,13 @@ class FeatureStore extends Vector {
     if (this.staticRepresentation.twoDim) {
       if (this._twoDimLoaded) {
         this._twoDimLoaded.then(() => {
-          this._twoDimStaticSource.getFeatures()
-            .forEach((f) => {
-              if (featureType != null) {
-                f[symbol] = featureType;
-              } else {
-                delete f[symbol];
-              }
-            });
+          this._twoDimStaticSource.getFeatures().forEach((f) => {
+            if (featureType != null) {
+              f[symbol] = featureType;
+            } else {
+              delete f[symbol];
+            }
+          });
         });
       } else {
         this._setEditing = { symbol, featureType };
@@ -442,33 +487,24 @@ class FeatureStore extends Vector {
   }
 
   /**
-   * @param {Object|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTilePointFeature|import("@vcmap/cesium").Cesium3DTileFeature} feature
+   * @param {Object|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("@vcmap-cesium/engine").Cesium3DTileFeature} feature
    * @returns {?Object}
    */
   objectClickedHandler(feature) {
-    if ((feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature)) {
-      return CesiumTileset.prototype.objectClickedHandler.call(this, feature);
+    if (
+      feature instanceof Cesium3DTileFeature ||
+      feature instanceof Cesium3DTilePointFeature
+    ) {
+      return CesiumTilesetLayer.prototype.objectClickedHandler.call(
+        this,
+        feature,
+      );
     } else if (feature instanceof Feature) {
       return super.objectClickedHandler(feature);
     }
     return null;
   }
 
-  /**
-   * @param {Object|VectorClickedObject} object
-   * @returns {GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    if (object instanceof Feature) {
-      // @ts-ignore
-      return super.getGenericFeatureFromClickedObject(/** @type {VectorClickedObject} */ (object));
-    }
-    const generic = CesiumTileset.prototype.getGenericFeatureFromClickedObject.call(this, object);
-    generic.layerName = this.name;
-    generic.layerClass = this.className;
-    return generic;
-  }
-
   /**
    * @inheritDoc
    * @returns {Extent|null}
@@ -479,12 +515,17 @@ class FeatureStore extends Vector {
       return this.extent;
     }
     const extent = super.getZoomToExtent();
-    const mercatorExtent = extent ? extent.getCoordinatesInProjection(mercatorProjection) : createEmpty();
+    const mercatorExtent = extent
+      ? extent.getCoordinatesInProjection(mercatorProjection)
+      : createEmpty();
     if (this.staticRepresentation.threeDim) {
-      const threeDImpl = /** @type {CesiumTilesetCesium} */ (this.getImplementations()
-        .find((impl) => {
-          return impl instanceof CesiumTilesetCesium && impl.cesium3DTileset;
-        }));
+      const threeDImpl = /** @type {CesiumTilesetCesiumImpl} */ (
+        this.getImplementations().find((impl) => {
+          return (
+            impl instanceof CesiumTilesetCesiumImpl && impl.cesium3DTileset
+          );
+        })
+      );
 
       if (threeDImpl) {
         const threeDimExtent = getExtentFromTileset(threeDImpl.cesium3DTileset);
@@ -497,7 +538,7 @@ class FeatureStore extends Vector {
     }
 
     const actualExtent = new Extent({
-      ...mercatorProjection.toJSON(),
+      projection: mercatorProjection.toJSON(),
       coordinates: mercatorExtent,
     });
 
@@ -520,17 +561,16 @@ class FeatureStore extends Vector {
       this.screenSpaceError = value;
     }
 
-    this.getImplementations()
-      .forEach((impl) => {
-        if (impl instanceof CesiumTilesetCesium && impl.cesium3DTileset) {
-          impl.cesium3DTileset.maximumScreenSpaceError = value;
-        }
-      });
+    this.getImplementations().forEach((impl) => {
+      if (impl instanceof CesiumTilesetCesiumImpl && impl.cesium3DTileset) {
+        impl.cesium3DTileset.maximumScreenSpaceError = value;
+      }
+    });
   }
 
   /**
    * switch an array of static features to dynamic features
-   * This is done by hiding the static features and adding their dynamic counterparts to the FeatureStore layer
+   * This is done by hiding the static features and adding their dynamic counterparts to the FeatureStoreLayer layer
    * @param {string|number} [featureId] input static feature ID
    * @returns {Promise<import("ol").Feature<import("ol/geom/Geometry").default>>}
    * @api
@@ -542,15 +582,13 @@ class FeatureStore extends Vector {
     if (this.injectedFetchDynamicFeatureFunc) {
       return this.injectedFetchDynamicFeatureFunc(featureId)
         .then((result) => {
-          const { features } = parseGeoJSON(
-            result,
-            {
-              targetProjection: mercatorProjection,
-              defaultStyle: this.defaultStyle instanceof VectorStyleItem ?
-                this.defaultStyle :
-                defaultVectorStyle,
-            },
-          );
+          const { features } = parseGeoJSON(result, {
+            targetProjection: mercatorProjection,
+            defaultStyle:
+              this.defaultStyle instanceof VectorStyleItem
+                ? this.defaultStyle
+                : defaultVectorStyle,
+          });
           this._staticFeatureVisibility.hideObjects([featureId]);
           this.hiddenStaticFeatureIds.add(featureId);
           this.addFeatures(features);
@@ -573,7 +611,7 @@ class FeatureStore extends Vector {
     this.hiddenStaticFeatureIds.add(featureId);
     const feature = new Feature();
     feature.setId(featureId);
-    feature[featureStoreStateSymbol] = featureStoreState.STATIC;
+    feature[featureStoreStateSymbol] = FeatureStoreLayerState.STATIC;
     this.changeTracker.removeFeature(feature);
   }
 
@@ -598,16 +636,20 @@ class FeatureStore extends Vector {
    */
   toJSON() {
     const config = /** @type {FeatureStoreOptions} */ (super.toJSON());
-    const defaultOptions = FeatureStore.getDefaultOptions();
+    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
 
     delete config.projection;
-    config.vcsMeta = this.vectorProperties
-      .getVcsMeta({ ...VectorProperties.getDefaultOptions(), ...defaultOptions.vcsMeta });
+    config.vcsMeta = this.vectorProperties.getVcsMeta({
+      ...VectorProperties.getDefaultOptions(),
+      ...defaultOptions.vcsMeta,
+    });
     if (Object.keys(config.vcsMeta).length === 0) {
       delete config.vcsMeta;
     }
 
-    if (this.vcsMeta.screenSpaceError !== defaultOptions.vcsMeta.screenSpaceError) {
+    if (
+      this.vcsMeta.screenSpaceError !== defaultOptions.vcsMeta.screenSpaceError
+    ) {
       config.vcsMeta = config.vcsMeta || {};
       config.vcsMeta.screenSpaceError = this.vcsMeta.screenSpaceError;
     }
@@ -632,7 +674,9 @@ class FeatureStore extends Vector {
       this._twoDimStyleChanged();
       this._twoDimStyleChanged = null;
     }
-    this._featureVisibilitySyncListeners.forEach((cb) => { cb(); });
+    this._featureVisibilitySyncListeners.forEach((cb) => {
+      cb();
+    });
     this._featureVisibilitySyncListeners = [];
     this._staticFeatureVisibility.destroy();
     this.changeTracker.destroy();
@@ -643,5 +687,8 @@ class FeatureStore extends Vector {
   }
 }
 
-VcsClassRegistry.registerClass(FeatureStore.className, FeatureStore);
-export default FeatureStore;
+layerClassRegistry.registerClass(
+  FeatureStoreLayer.className,
+  FeatureStoreLayer,
+);
+export default FeatureStoreLayer;