@vcmap/core 5.0.0-rc.8 → 5.0.0

package/src/layer/featureStoreLayer.js

@@ -1,647 +0,0 @@
-import Feature from 'ol/Feature.js';
-import { Cesium3DTileFeature, Cesium3DTilePointFeature, ImagerySplitDirection } from '@vcmap/cesium';
-import VectorSource from 'ol/source/Vector.js';
-import { createEmpty, extend as extendExtent } from 'ol/extent.js';
-
-import VectorLayer from './vectorLayer.js';
-import { featureStoreStateSymbol, FeatureStoreLayerState } from './featureStoreLayerState.js';
-import { parseGeoJSON } from './geojsonHelpers.js';
-import { mercatorProjection } from '../util/projection.js';
-import FeatureStoreLayerChanges from './featureStoreLayerChanges.js';
-import VectorStyleItem, { defaultVectorStyle, vectorStyleSymbol } from '../style/vectorStyleItem.js';
-import FeatureVisibility, {
-  FeatureVisibilityAction,
-  originalStyle,
-  synchronizeFeatureVisibility,
-  updateOriginalStyle,
-} from './featureVisibility.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 VectorOpenlayersImpl from './openlayers/vectorOpenlayersImpl.js';
-import Layer from './layer.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 { requestJson } from '../util/fetch.js';
-
-/**
- * @typedef {Object} FeatureStoreStaticRepresentation
- * @property {string|undefined} threeDim - 3D static representation of this layer
- * @property {string|undefined} twoDim - 2D static representation for this layer
- * @api
- */
-
-/**
- * @typedef {Object} FeatureStoreFeature
- * @property {string} id - the mongo id
- * @property {Object} properties - the properties bag
- * @property {Object} geometry
- * @property {Object|undefined} vcsMeta
- * @property {FeatureStoreLayerState} state
- * @property {string} type - the featureType
- * @todo write vcsMeta for features
- * @todo set type to be one of an enum
- * @api
- */
-
-/**
- * For further details see: {@link http://gitlab/vcsuite/virtualcityMAP/wikis/featureStore/layerSchema}
- * @typedef {VectorOptions} FeatureStoreLayerSchema
- * @property {string} id - layer mongo id
- * @property {string} type
- * @property {string} featureType
- * @property {FeatureStoreStaticRepresentation|undefined} staticRepresentation -  URLs to static representations for 2D and 3D maps
- * @property {Array<string|number>} hiddenStaticFeatureIds -  an array of IDs of features to hide from the static representation
- * @property {Array<FeatureStoreFeature>} features - the array of features to represent dynamic features
- * @property {VcsMeta} vcsMeta -  vector style implemented by the map and base64-encoded png icons used for custom styles
- * @todo write type enum
- * @api
- */
-
-/**
- * @typedef {FeatureStoreLayerSchema} FeatureStoreOptions
- * @property {Function|undefined} injectedFetchDynamicFeatureFunc - injected function for fetching dynamic features from a remote FeatureStoreLayer server
- * @api
- */
-
-/** @type {symbol} */
-export const isTiledFeature = Symbol('isTiledFeature');
-
-/**
- * FeatureStoreLayer Layer
- * @class
- * @export
- * @extends {VectorLayer}
- * @api
- */
-class FeatureStoreLayer extends VectorLayer {
-  static get className() { return 'FeatureStoreLayer'; }
-
-  /**
-   * @returns {FeatureStoreOptions}
-   */
-  static getDefaultOptions() {
-    return {
-      id: '',
-      type: 'FeatureStoreLayer',
-      featureType: 'simple',
-      features: [],
-      ...VectorLayer.getDefaultOptions(),
-      projection: mercatorProjection.toJSON(),
-      staticRepresentation: {},
-      hiddenStaticFeatureIds: [],
-      vcsMeta: {
-        screenSpaceError: 4,
-        altitudeMode: 'clampToGround',
-      },
-    };
-  }
-
-  // XXX cant implement getConfigOptions do to non layer options. this will most likely go away in 4.0
-  /**
-   * @param {FeatureStoreOptions} options
-   */
-  constructor(options) {
-    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
-    const vectorOptions = {
-      projection: defaultOptions.projection,
-      ...options,
-    };
-    super(vectorOptions);
-    this._supportedMaps = [
-      CesiumMap.className,
-      OpenlayersMap.className,
-      ObliqueMap.className,
-    ];
-
-    /**
-     * Feature Store layers have feature UUIDs by design
-     * @type {boolean}
-     */
-    this.hasFeatureUUID = true;
-
-    /** @type {string} */
-    this.layerId = options.id;
-
-    /** @type {FeatureStoreStaticRepresentation} */
-    this.staticRepresentation = options.staticRepresentation || defaultOptions.staticRepresentation;
-
-    /** @type {Set<string|number>} */
-    this.hiddenStaticFeatureIds = new Set(options.hiddenStaticFeatureIds || defaultOptions.hiddenStaticFeatureIds);
-
-    /**
-     * @type {FeatureStoreLayerChanges}
-     * @api
-     */
-    this.changeTracker = new FeatureStoreLayerChanges(this);
-
-    const { vcsMeta } = defaultOptions;
-    if (options.vcsMeta) {
-      Object.assign(vcsMeta, options.vcsMeta);
-    }
-
-    /** @type {VcsMeta} */
-    this.vcsMeta = vcsMeta;
-    this.setVcsMeta(this.vcsMeta);
-
-    /** @type {number} */
-    this.screenSpaceErrorMobile = this.vcsMeta.screenSpaceError;
-    /** @type {number} */
-    this.screenSpaceError = this.vcsMeta.screenSpaceError;
-
-    /**
-     * @type {import("@vcmap/cesium").Event.RemoveCallback}
-     * @private
-     */
-    this._removeVectorPropertiesChangeHandler = this.vectorProperties.propertyChanged.addEventListener(() => {
-      this.changeTracker.values.changed = true;
-    });
-
-    /**
-     * a function to retrieve a single feature from the server
-     * @type {Function|undefined}
-     * @returns {Promise<string|Object>}
-     * @api
-     */
-    this.injectedFetchDynamicFeatureFunc = options.injectedFetchDynamicFeatureFunc;
-    /**
-     * @type {FeatureVisibility}
-     * @private
-     */
-    this._staticFeatureVisibility = new FeatureVisibility();
-    /**
-     * Synchronize featureVisibilities, while maintaining static features hidden.
-     * @type {Array<Function>}
-     * @private
-     */
-    this._featureVisibilitySyncListeners = [
-      synchronizeFeatureVisibility(this.featureVisibility, this._staticFeatureVisibility),
-      this._staticFeatureVisibility.changed.addEventListener(({ action }) => {
-        if (action === FeatureVisibilityAction.SHOW) {
-          this._staticFeatureVisibility.hideObjects([...this.hiddenStaticFeatureIds]);
-        }
-      }),
-    ];
-
-    /**
-     * @type {Object|null}
-     * @private
-     */
-    this._setEditing = null;
-    /**
-     * @type {Promise<void>|null}
-     * @private
-     */
-    this._twoDimLoaded = null;
-    /**
-     * @type {Function|null}
-     * @private
-     */
-    this._twoDimStyleChanged = null;
-    /**
-     * @type {import("ol/source").Vector<import("ol/geom/Geometry").default>}
-     * @private
-     */
-    this._twoDimStaticSource = new VectorSource();
-
-    if (options.features) {
-      const featureCollection = {
-        type: 'FeatureCollection',
-        features: options.features,
-        vcsMeta: options.vcsMeta,
-      };
-      const { style, features } = parseGeoJSON(
-        featureCollection,
-        { targetProjection: mercatorProjection, dynamicStyle: true },
-      );
-      if (style) {
-        this._defaultStyle = style;
-        this.setStyle(style);
-      }
-      this.addFeatures(features);
-    }
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   */
-  initialize() {
-    if (!this.initialized) {
-      return super.initialize()
-        .then(() => {
-          this._staticFeatureVisibility.hideObjects([...this.hiddenStaticFeatureIds]);
-        });
-    }
-    return super.initialize();
-  }
-
-  /**
-   * @returns {Promise<void>}
-   * @private
-   */
-  _loadTwoDim() {
-    if (!this._twoDimLoaded) {
-      this._twoDimLoaded = (async () => {
-        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;
-            }
-          });
-        this._twoDimStaticSource.addFeatures(
-          /** @type {Array<import("ol").Feature<import("ol/geom/Geometry").default>>} */ (features),
-        );
-      })();
-    }
-    return this._twoDimLoaded;
-  }
-
-  /**
-   * @returns {VectorImplementationOptions}
-   * @private
-   */
-  _getTwoDimStaticImplOptions() {
-    return {
-      ...super.getImplementationOptions(),
-      source: this._twoDimStaticSource,
-      featureVisibility: this._staticFeatureVisibility,
-    };
-  }
-
-  /**
-   * @param {import("@vcmap/core").VcsMap} map
-   * @returns {Array<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>}
-   */
-  // @ts-ignore
-  createImplementationsForMap(map) {
-    const impls = /** @type {Array<import("@vcmap/core").LayerImplementation>} */
-      (super.createImplementationsForMap(map));
-    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,
-        splitDirection: ImagerySplitDirection.NONE,
-        jumpToLocation: false,
-      })));
-    } else if (this.staticRepresentation && this.staticRepresentation.twoDim) {
-      this._loadTwoDim();
-      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<VectorObliqueImpl|import("@vcmap/core").VectorCesiumImpl|VectorOpenlayersImpl|CesiumTilesetCesiumImpl>} */ (impls);
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   */
-  reload() {
-    this._twoDimLoaded = null;
-    this._twoDimStaticSource.clear();
-    return super.reload();
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   * @api
-   */
-  async activate() {
-    await super.activate();
-    if (this.active && this._setEditing) {
-      this.setEditing(this._setEditing.symbol, this._setEditing.featureType);
-    }
-  }
-
-  /**
-   * @protected
-   */
-  _trackStyleChanges() {
-    super._trackStyleChanges();
-    if (this.staticRepresentation.twoDim) {
-      if (this._twoDimStyleChanged) {
-        this._twoDimStyleChanged();
-        this._twoDimStyleChanged = null;
-      }
-
-      const isDeclarative = this.style instanceof DeclarativeStyleItem;
-      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 {boolean=} silent
-   * @api
-   */
-  setStyle(style, silent) {
-    const changeTrackerActive = this.changeTracker.active;
-    if (changeTrackerActive) {
-      this.changeTracker.pauseTracking('changefeature');
-    }
-    super.setStyle(style, silent);
-    const isDeclarative = this.style instanceof DeclarativeStyleItem;
-    this._twoDimStaticSource.getFeatures().forEach((f) => {
-      if (f[vectorStyleSymbol]) {
-        let changed;
-        if (isDeclarative) {
-          changed = true;
-          f.setStyle(undefined);
-        } else if (f.getStyle() !== f[vectorStyleSymbol].style) {
-          changed = true;
-          f.setStyle(f[vectorStyleSymbol].style);
-        }
-        if (changed && Reflect.has(f, originalStyle)) {
-          updateOriginalStyle(f);
-        }
-      }
-    });
-    if (changeTrackerActive) {
-      this.changeTracker.track();
-      this.changeTracker.values.changed = true;
-    }
-  }
-
-  /**
-   * @param {symbol} symbol
-   * @param {number=} featureType
-   */
-  setEditing(symbol, featureType) {
-    this.getImplementations().forEach((impl) => {
-      if (impl instanceof CesiumTilesetCesiumImpl) {
-        if (impl.initialized) {
-          if (featureType != null) {
-            impl.cesium3DTileset[symbol] = featureType;
-          } else {
-            delete impl.cesium3DTileset[symbol];
-          }
-          this._setEditing = null;
-        } else {
-          this._setEditing = { symbol, featureType };
-        }
-      }
-    });
-
-    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];
-              }
-            });
-        });
-      } else {
-        this._setEditing = { symbol, featureType };
-      }
-    }
-  }
-
-  /**
-   * @param {Object|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTilePointFeature|import("@vcmap/cesium").Cesium3DTileFeature} feature
-   * @returns {?Object}
-   */
-  objectClickedHandler(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 = CesiumTilesetLayer.prototype.getGenericFeatureFromClickedObject.call(this, object);
-    generic.layerName = this.name;
-    generic.layerClass = this.className;
-    return generic;
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Extent|null}
-   * @api
-   */
-  getZoomToExtent() {
-    if (this.extent && this.extent.isValid()) {
-      return this.extent;
-    }
-    const extent = super.getZoomToExtent();
-    const mercatorExtent = extent ? extent.getCoordinatesInProjection(mercatorProjection) : createEmpty();
-    if (this.staticRepresentation.threeDim) {
-      const threeDImpl = /** @type {CesiumTilesetCesiumImpl} */ (this.getImplementations()
-        .find((impl) => {
-          return impl instanceof CesiumTilesetCesiumImpl && impl.cesium3DTileset;
-        }));
-
-      if (threeDImpl) {
-        const threeDimExtent = getExtentFromTileset(threeDImpl.cesium3DTileset);
-        extendExtent(mercatorExtent, threeDimExtent);
-      }
-    }
-
-    if (this.staticRepresentation.twoDim && this._twoDimLoaded) {
-      extendExtent(mercatorExtent, this._twoDimStaticSource.getExtent());
-    }
-
-    const actualExtent = new Extent({
-      projection: mercatorProjection.toJSON(),
-      coordinates: mercatorExtent,
-    });
-
-    if (actualExtent.isValid()) {
-      return actualExtent;
-    }
-
-    return null;
-  }
-
-  /**
-   * set the maximum screen space error of this layer
-   * @param {number} value
-   * @api stable
-   */
-  setMaximumScreenSpaceError(value) {
-    if (isMobile()) {
-      this.screenSpaceErrorMobile = value;
-    } else {
-      this.screenSpaceError = 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 FeatureStoreLayer layer
-   * @param {string|number} [featureId] input static feature ID
-   * @returns {Promise<import("ol").Feature<import("ol/geom/Geometry").default>>}
-   * @api
-   */
-  switchStaticFeatureToDynamic(featureId) {
-    if (this.hiddenStaticFeatureIds.has(featureId)) {
-      return Promise.resolve(this.getFeatureById(featureId));
-    }
-    if (this.injectedFetchDynamicFeatureFunc) {
-      return this.injectedFetchDynamicFeatureFunc(featureId)
-        .then((result) => {
-          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);
-          return features[0];
-        })
-        .catch((err) => {
-          this.getLogger().error(err.message);
-        });
-    }
-    return Promise.reject(new Error('no injected fetching function'));
-  }
-
-  /**
-   * removes a static feature from featureStore layer
-   * @param {string} featureId
-   * @api
-   */
-  removeStaticFeature(featureId) {
-    this._staticFeatureVisibility.hideObjects([featureId]);
-    this.hiddenStaticFeatureIds.add(featureId);
-    const feature = new Feature();
-    feature.setId(featureId);
-    feature[featureStoreStateSymbol] = FeatureStoreLayerState.STATIC;
-    this.changeTracker.removeFeature(feature);
-  }
-
-  /**
-   * Resets a feature which used to be static but is now dynamic. called from featureStoreChanges API.
-   * @param {string|number} featureId
-   */
-  resetStaticFeature(featureId) {
-    if (this.hiddenStaticFeatureIds.has(featureId)) {
-      const idArray = [featureId];
-      this.removeFeaturesById(idArray);
-      this.hiddenStaticFeatureIds.delete(featureId);
-      if (!this.featureVisibility.hiddenObjects[featureId]) {
-        this._staticFeatureVisibility.showObjects(idArray);
-      }
-    }
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {FeatureStoreOptions}
-   */
-  toJSON() {
-    const config = /** @type {FeatureStoreOptions} */ (super.toJSON());
-    const defaultOptions = FeatureStoreLayer.getDefaultOptions();
-
-    delete config.projection;
-    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) {
-      config.vcsMeta = config.vcsMeta || {};
-      config.vcsMeta.screenSpaceError = this.vcsMeta.screenSpaceError;
-    }
-
-    if (Object.keys(this.staticRepresentation).length > 0) {
-      config.staticRepresentation = { ...this.staticRepresentation };
-    }
-
-    if (this.hiddenStaticFeatureIds.size > 0) {
-      config.hiddenStaticFeatureIds = [...this.hiddenStaticFeatureIds];
-    }
-    return config;
-  }
-
-  /**
-   * @inheritDoc
-   */
-  destroy() {
-    this.removeAllFeatures();
-    this._twoDimStaticSource.clear();
-    if (this._twoDimStyleChanged) {
-      this._twoDimStyleChanged();
-      this._twoDimStyleChanged = null;
-    }
-    this._featureVisibilitySyncListeners.forEach((cb) => { cb(); });
-    this._featureVisibilitySyncListeners = [];
-    this._staticFeatureVisibility.destroy();
-    this.changeTracker.destroy();
-    if (this._removeVectorPropertiesChangeHandler) {
-      this._removeVectorPropertiesChangeHandler();
-    }
-    super.destroy();
-  }
-}
-
-VcsClassRegistry.registerClass(FeatureStoreLayer.className, FeatureStoreLayer);
-export default FeatureStoreLayer;