@vcmap/core 5.0.0-rc.23 → 5.0.0-rc.25

package/src/layer/cesium/vectorContext.js

@@ -1,8 +1,18 @@
-import { PrimitiveCollection, BillboardCollection, LabelCollection } from '@vcmap/cesium';
+import {
+  PrimitiveCollection,
+  BillboardCollection,
+  LabelCollection,
+  Matrix4,
+  Cartesian3,
+  Math as CesiumMath,
+  Model,
+} from '@vcmap/cesium';
+import Viewpoint from '../../util/viewpoint.js';
 
 /**
  * @typedef {Object} VectorContextFeatureCache
  * @property {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>|undefined} primitives
+ * @property {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>|undefined} scaledPrimitives
  * @property {Array<import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Entity>|undefined} billboards
  * @property {Array<import("@vcmap/cesium").Label|import("@vcmap/cesium").Entity>|undefined} labels
  */
@@ -31,10 +41,11 @@ export function removeArrayFromCollection(collection, array) {
  * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
  * @param {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Label|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model>>} featuresMap
  * @param {import("@vcmap/cesium").PrimitiveCollection|import("@vcmap/cesium").BillboardCollection|import("@vcmap/cesium").LabelCollection|import("@vcmap/cesium").EntityCollection} primitiveCollection
+ * @returns {boolean} - if a feature was removed from the map
  */
 export function removeFeatureFromMap(feature, featuresMap, primitiveCollection) {
   removeArrayFromCollection(primitiveCollection, featuresMap.get(feature));
-  featuresMap.delete(feature);
+  return featuresMap.delete(feature);
 }
 
 /**
@@ -43,14 +54,26 @@ export function removeFeatureFromMap(feature, featuresMap, primitiveCollection)
  * @param {boolean} allowPicking
  * @param {import("@vcmap/cesium").BillboardCollection|import("@vcmap/cesium").LabelCollection|import("@vcmap/cesium").PrimitiveCollection|import("@vcmap/cesium").EntityCollection} primitiveCollection
  * @param {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Label|import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model>>} featureMap
+ * @param {import("@vcmap/cesium").SplitDirection} [splitDirection]
  */
-export function addPrimitiveToContext(primitives, feature, allowPicking, primitiveCollection, featureMap) {
+export function addPrimitiveToContext(
+  primitives,
+  feature,
+  allowPicking,
+  primitiveCollection,
+  featureMap,
+  splitDirection = undefined,
+) {
   if (primitives.length) {
     const cesiumPrimitives = primitives.map((primitiveOptions) => {
       const primitive = primitiveCollection.add(primitiveOptions);
       if (allowPicking) {
         setReferenceForPicking(feature, primitive);
       }
+      if (splitDirection && primitive instanceof Model) {
+        // Cesium currently only supports splitDirection on Model primitives
+        primitive.splitDirection = splitDirection;
+      }
       return primitive;
     });
     if (!featureMap.has(feature)) {
@@ -61,31 +84,111 @@ export function addPrimitiveToContext(primitives, feature, allowPicking, primiti
   }
 }
 
+/**
+ * Sets splitDirection on primitives. Currently only Model primitives support splitting.
+ * @param {import("@vcmap/cesium").SplitDirection} splitDirection
+ * @param {import("@vcmap/cesium").PrimitiveCollection} primitives
+ */
+export function setSplitDirectionOnPrimitives(splitDirection, primitives) {
+  for (let i = 0; i < primitives.length; i++) {
+    const p = primitives.get(i);
+    if (p instanceof Model) {
+      p.splitDirection = splitDirection;
+    }
+  }
+}
+
+/**
+ * Symbol used in self scaling
+ * @type {symbol}
+ */
+const scaleSymbol = Symbol('Scale');
+/**
+ * self scaling scratch
+ * @type {import("@vcmap/cesium").Cartesian3}
+ */
+const scratchCenter = new Cartesian3();
+
+/**
+ * Creates a self scaling primitive collection. It will scale a primitive of model in the collection
+ * in such a fashion, that the cartesian unit of 1 equals 1 pixel.
+ * @param {import("@vcmap/core").CesiumMap} map
+ * @param {import("@vcmap/cesium").PrimitiveCollection} primitiveCollection
+ * @param {{value: boolean}}dirtyRef
+ * @returns {function():void}
+ */
+export function setupScalingPrimitiveCollection(map, primitiveCollection, dirtyRef) {
+  let cachedVP = new Viewpoint({});
+  return map.getScene().postRender.addEventListener(() => {
+    const { length } = primitiveCollection;
+    if (length === 0) {
+      return;
+    }
+
+    const vp = map.getViewpointSync();
+    if (!dirtyRef.value && cachedVP.equals(vp, CesiumMath.EPSILON5)) {
+      return;
+    }
+
+    for (let i = 0; i < length; i++) {
+      const primitive = primitiveCollection.get(i);
+      if (!primitive.isDestroyed()) {
+        const { modelMatrix } = primitive;
+        const center = Matrix4.getTranslation(modelMatrix, scratchCenter);
+        const res = map.getCurrentResolutionFromCartesian(center);
+        if (primitive[scaleSymbol] !== res) {
+          primitive.modelMatrix = Matrix4.setScale(modelMatrix, new Cartesian3(res, res, res), new Matrix4());
+          primitive[scaleSymbol] = res;
+        }
+      }
+    }
+    dirtyRef.value = false;
+    cachedVP = vp;
+  });
+}
+
 /**
  * @class
  */
 class VectorContext {
   /**
-   * @param {import("@vcmap/cesium").Scene} scene
+   * @param {import("@vcmap/core").CesiumMap} map
    * @param {import("@vcmap/cesium").PrimitiveCollection} rootCollection
+   * @param {import("@vcmap/cesium").SplitDirection} splitDirection
    */
-  constructor(scene, rootCollection) {
+  constructor(map, rootCollection, splitDirection) {
+    const scene = map.getScene();
     /** @type {import("@vcmap/cesium").PrimitiveCollection} */
     this.primitives = new PrimitiveCollection();
+    /** @type {import("@vcmap/cesium").PrimitiveCollection} */
+    this.scaledPrimitives = new PrimitiveCollection();
     /** @type {import("@vcmap/cesium").BillboardCollection} */
     this.billboards = new BillboardCollection({ scene });
     /** @type {import("@vcmap/cesium").LabelCollection} */
     this.labels = new LabelCollection({ scene });
     /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>>} */
     this.featureToPrimitiveMap = new Map();
+    /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>>} */
+    this.featureToScaledPrimitiveMap = new Map();
     /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Billboard>>} */
     this.featureToBillboardMap = new Map();
     /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Label>>} */
     this.featureToLabelMap = new Map();
+    /** @type {import("@vcmap/cesium").SplitDirection} */
+    this.splitDirection = splitDirection;
+
+    /**
+     * @type {import("@vcmap/cesium").PrimitiveCollection}
+     * @private
+     */
+    this._rootCollection = rootCollection;
+    this._rootCollection.add(this.primitives);
+    this._rootCollection.add(this.scaledPrimitives);
+    this._rootCollection.add(this.billboards);
+    this._rootCollection.add(this.labels);
 
-    rootCollection.add(this.primitives);
-    rootCollection.add(this.billboards);
-    rootCollection.add(this.labels);
+    this._scaledDirty = { value: true };
+    this._postRenderListener = setupScalingPrimitiveCollection(map, this.scaledPrimitives, this._scaledDirty);
   }
 
   /**
@@ -94,7 +197,31 @@ class VectorContext {
    * @param {boolean=} allowPicking
    */
   addPrimitives(primitives, feature, allowPicking) {
-    addPrimitiveToContext(primitives, feature, allowPicking, this.primitives, this.featureToPrimitiveMap);
+    addPrimitiveToContext(
+      primitives,
+      feature,
+      allowPicking,
+      this.primitives,
+      this.featureToPrimitiveMap,
+      this.splitDirection,
+    );
+  }
+
+  /**
+   * @param {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>} primitives
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+   * @param {boolean=} allowPicking
+   */
+  addScaledPrimitives(primitives, feature, allowPicking) {
+    addPrimitiveToContext(
+      primitives,
+      feature,
+      allowPicking,
+      this.scaledPrimitives,
+      this.featureToScaledPrimitiveMap,
+      this.splitDirection,
+    );
+    this._scaledDirty.value = true;
   }
 
   /**
@@ -103,7 +230,14 @@ class VectorContext {
    * @param {boolean=} allowPicking
    */
   addBillboards(billboardOptions, feature, allowPicking) {
-    addPrimitiveToContext(billboardOptions, feature, allowPicking, this.billboards, this.featureToBillboardMap);
+    addPrimitiveToContext(
+      billboardOptions,
+      feature,
+      allowPicking,
+      this.billboards,
+      this.featureToBillboardMap,
+      this.splitDirection,
+    );
   }
 
   /**
@@ -112,7 +246,14 @@ class VectorContext {
    * @param {boolean=} allowPicking
    */
   addLabels(labelOptions, feature, allowPicking) {
-    addPrimitiveToContext(labelOptions, feature, allowPicking, this.labels, this.featureToLabelMap);
+    addPrimitiveToContext(
+      labelOptions,
+      feature,
+      allowPicking,
+      this.labels,
+      this.featureToLabelMap,
+      this.splitDirection,
+    );
   }
 
   /**
@@ -120,6 +261,7 @@ class VectorContext {
    */
   removeFeature(feature) {
     removeFeatureFromMap(feature, this.featureToPrimitiveMap, this.primitives);
+    this._scaledDirty.value = removeFeatureFromMap(feature, this.featureToScaledPrimitiveMap, this.scaledPrimitives);
     removeFeatureFromMap(feature, this.featureToBillboardMap, this.billboards);
     removeFeatureFromMap(feature, this.featureToLabelMap, this.labels);
   }
@@ -134,6 +276,8 @@ class VectorContext {
     const cache = {};
     cache.primitives = this.featureToPrimitiveMap.get(feature);
     this.featureToPrimitiveMap.delete(feature);
+    cache.scaledPrimitives = this.featureToScaledPrimitiveMap.get(feature);
+    this.featureToScaledPrimitiveMap.delete(feature);
     cache.billboards = this.featureToBillboardMap.get(feature);
     this.featureToBillboardMap.delete(feature);
     cache.labels = this.featureToLabelMap.get(feature);
@@ -146,21 +290,53 @@ class VectorContext {
    */
   clearFeatureCache(cache) {
     removeArrayFromCollection(this.primitives, cache.primitives);
+    removeArrayFromCollection(this.scaledPrimitives, cache.scaledPrimitives);
     removeArrayFromCollection(this.billboards, cache.billboards);
     removeArrayFromCollection(this.labels, cache.labels);
   }
 
+  /**
+   * Updates splitDirection on primitives. Currently only Model primitives support splitting.
+   * @param {import("@vcmap/cesium").SplitDirection} splitDirection
+   */
+  updateSplitDirection(splitDirection) {
+    this.splitDirection = splitDirection;
+    setSplitDirectionOnPrimitives(splitDirection, this.primitives);
+    setSplitDirectionOnPrimitives(splitDirection, this.scaledPrimitives);
+  }
+
   /**
    * Clears all collections and maps
    * @api
    */
   clear() {
     this.primitives.removeAll();
+    this.scaledPrimitives.removeAll();
     this.billboards.removeAll();
     this.labels.removeAll();
     this.featureToBillboardMap.clear();
     this.featureToLabelMap.clear();
     this.featureToPrimitiveMap.clear();
+    this._scaledDirty.value = this.featureToScaledPrimitiveMap.size > 0;
+    this.featureToScaledPrimitiveMap.clear();
+  }
+
+  /**
+   * Destroys this context and all its resources
+   */
+  destroy() {
+    if (this._rootCollection) {
+      this._rootCollection.remove(this.primitives);
+      this._rootCollection.remove(this.scaledPrimitives);
+      this._rootCollection.remove(this.billboards);
+      this._rootCollection.remove(this.labels);
+    }
+    this._rootCollection = null;
+    this.featureToBillboardMap.clear();
+    this.featureToLabelMap.clear();
+    this.featureToPrimitiveMap.clear();
+    this.featureToScaledPrimitiveMap.clear();
+    this._postRenderListener();
   }
 }
 

package/src/layer/cesium/vectorRasterTileCesiumImpl.js

@@ -23,7 +23,6 @@ class VectorRasterTileCesiumImpl extends RasterLayerCesiumImpl {
     const rasterLayerOptions = {
       ...options,
       tilingSchema: 'mercator',
-      splitDirection: undefined,
       opacity: undefined,
     };
     super(map, rasterLayerOptions);

package/src/layer/cesiumTilesetLayer.js

@@ -1,4 +1,4 @@
-import { SplitDirection, Matrix4 } from '@vcmap/cesium';
+import { Matrix4 } from '@vcmap/cesium';
 
 import { checkMaybe } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
@@ -7,7 +7,6 @@ import VectorStyleItem from '../style/vectorStyleItem.js';
 import FeatureLayer from './featureLayer.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';
@@ -21,7 +20,6 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @property {Object|undefined} tilesetOptions
  * @property {import("@vcmap/core").VectorStyleItem|VectorStyleItemOptions|undefined} highlightStyle
  * @property {import("@vcmap/core").FeatureVisibility|undefined} featureVisibility
- * @property {string|undefined} splitDirection - either 'left' or 'right', if omitted none is applied
  * @property {import("ol/coordinate").Coordinate|undefined} offset - an offset of x, y, z. x and y in degrees longitude/latitude respectively
  * @api
  */
@@ -36,7 +34,6 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {FeatureLayerImplementationOptions} CesiumTilesetImplementationOptions
  * @property {Object|undefined} tilesetOptions
- * @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
@@ -47,7 +44,6 @@ import { layerClassRegistry } from '../classRegistry.js';
  * represents a specific Building layer for cesium.
  * @class
  * @extends {FeatureLayer}
- * @implements {SplitLayer}
  * @api stable
  */
 class CesiumTilesetLayer extends FeatureLayer {
@@ -65,7 +61,6 @@ class CesiumTilesetLayer extends FeatureLayer {
       screenSpaceErrorMobile: 32,
       maximumMemoryUsage: 16,
       tilesetOptions: {},
-      splitDirection: undefined,
       offset: undefined,
     };
   }
@@ -109,22 +104,6 @@ class CesiumTilesetLayer extends FeatureLayer {
       ...tilesetOptions,
     };
 
-    /** @type {import("@vcmap/cesium").SplitDirection} */
-    this._splitDirection = SplitDirection.NONE;
-
-    if (options.splitDirection) {
-      this._splitDirection = options.splitDirection === 'left' ?
-        SplitDirection.LEFT :
-        SplitDirection.RIGHT;
-    }
-
-    /**
-     * raised if the split direction changes, is passed the split direction as its only argument
-     * @type {VcsEvent<import("@vcmap/cesium").SplitDirection>}
-     * @api
-     */
-    this.splitDirectionChanged = new VcsEvent();
-
     /**
      * @type {import("@vcmap/cesium").Matrix4|undefined}
      * @private
@@ -185,25 +164,6 @@ class CesiumTilesetLayer extends FeatureLayer {
       });
   }
 
-  /**
-   * @api
-   * @type {import("@vcmap/cesium").SplitDirection}
-   */
-  get splitDirection() { return this._splitDirection; }
-
-  /**
-   * @param {import("@vcmap/cesium").SplitDirection} direction
-   */
-  set splitDirection(direction) {
-    if (direction !== this._splitDirection) {
-      this.getImplementations().forEach((impl) => {
-        /** @type {CesiumTilesetCesiumImpl} */ (impl).updateSplitDirection(direction);
-      });
-      this._splitDirection = direction;
-      this.splitDirectionChanged.raiseEvent(this._splitDirection);
-    }
-  }
-
   /**
    * @inheritDoc
    * @returns {CesiumTilesetImplementationOptions}
@@ -212,7 +172,6 @@ class CesiumTilesetLayer extends FeatureLayer {
     return {
       ...super.getImplementationOptions(),
       tilesetOptions: this.tilesetOptions,
-      splitDirection: this.splitDirection,
       modelMatrix: this.modelMatrix,
       offset: this.offset,
     };
@@ -276,20 +235,6 @@ class CesiumTilesetLayer extends FeatureLayer {
     return null;
   }
 
-  // TODO type params
-  getGenericFeatureFromClickedObject(object) {
-    const attributes = { ...this.genericFeatureProperties, ...object.attributes || object };
-    return {
-      layerName: this.name,
-      layerClass: this.className,
-      attributes,
-      longitude: object.clickedPosition.longitude,
-      latitude: object.clickedPosition.latitude,
-      height: object.clickedPosition.height + this.balloonHeightOffset,
-      relativeToGround: false,
-    };
-  }
-
   /**
    * set the maximum screenspace error of this layer
    * @param {number} value
@@ -345,12 +290,6 @@ class CesiumTilesetLayer extends FeatureLayer {
       config.tilesetOptions = tilesetOptions;
     }
 
-    if (this._splitDirection !== SplitDirection.NONE) {
-      config.splitDirection = this._splitDirection === SplitDirection.RIGHT ?
-        'right' :
-        'left';
-    }
-
     if (Array.isArray(this.offset)) {
       config.offset = this.offset.slice();
     }
@@ -364,7 +303,6 @@ class CesiumTilesetLayer extends FeatureLayer {
    */
   destroy() {
     super.destroy();
-    this.splitDirectionChanged.destroy();
   }
 }
 

package/src/layer/czmlLayer.js

@@ -5,7 +5,7 @@ import { vcsLayerName } from './layerSymbols.js';
 import { layerClassRegistry } from '../classRegistry.js';
 
 /**
- * @typedef {DataSourceOptions} CzmlOptions
+ * @typedef {LayerOptions} CzmlOptions
  * @property {string|undefined} sourceUri
  * @api
  */

package/src/layer/dataSourceLayer.js

@@ -6,12 +6,6 @@ import { vcsLayerName } from './layerSymbols.js';
 import FeatureVisibility, { FeatureVisibilityAction } from './featureVisibility.js';
 import { layerClassRegistry } from '../classRegistry.js';
 
-/**
- * @typedef {LayerOptions} DataSourceOptions
- * @property {Object|undefined} genericFeatureProperties
- * @api
- */
-
 /**
  * @typedef {Object} DataSourcePickedObject
  * @property {import("@vcmap/cesium").Entity} id
@@ -36,21 +30,10 @@ class DataSourceLayer extends Layer {
   static get className() { return 'DataSourceLayer'; }
 
   /**
-   * @returns {DataSourceOptions}
-   */
-  static getDefaultOptions() {
-    return {
-      ...Layer.getDefaultOptions(),
-      genericFeatureProperties: {},
-    };
-  }
-
-  /**
-   * @param {DataSourceOptions} options
+   * @param {LayerOptions} options
    */
   constructor(options) {
     super(options);
-    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}
@@ -61,12 +44,6 @@ class DataSourceLayer extends Layer {
      * @type {import("@vcmap/cesium").DataSourceClock|undefined}
      */
     this.clock = undefined;
-    /**
-     * @type {Object}
-     * @private
-     */
-    this._genericFeatureProperties = options.genericFeatureProperties || defaultOptions.genericFeatureProperties;
-
     /**
      * The feature visibility of this layer. NOTE: Entities cannot be highlighted at this moment.
      * @type {FeatureVisibility}
@@ -223,35 +200,6 @@ class DataSourceLayer extends Layer {
     return null;
   }
 
-  /**
-   * @param {DataSourcePickedObject} object
-   * @returns {GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    const attributes = { ...this._genericFeatureProperties, ...object.attributes || {} };
-    return {
-      layerName: this.name,
-      layerClass: this.className,
-      attributes,
-      longitude: object.clickedPosition.longitude,
-      latitude: object.clickedPosition.latitude,
-      height: object.clickedPosition.height,
-      relativeToGround: false,
-    };
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {DataSourceOptions}
-   */
-  toJSON() {
-    const config = /** @type {DataSourceOptions} */ (super.toJSON());
-    if (Object.keys(this._genericFeatureProperties).length > 0) {
-      config.genericFeatureProperties = { ...this._genericFeatureProperties };
-    }
-    return config;
-  }
-
   /**
    * @inheritDoc
    */