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

package/src/layer/featureLayer.js

@@ -13,7 +13,6 @@ 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 {FeatureVisibility|undefined} featureVisibility - vcs:undocumented
  * @api
@@ -59,7 +58,6 @@ class FeatureLayer extends Layer {
       ...Layer.getDefaultOptions(),
       style: undefined,
       balloonHeightOffset: 10,
-      genericFeatureProperties: {},
     };
   }
 
@@ -86,19 +84,12 @@ 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);
-
     /**
      * FeatureVisibility tracks the highlighting and hiding of features on this layer
      * @type {FeatureVisibility}
@@ -126,15 +117,6 @@ class FeatureLayer extends Layer {
     return this._style;
   }
 
-  /**
-   * Generic properties to be added to each feature. Use assignGenericFeatureProperties to change them.
-   * @type {Object}
-   * @readonly
-   */
-  get genericFeatureProperties() {
-    return this._genericFeatureProperties;
-  }
-
   /**
    * @returns {FeatureLayerImplementationOptions}
    */
@@ -164,28 +146,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,10 +194,6 @@ 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 };
-    }
     return config;
   }
 

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

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';
 
 /**
@@ -556,14 +555,6 @@ class VectorLayer extends FeatureLayer {
     return null;
   }
 
-  /**
-   * @param {VectorClickedObject} object
-   * @returns {?GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    return getGenericFeatureFromClickedObject(object, this);
-  }
-
   /**
    * @returns {VectorOptions}
    */

package/src/layer/vectorProperties.js

@@ -1,7 +1,7 @@
 import deepEqual from 'fast-deep-equal';
-import { HeightReference, ClassificationType, NearFarScalar, Cartesian3 } from '@vcmap/cesium';
+import { Cartesian3, ClassificationType, HeightReference, NearFarScalar } from '@vcmap/cesium';
 import { check, checkMaybe } from '@vcsuite/check';
-import { parseBoolean, parseEnumKey, parseNumber, parseInteger } from '@vcsuite/parsers';
+import { parseBoolean, parseEnumKey, parseInteger, parseNumber } from '@vcsuite/parsers';
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
 import VcsEvent from '../vcsEvent.js';
 
@@ -35,23 +35,63 @@ function getLogger() {
  * @property {number} [modelHeading=0] - in degrees
  * @property {number} [modelPitch=0] - in degrees
  * @property {number} [modelRoll=0] - in degrees
+ * @property {boolean} [modelAutoScale]
  * @property {Object|undefined} modelOptions - Model options are merged with the model definition from model url, scale and orientation and accepts any option passed to a Cesium.Model.
+ * @property {VectorPropertiesPrimitiveOptions} [primitiveOptions] - primitive options to render in 3D instead of a billboard
  * @property {string|undefined} baseUrl - a base URL to resolve relative model URLs against.
  * @api
  */
 
 /**
- * @typedef {Object} VectorPropertiesModelOptions
- * @property {string} url
+ * @typedef {Object} VectorPropertiesBaseOptions
  * @property {Array<number>} scale
  * @property {number} heading
  * @property {number} pitch
  * @property {number} roll
+ * @property {boolean} autoScale
+ */
+
+/**
+ * @typedef {VectorPropertiesBaseOptions} VectorPropertiesModelOptions
+ * @property {string} url
  * @api
  */
 
+/**
+ * @typedef {Object} VectorPropertiesPrimitiveOptions
+ * @property {PrimitiveOptionsType} type
+ * @property {*} geometryOptions - the options for the specified geometry
+ * @property {import("ol/color").Color|import("ol/colorlike").ColorLike} [depthFailColor]
+ * @property {import("ol/coordinate").Coordinate} [offset] an offset to apply to the geometry
+ * @property {Object} [additionalOptions] - additional options passed to the Primitive constructor
+ */
+
+/**
+ * @typedef {VectorPropertiesBaseOptions} VectorPropertiesPrimitive
+ * @property {VectorPropertiesPrimitiveOptions} primitiveOptions
+ */
+
+/**
+ * @enum {string}
+ * @property {string} CYLINDER
+ * @property {string} SPHERE
+ * @property {string} ELLIPSE
+ * @property {string} ELLIPSOID
+ * @property {string} BOC
+ * @const
+ */
+export const PrimitiveOptionsType = {
+  CYLINDER: 'cylinder',
+  SPHERE: 'sphere',
+  ELLIPSOID: 'ellipsoid',
+  BOX: 'box',
+};
+
 /**
  * @enum {import("@vcmap/cesium").HeightReference}
+ * @property {import("@vcmap/cesium").HeightReference} clampToGround
+ * @property {import("@vcmap/cesium").HeightReference} absolute
+ * @property {import("@vcmap/cesium").HeightReference} relativeToGround
  * @const
  */
 export const AltitudeModeCesium = {
@@ -62,6 +102,9 @@ export const AltitudeModeCesium = {
 
 /**
  * @enum {import("@vcmap/cesium").ClassificationType}
+ * @property {import("@vcmap/cesium").ClassificationType} both
+ * @property {import("@vcmap/cesium").ClassificationType} cesium3DTile
+ * @property {import("@vcmap/cesium").ClassificationType} terrain
  * @const
  */
 export const ClassificationTypeCesium = {
@@ -197,7 +240,9 @@ class VectorProperties {
       modelPitch: 0,
       modelRoll: 0,
       modelOptions: undefined,
+      modelAutoScale: false,
       baseUrl: undefined,
+      primitiveOptions: undefined,
     };
   }
 
@@ -345,6 +390,16 @@ class VectorProperties {
      * @private
      */
     this._modelOptions = options.modelOptions || defaultValues.modelOptions;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    this._modelAutoScale = parseBoolean(options.modelAutoScale, defaultValues.modelAutoScale);
+    /**
+     * @type {VectorPropertiesPrimitiveOptions}
+     * @private
+     */
+    this._primitiveOptions = options.primitiveOptions || defaultValues.primitiveOptions;
 
     /**
      * Event raised when properties change. is passed an array of keys for the changed properties.
@@ -1010,6 +1065,35 @@ class VectorProperties {
     return {};
   }
 
+  /**
+   * @type {boolean}
+   */
+  get modelAutoScale() {
+    return this._modelAutoScale;
+  }
+
+  /**
+   * @param {boolean} value
+   */
+  set modelAutoScale(value) {
+    checkMaybe(value, Boolean);
+
+    const booleanValue = !!value;
+    if (this._modelAutoScale !== booleanValue) {
+      this._modelAutoScale = booleanValue;
+      this.propertyChanged.raiseEvent(['modelAutoScale']);
+    }
+  }
+
+  /**
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+   * @returns {*|boolean}
+   */
+  getModelAutoScale(feature) {
+    const featureValue = feature.get('olcs_modelAutoScale');
+    return featureValue !== undefined ? featureValue : this.modelAutoScale;
+  }
+
   /**
    * @api
    * @type {string}
@@ -1040,6 +1124,67 @@ class VectorProperties {
     return featureValue !== undefined ? featureValue : this.baseUrl;
   }
 
+  /**
+   * @type {VectorPropertiesPrimitiveOptions}
+   */
+  get primitiveOptions() {
+    return this._primitiveOptions;
+  }
+
+  /**
+   * @param {VectorPropertiesPrimitiveOptions|undefined} value
+   */
+  set primitiveOptions(value) {
+    checkMaybe(value, Object);
+
+    if (this._primitiveOptions !== value) {
+      this._primitiveOptions = value;
+      this.propertyChanged.raiseEvent(['primitiveOptions']);
+    }
+  }
+
+  /**
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+   * @returns {VectorPropertiesPrimitiveOptions|null}
+   * @api
+   */
+  getPrimitiveOptions(feature) {
+    const featureValue = feature.get('olcs_primitiveOptions');
+    return featureValue !== undefined ? featureValue : this.primitiveOptions;
+  }
+
+  /**
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+   * @returns {VectorPropertiesBaseOptions}
+   * @private
+   */
+  _getBaseOptions(feature) {
+    return {
+      scale: [this.getModelScaleX(feature), this.getModelScaleY(feature), this.getModelScaleZ(feature)],
+      heading: this.getModelHeading(feature),
+      pitch: this.getModelPitch(feature),
+      roll: this.getModelRoll(feature),
+      autoScale: this.getModelAutoScale(feature),
+    };
+  }
+
+  /**
+   * Returns the primive definition of this feature
+   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+   * @returns {VectorPropertiesPrimitive|null}
+   */
+  getPrimitive(feature) {
+    const primitiveOptions = this.getPrimitiveOptions(feature);
+    if (!primitiveOptions?.geometryOptions) {
+      return null;
+    }
+
+    return {
+      ...this._getBaseOptions(feature),
+      primitiveOptions,
+    };
+  }
+
   /**
    * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
    * @returns {VectorPropertiesModelOptions|null}
@@ -1057,11 +1202,8 @@ class VectorProperties {
     }
 
     return {
+      ...this._getBaseOptions(feature),
       url,
-      scale: [this.getModelScaleX(feature), this.getModelScaleY(feature), this.getModelScaleZ(feature)],
-      heading: this.getModelHeading(feature),
-      pitch: this.getModelPitch(feature),
-      roll: this.getModelRoll(feature),
     };
   }
 

package/src/layer/vectorTileLayer.js

@@ -12,7 +12,6 @@ import { FeatureVisibilityAction, globalHidden, hidden, highlighted } from './fe
 import { getStylesArray } from '../util/featureconverter/convert.js';
 import { vcsLayerName } from './layerSymbols.js';
 import TileProviderFeatureProvider from '../featureProvider/tileProviderFeatureProvider.js';
-import { getGenericFeatureFromClickedObject } from './vectorHelpers.js';
 import { originalFeatureSymbol } from './vectorSymbols.js';
 import { getObjectFromClassRegistry, layerClassRegistry, tileProviderClassRegistry } from '../classRegistry.js';
 import TileProvider from './tileProvider/tileProvider.js';
@@ -238,14 +237,6 @@ class VectorTileLayer extends FeatureLayer {
     return null;
   }
 
-  /**
-   * @param {VectorClickedObject} object
-   * @returns {?GenericFeature}
-   */
-  getGenericFeatureFromClickedObject(object) {
-    return getGenericFeatureFromClickedObject(object, this);
-  }
-
   /**
    * @returns {number}
    * @private

package/src/map/cesiumMap.js

@@ -27,6 +27,7 @@ import {
   KeyboardEventModifier,
   ScreenSpaceEventType,
   Cesium3DTileset,
+  Cartographic,
 } from '@vcmap/cesium';
 
 import { check, checkMaybe } from '@vcsuite/check';
@@ -739,15 +740,14 @@ class CesiumMap extends VcsMap {
   }
 
   /**
-   * @inheritDoc
-   * @param {import("ol/coordinate").Coordinate} coordinate - in mercator
+   * @param {import("@vcmap/cesium").Cartesian3} cartesian
+   * @param {number} latitude - in radians
    * @returns {number}
+   * @private
    */
-  getCurrentResolution(coordinate) {
+  _getCurrentResolutionFromCartesianLatitude(cartesian, latitude) {
     const cam = this._cesiumWidget.scene.camera;
-    const wgs84Coordinate = Projection.mercatorToWgs84(coordinate);
-    const distance = Cartesian3
-      .distance(Cartesian3.fromDegrees(wgs84Coordinate[0], wgs84Coordinate[1], wgs84Coordinate[2]), cam.position);
+    const distance = Cartesian3.distance(cartesian, cam.position);
 
     const fov = Math.PI / 3.0;
     const width = this.mapElement.offsetWidth;
@@ -755,12 +755,31 @@ class CesiumMap extends VcsMap {
     const aspectRatio = width / height;
     const fovy = Math.atan(Math.tan(fov * 0.5) / aspectRatio) * 2.0;
     const visibleMeters = 2 * distance * Math.tan(fovy / 2);
-    const relativeCircumference = Math.cos(Math.abs(CesiumMath.toRadians(wgs84Coordinate[1])));
+    const relativeCircumference = Math.cos(Math.abs(latitude));
     const visibleMapUnits = visibleMeters / relativeCircumference;
 
     return visibleMapUnits / height;
   }
 
+  /**
+   * @inheritDoc
+   * @param {import("ol/coordinate").Coordinate} coordinate - in mercator
+   * @returns {number}
+   */
+  getCurrentResolution(coordinate) {
+    const wgs84Coordinate = Projection.mercatorToWgs84(coordinate);
+    const cartesian = Cartesian3.fromDegrees(wgs84Coordinate[0], wgs84Coordinate[1], wgs84Coordinate[2]);
+    return this._getCurrentResolutionFromCartesianLatitude(cartesian, CesiumMath.toRadians(wgs84Coordinate[1]));
+  }
+
+  /**
+   * @param {import("@vcmap/cesium").Cartesian3} cartesian
+   * @returns {number}
+   */
+  getCurrentResolutionFromCartesian(cartesian) {
+    return this._getCurrentResolutionFromCartesianLatitude(cartesian, Cartographic.fromCartesian(cartesian).latitude);
+  }
+
   /**
    * @param {boolean} bool
    * @inheritDoc