@vcmap/core 5.0.0-rc.3 → 5.0.0-rc.30

package/src/vcs/vcm/layer/cesium/vectorContext.js

@@ -1,167 +0,0 @@
-import { PrimitiveCollection, BillboardCollection, LabelCollection } from '@vcmap/cesium';
-
-/**
- * @typedef {Object} VectorContextFeatureCache
- * @property {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>|undefined} primitives
- * @property {Array<import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Entity>|undefined} billboards
- * @property {Array<import("@vcmap/cesium").Label|import("@vcmap/cesium").Entity>|undefined} labels
- */
-
-/**
- * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
- * @param {import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Label|import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model} primitive
- */
-export function setReferenceForPicking(feature, primitive) {
-  primitive.olFeature = feature;
-}
-
-/**
- * @param {import("@vcmap/cesium").PrimitiveCollection|import("@vcmap/cesium").BillboardCollection|import("@vcmap/cesium").LabelCollection|import("@vcmap/cesium").EntityCollection=} collection
- * @param {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Label|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model>=} array
- */
-export function removeArrayFromCollection(collection, array) {
-  if (array) {
-    array.forEach((primitive) => {
-      collection.remove(primitive);
-    });
-  }
-}
-
-/**
- * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
- * @param {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Label|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model>>} featuresMap
- * @param {import("@vcmap/cesium").PrimitiveCollection|import("@vcmap/cesium").BillboardCollection|import("@vcmap/cesium").LabelCollection|import("@vcmap/cesium").EntityCollection} primitiveCollection
- */
-export function removeFeatureFromMap(feature, featuresMap, primitiveCollection) {
-  removeArrayFromCollection(primitiveCollection, featuresMap.get(feature));
-  featuresMap.delete(feature);
-}
-
-/**
- * @param {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Entity.ConstructorOptions|import("@vcmap/cesium").Model|Object>} primitives
- * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
- * @param {boolean} allowPicking
- * @param {import("@vcmap/cesium").BillboardCollection|import("@vcmap/cesium").LabelCollection|import("@vcmap/cesium").PrimitiveCollection|import("@vcmap/cesium").EntityCollection} primitiveCollection
- * @param {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Billboard|import("@vcmap/cesium").Label|import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Entity|import("@vcmap/cesium").Model>>} featureMap
- */
-export function addPrimitiveToContext(primitives, feature, allowPicking, primitiveCollection, featureMap) {
-  if (primitives.length) {
-    const cesiumPrimitives = primitives.map((primitiveOptions) => {
-      const primitive = primitiveCollection.add(primitiveOptions);
-      if (allowPicking) {
-        setReferenceForPicking(feature, primitive);
-      }
-      return primitive;
-    });
-    if (!featureMap.has(feature)) {
-      featureMap.set(feature, cesiumPrimitives);
-    } else {
-      featureMap.get(feature).push(...cesiumPrimitives);
-    }
-  }
-}
-
-/**
- * @class
- */
-class VectorContext {
-  /**
-   * @param {import("@vcmap/cesium").Scene} scene
-   * @param {import("@vcmap/cesium").PrimitiveCollection} rootCollection
-   */
-  constructor(scene, rootCollection) {
-    /** @type {import("@vcmap/cesium").PrimitiveCollection} */
-    this.primitives = new PrimitiveCollection();
-    /** @type {import("@vcmap/cesium").BillboardCollection} */
-    this.billboards = new BillboardCollection({ scene });
-    /** @type {import("@vcmap/cesium").LabelCollection} */
-    this.labels = new LabelCollection({ scene });
-    /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>>} */
-    this.featureToPrimitiveMap = new Map();
-    /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Billboard>>} */
-    this.featureToBillboardMap = new Map();
-    /** @type {Map<import("ol").Feature<import("ol/geom/Geometry").default>, Array<import("@vcmap/cesium").Label>>} */
-    this.featureToLabelMap = new Map();
-
-    rootCollection.add(this.primitives);
-    rootCollection.add(this.billboards);
-    rootCollection.add(this.labels);
-  }
-
-  /**
-   * @param {Array<import("@vcmap/cesium").Primitive|import("@vcmap/cesium").GroundPrimitive|import("@vcmap/cesium").GroundPolylinePrimitive|import("@vcmap/cesium").ClassificationPrimitive|import("@vcmap/cesium").Model>} primitives
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
-   * @param {boolean=} allowPicking
-   */
-  addPrimitives(primitives, feature, allowPicking) {
-    addPrimitiveToContext(primitives, feature, allowPicking, this.primitives, this.featureToPrimitiveMap);
-  }
-
-  /**
-   * @param {Array<Object>} billboardOptions
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
-   * @param {boolean=} allowPicking
-   */
-  addBillboards(billboardOptions, feature, allowPicking) {
-    addPrimitiveToContext(billboardOptions, feature, allowPicking, this.billboards, this.featureToBillboardMap);
-  }
-
-  /**
-   * @param {Array<Object>} labelOptions
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
-   * @param {boolean=} allowPicking
-   */
-  addLabels(labelOptions, feature, allowPicking) {
-    addPrimitiveToContext(labelOptions, feature, allowPicking, this.labels, this.featureToLabelMap);
-  }
-
-  /**
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>} feature
-   */
-  removeFeature(feature) {
-    removeFeatureFromMap(feature, this.featureToPrimitiveMap, this.primitives);
-    removeFeatureFromMap(feature, this.featureToBillboardMap, this.billboards);
-    removeFeatureFromMap(feature, this.featureToLabelMap, this.labels);
-  }
-
-  /**
-   * Caches the current cesium resources for a feature, removing them from the feature map
-   * @param {import("ol").Feature<import("ol/geom/Geometry").default>}feature
-   * @returns {VectorContextFeatureCache}
-   */
-  createFeatureCache(feature) {
-    /** @type {VectorContextFeatureCache} */
-    const cache = {};
-    cache.primitives = this.featureToPrimitiveMap.get(feature);
-    this.featureToPrimitiveMap.delete(feature);
-    cache.billboards = this.featureToBillboardMap.get(feature);
-    this.featureToBillboardMap.delete(feature);
-    cache.labels = this.featureToLabelMap.get(feature);
-    this.featureToLabelMap.delete(feature);
-    return cache;
-  }
-
-  /**
-   * @param {VectorContextFeatureCache} cache
-   */
-  clearFeatureCache(cache) {
-    removeArrayFromCollection(this.primitives, cache.primitives);
-    removeArrayFromCollection(this.billboards, cache.billboards);
-    removeArrayFromCollection(this.labels, cache.labels);
-  }
-
-  /**
-   * Clears all collections and maps
-   * @api
-   */
-  clear() {
-    this.primitives.removeAll();
-    this.billboards.removeAll();
-    this.labels.removeAll();
-    this.featureToBillboardMap.clear();
-    this.featureToLabelMap.clear();
-    this.featureToPrimitiveMap.clear();
-  }
-}
-
-export default VectorContext;

package/src/vcs/vcm/layer/openlayers/layerOpenlayers.js

@@ -1,79 +0,0 @@
-import { vcsLayerName } from '../layerSymbols.js';
-import LayerImplementation from '../layerImplementation.js';
-
-/**
- * Layer implementation for {@link CesiumMap}.
- * @class
- * @export
- * @extends {LayerImplementation<import("@vcmap/core").Openlayers>}}
- */
-class LayerOpenlayers extends LayerImplementation {
-  static get className() { return 'vcs.vcm.layer.openlayers.LayerOpenlayers'; }
-
-  /**
-   * @param {import("@vcmap/core").Openlayers} map
-   * @param {LayerImplementationOptions} options
-   */
-  constructor(map, options) {
-    super(map, options);
-    /**
-     * @type {import("ol/layer").Layer<import("ol/source/Source").default>|null}
-     */
-    this.olLayer = null;
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   */
-  initialize() {
-    if (!this.initialized) {
-      this.olLayer = this.getOLLayer();
-      this.olLayer[vcsLayerName] = this.name;
-      this.map.addOLLayer(this.olLayer);
-    }
-    return super.initialize();
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {Promise<void>}
-   */
-  async activate() {
-    await super.activate();
-    if (this.active) {
-      this.olLayer.setVisible(true);
-    }
-  }
-
-  /**
-   * @inheritDoc
-   */
-  deactivate() {
-    super.deactivate();
-    if (this.olLayer) {
-      this.olLayer.setVisible(false);
-    }
-  }
-
-  // eslint-disable-next-line jsdoc/require-returns-check
-  /**
-   * returns the ol Layer
-   * @returns {import("ol/layer").Layer<import("ol/source/Source").default>}
-   */
-  // eslint-disable-next-line class-methods-use-this
-  getOLLayer() { throw new Error(); }
-
-  /**
-   * @inheritDoc
-   */
-  destroy() {
-    if (this.olLayer) {
-      this.map.removeOLLayer(this.olLayer);
-    }
-    this.olLayer = null;
-    super.destroy();
-  }
-}
-
-export default LayerOpenlayers;

package/src/vcs/vcm/layer/openlayers/openStreetMapOpenlayers.js

@@ -1,27 +0,0 @@
-import Tile from 'ol/layer/Tile.js';
-import OSM from 'ol/source/OSM.js';
-import RasterLayerOpenlayers from './rasterLayerOpenlayers.js';
-
-/**
- * represents a specific OpenStreetMap layer for openlayers.
- * @class
- * @export
- * @extends {RasterLayerOpenlayers}
- */
-class OpenStreetMapOpenlayers extends RasterLayerOpenlayers {
-  static get className() { return 'vcs.vcm.layer.openlayers.OpenStreetMapOpenlayers'; }
-
-  /**
-   * @returns {import("ol/layer/Tile").default}
-   */
-  getOLLayer() {
-    return new Tile({
-      opacity: this.opacity,
-      source: new OSM({
-        maxZoom: this.maxLevel,
-      }),
-    });
-  }
-}
-
-export default OpenStreetMapOpenlayers;

package/src/vcs/vcm/layer/openlayers/rasterLayerOpenlayers.js

@@ -1,121 +0,0 @@
-import { ImagerySplitDirection } from '@vcmap/cesium';
-import { unByKey } from 'ol/Observable.js';
-import LayerOpenlayers from './layerOpenlayers.js';
-
-/**
- * RasterLayer implementation for {@link Openlayers}
- * @class
- * @extends {LayerOpenlayers}
- * @implements {RasterLayerImplementation}
- * @abstract
- */
-class RasterLayerOpenlayers extends LayerOpenlayers {
-  static get className() { return 'vcs.vcm.layer.openlayers.RasterLayerOpenlayers'; }
-
-  /**
-   * @param {import("@vcmap/core").Openlayers} map
-   * @param {RasterLayerImplementationOptions} options
-   */
-  constructor(map, options) {
-    super(map, options);
-    /** @type {import("@vcmap/cesium").ImagerySplitDirection} */
-    this.splitDirection = options.splitDirection;
-    /** @type {number} */
-    this.minLevel = options.minLevel;
-    /** @type {number} */
-    this.maxLevel = options.maxLevel;
-    /** @type {string} */
-    this.tilingSchema = options.tilingSchema;
-    /** @type {import("@vcmap/core").Extent} */
-    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);
-      });
-  }
-
-  /**
-   * @param {number} opacity
-   */
-  updateOpacity(opacity) {
-    this.opacity = opacity;
-    if (this.initialized) {
-      this.olLayer.setOpacity(this.opacity);
-    }
-  }
-
-  /**
-   * @param {import("@vcmap/cesium").ImagerySplitDirection} splitDirection
-   */
-  updateSplitDirection(splitDirection) {
-    this.splitDirection = splitDirection;
-    if (this.initialized) {
-      if (this.splitDirection === ImagerySplitDirection.NONE && this._splitDirectionRenderListeners) {
-        unByKey(this._splitDirectionRenderListeners);
-        this._splitDirectionRenderListeners = null;
-        this.olLayer.changed();
-      } else if (splitDirection !== ImagerySplitDirection.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) => {
-              event.context.restore();
-            })),
-          );
-        this.olLayer.changed();
-      }
-    }
-  }
-
-  /**
-   * @param {import("ol/render/Event").default} event
-   * @private
-   */
-  _splitPreCompose(event) {
-    if (!this.map.splitScreen) {
-      return;
-    }
-    const { context } = event;
-    const width = context.canvas.width * this.map.splitScreen.position;
-    context.save();
-    context.beginPath();
-
-    if (this.splitDirection === ImagerySplitDirection.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 RasterLayerOpenlayers;

package/src/vcs/vcm/layer/terrainHelpers.js

@@ -1,119 +0,0 @@
-import { CesiumTerrainProvider, Cartographic, Cartesian2, sampleTerrainMostDetailed, sampleTerrain } from '@vcmap/cesium';
-import { getTransform } from 'ol/proj.js';
-import { wgs84Projection } from '../util/projection.js';
-
-/**
- * @typedef {Object} TerrainProviderOptions
- * @property {!string} url
- * @property {boolean|undefined} requestVertexNormals
- * @property {boolean|undefined} requestWaterMask
- * @api
- */
-
-/**
- * @type {Object<string, import("@vcmap/cesium").CesiumTerrainProvider>}
- */
-const terrainProviders = {};
-
-/**
- * @param {TerrainProviderOptions} options
- * @returns {import("@vcmap/cesium").CesiumTerrainProvider}
- */
-export function getTerrainProviderForUrl(options) {
-  if (!terrainProviders[options.url]) {
-    terrainProviders[options.url] = new CesiumTerrainProvider(options);
-    return terrainProviders[options.url];
-  }
-  let terrainProvider = terrainProviders[options.url];
-  if ((options.requestVertexNormals !== undefined &&
-    terrainProvider.requestVertexNormals !== options.requestVertexNormals) ||
-    (options.requestWaterMask !== undefined &&
-      terrainProvider.requestWaterMask !== options.requestWaterMask)) {
-    terrainProviders[options.url] = new CesiumTerrainProvider(options);
-    terrainProvider = terrainProviders[options.url];
-  }
-  return terrainProvider;
-}
-
-/**
- * @param {import("@vcmap/cesium").CesiumTerrainProvider} terrainProvider
- * @param {Array<import("@vcmap/cesium").Cartographic>} positions
- * @returns {Promise<Array<import("@vcmap/cesium").Cartographic>>}
- */
-export function sampleCesiumTerrainMostDetailed(terrainProvider, positions) {
-  return new Promise((resolve, reject) => {
-    sampleTerrainMostDetailed(terrainProvider, positions)
-      .then((updatedPositions) => {
-        resolve(updatedPositions);
-      }, reject);
-  });
-}
-
-/**
- * updates the height of the positions in place.
- * @param {import("@vcmap/cesium").CesiumTerrainProvider} terrainProvider
- * @param {number} level
- * @param {Array<import("@vcmap/cesium").Cartographic>} positions
- * @returns {Promise<Array<import("@vcmap/cesium").Cartographic>>}
- */
-export function sampleCesiumTerrain(terrainProvider, level, positions) {
-  return new Promise((resolve, reject) => {
-    sampleTerrain(terrainProvider, level, positions)
-      .then((updatedPositions) => {
-        resolve(updatedPositions);
-      }, reject);
-  });
-}
-
-/**
- * changes input coordinate Array in place, new height can also be accessed by coordinates[x][2]
- * @param {import("@vcmap/cesium").CesiumTerrainProvider} terrainProvider
- * @param {Array<import("ol/coordinate").Coordinate>} coordinates
- * @param {import("@vcmap/core").Projection=} optSourceProjection - if input is not WGS84
- * @param {Array<import("ol/coordinate").Coordinate>=} result
- * @returns {Promise<Array<import("ol/coordinate").Coordinate>>}
- */
-export function getHeightFromTerrainProvider(terrainProvider, coordinates, optSourceProjection, result) {
-  const sourceTransformer = optSourceProjection ?
-    getTransform(
-      optSourceProjection.proj,
-      wgs84Projection.proj,
-    ) :
-    null;
-
-  const positions = coordinates.map((coord) => {
-    const wgs84 = sourceTransformer ?
-      sourceTransformer(coord, coord.slice(), coord.length) :
-      coord;
-    return Cartographic.fromDegrees(wgs84[0], wgs84[1]);
-  });
-
-  const outArray = result || coordinates.map(c => c.slice());
-  return new Promise((resolve, reject) => {
-    sampleTerrainMostDetailed(terrainProvider, positions)
-      .then((updatedPositions) => {
-        updatedPositions.forEach((position, index) => {
-          outArray[index][2] = position.height || 0;
-        });
-        resolve(outArray);
-      }, reject);
-  });
-}
-
-/**
- * checks, whether a terrain tile is available at given position or not
- * @param {import("@vcmap/cesium").CesiumTerrainProvider} terrainProvider
- * @param {number} level
- * @param {import("@vcmap/cesium").Cartographic} position
- * @returns {boolean}
- */
-export function isTerrainTileAvailable(terrainProvider, level, position) {
-  if (!terrainProvider.ready) {
-    return false;
-  }
-  const tileXY = terrainProvider.tilingScheme.positionToTileXY(
-    position, level, new Cartesian2(),
-  );
-  return terrainProvider.getTileDataAvailable(tileXY.x, tileXY.y, level);
-}
-

package/src/vcs/vcm/layer/tileProvider/staticGeojsonTileProvider.js

@@ -1,67 +0,0 @@
-import axios from 'axios';
-import { parseGeoJSON } from '../geojsonHelpers.js';
-import TileProvider from './tileProvider.js';
-
-/**
- * @typedef {TileProviderOptions} StaticGeojsonTileProviderOptions
- * @property {string} url geojson
- * @api
- */
-
-/**
- * Loads the provided geojson url and tiles the content in memory, data is only requested once
- *
- * @class
- * @extends {TileProvider}
- * @export
- * @api
- */
-class StaticGeojsonTileProvider extends TileProvider {
-  /**
-   * @readonly
-   * @returns {string}
-   */
-  static get className() { return 'vcs.vcm.layer.tileProvider.StaticGeojsonTileProvider'; }
-
-  /**
-   * @returns {StaticGeojsonTileProviderOptions}
-   */
-  static getDefaultOptions() {
-    return {
-      ...TileProvider.getDefaultOptions(),
-      url: undefined,
-      baseLevels: [0],
-    };
-  }
-
-  /**
-   * @param {StaticGeojsonTileProviderOptions} options
-   */
-  constructor(options) {
-    const defaultOptions = StaticGeojsonTileProvider.getDefaultOptions();
-    options.baseLevels = defaultOptions.baseLevels;
-    super(options);
-
-    /**
-     * @type {string}
-     */
-    this.url = options.url || defaultOptions.url;
-  }
-
-
-  /**
-   * @inheritDoc
-   * @param {number} x
-   * @param {number} y
-   * @param {number} z
-   * @returns {Promise<Array<import("ol").Feature<import("ol/geom/Geometry").default>>>}
-   */
-  // eslint-disable-next-line no-unused-vars
-  async loader(x, y, z) {
-    const response = await axios.get(this.url);
-    const { features } = parseGeoJSON(response.data, { dynamicStyle: true });
-    return features;
-  }
-}
-
-export default StaticGeojsonTileProvider;

package/src/vcs/vcm/layer/tileProvider/tileProviderFactory.js

@@ -1,28 +0,0 @@
-import { VcsClassRegistry } from '../../classRegistry.js';
-import TileProvider from './tileProvider.js';
-import URLTemplateTileProvider from './urlTemplateTileProvider.js';
-import StaticGeojsonTileProvider from './staticGeojsonTileProvider.js';
-import MVTTileProvider from './mvtTileProvider.js';
-
-VcsClassRegistry.registerClass(TileProvider.className, TileProvider);
-VcsClassRegistry.registerClass(URLTemplateTileProvider.className, URLTemplateTileProvider);
-VcsClassRegistry.registerClass(StaticGeojsonTileProvider.className, StaticGeojsonTileProvider);
-VcsClassRegistry.registerClass(MVTTileProvider.className, MVTTileProvider);
-
-/**
- * TileProvider
- * @namespace tileProvider
- * @api stable
- */
-
-/**
- * @param {Object} options
- * @returns {Promise<TileProvider>}
- * @api
- * @export
- */
-function factory(options) {
-  return VcsClassRegistry.create(options.type, options);
-}
-
-export default factory;