@vcmap/core 6.2.4 → 6.3.0-rc.2

package/src/layer/layer.ts

@@ -11,7 +11,16 @@ import { layerClassRegistry } from '../classRegistry.js';
 import GlobalHider from './globalHider.js';
 import type VcsMap from '../map/vcsMap.js';
 import type LayerImplementation from './layerImplementation.js';
-import type AbstractFeatureProvider from '../featureProvider/abstractFeatureProvider.js';
+import {
+  type default as AbstractFeatureProvider,
+  type AbstractFeatureProviderOptions,
+} from '../featureProvider/abstractFeatureProvider.js';
+import type {
+  // eslint-disable-next-line import/no-named-default
+  default as AbstractAttributeProvider,
+  AbstractAttributeProviderOptions,
+} from '../featureProvider/abstractAttributeProvider.js';
+import { getProviderForOption } from '../featureProvider/featureProviderFactory.js';
 
 export type CopyrightOptions = {
   provider?: string;
@@ -58,6 +67,18 @@ export type LayerOptions = VcsObjectOptions & {
    * Optional Request Headers which will be sent with each request.
    */
   headers?: Record<string, string>;
+  /**
+   * if true, the layer types of the map will be ignored when checking if the layer is supported
+   */
+  ignoreMapLayerTypes?: boolean;
+  /**
+   * An optional feature or attribute provider to provide or augment features on click events.
+   */
+  featureProvider?:
+    | AbstractFeatureProvider
+    | AbstractAttributeProvider
+    | AbstractFeatureProviderOptions
+    | AbstractAttributeProviderOptions;
 };
 
 export type LayerImplementationOptions = {
@@ -92,7 +113,9 @@ class Layer<
       copyright: undefined,
       datasourceId: undefined,
       headers: undefined,
+      ignoreMapLayerTypes: false,
       zIndex: 0,
+      featureProvider: undefined,
     };
   }
 
@@ -108,12 +131,9 @@ class Layer<
 
   private _initialized: boolean;
 
-  /**
-   * if provided, the layer will only be shown in the given MapNames.
-   * An empty array will show the layer in all configured maps.
-   * Changes require calling layer.redraw() to take effect.
-   */
-  mapNames: string[];
+  private _mapNames: string[];
+
+  readonly mapNamesChanged = new VcsEvent<string[]>();
 
   /**
    * The class names of the supported maps.
@@ -145,9 +165,12 @@ class Layer<
 
   copyright: CopyrightOptions | undefined;
 
-  private _implementations: Map<VcsMap, I[]>;
+  private _implementations = new Map<
+    VcsMap,
+    { implementations: I[]; destroy: () => void }
+  >();
 
-  private _activeMaps: Set<VcsMap>;
+  private _activeMaps = new Set<VcsMap>();
 
   /**
    * Event raised, if the layers state changes. Is passed the LayerState as its only parameter
@@ -155,9 +178,12 @@ class Layer<
   stateChanged: VcsEvent<LayerState>;
 
   /**
-   * An optional feature provider to provider features based on click events.
+   * An optional feature or attribute provider to provide or augment features on click events.
    */
-  featureProvider: AbstractFeatureProvider | undefined;
+  featureProvider:
+    | AbstractFeatureProvider
+    | AbstractAttributeProvider
+    | undefined;
 
   private _locale: string;
 
@@ -169,9 +195,11 @@ class Layer<
    */
   datasourceId?: string;
 
+  private _ignoreMapLayerTypes: boolean;
+
   constructor(options: LayerOptions) {
-    super(options);
     const defaultOptions = Layer.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
 
     this.extent = options.extent ? new Extent(options.extent) : null;
 
@@ -191,7 +219,8 @@ class Layer<
 
     this._initialized = false;
 
-    this.mapNames = options.mapNames ?? (defaultOptions.mapNames as string[]);
+    this._mapNames =
+      options.mapNames?.slice() ?? (defaultOptions.mapNames as string[]);
 
     this._supportedMaps = [];
 
@@ -215,19 +244,20 @@ class Layer<
 
     this.copyright = options.copyright || defaultOptions.copyright;
 
-    this._implementations = new Map();
-
-    this._activeMaps = new Set();
-
     this.stateChanged = new VcsEvent();
 
-    this.featureProvider = undefined;
-
     this._locale = 'en';
 
     this.datasourceId = options.datasourceId || defaultOptions.datasourceId;
 
     this._headers = structuredClone(options.headers);
+
+    this._ignoreMapLayerTypes = parseBoolean(
+      options.ignoreMapLayerTypes,
+      defaultOptions.ignoreMapLayerTypes,
+    );
+
+    this.featureProvider = getProviderForOption(options.featureProvider);
   }
 
   /**
@@ -304,6 +334,31 @@ class Layer<
     return this._globalHider;
   }
 
+  get mapNames(): string[] {
+    return this._mapNames.slice();
+  }
+
+  /**
+   * if provided, the layer will only be shown in the given MapNames.
+   * An empty array will show the layer in all configured maps.
+   * Changes will call reload on the layer.
+   */
+  set mapNames(mapNames: string[]) {
+    check(mapNames, [String]);
+
+    if (
+      mapNames.length !== this._mapNames.length ||
+      !mapNames.every((m) => this._mapNames.includes(m))
+    ) {
+      this._mapNames = mapNames.slice();
+      this.mapNamesChanged.raiseEvent(this._mapNames.slice());
+      this.forceRedraw().catch((err: unknown) => {
+        this.getLogger().error('failed to reload after mapNames setting');
+        this.getLogger().error(String(err));
+      });
+    }
+  }
+
   setGlobalHider(globalHider?: GlobalHider): void {
     check(globalHider, maybe(GlobalHider));
 
@@ -400,6 +455,28 @@ class Layer<
     }
   }
 
+  get ignoreMapLayerTypes(): boolean {
+    return this._ignoreMapLayerTypes;
+  }
+
+  /**
+   * if set to true, the layer types of the map will be ignored when checking if the layer is supported.
+   * Changes will call reload on the layer.
+   */
+  set ignoreMapLayerTypes(value: boolean) {
+    check(value, Boolean);
+
+    if (this._ignoreMapLayerTypes !== value) {
+      this._ignoreMapLayerTypes = value;
+      this.reload().catch((err: unknown) => {
+        this.getLogger().error(
+          'failed to reload after setting ignoreMapLayerTypes',
+        );
+        this.getLogger().error(String(err));
+      });
+    }
+  }
+
   /**
    * creates an array of layer implementations for the given map.
    * @param  _map Map
@@ -417,20 +494,61 @@ class Layer<
    */
   getImplementationsForMap(map: VcsMap): I[] {
     if (!this._implementations.has(map)) {
+      let currentlySupported = this.isSupported(map);
+      let destroy: () => void;
+      const layerTypesChangedListener = map.layerTypesChanged.addEventListener(
+        () => {
+          const nowSupported = this.isSupported(map);
+          if (currentlySupported !== nowSupported) {
+            currentlySupported = nowSupported;
+            // either destroy current implementation or remove the empty array for unsupported layers.
+            // either way we have to reset this map if the inclusion changes
+            destroy();
+
+            if (
+              this.initialized &&
+              map.active &&
+              (this.active || this.loading)
+            ) {
+              this.getImplementationsForMap(map);
+              if (nowSupported) {
+                this._activateImplsForMap(map).catch(() => {
+                  this.getLogger().error(
+                    `Layer ${this.name} could not activate impl for map ${map.name} after layerTypesChanged`,
+                  );
+                });
+              }
+            }
+          }
+        },
+      );
+      destroy = (): void => {
+        layerTypesChangedListener();
+        this._implementations.get(map)?.implementations?.forEach((i) => {
+          i.destroy();
+        });
+        this._implementations.delete(map);
+      };
+
       if (this.isSupported(map)) {
-        this._implementations.set(map, this.createImplementationsForMap(map));
+        this._implementations.set(map, {
+          implementations: this.createImplementationsForMap(map),
+          destroy,
+        });
       } else {
-        this._implementations.set(map, []);
+        this._implementations.set(map, { implementations: [], destroy });
       }
     }
-    return this._implementations.get(map)!;
+    return this._implementations.get(map)!.implementations;
   }
 
   /**
    * Returns all implementation of this layer for all maps
    */
   getImplementations(): I[] {
-    return [...this._implementations.values()].flat();
+    return [...this._implementations.values()].flatMap(
+      (i) => i.implementations,
+    );
   }
 
   getImplementationOptions(): LayerImplementationOptions {
@@ -529,10 +647,7 @@ class Layer<
    */
   removedFromMap(map: VcsMap): void {
     this._activeMaps.delete(map);
-    this.getImplementationsForMap(map).forEach((impl) => {
-      impl.destroy();
-    });
-    this._implementations.delete(map);
+    this._implementations.get(map)?.destroy();
   }
 
   /**
@@ -540,10 +655,23 @@ class Layer<
    * @param  map
    */
   isSupported(map: VcsMap): boolean {
+    if (!map) {
+      return false;
+    }
+
+    const isSupportedMap = (): boolean =>
+      this._supportedMaps.includes(map.className);
+
+    const isAllowedMapName = (): boolean =>
+      this._mapNames.length === 0 || this._mapNames.includes(map.name);
+
+    const isAllowedLayerType = (): boolean =>
+      this._ignoreMapLayerTypes ||
+      map.layerTypes.length === 0 ||
+      map.layerTypes.includes(this.className);
+
     return (
-      map &&
-      this._supportedMaps.includes(map.className) &&
-      (this.mapNames.length === 0 || this.mapNames.indexOf(map.name) >= 0)
+      !!map && isSupportedMap() && isAllowedMapName() && isAllowedLayerType()
     );
   }
 
@@ -556,9 +684,12 @@ class Layer<
         `Layer ${this.name} could not activate impl for map ${map.name}`,
       );
       this.getLogger().error(String(err));
-      this._implementations.set(map, []);
-      impls.forEach((i) => {
-        i.destroy();
+      this._implementations.get(map)?.destroy();
+      this._implementations.set(map, {
+        implementations: [],
+        destroy: () => {
+          this._implementations.delete(map);
+        },
       });
     }
   }
@@ -580,7 +711,7 @@ class Layer<
     }
 
     await Promise.all(
-      [...this._activeMaps].map((m) => this._activateImplsForMap(m)),
+      [...this._activeMaps.keys()].map((m) => this._activateImplsForMap(m)),
     );
     if (this._state !== LayerState.LOADING) {
       return;
@@ -653,9 +784,8 @@ class Layer<
     }
   }
 
-  toJSON(): LayerOptions {
-    const config: LayerOptions = super.toJSON();
-    const defaultOptions = Layer.getDefaultOptions();
+  toJSON(defaultOptions = Layer.getDefaultOptions()): LayerOptions {
+    const config: LayerOptions = super.toJSON(defaultOptions);
 
     if (this.activeOnStartup !== defaultOptions.activeOnStartup) {
       config.activeOnStartup = this.activeOnStartup;
@@ -665,8 +795,8 @@ class Layer<
       config.allowPicking = this.allowPicking;
     }
 
-    if (this.mapNames.length > 0) {
-      config.mapNames = this.mapNames.slice();
+    if (this._mapNames.length > 0) {
+      config.mapNames = this._mapNames.slice();
     }
 
     if (this.hiddenObjectIds.length > 0) {
@@ -701,6 +831,14 @@ class Layer<
       config.zIndex = this._zIndex;
     }
 
+    if (this._ignoreMapLayerTypes !== defaultOptions.ignoreMapLayerTypes) {
+      config.ignoreMapLayerTypes = this._ignoreMapLayerTypes;
+    }
+
+    if (this.featureProvider) {
+      config.featureProvider = this.featureProvider.toJSON();
+    }
+
     return config;
   }
 
@@ -723,6 +861,7 @@ class Layer<
     this.stateChanged.destroy();
     this.zIndexChanged.destroy();
     this.exclusiveGroupsChanged.destroy();
+    this.mapNamesChanged.destroy();
   }
 }
 

package/src/layer/layerSymbols.ts

@@ -7,3 +7,8 @@ export const vcsLayerName: unique symbol = Symbol('vcsLayerName');
  * Symbol added to Cesium3DTilesets to suppress picking.
  */
 export const allowPicking: unique symbol = Symbol('allowPicking');
+
+/**
+ * Symbol to store the I3SNode and the cartesian position on features created from non Cesium3DTileset sources.
+ */
+export const i3sData: unique symbol = Symbol('i3sData');

package/src/layer/openStreetMapLayer.ts

@@ -12,6 +12,8 @@ import { layerClassRegistry } from '../classRegistry.js';
 import type { RasterLayerImplementationOptions } from './rasterLayer.js';
 import { TilingScheme } from './rasterLayer.js';
 import type VcsMap from '../map/vcsMap.js';
+import PanoramaMap from '../map/panoramaMap.js';
+import BaseCesiumMap from '../map/baseCesiumMap.js';
 
 export type OpenStreetMapOptions = LayerOptions & {
   /**
@@ -102,11 +104,15 @@ class OpenStreetMapLayer
    */
   imageryLayerOptions: ImageryLayer.ConstructorOptions | undefined;
 
-  protected _supportedMaps = [CesiumMap.className, OpenlayersMap.className];
+  protected _supportedMaps = [
+    CesiumMap.className,
+    OpenlayersMap.className,
+    PanoramaMap.className,
+  ];
 
   constructor(options: OpenStreetMapOptions) {
-    super(options);
     const defaultOptions = OpenStreetMapLayer.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
     this._splitDirection = SplitDirection.NONE;
 
     if (options.splitDirection) {
@@ -188,7 +194,7 @@ class OpenStreetMapLayer
       ];
     }
 
-    if (map instanceof CesiumMap) {
+    if (map instanceof BaseCesiumMap) {
       return [
         new OpenStreetMapCesiumImpl(map, this.getImplementationOptions()),
       ];
@@ -196,9 +202,10 @@ class OpenStreetMapLayer
     return [];
   }
 
-  toJSON(): OpenStreetMapOptions {
-    const config: OpenStreetMapOptions = super.toJSON();
-    const defaultOptions = OpenStreetMapLayer.getDefaultOptions();
+  toJSON(
+    defaultOptions = OpenStreetMapLayer.getDefaultOptions(),
+  ): OpenStreetMapOptions {
+    const config: OpenStreetMapOptions = super.toJSON(defaultOptions);
 
     if (this._splitDirection !== SplitDirection.NONE) {
       config.splitDirection =

package/src/layer/panorama/vectorPanoramaImpl.ts

@@ -0,0 +1,238 @@
+import { PrimitiveCollection, type SplitDirection } from '@vcmap-cesium/engine';
+import VectorSource from 'ol/source/Vector.js';
+import { unByKey } from 'ol/Observable.js';
+import type { Feature } from 'ol/index.js';
+import { vcsLayerName } from '../layerSymbols.js';
+import LayerImplementation from '../layerImplementation.js';
+import { synchronizeFeatureVisibilityWithSource } from '../vectorHelpers.js';
+import type { FeatureLayerImplementation } from '../featureLayer.js';
+import type { VectorImplementationOptions } from '../vectorLayer.js';
+import type VectorProperties from '../vectorProperties.js';
+import type StyleItem from '../../style/styleItem.js';
+import type FeatureVisibility from '../featureVisibility.js';
+import type GlobalHider from '../globalHider.js';
+import VectorContext from '../cesium/vectorContext.js';
+import {
+  createSourceVectorContextSync,
+  type SourceVectorContextSync,
+} from '../cesium/sourceVectorContextSync.js';
+import type PanoramaMap from '../../map/panoramaMap.js';
+import type { PanoramaImage } from '../../panorama/panoramaImage.js';
+import { cartesianToMercator } from '../../util/math.js';
+
+type PanoramaSourceSync = {
+  paused: boolean;
+  destroy: () => void;
+};
+
+function getImageExtent(
+  image: PanoramaImage,
+): [number, number, number, number] {
+  const center = cartesianToMercator(image.position);
+  const depth = image.maxDepth ?? 50;
+  return [
+    center[0] - depth,
+    center[1] - depth,
+    center[0] + depth,
+    center[1] + depth,
+  ];
+}
+
+function featureWithinImage(feature?: Feature, image?: PanoramaImage): boolean {
+  if (feature && image) {
+    const extent = getImageExtent(image);
+    return feature.getGeometry()?.intersectsExtent(extent) ?? false;
+  }
+  return false;
+}
+
+function setupMapSourceListeners(
+  map: PanoramaMap,
+  originalSource: VectorSource,
+  panoramaSource: VectorSource,
+): PanoramaSourceSync {
+  let paused = false;
+  const sourceListeners = [
+    originalSource.on('addfeature', (event) => {
+      if (
+        !paused &&
+        featureWithinImage(event.feature, map.currentPanoramaImage)
+      ) {
+        panoramaSource.addFeature(event.feature as Feature);
+      }
+    }),
+    originalSource.on('removefeature', (event) => {
+      panoramaSource.removeFeature(event.feature as Feature);
+    }),
+  ];
+
+  const setFeatures = (): void => {
+    panoramaSource.clear();
+    if (map.currentPanoramaImage) {
+      const extent = getImageExtent(map.currentPanoramaImage);
+      originalSource.getFeaturesInExtent(extent).forEach((f) => {
+        panoramaSource.addFeature(f);
+      });
+    }
+  };
+  const panoramaImageListener =
+    map.currentImageChanged.addEventListener(setFeatures);
+
+  return {
+    get paused(): boolean {
+      return paused;
+    },
+    set paused(p: boolean) {
+      paused = p;
+      if (!paused) {
+        setFeatures();
+      }
+    },
+    destroy: (): void => {
+      unByKey(sourceListeners);
+      panoramaImageListener();
+    },
+  };
+}
+
+/**
+ * represents a specific vector layer for cesium.
+ */
+export default class VectorPanoramaImpl
+  extends LayerImplementation<PanoramaMap>
+  implements FeatureLayerImplementation
+{
+  static get className(): string {
+    return 'VectorPanoramaImpl';
+  }
+
+  vectorProperties: VectorProperties;
+
+  source: VectorSource;
+
+  splitDirection: SplitDirection;
+
+  style: StyleItem;
+
+  featureVisibility: FeatureVisibility;
+
+  private _featureVisibilityListeners: (() => void)[] = [];
+
+  private _rootCollection: PrimitiveCollection;
+
+  private _context: VectorContext | null = null;
+
+  private _sourceVectorContextSync: SourceVectorContextSync | undefined;
+
+  private _sourceSync: PanoramaSourceSync;
+
+  globalHider: GlobalHider | undefined;
+
+  constructor(map: PanoramaMap, options: VectorImplementationOptions) {
+    super(map, options);
+
+    this.vectorProperties = options.vectorProperties;
+    this.source = new VectorSource();
+
+    this.splitDirection = options.splitDirection;
+    this.style = options.style;
+    this.featureVisibility = options.featureVisibility;
+
+    this._rootCollection = new PrimitiveCollection();
+    this._rootCollection[vcsLayerName] = options.name;
+    this.globalHider = options.globalHider;
+    this._sourceSync = setupMapSourceListeners(
+      map,
+      options.source,
+      this.source,
+    );
+    this._sourceSync.paused = true;
+  }
+
+  async initialize(): Promise<void> {
+    if (!this.initialized) {
+      this._context = new VectorContext(
+        this.map,
+        this._rootCollection,
+        this.splitDirection,
+      );
+      this.map.addPrimitiveCollection(this._rootCollection);
+      this._sourceVectorContextSync = createSourceVectorContextSync(
+        this.source,
+        this._context,
+        this.map.getCesiumWidget().scene,
+        this.style.style,
+        this.vectorProperties,
+      );
+    }
+    await super.initialize();
+    if (this.splitDirection) {
+      this.updateSplitDirection(this.splitDirection);
+    }
+  }
+
+  /**
+   * Forces a complete re-render of all features.
+   */
+  refresh(): void {
+    this._sourceVectorContextSync?.refresh();
+  }
+
+  async activate(): Promise<void> {
+    if (!this.active) {
+      await super.activate();
+      if (this.active) {
+        this._sourceVectorContextSync?.activate();
+        this._rootCollection.show = true;
+        if (this._featureVisibilityListeners.length === 0) {
+          this._featureVisibilityListeners =
+            synchronizeFeatureVisibilityWithSource(
+              this.featureVisibility,
+              this.source,
+              this.globalHider as GlobalHider,
+            );
+        }
+        this._sourceSync.paused = false;
+      }
+    }
+  }
+
+  deactivate(): void {
+    super.deactivate();
+    this._sourceVectorContextSync?.deactivate();
+    this._rootCollection.show = false;
+    this._featureVisibilityListeners.forEach((cb) => {
+      cb();
+    });
+    this._featureVisibilityListeners = [];
+    this._sourceSync.paused = true;
+  }
+
+  updateStyle(style: StyleItem, silent?: boolean): void {
+    this.style = style;
+    this._sourceVectorContextSync?.setStyle(style.style, silent);
+  }
+
+  updateSplitDirection(splitDirection: SplitDirection): void {
+    this.splitDirection = splitDirection;
+    if (this.initialized) {
+      this._context?.updateSplitDirection(splitDirection);
+    }
+  }
+
+  destroy(): void {
+    if (this.initialized) {
+      this._sourceVectorContextSync?.destroy();
+      this._context?.destroy();
+      this.map.removePrimitiveCollection(this._rootCollection);
+      this._rootCollection.destroy();
+    }
+    this._context = null;
+    this._featureVisibilityListeners.forEach((cb) => {
+      cb();
+    });
+    this._featureVisibilityListeners = [];
+    this._sourceSync.destroy();
+    super.destroy();
+  }
+}