@vcmap/core 5.0.0-rc.34 → 5.0.0-rc.36

package/src/interaction/featureAtPixelInteraction.ts

@@ -26,6 +26,9 @@ import type OpenlayersMap from '../map/openlayersMap.js';
 import type ObliqueMap from '../map/obliqueMap.js';
 import type CesiumMap from '../map/cesiumMap.js';
 
+/**
+ * @group Interaction
+ */
 class FeatureAtPixelInteraction extends AbstractInteraction {
   private _pickPosition = EventType.CLICK;
 

package/src/interaction/featureProviderInteraction.ts

@@ -9,6 +9,9 @@ import {
   PointerKeyType,
 } from './interactionType.js';
 
+/**
+ * @group Interaction
+ */
 class FeatureProviderInteraction extends AbstractInteraction {
   constructor() {
     super(EventType.CLICK, ModificationKeyType.ALL, PointerKeyType.ALL);

package/src/interaction/interactionChain.ts

@@ -7,6 +7,9 @@ import {
   PointerKeyType,
 } from './interactionType.js';
 
+/**
+ * @group Interaction
+ */
 class InteractionChain extends AbstractInteraction {
   /**
    * The interactions to handle one after the other

package/src/layer/cesium/vectorRasterTileCesiumImpl.ts

@@ -36,7 +36,7 @@ class VectorRasterTileCesiumImpl extends RasterLayerCesiumImpl {
     const rasterLayerOptions: RasterLayerImplementationOptions = {
       ...options,
       tilingSchema: TilingScheme.MERCATOR,
-      opacity: 0,
+      opacity: 1,
     };
     super(map, rasterLayerOptions);
     this.tileProvider = options.tileProvider;

package/src/layer/cesiumTilesetLayer.ts

@@ -58,6 +58,7 @@ export type CesiumTilesetImplementationOptions =
 
 /**
  * represents a specific Building layer for cesium.
+ * @group Layer
  */
 class CesiumTilesetLayer extends FeatureLayer<CesiumTilesetCesiumImpl> {
   static get className(): string {

package/src/layer/czmlLayer.ts

@@ -9,6 +9,9 @@ export type CzmlOptions = LayerOptions & {
   sourceUri?: string;
 };
 
+/**
+ * @group Layer
+ */
 class CzmlLayer extends DataSourceLayer {
   static get className(): string {
     return 'CzmlLayer';

package/src/layer/dataSourceLayer.ts

@@ -20,6 +20,7 @@ export type DataSourceImplementationOptions = LayerImplementationOptions & {
 
 /**
  * Represents a layer of Cesium.Entity
+ * @group Layer
  */
 class DataSourceLayer extends Layer<DataSourceCesiumImpl> {
   static get className(): string {

package/src/layer/featureLayer.ts

@@ -42,6 +42,7 @@ export interface FeatureLayerImplementation {
 
 /**
  * Base class for all layers representing features, e.g. VectorLayer, Buildings, POIs
+ * @group Layer
  */
 class FeatureLayer<
     T extends LayerImplementation<VcsMap> & FeatureLayerImplementation,

package/src/layer/featureStoreLayer.ts

@@ -100,6 +100,8 @@ export const isTiledFeature: unique symbol = Symbol('isTiledFeature');
 
 /**
  * FeatureStoreLayer Layer
+ * @group Layer
+ * @experimental
  */
 class FeatureStoreLayer extends VectorLayer {
   static get className(): string {

package/src/layer/geojsonHelpers.ts

@@ -265,9 +265,6 @@ function readFeature(
   }
 
   featureObj.vcsMeta = featureObj.vcsMeta || ({} as VcsMeta);
-  if (featureObj.vcsStyle) {
-    featureObj.vcsMeta.style = featureObj.vcsMeta.style || featureObj.vcsStyle;
-  }
   const { properties } = featureObj;
   if (
     properties &&
@@ -352,7 +349,6 @@ export function parseGeoJSON(
       geoJSON.vcsMeta ||
       ({
         embeddedIcons: geoJSON.vcsEmbeddedIcons,
-        style: geoJSON.vcsStyle,
       } as VcsMeta);
 
     let style;

package/src/layer/geojsonLayer.ts

@@ -16,6 +16,9 @@ export type GeoJSONOptions = VectorOptions & {
  */
 export const featureFromOptions = Symbol('featureFromOptions');
 
+/**
+ * @group Layer
+ */
 class GeoJSONLayer extends VectorLayer {
   static get className(): string {
     return 'GeoJSONLayer';

package/src/layer/layer.ts

@@ -2,7 +2,6 @@ import { check, checkMaybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger } from '@vcsuite/parsers';
 import VcsObject, { VcsObjectOptions } from '../vcsObject.js';
 import Extent, { type ExtentOptions } from '../util/extent.js';
-import { vcsLayerName } from './layerSymbols.js';
 import LayerState from './layerState.js';
 import VcsEvent from '../vcsEvent.js';
 import { layerClassRegistry } from '../classRegistry.js';
@@ -56,6 +55,7 @@ export type LayerImplementationOptions = {
  * Abstract base class for Layers.
  * To create a layer Implementation the function `createImplementationsForMap` has to be implemented.
  * To receive implementation options, implement `geImplementationOptions`
+ * @group Layer
  */
 class Layer<
   I extends LayerImplementation<VcsMap> = LayerImplementation<VcsMap>,
@@ -64,14 +64,6 @@ class Layer<
     return 'Layer';
   }
 
-  /**
-   * Symbol to declare a layers name on its visualizations, e.g. ol.layer.Layer, Cesium.Cesium3DTileset
-   * @deprecated
-   */
-  static get vcsLayerNameSymbol(): symbol {
-    return vcsLayerName;
-  }
-
   static getDefaultOptions(): LayerOptions {
     return {
       name: undefined,

package/src/layer/layerSymbols.ts

@@ -1,2 +1,5 @@
+/**
+ * Symbol to declare a layers name on its visualizations, e.g. ol.layer.Layer, Cesium.Cesium3DTileset*
+ */
 /* eslint-disable import/prefer-default-export */
 export const vcsLayerName: unique symbol = Symbol('vcsLayerName');

package/src/layer/openStreetMapLayer.ts

@@ -31,6 +31,9 @@ export type OpenStreetMapOptions = LayerOptions & {
   maxLevel?: number;
 };
 
+/**
+ * @group Layer
+ */
 class OpenStreetMapLayer
   extends Layer<OpenStreetMapCesiumImpl | OpenStreetMapOpenlayersImpl>
   implements SplitLayer

package/src/layer/pointCloudLayer.ts

@@ -29,6 +29,7 @@ export const defaultPointCloudStyle = new DeclarativeStyleItem({});
  *  <li>url: string: url to the p3dm dataset
  *  <li>pointSize: number: size of the points to display
  * </ul>
+ * @group Layer
  */
 class PointCloudLayer extends CesiumTilesetLayer {
   static get className(): string {

package/src/layer/rasterLayer.ts

@@ -149,6 +149,7 @@ export function calculateMinLevel(
 /**
  * This abstract class allows for automatic loading scheme determination
  * for raster layers
+ * @group Layer
  */
 class RasterLayer<
     I extends LayerImplementation<VcsMap> & RasterLayerImplementation,

package/src/layer/singleImageLayer.ts

@@ -23,6 +23,7 @@ export type SingleImageImplementationOptions =
 
 /**
  * Image layer for Cesium and OpenlayersMap
+ * @group Layer
  */
 class SingleImageLayer extends RasterLayer<
   SingleImageCesiumImpl | SingleImageOpenlayersImpl

package/src/layer/terrainLayer.ts

@@ -20,6 +20,9 @@ export type TerrainImplementationOptions = LayerImplementationOptions & {
   requestWaterMask: boolean;
 };
 
+/**
+ * @group Layer
+ */
 class TerrainLayer extends Layer<TerrainCesiumImpl> {
   static get className(): string {
     return 'TerrainLayer';

package/src/layer/tmsLayer.ts

@@ -21,6 +21,9 @@ export type TMSImplementationOptions = RasterLayerImplementationOptions & {
   tileSize: Size;
 };
 
+/**
+ * @group Layer
+ */
 class TMSLayer extends RasterLayer<TmsCesiumImpl | TmsOpenlayersImpl> {
   static get className(): string {
     return 'TMSLayer';

package/src/layer/vectorLayer.ts

@@ -33,13 +33,7 @@ import DeclarativeStyleItem, {
   DeclarativeStyleItemOptions,
 } from '../style/declarativeStyleItem.js';
 import writeStyle from '../style/writeStyle.js';
-import {
-  alreadyTransformedToImage,
-  alreadyTransformedToMercator,
-  doNotTransform,
-  obliqueGeometry,
-  originalFeatureSymbol,
-} from './vectorSymbols.js';
+import { alreadyTransformedToMercator } from './vectorSymbols.js';
 import Extent from '../util/extent.js';
 import VectorProperties, {
   VcsMeta,
@@ -144,6 +138,7 @@ export type VectorImplementationOptions = FeatureLayerImplementationOptions & {
 
 /**
  * VectorLayer Layer for OpenlayersMap, Cesium and ObliqueMap
+ * @group Layer
  */
 class VectorLayer
   extends FeatureLayer<
@@ -158,41 +153,6 @@ class VectorLayer
     return 'VectorLayer';
   }
 
-  /**
-   * @deprecated
-   */
-  static get alreadyTransformedToMercator(): symbol {
-    return alreadyTransformedToMercator;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get alreadyTransformedToImage(): symbol {
-    return alreadyTransformedToImage;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get obliqueGeometry(): symbol {
-    return obliqueGeometry;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get doNotTransform(): symbol {
-    return doNotTransform;
-  }
-
-  /**
-   * @deprecated
-   */
-  static get originalFeatureSymbol(): symbol {
-    return originalFeatureSymbol;
-  }
-
   static getDefaultOptions(): VectorOptions {
     return {
       ...Layer.getDefaultOptions(),

package/src/layer/vectorProperties.ts

@@ -113,7 +113,6 @@ export type VectorPropertiesOptions = {
   storeysBelowGround?: number;
   storeyHeightsAboveGround?: number[] | number;
   storeyHeightsBelowGround?: number[] | number;
-  storeyHeight?: number;
   modelUrl?: string;
   modelScaleX?: number;
   modelScaleY?: number;
@@ -302,7 +301,6 @@ class VectorProperties {
       storeysBelowGround: 0,
       storeyHeightsAboveGround: [],
       storeyHeightsBelowGround: [],
-      storeyHeight: undefined,
       modelUrl: undefined,
       modelScaleX: 1,
       modelScaleY: 1,
@@ -343,11 +341,6 @@ class VectorProperties {
 
   private _storeyHeightsBelowGround: number[];
 
-  /**
-   * @deprecated v3.8
-   */
-  private _storeyHeight: number | undefined;
-
   private _modelUrl: string | undefined;
 
   private _modelScaleX: number;
@@ -441,11 +434,6 @@ class VectorProperties {
       defaultValues.storeyHeightsBelowGround,
     );
 
-    this._storeyHeight = parseNumber(
-      options.storeyHeight,
-      defaultValues.storeyHeight,
-    );
-
     this._modelUrl = options.modelUrl ?? defaultValues.modelUrl;
 
     this._modelScaleX = parseNumber(
@@ -738,26 +726,6 @@ class VectorProperties {
     );
   }
 
-  /**
-   * @deprecated v3.8
-   */
-  get storeyHeight(): number | undefined {
-    return this._storeyHeight;
-  }
-
-  /**
-   * @param  value
-   * @deprecated v3.8
-   */
-  set storeyHeight(value: number | undefined) {
-    if (value !== this._storeyHeight) {
-      getLogger().deprecate('storeyHeight', 'use storeyHeightAboveGround');
-      check(value, Number);
-      this._storeyHeight = value;
-      this.propertyChanged.raiseEvent(['storeyHeight']);
-    }
-  }
-
   get modelUrl(): string | undefined {
     return this._modelUrl;
   }
@@ -1199,18 +1167,6 @@ class VectorProperties {
       }
     }
 
-    if ('storeyHeight' in options) {
-      const parsedStoreyHeight = parseNumber(
-        options.storeyHeight,
-        defaultValues.storeyHeight,
-      );
-      if (parsedStoreyHeight !== this._storeyHeight) {
-        getLogger().deprecate('storeyHeight', 'use storeyHeightAboveGround');
-        this._storeyHeight = parsedStoreyHeight;
-        changedProperties.push('storeyHeight');
-      }
-    }
-
     if ('modelUrl' in options) {
       if (options.modelUrl !== this._modelUrl) {
         this._modelUrl = options.modelUrl ?? '';
@@ -1311,7 +1267,6 @@ class VectorProperties {
       storeysBelowGround: this.storeysBelowGround,
       storeyHeightsAboveGround: this.storeyHeightsAboveGround,
       storeyHeightsBelowGround: this.storeyHeightsBelowGround,
-      storeyHeight: this.storeyHeight,
       modelUrl: this.modelUrl,
       modelScaleX: this.modelScaleX,
       modelScaleY: this.modelScaleY,
@@ -1394,9 +1349,6 @@ class VectorProperties {
     ) {
       vcsMeta.storeyHeightsBelowGround = this.storeyHeightsBelowGround;
     }
-    if (this.storeyHeight !== defaultValues.storeyHeight) {
-      vcsMeta.storeyHeight = this.storeyHeight;
-    }
     if (this.modelUrl !== defaultValues.modelUrl) {
       vcsMeta.modelUrl = this.modelUrl;
     }

package/src/layer/vectorTileLayer.ts

@@ -102,6 +102,7 @@ export interface VectorTileImplementation extends FeatureLayerImplementation {
 
 /**
  * VectorTileLayer Layer for tiled vector Data. Can be connected to data with a TileProvider
+ * @group Layer
  */
 class VectorTileLayer extends FeatureLayer<
   VectorTileOpenlayersImpl | VectorRasterTileCesiumImpl

package/src/layer/wfsLayer.ts

@@ -20,6 +20,9 @@ export type WFSOptions = VectorOptions & {
   getFeatureOptions?: Record<string, unknown>;
 };
 
+/**
+ * @group Layer
+ */
 class WFSLayer extends VectorLayer {
   static get className(): string {
     return 'WFSLayer';

package/src/layer/wmsLayer.ts

@@ -54,6 +54,7 @@ export type WMSOptions = RasterLayerOptions & {
 
 /**
  * WmsLayer layer for Cesium and OpenlayersMap
+ * @group Layer
  */
 class WMSLayer extends RasterLayer<WmsCesiumImpl | WmsOpenlayersImpl> {
   static get className(): string {

package/src/layer/wmtsLayer.ts

@@ -59,6 +59,9 @@ function getMatrixIds(
   });
 }
 
+/**
+ * @group Layer
+ */
 class WMTSLayer extends RasterLayer<WmtsCesiumImpl | WmtsOpenlayersImpl> {
   static get className(): string {
     return 'WMTSLayer';

package/src/map/baseOLMap.ts

@@ -42,6 +42,9 @@ export function ensureLayerInCollection(
   }
 }
 
+/**
+ * @group Map
+ */
 class BaseOLMap extends VcsMap<OLLayer> {
   static get className(): string {
     return 'BaseOLMap';

package/src/map/cesiumMap.ts

@@ -74,6 +74,12 @@ export type CesiumMapOptions = VcsMapOptions & {
    * the color of the globe, if no image is provided
    */
   globeColor?: string;
+
+  /**
+   * use Original Cesium Shader, otherwise the VCS Customized Shader will be used.
+   * This is a global Setting for all VCMap Instances on the same page.
+   */
+  useOriginalCesiumShader?: boolean;
 };
 
 export type CesiumMapEvent = {
@@ -265,6 +271,7 @@ export type CesiumVisualisationType =
 
 /**
  * Cesium Globe Map Class (3D map)
+ * @group Map
  */
 class CesiumMap extends VcsMap<CesiumVisualisationType> {
   static get className(): string {
@@ -279,6 +286,7 @@ class CesiumMap extends VcsMap<CesiumVisualisationType> {
       webGLaa: false,
       cameraLimiter: undefined,
       globeColor: '#3f47cc',
+      useOriginalCesiumShader: false,
     };
   }
 
@@ -334,6 +342,8 @@ class CesiumMap extends VcsMap<CesiumVisualisationType> {
 
   private _lastEventFrameNumber: number | null;
 
+  private _useOriginalCesiumShader: boolean;
+
   constructor(options: CesiumMapOptions) {
     super(options);
 
@@ -366,6 +376,11 @@ class CesiumMap extends VcsMap<CesiumVisualisationType> {
 
     this.webGLaa = parseBoolean(options.webGLaa, defaultOptions.webGLaa);
 
+    this._useOriginalCesiumShader = parseBoolean(
+      options.useOriginalCesiumShader,
+      defaultOptions.useOriginalCesiumShader,
+    );
+
     this.globeColor = Color.fromCssColorString(
       options.globeColor || (defaultOptions.globeColor as string),
     );
@@ -578,6 +593,17 @@ class CesiumMap extends VcsMap<CesiumVisualisationType> {
 
   initialize(): Promise<void> {
     if (!this.initialized) {
+      if (!this._useOriginalCesiumShader) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        globalThis.useVcsCustomShading = true;
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+      } else if (globalThis.useVcsCustomShading) {
+        console.error(
+          'Cannot activate Original Cesium Shader, flag to use VCS Shader is already set by another Cesium Map or VCMap Instance',
+        );
+      }
       this._cesiumWidget = new CesiumWidget(this.mapElement, {
         requestRenderMode: false,
         scene3DOnly: true,

package/src/map/obliqueMap.ts

@@ -69,6 +69,9 @@ export function getMercatorViewpointCenter(viewpoint: Viewpoint): Coordinate {
   return transform(gpWGS84, wgs84Projection.proj, mercatorProjection.proj);
 }
 
+/**
+ * @group Map
+ */
 class ObliqueMap extends BaseOLMap {
   static get className(): string {
     return 'ObliqueMap';

package/src/map/openlayersMap.ts

@@ -14,6 +14,9 @@ export type OpenlayersOptions = VcsMapOptions & {
   fixedNorthOrientation?: boolean;
 };
 
+/**
+ * @group Map
+ */
 class OpenlayersMap extends BaseOLMap {
   static get className(): string {
     return 'OpenlayersMap';

package/src/map/vcsMap.ts

@@ -40,6 +40,7 @@ export type VcsMapRenderEvent<V extends VisualisationType> = {
 
 /**
  * Map Base Class, each different map is derived from this abstract base class.
+ * @group Map
  */
 class VcsMap<
   V extends VisualisationType = VisualisationType,

package/src/ol/geojson.d.ts

@@ -1,5 +1,4 @@
 import { GeoJsonProperties, Geometry } from 'geojson';
-import type { StyleItemOptions } from '../style/styleItem.js';
 import type { VcsMeta } from '../layer/vectorProperties.js';
 import { FeatureStoreLayerState } from '../layer/featureStoreLayerState.js';
 
@@ -16,10 +15,6 @@ declare module 'geojson' {
     id?: string | number;
     radius?: G extends Point ? number : never;
     vcsMeta?: VcsMeta;
-    /**
-     * @deprecated
-     */
-    vcsStyle?: StyleItemOptions;
     state?: FeatureStoreLayerState;
   }
 
@@ -29,6 +24,5 @@ declare module 'geojson' {
       | { type: 'EPSG'; properties: { code: string } };
     vcsMeta?: VcsMeta;
     vcsEmbeddedIcons?: string[];
-    vcsStyle?: StyleItemOptions;
   }
 }

package/src/ol/ol.d.ts

@@ -22,10 +22,7 @@ import {
   originalFeatureSymbol,
 } from '../layer/vectorSymbols.js';
 import { vcsLayerName } from '../layer/layerSymbols.js';
-import {
-  isProvidedFeature,
-  showProvidedFeature,
-} from '../featureProvider/featureProviderSymbols.js';
+import { isProvidedFeature } from '../featureProvider/featureProviderSymbols.js';
 import {
   globalHidden,
   hidden,
@@ -90,7 +87,6 @@ declare module 'ol/index.js' {
     [vectorStyleSymbol]?: VectorStyleItem;
     [featureArcStruct]?: ArcStruct;
     [isProvidedFeature]?: boolean;
-    [showProvidedFeature]?: boolean;
     [globalHidden]?: boolean;
     [hidden]?: boolean;
     [highlighted]?: VectorStyleItem;

package/src/style/declarativeStyleItem.ts

@@ -90,6 +90,7 @@ function addCustomProperty(
 
 /**
  * Style Object {@link https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling}
+ * @group Style
  */
 class DeclarativeStyleItem extends StyleItem {
   static get className(): string {
@@ -220,9 +221,7 @@ class DeclarativeStyleItem extends StyleItem {
 
   private _styleLineString(feature: Feature): Style {
     const style = new Style({});
-    const isExtruded = (!!feature.get('olcs_extrudedHeight') ||
-      (feature.get('olcs_storeyHeight') &&
-        feature.get('olcs_storeyNumber'))) as boolean;
+    const isExtruded = !!feature.get('olcs_extrudedHeight');
     const color = this.cesiumStyle.color
       ? this.cesiumStyle.color.evaluate<Color>(feature, scratchColor)
       : Color.WHITE;