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

package/src/layer/featureLayer.js

@@ -2,6 +2,7 @@ import Style from 'ol/style/Style.js';
 
 import { check } from '@vcsuite/check';
 import { parseInteger } from '@vcsuite/parsers';
+import { SplitDirection } from '@vcmap/cesium';
 import Layer from './layer.js';
 import StyleItem from '../style/styleItem.js';
 import VectorStyleItem from '../style/vectorStyleItem.js';
@@ -13,8 +14,8 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {LayerOptions} FeatureLayerOptions
  * @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 {string|undefined} splitDirection - either 'left' or 'right', if omitted none is applied (for 3D Vector currently only Models are split-able)
  * @property {FeatureVisibility|undefined} featureVisibility - vcs:undocumented
  * @api
  */
@@ -22,6 +23,7 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {LayerImplementationOptions} FeatureLayerImplementationOptions
  * @property {GlobalHider} globalHider
+ * @property {import("@vcmap/cesium").SplitDirection} splitDirection
  * @property {FeatureVisibility} featureVisibility
  * @property {import("@vcmap/core").StyleItem} style
  * @api
@@ -38,6 +40,7 @@ import { layerClassRegistry } from '../classRegistry.js';
 /**
  * @typedef {import("@vcmap/core").LayerImplementation<import("@vcmap/core").VcsMap>} FeatureLayerImplementation
  * @property {function(import("@vcmap/core").StyleItem, boolean=):void} updateStyle
+ * @property {function(import("@vcmap/cesium").SplitDirection):void} updateSplitDirection
  */
 
 /**
@@ -45,6 +48,7 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @class
  * @abstract
  * @extends {Layer}
+ * @implements {SplitLayer}
  * @api
  */
 class FeatureLayer extends Layer {
@@ -59,7 +63,7 @@ class FeatureLayer extends Layer {
       ...Layer.getDefaultOptions(),
       style: undefined,
       balloonHeightOffset: 10,
-      genericFeatureProperties: {},
+      splitDirection: undefined,
     };
   }
 
@@ -86,19 +90,27 @@ class FeatureLayer extends Layer {
      * @api
      */
     this.styleChanged = new VcsEvent();
-    /**
-     * @type {Object}
-     * @private
-     */
-    this._genericFeatureProperties = options.genericFeatureProperties || defaultOptions.genericFeatureProperties;
-
     /**
      * a height offset for rendering of a balloon for a feature of this layer.
      * @type {number}
      * @api
      */
     this.balloonHeightOffset = parseInteger(options.balloonHeightOffset, defaultOptions.balloonHeightOffset);
+    /** @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();
     /**
      * FeatureVisibility tracks the highlighting and hiding of features on this layer
      * @type {FeatureVisibility}
@@ -127,12 +139,23 @@ class FeatureLayer extends Layer {
   }
 
   /**
-   * Generic properties to be added to each feature. Use assignGenericFeatureProperties to change them.
-   * @type {Object}
-   * @readonly
+   * @api
+   * The splitDirection to be applied - for 3D vector features currently only working on points with a Model
+   * @type {import("@vcmap/cesium").SplitDirection}
+   */
+  get splitDirection() { return this._splitDirection; }
+
+  /**
+   * @param {import("@vcmap/cesium").SplitDirection} direction
    */
-  get genericFeatureProperties() {
-    return this._genericFeatureProperties;
+  set splitDirection(direction) {
+    if (direction !== this._splitDirection) {
+      this.getImplementations().forEach((impl) => {
+        /** @type {FeatureLayerImplementation} */ (impl).updateSplitDirection(direction);
+      });
+      this._splitDirection = direction;
+      this.splitDirectionChanged.raiseEvent(this._splitDirection);
+    }
   }
 
   /**
@@ -144,6 +167,7 @@ class FeatureLayer extends Layer {
       globalHider: this.globalHider,
       featureVisibility: this.featureVisibility,
       style: this.style,
+      splitDirection: this.splitDirection,
     };
   }
 
@@ -164,28 +188,6 @@ class FeatureLayer extends Layer {
     return null;
   }
 
-  /**
-   * This is called by the selectBehavior to create generic features from clicked objects
-   * needs to be implemented by each layer which has clickable objects
-   * @param {Object|VectorClickedObject|import("ol").Feature<import("ol/geom/Geometry").default>} object
-   * @returns {GenericFeature}
-   */
-  // eslint-disable-next-line no-unused-vars
-  getGenericFeatureFromClickedObject(object) { // XXX remove after event implementation
-    this.getLogger().warning('This method should be implemented by any specific layers');
-    return null;
-  }
-
-  /**
-   * Set properties, which are always added to the generic object, eg. for use in balloons
-   * @param {Object} properties
-   * @api
-   */
-  assignGenericFeatureProperties(properties) {
-    check(properties, Object);
-    Object.assign(this._genericFeatureProperties, properties);
-  }
-
   /**
    * @param {(DeclarativeStyleItemOptions|VectorStyleItemOptions|import("@vcmap/core").StyleItem)=} styleOptions
    * @param {(import("@vcmap/core").VectorStyleItem|import("@vcmap/core").DeclarativeStyleItem)=} defaultStyle
@@ -234,9 +236,10 @@ class FeatureLayer extends Layer {
     if (!this.getStyleOrDefaultStyle().equals(this._style)) {
       config.style = this.style.toJSON();
     }
-
-    if (Object.keys(this._genericFeatureProperties).length > 0) {
-      config.genericFeatureProperties = { ...this._genericFeatureProperties };
+    if (this._splitDirection !== SplitDirection.NONE) {
+      config.splitDirection = this._splitDirection === SplitDirection.RIGHT ?
+        'right' :
+        'left';
     }
     return config;
   }
@@ -249,6 +252,7 @@ class FeatureLayer extends Layer {
       this.featureVisibility.destroy();
     }
     this.styleChanged.destroy();
+    this.splitDirectionChanged.destroy();
     super.destroy();
   }
 }

package/src/layer/featureStoreLayer.js

@@ -454,21 +454,6 @@ class FeatureStoreLayer extends VectorLayer {
     return null;
   }
 
-  /**
-   * @param {Object|VectorClickedObject} object
-   * @returns {GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    if (object instanceof Feature) {
-      // @ts-ignore
-      return super.getGenericFeatureFromClickedObject(/** @type {VectorClickedObject} */ (object));
-    }
-    const generic = CesiumTilesetLayer.prototype.getGenericFeatureFromClickedObject.call(this, object);
-    generic.layerName = this.name;
-    generic.layerClass = this.className;
-    return generic;
-  }
-
   /**
    * @inheritDoc
    * @returns {Extent|null}

package/src/layer/layer.js

@@ -8,17 +8,6 @@ import VcsEvent from '../vcsEvent.js';
 import { layerClassRegistry } from '../classRegistry.js';
 import GlobalHider from './globalHider.js';
 
-/**
- * @typedef {Object} GenericFeature
- * @property {number} longitude
- * @property {number} latitude
- * @property {number} height
- * @property {string} layerName
- * @property {string} layerClass
- * @property {any} attributes
- * @property {boolean} relativeToGround
- */
-
 /**
  * @typedef {import("@vcmap/core").Layer} SplitLayer
  * @property {import("@vcmap/cesium").SplitDirection} splitDirection
@@ -68,6 +57,12 @@ import GlobalHider from './globalHider.js';
  * @api
  */
 
+/**
+ * @typedef {LayerImplementationOptions} SplitLayerImplementationOptions
+ * @property {import("@vcmap/cesium").SplitDirection} splitDirection
+ * @api
+ */
+
 /**
  * Layer implementations for the {@link CesiumMap} map
  * @namespace cesium

package/src/layer/layerSymbols.js

@@ -1,6 +1,7 @@
+/* eslint-disable import/prefer-default-export */
+
 /**
  * @type {symbol}
  * @const
  */
-// eslint-disable-next-line import/prefer-default-export
 export const vcsLayerName = Symbol('vcsLayerName');

package/src/layer/oblique/vectorObliqueImpl.js

@@ -116,6 +116,12 @@ class VectorObliqueImpl extends LayerObliqueImpl {
     }
   }
 
+  /**
+   * @param {import("@vcmap/cesium").SplitDirection} splitDirection
+   */
+  // eslint-disable-next-line class-methods-use-this,no-unused-vars
+  updateSplitDirection(splitDirection) {}
+
   /**
    * clears the current image and fetches features for the next
    * @private

package/src/layer/openStreetMapLayer.js

@@ -177,6 +177,12 @@ class OpenStreetMapLayer extends Layer {
       config.maxLevel = this.maxLevel;
     }
 
+    if (this._splitDirection !== SplitDirection.NONE) {
+      config.splitDirection = this._splitDirection === SplitDirection.RIGHT ?
+        'right' :
+        'left';
+    }
+
     return config;
   }
 

package/src/layer/openlayers/layerOpenlayersImpl.js

@@ -1,8 +1,15 @@
+import { SplitDirection } from '@vcmap/cesium';
+import { unByKey } from 'ol/Observable.js';
 import { vcsLayerName } from '../layerSymbols.js';
 import LayerImplementation from '../layerImplementation.js';
 
 /**
- * Layer implementation for {@link CesiumMap}.
+ * @typedef {LayerImplementationOptions} LayerOpenlayersImplementationOptions
+ * @property {import("@vcmap/cesium").SplitDirection} splitDirection
+ */
+
+/**
+ * Layer implementation for {@link OpenlayersMap}.
  * @class
  * @extends {LayerImplementation<import("@vcmap/core").OpenlayersMap>}}
  */
@@ -11,7 +18,7 @@ class LayerOpenlayersImpl extends LayerImplementation {
 
   /**
    * @param {import("@vcmap/core").OpenlayersMap} map
-   * @param {LayerImplementationOptions} options
+   * @param {LayerOpenlayersImplementationOptions} options
    */
   constructor(map, options) {
     super(map, options);
@@ -19,19 +26,27 @@ class LayerOpenlayersImpl extends LayerImplementation {
      * @type {import("ol/layer").Layer<import("ol/source/Source").default>|null}
      */
     this.olLayer = null;
+    /** @type {import("@vcmap/cesium").SplitDirection} */
+    this.splitDirection = options.splitDirection;
+    /**
+     * @type {Array<import("ol/events").EventsKey>|null}
+     * @private
+     */
+    this._splitDirectionRenderListeners = null;
   }
 
   /**
    * @inheritDoc
    * @returns {Promise<void>}
    */
-  initialize() {
+  async initialize() {
     if (!this.initialized) {
       this.olLayer = this.getOLLayer();
       this.olLayer[vcsLayerName] = this.name;
       this.map.addOLLayer(this.olLayer);
     }
-    return super.initialize();
+    await super.initialize();
+    this.updateSplitDirection(this.splitDirection);
   }
 
   /**
@@ -63,6 +78,52 @@ class LayerOpenlayersImpl extends LayerImplementation {
   // eslint-disable-next-line class-methods-use-this
   getOLLayer() { throw new Error(); }
 
+  /**
+   * @param {import("@vcmap/cesium").SplitDirection} splitDirection
+   */
+  updateSplitDirection(splitDirection) {
+    this.splitDirection = splitDirection;
+    if (this.initialized) {
+      if (this.splitDirection === SplitDirection.NONE && this._splitDirectionRenderListeners) {
+        unByKey(this._splitDirectionRenderListeners);
+        this._splitDirectionRenderListeners = null;
+        this.olLayer.changed();
+      } else if (splitDirection !== SplitDirection.NONE && !this._splitDirectionRenderListeners) {
+        this._splitDirectionRenderListeners = [];
+        this._splitDirectionRenderListeners
+          .push(/** @type {import("ol/events").EventsKey} */
+            (this.olLayer.on('prerender', this._splitPreRender.bind(this))),
+          );
+        this._splitDirectionRenderListeners
+          .push(/** @type {import("ol/events").EventsKey} */
+            (this.olLayer.on('postrender', (/** @type {import("ol/render/Event").default} */ event) => {
+              /** @type {CanvasRenderingContext2D} */ (event.context).restore();
+            })),
+          );
+        this.olLayer.changed();
+      }
+    }
+  }
+
+  /**
+   * @param {import("ol/render/Event").default} event
+   * @private
+   */
+  _splitPreRender(event) {
+    // eslint-disable-next-line prefer-destructuring
+    const context = /** @type {CanvasRenderingContext2D} */ (event.context);
+    const width = context.canvas.width * this.map.splitPosition;
+    context.save();
+    context.beginPath();
+
+    if (this.splitDirection === SplitDirection.LEFT) {
+      context.rect(0, 0, width, context.canvas.height);
+    } else {
+      context.rect(width, 0, context.canvas.width - width, context.canvas.height);
+    }
+    context.clip();
+  }
+
   /**
    * @inheritDoc
    */
@@ -71,6 +132,10 @@ class LayerOpenlayersImpl extends LayerImplementation {
       this.map.removeOLLayer(this.olLayer);
     }
     this.olLayer = null;
+    if (this._splitDirectionRenderListeners) {
+      unByKey(this._splitDirectionRenderListeners);
+      this._splitDirectionRenderListeners = null;
+    }
     super.destroy();
   }
 }

package/src/layer/openlayers/rasterLayerOpenlayersImpl.js

@@ -1,5 +1,3 @@
-import { SplitDirection } from '@vcmap/cesium';
-import { unByKey } from 'ol/Observable.js';
 import LayerOpenlayersImpl from './layerOpenlayersImpl.js';
 
 /**
@@ -18,8 +16,6 @@ class RasterLayerOpenlayersImpl extends LayerOpenlayersImpl {
    */
   constructor(map, options) {
     super(map, options);
-    /** @type {import("@vcmap/cesium").SplitDirection} */
-    this.splitDirection = options.splitDirection;
     /** @type {number} */
     this.minLevel = options.minLevel;
     /** @type {number} */
@@ -30,22 +26,6 @@ class RasterLayerOpenlayersImpl extends LayerOpenlayersImpl {
     this.extent = options.extent;
     /** @type {number} */
     this.opacity = options.opacity;
-    /**
-     * @type {Array<import("ol/events").EventsKey>|null}
-     * @private
-     */
-    this._splitDirectionRenderListeners = null;
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   */
-  initialize() {
-    return super.initialize()
-      .then(() => {
-        this.updateSplitDirection(this.splitDirection);
-      });
   }
 
   /**
@@ -57,66 +37,6 @@ class RasterLayerOpenlayersImpl extends LayerOpenlayersImpl {
       this.olLayer.setOpacity(this.opacity);
     }
   }
-
-  /**
-   * @param {import("@vcmap/cesium").SplitDirection} splitDirection
-   */
-  updateSplitDirection(splitDirection) {
-    this.splitDirection = splitDirection;
-    if (this.initialized) {
-      if (this.splitDirection === SplitDirection.NONE && this._splitDirectionRenderListeners) {
-        unByKey(this._splitDirectionRenderListeners);
-        this._splitDirectionRenderListeners = null;
-        this.olLayer.changed();
-      } else if (splitDirection !== SplitDirection.NONE && !this._splitDirectionRenderListeners) {
-        this._splitDirectionRenderListeners = [];
-        this._splitDirectionRenderListeners
-          .push(/** @type {import("ol/events").EventsKey} */
-            (this.olLayer.on('prerender', this._splitPreCompose.bind(this))),
-          );
-        this._splitDirectionRenderListeners
-          .push(/** @type {import("ol/events").EventsKey} */
-            (this.olLayer.on('postrender', (/** @type {import("ol/render/Event").default} */ event) => {
-              /** @type {CanvasRenderingContext2D} */ (event.context).restore();
-            })),
-          );
-        this.olLayer.changed();
-      }
-    }
-  }
-
-  /**
-   * @param {import("ol/render/Event").default} event
-   * @private
-   */
-  _splitPreCompose(event) {
-    if (!this.map.splitScreen) {
-      return;
-    }
-    // eslint-disable-next-line prefer-destructuring
-    const context = /** @type {CanvasRenderingContext2D} */ (event.context);
-    const width = context.canvas.width * this.map.splitScreen.position;
-    context.save();
-    context.beginPath();
-
-    if (this.splitDirection === SplitDirection.LEFT) {
-      context.rect(0, 0, width, context.canvas.height);
-    } else {
-      context.rect(width, 0, context.canvas.width - width, context.canvas.height);
-    }
-    context.clip();
-  }
-
-  /**
-   * @inheritDoc
-   */
-  destroy() {
-    if (this._splitDirectionRenderListeners) {
-      unByKey(this._splitDirectionRenderListeners);
-      this._splitDirectionRenderListeners = null;
-    }
-    super.destroy();
-  }
 }
 
 export default RasterLayerOpenlayersImpl;

package/src/layer/rasterLayer.js

@@ -24,8 +24,8 @@ import { layerClassRegistry } from '../classRegistry.js';
  * @property {number} maxLevel
  * @property {string} tilingSchema
  * @property {number} opacity
- * @property {import("@vcmap/cesium").SplitDirection} splitDirection
  * @property {Extent|undefined} extent
+ * @property {import("@vcmap/cesium").SplitDirection} splitDirection
  */
 
 /**

package/src/layer/vectorHelpers.js

@@ -1,11 +1,5 @@
 import { unByKey } from 'ol/Observable.js';
-import Feature from 'ol/Feature.js';
-import { HeightReference } from '@vcmap/cesium';
 import { FeatureVisibilityAction } from './featureVisibility.js';
-import Projection from '../util/projection.js';
-import { getHeightInfo } from '../util/featureconverter/featureconverterHelper.js';
-import { getFlatCoordinatesFromGeometry } from '../util/geometryHelpers.js';
-import Extent3D from '../util/featureconverter/extent3D.js';
 
 /**
  * Added to ol.source.Vector to determine, when the source has last had an update to its features visibility.
@@ -124,82 +118,3 @@ export function synchronizeFeatureVisibilityWithSource(featureVisibility, source
     () => { unByKey(sourceListener); },
   ];
 }
-
-/**
- * @param {VectorClickedObject} object
- * @param {import("@vcmap/core").VectorLayer|import("@vcmap/core").VectorTileLayer} layer
- * @returns {?GenericFeature}
- */
-export function getGenericFeatureFromClickedObject(object, layer) {
-  if (!(object instanceof Feature)) {
-    return null;
-  }
-  const attributes = object.getProperties();
-  delete attributes[object.getGeometryName()];
-
-  const { clickedPosition } = object;
-  if (!clickedPosition) {
-    return null;
-  }
-  let { latitude, longitude } = clickedPosition;
-  const geometry = object.getGeometry();
-  let heightOffset = clickedPosition.height;
-  let calculateHeight = !heightOffset;
-  if (!geometry) {
-    calculateHeight = false; // we cannot calculate the height without geometry;
-  }
-
-  let relativeToGround = !heightOffset;
-  // Edge Case ClickedPosition is next to the feature and Feature got detected in clickToleranz.
-  // if the clicked Position does not intersect the feature the closestPoint will be used.
-  // also if the clickedPosition is not on the Feature we do not trust the Height Value;
-  const mercatorPoint =
-    Projection.wgs84ToMercator([clickedPosition.longitude, clickedPosition.latitude, clickedPosition.height]);
-  if (geometry && !geometry.intersectsCoordinate(mercatorPoint)) {
-    const closestPoint = geometry.getClosestPoint(mercatorPoint);
-    [longitude, latitude] = Projection.mercatorToWgs84(closestPoint);
-    calculateHeight = true;
-  }
-
-  // edge case oblique in this case we do get a height value but not of the feature but the underlying terrain.
-  // this is necessary to calculate the correct position of the balloon
-
-  // if we do not have a height value from the clickedPosition we calculate the height based in the feature;
-  if (calculateHeight) {
-    const coordinates = getFlatCoordinatesFromGeometry(geometry);
-    const heightInfo = getHeightInfo(object, layer.vectorProperties, coordinates);
-    if (heightInfo.perPositionHeight || heightInfo.extruded) {
-      const extent = Extent3D.fromGeometry(geometry);
-      extent.extendWithHeightInfo(heightInfo);
-      heightOffset = extent.maxZ;
-    }
-    // edge case points are rendered depending on the terrain, so we set relativeToGround to true.
-    // In this case the heightAboveGroundAdjustment is also just an Offset.
-    if (
-      !heightInfo.extruded &&
-      (geometry.getType() === 'Point' || geometry.getType() === 'MultiPoint') &&
-      (
-        heightInfo.heightReference === HeightReference.RELATIVE_TO_GROUND ||
-        heightInfo.heightReference === HeightReference.CLAMP_TO_GROUND)
-    ) {
-      heightOffset = heightInfo.heightAboveGroundAdjustment;
-      relativeToGround = true;
-    } else {
-      heightOffset += heightInfo.heightAboveGroundAdjustment;
-    }
-
-    // if we have to calculate the height we have to take heightAboveGround into account
-  }
-
-  delete attributes.clickedPosition;
-  heightOffset = Number.isFinite(heightOffset) ? heightOffset : 0;
-  return {
-    layerName: layer.name,
-    layerClass: layer.className,
-    attributes: { ...layer.genericFeatureProperties, ...attributes },
-    longitude,
-    latitude,
-    height: heightOffset + layer.balloonHeightOffset,
-    relativeToGround,
-  };
-}

package/src/layer/vectorLayer.js

@@ -27,7 +27,6 @@ import ObliqueMap from '../map/obliqueMap.js';
 import CesiumMap from '../map/cesiumMap.js';
 import { originalStyle, updateOriginalStyle } from './featureVisibility.js';
 import StyleItem from '../style/styleItem.js';
-import { getGenericFeatureFromClickedObject } from './vectorHelpers.js';
 import { layerClassRegistry } from '../classRegistry.js';
 
 /**
@@ -85,6 +84,7 @@ import { layerClassRegistry } from '../classRegistry.js';
  * VectorLayer Layer for OpenlayersMap, Cesium and ObliqueMap
  * @class
  * @extends {FeatureLayer}
+ * @implements {SplitLayer}
  * @api stable
  */
 class VectorLayer extends FeatureLayer {
@@ -556,14 +556,6 @@ class VectorLayer extends FeatureLayer {
     return null;
   }
 
-  /**
-   * @param {VectorClickedObject} object
-   * @returns {?GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    return getGenericFeatureFromClickedObject(object, this);
-  }
-
   /**
    * @returns {VectorOptions}
    */