@vcmap/core 5.0.0-rc.0

package/src/vcs/vcm/util/featureconverter/polygonToCesium.js

@@ -0,0 +1,229 @@
+import {
+  Cartesian3,
+  PolygonGeometry,
+  PerInstanceColorAppearance,
+  PolygonOutlineGeometry,
+  GroundPolylineGeometry,
+  PolygonHierarchy,
+  PolylineGeometry,
+} from '@vcmap/cesium';
+import GeometryType from 'ol/geom/GeometryType.js';
+import { parseNumber } from '@vcsuite/parsers';
+import { addPrimitivesToContext } from './featureconverterHelper.js';
+import Projection from '../projection.js';
+import { getFlatCoordinatesFromSimpleGeometry } from '../geometryHelpers.js';
+
+/**
+ * @param {Object} options
+ * @param {number} height
+ * @param {boolean} perPositionHeight
+ * @param {number=} extrudedHeight
+ * @returns {Array<import("@vcmap/cesium").PolygonGeometry>}
+ * @private
+ */
+export function createSolidGeometries(options, height, perPositionHeight, extrudedHeight) {
+  const polygonOptions = {
+    ...options,
+    perPositionHeight,
+    extrudedHeight,
+  };
+  if (!perPositionHeight) {
+    polygonOptions.height = height;
+  }
+  return [new PolygonGeometry(polygonOptions)];
+}
+
+/**
+ * @param {Object} options
+ * @param {number} height
+ * @param {boolean} perPositionHeight
+ * @param {number=} extrudedHeight
+ * @returns {Array<import("@vcmap/cesium").PolygonOutlineGeometry>}
+ * @private
+ */
+export function createOutlineGeometries(options, height, perPositionHeight, extrudedHeight) {
+  return [new PolygonOutlineGeometry({
+    ...options,
+    height: perPositionHeight ? undefined : height,
+    extrudedHeight,
+    perPositionHeight,
+    vertexFormat: PerInstanceColorAppearance.FLAT_VERTEX_FORMAT,
+  })];
+}
+
+/**
+ * @param {Object} options
+ * @param {number} height
+ * @param {boolean} perPositionHeight
+ * @returns {Array<import("@vcmap/cesium").PolygonGeometry>}
+ * @private
+ */
+export function createFillGeometries(options, height, perPositionHeight) {
+  return createSolidGeometries(options, height, perPositionHeight, undefined);
+}
+
+/**
+ * @param {Object} options
+ * @param {import("ol/style/Style").default} style
+ * @returns {Array<Object>}
+ * @private
+ */
+export function getLineGeometryOptions(options, style) {
+  const width = parseNumber(style.getStroke().getWidth(), 1.0);
+  const geometryOptions = [];
+  geometryOptions.push({
+    positions: options.polygonHierarchy.positions,
+    width,
+  });
+  options.polygonHierarchy.holes.forEach((polygonHierarchy) => {
+    geometryOptions.push({
+      positions: polygonHierarchy.positions,
+      width,
+    });
+  });
+  return geometryOptions;
+}
+
+/**
+ * @param {Object} options
+ * @param {import("ol/style/Style").default} style
+ * @returns {Array<GroundPolylineGeometry>}
+ * @private
+ */
+export function createGroundLineGeometries(options, style) {
+  return getLineGeometryOptions(options, style).map((option) => {
+    return new GroundPolylineGeometry(option);
+  });
+}
+
+/**
+ * @param {Object} options
+ * @param {import("ol/style/Style").default} style
+ * @returns {Array<PolylineGeometry>}
+ * @private
+ */
+export function createLineGeometries(options, style) {
+  return getLineGeometryOptions(options, style).map((option) => {
+    return new PolylineGeometry(option);
+  });
+}
+
+
+/**
+ * @param {import("ol/geom/Polygon").default} geometry
+ * @param {number} positionHeightAdjustment
+ * @returns {Object}
+ * @private
+ */
+export function getGeometryOptions(geometry, positionHeightAdjustment) {
+  let hieraryPositions;
+  const holes = [];
+  const rings = geometry.getLinearRings();
+  for (let i = 0; i < rings.length; i++) {
+    const coords = rings[i].getCoordinates();
+    const positions = coords.map((coord) => {
+      const wgs84Coords = Projection.mercatorToWgs84(coord);
+      if (wgs84Coords[2] != null) {
+        wgs84Coords[2] += positionHeightAdjustment;
+      }
+      return Cartesian3.fromDegrees(wgs84Coords[0], wgs84Coords[1], wgs84Coords[2]);
+    });
+    // make sure the last and first vertex is identical.
+    if (!Cartesian3.equals(positions[0], positions[positions.length - 1])) {
+      positions.push(positions[0]);
+    }
+    if (i === 0) {
+      hieraryPositions = positions;
+    } else {
+      holes.push(new PolygonHierarchy(positions));
+    }
+  }
+  return {
+    polygonHierarchy: new PolygonHierarchy(hieraryPositions, holes),
+  };
+}
+
+/**
+ * @param {Array<import("ol/geom/Polygon").default>} geometries
+ * @returns {Array<import("ol/coordinate").Coordinate>}
+ * @private
+ */
+export function getCoordinates(geometries) {
+  const coordinates = [];
+  geometries.forEach((polygon) => {
+    coordinates.push(...getFlatCoordinatesFromSimpleGeometry(polygon));
+  });
+  return coordinates;
+}
+
+/**
+ * @type {VectorGeometryFactoryType|null}
+ */
+let geometryFactory = null;
+
+/**
+ * @returns {VectorGeometryFactoryType}
+ */
+function getGeometryFactory() {
+  if (!geometryFactory) {
+    geometryFactory = {
+      getCoordinates,
+      getGeometryOptions,
+      createSolidGeometries,
+      createOutlineGeometries,
+      createFillGeometries,
+      createGroundLineGeometries,
+      createLineGeometries,
+    };
+  }
+  return geometryFactory;
+}
+
+/**
+ * TODO maybe add validation Functions to Openlayers
+ * validates if a polygon is renderable
+ * @param {import("ol/geom/Polygon").default} polygon
+ * @returns {boolean}
+ */
+export function validatePolygon(polygon) {
+  if (polygon.getType() !== GeometryType.POLYGON) {
+    return false;
+  }
+  const flatCoordinates = polygon.getFlatCoordinates();
+  const ends = polygon.getEnds();
+  const stride = polygon.getStride();
+  const valid = ends.every((end, index) => {
+    const previous = index ? ends[index - 1] : 0;
+    const currentRingSize = end - previous;
+    return currentRingSize >= stride * 3;
+  });
+  if (!valid) {
+    return false;
+  }
+  // should have at least three coordinates for each linearRing and every value should be a number
+  const minimumValues = stride * 3 * polygon.getLinearRingCount();
+  if (flatCoordinates && flatCoordinates.length >= minimumValues && polygon.getLinearRingCount()) {
+    return flatCoordinates.every(value => Number.isFinite(value));
+  }
+  return false;
+}
+
+/**
+ * converts a polygon to a a cesium primitive, with optional labels
+ * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
+ * @param {import("ol/style/Style").default} style
+ * @param {Array<import("ol/geom/Polygon").default>} geometries
+ * @param {import("@vcmap/core").VectorProperties} vectorProperties
+ * @param {import("@vcmap/cesium").Scene} scene
+ * @param {import("@vcmap/core").VectorContext|import("@vcmap/core").ClusterContext} context
+ */
+export default function polygonToCesium(feature, style, geometries, vectorProperties, scene, context) {
+  if (!style.getFill() && !style.getStroke()) {
+    return;
+  }
+  const polygonGeometryFactory = getGeometryFactory();
+  const validGeometries = geometries.filter(polygon => validatePolygon(polygon));
+  addPrimitivesToContext(
+    feature, style, validGeometries, vectorProperties, scene, polygonGeometryFactory, context,
+  );
+}

package/src/vcs/vcm/util/geometryHelpers.js

@@ -0,0 +1,172 @@
+import { offset } from 'ol/sphere.js';
+import Circle from 'ol/geom/Circle.js';
+import Point from 'ol/geom/Point.js';
+import LineString from 'ol/geom/LineString.js';
+import Polygon, { fromCircle } from 'ol/geom/Polygon.js';
+import MultiPoint from 'ol/geom/MultiPoint.js';
+import MultiLineString from 'ol/geom/MultiLineString.js';
+import MultiPolygon from 'ol/geom/MultiPolygon.js';
+import GeometryCollection from 'ol/geom/GeometryCollection.js';
+import Projection from './projection.js';
+
+/**
+ * @param {import("ol/geom/SimpleGeometry").default} geometry
+ * @returns {Array<import("ol/coordinate").Coordinate>}
+ */
+export function getFlatCoordinatesFromSimpleGeometry(geometry) {
+  const stride = geometry.getStride();
+  const flatCoordinates = geometry.getFlatCoordinates();
+  if (flatCoordinates.length) {
+    const numberOfCoordinates = Math.floor(flatCoordinates.length / stride);
+    const coordinates = new Array(numberOfCoordinates);
+    for (let i = 0; i < numberOfCoordinates; i++) {
+      const flatIndex = i * stride;
+      const coord = new Array(stride);
+      for (let j = 0; j < stride; j++) {
+        coord[j] = flatCoordinates[flatIndex + j];
+      }
+      coordinates[i] = coord;
+    }
+    return coordinates;
+  }
+  return [];
+}
+
+/**
+ * @param {import("ol/geom/Geometry").default} geometry
+ * @param {Array=} inputCoordinates
+ * @returns {Array.<import("ol/coordinate").Coordinate>}
+ */
+export function getFlatCoordinatesFromGeometry(geometry, inputCoordinates) {
+  const coordinates = inputCoordinates || geometry.getCoordinates();
+  let flattenCoordinates = null;
+  if (geometry instanceof Point) {
+    flattenCoordinates = [coordinates];
+  } else if (geometry instanceof LineString) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof Polygon) {
+    flattenCoordinates = coordinates.reduce((current, next) => current.concat(next));
+  } else if (geometry instanceof MultiPoint) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof MultiLineString) {
+    flattenCoordinates = coordinates.reduce((current, next) => current.concat(next));
+  } else if (geometry instanceof MultiPolygon) {
+    flattenCoordinates = coordinates
+      .reduce((current, next) => current.concat(next))
+      .reduce((current, next) => current.concat(next));
+  } else if (geometry instanceof Circle) {
+    flattenCoordinates = coordinates;
+  } else if (geometry instanceof GeometryCollection) {
+    flattenCoordinates = geometry.getGeometries()
+      .map((g, i) => getFlatCoordinatesFromGeometry(g, coordinates[i]))
+      .reduce((current, next) => current.concat(next));
+  }
+  return flattenCoordinates;
+}
+
+/**
+ * @param {import("ol/coordinate").Coordinate} center
+ * @param {number} radius
+ * @returns {import("ol/geom/Circle").default}
+ */
+export function circleFromCenterRadius(center, radius) {
+  const offsetWGS84 = offset(Projection.mercatorToWgs84(center), radius, Math.PI / 2);
+  const of = Projection.wgs84ToMercator(offsetWGS84);
+  const dx = center[0] - of[0];
+  const dy = center[1] - of[1];
+  const dx2 = dx * dx;
+  const dy2 = dy * dy;
+  const radiusProjected = Math.sqrt(dx2 + dy2);
+  return new Circle(
+    center,
+    radiusProjected,
+    'XYZ',
+  );
+}
+
+/**
+ * @param {import("ol/geom/Geometry").default} geometry
+ * @returns {import("ol/geom/Geometry").default}
+ */
+export function convertGeometryToPolygon(geometry) {
+  if (geometry instanceof Circle) {
+    return fromCircle(geometry);
+  } else if (geometry instanceof Polygon) {
+    geometry.unset('_vcsGeomType');
+  }
+  return geometry;
+}
+
+/**
+ * @param {Array<import("ol/coordinate").Coordinate>} linearRing
+ */
+export function enforceEndingVertex(linearRing) {
+  const [lastX, lastY] = linearRing[linearRing.length - 1];
+  if (!(linearRing[0][0] === lastX && linearRing[0][1] === lastY)) {
+    linearRing.push(linearRing[0].slice());
+  }
+}
+
+/**
+ * @param {Array<import("ol/coordinate").Coordinate>} linearRing
+ */
+export function removeEndingVertex(linearRing) {
+  const [lastX, lastY] = linearRing[linearRing.length - 1];
+  if (linearRing[0][0] === lastX && linearRing[0][1] === lastY) {
+    linearRing.pop();
+  }
+}
+
+/**
+ * @param {import("ol/geom/Geometry").default} geometry
+ */
+export function removeEndingVertexFromGeometry(geometry) {
+  if (geometry instanceof Polygon) {
+    const coordinates = geometry.getCoordinates();
+    coordinates.forEach((ring) => {
+      removeEndingVertex(ring);
+    });
+    geometry.setCoordinates(coordinates);
+  } else if (geometry instanceof MultiPolygon) {
+    const coordinates = geometry.getCoordinates();
+    coordinates.forEach((poly) => {
+      poly.forEach((ring) => {
+        removeEndingVertex(ring);
+      });
+    });
+    geometry.setCoordinates(coordinates);
+  }
+}
+
+/**
+ * from @mapbox/geojson-area
+ * @param {Array<Array<number>>}ring
+ * @returns {number}
+ */
+function ringArea(ring) {
+  let area = 0;
+  const positions = ring.length;
+
+  for (let i = 0; i <= positions - 2; i++) {
+    const p1 = ring[i];
+    const p2 = ring[i + 1];
+    area += ((p1[0] * p2[1]) - (p1[1] * p2[0]));
+  }
+
+  area /= 2;
+  return area;
+}
+
+/**
+ * enforce a ring to be counter-clockwise
+ * @param {Array<import("ol/coordinate").Coordinate>} ring
+ * @returns {Array<import("ol/coordinate").Coordinate>}
+ */
+export function enforceRightHand(ring) {
+  const area = ringArea(ring);
+  if (area < 0) {
+    ring.reverse();
+  }
+
+  return ring;
+}

package/src/vcs/vcm/util/indexedCollection.js

@@ -0,0 +1,158 @@
+import VcsEvent from '../event/vcsEvent.js';
+import Collection from './collection.js';
+
+/**
+ * A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])
+ * @class
+ * @export
+ * @template {*} T
+ * @extends {Collection<T>}
+ * @api
+ */
+class IndexedCollection extends Collection {
+  /**
+   * Creates a Collection from an iterable, such as an Array.
+   * @template {*} T
+   * @param {Iterable<T>} iterable
+   * @param {(string|symbol|boolean)=} [uniqueKey='name'] - a key to maintain uniquely within the collection. passing false disables uniqueness.
+   * @returns {IndexedCollection<T>}
+   * @override
+   * @api
+   */
+  static from(iterable, uniqueKey) {
+    const collection = /** @type {IndexedCollection<T>} */ (new IndexedCollection(uniqueKey));
+    if (iterable) {
+      // eslint-disable-next-line no-restricted-syntax
+      for (const i of iterable) {
+        collection.add(i);
+      }
+    }
+    return collection;
+  }
+
+  /**
+   * @param {(string|symbol|boolean)=} [uniqueKey='name'] - a key to maintain uniquely within the collection. passing false disables uniqueness.
+   */
+  constructor(uniqueKey) {
+    super(uniqueKey);
+
+    /**
+     * Event raised if an item is relocated within the collection. Is passed the moved item.
+     * @type {VcsEvent<T>}
+     * @api
+     */
+    this.moved = new VcsEvent();
+  }
+
+  /**
+   * Returns an item at index.
+   * @param {number} index
+   * @returns {T}
+   * @api
+   */
+  get(index) {
+    return this._array[index];
+  }
+
+  /**
+   * Adds an item to the collection. Can optionally be passed an index at which to insert the item.
+   * @param {T} item - the item to be inserted
+   * @param {number=} index - an optional index at which to insert the item. clipped to the last entry
+   * @returns {number|null} the index at which the item was inserted
+   * @api
+   */
+  add(item, index) {
+    if (this._checkUniqueness(item)) {
+      let actualIndex = this._array.length;
+      if (index != null && index < this._array.length) {
+        actualIndex = index >= 0 ? index : 0;
+        this._array.splice(actualIndex, 0, item);
+      } else {
+        this._array.push(item);
+      }
+      this.added.raiseEvent(item);
+      return actualIndex;
+    }
+    return null;
+  }
+
+  /**
+   * @param {T} item
+   * @param {number} itemIndex
+   * @param {number} targetIndex
+   * @returns {number}
+   * @protected
+   */
+  _move(item, itemIndex, targetIndex) {
+    let target = targetIndex;
+    target = target >= 0 ? target : 0;
+    target = target < this._array.length ? target : this._array.length - 1;
+    this._array.splice(itemIndex, 1);
+    this._array.splice(target, 0, item);
+    this.moved.raiseEvent(item);
+    return target;
+  }
+
+  /**
+   * Lowers an item within the array
+   * @param {T} item
+   * @param {number} [steps=1] - an integer number to lower by
+   * @returns {number|null} the new index of the item
+   * @api
+   */
+  lower(item, steps = 1) {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, index - Math.ceil(steps));
+    }
+    return null;
+  }
+
+  /**
+   * Raises an item within the array
+   * @param {T} item
+   * @param {number} [steps=1] - an integer number to lower by
+   * @returns {number|null} the new index of the item
+   * @api
+   */
+  raise(item, steps = 1) {
+    const index = this._array.indexOf(item);
+    if (index > -1) {
+      return this._move(item, index, index + Math.ceil(steps));
+    }
+    return null;
+  }
+
+  /**
+   * Returns the index of an item or -1 if it is not part of this collection
+   * @param {T} item
+   * @returns {number}
+   * @api
+   */
+  indexOf(item) {
+    return this._array.indexOf(item);
+  }
+
+  /**
+   * Returns the index of a key. Returns undefined, if there is no uniqueness constraint
+   * @param {*} value
+   * @returns {number}
+   * @api
+   */
+  indexOfKey(value) {
+    if (!this.uniqueKey) {
+      return undefined;
+    }
+    return this._array.findIndex(e => e[this.uniqueKey] === value);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  destroy() {
+    super.destroy();
+    this.moved.destroy();
+  }
+}
+
+export default IndexedCollection;

package/src/vcs/vcm/util/isMobile.js

@@ -0,0 +1,12 @@
+/**
+ * returns true if we are on a mobile device including tablets
+ * @returns {boolean}
+ * @api
+ */
+// eslint-disable-next-line import/prefer-default-export
+export function isMobile() {
+  // @ts-ignore
+  const agent = navigator.userAgent || navigator.vendor || window.opera;
+  return /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(agent) ||
+    /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw-(n|u)|c55\/|capi|ccwa|cdm-|cell|chtm|cldc|cmd-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc-s|devi|dica|dmob|do(c|p)o|ds(12|-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(-|_)|g1 u|g560|gene|gf-5|g-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd-(m|p|t)|hei-|hi(pt|ta)|hp( i|ip)|hs-c|ht(c(-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i-(20|go|ma)|i230|iac( |-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|-[a-w])|libw|lynx|m1-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|-([1-8]|c))|phil|pire|pl(ay|uc)|pn-2|po(ck|rt|se)|prox|psio|pt-g|qa-a|qc(07|12|21|32|60|-[2-7]|i-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h-|oo|p-)|sdk\/|se(c(-|0|1)|47|mc|nd|ri)|sgh-|shar|sie(-|m)|sk-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h-|v-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl-|tdg-|tel(i|m)|tim-|t-mo|to(pl|sh)|ts(70|m-|m3|m5)|tx-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas-|your|zeto|zte-/i.test(agent.substr(0, 4));
+}