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

package/src/{vcs/vcm/util/style → style}/writeStyle.js

@@ -1,6 +1,5 @@
 import VectorStyleItem from './vectorStyleItem.js';
 import DeclarativeStyleItem from './declarativeStyleItem.js';
-import { referenceableStyleSymbol } from './styleItem.js';
 
 /**
  * @param {VectorStyleItemOptions} obj
@@ -8,11 +7,7 @@ import { referenceableStyleSymbol } from './styleItem.js';
  * @returns {VectorStyleItemOptions}
  */
 export function embedIconsInStyle(obj, embeddedIcons) {
-  if (
-    obj.image &&
-    obj.image.src &&
-    /^data:/.test(obj.image.src)
-  ) {
+  if (obj.image && obj.image.src && /^data:/.test(obj.image.src)) {
     if (embeddedIcons) {
       let index = embeddedIcons.indexOf(obj.image.src);
       if (index === -1) {
@@ -21,7 +16,8 @@ export function embedIconsInStyle(obj, embeddedIcons) {
       }
       obj.image.src = `:${index}`;
     } else {
-      obj.image = { // XXX is this the correct fallback?
+      obj.image = {
+        // XXX is this the correct fallback?
         radius: 5,
       };
     }
@@ -35,12 +31,11 @@ export function embedIconsInStyle(obj, embeddedIcons) {
  * @returns {VcsMeta}
  */
 function writeStyle(style, vcsMeta = {}) {
-  if (style[referenceableStyleSymbol]) { // XXX this should be configurable. In some cases, writting out the actual style would be desirable
-    vcsMeta.style = style.getReference();
-  } else if (style instanceof VectorStyleItem) {
-    vcsMeta.style = embedIconsInStyle(style.getOptions(), vcsMeta.embeddedIcons);
+  // XXX this entire function is not what is to be expected. feature store expects styles as refs to be possible
+  if (style instanceof VectorStyleItem) {
+    vcsMeta.style = embedIconsInStyle(style.toJSON(), vcsMeta.embeddedIcons);
   } else if (style instanceof DeclarativeStyleItem) {
-    vcsMeta.style = style.getOptions();
+    vcsMeta.style = style.toJSON();
   }
   return vcsMeta;
 }

package/src/{vcs/vcm/util → util}/clipping/clippingObject.js

@@ -1,16 +1,15 @@
 import { v4 as uuidv4 } from 'uuid';
-import { Cesium3DTileset } from '@vcmap/cesium';
+import { Cesium3DTileset } from '@vcmap-cesium/engine';
 
 import { check } from '@vcsuite/check';
 import { parseBoolean } from '@vcsuite/parsers';
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
-import CesiumMap from '../../maps/cesium.js';
-import VcsEvent from '../../event/vcsEvent.js';
+import CesiumMap from '../../map/cesiumMap.js';
+import VcsEvent from '../../vcsEvent.js';
 import LayerCollection from '../layerCollection.js';
 
 /**
  * @namespace clipping
- * @export
  * @api
  */
 
@@ -26,7 +25,7 @@ import LayerCollection from '../layerCollection.js';
  * @typedef {Object} ClippingObjectOptions
  * @property {Array<string>|undefined} layerNames
  * @property {Array<ClippingObjectEntityOption>|undefined} entities
- * @property {import("@vcmap/cesium").ClippingPlaneCollection|undefined} clippingPlaneCollection
+ * @property {import("@vcmap-cesium/engine").ClippingPlaneCollection|undefined} clippingPlaneCollection
  * @property {boolean} [terrain=false]
  * @property {boolean} [local=false] - if not local, coordinates are expected in ECEF
  * @api
@@ -36,21 +35,20 @@ import LayerCollection from '../layerCollection.js';
  * @returns {import("@vcsuite/logger").Logger}
  */
 function getLogger() {
-  return getLoggerByName('vcs.vcm.util.clipping.ClippingObject');
+  return getLoggerByName('ClippingObject');
 }
 
 const globeSymbol = Symbol('ClippingObjectGlobe');
 
 /**
  * The ClippingObject is a container for a Cesium.ClippingPlaneCollection. The container holds information on the
- * targeted Cesium objects, based on layerNames (for [CesiumTileset]{@link CesiumTileset}) or
- * layerName and entity id for Cesium.DataSource which are part of an [DataSource]{@link DataSource} layer.
+ * targeted Cesium objects, based on layerNames (for [CesiumTilesetLayer]{@link CesiumTilesetLayer}) or
+ * layerName and entity id for Cesium.DataSourceLayer which are part of an [DataSourceLayer]{@link DataSource} layer.
  * Adding a ClippingObject to the [ClippingObjectManager]{@link ClippingObjectManager} applies the
  * objects Cesium.ClippingPlaneCollection where applicable. Once added, changes to the targets of the object are tracked.
  * To update the Cesium.ClippingPlaneCollection or its definitions, you must trigger an update by setting the clippingPlaneCollection
  * property to the new definition.
  * @class
- * @export
  * @api stable
  */
 class ClippingObject {
@@ -80,12 +78,12 @@ class ClippingObject {
     /**
      * Key is a semantic identifier, eg. layerName or layerName-entitiyId, depending on the target. Targets
      * represent Cesium Object which support the clippingPlanes API
-     * @type {Map<(string|symbol), import("@vcmap/cesium").Entity|import("@vcmap/cesium").Cesium3DTileset|import("@vcmap/cesium").Globe>}
+     * @type {Map<(string|symbol), import("@vcmap-cesium/engine").Entity|import("@vcmap-cesium/engine").Cesium3DTileset|import("@vcmap-cesium/engine").Globe>}
      */
     this.targets = new Map();
 
     /**
-     * @type {import("@vcmap/cesium").ClippingPlaneCollection|null}
+     * @type {import("@vcmap-cesium/engine").ClippingPlaneCollection|null}
      * @private
      */
     this._clippingPlaneCollection = options.clippingPlaneCollection || null;
@@ -115,7 +113,7 @@ class ClippingObject {
     this.clippingPlaneUpdated = new VcsEvent();
 
     /**
-     * @type {Set<import("@vcmap/core").FeatureStore>}
+     * @type {Set<import("@vcmap/core").FeatureStoreLayer>}
      * @private
      */
     this._cachedFeatureStoreLayers = new Set();
@@ -126,12 +124,14 @@ class ClippingObject {
   /**
    * The current Cesium.ClippingPlaneCollection. To update the collection, set this property to the new definition.
    * @api
-   * @type {import("@vcmap/cesium").ClippingPlaneCollection|null}
+   * @type {import("@vcmap-cesium/engine").ClippingPlaneCollection|null}
    */
-  get clippingPlaneCollection() { return this._clippingPlaneCollection; }
+  get clippingPlaneCollection() {
+    return this._clippingPlaneCollection;
+  }
 
   /**
-   * @param {import("@vcmap/cesium").ClippingPlaneCollection} clippingPlaneCollection
+   * @param {import("@vcmap-cesium/engine").ClippingPlaneCollection} clippingPlaneCollection
    */
   set clippingPlaneCollection(clippingPlaneCollection) {
     this._clippingPlaneCollection = clippingPlaneCollection;
@@ -143,7 +143,9 @@ class ClippingObject {
    * @api
    * @type {boolean}
    */
-  get terrain() { return this._terrain; }
+  get terrain() {
+    return this._terrain;
+  }
 
   /**
    * @param {boolean} terrain
@@ -164,7 +166,9 @@ class ClippingObject {
    * @api
    * @type {boolean}
    */
-  get local() { return this._local; }
+  get local() {
+    return this._local;
+  }
 
   /**
    * @param {boolean} local
@@ -202,56 +206,63 @@ class ClippingObject {
       if (this.layerNames.includes(layer.name)) {
         if (layer.active) {
           const visualisations = map.getVisualizationsForLayer(layer);
-          const tilesets = visualisations ?
-            [...visualisations]
-              .filter(v => v instanceof Cesium3DTileset) :
-            [];
+          const tilesets = visualisations
+            ? [...visualisations].filter((v) => v instanceof Cesium3DTileset)
+            : [];
 
           if (tilesets.length > 0) {
-            tilesets.forEach(/** @param {import("@vcmap/cesium").Cesium3DTileset} tileset */ (tileset) => {
-              tileset.readyPromise.then((cesium3DTileset) => {
+            tilesets.forEach(
+              /** @param {import("@vcmap-cesium/engine").Cesium3DTileset} tileset */ (
+                tileset,
+              ) => {
                 if (this.layerNames.includes(layer.name) && layer.active) {
-                  this.targets.set(layer.name, cesium3DTileset);
+                  this.targets.set(layer.name, tileset);
                   this.targetsUpdated.raiseEvent();
                 }
-              });
-            });
+              },
+            );
           } else {
             const index = this.layerNames.indexOf(layer.name);
-            getLogger().warning(`layer ${layer.name} cannot have a ClippingObject applied`);
+            getLogger().warning(
+              `layer ${layer.name} cannot have a ClippingObject applied`,
+            );
             this.layerNames.splice(index, 1);
           }
         } else if (this.targets.has(layer.name)) {
           this.targets.delete(layer.name);
           this.targetsUpdated.raiseEvent();
         }
-      } else if (this.entities.find(eo => eo.layerName === layer.name)) {
+      } else if (this.entities.find((eo) => eo.layerName === layer.name)) {
         let raise = false;
         const visualisations = map.getVisualizationsForLayer(layer);
-        const dataSource = visualisations ?
-          [...visualisations][0] :
-          null;
+        const dataSource = visualisations ? [...visualisations][0] : null;
 
         if (!dataSource) {
           const index = this.layerNames.indexOf(layer.name);
-          getLogger().warning(`layer ${layer.name} cannot have a ClippingObject applied`);
+          getLogger().warning(
+            `layer ${layer.name} cannot have a ClippingObject applied`,
+          );
           this.layerNames.splice(index, 1);
           return;
         }
 
         this.entities
-          .filter(eo => eo.layerName === layer.name)
+          .filter((eo) => eo.layerName === layer.name)
           .forEach((eo) => {
             const key = `${eo.layerName}-${eo.entityId}`;
             if (layer.active) {
-              const entity = /** @type {import("@vcmap/cesium").CustomDataSource} */ (dataSource)
-                .entities.getById(eo.entityId);
+              const entity =
+                /** @type {import("@vcmap-cesium/engine").CustomDataSource} */ (
+                  dataSource
+                ).entities.getById(eo.entityId);
               if (entity) {
                 this.targets.set(key, entity);
                 raise = true;
               } else {
                 const index = this.entities.indexOf(eo);
-                getLogger().warning(`could not find entity with id ${eo.entityId} in layer ${eo.layerName}`);
+                getLogger().warning(
+                  `could not find entity with id ${eo.entityId} in layer ${eo.layerName}`,
+                );
                 this.entities.splice(index, 1);
               }
             } else if (this.targets.has(key)) {
@@ -264,11 +275,22 @@ class ClippingObject {
           this.targetsUpdated.raiseEvent();
         }
       }
-    } else if (this.layerNames.includes(layer.name) && layer.className === 'vcs.vcm.layer.FeatureStore') {
+    } else if (
+      this.layerNames.includes(layer.name) &&
+      layer.className === 'FeatureStoreLayer'
+    ) {
       if (layer.active) {
-        this._cachedFeatureStoreLayers.add(/** @type {import("@vcmap/core").FeatureStore} */ (layer));
-      } else if (this._cachedFeatureStoreLayers.has(/** @type {import("@vcmap/core").FeatureStore} */ (layer))) {
-        this._cachedFeatureStoreLayers.delete(/** @type {import("@vcmap/core").FeatureStore} */ (layer));
+        this._cachedFeatureStoreLayers.add(
+          /** @type {import("@vcmap/core").FeatureStoreLayer} */ (layer),
+        );
+      } else if (
+        this._cachedFeatureStoreLayers.has(
+          /** @type {import("@vcmap/core").FeatureStoreLayer} */ (layer),
+        )
+      ) {
+        this._cachedFeatureStoreLayers.delete(
+          /** @type {import("@vcmap/core").FeatureStoreLayer} */ (layer),
+        );
       }
     }
   }
@@ -293,7 +315,9 @@ class ClippingObject {
       }
 
       if (this._cachedFeatureStoreLayers.size > 0) {
-        this._cachedFeatureStoreLayers.forEach((layer) => { this.handleLayerChanged(layer); });
+        this._cachedFeatureStoreLayers.forEach((layer) => {
+          this.handleLayerChanged(layer);
+        });
         this._cachedFeatureStoreLayers.clear();
       }
     }
@@ -310,9 +334,9 @@ class ClippingObject {
 
     if (!this.layerNames.includes(layerName)) {
       this.layerNames.push(layerName);
-      const layer = this._layerCollection ?
-        this._layerCollection.getByKey(layerName) :
-        null;
+      const layer = this._layerCollection
+        ? this._layerCollection.getByKey(layerName)
+        : null;
       // XXX active state is not part of this yet
       if (layer && layer.active) {
         this.handleLayerChanged(layer);
@@ -349,11 +373,15 @@ class ClippingObject {
     check(layerName, String);
     check(entityId, String);
 
-    if (!this.entities.find(eo => eo.layerName === layerName && eo.entityId === entityId)) {
+    if (
+      !this.entities.find(
+        (eo) => eo.layerName === layerName && eo.entityId === entityId,
+      )
+    ) {
       this.entities.push({ layerName, entityId });
-      const layer = this._layerCollection ?
-        this._layerCollection.getByKey(layerName) :
-        null;
+      const layer = this._layerCollection
+        ? this._layerCollection.getByKey(layerName)
+        : null;
       if (layer && layer.active) {
         this.handleLayerChanged(layer);
       }
@@ -370,7 +398,9 @@ class ClippingObject {
     check(layerName, String);
     check(entityId, String);
 
-    const index = this.entities.findIndex(c => c.layerName === layerName && c.entityId === entityId);
+    const index = this.entities.findIndex(
+      (c) => c.layerName === layerName && c.entityId === entityId,
+    );
     if (index > -1) {
       this.entities.splice(index, 1);
     }

package/src/{vcs/vcm/util → util}/clipping/clippingObjectManager.js

@@ -1,7 +1,10 @@
 import { check } from '@vcsuite/check';
-import { clearClippingPlanes, setClippingPlanes } from './clippingPlaneHelper.js';
+import {
+  clearClippingPlanes,
+  setClippingPlanes,
+} from './clippingPlaneHelper.js';
 import ClippingObject from './clippingObject.js';
-import CesiumMap from '../../maps/cesium.js';
+import CesiumMap from '../../map/cesiumMap.js';
 
 /**
  * ClippingObjectManager, a singleton Class for managing [ClippingObjects]{@link ClippingObject}. The manager takes care to only apply a
@@ -12,12 +15,11 @@ import CesiumMap from '../../maps/cesium.js';
  * overwritten in the order they where added to the manager. Exclusive [ClippingObjects]{@link ClippingObject} are always applied last, even
  * if a default [ClippingObject]{@link ClippingObject} is added after.
  * @class
- * @export
  * @api stable
  */
 class ClippingObjectManager {
   static get className() {
-    return 'vcs.vcm.util.clipping.ClippingObjectManager';
+    return 'ClippingObjectManager';
   }
 
   constructor(layerCollection) {
@@ -32,7 +34,7 @@ class ClippingObjectManager {
      */
     this._exclusiveClippingObjects = null;
     /**
-     * @type {Map<(import("@vcmap/cesium").Globe|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Cesium3DTileset), ClippingObject>}
+     * @type {Map<(import("@vcmap-cesium/engine").Globe|import("@vcmap-cesium/engine").Entity|import("@vcmap-cesium/engine").Cesium3DTileset), ClippingObject>}
      * @private
      */
     this._targetsMap = new Map();
@@ -68,9 +70,10 @@ class ClippingObjectManager {
      * @type {Function}
      * @private
      */
-    this._layerChangedListener = this._layerCollection.stateChanged.addEventListener((layer) => {
-      this._layerChanged(layer);
-    });
+    this._layerChangedListener =
+      this._layerCollection.stateChanged.addEventListener((layer) => {
+        this._layerChanged(layer);
+      });
   }
 
   /**
@@ -101,9 +104,13 @@ class ClippingObjectManager {
    */
   _layerChanged(layer) {
     this.suspendUpdate = true;
-    this._defaultClippingObjects.forEach((co) => { co.handleLayerChanged(layer); });
+    this._defaultClippingObjects.forEach((co) => {
+      co.handleLayerChanged(layer);
+    });
     if (this._exclusiveClippingObjects) {
-      this._exclusiveClippingObjects.forEach((co) => { co.handleLayerChanged(layer); });
+      this._exclusiveClippingObjects.forEach((co) => {
+        co.handleLayerChanged(layer);
+      });
     }
     this.suspendUpdate = false;
   }
@@ -113,9 +120,13 @@ class ClippingObjectManager {
    */
   mapActivated(map) {
     this.suspendUpdate = true;
-    this._defaultClippingObjects.forEach((co) => { co.handleMapChanged(map); });
+    this._defaultClippingObjects.forEach((co) => {
+      co.handleMapChanged(map);
+    });
     if (this._exclusiveClippingObjects) {
-      this._exclusiveClippingObjects.forEach((co) => { co.handleMapChanged(map); });
+      this._exclusiveClippingObjects.forEach((co) => {
+        co.handleMapChanged(map);
+      });
     }
     this.suspendUpdate = false;
     this._activeMap = map;
@@ -145,7 +156,9 @@ class ClippingObjectManager {
 
     this._listenersMap.set(clippingObject, [
       clippingObject.targetsUpdated.addEventListener(this._update.bind(this)),
-      clippingObject.clippingPlaneUpdated.addEventListener(this._clippingPlaneUpdated.bind(this, clippingObject)),
+      clippingObject.clippingPlaneUpdated.addEventListener(
+        this._clippingPlaneUpdated.bind(this, clippingObject),
+      ),
     ]);
     this._update();
   }
@@ -160,7 +173,9 @@ class ClippingObjectManager {
 
     if (this._defaultClippingObjects.has(clippingObject)) {
       this._defaultClippingObjects.delete(clippingObject);
-      this._listenersMap.get(clippingObject).forEach((cb) => { cb(); });
+      this._listenersMap.get(clippingObject).forEach((cb) => {
+        cb();
+      });
       this._listenersMap.delete(clippingObject);
       this._update();
     }
@@ -175,8 +190,13 @@ class ClippingObjectManager {
   hasClippingObject(clippingObject) {
     check(clippingObject, ClippingObject);
 
-    return this._defaultClippingObjects.has(clippingObject) ||
-      !!(this._exclusiveClippingObjects && this._exclusiveClippingObjects.includes(clippingObject));
+    return (
+      this._defaultClippingObjects.has(clippingObject) ||
+      !!(
+        this._exclusiveClippingObjects &&
+        this._exclusiveClippingObjects.includes(clippingObject)
+      )
+    );
   }
 
   /**
@@ -194,8 +214,10 @@ class ClippingObjectManager {
     check(clippingObjects, [ClippingObject]);
     check(removedCb, Function);
 
-    if (clippingObjects.find(co => this._defaultClippingObjects.has(co))) {
-      throw new Error('Some ClippingObjects are already managed, remove them first');
+    if (clippingObjects.find((co) => this._defaultClippingObjects.has(co))) {
+      throw new Error(
+        'Some ClippingObjects are already managed, remove them first',
+      );
     }
 
     this._clearExclusiveClippingObjects();
@@ -209,7 +231,9 @@ class ClippingObjectManager {
       }
       this._listenersMap.set(clippingObject, [
         clippingObject.targetsUpdated.addEventListener(this._update.bind(this)),
-        clippingObject.clippingPlaneUpdated.addEventListener(this._clippingPlaneUpdated.bind(this, clippingObject)),
+        clippingObject.clippingPlaneUpdated.addEventListener(
+          this._clippingPlaneUpdated.bind(this, clippingObject),
+        ),
       ]);
     });
     this._update();
@@ -222,7 +246,9 @@ class ClippingObjectManager {
   _clearExclusiveClippingObjects(silent) {
     if (this._exclusiveClippingObjects) {
       this._exclusiveClippingObjects.forEach((cp) => {
-        this._listenersMap.get(cp).forEach((cb) => { cb(); });
+        this._listenersMap.get(cp).forEach((cb) => {
+          cb();
+        });
         this._listenersMap.delete(cp);
       });
       this._exclusiveClippingObjects = null;
@@ -270,7 +296,9 @@ class ClippingObjectManager {
       this._exclusiveClippingObjects.forEach(setTargets);
     }
 
-    currentTargets.forEach((t) => { clearClippingPlanes(t); });
+    currentTargets.forEach((t) => {
+      clearClippingPlanes(t);
+    });
     this._targetsMap.forEach((clippingObject, target) => {
       if (clippingObject.clippingPlaneCollection) {
         setClippingPlanes(
@@ -288,7 +316,10 @@ class ClippingObjectManager {
    */
   _clippingPlaneUpdated(clippingObject) {
     this._targetsMap.forEach((setClippingObject, target) => {
-      if (setClippingObject === clippingObject && clippingObject.clippingPlaneCollection) {
+      if (
+        setClippingObject === clippingObject &&
+        clippingObject.clippingPlaneCollection
+      ) {
         setClippingPlanes(target, clippingObject.clippingPlaneCollection);
       }
     });
@@ -299,7 +330,9 @@ class ClippingObjectManager {
    */
   destroy() {
     this._listenersMap.forEach((listeners) => {
-      listeners.forEach((cb) => { cb(); });
+      listeners.forEach((cb) => {
+        cb();
+      });
     });
     this._layerChangedListener();
     this._listenersMap.clear();