copper3d 3.0.1 → 3.1.0

package/dist/index.d.ts

@@ -17,10 +17,13 @@ import { Copper3dTrackballControls } from "./Controls/Copper3dTrackballControls"
 import { MeshNodeTool } from "./Utils/MeshNodeTool";
 import { removeGuiFolderChilden } from "./Utils/segmentation/coreTools/gui";
 import { nrrdMeshesType, nrrdSliceType, SensorDecodedValue_kiwrious, SensorReadResult_kiwrious, HeartRateResult_kiwrious, loadingBarType, exportPaintImageType, IOptVTKLoader } from "./types/types";
-import { IPaintImage, ICommXYZ, IGUIStates, IGuiParameterSettings, INrrdStates } from "./Utils/segmentation/coreTools/coreType";
+import { IPaintImage, ICommXYZ, IGUIStates, IGuiParameterSettings, INrrdStates, IGuiMeta } from "./Utils/segmentation/core/types";
+import { NrrdState } from "./Utils/segmentation/coreTools/NrrdState";
+import { GuiState } from "./Utils/segmentation/coreTools/GuiState";
+import type { ToolMode, IAnnotationCallbacks } from "./Utils/segmentation/core/types";
 import { CHANNEL_COLORS, CHANNEL_HEX_COLORS, rgbaToHex, rgbaToCss } from "./Utils/segmentation/core/index";
 import type { LayerId, ChannelValue } from "./Utils/segmentation/core/index";
 import "./css/style.css";
-export declare const REVISION = "v3.0.1-beta";
+export declare const REVISION = "v3.1.0-beta";
 export { copperRenderer, copperRendererOnDemond, copperMSceneRenderer, setHDRFilePath, addLabelToScene, convert3DPostoScreenPos, convertScreenPosto3DPos, addBoxHelper, fullScreenListenner, configKiwriousHeart, copperScene, copperSceneOnDemond, copperMScene, CameraViewPoint, kiwrious, NrrdTools, loading, Copper3dTrackballControls, createTexture2D_NRRD, MeshNodeTool, throttle, removeGuiFolderChilden, CHANNEL_COLORS, CHANNEL_HEX_COLORS, rgbaToHex, rgbaToCss, };
-export type { positionType, screenPosType, optsType, nrrdMeshesType, nrrdSliceType, SensorDecodedValue_kiwrious, SensorReadResult_kiwrious, HeartRateResult_kiwrious, loadingBarType, IPaintImage, exportPaintImageType, IOptVTKLoader, ICommXYZ, IGUIStates, IGuiParameterSettings, INrrdStates, LayerId, ChannelValue, };
+export type { positionType, screenPosType, optsType, nrrdMeshesType, nrrdSliceType, SensorDecodedValue_kiwrious, SensorReadResult_kiwrious, HeartRateResult_kiwrious, loadingBarType, IPaintImage, exportPaintImageType, IOptVTKLoader, ICommXYZ, IGUIStates, IGuiParameterSettings, INrrdStates, NrrdState, GuiState, IGuiMeta, ToolMode, IAnnotationCallbacks, LayerId, ChannelValue, };

package/dist/index.js

@@ -20,7 +20,7 @@ import { MeshNodeTool } from "./Utils/MeshNodeTool";
 import { removeGuiFolderChilden } from "./Utils/segmentation/coreTools/gui";
 import { CHANNEL_COLORS, CHANNEL_HEX_COLORS, rgbaToHex, rgbaToCss } from "./Utils/segmentation/core/index";
 import "./css/style.css";
-export const REVISION = "v3.0.1-beta";
+export const REVISION = "v3.1.0-beta";
 console.log(`%cCopper3D Visualisation %cBeta:${REVISION}`, "padding: 3px;color:white; background:#023047", "padding: 3px;color:white; background:#f50a25");
 export { copperRenderer, copperRendererOnDemond, copperMSceneRenderer, setHDRFilePath, addLabelToScene, convert3DPostoScreenPos, convertScreenPosto3DPos, addBoxHelper, fullScreenListenner, configKiwriousHeart, copperScene, copperSceneOnDemond, copperMScene, CameraViewPoint, kiwrious, NrrdTools, loading, Copper3dTrackballControls, createTexture2D_NRRD, MeshNodeTool, throttle, removeGuiFolderChilden, CHANNEL_COLORS, CHANNEL_HEX_COLORS, rgbaToHex, rgbaToCss, };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uDAAuD;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,eAAe,EAGf,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAY,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,QAAQ,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC3D,iDAAiD;AAEjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAc5E,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAG3G,OAAO,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,QAAQ,GAAG,aAAa,CAAC;AAEtC,OAAO,CAAC,GAAG,CACT,mCAAmC,QAAQ,EAAE,EAC7C,8CAA8C,EAC9C,8CAA8C,CAC/C,CAAC;AAEF,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,SAAS,EACT,OAAO,EACP,yBAAyB,EACzB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,sBAAsB,EACtB,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,SAAS,GACV,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uDAAuD;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,eAAe,EAGf,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAY,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAEzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,QAAQ,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC3D,iDAAiD;AAEjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAiB5E,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAG3G,OAAO,iBAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,QAAQ,GAAG,aAAa,CAAC;AAEtC,OAAO,CAAC,GAAG,CACT,mCAAmC,QAAQ,EAAE,EAC7C,8CAA8C,EAC9C,8CAA8C,CAC/C,CAAC;AAEF,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,SAAS,EACT,OAAO,EACP,yBAAyB,EACzB,oBAAoB,EACpB,YAAY,EACZ,QAAQ,EACR,sBAAsB,EACtB,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,SAAS,GACV,CAAC"}

package/dist/types/Utils/segmentation/CanvasState.d.ts

@@ -0,0 +1,31 @@
+import { IProtected, ICursorPage, IKeyBoardSettings, IAnnotationCallbacks } from "./core/types";
+import { NrrdState } from "./coreTools/NrrdState";
+import { GuiState } from "./coreTools/GuiState";
+/**
+ * CanvasState — Pure state container.
+ *
+ * Holds all shared mutable state that was previously scattered across the
+ * CommToolsData base class.  No rendering logic lives here; rendering is
+ * handled by {@link RenderingUtils}.
+ *
+ * Created once by NrrdTools and shared (by reference) with DrawToolCore,
+ * RenderingUtils, DragOperator, and all legacy Tool instances.
+ */
+export declare class CanvasState {
+    baseCanvasesSize: number;
+    /** External annotation callbacks — set via draw() options */
+    annotationCallbacks: IAnnotationCallbacks;
+    /** Whether the keyboard-config dialog is open (suppresses all shortcuts). */
+    configKeyBoard: boolean;
+    /** Active keyboard shortcut bindings. */
+    keyboardSettings: IKeyBoardSettings;
+    nrrd_states: NrrdState;
+    gui_states: GuiState;
+    protectedData: IProtected;
+    cursorPage: ICursorPage;
+    constructor(container: HTMLElement, mainAreaContainer: HTMLElement, options?: {
+        layers?: string[];
+    });
+    private generateSystemCanvases;
+    private generateLayerTargets;
+}

package/dist/types/Utils/segmentation/DragOperator.d.ts

@@ -1,4 +1,6 @@
-import { IDragOpts, IDrawingEvents, IProtected, IGUIStates, INrrdStates } from "./coreTools/coreType";
+import { IDragOpts, IDrawingEvents, IProtected } from "./core/types";
+import { NrrdState } from "./coreTools/NrrdState";
+import { GuiState } from "./coreTools/GuiState";
 import type { EventRouter } from "./eventRouter";
 export declare class DragOperator {
     container: HTMLElement;
@@ -16,10 +18,16 @@ export declare class DragOperator {
     private setEmptyCanvasSize;
     private getOrCreateSliceBuffer;
     private renderSliceToCanvas;
+    private refreshSphereOverlayCb;
     private eventRouter;
-    constructor(container: HTMLElement, nrrd_sates: INrrdStates, gui_states: IGUIStates, protectedData: IProtected, drawingPrameters: IDrawingEvents, setSyncsliceNum: () => void, setIsDrawFalse: (target: number) => void, flipDisplayImageByAxis: () => void, setEmptyCanvasSize: (axis?: "x" | "y" | "z") => void, getOrCreateSliceBuffer: (axis: "x" | "y" | "z") => ImageData | null, renderSliceToCanvas: (layer: string, axis: "x" | "y" | "z", sliceIndex: number, buffer: ImageData, targetCtx: CanvasRenderingContext2D, scaledWidth: number, scaledHeight: number) => void);
+    constructor(container: HTMLElement, nrrd_sates: NrrdState, gui_states: GuiState, protectedData: IProtected, drawingPrameters: IDrawingEvents, setSyncsliceNum: () => void, setIsDrawFalse: (target: number) => void, flipDisplayImageByAxis: () => void, setEmptyCanvasSize: (axis?: "x" | "y" | "z") => void, getOrCreateSliceBuffer: (axis: "x" | "y" | "z") => ImageData | null, renderSliceToCanvas: (layer: string, axis: "x" | "y" | "z", sliceIndex: number, buffer: ImageData, targetCtx: CanvasRenderingContext2D, scaledWidth: number, scaledHeight: number) => void);
     private init;
     setShowDragNumberDiv(sliceIndexContainer: HTMLDivElement): void;
+    /**
+     * Set the sphere overlay refresh callback.
+     * Called by NrrdTools after DrawToolCore is initialized.
+     */
+    setRefreshSphereOverlay(cb: () => void): void;
     /**
      * Set the EventRouter reference for centralized event handling.
      * Called by NrrdTools/DrawToolCore after EventRouter is initialized.

package/dist/types/Utils/segmentation/DrawToolCore.d.ts

@@ -1,51 +1,66 @@
-import { IConvertObjType, IDrawingEvents, IContrastEvents, IDrawOpts } from "./coreTools/coreType";
-import { CommToolsData } from "./CommToolsData";
+import { IConvertObjType, IDrawingEvents, IContrastEvents, IDrawOpts } from "./core/types";
+import { CanvasState } from "./CanvasState";
+import { RenderingUtils } from "./RenderingUtils";
 import { EventRouter } from "./eventRouter";
 import { SphereTool } from "./tools/SphereTool";
 import { CrosshairTool } from "./tools/CrosshairTool";
 import { ContrastTool } from "./tools/ContrastTool";
 import { ZoomTool } from "./tools/ZoomTool";
 import { EraserTool } from "./tools/EraserTool";
+import { PanTool } from "./tools/PanTool";
+import { DrawingTool } from "./tools/DrawingTool";
 import { ImageStoreHelper } from "./tools/ImageStoreHelper";
 import { UndoManager } from "./core";
-export declare class DrawToolCore extends CommToolsData {
+/**
+ * DrawToolCore — Tool orchestration and event routing.
+ *
+ * Previously extended CommToolsData; now uses composition:
+ * - `state: CanvasState` — pure state container
+ * - `renderer: RenderingUtils` — rendering / slice-buffer helpers
+ *
+ * Created by NrrdTools which passes in a shared CanvasState.
+ */
+export declare class DrawToolCore {
     container: HTMLElement;
     mainAreaContainer: HTMLDivElement;
+    /** Shared state container (created by NrrdTools, passed in). */
+    readonly state: CanvasState;
+    /** Rendering utilities (created here, uses shared state). */
+    readonly renderer: RenderingUtils;
     drawingPrameters: IDrawingEvents;
     contrastEventPrameters: IContrastEvents;
     eraserUrls: string[];
     pencilUrls: string[];
     undoManager: UndoManager;
-    /** Snapshot of the active layer's slice captured on mouse-down (before drawing). */
-    private preDrawSlice;
-    private preDrawAxis;
-    private preDrawSliceIndex;
-    protected eventRouter: EventRouter | null;
-    protected sphereTool: SphereTool;
-    protected crosshairTool: CrosshairTool;
+    eventRouter: EventRouter;
+    sphereTool: SphereTool;
+    crosshairTool: CrosshairTool;
     protected contrastTool: ContrastTool;
     protected zoomTool: ZoomTool;
     protected eraserTool: EraserTool;
+    protected panTool: PanTool;
+    protected drawingTool: DrawingTool;
     protected imageStoreHelper: ImageStoreHelper;
+    /** Slice index recorded when paintOnCanvas() starts, guards stale-click */
+    private paintSliceIndex;
+    /** Wheel event dispatch mode — replaces manual wheel add/remove (Phase 2) */
+    private activeWheelMode;
     start: () => void;
-    constructor(container: HTMLElement, options?: {
-        layers?: string[];
-    });
+    constructor(container: HTMLElement, state: CanvasState);
     private initTools;
     private initDrawToolCore;
     setEraserUrls(urls: string[]): void;
     setPencilIconUrls(urls: string[]): void;
     private setCurrentLayer;
     draw(opts?: IDrawOpts): void;
-    drawCalSphereDown(x: number, y: number, sliceIndex: number, cal_position: "tumour" | "skin" | "nipple" | "ribcage"): void;
-    drawCalSphereUp(): void;
     private zoomActionAfterDrawSphere;
-    private clearSpherePrintStoreImages;
     private paintOnCanvas;
-    /*************************************May consider to move outside *******************************************/
-    private drawLine;
-    private drawLinesOnLayer;
-    private paintOnCanvasLayer;
+    /**
+     * Extracted from paintOnCanvas() pointerleave handler.
+     */
+    private handlePointerLeave;
+    /** Extracted from paintOnCanvas() — handles sphere placement on left-click */
+    private handleSphereClick;
     private initAllCanvas;
     private useEraser;
     configMouseZoomWheel(): (e: WheelEvent) => void;
@@ -54,10 +69,13 @@ export declare class DrawToolCore extends CommToolsData {
     drawImageOnEmptyImage(canvas: HTMLCanvasElement): void;
     /****************************Sphere functions (delegated to SphereTool)****************************************************/
     drawCalculatorSphereOnEachViews(axis: "x" | "y" | "z"): void;
-    private drawSphereOnEachViews;
     private configMouseSphereWheel;
     drawCalculatorSphere(radius: number): void;
     drawSphere(mouseX: number, mouseY: number, radius: number): void;
+    /**
+     * Refresh sphere canvas from sphereMaskVolume for the current slice/axis.
+     */
+    refreshSphereOverlay(): void;
     /**
      * Convert cursor point between axis views.
      * Delegated to CrosshairTool.
@@ -68,38 +86,49 @@ export declare class DrawToolCore extends CommToolsData {
     getRestLayer(): string[];
     /**************************** Undo/Redo functions (Phase 6 — Delta-based) ****************************/
     /**
-     * Clear mask on current slice canvas.
-     *
-     * Only clears the active layer's MaskVolume slice data.
-     * Other layers are left untouched. After clearing, all layer canvases
-     * are re-rendered from MaskVolume to keep visuals in sync.
+     * Clear the mask on the current slice canvas for the active layer ONLY.
      */
-    clearPaint(): void;
+    clearActiveSlice(): void;
     /**
      * Undo the last drawing operation on the active layer.
-     * Restores the MaskVolume slice to its pre-draw state, re-renders
-     * the canvas, and notifies the backend.
      */
     undoLastPainting(): void;
     /**
      * Redo the last undone operation on the active layer.
-     * Reapplies the MaskVolume slice to its post-draw state, re-renders
-     * the canvas, and notifies the backend.
      */
     redoLastPainting(): void;
     /**
      * Re-render a layer canvas from MaskVolume and composite to master.
-     * Called after writing oldSlice/newSlice back to the volume during undo/redo.
      */
     private applyUndoRedoToCanvas;
     /****************************Store images (delegated to ImageStoreHelper)****************************************************/
-    storeAllImages(index: number, layer: string): void;
-    storeImageToLayer(index: number, canvas: HTMLCanvasElement): ImageData;
-    storeEachLayerImage(index: number, layer: string): void;
+    syncLayerSliceData(index: number, layer: string): void;
     /******************************** Utils gui related functions (delegated to ContrastTool) ***************************************/
     setupConrastEvents(callback: (step: number, towards: "horizental" | "vertical") => void): void;
     configContrastDragMode: () => void;
     removeContrastDragMode: () => void;
     updateSlicesContrast: (value: number, flag: string) => void;
     repraintCurrentContrastSlice: () => void;
+    /** Override in NrrdTools */
+    setIsDrawFalse(target: number): void;
+    /** Override in NrrdTools */
+    setSyncsliceNum(): void;
+    /** Override in NrrdTools */
+    resetPaintAreaUIPosition(l?: number, t?: number): void;
+    /** Override in NrrdTools */
+    resizePaintArea(factor: number): void;
+    /** Override in NrrdTools */
+    setEmptyCanvasSize(axis?: "x" | "y" | "z"): void;
+    /** Override in NrrdTools */
+    flipDisplayImageByAxis(): void;
+    /** Override in NrrdTools */
+    updateOriginAndChangedWH(): void;
+    /** Override in NrrdTools */
+    resetLayerCanvas(): void;
+    /** Override in NrrdTools */
+    redrawDisplayCanvas(): void;
+    /** Override in NrrdTools */
+    enterSphereMode(): void;
+    /** Override in NrrdTools */
+    exitSphereMode(): void;
 }