@vcmap/viewshed 2.0.3 → 2.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/viewshed",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "Tool to simulate a \"viewer\" and their field of vision from a certain standpoint in the map. It allows the user to see which areas and buildings can or can't be seen from a specific standpoint, regarding different viewing distances, viewers' sizes and orientations.Th",
   "type": "module",
   "main": "src/index.js",

package/src/ViewshedWindow.vue

@@ -1,7 +1,12 @@
 <template>
   <div>
     <div v-if="viewshedMode === ViewshedPluginModes.CREATE" class="px-2 py-1">
-      {{ $t('viewshed.createDescription') }}
+      <template v-if="viewshedType === ViewshedTypes.CONE">
+        {{ $t('viewshed.createDescription') }}
+      </template>
+      <template v-else-if="viewshedType === ViewshedTypes.THREESIXTY">
+        {{ $t('viewshed.createThreeSixtyDescription') }}
+      </template>
     </div>
     <VcsFormSection
       v-else-if="

package/src/index.js

@@ -68,25 +68,40 @@ export default function plugin(config) {
         vcsUiApp,
         viewshedCategoryHelper.collectionComponent,
       );
+
+      const { activeMap } = vcsUiApp.maps;
+      function activateCachedViewshed(map) {
+        if (state?.mode && state.currentViewshed && map instanceof CesiumMap) {
+          const activeViewshed = new Viewshed(state.currentViewshed, activeMap);
+          if (state.mode === ViewshedPluginModes.VIEW) {
+            viewshedManager.viewViewshed(activeViewshed);
+          } else {
+            viewshedManager.editViewshed(activeViewshed);
+          }
+        }
+      }
+      let appliedCachedViewshed = false;
+      if (activeMap) {
+        appliedCachedViewshed = true;
+        activateCachedViewshed(activeMap);
+      }
+      const mapActivatedListener = vcsUiApp.maps.mapActivated.addEventListener(
+        (map) => {
+          viewshedManager.stop();
+          if (!appliedCachedViewshed) {
+            activateCachedViewshed(map);
+            appliedCachedViewshed = true;
+          }
+        },
+      );
+
       destroy = () => {
+        mapActivatedListener();
         destroyButtons();
         destroyViewshedWindow();
         viewshedCategoryHelper.destroy();
+        viewshedManager.destroy();
       };
-
-      const { activeMap } = vcsUiApp.maps;
-      if (
-        state?.mode &&
-        state.currentViewshed &&
-        activeMap instanceof CesiumMap
-      ) {
-        const activeViewshed = new Viewshed(state.currentViewshed, activeMap);
-        if (state.mode === ViewshedPluginModes.VIEW) {
-          viewshedManager.viewViewshed(activeViewshed);
-        } else {
-          viewshedManager.editViewshed(activeViewshed);
-        }
-      }
     },
     /**
      * should return all default values of the configuration
@@ -163,9 +178,11 @@ export default function plugin(config) {
           move: 'Move viewpoint',
           createDescription:
             'Click the map twice. First click places the origin, second defines the distance and direction of the viewshed.',
+          createThreeSixtyDescription:
+            'Click the map twice. First click places the origin, second defines the distance of the viewshed.',
           remove: 'Remove',
           editor: {
-            general: 'General',
+            general: 'General Settings',
             visibleColor: 'Visible color',
             shadowColor: 'Shadow color',
             tools: 'Tools',
@@ -197,11 +214,13 @@ export default function plugin(config) {
           move: 'Viewpoint verschieben',
           createDescription:
             'Klicke zweimal in die Karte. Der erste Klick platziert den Ursprung, der zweite die Distanz und die Richtung des Viewsheds.',
+          createThreeSixtyDescription:
+            'Klicke zweimal in die Karte. Der erste Klick platziert den Ursprung, der zweite die Distanz des Viewsheds.',
           remove: 'Entfernen',
           editor: {
-            general: 'Generelles',
+            general: 'Allgemeine Einstellungen',
             visibleColor: 'Sichtbarer Bereich',
-            shadowColor: 'Schatten Bereich',
+            shadowColor: 'Nicht sichtbarer Bereich',
             tools: 'Werkzeuge',
           },
         },

package/src/util/toolboxHelper.js

@@ -97,7 +97,6 @@ function createViewshedToolbox(app, manager, name, tools) {
       toolbox.action.disabled = false;
     } else {
       toolbox.action.disabled = true;
-      manager.stop();
     }
   });
 

package/src/viewshed.js

@@ -102,9 +102,8 @@ export default class Viewshed extends VcsObject {
 
   /**
    * @param {ViewshedOptions} options The options for the viewshed.
-   * @param {import("@vcmap/core").CesiumMap} [cesiumMap] The cesiumMap the viewshed should be applied to. If this parameter is passed, the viewshed is activated and all other viewsheds are deactivated.
    */
-  constructor(options, cesiumMap) {
+  constructor(options) {
     super(options);
     /**
      * @type {import("@vcmap/core").CesiumMap | null}
@@ -198,26 +197,16 @@ export default class Viewshed extends VcsObject {
     this._showPrimitive = !!options.showPrimitive;
 
     /**
-     * Makes sure that the viewshed instance is deactivated, if shadow map of another viewshed or plugin is applied to the scene of the CesiumMap.
+     * @type {import("@vcmap/core").VcsEvent<number[]>}
      * @private
      */
-    this._shadowMapChangedListener = null;
+    this._positionChanged = new VcsEvent();
 
     /**
-     * @type {import("@vcmap/core").VcsEvent<number[]>}
+     * @type {boolean}
      * @private
      */
-    this._positionChanged = new VcsEvent();
-
-    if (cesiumMap) {
-      this.activate(cesiumMap);
-    } else {
-      /**
-       * @type {boolean}
-       * @private
-       */
-      this._active = false;
-    }
+    this._active = false;
   }
 
   /**
@@ -267,7 +256,6 @@ export default class Viewshed extends VcsObject {
         this.position[1],
         this.position[2] + value,
       );
-      this._updateShadowMap();
       this._updatePrimitive();
     }
   }
@@ -289,7 +277,9 @@ export default class Viewshed extends VcsObject {
       value > Viewshed.MIN_DISTANCE ? value : Viewshed.MIN_DISTANCE;
     if (this._shadowCamera) {
       this._shadowCamera.frustum.far = this._frustumOptions.far;
-      this._updateShadowMap();
+      if (this._viewshedType === ViewshedTypes.THREESIXTY) {
+        this._updateShadowMap();
+      }
       if (this._viewshedType === ViewshedTypes.CONE) {
         this._updatePrimitive();
       }
@@ -314,7 +304,6 @@ export default class Viewshed extends VcsObject {
       /** @type {import("@vcmap-cesium/engine").PerspectiveFrustum} */ (
         this._shadowCamera.frustum
       ).fov = value * CesiumMath.RADIANS_PER_DEGREE;
-      this._updateShadowMap();
       if (this._viewshedType === ViewshedTypes.CONE) {
         this._updatePrimitive();
       }
@@ -400,7 +389,7 @@ export default class Viewshed extends VcsObject {
   }
 
   /**
-   * Retruns the type of the Viewshed.
+   * Returns the type of the Viewshed.
    * @returns {ViewshedTypes}
    */
   get type() {
@@ -408,25 +397,30 @@ export default class Viewshed extends VcsObject {
   }
 
   /**
-   * Deactivates the viewshed by removing primitve and removing shadowMap.
+   * @returns {ShadowMap|null}
+   */
+  get shadowMap() {
+    return this._shadowMap;
+  }
+
+  /**
+   * Deactivates the viewshed by removing primitive and removing shadowMap.
    */
   deactivate() {
     if (this._active) {
       this._removePrimitive();
-      this._shadowMapChangedListener?.();
-      if (this._cesiumMap?.getScene()?.shadowMap === this._shadowMap) {
-        this._cesiumMap.setDefaultShadowMap();
-      }
+      this._shadowMap.enabled = false;
       this._shadowMap?.destroy();
       this._shadowCamera = null;
       this._scene = null;
       this._cesiumMap = null;
+      this._shadowMap = null;
       this._active = false;
     }
   }
 
   /**
-   * Activates viewshed. Sets the CesiumMap and adds shadowMapChanged listener to CesiumMap. If viewshed is active but
+   * Activates viewshed.
    * @param {import("@vcmap/core").CesiumMap} cesiumMap The cesium map to which the shadow map of the viewshed is applied to.
    */
   activate(cesiumMap) {
@@ -451,10 +445,6 @@ export default class Viewshed extends VcsObject {
 
       this._updateShadowMap();
       this._updatePrimitive();
-      this._shadowMapChangedListener =
-        this._cesiumMap.shadowMapChanged.addEventListener(() => {
-          this.deactivate();
-        });
     }
   }
 
@@ -471,6 +461,7 @@ export default class Viewshed extends VcsObject {
       return;
     }
 
+    this._shadowMap?.destroy();
     // @ts-ignore
     this._shadowMap = new ShadowMap({
       // @ts-ignore
@@ -490,7 +481,7 @@ export default class Viewshed extends VcsObject {
   }
 
   _removePrimitive() {
-    if (this._primitive) {
+    if (this._primitive && !this._primitive.isDestroyed?.()) {
       this._scene?.primitives.remove(this._primitive);
       this._primitive.destroy();
       this._primitive = null;
@@ -572,6 +563,11 @@ export default class Viewshed extends VcsObject {
    * Destroys the viewshed.
    */
   destroy() {
+    const cesiumMap = this._cesiumMap;
+    const shadowMap = this._shadowMap;
     this.deactivate();
+    if (cesiumMap?.getScene()?.shadowMap === shadowMap) {
+      cesiumMap.setDefaultShadowMap();
+    }
   }
 }

package/src/viewshedManager.js

@@ -130,15 +130,15 @@ export default function createViewshedManager(app, config, categoryHelper) {
   /** @type {import("vue").Ref<import("@vcmap/core").EditFeaturesSession | import("@vcmap/core").EditGeometrySession | null>} */
   const currentEditSession = shallowRef(null);
 
-  function setCurrentViewshed(viewshed) {
+  let shadowMapChangedListener = () => {};
+
+  function deactivateCurrentViewshed() {
     if (currentIsPersisted.value && currentViewshed.value) {
       currentViewshed.value.deactivate();
       categoryHelper.setVisibility(currentViewshed.value.name, false);
     } else {
       currentViewshed.value?.destroy();
     }
-    currentViewshed.value = viewshed;
-    currentViewshed.value?.activate(app.maps.activeMap);
   }
 
   /**
@@ -146,8 +146,10 @@ export default function createViewshedManager(app, config, categoryHelper) {
    * @param {boolean} [clear=true] - Indicates whether to clear the selection.
    */
   function stop(clear = true) {
+    shadowMapChangedListener();
     removeInteraction();
-    setCurrentViewshed(null);
+    deactivateCurrentViewshed();
+    currentViewshed.value = null;
     if (clear) {
       categoryHelper.clearSelection();
     }
@@ -155,6 +157,26 @@ export default function createViewshedManager(app, config, categoryHelper) {
     mode.value = null;
   }
 
+  /**
+   * activates a viewshed, and adds a Listener to the shadowMapChangedEvent to deactivate the viewshed plugin.
+   * @param {Viewshed} viewshed
+   */
+  function activateViewshed(viewshed) {
+    shadowMapChangedListener();
+    // deactivate existing Viewsheds
+    deactivateCurrentViewshed();
+    if (app.maps.activeMap instanceof CesiumMap) {
+      currentViewshed.value = viewshed;
+      viewshed.activate(app.maps.activeMap);
+      shadowMapChangedListener =
+        app.maps.activeMap.shadowMapChanged.addEventListener((newShadowMap) => {
+          if (newShadowMap !== currentViewshed.value?.shadowMap) {
+            stop(false);
+          }
+        });
+    }
+  }
+
   async function createViewshed(viewshedType) {
     stop();
     await nextTick(); // so the viewshedWindow is closed with mode === null and not CREATE
@@ -163,19 +185,16 @@ export default function createViewshedManager(app, config, categoryHelper) {
     const { featureInteraction } = eventHandler;
 
     // create new viewshed instance
-    currentViewshed.value = new Viewshed(
-      {
-        viewshedType,
-        colorOptions: {
-          visibleColor: config.visibleColor,
-          shadowColor: config.shadowColor,
-        },
-        heightOffset:
-          heightMode.value === HeightModes.ABSOLUTE ? 0 : defaultHeightOffset,
+    const viewshed = new Viewshed({
+      viewshedType,
+      colorOptions: {
+        visibleColor: config.visibleColor,
+        shadowColor: config.shadowColor,
       },
-      /** @type {import("@vcmap/core").CesiumMap} */ (app.maps.activeMap),
-    );
-
+      heightOffset:
+        heightMode.value === HeightModes.ABSOLUTE ? 0 : defaultHeightOffset,
+    });
+    activateViewshed(viewshed);
     // setup viewshed create interaction
     const interaction = new ViewshedInteraction(currentViewshed.value);
 
@@ -274,7 +293,7 @@ export default function createViewshedManager(app, config, categoryHelper) {
   function changeMode(viewshedMode, viewshed) {
     removeInteraction();
     if (currentViewshed.value !== viewshed) {
-      setCurrentViewshed(viewshed);
+      activateViewshed(viewshed);
       heightMode.value = viewshed.heightOffset
         ? HeightModes.RELATIVE
         : HeightModes.ABSOLUTE;
@@ -387,7 +406,8 @@ export default function createViewshedManager(app, config, categoryHelper) {
     setupMultiSelect() {
       removeInteraction();
       mode.value = ViewshedPluginModes.MULTI_SELECT;
-      setCurrentViewshed(null);
+      deactivateCurrentViewshed();
+      currentViewshed.value = null;
     },
     mode,
     heightMode,