@vcmap/viewshed 4.0.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vcmap/viewshed",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "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.",
   "type": "module",
   "main": "src/index.js",
@@ -8,6 +8,7 @@
     "prepublishOnly": "vcmplugin build",
     "build": "vcmplugin build",
     "bundle": "vcmplugin bundle",
+    "audit": "npm audit --omit=peer --omit=dev --omit=optional",
     "start": "vcmplugin serve",
     "preview": "vcmplugin preview",
     "buildStagingApp": "vcmplugin buildStagingApp",
@@ -40,20 +41,18 @@
   },
   "prettier": "@vcsuite/eslint-config/prettier.js",
   "peerDependencies": {
-    "@vcmap-cesium/engine": "^11.0.4",
-    "@vcmap/core": "^6.3.0",
-    "@vcmap/ui": "^6.3.0-rc.6",
+    "@vcmap-cesium/engine": "^11.0.5",
+    "@vcmap/core": "^6.3.5",
+    "@vcmap/ui": "^6.3.6",
     "ol": "^10.4.0",
     "vue": "~3.4.38",
     "vuetify": "~3.7.14"
   },
   "overrides": {
-    "@vcmap/core": "^6.3.0",
-    "@vcmap/ui": "^6.3.0-rc.6",
     "esbuild": "^0.25.0"
   },
   "devDependencies": {
-    "@vcmap/plugin-cli": "^4.1.6",
+    "@vcmap/plugin-cli": "^4.2.0",
     "@vcsuite/eslint-config": "^4.1.0",
     "@vitest/coverage-v8": "^2.1.9",
     "jest-canvas-mock": "^2.5.2",

package/src/callbacks/activateViewshedCallback.ts

@@ -0,0 +1,57 @@
+import { getLogger } from '@vcsuite/logger';
+import { parseEnumValue } from '@vcsuite/parsers';
+import { VcsCallback } from '@vcmap/ui';
+import type { VcsCallbackOptions, VcsUiApp } from '@vcmap/ui';
+import type { ViewshedPlugin, ViewshedPluginState } from '../index.js';
+import { name as pluginName } from '../../package.json';
+import { ViewshedPluginModes } from '../viewshedManager.js';
+import type { ViewshedOptions } from '../viewshed.js';
+
+export type ActivateViewshedCallbackOptions = VcsCallbackOptions &
+  ViewshedPluginState;
+
+class ActivateViewshedCallback extends VcsCallback {
+  static get className(): string {
+    return 'ActivateViewshedCallback';
+  }
+
+  private _mode: ViewshedPluginModes | null;
+  private _viewshedOptions: ViewshedOptions | null;
+  constructor(options: ActivateViewshedCallbackOptions, app: VcsUiApp) {
+    super(options, app);
+    this._mode = parseEnumValue<ViewshedPluginModes>(
+      options.m,
+      ViewshedPluginModes,
+      ViewshedPluginModes.CREATE,
+    );
+    this._viewshedOptions = options.cv || null;
+  }
+
+  callback(): void {
+    const plugin = (this._app as VcsUiApp).plugins.getByKey(pluginName) as
+      | ViewshedPlugin
+      | undefined;
+    if (!plugin) {
+      getLogger('ActivateViewshedCallback').warning(
+        `Plugin ${pluginName} not found`,
+      );
+      return;
+    }
+    plugin.state.m = this._mode;
+    plugin.state.cv = this._viewshedOptions;
+    plugin.activate();
+  }
+
+  toJSON(): ActivateViewshedCallbackOptions {
+    const config: ActivateViewshedCallbackOptions = super.toJSON();
+    if (this._mode) {
+      config.m = this._mode;
+    }
+    if (this._viewshedOptions) {
+      config.cv = structuredClone(this._viewshedOptions);
+    }
+    return config;
+  }
+}
+
+export default ActivateViewshedCallback;

package/src/callbacks/deactivateViewshedCallback.ts

@@ -0,0 +1,26 @@
+import { VcsCallback } from '@vcmap/ui';
+import type { VcsUiApp } from '@vcmap/ui';
+import { getLogger } from '@vcsuite/logger';
+import { name as pluginName } from '../../package.json';
+import type { ViewshedPlugin } from '../index.js';
+
+class DeactivateViewshedCallback extends VcsCallback {
+  static get className(): string {
+    return 'DeactivateViewshedCallback';
+  }
+
+  callback(): void {
+    const plugin = (this._app as VcsUiApp).plugins.getByKey(pluginName) as
+      | ViewshedPlugin
+      | undefined;
+    if (!plugin) {
+      getLogger('DeactivateShadowCallback').warning(
+        `Plugin ${pluginName} not found`,
+      );
+      return;
+    }
+    plugin.deactivate();
+  }
+}
+
+export default DeactivateViewshedCallback;

package/src/index.ts

@@ -1,6 +1,8 @@
 import type { VcsMap } from '@vcmap/core';
 import { CesiumMap, moduleIdSymbol } from '@vcmap/core';
 import type { PluginConfigEditor, VcsPlugin, VcsUiApp } from '@vcmap/ui';
+import { getLogger } from '@vcsuite/logger';
+import { reactive } from 'vue';
 import type { ColorOptions, ViewshedOptions } from './viewshed.js';
 import Viewshed, { ViewshedTypes } from './viewshed.js';
 import type { ViewshedManager } from './viewshedManager.js';
@@ -13,8 +15,10 @@ import { name, version, mapVersion } from '../package.json';
 import ViewshedCategory, { createCategory } from './viewshedCategory.js';
 import type { ViewshedConfig } from './ViewshedConfigEditor.vue';
 import ViewshedConfigEditor from './ViewshedConfigEditor.vue';
+import ActivateViewshedCallback from './callbacks/activateViewshedCallback.js';
+import DeactivateViewshedCallback from './callbacks/deactivateViewshedCallback.js';
 
-type ViewshedPluginState = {
+export type ViewshedPluginState = {
   /** Which mode the plugin is currently in. */
   m?: ViewshedPluginModes | null;
   /** The currents viewshed options. */
@@ -36,15 +40,43 @@ export function getDefaultOptions(): ViewshedConfig {
 export type ViewshedPlugin = VcsPlugin<
   ViewshedPluginOptions,
   ViewshedPluginState
->;
+> & {
+  readonly state: ViewshedPluginState;
+  activate: () => void;
+  deactivate: () => void;
+};
+
+function activateCachedViewshed(
+  map: VcsMap,
+  viewshedManager?: ViewshedManager,
+  state?: ViewshedPluginState,
+): void {
+  if (!state?.m || !(map instanceof CesiumMap)) {
+    return;
+  }
+  if (state.m === ViewshedPluginModes.CREATE) {
+    const viewshedType = state.cv?.viewshedType ?? ViewshedTypes.CONE;
+    viewshedManager?.createViewshed(viewshedType).catch((e: unknown) => {
+      getLogger(name).error('Failed to create viewshed', String(e));
+    });
+  } else if (state.cv) {
+    const activeViewshed = new Viewshed(state.cv);
+    if (state.m === ViewshedPluginModes.VIEW) {
+      viewshedManager?.viewViewshed(activeViewshed);
+    } else {
+      viewshedManager?.editViewshed(activeViewshed);
+    }
+  }
+}
 
 export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
-  let app: VcsUiApp;
-  let viewshedManager: ViewshedManager;
+  let app: VcsUiApp | undefined;
+  let viewshedManager: ViewshedManager | undefined;
   let destroy = (): void => {};
 
   const defaultOptions = getDefaultOptions();
   const config = { ...defaultOptions, ...options };
+  const defaultState: ViewshedPluginState = reactive({});
 
   return {
     get name(): string {
@@ -56,16 +88,29 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
     get mapVersion(): string {
       return mapVersion;
     },
+    getDefaultOptions,
+    state: defaultState,
     async initialize(
       vcsUiApp: VcsUiApp,
       state?: ViewshedPluginState,
     ): Promise<void> {
       app = vcsUiApp;
+      app.callbackClassRegistry.registerClass(
+        this[moduleIdSymbol],
+        ActivateViewshedCallback.className,
+        ActivateViewshedCallback,
+      );
+      app.callbackClassRegistry.registerClass(
+        this[moduleIdSymbol],
+        DeactivateViewshedCallback.className,
+        DeactivateViewshedCallback,
+      );
       vcsUiApp.categoryClassRegistry.registerClass(
         this[moduleIdSymbol],
         ViewshedCategory.className,
         ViewshedCategory,
       );
+
       const viewshedCategoryHelper = await createCategory(vcsUiApp);
       viewshedManager = createViewshedManager(
         vcsUiApp,
@@ -85,26 +130,17 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
       );
 
       const { activeMap } = vcsUiApp.maps;
-      function activateCachedViewshed(map: VcsMap): void {
-        if (state?.m && state.cv && map instanceof CesiumMap) {
-          const activeViewshed = new Viewshed(state.cv);
-          if (state.m === ViewshedPluginModes.VIEW) {
-            viewshedManager.viewViewshed(activeViewshed);
-          } else {
-            viewshedManager.editViewshed(activeViewshed);
-          }
-        }
-      }
+
       let appliedCachedViewshed = false;
       if (activeMap) {
         appliedCachedViewshed = true;
-        activateCachedViewshed(activeMap);
+        activateCachedViewshed(activeMap, viewshedManager, state);
       }
       const mapActivatedListener = vcsUiApp.maps.mapActivated.addEventListener(
         (map) => {
-          viewshedManager.stop();
+          viewshedManager?.stop();
           if (!appliedCachedViewshed) {
-            activateCachedViewshed(map);
+            activateCachedViewshed(map, viewshedManager, state);
             appliedCachedViewshed = true;
           }
         },
@@ -114,11 +150,24 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
         mapActivatedListener();
         destroyButtons();
         destroyViewshedWindow();
-        viewshedCategoryHelper.destroy();
-        viewshedManager.destroy();
+        viewshedCategoryHelper?.destroy();
+        viewshedManager?.destroy();
       };
     },
-    getDefaultOptions,
+    activate(): void {
+      if (!viewshedManager || !app) {
+        getLogger(name).error('Cannot activate plugin before initialization');
+        return;
+      }
+      if (!app.maps.activeMap) {
+        getLogger(name).error('Cannot activate plugin without an active map');
+        return;
+      }
+      activateCachedViewshed(app.maps.activeMap, viewshedManager, this.state);
+    },
+    deactivate(): void {
+      viewshedManager?.stop();
+    },
     toJSON(): ViewshedPluginOptions {
       const serial: ViewshedPluginOptions = {};
       if (config.tools && defaultOptions.tools.length !== config.tools.length) {
@@ -140,8 +189,8 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
     },
     getState(forUrl?: boolean): ViewshedPluginState {
       const state: ViewshedPluginState = {};
-      const mode = viewshedManager.mode.value;
-      const currentViewshed = viewshedManager.currentViewshed.value?.toJSON();
+      const mode = viewshedManager?.mode.value;
+      const currentViewshed = viewshedManager?.currentViewshed.value?.toJSON();
 
       if (
         mode !== null &&
@@ -173,9 +222,6 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
         },
       ];
     },
-    destroy: (): void => {
-      destroy();
-    },
     i18n: {
       en: {
         viewshed: {
@@ -254,5 +300,18 @@ export default function plugin(options: ViewshedPluginOptions): ViewshedPlugin {
         },
       },
     },
+    destroy(): void {
+      if (app) {
+        app.callbackClassRegistry.unregisterClass(
+          this[moduleIdSymbol],
+          ActivateViewshedCallback.className,
+        );
+        app.callbackClassRegistry.unregisterClass(
+          this[moduleIdSymbol],
+          DeactivateViewshedCallback.className,
+        );
+      }
+      destroy();
+    },
   };
 }