@vcmap/core 5.0.0-rc.1 → 5.0.0-rc.12

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

@@ -10,7 +10,7 @@ import Circle from 'ol/style/Circle.js';
 import RegularShape from 'ol/style/RegularShape.js';
 
 import { check, checkMaybe } from '@vcsuite/check';
-import StyleItem, { StyleType } from './styleItem.js';
+import StyleItem from './styleItem.js';
 import {
   parseColor,
   PatternType,
@@ -24,6 +24,7 @@ import {
   getDefaultVectorStyleItemOptions,
 } from './styleHelpers.js';
 import { getShapeFromOptions } from './shapesCategory.js';
+import { styleClassRegistry } from '../classRegistry.js';
 
 /**
  * @typedef {Object} VectorStyleItemPattern
@@ -96,7 +97,7 @@ import { getShapeFromOptions } from './shapesCategory.js';
  * @property {number} POLYLINE
  * @property {number} POINT
  */
-export const olcsGeometryType = {
+export const OlcsGeometryType = {
   POLYGON: 1,
   POLYLINE: 2,
   POINT: 3,
@@ -114,21 +115,19 @@ export const olcsGeometryType = {
 
 /**
  * Is set on a feature and is used to signal that the feature has a specific vectorStyleItem.
- * Is set by the Editor if the layerStyle is overwritten. The Vector layer assures this style is set, if
+ * Is set by the Editor if the layerStyle is overwritten. The VectorLayer layer assures this style is set, if
  * the style on the layer is not a DeclarativeStyle
  * @type {symbol}
- * @export
  */
 export const vectorStyleSymbol = Symbol('VcsVectorStyleItem');
 
 /**
  * @class
  * @extends {StyleItem}
- * @export
  * @api
  */
 class VectorStyleItem extends StyleItem {
-  static get className() { return 'vcs.vcm.util.style.VectorStyleItem'; }
+  static get className() { return 'VectorStyleItem'; }
 
   /**
    * @param {VectorStyleItemOptions} options
@@ -521,12 +520,12 @@ class VectorStyleItem extends StyleItem {
   updateCesiumStyleColor(silent) {
     const colorConditions = getDefaultCondition('olcs_color', true);
     if (this.stroke && this.stroke.getColor()) {
-      colorConditions.splice(1, 0, [`\${olcs_geometryType}===${olcsGeometryType.POLYLINE}`, getStringColor(this.stroke.getColor())]);
+      colorConditions.splice(1, 0, [`\${olcs_geometryType}===${OlcsGeometryType.POLYLINE}`, getStringColor(this.stroke.getColor())]);
     }
     if (this._image instanceof Circle && this._image.getFill()) {
       colorConditions.splice(
         1, 0,
-        [`\${olcs_geometryType}===${olcsGeometryType.POINT}`, getStringColor(this._image.getFill().getColor())],
+        [`\${olcs_geometryType}===${OlcsGeometryType.POINT}`, getStringColor(this._image.getFill().getColor())],
       );
     }
     if (this.fillColor) {
@@ -710,7 +709,9 @@ class VectorStyleItem extends StyleItem {
       });
       return result;
     }
-    return new VectorStyleItem(this.getOptions());
+    const config = this.toJSON();
+    delete config.name;
+    return new VectorStyleItem(config);
   }
 
   /**
@@ -719,6 +720,7 @@ class VectorStyleItem extends StyleItem {
    * @api
    */
   assign(result) {
+    super.assign(result);
     if (result.fillColor) {
       this.fillColor = result.fillColor.slice();
     }
@@ -755,79 +757,61 @@ class VectorStyleItem extends StyleItem {
   }
 
   /**
-   * @param {VectorStyleItemSections=} sections
    * @returns {VectorStyleItemOptions}
    * @api
    */
-  getOptions(sections) {
+  toJSON() {
     // TODO clean default, only copy relevant keys
-    const options = /** @type {VectorStyleItemOptions} */ (super.getOptions(sections));
-    options.type = StyleType.VECTOR;
-    /** @type {VectorStyleItemSections} */
-    const usedSections = sections || {
-      fill: true,
-      stroke: true,
-      text: true,
-      image: true,
-    };
-
-    if (usedSections.fill) {
-      if (this._fillOptions) {
-        options.fill = {
-          color: /** @type {import("ol/color").Color} */ (parseColor(this._fillOptions.color).slice()),
-        };
-        if (this._fillOptions.pattern) {
-          options.fill.pattern = { ...this._fillOptions.pattern };
-        }
-      } else if (this.exclude.fill) {
-        options.fill = false;
+    const options = /** @type {VectorStyleItemOptions} */ (super.toJSON());
+    if (this._fillOptions) {
+      options.fill = {
+        color: /** @type {import("ol/color").Color} */ (parseColor(this._fillOptions.color).slice()),
+      };
+      if (this._fillOptions.pattern) {
+        options.fill.pattern = { ...this._fillOptions.pattern };
       }
+    } else if (this.exclude.fill) {
+      options.fill = false;
     }
 
-    if (usedSections.stroke) {
-      if (this._stroke) {
-        options.stroke = getStrokeOptions(this._stroke);
-      } else if (this.exclude.stroke) {
-        options.stroke = false;
-      }
+    if (this._stroke) {
+      options.stroke = getStrokeOptions(this._stroke);
+    } else if (this.exclude.stroke) {
+      options.stroke = false;
     }
 
-    if (usedSections.text) {
-      if (this._text) {
-        options.text = getTextOptions(this._text);
-      }
+    if (this._text) {
+      options.text = getTextOptions(this._text);
     }
 
-    if (usedSections.label) {
+    if (this._label) {
       options.label = this._label;
     }
 
-    if (usedSections.image) { // TODO this should be nicer...
-      if (this._image instanceof Icon) {
-        options.image = {
-          src: this._image.getSrc(), // XXX this is an issue... we dont want a data URI in the geoJSON
-          scale: this._image.getScale(),
-          opacity: this._image.getOpacity(),
-        };
-      } else if (this._image instanceof Circle) {
-        options.image = {
-          scale: this._image.getScale(),
-          fill: getFillOptions(this._image),
-          radius: this._image.getRadius(),
-          stroke: this._image.getStroke() ? getStrokeOptions(this._image.getStroke()) : undefined,
-        };
-      } else if (this._image instanceof RegularShape) {
-        options.image = {
-          scale: this._image.getScale(),
-          fill: getFillOptions(this._image),
-          points: this._image.getPoints(),
-          angle: this._image.getAngle(),
-          radius: this._image.getRadius(),
-          stroke: this._image.getStroke() ? getStrokeOptions(this._image.getStroke()) : undefined,
-        };
-      } else if (this.exclude.image) {
-        options.image = false;
-      }
+    if (this._image instanceof Icon) {
+      options.image = {
+        src: this._image.getSrc(), // XXX this is an issue... we dont want a data URI in the geoJSON
+        scale: this._image.getScale(),
+        opacity: this._image.getOpacity(),
+      };
+    } else if (this._image instanceof Circle) {
+      options.image = {
+        scale: this._image.getScale(),
+        fill: getFillOptions(this._image),
+        radius: this._image.getRadius(),
+        stroke: this._image.getStroke() ? getStrokeOptions(this._image.getStroke()) : undefined,
+      };
+    } else if (this._image instanceof RegularShape) {
+      options.image = {
+        scale: this._image.getScale(),
+        fill: getFillOptions(this._image),
+        points: this._image.getPoints(),
+        angle: this._image.getAngle(),
+        radius: this._image.getRadius(),
+        stroke: this._image.getStroke() ? getStrokeOptions(this._image.getStroke()) : undefined,
+      };
+    } else if (this.exclude.image) {
+      options.image = false;
     }
 
     return options;
@@ -841,33 +825,38 @@ class VectorStyleItem extends StyleItem {
     const type = feature.getGeometry().getType();
     const extrusion = feature.get('olcs_extrudedHeight') ||
       (feature.get('olcs_storeyHeight') && feature.get('olcs_storeyNumber'));
-    const sections = {};
+    const sections = new Set();
 
     if (type === 'Point' || type === 'MultiPoint') {
       if (feature[vectorStyleSymbol].label != null) {
-        sections.text = true;
-        sections.label = true;
+        sections.add('text');
+        sections.add('label');
       }
-      sections.image = true;
+      sections.add('image');
 
       if (extrusion) {
-        sections.stroke = true;
+        sections.add('stroke');
       }
     } else if (type === 'LineString' || type === 'MultiLineString') {
-      sections.stroke = true;
+      sections.add('stroke');
       if (extrusion) {
-        sections.fill = true;
+        sections.add('fill');
       }
     } else if (type === 'Polygon' || type === 'MultiPolygon' || type === 'Circle') {
-      sections.stroke = true;
-      sections.fill = true;
+      sections.add('stroke');
+      sections.add('fill');
     } else if (type === 'GeometryCollection') {
-      sections.stroke = true;
-      sections.fill = true;
-      sections.image = true;
-      sections.text = true;
-    }
-    return this.getOptions(sections);
+      sections.add('stroke');
+      sections.add('fill');
+      sections.add('image');
+      sections.add('text');
+    }
+    const config = this.toJSON();
+    const options = {};
+    sections.forEach((key) => {
+      options[key] = config[key];
+    });
+    return options;
   }
 
   /**
@@ -904,14 +893,13 @@ export default VectorStyleItem;
 
 /**
  * @type {VectorStyleItem}
- * @export
  */
 export const defaultVectorStyle = new VectorStyleItem(getDefaultVectorStyleItemOptions());
+styleClassRegistry.registerClass(VectorStyleItem.className, VectorStyleItem);
 
 /**
  * @param {import("@vcmap/cesium").Color} cesiumColor
  * @returns {VectorStyleItem}
- * @export
  */
 export function fromCesiumColor(cesiumColor) {
   const color = /** @type {import("ol/color").Color} */ (cesiumColor.toBytes());

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
@@ -34,13 +33,11 @@ export function embedIconsInStyle(obj, embeddedIcons) {
  * @param {VcsMeta=} vcsMeta
  * @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);
+function writeStyle(style, vcsMeta = {}) { // 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

@@ -4,13 +4,12 @@ import { Cesium3DTileset } from '@vcmap/cesium';
 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
  */
 
@@ -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 {
@@ -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();
@@ -264,11 +262,11 @@ 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));
       }
     }
   }

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

@@ -1,7 +1,7 @@
 import { check } from '@vcsuite/check';
 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 +12,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) {

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

@@ -19,7 +19,7 @@ import Polygon from 'ol/geom/Polygon.js';
 
 import { check, checkMaybe } from '@vcsuite/check';
 import Projection, { mercatorProjection, wgs84Projection } from '../projection.js';
-import { createOrUpdateFromGeometry } from '../featureconverter/extent3d.js';
+import Extent3D from '../featureconverter/extent3D.js';
 import { enforceEndingVertex, enforceRightHand, getFlatCoordinatesFromGeometry } from '../geometryHelpers.js';
 
 /**
@@ -75,9 +75,9 @@ function createVerticalPlanes(coords) {
  */
 function createHorizontalPlanes(feature, coords, options) {
   const clippingPlanes = [];
-  const extent = createOrUpdateFromGeometry(feature.getGeometry());
-  let min = Number.isFinite(extent[2]) ? extent[2] : 0;
-  let max = Number.isFinite(extent[5]) ? extent[5] : 0;
+  const extent = Extent3D.fromGeometry(feature.getGeometry());
+  let min = Number.isFinite(extent.minZ) ? extent.minZ : 0;
+  let max = Number.isFinite(extent.maxZ) ? extent.maxZ : 0;
   const extruded = feature.get('olcs_extrudedHeight');
   if (extruded) {
     max += extruded;
@@ -139,7 +139,6 @@ function createEndingPlanes(coords) {
  * @param {import("@vcmap/cesium").Matrix4=} transformMatrix - 4x4 matrix specifying the transform of clipping planes from Earth's fixed frame to another one
  * @returns {import("@vcmap/cesium").ClippingPlaneCollection|null}
  * @api stable
- * @export
  */
 export function createClippingPlaneCollection(feature, options = {}, transformMatrix) {
   check(feature, Feature);
@@ -203,7 +202,6 @@ export function createClippingPlaneCollection(feature, options = {}, transformMa
  * @param {import("@vcmap/cesium").Cartesian3=} originPoint - the origin point of the transformation target, so the plane distance can be set correctly
  * @returns {import("@vcmap/cesium").ClippingPlaneCollection}
  * @api stable
- * @export
  */
 export function copyClippingPlanesToCollection(source, result, transformMatrix, originPoint) {
   check(source, ClippingPlaneCollection);
@@ -346,7 +344,6 @@ export function setClippingPlanes(target, clippingPlaneCollection, local) {
  * @param {number} [offsetDistance=25] - the offset from the coordinate to use for the size of the geometry
  * @returns {import("ol").Feature<import("ol/geom/Geometry").default>} - the features geometry is in web mercator
  * @api
- * @export
  */
 export function createClippingFeature(coordinate, camera, vertical = false, offsetDistance = 25) {
   check(coordinate, [Number]);
@@ -389,7 +386,6 @@ export function createClippingFeature(coordinate, camera, vertical = false, offs
  * @param {boolean=} [infinite=false]
  * @returns {CreationOptions}
  * @api
- * @export
  */
 export function getClippingOptions(feature, infinite = false) {
   checkMaybe(feature, Feature);

package/src/{vcs/vcm/util → util}/collection.js

@@ -1,9 +1,8 @@
-import VcsEvent from '../event/vcsEvent.js';
+import VcsEvent from '../vcsEvent.js';
 
 /**
  * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
  * @class
- * @export
  * @template {*} T
  * @api
  */
@@ -135,15 +134,28 @@ class Collection {
     return null;
   }
 
+  /**
+   * internal remove function, to remove an item from the collection, does not raise an event.
+   * @param {T} item
+   * @returns {number} returns the index of the removed item or -1 if the item has not been found.
+   * @protected
+   */
+  _remove(item) {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      this._array.splice(index, 1);
+    }
+    return index;
+  }
+
   /**
    * Removes an item from the collection
    * @param {T} item
    * @api
    */
   remove(item) {
-    const index = this._array.indexOf(item);
+    const index = this._remove(item);
     if (index > -1) {
-      this._array.splice(index, 1);
       this.removed.raiseEvent(item);
     }
   }

package/src/{vcs/vcm/util → util}/extent.js

@@ -1,8 +1,10 @@
 import Projection from './projection.js';
 
 /**
- * @typedef {ProjectionOptions} ExtentOptions
- * @property {import("ol/extent").Extent|undefined} coordinates - if not specified, the extent of the projection is used
+ * @typedef {Object} ExtentOptions
+ * @property {string} [type]
+ * @property {import("ol/extent").Extent|undefined} [coordinates] - if not specified, the extent of the projection is used
+ * @property {ProjectionOptions} [projection] - if not specified the default projection is assumed
  * @api
  */
 
@@ -31,20 +33,20 @@ function checkExtentValidity(extent) {
 /**
  * Extent Class
  * @class
- * @export
  * @api
  */
 class Extent {
+  /**
+   * @type {string}
+   */
+  static get className() { return 'Extent'; }
+
   /**
    * @param {ExtentOptions=} options object
    */
   constructor(options = {}) {
     /** @type {Projection} */
-    this.projection = new Projection({
-      epsg: options.epsg,
-      proj4: options.proj4,
-      alias: options.alias,
-    });
+    this.projection = new Projection(options.projection);
 
     /** @type {import("ol/extent").Extent|null} */
     this.extent = options.coordinates || this.projection.proj.getExtent();
@@ -78,15 +80,19 @@ class Extent {
   /**
    * @returns {ExtentOptions}
    */
-  getConfigObject() {
-    return { coordinates: this.extent.slice(), ...this.projection.getConfigObject() };
+  toJSON() {
+    return {
+      coordinates: this.extent.slice(),
+      projection: this.projection.toJSON(),
+      type: Extent.className,
+    };
   }
 
   /**
    * @returns {Extent}
    */
   clone() {
-    return new Extent(this.getConfigObject());
+    return new Extent(this.toJSON());
   }
 
   /**
@@ -112,7 +118,7 @@ class Extent {
    * @api
    */
   static validateOptions(options) {
-    return Projection.validateOptions(options) && checkExtentValidity(options.coordinates);
+    return Projection.validateOptions(options.projection || {}) && checkExtentValidity(options.coordinates);
   }
 
   /**