@geode/opengeodeweb-front 10.31.0 → 10.32.0-rc.1

package/app/components/CameraOrientation.vue

@@ -1,6 +1,6 @@
 <script setup>
 import ToolPanel from "@ogw_front/components/ToolPanel";
-import { applyCameraOptions } from "@ogw_internal/stores/hybrid_viewer_camera";
+import { applyCameraOptions } from "@ogw_internal/stores/hybrid_viewer/camera";
 import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 import { newInstance as vtkAnnotatedCubeActor } from "@kitware/vtk.js/Rendering/Core/AnnotatedCubeActor";
 import { newInstance as vtkGenericRenderWindow } from "@kitware/vtk.js/Rendering/Misc/GenericRenderWindow";

package/app/components/HybridRenderingView.vue

@@ -55,6 +55,14 @@ function debounce(func, wait) {
 
 async function handleClick(event) {
   const { offsetX, offsetY, clientX, clientY } = event;
+  if (hybridViewerStore.is_ruler_active) {
+    const rect = container.value.$el.getBoundingClientRect();
+    const x = event.clientX - rect.left;
+    const y = elementHeight.value - (event.clientY - rect.top);
+    await hybridViewerStore.handleRulerClick(x, y);
+    return;
+  }
+
   if (viewerStore.picking_mode) {
     const rect = container.value.$el.getBoundingClientRect();
     const x = event.clientX - rect.left;

package/app/components/Ruler.vue

@@ -0,0 +1,144 @@
+<script setup>
+import ToolPanel from "@ogw_front/components/ToolPanel";
+import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
+
+const show = defineModel("show", { type: Boolean, default: false });
+const hybridViewerStore = useHybridViewerStore();
+
+const localPoint1 = ref([0, 0, 0]);
+const localPoint2 = ref([0, 0, 0]);
+
+watch(
+  () => hybridViewerStore.ruler_point1,
+  (point) => {
+    if (point) {
+      localPoint1.value = [...point];
+    }
+  },
+);
+
+watch(
+  () => hybridViewerStore.ruler_point2,
+  (point) => {
+    if (point) {
+      localPoint2.value = [...point];
+    }
+  },
+);
+
+watch(show, (visible) => {
+  if (visible) {
+    hybridViewerStore.is_ruler_active = true;
+  } else if (hybridViewerStore.is_ruler_active) {
+    hybridViewerStore.deactivateRuler();
+  }
+});
+
+watch(
+  () => hybridViewerStore.is_ruler_active,
+  (active) => {
+    if (!active) {
+      show.value = false;
+    }
+  },
+);
+
+async function applyManualCoords() {
+  hybridViewerStore.ruler_point1 = [...localPoint1.value];
+  hybridViewerStore.ruler_point2 = [...localPoint2.value];
+  await hybridViewerStore.applyRuler();
+}
+</script>
+
+<template>
+  <ToolPanel
+    v-model="show"
+    title="Ruler"
+    :width="300"
+    close-label="Stop ruler"
+    :click-outside="false"
+  >
+    <v-card-text class="pa-3">
+      <v-switch
+        v-model="hybridViewerStore.ruler_snap"
+        data-testid="rulerSnapToggle"
+        label="Snap to vertex"
+        color="primary"
+        density="compact"
+        hide-details
+        class="mb-4"
+      />
+
+      <v-divider class="mb-3" />
+
+      <div class="text-caption font-weight-bold mb-2 text-medium-emphasis">Point 1</div>
+      <v-row dense class="mb-1" data-testid="rulerPointCard">
+        <v-col v-for="(axis, index) in ['X', 'Y', 'Z']" :key="axis">
+          <v-text-field
+            v-model.number="localPoint1[index]"
+            data-testid="rulerPointCoordInput"
+            :label="axis"
+            type="number"
+            density="compact"
+            variant="outlined"
+            hide-details
+          />
+        </v-col>
+      </v-row>
+
+      <div class="text-caption font-weight-bold mb-2 mt-3 text-medium-emphasis">Point 2</div>
+      <v-row dense class="mb-1" data-testid="rulerPointCard">
+        <v-col v-for="(axis, index) in ['X', 'Y', 'Z']" :key="axis">
+          <v-text-field
+            v-model.number="localPoint2[index]"
+            data-testid="rulerPointCoordInput"
+            :label="axis"
+            type="number"
+            density="compact"
+            variant="outlined"
+            hide-details
+          />
+        </v-col>
+      </v-row>
+
+      <v-btn
+        data-testid="rulerApplyButton"
+        variant="tonal"
+        size="small"
+        color="primary"
+        block
+        class="mt-3 text-caption text-none"
+        @click="applyManualCoords"
+      >
+        Apply
+      </v-btn>
+
+      <v-divider class="my-3" />
+
+      <div v-if="hybridViewerStore.ruler_distance !== undefined" class="text-center">
+        <div class="text-caption text-medium-emphasis mb-1">Distance</div>
+        <div data-testid="rulerDistance" class="text-h6 font-weight-bold">
+          {{ hybridViewerStore.ruler_distance.toFixed(4) }}
+        </div>
+      </div>
+      <div v-else class="text-caption text-medium-emphasis text-center">
+        Click in the scene to set both points
+      </div>
+    </v-card-text>
+
+    <template #actions>
+      <v-card-actions class="justify-center pb-3 pt-0">
+        <v-btn
+          data-testid="rulerClearButton"
+          variant="text"
+          size="small"
+          color="error"
+          class="text-caption text-none"
+          @click="hybridViewerStore.clearRuler()"
+        >
+          Clear
+        </v-btn>
+      </v-card-actions>
+    </template>
+  </ToolPanel>
+</template>

package/app/components/ViewToolbar.vue

@@ -4,6 +4,7 @@ import CameraBookmarkIcon from "@ogw_front/assets/viewer_svgs/camera-bookmark.sv
 import CameraManager from "@ogw_front/components/CameraManager";
 import CameraOrientation from "@ogw_front/components/CameraOrientation";
 import ClippingPlanes from "@ogw_front/components/ClippingPlanes";
+import Ruler from "@ogw_front/components/Ruler";
 import Screenshot from "@ogw_front/components/Screenshot";
 import ShrinkFilter from "@ogw_front/components/ShrinkFilter";
 import ZScaling from "@ogw_front/components/ZScaling";
@@ -19,6 +20,7 @@ const showCameraOrientation = ref(false);
 const showZScaling = ref(false);
 const showClippingPlanes = ref(false);
 const showShrinkFilter = ref(false);
+const showRuler = ref(false);
 const grid_scale = ref(false);
 const zScale = ref(hybridViewerStore.zScale);
 
@@ -173,6 +175,15 @@ const camera_options = computed(() => [
       showShrinkFilter.value = !showShrinkFilter.value;
     },
   },
+  {
+    testId: "rulerButton",
+    tooltip: "Ruler",
+    icon: "mdi-ruler",
+    color: showRuler.value ? "primary" : undefined,
+    action: () => {
+      showRuler.value = !showRuler.value;
+    },
+  },
 ]);
 </script>
 
@@ -247,6 +258,7 @@ const camera_options = computed(() => [
   />
   <ClippingPlanes v-model:show="showClippingPlanes" />
   <ShrinkFilter v-model:show="showShrinkFilter" />
+  <Ruler v-model:show="showRuler" />
 </template>
 
 <style module>

package/app/components/Viewer/Ui.vue

@@ -25,7 +25,9 @@ function stopHoverHighlight() {
 }
 
 onKeyStroke("Escape", () => {
-  if (hybridViewerStore.is_hover_highlight) {
+  if (hybridViewerStore.is_ruler_active) {
+    hybridViewerStore.deactivateRuler();
+  } else if (hybridViewerStore.is_hover_highlight) {
     stopHoverHighlight();
   }
 });
@@ -129,6 +131,30 @@ defineExpose({ get_viewer_id });
       </v-chip>
     </div>
   </v-fade-transition>
+
+  <v-fade-transition>
+    <div
+      v-if="hybridViewerStore.is_ruler_active"
+      class="picking-message-container d-flex justify-center w-100 pa-4"
+    >
+      <v-chip
+        data-testid="rulerActiveChip"
+        color="secondary"
+        elevation="8"
+        size="large"
+        variant="flat"
+        class="pick-pulse"
+        style="pointer-events: auto"
+        prepend-icon="mdi-ruler"
+        @click="hybridViewerStore.clearRuler()"
+      >
+        Ruler &mdash; click to set point {{ hybridViewerStore.ruler_awaiting_point }}
+        &middot; Esc to stop
+        <v-divider vertical class="mx-2 my-1" opacity="0.3" />
+        <v-icon icon="mdi-close" size="small" />
+      </v-chip>
+    </div>
+  </v-fade-transition>
 </template>
 
 <style scoped>

package/app/stores/hybrid_viewer.js

@@ -1,81 +1,52 @@
-import {
-  ACTOR_COLOR,
-  BACKGROUND_COLOR,
-  WHEEL_TIME_OUT_MS,
-} from "@ogw_internal/stores/hybrid_viewer_constants";
 import {
   applySnapshot,
   getCameraOptions,
-  performCameraOrientation,
-  performFocusCameraOnObject,
-  performSetCamera,
-  performSyncRemoteCamera,
-} from "@ogw_internal/stores/hybrid_viewer_camera";
-import {
-  createClearHoverData,
-  createHoverHighlight,
-} from "@ogw_internal/stores/hybrid_viewer_highlight";
-import {
-  performAddItem,
-  performClear,
-  performClearHoverHighlight,
-  performClickPicking,
-  performRemoveItem,
-  performResize,
-  performSetClippingPlanes,
-  performSetContainer,
-  performSetShrink,
-  performSetVisibility,
-  performSetZScaling,
-} from "@ogw_internal/stores/hybrid_viewer";
-import { computeAverageBrightness } from "@ogw_internal/stores/hybrid_viewer_brightness";
-import { newInstance as vtkActor } from "@kitware/vtk.js/Rendering/Core/Actor";
+  useHybridViewerCamera,
+} from "@ogw_internal/stores/hybrid_viewer/camera";
+import { BACKGROUND_COLOR } from "@ogw_internal/stores/hybrid_viewer/constants";
+import { useHybridViewerBrightness } from "@ogw_internal/stores/hybrid_viewer/brightness";
+import { useHybridViewerFilters } from "@ogw_internal/stores/hybrid_viewer/filters";
+import { useHybridViewerHighlight } from "@ogw_internal/stores/hybrid_viewer/highlight";
+import { useHybridViewerRuler } from "@ogw_internal/stores/hybrid_viewer/ruler";
+import { useHybridViewerScene } from "@ogw_internal/stores/hybrid_viewer/scene";
+import { useHybridViewerViewport } from "@ogw_internal/stores/hybrid_viewer/viewport";
 import { newInstance as vtkGenericRenderWindow } from "@kitware/vtk.js/Rendering/Misc/GenericRenderWindow";
-import { newInstance as vtkMapper } from "@kitware/vtk.js/Rendering/Core/Mapper";
-import { newInstance as vtkXMLPolyDataReader } from "@kitware/vtk.js/IO/XML/XMLPolyDataReader";
 
 import { Status } from "@ogw_front/utils/status";
-import { useDataStore } from "@ogw_front/stores/data";
 import { useViewerStore } from "@ogw_front/stores/viewer";
 
 import viewer_schemas from "@geode/opengeodeweb-viewer/opengeodeweb_viewer_schemas.json";
 
 // oxlint-disable max-lines-per-function, max-statements
 export const useHybridViewerStore = defineStore("hybridViewer", () => {
-  const dataStore = useDataStore();
-  const hybridDb = reactive({});
   const viewerStore = useViewerStore();
-  const camera_options = reactive({});
   const genericRenderWindow = reactive({});
   const status = ref(Status.NOT_CREATED);
   const is_moving = ref(false);
   const is_picking = ref(false);
-  const is_hover_highlight = ref(false);
-  const hover_highlight_field_type = ref("CELL");
-  const hoverData = ref(undefined);
-  const hoverPosition = ref({ x: 0, y: 0 });
-  const zScale = ref(1);
   let imageStyle = undefined;
-  let viewStream = undefined;
-  let wheelEventEndTimeout = undefined;
-  const gridActor = undefined;
 
-  watch(is_picking, (value) => {
-    const element = genericRenderWindow.value
-      ?.getApiSpecificRenderWindow()
-      ?.getCanvas()?.parentElement;
-    if (element) {
-      element.style.cursor = value ? "crosshair" : "default";
+  const brightnessStore = useHybridViewerBrightness();
+  const sceneStore = useHybridViewerScene();
+  const filtersStore = useHybridViewerFilters();
+  const highlightStore = useHybridViewerHighlight();
+  const rulerStore = useHybridViewerRuler();
+  const cameraStore = useHybridViewerCamera();
+  const viewportStore = useHybridViewerViewport();
+
+  const is_cursor_crosshair = computed(() => is_picking.value || rulerStore.is_ruler_active.value);
+
+  watch(is_cursor_crosshair, (value) => {
+    if (!genericRenderWindow.value) {
+      return;
+    }
+    const webGLRenderWindow = genericRenderWindow.value.getApiSpecificRenderWindow();
+    const canvas = webGLRenderWindow.getCanvas();
+    if (canvas && canvas.parentElement) {
+      canvas.parentElement.style.cursor = value ? "crosshair" : "default";
     }
   });
 
-  const latestImage = ref(undefined);
-  const offscreenCanvas =
-    typeof document === "undefined" ? undefined : document.createElement("canvas");
-  const offscreenCtx = offscreenCanvas
-    ? offscreenCanvas.getContext("2d", { willReadFrequently: true })
-    : undefined;
-
   async function initHybridViewer() {
     if (status.value !== Status.NOT_CREATED) {
       return;
@@ -89,112 +60,25 @@ export const useHybridViewerStore = defineStore("hybridViewer", () => {
     imageStyle = webGLRenderWindow.getReferenceByName("bgImage").style;
     Object.assign(imageStyle, { transition: "opacity 0.1s ease-in", zIndex: 1 });
     await viewerStore.ws_connect();
-    viewStream = viewerStore.client.getImageStream().createViewStream("-1");
-    viewStream.onImageReady((event) => {
+    const imageStream = viewerStore.client.getImageStream();
+    viewportStore.viewStream.value = imageStream.createViewStream("-1");
+    viewportStore.viewStream.value.onImageReady((event) => {
       if (is_moving.value) {
         return;
       }
-      latestImage.value = event.image;
+      brightnessStore.latestImage.value = event.image;
       webGLRenderWindow.setBackgroundImage(event.image);
       imageStyle.opacity = 1;
     });
-    const camera = genericRenderWindow.value.getRenderer().getActiveCamera();
-    Object.assign(camera_options, getCameraOptions(camera));
+    const renderer = genericRenderWindow.value.getRenderer();
+    const camera = renderer.getActiveCamera();
+    Object.assign(cameraStore.camera_options, getCameraOptions(camera));
     camera.onModified(() => {
-      Object.assign(camera_options, getCameraOptions(camera));
+      Object.assign(cameraStore.camera_options, getCameraOptions(camera));
     });
     status.value = Status.CREATED;
   }
 
-  async function addItem(id) {
-    await performAddItem(id, {
-      genericRenderWindow: genericRenderWindow.value,
-      dataStore,
-      vtkXMLPolyDataReader,
-      vtkActor,
-      vtkMapper,
-      actorColor: ACTOR_COLOR,
-      hybridDb,
-    });
-  }
-
-  function removeItem(id) {
-    performRemoveItem(id, { genericRenderWindow: genericRenderWindow.value, hybridDb });
-  }
-
-  function setVisibility(id, visibility) {
-    performSetVisibility(id, visibility, {
-      genericRenderWindow: genericRenderWindow.value,
-      hybridDb,
-    });
-  }
-
-  async function setZScaling(z_scale) {
-    await performSetZScaling(z_scale, {
-      zScale,
-      genericRenderWindow: genericRenderWindow.value,
-      gridActor,
-      viewerStore,
-      viewer_schemas,
-      remoteRender,
-    });
-  }
-
-  async function setClippingPlanes(ids, planes) {
-    await performSetClippingPlanes(ids, planes, { viewerStore, viewer_schemas, remoteRender });
-  }
-
-  async function setShrink(ids, shrink_factor) {
-    await performSetShrink(ids, shrink_factor, { viewerStore, viewer_schemas, remoteRender });
-  }
-
-  function resetCamera() {
-    genericRenderWindow.value.getRenderer().resetCamera();
-    genericRenderWindow.value.getRenderWindow().render();
-    syncRemoteCamera();
-  }
-
-  async function focusCameraOnObject(id, block_ids = []) {
-    await performFocusCameraOnObject(id, {
-      hybridDb,
-      viewerStore,
-      viewer_schemas,
-      genericRenderWindow: genericRenderWindow.value,
-      block_ids,
-      is_moving,
-      imageStyle,
-      syncRemoteCamera,
-    });
-  }
-
-  function setCameraOrientation(orientation) {
-    performCameraOrientation(orientation, {
-      genericRenderWindow: genericRenderWindow.value,
-      is_moving,
-      imageStyle,
-      syncRemoteCamera,
-    });
-  }
-
-  function setCamera(targetCameraOptions) {
-    performSetCamera(targetCameraOptions, {
-      genericRenderWindow: genericRenderWindow.value,
-      is_moving,
-      imageStyle,
-      syncRemoteCamera,
-    });
-  }
-
-  function syncRemoteCamera() {
-    performSyncRemoteCamera({
-      genericRenderWindow: genericRenderWindow.value,
-      viewerStore,
-      viewer_schemas,
-      remoteRender,
-      camera_options,
-    });
-  }
-
   let renderPromise = undefined;
   let renderPending = false;
 
@@ -219,124 +103,30 @@ export const useHybridViewerStore = defineStore("hybridViewer", () => {
     return renderPromise;
   }
 
-  const hoverTimeoutRef = ref(undefined);
-  const currentHoverId = ref(undefined);
-
-  const clearHoverData = createClearHoverData(hoverTimeoutRef, hoverData, currentHoverId);
-
-  const hoverHighlight = createHoverHighlight({
-    genericRenderWindow,
-    is_hover_highlight,
-    viewerStore,
-    viewer_schemas,
-    hover_highlight_field_type,
-    hybridDb,
-    hoverData,
-    hoverPosition,
-    currentHoverId,
-    hoverTimeoutRef,
-    clearHoverData,
-  });
-
-  function clearHoverHighlight() {
-    clearHoverData();
-    performClearHoverHighlight({
-      viewerStore,
-      viewer_schemas,
-      hover_highlight_field_type,
-      hybridDb,
-    });
-  }
-
-  function setContainer(container) {
-    performSetContainer({
-      container,
-      genericRenderWindow: genericRenderWindow.value,
-      imageStyleSetter: (style) => (imageStyle = style),
-      resize,
-      useMousePressed,
-      useEventListener,
-      is_picking,
-      is_moving,
-      clickPickingCallback: performClickPicking,
-      viewerStore,
-      viewer_schemas,
-      syncRemoteCamera,
-      hoverHighlight,
-      wheelTimeoutMs: WHEEL_TIME_OUT_MS,
-      wheelEventEndTimeout,
-      wheelTimeoutSetter: (timeout) => (wheelEventEndTimeout = timeout),
-    });
-  }
-
-  async function resize(width, height) {
-    await performResize(width, height, {
-      viewerStore,
-      status,
-      Status,
-      genericRenderWindow: genericRenderWindow.value,
-      viewStream,
-      remoteRender,
-    });
-  }
-
-  function getAverageBrightness(rect) {
-    return computeAverageBrightness(rect, {
-      latestImage: latestImage.value,
-      offscreenCtx,
-      offscreenCanvas,
-      genericRenderWindow: genericRenderWindow.value,
-    });
-  }
-
   function exportStores() {
-    const camera = genericRenderWindow.value.getRenderer().getActiveCamera();
-    return { zScale: zScale.value, camera_options: getCameraOptions(camera) || camera_options };
-  }
-
-  async function importStores(snapshot) {
-    await applySnapshot(snapshot, {
-      genericRenderWindow: genericRenderWindow.value,
-      setZScaling,
-      syncRemoteCamera,
-      setCamera,
-    });
-  }
-
-  function clear() {
-    performClear({ genericRenderWindow: genericRenderWindow.value, hybridDb });
+    const renderer = genericRenderWindow.value.getRenderer();
+    const camera = renderer.getActiveCamera();
+    return {
+      zScale: sceneStore.zScale.value,
+      camera_options: getCameraOptions(camera) || cameraStore.camera_options,
+    };
   }
 
   return {
-    hybridDb,
     genericRenderWindow,
-    addItem,
-    removeItem,
-    setVisibility,
-    setZScaling,
-    setClippingPlanes,
-    setShrink,
-    syncRemoteCamera,
-    setCamera,
+    status,
+    is_moving,
+    is_picking,
     initHybridViewer,
     remoteRender,
-    resize,
-    resetCamera,
-    focusCameraOnObject,
-    setCameraOrientation,
-    setContainer,
-    zScale,
-    is_picking,
-    is_hover_highlight,
-    hover_highlight_field_type,
-    clearHoverHighlight,
-    hoverData,
-    hoverPosition,
-    clear,
     exportStores,
-    importStores,
-    camera_options,
-    latestImage,
-    getAverageBrightness,
+    importStores: applySnapshot,
+    ...brightnessStore,
+    ...sceneStore,
+    ...viewportStore,
+    ...filtersStore,
+    ...highlightStore,
+    ...rulerStore,
+    ...cameraStore,
   };
 });

package/internal/stores/{hybrid_viewer_brightness.js → hybrid_viewer/brightness.js}

@@ -1,9 +1,32 @@
-import { BACKGROUND_GREY_VALUE, RGB_MAX } from "./hybrid_viewer_constants";
+import { BACKGROUND_GREY_VALUE, RGB_MAX } from "./constants";
+import { useHybridViewerStore } from "@ogw_front/stores/hybrid_viewer";
 
 const RGBA_CHANNELS = 4;
 const SAMPLE_SIZE = 10;
 const TOTAL_CHANNELS = 400;
 
+function useHybridViewerBrightness() {
+  const latestImage = ref(undefined);
+  const offscreenCanvas =
+    typeof document === "undefined" ? undefined : document.createElement("canvas");
+  const offscreenCtx = offscreenCanvas
+    ? offscreenCanvas.getContext("2d", { willReadFrequently: true })
+    : undefined;
+
+  function getAverageBrightness(rect) {
+    return computeAverageBrightness(rect, {
+      latestImage: latestImage.value,
+      offscreenCtx,
+      offscreenCanvas,
+    });
+  }
+
+  return {
+    latestImage,
+    getAverageBrightness,
+  };
+}
+
 function mapRect(rect, latestImage, canvasRect) {
   const scaleX = latestImage.width / canvasRect.width;
   const scaleY = latestImage.height / canvasRect.height;
@@ -16,11 +39,12 @@ function mapRect(rect, latestImage, canvasRect) {
 }
 
 function computeAverageBrightness(rect, options) {
-  const { latestImage, offscreenCtx, offscreenCanvas, genericRenderWindow } = options;
-  if (!latestImage || !offscreenCtx || !offscreenCanvas || !genericRenderWindow) {
+  const { latestImage, offscreenCtx, offscreenCanvas } = options;
+  const { genericRenderWindow } = useHybridViewerStore();
+  if (!latestImage || !offscreenCtx || !offscreenCanvas || !genericRenderWindow.value) {
     return BACKGROUND_GREY_VALUE / RGB_MAX;
   }
-  const canvas = genericRenderWindow.getApiSpecificRenderWindow().getCanvas();
+  const canvas = genericRenderWindow.value.getApiSpecificRenderWindow().getCanvas();
   if (!canvas) {
     return BACKGROUND_GREY_VALUE / RGB_MAX;
   }
@@ -59,4 +83,4 @@ function computeAverageBrightness(rect, options) {
   }
 }
 
-export { computeAverageBrightness };
+export { computeAverageBrightness, useHybridViewerBrightness };