@vcmap/core 6.2.4 → 6.3.0-rc.2

package/src/util/editor/interactions/mapInteractionController.ts

@@ -9,7 +9,8 @@ import { handlerSymbol, vertexSymbol } from '../editorSymbols.js';
 import type { EventAfterEventHandler } from '../../../interaction/abstractInteraction.js';
 import AbstractInteraction from '../../../interaction/abstractInteraction.js';
 import type BaseOLMap from '../../../map/baseOLMap.js';
-import type CesiumMap from '../../../map/cesiumMap.js';
+import CesiumMap from '../../../map/cesiumMap.js';
+import PanoramaMap from '../../../map/panoramaMap.js';
 
 function suspendOpenlayerMap(map: BaseOLMap): () => void {
   const dragPan = map
@@ -26,6 +27,13 @@ function suspendOpenlayerMap(map: BaseOLMap): () => void {
   return () => {};
 }
 
+function suspendPanoramaMap(map: PanoramaMap): () => void {
+  map.panoramaCameraController.enabled = false;
+  return () => {
+    map.panoramaCameraController.enabled = true;
+  };
+}
+
 type CachedScreenSpaceCameraControllerKeys =
   | 'lookEventTypes'
   | 'tiltEventTypes'
@@ -99,8 +107,10 @@ class MapInteractionController extends AbstractInteraction {
       ((event.feature as Feature)[vertexSymbol] ||
         (event.feature as Feature)[handlerSymbol])
     ) {
-      if (event.map.className === 'CesiumMap') {
+      if (event.map.className === CesiumMap.className) {
         this._clear = suspendCesiumMap(event.map as CesiumMap);
+      } else if (event.map.className === PanoramaMap.className) {
+        this._clear = suspendPanoramaMap(event.map as PanoramaMap);
       } else {
         this._clear = suspendOpenlayerMap(event.map as BaseOLMap);
       }

package/src/util/editor/interactions/translationSnapping.ts

@@ -19,6 +19,7 @@ import { vertexIndexSymbol } from '../editorSymbols.js';
 import { isVertex } from '../editorHelpers.js';
 import type { SnappingInteractionEvent } from '../editorSessionHelpers.js';
 import { alreadySnapped } from '../editorSessionHelpers.js';
+import PanoramaMap from '../../../map/panoramaMap.js';
 
 function getBearings(coordinates: Coordinate[], isPolygon: boolean): number[] {
   const length = isPolygon ? coordinates.length : coordinates.length - 1;
@@ -141,13 +142,14 @@ export default class TranslationSnapping extends AbstractInteraction {
       return Promise.resolve(event);
     }
 
+    const ctrlKey = event.key === ModificationKeyType.CTRL;
+    const useSnapping =
+      event.map.className === PanoramaMap.className ? ctrlKey : !ctrlKey;
+
     if (event.type === EventType.DRAGEND && this._lastCoordinate) {
       event.positionOrPixel = this._lastCoordinate;
       this._lastCoordinate = undefined;
-    } else if (
-      event.key !== ModificationKeyType.CTRL &&
-      isVertex(event.feature)
-    ) {
+    } else if (useSnapping && isVertex(event.feature)) {
       const index = event.feature[vertexIndexSymbol];
       if (event.type === EventType.DRAGSTART) {
         this._setCoordinates(index);

package/src/util/editor/selectFeaturesSession.ts

@@ -160,7 +160,7 @@ function startSelectFeaturesSession(
     interactionChain,
     removed: interactionRemoved,
     destroy: destroyInteractionChain,
-  } = setupInteractionChain(app.maps.eventHandler, interactionId);
+  } = setupInteractionChain(app.maps, interactionId);
 
   const highlightManager = createHighlightManager(layer, highlightStyle);
 

package/src/util/editor/transformation/create3DHandlers.ts

@@ -35,7 +35,7 @@ import {
 } from './transformationTypes.js';
 import Projection from '../../projection.js';
 import { mercatorToCartesian } from '../../math.js';
-import type CesiumMap from '../../../map/cesiumMap.js';
+import type BaseCesiumMap from '../../../map/baseCesiumMap.js';
 
 function setFeatureOnPrimitive(primitive: Primitive): void {
   if (primitive[handlerSymbol]) {
@@ -545,7 +545,7 @@ function createShowShadowPrimitive(
  * @param  mode
  */
 export default function create3DHandlers(
-  map: CesiumMap,
+  map: BaseCesiumMap,
   mode: TransformationMode,
 ): Handlers {
   const primitiveCollection = new PrimitiveCollection();

package/src/util/editor/transformation/transformationHandler.ts

@@ -8,7 +8,6 @@ import {
 } from 'ol/extent.js';
 import { HeightReference } from '@vcmap-cesium/engine';
 import Extent3D from '../../featureconverter/extent3D.js';
-import CesiumMap from '../../../map/cesiumMap.js';
 import BaseOLMap from '../../../map/baseOLMap.js';
 import create3DHandlers from './create3DHandlers.js';
 import create2DHandlers from './create2DHandlers.js';
@@ -28,6 +27,7 @@ import {
 } from '../../featureconverter/vectorHeightInfo.js';
 import { mercatorToCartographic } from '../../math.js';
 import { is2DLayout } from '../../geometryHelpers.js';
+import BaseCesiumMap from '../../../map/baseCesiumMap.js';
 
 type FeatureCenterInfo = {
   center: Coordinate;
@@ -126,7 +126,7 @@ export default function createTransformationHandler(
   let handlerFeatures: Handlers;
   let center: Coordinate = [0, 0, 0];
   let getCenterFromFeatures: (features: Feature[]) => FeatureCenterInfo;
-  let cesiumMap: CesiumMap | null = null;
+  let cesiumMap: BaseCesiumMap | null = null;
 
   const setFeatures = (features: Feature[]): void => {
     const show = features.length > 0;
@@ -168,13 +168,15 @@ export default function createTransformationHandler(
     }
   };
 
-  if (map instanceof CesiumMap) {
+  if (map instanceof BaseCesiumMap) {
     handlerFeatures = create3DHandlers(map, mode);
     getCenterFromFeatures = getCenterFromFeatures3D.bind(null, layer, mode);
     cesiumMap = map;
   } else if (map instanceof BaseOLMap) {
     handlerFeatures = create2DHandlers(map, scratchLayer, mode);
     getCenterFromFeatures = getCenterFromFeatures2D;
+  } else {
+    throw new Error('unsupported map type for transformation handler');
   }
 
   return {

package/src/util/editor/transformation/translateInteraction.ts

@@ -17,7 +17,7 @@ import Projection, { mercatorProjection } from '../../projection.js';
 import { cartographicToWgs84, mercatorToCartesian } from '../../math.js';
 import type { TransformationHandler } from './transformationTypes.js';
 import { AxisAndPlanes, is1DAxis, is2DAxis } from './transformationTypes.js';
-import CesiumMap from '../../../map/cesiumMap.js';
+import BaseCesiumMap from '../../../map/baseCesiumMap.js';
 
 /**
  * Of type [dx, dy, dz];
@@ -66,7 +66,7 @@ class TranslateInteraction extends AbstractInteraction {
       const axis = (event.feature as Feature)[handlerSymbol] as AxisAndPlanes;
       if (axis !== AxisAndPlanes.NONE) {
         this._transformationHandler!.showAxis = axis;
-        if (event.map instanceof CesiumMap) {
+        if (event.map instanceof BaseCesiumMap) {
           if (is1DAxis(axis)) {
             this._getTranslateEvent = this._dragAlongAxis3D(axis, event);
           } else if (is2DAxis(axis)) {
@@ -86,7 +86,7 @@ class TranslateInteraction extends AbstractInteraction {
     axis: AxisAndPlanes,
     event: EventAfterEventHandler,
   ): GetTranslateEvent {
-    const scene = (event.map as CesiumMap).getScene() as Scene;
+    const scene = (event.map as BaseCesiumMap).getScene() as Scene;
     if (axis !== AxisAndPlanes.Z) {
       const center = mercatorToCartesian(this._transformationHandler!.center);
       let plane = Plane.clone(Plane.ORIGIN_XY_PLANE);
@@ -147,7 +147,7 @@ class TranslateInteraction extends AbstractInteraction {
     axis: AxisAndPlanes,
     event: EventAfterEventHandler,
   ): GetTranslateEvent {
-    const scene = (event.map as CesiumMap).getScene() as Scene;
+    const scene = (event.map as BaseCesiumMap).getScene() as Scene;
     const center = mercatorToCartesian(this._transformationHandler!.center);
     let plane: Plane;
     if (axis === AxisAndPlanes.YZ) {

package/src/util/fetch.ts

@@ -38,6 +38,13 @@ export async function requestObjectUrl(
   return URL.createObjectURL(blob);
 }
 
+/**
+ * Get a RequestInit object for the given url, adding optional headers. If the url is in the
+ * TrustedServers {@see https://cesium.com/learn/cesiumjs/ref-doc/TrustedServers.html?classFilter=Trusted}
+ * credentials will be included in the request.
+ * @param url
+ * @param headers
+ */
 export function getInitForUrl(
   url: string,
   headers?: Record<string, string>,

package/src/util/flight/flightInstance.ts

@@ -69,9 +69,9 @@ class FlightInstance extends VcsObject {
   }
 
   constructor(options: FlightInstanceOptions) {
-    super(options);
-
     const defaultOptions = FlightInstance.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
+
     const anchorsArray = (options.anchors ?? defaultOptions.anchors!)
       .map(anchorFromGeojsonFeature)
       .filter((a): a is FlightAnchor => !!a);
@@ -205,15 +205,16 @@ class FlightInstance extends VcsObject {
    * returns an options object for this flight. if this flight was configured via an URL, only the url will be configured.
    * @returns
    */
-  toJSON(): FlightInstanceOptions {
-    const config = super.toJSON() as FlightInstanceOptions;
+  toJSON(
+    defaultOptions = FlightInstance.getDefaultOptions(),
+  ): FlightInstanceOptions {
+    const config = super.toJSON(defaultOptions) as FlightInstanceOptions;
 
     if (this._url) {
       config.url = this._url;
       return config;
     }
 
-    const defaultOptions = FlightInstance.getDefaultOptions();
     if (this._multiplier !== defaultOptions.multiplier) {
       config.multiplier = this._multiplier;
     }

package/src/util/mapCollection.ts

@@ -22,6 +22,7 @@ import PanoramaImageSelection from '../interaction/panoramaImageSelection.js';
 import type { PanoramaImage } from '../panorama/panoramaImage.js';
 import type PanoramaMap from '../map/panoramaMap.js';
 import PanoramaFeatureHighlight from '../interaction/panoramaFeatureHighlight.js';
+import { EventType } from '../interaction/interactionType.js';
 
 export type MapCollectionInitializationError = {
   error: Error;
@@ -258,6 +259,23 @@ class MapCollection extends Collection<VcsMap> {
     return this._exclusiveMapControls?.id;
   }
 
+  /**
+   * Indicates whether panorama image selection is paused.
+   */
+  get pausePanoramaImageSelection(): boolean {
+    return (
+      this._panoramaImageSelection.active === EventType.NONE &&
+      this._panoramaTileHighlight.active === EventType.NONE
+    );
+  }
+
+  set pausePanoramaImageSelection(paused: boolean) {
+    check(paused, Boolean);
+    const active = paused ? false : undefined;
+    this._panoramaImageSelection.setActive(active);
+    this._panoramaTileHighlight.setActive(active);
+  }
+
   /**
    * Adds a map to the collection. This will set the collections target
    * and the collections  on the map.

package/src/util/renderScreenshot.ts

@@ -1,20 +1,16 @@
 import type { Size } from 'ol/size.js';
 import { getLogger } from '@vcsuite/logger';
-import CesiumMap from '../map/cesiumMap.js';
 import OpenlayersMap from '../map/openlayersMap.js';
 import ObliqueMap from '../map/obliqueMap.js';
-import PanoramaMap from '../map/panoramaMap.js';
 import type VcsApp from '../vcsApp.js';
+import BaseCesiumMap from '../map/baseCesiumMap.js';
 /**
  * Prepares the cesium map for the screenshot
  * @param map - The cesium map
  * @param scale - The factor to scale the map according to the required resolution
  * @returns The function to reset the applied scale.
  */
-function prepareCesiumMap(
-  map: CesiumMap | PanoramaMap,
-  scale: number,
-): () => void {
+function prepareCesiumMap(map: BaseCesiumMap, scale: number): () => void {
   const viewer = map.getCesiumWidget()!;
   const { resolutionScale } = viewer;
   viewer.resolutionScale = scale;
@@ -64,7 +60,7 @@ function prepareOlMap(
  * @returns A promise that resolves to the canvas element.
  */
 async function getImageFromCesium(
-  map: CesiumMap | PanoramaMap,
+  map: BaseCesiumMap,
 ): Promise<HTMLCanvasElement> {
   const { scene } = map.getCesiumWidget()!;
 
@@ -167,7 +163,7 @@ export default async function renderScreenshot(
   let resetMap: () => void;
   const map = app.maps.activeMap;
 
-  if (map instanceof CesiumMap || map instanceof PanoramaMap) {
+  if (map instanceof BaseCesiumMap) {
     const { canvas } = map.getCesiumWidget()!.scene;
     const canvasWidth = canvas.width;
     const canvasHeight = canvas.height;

package/src/util/viewpoint.ts

@@ -182,9 +182,9 @@ class Viewpoint extends VcsObject {
    * @param  options
    */
   constructor(options: ViewpointOptions) {
-    super(options);
-
     const defaultOptions = Viewpoint.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
+
     this.cameraPosition = null;
     if (
       Array.isArray(options.cameraPosition) &&

package/src/vcsApp.ts

@@ -29,7 +29,11 @@ import VcsEvent from './vcsEvent.js';
 import { setDefaultProjectionOptions } from './util/projection.js';
 import ObliqueMap from './map/obliqueMap.js';
 import OverrideClassRegistry from './overrideClassRegistry.js';
-import type { AbstractCtor, CtorType } from './classRegistry.js';
+import type {
+  AbstractCtor,
+  CtorType,
+  FeatureProviderClass,
+} from './classRegistry.js';
 import ClassRegistry, {
   categoryClassRegistry,
   featureProviderClassRegistry,
@@ -44,7 +48,6 @@ import { moduleIdSymbol } from './moduleIdSymbol.js';
 import type LayerCollection from './util/layerCollection.js';
 import type Category from './category/category.js';
 import type TileProvider from './layer/tileProvider/tileProvider.js';
-import type AbstractFeatureProvider from './featureProvider/abstractFeatureProvider.js';
 import type { HiddenObject } from './util/hiddenObjects.js';
 import { createHiddenObjectsCollection } from './util/hiddenObjects.js';
 import type { FlightInstanceOptions } from './util/flight/flightInstance.js';
@@ -155,9 +158,7 @@ class VcsApp {
     typeof TileProvider
   >;
 
-  private _featureProviderClassRegistry: OverrideClassRegistry<
-    typeof AbstractFeatureProvider
-  >;
+  private _featureProviderClassRegistry: OverrideClassRegistry<FeatureProviderClass>;
 
   /**
    * @param  options
@@ -402,9 +403,7 @@ class VcsApp {
     return this._tileProviderClassRegistry;
   }
 
-  get featureProviderClassRegistry(): OverrideClassRegistry<
-    typeof AbstractFeatureProvider
-  > {
+  get featureProviderClassRegistry(): OverrideClassRegistry<FeatureProviderClass> {
     return this._featureProviderClassRegistry;
   }
 

package/src/vcsModuleHelpers.ts

@@ -11,8 +11,19 @@ import type {
   StyleItemOptions,
 } from './style/styleItem.js';
 import type { TileProviderOptions } from './layer/tileProvider/tileProvider.js';
-import type { AbstractFeatureProviderOptions } from './featureProvider/abstractFeatureProvider.js';
+import type {
+  // eslint-disable-next-line import/no-named-default
+  default as AbstractFeatureProvider,
+  AbstractFeatureProviderOptions,
+} from './featureProvider/abstractFeatureProvider.js';
 import type VcsApp from './vcsApp.js';
+import type { CompositeFeatureProviderOptions } from './featureProvider/compositeFeatureProvider.js';
+import CompositeFeatureProvider from './featureProvider/compositeFeatureProvider.js';
+import type {
+  // eslint-disable-next-line import/no-named-default
+  default as AbstractAttributeProvider,
+  AbstractAttributeProviderOptions,
+} from './featureProvider/abstractAttributeProvider.js';
 
 function getLogger(): Logger {
   return getLoggerByName('init');
@@ -22,7 +33,7 @@ export type ModuleLayerOptions = LayerOptions & {
   style?: string | StyleItemOptions;
   highlightStyle?: string | StyleItemOptions;
   tileProvider?: TileProviderOptions;
-  featureProvider?: AbstractFeatureProviderOptions;
+  attributeProvider?: AbstractAttributeProviderOptions;
 };
 
 export function deserializeMap(
@@ -48,6 +59,44 @@ export function deserializeViewpoint(
   return null;
 }
 
+export function deserializeFeatureProvider(
+  vcsApp: VcsApp,
+  options:
+    | AbstractFeatureProviderOptions
+    | CompositeFeatureProviderOptions
+    | AbstractAttributeProviderOptions,
+): AbstractAttributeProvider | AbstractFeatureProvider | null {
+  if (options.type === CompositeFeatureProvider.className) {
+    const {
+      featureProviders: featureProviderOptions,
+      attributeProviders: attributeProviderOptions,
+    } = options as CompositeFeatureProviderOptions;
+
+    const featureProviders = featureProviderOptions
+      .map((fpConfig) => deserializeFeatureProvider(vcsApp, fpConfig))
+      .filter((fp): fp is AbstractFeatureProvider => !!fp);
+
+    const attributeProviders = attributeProviderOptions
+      .map((apConfig) => deserializeFeatureProvider(vcsApp, apConfig))
+      .filter((ap): ap is AbstractAttributeProvider => !!ap);
+
+    return new CompositeFeatureProvider({
+      ...options,
+      featureProviders,
+      attributeProviders,
+    });
+  }
+
+  if (options.type) {
+    return getObjectFromClassRegistry(
+      vcsApp.featureProviderClassRegistry,
+      options,
+    );
+  }
+
+  return null;
+}
+
 export function deserializeLayer(
   vcsApp: VcsApp,
   layerConfig: ModuleLayerOptions,
@@ -83,10 +132,18 @@ export function deserializeLayer(
     );
   }
 
+  let attributeProvider;
+  if (layerConfig.attributeProvider) {
+    attributeProvider = deserializeFeatureProvider(
+      vcsApp,
+      layerConfig.attributeProvider,
+    ) as AbstractAttributeProvider | null;
+  }
+
   let featureProvider;
   if (layerConfig.featureProvider) {
-    featureProvider = getObjectFromClassRegistry(
-      vcsApp.featureProviderClassRegistry,
+    featureProvider = deserializeFeatureProvider(
+      vcsApp,
       layerConfig.featureProvider,
     );
   }
@@ -97,6 +154,7 @@ export function deserializeLayer(
     highlightStyle,
     tileProvider,
     featureProvider,
+    attributeProvider,
   });
 }
 

package/src/vcsObject.ts

@@ -25,6 +25,14 @@ class VcsObject {
     return 'VcsObject';
   }
 
+  static getDefaultOptions(): VcsObjectOptions {
+    return {
+      type: undefined,
+      name: undefined,
+      properties: {},
+    };
+  }
+
   /**
    * unique Name
    */
@@ -50,7 +58,8 @@ class VcsObject {
     return getLogger(this.className);
   }
 
-  toJSON(): VcsObjectOptions {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  toJSON(_defaultOptions?: VcsObjectOptions): VcsObjectOptions {
     const config: VcsObjectOptions = {
       type: this.className,
       name: this.name,

package/src/vectorCluster/vectorClusterGroup.ts

@@ -135,8 +135,8 @@ export default class VectorClusterGroup extends VcsObject {
   clusterDistance: number;
 
   constructor(options: VectorClusterGroupOptions) {
-    super(options);
     const defaultOptions = VectorClusterGroup.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
 
     this._style = getStyleOrDefaultStyle(
       options.style,
@@ -445,9 +445,12 @@ export default class VectorClusterGroup extends VcsObject {
     }
   }
 
-  toJSON(): VectorClusterGroupOptions {
-    const config: Partial<VectorClusterGroupOptions> = super.toJSON();
-    const defaultOptions = VectorClusterGroup.getDefaultOptions();
+  toJSON(
+    defaultOptions = VectorClusterGroup.getDefaultOptions(),
+  ): VectorClusterGroupOptions {
+    const config: Partial<VectorClusterGroupOptions> = super.toJSON(
+      defaultOptions,
+    );
 
     if (!this.style.equals(new VectorClusterStyleItem({}))) {
       config.style = this.style.toJSON();

package/src/vectorCluster/vectorClusterStyleItem.ts

@@ -99,8 +99,8 @@ export default class VectorClusterStyleItem extends VcsObject {
   styleChanged = new VcsEvent<void>();
 
   constructor(options: VectorClusterStyleItemOptions) {
-    super(options);
     const defaultOptions = VectorClusterStyleItem.getDefaultOptions();
+    super({ ...defaultOptions, ...options });
 
     const configTemplate = Array.isArray(options.template)
       ? options.template.join('')
@@ -336,9 +336,13 @@ export default class VectorClusterStyleItem extends VcsObject {
     this._styleCache.clear();
   }
 
-  toJSON(): VectorClusterStyleItemOptions {
-    const config: Partial<VectorClusterStyleItemOptions> = super.toJSON();
-    const defaultOptions = VectorClusterStyleItem.getDefaultOptions();
+  toJSON(
+    defaultOptions = VectorClusterStyleItem.getDefaultOptions(),
+  ): VectorClusterStyleItemOptions {
+    const config: Partial<VectorClusterStyleItemOptions> = super.toJSON(
+      defaultOptions,
+    );
+
     if (this.template !== defaultOptions.template) {
       config.template = this.template;
     }

package/dist/src/map/cesiumMapHelpers.d.ts

@@ -1,7 +0,0 @@
-import type { Camera, Scene, ScreenSpaceEventHandler } from '@vcmap-cesium/engine';
-import { Cartesian3 } from '@vcmap-cesium/engine';
-import Viewpoint from '../util/viewpoint.js';
-import type VcsMap from './vcsMap.js';
-export declare function setupCesiumInteractions(map: VcsMap, scene: Scene, screenSpaceEventHandler: ScreenSpaceEventHandler): () => void;
-export declare function getViewpointFromScene(scene: Scene): Viewpoint;
-export declare function getResolution(cartesian: Cartesian3, camera: Camera, mapElement: HTMLElement, latitude?: number): number;