@vcmap/viewshed 3.0.2 → 3.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/viewshed",
-  "version": "3.0.2",
+  "version": "3.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",
@@ -48,8 +48,8 @@
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "peerDependencies": {
     "@vcmap-cesium/engine": "^11.0.2",
-    "@vcmap/core": "^6.0.0",
-    "@vcmap/ui": "^6.0.2",
+    "@vcmap/core": "^6.0.4",
+    "@vcmap/ui": "^6.0.6",
     "ol": "^10.2.1",
     "vue": "~3.4.38",
     "vuetify": "^3.7.3"
@@ -57,11 +57,11 @@
   "devDependencies": {
     "@vcmap/plugin-cli": "^4.0.1",
     "@vcsuite/eslint-config": "^3.0.8",
-    "@vitest/coverage-v8": "^2.1.3",
+    "@vitest/coverage-v8": "^2.1.4",
     "jest-canvas-mock": "^2.5.2",
     "jsdom": "^22.1.0",
     "resize-observer-polyfill": "^1.5.1",
-    "vitest": "^2.1.3"
+    "vitest": "^2.1.4"
   },
   "dependencies": {
     "@vcsuite/check": "^2.1.0",

package/src/index.js

@@ -74,9 +74,6 @@ export default function plugin(config) {
       const { activeMap } = vcsUiApp.maps;
       function activateCachedViewshed(map) {
         if (state?.m && state.cv && map instanceof CesiumMap) {
-          if (state.cv.properties.title) {
-            delete state.cv.properties.title;
-          }
           const activeViewshed = new Viewshed(state.cv);
           if (state.m === ViewshedPluginModes.VIEW) {
             viewshedManager.viewViewshed(activeViewshed);
@@ -141,9 +138,10 @@ export default function plugin(config) {
     },
     /**
      * should return the plugins state
+     * @param {boolean} forUrl
      * @returns {ViewshedPluginState}
      */
-    getState() {
+    getState(forUrl) {
       const state = {};
       const mode = viewshedManager.mode.value;
       const currentViewshed = viewshedManager.currentViewshed.value?.toJSON();
@@ -151,6 +149,13 @@ export default function plugin(config) {
       if (mode !== null && mode !== 'create' && currentViewshed) {
         state.m = mode;
         state.cv = currentViewshed;
+        if (forUrl && state.cv.properties?.title) {
+          if (Object.keys(state.properties).length === 1) {
+            delete state.cv.properties;
+          } else {
+            delete state.cv.properties.title;
+          }
+        }
       }
 
       return state;

package/src/util/toolboxHelper.js

@@ -21,52 +21,95 @@ import { ViewshedPluginModes } from '../viewshedManager.js';
  * @returns {ViewshedToolbox} A select toolbox with buttons to create 360 and cone viewshed.
  */
 function createViewshedToolbox(app, manager, name, tools) {
-  const toolbox = {
-    type: ToolboxType.SELECT,
-    action: reactive({
-      name,
-      currentIndex: 0,
-      active: false,
-      background: false,
-      disabled: !(app.maps.activeMap instanceof CesiumMap),
-      callback() {
-        if (this.active) {
-          if (this.background && manager.currentViewshed.value) {
-            manager.editViewshed(manager.currentViewshed.value);
+  /**
+   * @param {string} tool The tool to create.
+   * @returns {{name:ViewshedTypes, icon:string, title:string, } | undefined} A tool object.
+   */
+  function parseTool(tool) {
+    if (tool === ViewshedTypes.CONE) {
+      return {
+        name: ViewshedTypes.CONE,
+        icon: ViewshedIcons[ViewshedTypes.CONE],
+        title: `viewshed.create.${ViewshedTypes.CONE}`,
+      };
+    } else if (tool === ViewshedTypes.THREESIXTY) {
+      return {
+        name: ViewshedTypes.THREESIXTY,
+        icon: ViewshedIcons[ViewshedTypes.THREESIXTY],
+        title: `viewshed.create.${ViewshedTypes.THREESIXTY}`,
+      };
+    } else {
+      return undefined;
+    }
+  }
+
+  let toolbox;
+  let currentViewshedWatcher;
+  if (tools.length === 1) {
+    const tool = parseTool(tools[0]);
+    toolbox = {
+      type: ToolboxType.SINGLE,
+      action: reactive({
+        ...tool,
+        active: false,
+        background: false,
+        disabled: !(app.maps.activeMap instanceof CesiumMap),
+        callback() {
+          if (this.active) {
+            if (this.background && manager.currentViewshed.value) {
+              manager.editViewshed(manager.currentViewshed.value);
+            } else {
+              manager.stop();
+            }
+          } else {
+            manager.createViewshed(tool.name);
+          }
+        },
+      }),
+    };
+  } else {
+    toolbox = {
+      type: ToolboxType.SELECT,
+      action: reactive({
+        name,
+        currentIndex: 0,
+        active: false,
+        background: false,
+        disabled: !(app.maps.activeMap instanceof CesiumMap),
+        callback() {
+          if (this.active) {
+            if (this.background && manager.currentViewshed.value) {
+              manager.editViewshed(manager.currentViewshed.value);
+            } else {
+              manager.stop();
+            }
           } else {
-            manager.stop();
+            const toolName = this.tools[this.currentIndex].name;
+            manager.createViewshed(toolName);
+          }
+        },
+        selected(newIndex) {
+          if (newIndex !== this.currentIndex) {
+            this.currentIndex = newIndex;
           }
-        } else {
           const toolName = this.tools[this.currentIndex].name;
           manager.createViewshed(toolName);
+        },
+        tools: tools.flatMap(parseTool),
+      }),
+    };
+
+    currentViewshedWatcher = watch(
+      manager.currentViewshed,
+      (currentViewshed) => {
+        if (currentViewshed) {
+          toolbox.action.currentIndex = toolbox.action.tools.findIndex(
+            (tool) => tool.name === currentViewshed.type,
+          );
         }
       },
-      selected(newIndex) {
-        if (newIndex !== this.currentIndex) {
-          this.currentIndex = newIndex;
-        }
-        const toolName = this.tools[this.currentIndex].name;
-        manager.createViewshed(toolName);
-      },
-      tools: tools.flatMap((tool) => {
-        if (tool === ViewshedTypes.CONE) {
-          return {
-            name: ViewshedTypes.CONE,
-            icon: ViewshedIcons[ViewshedTypes.CONE],
-            title: `viewshed.create.${ViewshedTypes.CONE}`,
-          };
-        } else if (tool === ViewshedTypes.THREESIXTY) {
-          return {
-            name: ViewshedTypes.THREESIXTY,
-            icon: ViewshedIcons[ViewshedTypes.THREESIXTY],
-            title: `viewshed.create.${ViewshedTypes.THREESIXTY}`,
-          };
-        } else {
-          return [];
-        }
-      }),
-    }),
-  };
+    );
+  }
 
   const viewshedModeWatcher = watch(manager.mode, (mode) => {
     if (mode === ViewshedPluginModes.VIEW) {
@@ -81,17 +124,6 @@ function createViewshedToolbox(app, manager, name, tools) {
     }
   });
 
-  const currentViewshedWatcher = watch(
-    manager.currentViewshed,
-    (currentViewshed) => {
-      if (currentViewshed) {
-        toolbox.action.currentIndex = toolbox.action.tools.findIndex(
-          (tool) => tool.name === currentViewshed.type,
-        );
-      }
-    },
-  );
-
   const mapChangedListener = app.maps.mapActivated.addEventListener((map) => {
     if (map instanceof CesiumMap) {
       toolbox.action.disabled = false;
@@ -103,7 +135,7 @@ function createViewshedToolbox(app, manager, name, tools) {
   return {
     destroy() {
       viewshedModeWatcher();
-      currentViewshedWatcher();
+      currentViewshedWatcher?.();
       mapChangedListener();
     },
     toolbox,

package/src/viewshedManager.js

@@ -24,6 +24,7 @@ import ViewshedInteraction from './viewshedInteraction.js';
  * @property {import("vue").ShallowRef<import("./viewshed.js").default | null>} currentViewshed The current viewshed, that is displayed in the map.
  * @property {import("vue").Ref<null | boolean>} currentIsPersisted Whether current viewshed is persisted or not.
  * @property {import("vue").Ref<import("@vcmap/core").EditFeaturesSession | import("@vcmap/core").EditGeometrySession | null>} currentEditSession The current edit session, when in MOVE mode. Read only.
+ * @property {import("vue").ShallowRef<import("ol").Feature[]>} currentFeatures The feature that is created for feature/geometry editing in {@link moveCurrentViewshed}. Needed to match the EditorManager API from the UI.
  * @property {function(import("./viewshed.js").ViewshedTypes): void} createViewshed Creates a new viewshed and stops a running create process.
  * @property {function(import("./viewshed.js").default):void} viewViewshed Changes mode to VIEW for passed Viewshed.
  * @property {function(import("./viewshed.js").default):void} editViewshed Changes mode to EDIT for passed Viewshed.
@@ -129,6 +130,11 @@ export default function createViewshedManager(app, config, categoryHelper) {
   let removeInteraction = () => {};
   /** @type {import("vue").Ref<import("@vcmap/core").EditFeaturesSession | import("@vcmap/core").EditGeometrySession | null>} */
   const currentEditSession = shallowRef(null);
+  /**
+   * The feature that is created for feature/geometry editing in {@link moveCurrentViewshed}. Needed to match the EditorManager API from the UI.
+   * @type {import("vue").ShallowRef<import("ol").Feature[]>}
+   */
+  const currentFeatures = shallowRef([]);
 
   let shadowMapChangedListener = () => {};
 
@@ -242,6 +248,8 @@ export default function createViewshedManager(app, config, categoryHelper) {
       } = createLayerWithFeature(currentViewshed.value.position);
       app.layers.add(layer);
 
+      currentFeatures.value = [feature];
+
       if (heightMode.value === HeightModes.ABSOLUTE) {
         currentEditSession.value = startEditFeaturesSession(app, layer);
         currentEditSession.value.setFeatures([feature]);
@@ -276,6 +284,7 @@ export default function createViewshedManager(app, config, categoryHelper) {
         }
         currentEditSession.value?.stop();
         currentEditSession.value = null;
+        currentFeatures.value = [];
         app.layers.remove(layer);
         destroyLayerWithFeature();
         mode.value = ViewshedPluginModes.EDIT;
@@ -382,6 +391,7 @@ export default function createViewshedManager(app, config, categoryHelper) {
     currentViewshed,
     currentIsPersisted,
     currentEditSession,
+    currentFeatures,
     createViewshed,
     viewViewshed(viewshed) {
       changeMode(ViewshedPluginModes.VIEW, viewshed);