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

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/baseOLMap.js

@@ -60,6 +60,23 @@ class BaseOLMap extends VcsMap {
     this._olListeners = [];
   }
 
+  /**
+   * @type {number}
+   * @inheritDoc
+   */
+  get splitPosition() {
+    return super.splitPosition;
+  }
+
+  /**
+   * @param {number} position
+   * @inheritDoc
+   */
+  set splitPosition(position) {
+    super.splitPosition = position;
+    this.requestRender();
+  }
+
   /**
    * @returns {import("ol/Map").default}
    * @readonly

package/src/map/cesiumMap.js

@@ -27,6 +27,7 @@ import {
   KeyboardEventModifier,
   ScreenSpaceEventType,
   Cesium3DTileset,
+  Cartographic,
 } from '@vcmap/cesium';
 
 import { check, checkMaybe } from '@vcsuite/check';
@@ -350,6 +351,25 @@ class CesiumMap extends VcsMap {
     this._lastEventFrameNumber = null;
   }
 
+  /**
+   * @type {number}
+   * @inheritDoc
+   */
+  get splitPosition() {
+    return super.splitPosition;
+  }
+
+  /**
+   * @param {number} position
+   * @inheritDoc
+   */
+  set splitPosition(position) {
+    super.splitPosition = position;
+    if (this._cesiumWidget) {
+      this._cesiumWidget.scene.splitPosition = position;
+    }
+  }
+
   /**
    * @returns {import("@vcmap/cesium").TerrainProvider}
    * @api
@@ -524,7 +544,7 @@ class CesiumMap extends VcsMap {
       this._cesiumWidget.scene.globe.depthTestAgainstTerrain = true;
       this._cesiumWidget.scene.highDynamicRange = false;
       // this._cesiumWidget.scene.logarithmicDepthBuffer = false; // TODO observe this
-      this._cesiumWidget.scene.splitPosition = 0.5;
+      this._cesiumWidget.scene.splitPosition = this.splitPosition;
 
       this._cesiumWidget.scene.globe.enableLighting = this.enableLightning;
 
@@ -739,15 +759,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 +774,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

package/src/map/vcsMap.js

@@ -153,12 +153,10 @@ class VcsMap extends VcsObject {
      */
     this.pointerInteractionEvent = new VcsEvent();
     /**
-     * If present, the split screen to use on this map. Is set by the mapCollection
-     * @type {import("@vcmap/core").SplitScreen|null}
-     * @api
+     * The split position to use on this map. Is set by the mapCollection
+     * @type {number}
      */
-    this.splitScreen = null;
-
+    this._splitPosition = 0.5;
     /**
      * @type {VcsEvent<VcsMapRenderEvent>}
      * @private
@@ -229,6 +227,26 @@ class VcsMap extends VcsObject {
     this._setLayerCollectionListeners();
   }
 
+  /**
+   * @type {number}
+   */
+  get splitPosition() {
+    return this._splitPosition;
+  }
+
+  /**
+   * The splitPosition should always be aligned with the mapCollection's splitPosition.
+   * Use mapCollection to change splitPosition.
+   * @param {number} position
+   */
+  set splitPosition(position) {
+    check(position, Number);
+    if (position < 0 || position > 1) {
+      throw new Error('Position must be between 0 and 1');
+    }
+    this._splitPosition = position;
+  }
+
   /**
    * An event raised on the maps post render
    * @type {VcsEvent<VcsMapRenderEvent>}