All files / extensions/cornerstone/src/Viewport/Overlays/ViewportSliceProgressScrollbar hooks.ts

85.36% Statements 105/123
85.24% Branches 52/61
84.61% Functions 22/26
85% Lines 102/120

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354                                              4186x 4186x               4186x 740x 317x     423x 630x 630x 630x       630x 446x   630x 630x     423x   423x 4539x 4539x 4539x     4539x 4378x 4332x       207x   423x   423x 171x       4186x                                       4186x 740x 317x     423x 423x 420x 420x 420x   420x                 423x   423x       423x 633x 633x       633x 633x     633x   633x           423x   423x 171x                                       4186x         4186x             4186x 1149x 331x 331x 24665x 24665x 6442x           1149x 818x     331x 22717x 22717x     22717x 22717x 8051x       331x                     331x 331x   331x 151x 151x                         4186x                                       4186x 4186x             4186x 1141x 327x 327x 23879x 23879x 322x           1141x       1141x               946x 125x     821x             821x 821x 488x         1141x 888x                               4186x 1483x 825x     658x 658x 658x 658x 655x       658x 658x 658x                                       4186x    
import { useEffect, useRef, useState } from 'react';
import {
  cache as cornerstoneCache,
  Enums,
  eventTarget,
  utilities,
  VolumeViewport3D,
} from '@cornerstonejs/core';
import { useByteArray } from '@ohif/ui-next';
import { getImageIdFromCacheEvent, getImageIndexFromEvent, isProgressFullMode } from './helpers';
import { ImageSliceData, ViewportData } from './types';
 
export function useProgressScrollbarMode({
  viewportData,
  viewportId,
  element,
  cornerstoneViewportService,
}: {
  viewportData: ViewportData;
  viewportId: string;
  element: HTMLElement;
  cornerstoneViewportService: AppTypes.CornerstoneViewportService;
}) {
  const [isFullMode, setIsFullMode] = useState(false);
  const lastViewPlaneNormalRef = useRef<number[] | null>(null);
 
  /**
   * Tracks whether this viewport should render full progress UI (stack or acquisition-plane
   * orthographic volume) versus minimal UI. We compute once on setup and recompute on each
   * CAMERA_MODIFIED event so stack->MPR transitions and acquisition-plane changes are reflected
   * immediately.
   */
  useEffect(() => {
    if (!viewportData) {
      return;
    }
 
    const updateMode = () => {
      const viewport = cornerstoneViewportService.getCornerstoneViewport(viewportId);
      const viewportImageData = viewport?.getImageData?.();
      const nextViewPlaneNormal = viewport?.getCamera?.()?.viewPlaneNormal as number[] | undefined;
      // Do not update the lastViewPlaneNormalRef until we have a valid viewportImageData.
      // Without viewportImageData, the viewport is not fully initialized and the isAcquisitionPlane
      // check will not be accurate.
      if (viewportImageData && nextViewPlaneNormal) {
        lastViewPlaneNormalRef.current = [...nextViewPlaneNormal];
      }
      const nextMode = isProgressFullMode(viewportData, viewport);
      setIsFullMode(prevMode => (prevMode === nextMode ? prevMode : nextMode));
    };
 
    updateMode();
 
    const onCameraModified = () => {
      const viewport = cornerstoneViewportService.getCornerstoneViewport(viewportId);
      const nextViewPlaneNormal = viewport?.getCamera?.()?.viewPlaneNormal as number[] | undefined;
      const previousViewPlaneNormal = lastViewPlaneNormalRef.current;
 
      // Ignore camera updates that keep the same orientation (pan/zoom/scroll).
      if (nextViewPlaneNormal && previousViewPlaneNormal) {
        if (utilities.isEqual(nextViewPlaneNormal, previousViewPlaneNormal)) {
          return;
        }
      }
 
      updateMode();
    };
    element.addEventListener(Enums.Events.CAMERA_MODIFIED, onCameraModified);
 
    return () => {
      element.removeEventListener(Enums.Events.CAMERA_MODIFIED, onCameraModified);
    };
  }, [viewportData, viewportId, cornerstoneViewportService, element]);
 
  return isFullMode;
}
 
export function useViewportSliceSync({
  viewportData,
  viewportId,
  element,
  cornerstoneViewportService,
  setImageSliceData,
}: {
  viewportData: ViewportData;
  viewportId: string;
  element: HTMLElement;
  cornerstoneViewportService: AppTypes.CornerstoneViewportService;
  setImageSliceData: (data: ImageSliceData) => void;
}) {
  /**
   * Keeps shared slice state in sync: first initialize from the live viewport snapshot, then
   * subscribe to navigation/render events for incremental updates while users scroll.
   */
  useEffect(() => {
    if (!viewportData) {
      return;
    }
 
    const viewport = cornerstoneViewportService.getCornerstoneViewport(viewportId);
    if (viewport && !(viewport instanceof VolumeViewport3D)) {
      try {
        const currentImageIndex = viewport.getCurrentImageIdIndex();
        const currentNumberOfSlices = viewport.getNumberOfSlices();
 
        setImageSliceData({
          imageIndex: currentImageIndex,
          numberOfSlices: currentNumberOfSlices,
        });
      } catch (error) {
        console.warn(error);
      }
    }
 
    const { viewportType } = viewportData;
    const eventId =
      (viewportType === Enums.ViewportType.STACK && Enums.Events.STACK_NEW_IMAGE) ||
      (viewportType === Enums.ViewportType.ORTHOGRAPHIC && Enums.Events.VOLUME_NEW_IMAGE) ||
      Enums.Events.IMAGE_RENDERED;
 
    const updateIndex = event => {
      const viewport = cornerstoneViewportService.getCornerstoneViewport(viewportId);
      Iif (!viewport || viewport instanceof VolumeViewport3D) {
        return;
      }
 
      const nextImageIndex = getImageIndexFromEvent(event);
      Iif (nextImageIndex == null) {
        return;
      }
      const nextNumberOfSlices = viewport.getNumberOfSlices();
 
      setImageSliceData({
        imageIndex: nextImageIndex,
        numberOfSlices: nextNumberOfSlices,
      });
    };
 
    element.addEventListener(eventId, updateIndex);
 
    return () => {
      element.removeEventListener(eventId, updateIndex);
    };
  }, [viewportData, element, viewportId, cornerstoneViewportService, setImageSliceData]);
}
 
export function useLoadedSliceBytes({
  isFullMode,
  numberOfSlices,
  viewportData,
  imageIds,
  imageIdToIndex,
  loadedBatchIntervalMs,
}: {
  isFullMode: boolean;
  numberOfSlices: number;
  viewportData: ViewportData;
  imageIds: string[];
  imageIdToIndex: Map<string, number>;
  loadedBatchIntervalMs: number;
}) {
  const loadedState = useByteArray(numberOfSlices || 0, loadedBatchIntervalMs);
  const {
    resetWith: resetLoaded,
    setByte: setLoadedByte,
    clearByte: clearLoadedByte,
  } = loadedState;
 
  /**
   * Keeps the loaded byte array in sync with Cornerstone cache: seed from cache whenever stack /
   * mode / slice count changes, then subscribe so cache add/remove updates stay incremental.
   * Seeding runs immediately before registering listeners in the same effect.
   */
  useEffect(() => {
    if (isFullMode && numberOfSlices) {
      resetLoaded(bytes => {
        for (let i = 0; i < bytes.length; i++) {
          const imageId = imageIds[i];
          if (imageId && cornerstoneCache.isLoaded(imageId)) {
            bytes[i] = 1;
          }
        }
      });
    }
 
    if (!isFullMode || !viewportData) {
      return;
    }
 
    const markLoaded = event => {
      const imageId = getImageIdFromCacheEvent(event);
      Iif (!imageId) {
        return;
      }
      const index = imageIdToIndex.get(imageId);
      if (index !== undefined) {
        setLoadedByte(index);
      }
    };
 
    const markRemoved = event => {
      const imageId = getImageIdFromCacheEvent(event);
      Iif (!imageId) {
        return;
      }
      const index = imageIdToIndex.get(imageId);
      Iif (index !== undefined) {
        clearLoadedByte(index);
      }
    };
 
    eventTarget.addEventListener(Enums.Events.IMAGE_CACHE_IMAGE_ADDED, markLoaded);
    eventTarget.addEventListener(Enums.Events.IMAGE_CACHE_IMAGE_REMOVED, markRemoved);
 
    return () => {
      eventTarget.removeEventListener(Enums.Events.IMAGE_CACHE_IMAGE_ADDED, markLoaded);
      eventTarget.removeEventListener(Enums.Events.IMAGE_CACHE_IMAGE_REMOVED, markRemoved);
    };
  }, [
    imageIds,
    isFullMode,
    numberOfSlices,
    viewportData,
    imageIdToIndex,
    resetLoaded,
    setLoadedByte,
    clearLoadedByte,
  ]);
 
  return loadedState;
}
 
export function useViewedSliceBytes({
  isFullMode,
  numberOfSlices,
  imageIndex,
  imageIds,
  imageIdToIndex,
  viewedDwellMs,
  viewedDataService,
}: {
  isFullMode: boolean;
  numberOfSlices: number;
  imageIndex: number;
  imageIds: string[];
  imageIdToIndex: Map<string, number>;
  viewedDwellMs: number;
  viewedDataService: AppTypes.ViewedDataService;
}) {
  const viewedState = useByteArray(numberOfSlices || 0);
  const { resetWith: resetViewed, setByte: setViewedByte } = viewedState;
 
  /**
   * Keeps the viewed byte array in sync with the global viewed-data store: seed from the store
   * whenever stack / mode / slice count changes, then subscribe so `markDataViewed` updates stay
   * incremental. Seeding runs immediately before registering the listener in the same effect.
   */
  useEffect(() => {
    if (isFullMode && numberOfSlices) {
      resetViewed(bytes => {
        for (let i = 0; i < bytes.length; i++) {
          const imageId = imageIds[i];
          if (imageId && viewedDataService?.isDataViewed(imageId)) {
            bytes[i] = 1;
          }
        }
      });
    }
 
    Iif (!viewedDataService) {
      return;
    }
 
    const subscription = viewedDataService.subscribeViewedDataChanges(
      ({
        viewedDataId,
        viewedDataCleared,
      }: {
        viewedDataId?: string;
        viewedDataCleared?: boolean;
      }) => {
        if (!isFullMode || !numberOfSlices) {
          return;
        }
 
        Iif (viewedDataCleared) {
          resetViewed(bytes => {
            bytes.fill(0);
          });
          return;
        }
 
        const index = imageIdToIndex.get(viewedDataId);
        if (index !== undefined) {
          setViewedByte(index);
        }
      }
    );
 
    return () => {
      subscription.unsubscribe();
    };
  }, [
    imageIds,
    isFullMode,
    numberOfSlices,
    imageIdToIndex,
    resetViewed,
    setViewedByte,
    viewedDataService,
  ]);
 
  /**
   * Marks slices as viewed in full mode. With `viewedDwellMs === 0`, marking is immediate on
   * index change; otherwise a dwell timer is used and cleaned up on subsequent changes/unmount.
   */
  useEffect(() => {
    if (!isFullMode || !numberOfSlices) {
      return;
    }
 
    const markViewed = (targetIndex: number) => {
      setViewedByte(targetIndex);
      const imageId = imageIds[targetIndex];
      if (imageId) {
        viewedDataService?.markDataViewed(imageId);
      }
    };
 
    if (viewedDwellMs === 0) {
      markViewed(imageIndex || 0);
      return;
    }
 
    const timerId = window.setTimeout(() => {
      markViewed(imageIndex || 0);
    }, viewedDwellMs);
 
    return () => {
      window.clearTimeout(timerId);
    };
  }, [
    isFullMode,
    numberOfSlices,
    imageIndex,
    imageIds,
    setViewedByte,
    viewedDwellMs,
    viewedDataService,
  ]);
 
  return viewedState;
}