@vcmap/core 5.0.0-rc.8 → 5.0.0

package/src/layer/cesium/vectorTileImageryProvider.js

@@ -1,246 +0,0 @@
-import { Event as CesiumEvent, Rectangle, Math as CesiumMath } from '@vcmap/cesium';
-import { compose, create as createTransform, scale as scaleTransform } from 'ol/transform.js';
-import { rectangleToExtent } from '../tileProvider/tileProvider.js';
-import { wgs84ToMercatorTransformer } from '../../util/projection.js';
-import CanvasTileRenderer from '../../ol/render/canvas/canvasTileRenderer.js';
-
-/**
- * @param {import("ol/extent").Extent} extent
- * @param {import("ol/coordinate").Coordinate} center
- * @param {Object} context
- * @param {import("ol/size").Size} tileSize
- * @returns {import("ol").CanvasTileRenderer}
- */
-export function toContext(extent, center, context, tileSize) {
-  const { canvas } = context;
-  canvas.width = tileSize[0];
-  canvas.height = tileSize[1];
-  canvas.style.width = `${tileSize[0] }px`;
-  canvas.style.height = `${tileSize[1] }px`;
-  const scaleY = (extent[2] - extent[0]) / (extent[3] - extent[1]);
-  const sx = 1 / ((extent[2] - extent[0]) / 256);
-  const sy = -1 / ((extent[3] - extent[1]) / 256);
-  const transform = scaleTransform(createTransform(), 1, 1);
-  const newTransform = compose(transform, 128, 128, sx, sy, 0, -center[0], -center[1]);
-  // @ts-ignore
-  return new CanvasTileRenderer(context, 1, extent, newTransform, 0, null, null, scaleY);
-}
-
-
-/**
- * creates a canvas and draws the features on the canvas;
- * @param {Array<import("ol").Feature<import("ol/geom/Geometry").default>>} features
- * @param {import("ol/extent").Extent} extent
- * @param {import("@vcmap/cesium").Cartographic} center
- * @param {import("ol/size").Size} tileSize
- * @returns {HTMLCanvasElement}
- */
-export function getCanvasFromFeatures(features, extent, center, tileSize) {
-  const canvas = document.createElement('canvas');
-  canvas.width = tileSize[0];
-  canvas.height = tileSize[0];
-  const centerMercator =
-    wgs84ToMercatorTransformer([CesiumMath.toDegrees(center.longitude), CesiumMath.toDegrees(center.latitude)]);
-  const vectorContext = toContext(extent, centerMercator, canvas.getContext('2d'), tileSize);
-
-  features.forEach((feature) => {
-    const styleFunction = feature.getStyleFunction();
-    const featureStyles = /** @type {Array<import("ol/style/Style").default>} */(styleFunction(feature, 1));
-    featureStyles.forEach((styleToUse) => {
-      // @ts-ignore
-      vectorContext.drawFeature(feature, styleToUse);
-    });
-  });
-  return canvas;
-}
-
-/**
- * @typedef {Object} VectorTileImageryProviderOptions
- * @property {import("@vcmap/core").TileProvider} tileProvider
- * @property {import("ol/size").Size} tileSize
- * @api
- */
-
-/**
- * implementation of Cesium ImageryProvider Interface
- * @class
- * @export
- */
-class VectorTileImageryProvider {
-  /**
-   * @param {VectorTileImageryProviderOptions} options
-   */
-  constructor(options) {
-    /**
-     * @type {import("@vcmap/core").TileProvider}
-     */
-    this.tileProvider = options.tileProvider;
-
-    /**
-     * @type {import("@vcmap/cesium").WebMercatorTilingScheme}
-     * @private
-     */
-    this._tilingScheme = this.tileProvider.tilingScheme;
-
-    /**
-     * @type {import("ol/size").Size}
-     * @private
-     */
-    this._tileSize = options.tileSize;
-
-    /**
-     * @type {import("@vcmap/cesium").Event}
-     * @private
-     */
-    this._errorEvent = new CesiumEvent();
-
-    /**
-     * @type {Promise<boolean>}
-     * @private
-     */
-    this._readyPromise = Promise.resolve(true);
-
-    /**
-     * @type {HTMLCanvasElement}
-     */
-    this.emptyCanvas = document.createElement('canvas');
-    this.emptyCanvas.width = this.tileWidth;
-    this.emptyCanvas.height = this.tileHeight;
-
-
-    /**
-     * @type {number}
-     */
-    this.minLevel = 0;
-    /**
-     * @type {number}
-     */
-    this.maxLevel = 26;
-
-    /**
-     * @type {Function}
-     */
-    this._reload = undefined;
-
-    // Necessary to satisfy Cesium ImageryProvider Interface
-    this.defaultAlpha = undefined;
-    this.defaultNightAlpha = undefined;
-    this.defaultDayAlpha = undefined;
-    this.defaultBrightness = undefined;
-    this.defaultContrast = undefined;
-    this.defaultHue = undefined;
-    this.defaultSaturation = undefined;
-    this.defaultGamma = undefined;
-    this.defaultMinificationFilter = undefined;
-    this.defaultMagnificationFilter = undefined;
-  }
-
-  /**
-   * @returns {boolean}
-   */
-  // eslint-disable-next-line class-methods-use-this
-  get ready() {
-    return true;
-  }
-
-  /**
-   * @returns {Promise<boolean>}
-   */
-  get readyPromise() {
-    return this._readyPromise;
-  }
-
-  /**
-   * @returns {import("@vcmap/cesium").Rectangle}
-   */
-  get rectangle() {
-    return this._tilingScheme.rectangle;
-  }
-
-  /**
-   * @returns {number}
-   */
-  get tileWidth() {
-    return this._tileSize[0];
-  }
-
-  /**
-   * @returns {number}
-   */
-  get tileHeight() {
-    return this._tileSize[1];
-  }
-
-  /**
-   * @returns {number}
-   */
-  get maximumLevel() {
-    return this.maxLevel;
-  }
-
-  /**
-   * @returns {number}
-   */
-  get minimumLevel() {
-    return this.minLevel;
-  }
-
-  /**
-   * @returns {import("@vcmap/cesium").TilingScheme}
-   */
-  get tilingScheme() {
-    return this._tilingScheme;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get tileDiscardPolicy() {
-    return undefined;
-  }
-
-  /**
-   * @returns {import("@vcmap/cesium").Event}
-   */
-  get errorEvent() {
-    return this._errorEvent;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get credit() {
-    return undefined;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get proxy() {
-    return undefined;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get hasAlphaChannel() {
-    return true;
-  }
-
-  /**
-   * Requests the image for a given tile.  This function should
-   * not be called before {@link TileCoordinatesImageryProvider#ready} returns true.
-   *
-   * @param {number} x The tile X coordinate.
-   * @param {number} y The tile Y coordinate.
-   * @param {number} level The tile level.
-   * @returns {Promise<HTMLImageElement|HTMLCanvasElement>} A promise for the image that will resolve when the image is available, or
-   *          undefined if there are too many active requests to the server, and the request
-   *          should be retried later.  The resolved image may be either an
-   *          Image or a Canvas DOM object.
-   */
-  async requestImage(x, y, level) {
-    const features = await this.tileProvider.getFeaturesForTile(x, y, level);
-    if (features.length === 0) {
-      return this.emptyCanvas;
-    }
-    const rectangle = this.tileProvider.tilingScheme.tileXYToRectangle(x, y, level);
-    const extent = rectangleToExtent(rectangle);
-    const center = Rectangle.center(rectangle);
-    return getCanvasFromFeatures(features, extent, center, this._tileSize);
-  }
-}
-
-export default VectorTileImageryProvider;

package/src/layer/cesium/x3dmHelper.js

@@ -1,22 +0,0 @@
-/**
- * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature} feature
- * @returns {Object}
- */
-export default function getJSONObjectFromObject(feature) {
-  const properties = feature.getPropertyNames();
-  const JSONObject = {};
-  for (let i = 0; i < properties.length; i++) {
-    JSONObject[properties[i]] = feature.getProperty(properties[i]);
-  }
-  if (JSONObject.id == null) {
-    JSONObject.id = `${feature.content.url}${feature._batchId}`;
-  }
-  if (JSONObject.attributes) {
-    JSONObject.attributes.gmlId = JSONObject.id;
-  } else if (JSONObject.gmlId == null) {
-    JSONObject.gmlId = JSONObject.id;
-  }
-  // @ts-ignore
-  JSONObject.clickedPosition = feature.clickedPosition ? feature.clickedPosition : {};
-  return JSONObject;
-}

package/src/layer/cesiumTilesetLayer.js

@@ -1,376 +0,0 @@
-import { ImagerySplitDirection, Matrix4 } from '@vcmap/cesium';
-
-import { checkMaybe } from '@vcsuite/check';
-import { parseInteger } from '@vcsuite/parsers';
-import getJSONObjectFromObject from './cesium/x3dmHelper.js';
-import VectorStyleItem from '../style/vectorStyleItem.js';
-import FeatureLayer from './featureLayer.js';
-import CesiumTilesetCesiumImpl, { getExtentFromTileset } from './cesium/cesiumTilesetCesiumImpl.js';
-import CesiumMap from '../map/cesiumMap.js';
-import VcsEvent from '../vcsEvent.js';
-import Extent from '../util/extent.js';
-import { mercatorProjection } from '../util/projection.js';
-import { isMobile } from '../util/isMobile.js';
-import { referenceableStyleSymbol } from '../style/styleItem.js';
-import { VcsClassRegistry } from '../classRegistry.js';
-
-/**
- * @typedef {LayerOptions} CesiumTilesetOptions
- * @property {number|undefined} [screenSpaceError=16] -  relates inversely to the depth over which the layer is activated
- * @property {number|undefined} [screenSpaceErrorMobile=32] -  relates inversely to the depth over which the layer is activated
- * @property {number|undefined} [maximumMemoryUsage=16] - sets the cesium maximumMemoryUsage Parameter (Is when the cached tiles exceed this value cesium starts to clear the cached tiles)
- * @property {Object|undefined} tilesetOptions
- * @property {import("@vcmap/core").VectorStyleItem|VectorStyleItemOptions|undefined} highlightStyle
- * @property {import("@vcmap/core").FeatureVisibility|undefined} featureVisibility
- * @property {string|undefined} splitDirection - either 'left' or 'right', if omitted none is applied
- * @property {import("ol/coordinate").Coordinate|undefined} offset - an offset of x, y, z. x and y in degrees longitude/latitude respectively
- * @api
- */
-
-/**
- * @typedef {Object} CesiumTilesetTilesetProperties
- * @property {string|symbol} key
- * @property {*} value
- * @api
- */
-
-/**
- * @typedef {FeatureLayerImplementationOptions} CesiumTilesetImplementationOptions
- * @property {Object|undefined} tilesetOptions
- * @property {import("@vcmap/cesium").ImagerySplitDirection} splitDirection
- * @property {Array<CesiumTilesetTilesetProperties>|undefined} tilesetProperties
- * @property {import("@vcmap/cesium").Matrix4|undefined} modelMatrix
- * @property {import("ol/coordinate").Coordinate|undefined} offset
- * @api
- */
-
-/**
- * represents a specific Building layer for cesium.
- * @class
- * @extends {FeatureLayer}
- * @implements {SplitLayer}
- * @api stable
- * @export
- */
-class CesiumTilesetLayer extends FeatureLayer {
-  /** @type {string} */
-  static get className() { return 'CesiumTilesetLayer'; }
-
-  /**
-   * @returns {CesiumTilesetOptions}
-   */
-  static getDefaultOptions() {
-    return {
-      ...FeatureLayer.getDefaultOptions(),
-      highlightStyle: undefined,
-      screenSpaceError: 16,
-      screenSpaceErrorMobile: 32,
-      maximumMemoryUsage: 16,
-      tilesetOptions: {},
-      splitDirection: undefined,
-      offset: undefined,
-    };
-  }
-
-  /**
-   * @param {CesiumTilesetOptions} options
-   */
-  constructor(options) {
-    super(options);
-    this._supportedMaps = [
-      CesiumMap.className,
-    ];
-    const defaultOptions = CesiumTilesetLayer.getDefaultOptions();
-    if (this.url && !/\.json$/.test(this.url)) {
-      this.url = `${this.url.replace(/\/$/, '')}/tileset.json`;
-    }
-
-    /** @type {VectorStyleItem} */
-    this.highlightStyle = null;
-    if (options.highlightStyle) {
-      this.highlightStyle = options.highlightStyle instanceof VectorStyleItem ?
-        options.highlightStyle :
-        new VectorStyleItem(/** @type {VectorStyleItemOptions} */ (options.highlightStyle));
-    }
-    /** @type {number} */
-    this.screenSpaceError = parseInteger(options.screenSpaceError, defaultOptions.screenSpaceError);
-
-    /** @type {number} */
-    this.screenSpaceErrorMobile = parseInteger(options.screenSpaceErrorMobile, defaultOptions.screenSpaceErrorMobile);
-
-    /** @type {number} */
-    this.maximumMemoryUsage = parseInteger(options.maximumMemoryUsage, defaultOptions.maximumMemoryUsage);
-
-    const tilesetOptions = options.tilesetOptions || defaultOptions.tilesetOptions;
-
-    /** @type {!Object} */
-    this.tilesetOptions = {
-      url: this.url,
-      maximumScreenSpaceError: isMobile() ? this.screenSpaceErrorMobile : this.screenSpaceError,
-      maximumMemoryUsage: this.maximumMemoryUsage,
-      ...tilesetOptions,
-    };
-
-    /** @type {import("@vcmap/cesium").ImagerySplitDirection} */
-    this._splitDirection = ImagerySplitDirection.NONE;
-
-    if (options.splitDirection) {
-      this._splitDirection = options.splitDirection === 'left' ?
-        ImagerySplitDirection.LEFT :
-        ImagerySplitDirection.RIGHT;
-    }
-
-    /**
-     * raised if the split direction changes, is passed the split direction as its only argument
-     * @type {VcsEvent<import("@vcmap/cesium").ImagerySplitDirection>}
-     * @api
-     */
-    this.splitDirectionChanged = new VcsEvent();
-
-    /**
-     * @type {import("@vcmap/cesium").Matrix4|undefined}
-     * @private
-     */
-    this._modelMatrix = undefined;
-
-    /**
-     * @type {import("ol/coordinate").Coordinate|undefined}
-     * @private
-     */
-    this._offset = options.offset || defaultOptions.offset;
-  }
-
-  /**
-   * A model matrix to apply to each cesium3DTileset created from this layer.
-   * This will overwrite any modelMatrix calculated by the offset property.
-   * @api
-   * @returns {import("@vcmap/cesium").Matrix4|undefined}
-   */
-  get modelMatrix() {
-    return this._modelMatrix;
-  }
-
-  /**
-   * @param {import("@vcmap/cesium").Matrix4|undefined} modelMatrix
-   */
-  set modelMatrix(modelMatrix) {
-    checkMaybe(modelMatrix, Matrix4);
-
-    this._modelMatrix = modelMatrix;
-    this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */ (impl) => {
-        impl.updateModelMatrix(modelMatrix);
-      });
-  }
-
-  /**
-   * An offset in x, y, z. x and y are in degrees longitude latitude respectively.
-   * If a modelMatrix is defined on this layer, setting an offset will not take effect until you
-   * set the modelMatrix to undefined.
-   * @api
-   * @type {import("ol/coordinate").Coordinate|undefined}
-   */
-  get offset() {
-    return this._offset;
-  }
-
-  /**
-   * @param {import("ol/coordinate").Coordinate|undefined} offset
-   */
-  set offset(offset) {
-    checkMaybe(offset, [Number]);
-
-    this._offset = offset;
-    this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */ (impl) => {
-        impl.updateOffset(offset);
-      });
-  }
-
-  /**
-   * @api
-   * @type {import("@vcmap/cesium").ImagerySplitDirection}
-   */
-  get splitDirection() { return this._splitDirection; }
-
-  /**
-   * @param {import("@vcmap/cesium").ImagerySplitDirection} direction
-   */
-  set splitDirection(direction) {
-    if (direction !== this._splitDirection) {
-      this.getImplementations().forEach((impl) => {
-        /** @type {CesiumTilesetCesiumImpl} */ (impl).updateSplitDirection(direction);
-      });
-      this._splitDirection = direction;
-      this.splitDirectionChanged.raiseEvent(this._splitDirection);
-    }
-  }
-
-  /**
-   * @inheritDoc
-   * @returns {CesiumTilesetImplementationOptions}
-   */
-  getImplementationOptions() {
-    return {
-      ...super.getImplementationOptions(),
-      tilesetOptions: this.tilesetOptions,
-      splitDirection: this.splitDirection,
-      modelMatrix: this.modelMatrix,
-      offset: this.offset,
-    };
-  }
-
-  /**
-   * @inheritDoc
-   * @param {import("@vcmap/core").VcsMap} map
-   * @returns {Array<CesiumTilesetCesiumImpl>}
-   */
-  createImplementationsForMap(map) {
-    if (map instanceof CesiumMap) {
-      return [new CesiumTilesetCesiumImpl(map, this.getImplementationOptions())];
-    }
-    return [];
-  }
-
-  /**
-   * @inheritDoc
-   * @param {import("@vcmap/cesium").Cesium3DTileFeature|import("@vcmap/cesium").Cesium3DTilePointFeature} object
-   * @returns {?Object}
-   */
-  objectClickedHandler(object) {
-    if (this.allowPicking) {
-      const jsonObject = getJSONObjectFromObject(object);
-      if (jsonObject) {
-        return {
-          id: jsonObject.id,
-          feature: jsonObject,
-        };
-      }
-    }
-    return null;
-  }
-
-  /**
-   * Returns the configured Extent of this layer or tries to calculate the extent based on tileset.
-   * Returns null of no extent was configured and the layers tileset is not yet loaded or ready.
-   * @returns {Extent|null}
-   * @api
-   */
-  getZoomToExtent() {
-    const metaExtent = super.getZoomToExtent();
-    if (metaExtent) {
-      return metaExtent;
-    }
-    const impl = /** @type {CesiumTilesetCesiumImpl} */ (this.getImplementations()[0]);
-    if (impl) {
-      const threeDimExtent = getExtentFromTileset(impl.cesium3DTileset);
-
-      const actualExtent = new Extent({
-        projection: mercatorProjection.toJSON(),
-        coordinates: threeDimExtent,
-      });
-
-      if (actualExtent.isValid()) {
-        return actualExtent;
-      }
-    }
-
-    return null;
-  }
-
-  // TODO type params
-  getGenericFeatureFromClickedObject(object) {
-    const attributes = { ...this.genericFeatureProperties, ...object.attributes || object };
-    return {
-      layerName: this.name,
-      layerClass: this.className,
-      attributes,
-      longitude: object.clickedPosition.longitude,
-      latitude: object.clickedPosition.latitude,
-      height: object.clickedPosition.height + this.balloonHeightOffset,
-      relativeToGround: false,
-    };
-  }
-
-  /**
-   * set the maximum screenspace error of this layer
-   * @param {number} value
-   * @api stable
-   */
-  setMaximumScreenSpaceError(value) {
-    this.getImplementations()
-      .forEach(/** @param {CesiumTilesetCesiumImpl} impl */(impl) => {
-        if (impl.cesium3DTileset) {
-          impl.cesium3DTileset.maximumScreenSpaceError = value;
-        }
-      });
-  }
-
-  /**
-   * @returns {CesiumTilesetOptions}
-   */
-  toJSON() {
-    /** @type {CesiumTilesetOptions} */
-    const config = super.toJSON();
-    const defaultOptions = CesiumTilesetLayer.getDefaultOptions();
-    if (this.highlightStyle) {
-      config.highlightStyle = this.highlightStyle[referenceableStyleSymbol] ?
-        this.highlightStyle.getReference() :
-        this.highlightStyle.getOptions();
-    }
-
-    if (this.screenSpaceError !== defaultOptions.screenSpaceError) {
-      config.screenSpaceError = this.screenSpaceError;
-    }
-
-    if (this.screenSpaceErrorMobile !== defaultOptions.screenSpaceErrorMobile) {
-      config.screenSpaceErrorMobile = this.screenSpaceErrorMobile;
-    }
-
-    if (this.maximumMemoryUsage !== defaultOptions.maximumMemoryUsage) {
-      config.maximumMemoryUsage = this.maximumMemoryUsage;
-    }
-
-    const tilesetOptions = { ...this.tilesetOptions };
-    if (tilesetOptions.url === this.url) {
-      delete tilesetOptions.url;
-    }
-
-    const usedScreenSpaceError = isMobile() ? this.screenSpaceErrorMobile : this.screenSpaceError;
-    if (tilesetOptions.maximumScreenSpaceError === usedScreenSpaceError) {
-      delete tilesetOptions.maximumScreenSpaceError;
-    }
-
-    if (tilesetOptions.maximumMemoryUsage === this.maximumMemoryUsage) {
-      delete tilesetOptions.maximumMemoryUsage;
-    }
-
-    if (Object.keys(tilesetOptions).length > 0) {
-      config.tilesetOptions = tilesetOptions;
-    }
-
-    if (this._splitDirection !== ImagerySplitDirection.NONE) {
-      config.splitDirection = this._splitDirection === ImagerySplitDirection.RIGHT ?
-        'right' :
-        'left';
-    }
-
-    if (Array.isArray(this.offset)) {
-      config.offset = this.offset.slice();
-    }
-
-    return config;
-  }
-
-  /**
-   * disposes of this layer, removes instances from the current maps and the framework
-   * @api stable
-   */
-  destroy() {
-    super.destroy();
-    this.splitDirectionChanged.destroy();
-  }
-}
-
-VcsClassRegistry.registerClass(CesiumTilesetLayer.className, CesiumTilesetLayer);
-export default CesiumTilesetLayer;