@vcmap/core 5.0.0-rc.2 → 5.0.0-rc.20

package/src/{vcs/vcm/layer/cesiumTileset.js → layer/cesiumTilesetLayer.js}

@@ -1,18 +1,17 @@
-import { ImagerySplitDirection, Matrix4 } from '@vcmap/cesium';
+import { SplitDirection, Matrix4 } from '@vcmap/cesium';
 
 import { checkMaybe } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
 import getJSONObjectFromObject from './cesium/x3dmHelper.js';
-import VectorStyleItem from '../util/style/vectorStyleItem.js';
+import VectorStyleItem from '../style/vectorStyleItem.js';
 import FeatureLayer from './featureLayer.js';
-import CesiumTilesetCesium, { getExtentFromTileset } from './cesium/cesiumTilesetCesium.js';
-import CesiumMap from '../maps/cesium.js';
-import VcsEvent from '../event/vcsEvent.js';
+import CesiumTilesetCesiumImpl, { getExtentFromTileset } from './cesium/cesiumTilesetCesiumImpl.js';
+import CesiumMap from '../map/cesiumMap.js';
+import VcsEvent from '../vcsEvent.js';
 import Extent from '../util/extent.js';
 import { mercatorProjection } from '../util/projection.js';
 import { isMobile } from '../util/isMobile.js';
-import { referenceableStyleSymbol } from '../util/style/styleItem.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerOptions} CesiumTilesetOptions
@@ -37,7 +36,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {FeatureLayerImplementationOptions} CesiumTilesetImplementationOptions
  * @property {Object|undefined} tilesetOptions
- * @property {import("@vcmap/cesium").ImagerySplitDirection} splitDirection
+ * @property {import("@vcmap/cesium").SplitDirection} splitDirection
  * @property {Array<CesiumTilesetTilesetProperties>|undefined} tilesetProperties
  * @property {import("@vcmap/cesium").Matrix4|undefined} modelMatrix
  * @property {import("ol/coordinate").Coordinate|undefined} offset
@@ -50,11 +49,10 @@ import { VcsClassRegistry } from '../classRegistry.js';
  * @extends {FeatureLayer}
  * @implements {SplitLayer}
  * @api stable
- * @export
  */
-class CesiumTileset extends FeatureLayer {
+class CesiumTilesetLayer extends FeatureLayer {
   /** @type {string} */
-  static get className() { return 'vcs.vcm.layer.CesiumTileset'; }
+  static get className() { return 'CesiumTilesetLayer'; }
 
   /**
    * @returns {CesiumTilesetOptions}
@@ -80,7 +78,7 @@ class CesiumTileset extends FeatureLayer {
     this._supportedMaps = [
       CesiumMap.className,
     ];
-    const defaultOptions = CesiumTileset.getDefaultOptions();
+    const defaultOptions = CesiumTilesetLayer.getDefaultOptions();
     if (this.url && !/\.json$/.test(this.url)) {
       this.url = `${this.url.replace(/\/$/, '')}/tileset.json`;
     }
@@ -111,18 +109,18 @@ class CesiumTileset extends FeatureLayer {
       ...tilesetOptions,
     };
 
-    /** @type {import("@vcmap/cesium").ImagerySplitDirection} */
-    this._splitDirection = ImagerySplitDirection.NONE;
+    /** @type {import("@vcmap/cesium").SplitDirection} */
+    this._splitDirection = SplitDirection.NONE;
 
     if (options.splitDirection) {
       this._splitDirection = options.splitDirection === 'left' ?
-        ImagerySplitDirection.LEFT :
-        ImagerySplitDirection.RIGHT;
+        SplitDirection.LEFT :
+        SplitDirection.RIGHT;
     }
 
     /**
      * raised if the split direction changes, is passed the split direction as its only argument
-     * @type {VcsEvent<import("@vcmap/cesium").ImagerySplitDirection>}
+     * @type {VcsEvent<import("@vcmap/cesium").SplitDirection>}
      * @api
      */
     this.splitDirectionChanged = new VcsEvent();
@@ -158,7 +156,7 @@ class CesiumTileset extends FeatureLayer {
 
     this._modelMatrix = modelMatrix;
     this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesium} impl */ (impl) => {
+      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */ (impl) => {
         impl.updateModelMatrix(modelMatrix);
       });
   }
@@ -182,30 +180,35 @@ class CesiumTileset extends FeatureLayer {
 
     this._offset = offset;
     this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesium} impl */ (impl) => {
+      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */ (impl) => {
         impl.updateOffset(offset);
       });
   }
 
   /**
    * @api
-   * @type {import("@vcmap/cesium").ImagerySplitDirection}
+   * @type {import("@vcmap/cesium").SplitDirection}
    */
   get splitDirection() { return this._splitDirection; }
 
   /**
-   * @param {import("@vcmap/cesium").ImagerySplitDirection} direction
+   * @param {import("@vcmap/cesium").SplitDirection} direction
    */
   set splitDirection(direction) {
     if (direction !== this._splitDirection) {
       this.getImplementations().forEach((impl) => {
-        /** @type {CesiumTilesetCesium} */ (impl).updateSplitDirection(direction);
+        /** @type {CesiumTilesetCesiumImpl} */ (impl).updateSplitDirection(direction);
       });
       this._splitDirection = direction;
       this.splitDirectionChanged.raiseEvent(this._splitDirection);
     }
   }
 
+  async initialize() {
+    await this.style.cesiumStyle.readyPromise;
+    return super.initialize();
+  }
+
   /**
    * @inheritDoc
    * @returns {CesiumTilesetImplementationOptions}
@@ -223,11 +226,11 @@ class CesiumTileset extends FeatureLayer {
   /**
    * @inheritDoc
    * @param {import("@vcmap/core").VcsMap} map
-   * @returns {Array<CesiumTilesetCesium>}
+   * @returns {Array<CesiumTilesetCesiumImpl>}
    */
   createImplementationsForMap(map) {
     if (map instanceof CesiumMap) {
-      return [new CesiumTilesetCesium(map, this.getImplementationOptions())];
+      return [new CesiumTilesetCesiumImpl(map, this.getImplementationOptions())];
     }
     return [];
   }
@@ -261,12 +264,12 @@ class CesiumTileset extends FeatureLayer {
     if (metaExtent) {
       return metaExtent;
     }
-    const impl = /** @type {CesiumTilesetCesium} */ (this.getImplementations()[0]);
+    const impl = /** @type {CesiumTilesetCesiumImpl} */ (this.getImplementations()[0]);
     if (impl) {
       const threeDimExtent = getExtentFromTileset(impl.cesium3DTileset);
 
       const actualExtent = new Extent({
-        ...mercatorProjection.toJSON(),
+        projection: mercatorProjection.toJSON(),
         coordinates: threeDimExtent,
       });
 
@@ -299,7 +302,7 @@ class CesiumTileset extends FeatureLayer {
    */
   setMaximumScreenSpaceError(value) {
     this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesium} impl */(impl) => {
+      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */(impl) => {
         if (impl.cesium3DTileset) {
           impl.cesium3DTileset.maximumScreenSpaceError = value;
         }
@@ -312,11 +315,9 @@ class CesiumTileset extends FeatureLayer {
   toJSON() {
     /** @type {CesiumTilesetOptions} */
     const config = super.toJSON();
-    const defaultOptions = CesiumTileset.getDefaultOptions();
+    const defaultOptions = CesiumTilesetLayer.getDefaultOptions();
     if (this.highlightStyle) {
-      config.highlightStyle = this.highlightStyle[referenceableStyleSymbol] ?
-        this.highlightStyle.getReference() :
-        this.highlightStyle.getOptions();
+      config.highlightStyle = this.highlightStyle.toJSON();
     }
 
     if (this.screenSpaceError !== defaultOptions.screenSpaceError) {
@@ -349,8 +350,8 @@ class CesiumTileset extends FeatureLayer {
       config.tilesetOptions = tilesetOptions;
     }
 
-    if (this._splitDirection !== ImagerySplitDirection.NONE) {
-      config.splitDirection = this._splitDirection === ImagerySplitDirection.RIGHT ?
+    if (this._splitDirection !== SplitDirection.NONE) {
+      config.splitDirection = this._splitDirection === SplitDirection.RIGHT ?
         'right' :
         'left';
     }
@@ -372,5 +373,5 @@ class CesiumTileset extends FeatureLayer {
   }
 }
 
-VcsClassRegistry.registerClass(CesiumTileset.className, CesiumTileset);
-export default CesiumTileset;
+layerClassRegistry.registerClass(CesiumTilesetLayer.className, CesiumTilesetLayer);
+export default CesiumTilesetLayer;

package/src/{vcs/vcm/layer/czml.js → layer/czmlLayer.js}

@@ -1,8 +1,8 @@
 import { CzmlDataSource } from '@vcmap/cesium';
 
-import DataSource from './dataSource.js';
+import DataSourceLayer from './dataSourceLayer.js';
 import { vcsLayerName } from './layerSymbols.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {DataSourceOptions} CzmlOptions
@@ -12,18 +12,17 @@ import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * @class
- * @export
- * @extends {DataSource}
+ * @extends {DataSourceLayer}
  */
-class Czml extends DataSource {
-  static get className() { return 'vcs.vcm.layer.Czml'; }
+class CzmlLayer extends DataSourceLayer {
+  static get className() { return 'CzmlLayer'; }
 
   /**
    * @returns {CzmlOptions}
    */
   static getDefaultOptions() {
     return {
-      ...DataSource.getDefaultOptions(),
+      ...DataSourceLayer.getDefaultOptions(),
       sourceUri: undefined,
     };
   }
@@ -36,7 +35,7 @@ class Czml extends DataSource {
     this.dataSource = new CzmlDataSource();
     this.entities = this.dataSource.entities;
 
-    const defaultOptions = Czml.getDefaultOptions();
+    const defaultOptions = CzmlLayer.getDefaultOptions();
     /** @type {string|null} */
     this.sourceUri = options.sourceUri || defaultOptions.sourceUri;
     /** @type {Function} */
@@ -44,7 +43,7 @@ class Czml extends DataSource {
     /** @type {Function} */
     this._loadedReject = () => {};
     /**
-     * A Promise resolving with the DataSource on load
+     * A Promise resolving with the DataSourceLayer on load
      * @type {Promise<void>}
      * @api stable
      */
@@ -77,11 +76,9 @@ class Czml extends DataSource {
    * @private
    */
   async _loadData() {
-    const loaded = /** @type {import("@vcmap/cesium").CzmlDataSource} */ (this.dataSource)
+    await /** @type {import("@vcmap/cesium").CzmlDataSource} */ (this.dataSource)
       .load(this.url, this.sourceUri ? { sourceUri: this.sourceUri } : undefined);
-    await new Promise((resolve, reject) => {
-      loaded.then(resolve, reject);
-    });
+
     this.entities.values.forEach((entity) => {
       entity[vcsLayerName] = this.name;
     });
@@ -137,5 +134,5 @@ class Czml extends DataSource {
   }
 }
 
-VcsClassRegistry.registerClass(Czml.className, Czml);
-export default Czml;
+layerClassRegistry.registerClass(CzmlLayer.className, CzmlLayer);
+export default CzmlLayer;

package/src/{vcs/vcm/layer/dataSource.js → layer/dataSourceLayer.js}

@@ -1,11 +1,10 @@
 import { EntityCollection } from '@vcmap/cesium';
 import Layer from './layer.js';
-import CesiumMap from '../maps/cesium.js';
-import DataSourceCesium from './cesium/dataSourceCesium.js';
+import CesiumMap from '../map/cesiumMap.js';
+import DataSourceCesiumImpl from './cesium/dataSourceCesiumImpl.js';
 import { vcsLayerName } from './layerSymbols.js';
 import FeatureVisibility, { FeatureVisibilityAction } from './featureVisibility.js';
-import { getGlobalHider } from './globalHider.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerOptions} DataSourceOptions
@@ -30,12 +29,11 @@ import { VcsClassRegistry } from '../classRegistry.js';
 /**
  * Represents a layer of Cesium.Entity
  * @class
- * @export
  * @extends {Layer}
  * @api stable
  */
-class DataSource extends Layer {
-  static get className() { return 'vcs.vcm.layer.DataSource'; }
+class DataSourceLayer extends Layer {
+  static get className() { return 'DataSourceLayer'; }
 
   /**
    * @returns {DataSourceOptions}
@@ -52,7 +50,7 @@ class DataSource extends Layer {
    */
   constructor(options) {
     super(options);
-    const defaultOptions = DataSource.getDefaultOptions();
+    const defaultOptions = DataSourceLayer.getDefaultOptions();
     /**
      * The entities of this layer. Use the `addEntity` API to add Enitities to ensure interoperability with vcm interfaces
      * @type {import("@vcmap/cesium").EntityCollection}
@@ -86,12 +84,21 @@ class DataSource extends Layer {
     ];
   }
 
+  /**
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    super.setGlobalHider(globalHider);
+    this._setUpFeatureVisibility();
+  }
+
   /**
    * Sets up listeners for featureVisibility and global hider
    * @private
    */
   _setUpFeatureVisibility() {
-    const globalHider = getGlobalHider();
+    this._featureVisibilityListeners.forEach((cb) => { cb(); });
+
     this._featureVisibilityListeners = [
       this.featureVisibility.changed.addEventListener(({ action, ids }) => {
         if (action === FeatureVisibilityAction.HIDE) {
@@ -103,28 +110,30 @@ class DataSource extends Layer {
           });
         } // highlight is _possible_ but very tricky with all the possible entity values with potential materials
       }),
-      globalHider.changed.addEventListener(({ action, ids }) => {
-        if (action === FeatureVisibilityAction.HIDE) {
-          ids.forEach((id) => {
-            const entity = this.entities.getById(id);
-            if (entity) {
-              globalHider.addFeature(id, entity);
-            }
-          });
-        }
-      }),
       this.entities.collectionChanged.addEventListener((c, added) => {
         added.forEach((entity) => {
           if (this.featureVisibility.hiddenObjects[entity.id]) {
             this.featureVisibility.addHiddenFeature(entity.id, entity);
           }
-
-          if (globalHider.hiddenObjects[entity.id]) {
-            globalHider.addFeature(entity.id, entity);
+          if (this.globalHider && this.globalHider.hiddenObjects[entity.id]) {
+            this.globalHider.addFeature(entity.id, entity);
           }
         });
       }),
     ];
+
+    if (this.globalHider) {
+      this._featureVisibilityListeners.push(this.globalHider.changed.addEventListener(({ action, ids }) => {
+        if (action === FeatureVisibilityAction.HIDE) {
+          ids.forEach((id) => {
+            const entity = this.entities.getById(id);
+            if (entity) {
+              this.globalHider.addFeature(id, entity);
+            }
+          });
+        }
+      }));
+    }
   }
 
   /**
@@ -151,11 +160,11 @@ class DataSource extends Layer {
 
   /**
    * @param {CesiumMap} map
-   * @returns {Array<DataSourceCesium>}
+   * @returns {Array<DataSourceCesiumImpl>}
    */
   createImplementationsForMap(map) {
     if (map instanceof CesiumMap) {
-      return [new DataSourceCesium(map, this.getImplementationOptions())];
+      return [new DataSourceCesiumImpl(map, this.getImplementationOptions())];
     }
     return [];
   }
@@ -183,7 +192,7 @@ class DataSource extends Layer {
    */
   flyToEntity(id) {
     this.getImplementations().forEach((impl) => {
-      /** @type {DataSourceCesium} */ (impl).flyToEntity(id);
+      /** @type {DataSourceCesiumImpl} */ (impl).flyToEntity(id);
     });
   }
 
@@ -255,5 +264,5 @@ class DataSource extends Layer {
   }
 }
 
-VcsClassRegistry.registerClass(DataSource.className, DataSource);
-export default DataSource;
+layerClassRegistry.registerClass(DataSourceLayer.className, DataSourceLayer);
+export default DataSourceLayer;

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

@@ -3,18 +3,16 @@ import Style from 'ol/style/Style.js';
 import { check } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
 import Layer from './layer.js';
-import StyleItem, { referenceableStyleSymbol } from '../util/style/styleItem.js';
-import VectorStyleItem from '../util/style/vectorStyleItem.js';
+import StyleItem from '../style/styleItem.js';
+import VectorStyleItem from '../style/vectorStyleItem.js';
 import FeatureVisibility from './featureVisibility.js';
-import { getStyleOrDefaultStyle } from '../util/style/styleFactory.js';
-import VcsEvent from '../event/vcsEvent.js';
-import { styleCollection } from '../globalCollections.js';
-import { VcsClassRegistry } from '../classRegistry.js';
+import { getStyleOrDefaultStyle } from '../style/styleFactory.js';
+import VcsEvent from '../vcsEvent.js';
+import { layerClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerOptions} FeatureLayerOptions
- * @property {DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|string|undefined} style
- * @property {string|undefined} activeStyleName - vcs:undocumented
+ * @property {DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|undefined} style
  * @property {Object|undefined} genericFeatureProperties - properties to add to generic features, eg for display in the balloon
  * @property {number} [balloonHeightOffset=10]
  * @property {FeatureVisibility|undefined} featureVisibility - vcs:undocumented
@@ -23,6 +21,7 @@ import { VcsClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {LayerImplementationOptions} FeatureLayerImplementationOptions
+ * @property {GlobalHider} globalHider
  * @property {FeatureVisibility} featureVisibility
  * @property {import("@vcmap/core").StyleItem} style
  * @api
@@ -42,16 +41,15 @@ import { VcsClassRegistry } from '../classRegistry.js';
  */
 
 /**
- * Base class for all layers representing features, e.g. Vector, Buildings, POIs
+ * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
  * @class
  * @abstract
  * @extends {Layer}
- * @export
  * @api
  */
 class FeatureLayer extends Layer {
   /** @type {string} */
-  static get className() { return 'vcs.vcm.layer.FeatureLayer'; }
+  static get className() { return 'FeatureLayer'; }
 
   /**
    * @returns {FeatureLayerOptions}
@@ -76,7 +74,7 @@ class FeatureLayer extends Layer {
      * @type {import("@vcmap/core").StyleItem}
      * @private
      */
-    this._style = this.getStyleOrDefaultStyle(options.activeStyleName || options.style);
+    this._style = this.getStyleOrDefaultStyle(options.style);
     /**
      * @type {import("@vcmap/core").StyleItem}
      * @private
@@ -143,11 +141,20 @@ class FeatureLayer extends Layer {
   getImplementationOptions() {
     return {
       ...super.getImplementationOptions(),
+      globalHider: this.globalHider,
       featureVisibility: this.featureVisibility,
       style: this.style,
     };
   }
 
+  /**
+   * @param {import("@vcmap/core").GlobalHider} globalHider
+   */
+  setGlobalHider(globalHider) {
+    super.setGlobalHider(globalHider);
+    this.forceRedraw();
+  }
+
   /**
    * @param {Object|import("ol").Feature<import("ol/geom/Geometry").default>|import("@vcmap/cesium").Cesium3DTilePointFeature|import("@vcmap/cesium").Cesium3DTileFeature|DataSourcePickedObject} object
    * @returns {?Object}
@@ -180,7 +187,7 @@ class FeatureLayer extends Layer {
   }
 
   /**
-   * @param {(Reference|DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem|string)=} styleOptions
+   * @param {(DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem)=} styleOptions
    * @param {(import("@vcmap/core").VectorStyleItem|import("@vcmap/core").DeclarativeStyleItem)=} defaultStyle
    * @returns {import("@vcmap/core").StyleItem}
    */
@@ -191,21 +198,14 @@ class FeatureLayer extends Layer {
 
   /**
    * Sets the style based on a styleName on a layer
-   * @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
    */
   setStyle(style, silent) {
-    check(style, [Style, StyleItem, Function, String]);
+    check(style, [Style, StyleItem, Function]);
 
-    if (typeof style === 'string') {
-      const styleItem = styleCollection.getByKey(style);
-      if (!styleItem) {
-        this.getLogger().warning(`could not find style with name ${style}`);
-        return;
-      }
-      this._style = styleItem;
-    } else if (style instanceof StyleItem) {
+    if (style instanceof StyleItem) {
       this._style = style;
     } else {
       this._style = new VectorStyleItem({});
@@ -232,11 +232,7 @@ class FeatureLayer extends Layer {
   toJSON() {
     const config = /** @type {FeatureLayerOptions} */ (super.toJSON());
     if (!this.getStyleOrDefaultStyle().equals(this._style)) {
-      if (this._style[referenceableStyleSymbol]) {
-        config.style = this.style.getReference();
-      } else {
-        config.style = this.style.getOptions();
-      }
+      config.style = this.style.toJSON();
     }
 
     if (Object.keys(this._genericFeatureProperties).length > 0) {
@@ -257,5 +253,5 @@ class FeatureLayer extends Layer {
   }
 }
 
-VcsClassRegistry.registerClass(FeatureLayer.className, FeatureLayer);
+layerClassRegistry.registerClass(FeatureLayer.className, FeatureLayer);
 export default FeatureLayer;