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

package/src/{vcs/vcm/layer → layer}/featureVisibility.js

@@ -1,10 +1,14 @@
-import { Color, Cesium3DTileFeature, Cesium3DTilePointFeature, Entity as CesiumEntity } from '@vcmap/cesium';
+import {
+  Color,
+  Cesium3DTileFeature,
+  Cesium3DTilePointFeature,
+  Entity as CesiumEntity,
+} from '@vcmap-cesium/engine';
 import Feature from 'ol/Feature.js';
 import Style from 'ol/style/Style.js';
 
-import VectorStyleItem, { fromCesiumColor } from '../util/style/vectorStyleItem.js';
-import { emptyStyle } from '../util/style/styleHelpers.js';
-import VcsEvent from '../event/vcsEvent.js';
+import VectorStyleItem, { fromCesiumColor } from '../style/vectorStyleItem.js';
+import VcsEvent from '../vcsEvent.js';
 
 /**
  * Set on an ol.Feature or Cesium.Cesium3DTileFeature to indicate its style before it was hidden or highlighted.
@@ -37,7 +41,7 @@ export const globalHidden = Symbol('globalHidden');
 /**
  * @typedef {Object} HighlightedObject
  * @property {VectorStyleItem} style
- * @property {Set<import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature>} features
+ * @property {Set<import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature>} features
  */
 
 /**
@@ -48,42 +52,45 @@ export const globalHidden = Symbol('globalHidden');
  */
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature} feature
  * @returns {boolean}
  */
 export function featureExists(feature) {
-  return feature &&
+  return (
+    feature &&
     feature.content &&
     !feature.content.isDestroyed() &&
-    !feature.content.batchTable.isDestroyed();
+    !feature.content.batchTable.isDestroyed()
+  );
 }
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
  * @private
  */
 export function hideFeature(feature) {
   if (
-    (
-      (feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature) &&
-      featureExists(feature)
-    ) || feature instanceof CesiumEntity
+    ((feature instanceof Cesium3DTileFeature ||
+      feature instanceof Cesium3DTilePointFeature) &&
+      featureExists(feature)) ||
+    feature instanceof CesiumEntity
   ) {
     feature.show = false;
   } else if (feature instanceof Feature) {
-    feature.setStyle(emptyStyle.clone());
+    feature.changed();
   }
 }
 
 /**
  * Caches the original style on the feature using the originalStyle symbol
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
  * @private
  */
 export function cacheOriginalStyle(feature) {
   if (!Reflect.has(feature, originalStyle)) {
     if (
-      (feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature) &&
+      (feature instanceof Cesium3DTileFeature ||
+        feature instanceof Cesium3DTilePointFeature) &&
       featureExists(feature)
     ) {
       feature[originalStyle] = feature.color.clone();
@@ -94,45 +101,47 @@ export function cacheOriginalStyle(feature) {
 }
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
  * @private
  */
 export function resetOriginalStyle(feature) {
   if (!(feature[globalHidden] || feature[hidden] || feature[highlighted])) {
     const style = feature[originalStyle];
     if (
-      (feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature) &&
+      (feature instanceof Cesium3DTileFeature ||
+        feature instanceof Cesium3DTilePointFeature) &&
       featureExists(feature)
     ) {
       feature.color = style;
     } else if (feature instanceof Feature) {
-      feature.setStyle(style);
+      feature.changed();
     }
     delete feature[originalStyle];
   }
 }
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
  * @private
  */
 export function highlightFeature(feature) {
   if (!(feature[globalHidden] || feature[hidden])) {
     const style = feature[highlighted];
     if (
-      (feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature) &&
+      (feature instanceof Cesium3DTileFeature ||
+        feature instanceof Cesium3DTilePointFeature) &&
       featureExists(feature)
     ) {
       feature.color = style.cesiumFillColor;
     } else if (feature instanceof Feature) {
-      feature.setStyle(/** @type {import("ol/style/Style").default} */ (style.style));
+      feature.changed();
     }
   }
 }
 
 /**
  * Updates the cached original style
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
  * @private
  */
 export function updateOriginalStyle(feature) {
@@ -146,7 +155,7 @@ export function updateOriginalStyle(feature) {
 }
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>} feature
  */
 function unhighlightFeature(feature) {
   delete feature[highlighted];
@@ -154,7 +163,7 @@ function unhighlightFeature(feature) {
 }
 
 /**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity} feature
+ * @param {import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Cesium3DTilePointFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity} feature
  * @param {symbol} symbol
  * @private
  */
@@ -163,10 +172,10 @@ export function showFeature(feature, symbol) {
 
   if (!(feature[hidden] || feature[globalHidden])) {
     if (
-      (
-        (feature instanceof Cesium3DTileFeature || feature instanceof Cesium3DTilePointFeature) &&
-        featureExists(feature)
-      ) || feature instanceof CesiumEntity
+      ((feature instanceof Cesium3DTileFeature ||
+        feature instanceof Cesium3DTilePointFeature) &&
+        featureExists(feature)) ||
+      feature instanceof CesiumEntity
     ) {
       feature.show = true;
     }
@@ -181,7 +190,6 @@ export function showFeature(feature, symbol) {
 /**
  * Enumeration of feature visibility actions.
  * @enum {number}
- * @export
  * @api
  * @property {number} HIGHLIGHT
  * @property {number} UNHIGHLIGHT
@@ -232,11 +240,14 @@ export function synchronizeFeatureVisibility(source, destination) {
 }
 
 /**
+ * FeatureVisibility handles the visibility and highlighting of features of a specific {@link FeatureLayer} or {@link DataSourceLayer}
+ * and its {@link FeatureLayerImplementation} resp. {@link DataSourceCesiumImpl}.
+ * The visibility is being synchronized with the {@link GlobalHider}.
  * @class
  */
 class FeatureVisibility {
   constructor() {
-    /** @type {Object<string, Set<(import("@vcmap/cesium").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Entity)>>} */
+    /** @type {Object<string, Set<(import("@vcmap-cesium/engine").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Entity)>>} */
     this.hiddenObjects = {};
     /** @type {Object<string, HighlightedObject>} */
     this.highlightedObjects = {};
@@ -251,51 +262,58 @@ class FeatureVisibility {
   }
 
   /**
-   * highlights a number of features by ID (import("@vcmap/cesium").Cesium3DTileFeature|ol/Feature) with the given color.
-   * @param {Object<string, (VectorStyleItem|import("@vcmap/cesium").Color|import("ol/style/Style").default)>} toHighlight
+   * highlights a number of features by ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|ol/Feature) with the given color.
+   * @param {Object<string, (VectorStyleItem|import("@vcmap-cesium/engine").Color|import("ol/style/Style").default)>} toHighlight
    * @api stable
    */
   highlight(toHighlight) {
     const updatedIds = [];
-    Object.entries(toHighlight)
-      .forEach(([id, style]) => {
-        let usedStyle = style;
-        if (style instanceof Color) {
-          usedStyle = fromCesiumColor(style);
-        } else if (style instanceof Style) {
-          usedStyle = new VectorStyleItem({});
-          if (style.getText() && style.getText().getText()) {
-            usedStyle.label = style.getText().getText();
-          }
-          usedStyle.style = style;
-        }
-        // eslint-disable-next-line no-self-assign
-        usedStyle = /** @type {VectorStyleItem} */ (usedStyle);
-
-        if (!this.highlightedObjects[id]) {
-          this.highlightedObjects[id] = {
-            style: usedStyle,
-            features: new Set(),
-          };
-          updatedIds.push(id);
-          // @ts-ignore
-        } else if (this.highlightedObjects[id].style !== usedStyle) {
-          this.highlightedObjects[id].style = usedStyle;
-          this.highlightedObjects[id].features.forEach((s, feature) => {
-            feature[highlighted] = usedStyle;
-            highlightFeature(feature);
-          });
+    Object.entries(toHighlight).forEach(([id, style]) => {
+      let usedStyle = style;
+      if (style instanceof Color) {
+        usedStyle = fromCesiumColor(style);
+      } else if (style instanceof Style) {
+        usedStyle = new VectorStyleItem({});
+        if (
+          style.getText() &&
+          style.getText().getText() &&
+          !Array.isArray(style.getText().getText())
+        ) {
+          // getText can return a rich Text Array<string> We do not support this at the moment.
+          usedStyle.label = String(style.getText().getText());
         }
-      });
+        usedStyle.style = style;
+      }
+      // eslint-disable-next-line no-self-assign
+      usedStyle = /** @type {VectorStyleItem} */ (usedStyle);
+
+      if (!this.highlightedObjects[id]) {
+        this.highlightedObjects[id] = {
+          style: usedStyle,
+          features: new Set(),
+        };
+        updatedIds.push(id);
+        // @ts-ignore
+      } else if (this.highlightedObjects[id].style !== usedStyle) {
+        this.highlightedObjects[id].style = usedStyle;
+        this.highlightedObjects[id].features.forEach((s, feature) => {
+          feature[highlighted] = usedStyle;
+          highlightFeature(feature);
+        });
+      }
+    });
 
     if (updatedIds.length > 0) {
       this.lastUpdated = Date.now();
-      this.changed.raiseEvent({ action: FeatureVisibilityAction.HIGHLIGHT, ids: updatedIds });
+      this.changed.raiseEvent({
+        action: FeatureVisibilityAction.HIGHLIGHT,
+        ids: updatedIds,
+      });
     }
   }
 
   /**
-   * unhighlights a number of features given by the ID (import("@vcmap/cesium").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>)
+   * unhighlights a number of features given by the ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>)
    * @param {Array<string>} toUnHighlight Array with IDS to unhighlight
    * @api stable
    */
@@ -303,17 +321,19 @@ class FeatureVisibility {
     const updatedIds = [];
     toUnHighlight.forEach((id) => {
       if (this.highlightedObjects[id]) {
-        this.highlightedObjects[id].features
-          .forEach((f) => {
-            unhighlightFeature(f);
-          });
+        this.highlightedObjects[id].features.forEach((f) => {
+          unhighlightFeature(f);
+        });
         delete this.highlightedObjects[id];
         updatedIds.push(id);
       }
     });
 
     if (updatedIds.length > 0) {
-      this.changed.raiseEvent({ action: FeatureVisibilityAction.UNHIGHLIGHT, ids: updatedIds });
+      this.changed.raiseEvent({
+        action: FeatureVisibilityAction.UNHIGHLIGHT,
+        ids: updatedIds,
+      });
     }
   }
 
@@ -327,16 +347,19 @@ class FeatureVisibility {
 
   /**
    * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTileFeature} feature
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature} feature
    * @returns {boolean}
    */
   hasHighlightFeature(id, feature) {
-    return this.highlightedObjects[id] && this.highlightedObjects[id].features.has(feature);
+    return (
+      this.highlightedObjects[id] &&
+      this.highlightedObjects[id].features.has(feature)
+    );
   }
 
   /**
    * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTileFeature} feature
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature} feature
    */
   addHighlightFeature(id, feature) {
     if (this.highlightedObjects[id]) {
@@ -363,7 +386,10 @@ class FeatureVisibility {
 
     if (updatedIds.length > 0) {
       this.lastUpdated = Date.now();
-      this.changed.raiseEvent({ action: FeatureVisibilityAction.HIDE, ids: updatedIds });
+      this.changed.raiseEvent({
+        action: FeatureVisibilityAction.HIDE,
+        ids: updatedIds,
+      });
     }
   }
 
@@ -376,17 +402,19 @@ class FeatureVisibility {
     const updatedIds = [];
     unHide.forEach((id) => {
       if (this.hiddenObjects[id]) {
-        this.hiddenObjects[id]
-          .forEach((f) => {
-            showFeature(f, hidden);
-          });
+        this.hiddenObjects[id].forEach((f) => {
+          showFeature(f, hidden);
+        });
         delete this.hiddenObjects[id];
         updatedIds.push(id);
       }
     });
 
     if (updatedIds.length > 0) {
-      this.changed.raiseEvent({ action: FeatureVisibilityAction.SHOW, ids: updatedIds });
+      this.changed.raiseEvent({
+        action: FeatureVisibilityAction.SHOW,
+        ids: updatedIds,
+      });
     }
   }
 
@@ -400,7 +428,7 @@ class FeatureVisibility {
 
   /**
    * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Entity} feature
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Entity} feature
    * @returns {boolean}
    */
   hasHiddenFeature(id, feature) {
@@ -409,7 +437,7 @@ class FeatureVisibility {
 
   /**
    * @param {string|number} id
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Entity} feature
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap-cesium/engine").Cesium3DTileFeature|import("@vcmap-cesium/engine").Entity} feature
    */
   addHiddenFeature(id, feature) {
     if (this.hiddenObjects[id]) {
@@ -424,9 +452,13 @@ class FeatureVisibility {
    * Clears all caches and removes cesium events.
    */
   destroy() {
-    Object.values(this.hiddenObjects).forEach((s) => { s.clear(); });
+    Object.values(this.hiddenObjects).forEach((s) => {
+      s.clear();
+    });
     this.hiddenObjects = {};
-    Object.values(this.highlightedObjects).forEach(({ features }) => { features.clear(); });
+    Object.values(this.highlightedObjects).forEach(({ features }) => {
+      features.clear();
+    });
     this.highlightedObjects = {};
     this.changed.destroy();
   }