@vcmap/core 6.3.0-rc.3 → 6.3.0

package/src/layer/openlayers/mapboxStyleOpenlayersImpl.ts

@@ -0,0 +1,68 @@
+import type LayerGroup from 'ol/layer/Group.js';
+import { SplitDirection } from '@vcmap-cesium/engine';
+import { unByKey } from 'ol/Observable.js';
+import type { EventsKey } from 'ol/events.js';
+import type OpenlayersMap from '../../map/openlayersMap.js';
+import type { MapboxStyleLayerImplementationOptions } from '../cesium/mapboxStyleCesiumImpl.js';
+import type { OLLayerLike } from '../../map/baseOLMap.js';
+import LayerOpenlayersImpl from './layerOpenlayersImpl.js';
+
+class MapboxVectorTileOpenlayersImpl extends LayerOpenlayersImpl {
+  static get className(): string {
+    return 'MapboxVectorTileOpenlayersImpl';
+  }
+
+  private _styledMapboxLayerGroup: LayerGroup;
+
+  private _removeChildLayerListeners: (() => void) | null = null;
+
+  constructor(
+    map: OpenlayersMap,
+    options: MapboxStyleLayerImplementationOptions,
+  ) {
+    super(map, options);
+    this._styledMapboxLayerGroup = options.styledMapboxLayerGroup;
+  }
+
+  getOLLayer(): OLLayerLike {
+    return this._styledMapboxLayerGroup as OLLayerLike;
+  }
+
+  updateSplitDirection(splitDirection: SplitDirection): void {
+    this.splitDirection = splitDirection;
+    if (this.initialized) {
+      this._removeChildLayerListeners?.();
+      this._removeChildLayerListeners = null;
+
+      if (splitDirection !== SplitDirection.NONE) {
+        const childLayers = this._styledMapboxLayerGroup.getLayersArray();
+        const listenerKeys: EventsKey[] = [];
+        childLayers.forEach((layer) => {
+          listenerKeys.push(
+            layer.on('prerender', this._splitPreRender.bind(this)),
+          );
+          listenerKeys.push(
+            layer.on('postrender', this._splitPostReder.bind(this)),
+          );
+          layer.changed();
+        });
+        this._removeChildLayerListeners = (): void => {
+          unByKey(listenerKeys);
+        };
+      } else {
+        const childLayers = this._styledMapboxLayerGroup.getLayersArray();
+        childLayers.forEach((layer) => {
+          layer.changed();
+        });
+      }
+    }
+  }
+
+  destroy(): void {
+    this._removeChildLayerListeners?.();
+    this._removeChildLayerListeners = null;
+    super.destroy();
+  }
+}
+
+export default MapboxVectorTileOpenlayersImpl;

package/src/map/baseCesiumMap.ts

@@ -21,7 +21,9 @@ import {
   ScreenSpaceEventType,
   type TerrainProvider,
 } from '@vcmap-cesium/engine';
+import { parseBoolean } from '@vcsuite/parsers';
 import type { Coordinate } from 'ol/coordinate.js';
+import type { VcsMapOptions } from './vcsMap.js';
 import VcsMap from './vcsMap.js';
 import type Layer from '../layer/layer.js';
 import type LayerCollection from '../util/layerCollection.js';
@@ -36,6 +38,13 @@ import Projection from '../util/projection.js';
 
 RequestScheduler.maximumRequestsPerServer = 12;
 
+export type BaseCesiumMapOptions = VcsMapOptions & {
+  /**
+   * If true, ancestors will be preloaded
+   */
+  preloadAncestors?: boolean;
+};
+
 /**
  * Ensures, a primitive/imageryLayer/entity is part of a collection and placed at the correct location
  * @param  cesiumCollection
@@ -148,18 +157,48 @@ export default class BaseCesiumMap extends VcsMap<CesiumVisualisationType> {
     return 'BaseCesiumMap';
   }
 
+  static getDefaultOptions(): BaseCesiumMapOptions {
+    return {
+      ...VcsMap.getDefaultOptions(),
+      preloadAncestors: false,
+    };
+  }
+
   protected _cesiumWidget: CesiumWidget | null = null;
 
   protected _terrainProvider: TerrainProvider | null | undefined = null;
 
   private _screenSpaceListener: (() => void) | undefined;
 
+  private _preloadAncestors = false;
+
   screenSpaceEventHandler: ScreenSpaceEventHandler | null = null;
 
   defaultTerrainProvider: TerrainProvider | null = null;
 
   protected _listeners: (() => void)[] = [];
 
+  constructor(options: BaseCesiumMapOptions) {
+    const defaultOptions = BaseCesiumMap.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
+
+    this._preloadAncestors = parseBoolean(
+      options.preloadAncestors,
+      defaultOptions.preloadAncestors,
+    );
+  }
+
+  get preloadAncestors(): boolean {
+    return this._preloadAncestors;
+  }
+
+  set preloadAncestors(value: boolean) {
+    this._preloadAncestors = value;
+    if (this._cesiumWidget) {
+      this._cesiumWidget.scene.globe.preloadAncestors = value;
+    }
+  }
+
   get terrainProvider(): TerrainProvider | null | undefined {
     return this._terrainProvider;
   }
@@ -185,6 +224,7 @@ export default class BaseCesiumMap extends VcsMap<CesiumVisualisationType> {
       ),
     );
 
+    this._cesiumWidget.scene.globe.preloadAncestors = this.preloadAncestors;
     this._cesiumWidget.scene.frameState.creditDisplay.update = (): void => {};
     this._cesiumWidget.scene.frameState.creditDisplay.beginFrame =
       (): void => {};
@@ -453,6 +493,13 @@ export default class BaseCesiumMap extends VcsMap<CesiumVisualisationType> {
     return this._cesiumWidget?.scene;
   }
 
+  /**
+   * defines whether ancestors are preloaded or not
+   */
+  setPreloadAncestors(value: boolean): void {
+    this.preloadAncestors = value;
+  }
+
   protected _indexChangedOnVisualization(vis: CesiumVisualisationType): void {
     if (vis instanceof PrimitiveCollection) {
       indexChangedOnPrimitive(
@@ -579,6 +626,16 @@ export default class BaseCesiumMap extends VcsMap<CesiumVisualisationType> {
     }
   }
 
+  toJSON(
+    defaultOptions = BaseCesiumMap.getDefaultOptions(),
+  ): BaseCesiumMapOptions {
+    const config: BaseCesiumMapOptions = super.toJSON(defaultOptions);
+    if (this.preloadAncestors !== defaultOptions.preloadAncestors) {
+      config.preloadAncestors = this.preloadAncestors;
+    }
+    return config;
+  }
+
   override destroy(): void {
     this._listeners.forEach((cb) => {
       cb();

package/src/map/baseOLMap.ts

@@ -1,12 +1,12 @@
 import { Cartesian2 } from '@vcmap-cesium/engine';
 import { unByKey } from 'ol/Observable.js';
 import OLMap from 'ol/Map.js';
+import type OLLayer from 'ol/layer/Layer.js';
+import type OLLayerGroup from 'ol/layer/Group.js';
 import { defaults as defaultInteractions } from 'ol/interaction.js';
 import type { Collection as OLCollection, MapBrowserEvent } from 'ol';
-import type { Layer as OLLayer } from 'ol/layer.js';
 import type { EventsKey } from 'ol/events.js';
 import type { Coordinate } from 'ol/coordinate.js';
-
 import VcsMap from './vcsMap.js';
 import { vcsLayerName } from '../layer/layerSymbols.js';
 import {
@@ -20,22 +20,24 @@ import type Layer from '../layer/layer.js';
 import type { DisableMapControlOptions } from '../util/mapCollection.js';
 import { vectorClusterGroupName } from '../vectorCluster/vectorClusterSymbols.js';
 
+export type OLLayerLike = OLLayer | OLLayerGroup;
+
 function ensureLayerInCollection(
-  layers: OLCollection<OLLayer>,
-  layer: OLLayer,
+  layers: OLCollection<OLLayerLike>,
+  layer: OLLayerLike,
   layerCollection: LayerCollection,
 ): void {
   const sortedVectorClusterGroups = [
     ...layerCollection.vectorClusterGroups,
   ].sort((a, b) => a.zIndex - b.zIndex);
 
-  const getIndexOfOlLayer = (olL: OLLayer): number => {
+  const getIndexOfOlLayer = (olL: OLLayerLike): number => {
     let layerIndex;
     let clusterIndex = 0;
-    if (olL[vectorClusterGroupName]) {
-      const clusterGroup = layerCollection.vectorClusterGroups.getByKey(
-        olL[vectorClusterGroupName],
-      )!;
+    const clusterName = (olL as OLLayer)[vectorClusterGroupName];
+    if (clusterName) {
+      const clusterGroup =
+        layerCollection.vectorClusterGroups.getByKey(clusterName)!;
       layerIndex = layerCollection.findIndex(
         (l) => l.zIndex > clusterGroup.zIndex,
       );
@@ -90,7 +92,7 @@ function getPointerKeyType(button?: number): PointerKeyType {
 /**
  * @group Map
  */
-class BaseOLMap extends VcsMap<OLLayer> {
+class BaseOLMap extends VcsMap<OLLayerLike> {
   static get className(): string {
     return 'BaseOLMap';
   }
@@ -214,7 +216,7 @@ class BaseOLMap extends VcsMap<OLLayer> {
         const layers = (this._olMap as OLMap).getLayers();
         layers.remove(olLayer);
         ensureLayerInCollection(
-          layers as OLCollection<OLLayer>,
+          layers as OLCollection<OLLayerLike>,
           olLayer,
           this.layerCollection,
         );
@@ -226,11 +228,11 @@ class BaseOLMap extends VcsMap<OLLayer> {
    * Internal API for registering representations.
    * @param olLayer
    */
-  addOLLayer(olLayer: OLLayer): void {
+  addOLLayer(olLayer: OLLayerLike): void {
     if (this.validateVisualization(olLayer)) {
       this.addVisualization(olLayer);
       ensureLayerInCollection(
-        (this._olMap as OLMap).getLayers() as OLCollection<OLLayer>,
+        (this._olMap as OLMap).getLayers() as OLCollection<OLLayerLike>,
         olLayer,
         this.layerCollection,
       );
@@ -240,7 +242,7 @@ class BaseOLMap extends VcsMap<OLLayer> {
   /**
    * Internal API for deregistering representations.
    */
-  removeOLLayer(olLayer: OLLayer): void {
+  removeOLLayer(olLayer: OLLayerLike): void {
     this.removeVisualization(olLayer);
     if (this._olMap) {
       this._olMap.getLayers().remove(olLayer);

package/src/map/cesiumMap.ts

@@ -29,7 +29,11 @@ import {
 import type { Coordinate } from 'ol/coordinate.js';
 import { check, maybe } from '@vcsuite/check';
 import { parseBoolean, parseInteger, parseNumber } from '@vcsuite/parsers';
-import VcsMap, { type VcsMapOptions } from './vcsMap.js';
+import type {
+  BaseCesiumMapOptions,
+  CesiumVisualisationType,
+} from './baseCesiumMap.js';
+import BaseCesiumMap from './baseCesiumMap.js';
 import type Viewpoint from '../util/viewpoint.js';
 import Projection, { mercatorProjection } from '../util/projection.js';
 import { getHeightFromTerrainProvider } from '../layer/terrainHelpers.js';
@@ -41,9 +45,6 @@ import type LayerCollection from '../util/layerCollection.js';
 import VcsEvent from '../vcsEvent.js';
 import type { DisableMapControlOptions } from '../util/mapCollection.js';
 import { vectorClusterGroupName } from '../vectorCluster/vectorClusterSymbols.js';
-import BaseCesiumMap, {
-  type CesiumVisualisationType,
-} from './baseCesiumMap.js';
 
 /**
  * @param  dataSourceCollection
@@ -120,7 +121,7 @@ function indexChangedOnDataSource(
   );
 }
 
-export type CesiumMapOptions = VcsMapOptions & {
+export type CesiumMapOptions = BaseCesiumMapOptions & {
   /**
    * if true, lighting will be activated.
    */
@@ -203,7 +204,7 @@ class CesiumMap extends BaseCesiumMap {
 
   static getDefaultOptions(): CesiumMapOptions {
     return {
-      ...VcsMap.getDefaultOptions(),
+      ...BaseCesiumMap.getDefaultOptions(),
       enableLightning: true,
       tileCacheSize: 1,
       webGLaa: false,

package/src/map/panoramaMap.ts

@@ -6,7 +6,6 @@ import {
   Math as CesiumMath,
 } from '@vcmap-cesium/engine';
 import type { Coordinate } from 'ol/coordinate.js';
-import VcsMap, { type VcsMapOptions } from './vcsMap.js';
 import type { PanoramaImage } from '../panorama/panoramaImage.js';
 import { mapClassRegistry } from '../classRegistry.js';
 import type { PanoramaImageView } from '../panorama/panoramaImageView.js';
@@ -19,9 +18,10 @@ import Projection from '../util/projection.js';
 import { defaultCursorColor } from '../panorama/panoramaTileMaterial.js';
 import LayerState from '../layer/layerState.js';
 import type PanoramaDatasetLayer from '../layer/panoramaDatasetLayer.js';
+import type { BaseCesiumMapOptions } from './baseCesiumMap.js';
 import BaseCesiumMap from './baseCesiumMap.js';
 
-export type PanoramaMapOptions = VcsMapOptions & {
+export type PanoramaMapOptions = BaseCesiumMapOptions & {
   /**
    * Css color string to use for the overlay NaN color.
    */
@@ -43,7 +43,7 @@ export default class PanoramaMap extends BaseCesiumMap {
 
   static getDefaultOptions(): PanoramaMapOptions {
     return {
-      ...VcsMap.getDefaultOptions(),
+      ...BaseCesiumMap.getDefaultOptions(),
       overlayNaNColor: 'rgba(255, 0, 0, 1)',
       cursorColor: defaultCursorColor,
       fallbackToCurrentMap: false,

package/src/map/vcsMap.ts

@@ -3,9 +3,9 @@ import { getLogger as getLoggerByName } from '@vcsuite/logger';
 import { parseBoolean } from '@vcsuite/parsers';
 import { v4 as uuidv4 } from 'uuid';
 import type { MapEvent as OLMapEvent } from 'ol';
-import type { Layer as OLLayer } from 'ol/layer.js';
+import type OLLayer from 'ol/layer/Layer.js';
+import OLLayerGroup from 'ol/layer/Group.js';
 import type { Coordinate } from 'ol/coordinate.js';
-
 import { check, is, maybe, oneOf } from '@vcsuite/check';
 import type { VcsObjectOptions } from '../vcsObject.js';
 import VcsObject from '../vcsObject.js';
@@ -19,6 +19,7 @@ import type Viewpoint from '../util/viewpoint.js';
 import type Layer from '../layer/layer.js';
 import type { MapEvent } from '../interaction/abstractInteraction.js';
 import type { DisableMapControlOptions } from '../util/mapCollection.js';
+import type { OLLayerLike } from './baseOLMap.js';
 import type VectorClusterGroup from '../vectorCluster/vectorClusterGroup.js';
 import { vectorClusterGroupName } from '../vectorCluster/vectorClusterSymbols.js';
 import type { CesiumVisualisationType } from './baseCesiumMap.js';
@@ -50,11 +51,11 @@ export type VcsMapOptions = VcsObjectOptions & {
   layerTypes?: string[];
 };
 
-export type VisualisationType = CesiumVisualisationType | OLLayer;
+export type VisualisationType = CesiumVisualisationType | OLLayerLike;
 
 export type VcsMapRenderEvent<V extends VisualisationType> = {
   map: VcsMap;
-  originalEvent: V extends OLLayer ? OLMapEvent : CesiumMapEvent;
+  originalEvent: V extends OLLayerLike ? OLMapEvent : CesiumMapEvent;
 };
 
 /**
@@ -421,18 +422,23 @@ class VcsMap<
     [vcsLayerName]?: string;
     [vectorClusterGroupName]?: string;
   } {
-    const vectorCluster = (item as OLLayer)[vectorClusterGroupName];
-    if (vectorCluster) {
-      return this.layerCollection.vectorClusterGroups.hasKey(
-        vectorCluster,
-      ) as boolean;
+    if (Object.hasOwn(item, vectorClusterGroupName)) {
+      if (item instanceof OLLayerGroup) {
+        return false;
+      } else {
+        const vectorCluster = (item as OLLayer)[vectorClusterGroupName];
+        if (vectorCluster) {
+          return this.layerCollection.vectorClusterGroups.hasKey(
+            vectorCluster,
+          ) as boolean;
+        }
+      }
     }
     const layerName = item[vcsLayerName];
     if (layerName == null) {
       this.getLogger().warning('item is missing vcsLayerName symbol');
       return false;
     }
-
     return this.layerCollection.hasKey(layerName) as boolean;
   }
 

package/src/ol/ol.d.ts

@@ -26,7 +26,11 @@ import type {
   panoramaFeature,
   primitives,
 } from '../layer/vectorSymbols.js';
-import type { i3sData, vcsLayerName } from '../layer/layerSymbols.js';
+import type {
+  allowPicking,
+  i3sData,
+  vcsLayerName,
+} from '../layer/layerSymbols.js';
 import type {
   isProvidedFeature,
   isProvidedClusterFeature,
@@ -164,8 +168,13 @@ declare module 'ol/style.js' {
 declare module 'ol/layer.js' {
   interface Layer {
     [vcsLayerName]: string;
+    [allowPicking]?: boolean;
     [vectorClusterGroupName]?: string;
   }
+
+  interface Group {
+    [vcsLayerName]: string;
+  }
 }
 
 declare module 'ol/source.js' {