@vcmap/core 5.0.0-rc.26 → 5.0.0-rc.27

package/index.d.ts

@@ -2,18 +2,6 @@ import olFeature from 'ol/Feature';
 import Geometry from 'ol/geom/Geometry';
 import Style from 'ol/style/Style';
 
-export interface AppBackedCategoryOptions extends CategoryOptions {
-    collectionName: string;
-}
-
-export class AppBackedCategory extends Category<VcsObject> {
-    constructor(options: AppBackedCategoryOptions);
-    protected _deserializeItem(config: VcsObjectOptions): Promise<VcsObject>;
-    setApp(app: VcsApp): void;
-    serializeForContext(contextId: string): null;
-    toJSON(): AppBackedCategoryOptions;
-}
-
 /**
  */
 export interface CategoryOptions extends VcsObjectOptions {
@@ -6348,6 +6336,10 @@ export interface ArcStyleOptions extends ArrowStyleOptions {
      * number of segments to interpolate the arc by
     */
     numberOfSegments?: number;
+    /**
+     * offset in m(mercator) from the arc end and arc start to the start/end points Is only rendered if offset * 2 < distance between start and endpoint
+    */
+    offset?: number;
 }
 
 /**
@@ -6377,6 +6369,7 @@ export const featureArcStruct: unique symbol;
 export class ArcStyle extends ArrowStyle {
     constructor(options?: ArcStyleOptions);
     numberOfSegments: any;
+    offset: any;
     arcFactor: any;
     primitiveOptions: VectorPropertiesPrimitiveOptions;
     end: ArrowEnd;
@@ -8631,6 +8624,7 @@ export interface OverrideCollectionInterface<T extends any> {
     shadowMap: Map<string, object[]>;
     override: (item: T) => T;
     parseItems: (items: object[], contextId: string) => Promise<void>;
+    getSerializedByKey: (key: string) => object;
     removeContext: (contextId: string) => Promise<void>;
     serializeContext: (contextId: string) => object[];
 }
@@ -8640,6 +8634,7 @@ export class OverrideCollection<T extends any> extends Collection<T> implements
     shadowMap: Map<string, object[]>;
     override: (item: T) => T;
     parseItems: (items: object[], contextId: string) => Promise<void>;
+    getSerializedByKey: (key: string) => object;
     removeContext: (contextId: string) => Promise<void>;
     serializeContext: (contextId: string) => object[];
 }
@@ -8649,6 +8644,7 @@ export class OverrideLayerCollection extends LayerCollection implements Override
     shadowMap: Map<string, object[]>;
     override: (item: Layer) => Layer;
     parseItems: (items: object[], contextId: string) => Promise<void>;
+    getSerializedByKey: (key: string) => object;
     removeContext: (contextId: string) => Promise<void>;
     serializeContext: (contextId: string) => object[];
 }
@@ -8658,6 +8654,7 @@ export class OverrideMapCollection extends MapCollection implements OverrideColl
     shadowMap: Map<string, object[]>;
     override: (item: VcsMap) => VcsMap;
     parseItems: (items: object[], contextId: string) => Promise<void>;
+    getSerializedByKey: (key: string) => object;
     removeContext: (contextId: string) => Promise<void>;
     serializeContext: (contextId: string) => object[];
 }

package/index.js

@@ -7,7 +7,6 @@ import './src/cesium/cesium3DTileFeature.js';
 import './src/cesium/cesiumVcsCameraPrimitive.js';
 import './src/cesium/entity.js';
 
-export { default as AppBackedCategory } from './src/category/appBackedCategory.js';
 export { default as Category } from './src/category/category.js';
 export { default as CategoryCollection } from './src/category/categoryCollection.js';
 export { layerClassRegistry, tileProviderClassRegistry, featureProviderClassRegistry, mapClassRegistry, styleClassRegistry, categoryClassRegistry, getObjectFromClassRegistry, default as ClassRegistry } from './src/classRegistry.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/core",
-  "version": "5.0.0-rc.26",
+  "version": "5.0.0-rc.27",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -50,6 +50,7 @@
     "mocha-junit-reporter": "^2.0.2",
     "nock": "^13.2.4",
     "node-fetch": "^3.2.0",
+    "resize-observer-polyfill": "1.5.1",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.6.0",
     "tui-jsdoc-template": "^1.2.2",
@@ -57,7 +58,7 @@
   },
   "peerDependencies": {
     "@vcmap-cesium/engine": "~1.1.2",
-    "ol": "~7.1.0"
+    "ol": "~7.2.2"
   },
   "eslintConfig": {
     "extends": [
@@ -80,7 +81,6 @@
     "proj4": "^2.7.5",
     "rbush": ">=3.0.1",
     "rbush-knn": "^3.0.1",
-    "underscore.template": "^0.1.7",
     "uuid": "^8.3.2"
   }
 }

package/src/category/categoryCollection.js

@@ -1,6 +1,5 @@
 import { getLogger as getLoggerByName } from '@vcsuite/logger';
 import Category from './category.js';
-import './appBackedCategory.js';
 import IndexedCollection from '../util/indexedCollection.js';
 import { getObjectFromClassRegistry } from '../classRegistry.js';
 

package/src/style/arcStyle.js

@@ -11,6 +11,7 @@ import ArrowStyle from './arrowStyle.js';
  * @typedef {ArrowStyleOptions} ArcStyleOptions
  * @property {number} [arcFactor=0.15] - factor to calculate the 'height' of an arc, based on the distance from start to end
  * @property {number} [numberOfSegments=64] - number of segments to interpolate the arc by
+ * @property {number} [offset=0] - offset in m(mercator) from the arc end and arc start to the start/end points Is only rendered if offset * 2 < distance between start and endpoint
  */
 
 /**
@@ -33,17 +34,6 @@ export const featureArcStruct = Symbol('FeatureArcStruct');
  */
 const featureArcStyleId = Symbol('ArcStyleId');
 
-/**
- * @param {import("ol/coordinate").Coordinate} p1
- * @param {import("ol/coordinate").Coordinate} p2
- * @param {number} factor
- * @returns {number}
- */
-function determineArcHeight(p1, p2, factor) {
-  const distance = cartesian2DDistance(p1, p2);
-  return distance * factor;
-}
-
 /**
  * Gets the radius of the circle covering p1, p2, p3. see https://math.stackexchange.com/a/1460096
  * @param {import("ol/coordinate").Coordinate} p1
@@ -117,26 +107,29 @@ function determineQuadrantOffset(center, coordinate, angle) {
  * @param {import("ol/coordinate").Coordinate} center
  * @param {number} radius
  * @param {number} numberOfSegments
+ * @param {number} offset
  * @returns {Array<import("ol/coordinate").Coordinate>}
  */
-function interpolateBetweenAngles(p1, p2, center, radius, numberOfSegments) {
+function interpolateBetweenAngles(p1, p2, center, radius, numberOfSegments, offset) {
   const zeroVector = Cartesian2.UNIT_X;
   const p1V = new Cartesian2(p1[0] - center[0], p1[1] - center[1]);
   const p2V = new Cartesian2(p2[0] - center[0], p2[1] - center[1]);
   let startAngle = Cartesian2.angleBetween(zeroVector, p1V);
   startAngle = determineQuadrantOffset(center, p1, startAngle);
-  const distance = Cartesian2.angleBetween(p1V, p2V);
+  let distance = Cartesian2.angleBetween(p1V, p2V);
   const coordinates = new Array(numberOfSegments);
+  const offsetAngle = offset / radius;
+  startAngle += offsetAngle;
+  distance -= offsetAngle * 2;
 
-  for (let i = 0; i < numberOfSegments; ++i) {
-    const angle = startAngle + (modulo(i, numberOfSegments) * distance) / numberOfSegments;
+  for (let i = 0; i <= numberOfSegments; ++i) {
+    const angle = startAngle + (modulo(i, numberOfSegments + 1) * distance) / numberOfSegments;
     coordinates[i] = [
       center[0] + radius * Math.cos(angle),
       center[1] + radius * Math.sin(angle),
       0,
     ];
   }
-  coordinates.push([p2[0], p2[1], 0]);
   return coordinates;
 }
 
@@ -146,19 +139,38 @@ function interpolateBetweenAngles(p1, p2, center, radius, numberOfSegments) {
  * @param {number} arcHeight
  * @param {number} numberOfSegments
  * @param {number} arcFactor
+ * @param {number} offset
  * @returns {Array<import("ol/coordinate").Coordinate>}
  */
-function getArcCoordinates(p1, p2, arcHeight, numberOfSegments, arcFactor) {
+function getArcCoordinates(p1, p2, arcHeight, numberOfSegments, arcFactor, offset) {
   const midPoint = getMidPoint(p1, p2);
   midPoint[2] += (arcHeight / 2);
-  const distance = cartesian2DDistance(p1, p2) / numberOfSegments;
+  const fullDistance = cartesian2DDistance(p1, p2);
+
+  const p1Cartesian = new Cartesian3(p1[0], p1[1], p1[2] ?? 0);
+  const midPointCartesian = new Cartesian3(midPoint[0], midPoint[1], midPoint[2] ?? 0);
+  const p2Cartesian = new Cartesian3(p2[0], p2[1], p2[2] ?? 0);
+  let points;
+  if (offset > 0) {
+    const distanceP1Midpoint = Cartesian3.distance(p1Cartesian, midPointCartesian);
+    const offsetNumber = (1 / distanceP1Midpoint) * offset;
+
+    const arcHeightCorrection = arcHeight / 4;
+    const offsetHeightCorrection =
+      (offsetNumber > 0.5 ? Math.abs(1 - offsetNumber) : offsetNumber) * arcHeightCorrection;
+    const newP1 = Cartesian3.lerp(p1Cartesian, midPointCartesian, offsetNumber, new Cartesian3());
+    newP1.z += offsetHeightCorrection;
+    const newP2 = Cartesian3.lerp(p2Cartesian, midPointCartesian, offsetNumber, new Cartesian3());
+    newP2.z += offsetHeightCorrection;
+    points = [newP1, midPointCartesian, newP2];
+  } else {
+    points = [p1Cartesian, midPointCartesian, p2Cartesian];
+  }
+
+  const distance = (fullDistance - offset * 2) / 64;
   const spline = new CatmullRomSpline({
     times: [0, 0.5, 1],
-    points: [
-      new Cartesian3(p1[0], p1[1], p1[2] ?? 0),
-      new Cartesian3(midPoint[0], midPoint[1], midPoint[2] ?? 0),
-      new Cartesian3(p2[0], p2[1], p2[2] ?? 0),
-    ],
+    points,
     firstTangent: new Cartesian3(0, 0, arcFactor * distance),
     lastTangent: new Cartesian3(0, 0, -arcFactor * distance),
   });
@@ -177,8 +189,9 @@ function getArcCoordinates(p1, p2, arcHeight, numberOfSegments, arcFactor) {
  * @param {number} arcFactor
  * @param {import("ol").Feature} feature
  * @param {number} numberOfSegments
+ * @param {number} offset
  */
-function createFeatureArc(arcFactor, feature, numberOfSegments) {
+function createFeatureArc(arcFactor, feature, numberOfSegments, offset) {
   if (feature[featureArcStruct]) {
     feature[featureArcStruct].destroy();
   }
@@ -187,20 +200,27 @@ function createFeatureArc(arcFactor, feature, numberOfSegments) {
   const destroy = () => {
     unByKey(listeners);
   };
-  listeners.push(feature.on('change:geometry', () => { createFeatureArc(arcFactor, feature, numberOfSegments); }));
+  listeners.push(feature.on('change:geometry', () => { createFeatureArc(arcFactor, feature, numberOfSegments, offset); }));
 
   if (geometry instanceof LineString) {
-    listeners.push(geometry.on('change', () => { createFeatureArc(arcFactor, feature, numberOfSegments); }));
+    listeners.push(geometry.on('change', () => { createFeatureArc(arcFactor, feature, numberOfSegments, offset); }));
     const p1 = geometry.getFirstCoordinate();
     const p2 = geometry.getLastCoordinate();
-    const arcHeight = determineArcHeight(p1, p2, arcFactor);
+    const distance = cartesian2DDistance(p1, p2);
+    const arcHeight = distance * arcFactor;
+    // check offset validity
+    let validOffset = offset;
+    if ((offset * 2) > distance) {
+      validOffset = 0;
+    }
     const midPoint = getMidPointOnArc(p1, p2, arcHeight);
     const { center, radius } = determineCircle(p1, p2, midPoint);
 
-    const coordinates = interpolateBetweenAngles(p1, p2, center, radius, numberOfSegments);
+    const coordinates = interpolateBetweenAngles(p1, p2, center, radius, numberOfSegments, validOffset);
+    const c = getArcCoordinates(p1, p2, arcHeight, numberOfSegments, arcFactor, validOffset);
     feature[featureArcStruct] = {
       geometry: new LineString(coordinates),
-      coordinates: getArcCoordinates(p1, p2, arcHeight, numberOfSegments, arcFactor),
+      coordinates: c,
       destroy,
     };
   } else {
@@ -241,6 +261,11 @@ class ArcStyle extends ArrowStyle {
      * @private
      */
     this._numberOfSegments = parseInteger(options.numberOfSegments, 64);
+    /**
+     * @type {number}
+     * @private
+     */
+    this._offset = parseNumber(options.offset, 0);
 
     this.setGeometry(this._getFeatureArcGeometry.bind(this));
   }
@@ -264,6 +289,25 @@ class ArcStyle extends ArrowStyle {
     }
   }
 
+  /**
+   * An offset from the arc end/start to the starting point / end point
+   * @type {number}
+   */
+  get offset() {
+    return this._offset;
+  }
+
+  /**
+   * @param {number} value
+   */
+  set offset(value) {
+    check(value, Number);
+    if (value !== this._offset && value > 0) {
+      this._offset = value;
+      this._revisionId = uuidv4();
+    }
+  }
+
   /**
    * The factor with which to calculate the 'height' of an arc using the distance from start to end of the LineString.
    * @type {number}
@@ -288,7 +332,7 @@ class ArcStyle extends ArrowStyle {
    */
   _getFeatureArcGeometry(feature) {
     if (!feature[featureArcStruct] || feature[featureArcStyleId] !== this._revisionId) {
-      createFeatureArc(this._arcFactor, feature, this._numberOfSegments);
+      createFeatureArc(this._arcFactor, feature, this._numberOfSegments, this._offset);
       feature[featureArcStyleId] = this._revisionId;
     }
     return feature[featureArcStruct].geometry;

package/src/util/overrideCollection.js

@@ -23,6 +23,7 @@ function getLogger() {
  * @property {function(T):T|null} override - returns the overriden item or null if the item could not be inserted (this would be the result of a race condition)
  * @property {Map<string, Array<Object>>} shadowMap
  * @property {function(Array<Object>, string):Promise<void>} parseItems
+ * @property {function(string):Object} getSerializedByKey
  * @property {function(string):Promise<void>} removeContext
  * @property {function(string):Array<Object>} serializeContext
  * @template {*} T
@@ -133,6 +134,18 @@ function makeOverrideCollection(
     }
   };
 
+  /**
+   * @param {string} key
+   * @returns {Object|undefined}
+   */
+  overrideCollection.getSerializedByKey = function getSerializedByKey(key) {
+    const item = overrideCollection.getByKey(key);
+    if (item) {
+      return serialize(item);
+    }
+    return undefined;
+  };
+
   overrideCollection.removed.addEventListener(async (item) => {
     const itemId = item[overrideCollection.uniqueKey];
 

package/src/category/appBackedCategory.js

@@ -1,89 +0,0 @@
-import Category from './category.js';
-import { categoryClassRegistry } from '../classRegistry.js';
-import Viewpoint from '../util/viewpoint.js';
-import ObliqueCollection from '../oblique/obliqueCollection.js';
-import { deserializeLayer, deserializeMap } from '../vcsAppContextHelpers.js';
-
-/**
- * @typedef {CategoryOptions} AppBackedCategoryOptions
- * @property {string} collectionName
- */
-
-/**
- * @type {Object<string, string>}
- */
-const collectionNameMap = {
-  layers: 'layerClassRegistry',
-  styles: 'styleClassRegistry',
-  maps: 'mapClassRegistry',
-  categories: 'categoryClassRegistry',
-};
-
-/**
- * @class
- * @extends {Category<import("@vcmap/core").VcsObject>}
- */
-class AppBackedCategory extends Category {
-  static get className() { return 'AppBackedCategory'; }
-
-  /**
-   * @param {AppBackedCategoryOptions} options
-   */
-  constructor(options) {
-    options.classRegistryName = collectionNameMap[options.collectionName];
-    super(options);
-    this._collectionName = options.collectionName;
-  }
-
-  /**
-   * @param {VcsObjectOptions} config
-   * @returns {Promise<import("@vcmap/core").VcsObject>}
-   * @protected
-   */
-  async _deserializeItem(config) {
-    if (!this._app) {
-      throw new Error('Cannot deserialize item before setting the vcApp');
-    }
-
-    if (this._collectionName === 'viewpoints') {
-      return new Viewpoint(config);
-    } else if (this._collectionName === 'obliqueCollections') {
-      return new ObliqueCollection(config);
-    } else if (this._collectionName === 'layers') {
-      return deserializeLayer(this._app, config);
-    } else if (this._collectionName === 'maps') {
-      return deserializeMap(this._app, config);
-    }
-    return super._deserializeItem(config);
-  }
-
-  /**
-   * @param {import("@vcmap/core").VcsApp} app
-   */
-  setApp(app) {
-    super.setApp(app);
-    this.setCollection(this._app[this._collectionName]);
-  }
-
-  /**
-   * @param {string} contextId
-   * @returns {null}
-   */
-  // eslint-disable-next-line class-methods-use-this,no-unused-vars
-  serializeForContext(contextId) {
-    return null;
-  }
-
-  /**
-   * @returns {AppBackedCategoryOptions}
-   */
-  toJSON() {
-    const config = /** @type {AppBackedCategoryOptions} */ (super.toJSON());
-    delete config.classRegistryName;
-    config.collectionName = this._collectionName;
-    return config;
-  }
-}
-
-export default AppBackedCategory;
-categoryClassRegistry.registerClass(AppBackedCategory.className, AppBackedCategory);