@cornerstonejs/tools 2.0.0-beta.2 → 2.0.0-beta.3

package/dist/cjs/tools/OrientationMarkerTool.d.ts

@@ -0,0 +1,88 @@
+import vtkAnnotatedCubeActor from '@kitware/vtk.js/Rendering/Core/AnnotatedCubeActor';
+import { BaseTool } from './base';
+declare class OrientationMarkerTool extends BaseTool {
+    static toolName: any;
+    static CUBE: number;
+    static AXIS: number;
+    static VTPFILE: number;
+    orientationMarkers: any;
+    polyDataURL: any;
+    static OVERLAY_MARKER_TYPES: {
+        ANNOTATED_CUBE: number;
+        AXES: number;
+        CUSTOM: number;
+    };
+    configuration_invalidated: boolean;
+    constructor(toolProps?: {}, defaultToolProps?: {
+        configuration: {
+            orientationWidget: {
+                enabled: boolean;
+                viewportCorner: import("@kitware/vtk.js/Interaction/Widgets/OrientationMarkerWidget/Constants").Corners;
+                viewportSize: number;
+                minPixelSize: number;
+                maxPixelSize: number;
+            };
+            overlayMarkerType: number;
+            overlayConfiguration: {
+                [x: number]: {
+                    faceProperties: {
+                        xPlus: {
+                            text: string;
+                            faceColor: string;
+                            faceRotation: number;
+                        };
+                        xMinus: {
+                            text: string;
+                            faceColor: string;
+                            faceRotation: number;
+                        };
+                        yPlus: {
+                            text: string;
+                            faceColor: string;
+                            fontColor: string;
+                            faceRotation: number;
+                        };
+                        yMinus: {
+                            text: string;
+                            faceColor: string;
+                            fontColor: string;
+                        };
+                        zPlus: {
+                            text: string;
+                        };
+                        zMinus: {
+                            text: string;
+                        };
+                    };
+                    defaultStyle: {
+                        fontStyle: string;
+                        fontFamily: string;
+                        fontColor: string;
+                        fontSizeScale: (res: any) => number;
+                        faceColor: string;
+                        edgeThickness: number;
+                        edgeColor: string;
+                        resolution: number;
+                    };
+                    polyDataURL?: undefined;
+                } | {
+                    faceProperties?: undefined;
+                    defaultStyle?: undefined;
+                    polyDataURL?: undefined;
+                } | {
+                    polyDataURL: string;
+                    faceProperties?: undefined;
+                    defaultStyle?: undefined;
+                };
+            };
+        };
+    });
+    onSetToolEnabled: () => void;
+    onSetToolActive: () => void;
+    private initViewports;
+    addAxisActorInViewport(viewport: any): Promise<void>;
+    private createCustomActor;
+    private createAnnotationCube;
+    createAnnotatedCubeActor(): Promise<vtkAnnotatedCubeActor>;
+}
+export default OrientationMarkerTool;

package/dist/cjs/tools/OrientationMarkerTool.js

@@ -0,0 +1,193 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const OrientationMarkerWidget_1 = __importDefault(require("@kitware/vtk.js/Interaction/Widgets/OrientationMarkerWidget"));
+const AnnotatedCubeActor_1 = __importDefault(require("@kitware/vtk.js/Rendering/Core/AnnotatedCubeActor"));
+const AxesActor_1 = __importDefault(require("@kitware/vtk.js/Rendering/Core/AxesActor"));
+const Actor_1 = __importDefault(require("@kitware/vtk.js/Rendering/Core/Actor"));
+const Mapper_1 = __importDefault(require("@kitware/vtk.js/Rendering/Core/Mapper"));
+const XMLPolyDataReader_1 = __importDefault(require("@kitware/vtk.js/IO/XML/XMLPolyDataReader"));
+const PolyData_1 = __importDefault(require("@kitware/vtk.js/Common/DataModel/PolyData"));
+const base_1 = require("./base");
+const core_1 = require("@cornerstonejs/core");
+const viewportFilters_1 = require("../utilities/viewportFilters");
+const OverlayMarkerType = {
+    ANNOTATED_CUBE: 1,
+    AXES: 2,
+    CUSTOM: 3,
+};
+class OrientationMarkerTool extends base_1.BaseTool {
+    constructor(toolProps = {}, defaultToolProps = {
+        configuration: {
+            orientationWidget: {
+                enabled: true,
+                viewportCorner: OrientationMarkerWidget_1.default.Corners.BOTTOM_RIGHT,
+                viewportSize: 0.15,
+                minPixelSize: 100,
+                maxPixelSize: 300,
+            },
+            overlayMarkerType: OrientationMarkerTool.OVERLAY_MARKER_TYPES.ANNOTATED_CUBE,
+            overlayConfiguration: {
+                [OrientationMarkerTool.OVERLAY_MARKER_TYPES.ANNOTATED_CUBE]: {
+                    faceProperties: {
+                        xPlus: { text: 'R', faceColor: '#ffff00', faceRotation: 90 },
+                        xMinus: { text: 'L', faceColor: '#ffff00', faceRotation: 270 },
+                        yPlus: {
+                            text: 'P',
+                            faceColor: '#00ffff',
+                            fontColor: 'white',
+                            faceRotation: 180,
+                        },
+                        yMinus: { text: 'A', faceColor: '#00ffff', fontColor: 'white' },
+                        zPlus: { text: 'S' },
+                        zMinus: { text: 'I' },
+                    },
+                    defaultStyle: {
+                        fontStyle: 'bold',
+                        fontFamily: 'Arial',
+                        fontColor: 'black',
+                        fontSizeScale: (res) => res / 2,
+                        faceColor: '#0000ff',
+                        edgeThickness: 0.1,
+                        edgeColor: 'black',
+                        resolution: 400,
+                    },
+                },
+                [OrientationMarkerTool.OVERLAY_MARKER_TYPES.AXES]: {},
+                [OrientationMarkerTool.OVERLAY_MARKER_TYPES.CUSTOM]: {
+                    polyDataURL: 'https://raw.githubusercontent.com/Slicer/Slicer/80ad0a04dacf134754459557bf2638c63f3d1d1b/Base/Logic/Resources/OrientationMarkers/Human.vtp',
+                },
+            },
+        },
+    }) {
+        super(toolProps, defaultToolProps);
+        this.configuration_invalidated = true;
+        this.onSetToolEnabled = () => {
+            this.initViewports();
+            this.configuration_invalidated = true;
+        };
+        this.onSetToolActive = () => {
+            this.initViewports();
+        };
+        this.orientationMarkers = {};
+        this.configuration_invalidated = true;
+    }
+    initViewports() {
+        const renderingEngines = (0, core_1.getRenderingEngines)();
+        const renderingEngine = renderingEngines[0];
+        if (!renderingEngine) {
+            return;
+        }
+        let viewports = renderingEngine.getViewports();
+        viewports = (0, viewportFilters_1.filterViewportsWithToolEnabled)(viewports, this.getToolName());
+        viewports.forEach((viewport) => this.addAxisActorInViewport(viewport));
+    }
+    addAxisActorInViewport(viewport) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const viewportId = viewport.id;
+            const type = this.configuration.overlayMarkerType;
+            const overlayConfiguration = this.configuration.overlayConfiguration[type];
+            if (this.orientationMarkers[viewportId]) {
+                const { actor, orientationWidget } = this.orientationMarkers[viewportId];
+                viewport.getRenderer().removeActor(actor);
+                orientationWidget.setEnabled(false);
+            }
+            let actor;
+            if (type === 1) {
+                actor = this.createAnnotationCube(overlayConfiguration);
+            }
+            else if (type === 2) {
+                actor = AxesActor_1.default.newInstance();
+            }
+            else if (type === 3) {
+                actor = yield this.createCustomActor();
+            }
+            const renderer = viewport.getRenderer();
+            const renderWindow = viewport
+                .getRenderingEngine()
+                .offscreenMultiRenderWindow.getRenderWindow();
+            const { enabled, viewportCorner, viewportSize, minPixelSize, maxPixelSize, } = this.configuration.orientationWidget;
+            const orientationWidget = OrientationMarkerWidget_1.default.newInstance({
+                actor,
+                interactor: renderWindow.getInteractor(),
+                parentRenderer: renderer,
+            });
+            orientationWidget.setEnabled(enabled);
+            orientationWidget.setViewportCorner(viewportCorner);
+            orientationWidget.setViewportSize(viewportSize);
+            orientationWidget.setMinPixelSize(minPixelSize);
+            orientationWidget.setMaxPixelSize(maxPixelSize);
+            orientationWidget.updateMarkerOrientation();
+            this.orientationMarkers[viewportId] = {
+                orientationWidget,
+                actor,
+            };
+            renderer.resetCamera();
+            renderWindow.render();
+            viewport.getRenderingEngine().render();
+            this.configuration_invalidated = false;
+        });
+    }
+    createCustomActor() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = this.configuration.overlayConfiguration[OverlayMarkerType.CUSTOM]
+                .polyDataURL;
+            const response = yield fetch(url);
+            const arrayBuffer = yield response.arrayBuffer();
+            const vtpReader = XMLPolyDataReader_1.default.newInstance();
+            vtpReader.parseAsArrayBuffer(arrayBuffer);
+            vtpReader.update();
+            const polyData = PolyData_1.default.newInstance();
+            polyData.shallowCopy(vtpReader.getOutputData());
+            polyData.getPointData().setActiveScalars('Color');
+            const mapper = Mapper_1.default.newInstance();
+            mapper.setInputData(polyData);
+            mapper.setColorModeToDirectScalars();
+            const actor = Actor_1.default.newInstance();
+            actor.setMapper(mapper);
+            actor.rotateZ(180);
+            return actor;
+        });
+    }
+    createAnnotationCube(overlayConfiguration) {
+        const actor = AnnotatedCubeActor_1.default.newInstance();
+        actor.setDefaultStyle(Object.assign({}, overlayConfiguration.defaultStyle));
+        actor.setXPlusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.xPlus));
+        actor.setXMinusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.xMinus));
+        actor.setYPlusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.yPlus));
+        actor.setYMinusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.yMinus));
+        actor.setZPlusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.zPlus));
+        actor.setZMinusFaceProperty(Object.assign({}, overlayConfiguration.faceProperties.zMinus));
+        return actor;
+    }
+    createAnnotatedCubeActor() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const axes = AnnotatedCubeActor_1.default.newInstance();
+            const { faceProperties, defaultStyle } = this.configuration.annotatedCube;
+            axes.setDefaultStyle(defaultStyle);
+            Object.keys(faceProperties).forEach((key) => {
+                const methodName = `set${key.charAt(0).toUpperCase() + key.slice(1)}FaceProperty`;
+                axes[methodName](faceProperties[key]);
+            });
+            return axes;
+        });
+    }
+}
+OrientationMarkerTool.CUBE = 1;
+OrientationMarkerTool.AXIS = 2;
+OrientationMarkerTool.VTPFILE = 3;
+OrientationMarkerTool.OVERLAY_MARKER_TYPES = OverlayMarkerType;
+OrientationMarkerTool.toolName = 'OrientationMarker';
+exports.default = OrientationMarkerTool;
+//# sourceMappingURL=OrientationMarkerTool.js.map

package/dist/cjs/tools/OrientationMarkerTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrientationMarkerTool.js","sourceRoot":"","sources":["../../../src/tools/OrientationMarkerTool.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0HAAqG;AACrG,2GAAsF;AACtF,yFAAoE;AACpE,iFAA4D;AAC5D,mFAA8D;AAC9D,iGAA4E;AAC5E,yFAAoE;AAEpE,iCAAkC;AAClC,8CAA0D;AAC1D,kEAA8E;AAE9E,MAAM,iBAAiB,GAAG;IACxB,cAAc,EAAE,CAAC;IACjB,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;CACV,CAAC;AAMF,MAAM,qBAAsB,SAAQ,eAAQ;IAY1C,YACE,SAAS,GAAG,EAAE,EACd,gBAAgB,GAAG;QACjB,aAAa,EAAE;YACb,iBAAiB,EAAE;gBACjB,OAAO,EAAE,IAAI;gBACb,cAAc,EAAE,iCAA0B,CAAC,OAAO,CAAC,YAAY;gBAC/D,YAAY,EAAE,IAAI;gBAClB,YAAY,EAAE,GAAG;gBACjB,YAAY,EAAE,GAAG;aAClB;YACD,iBAAiB,EACf,qBAAqB,CAAC,oBAAoB,CAAC,cAAc;YAC3D,oBAAoB,EAAE;gBACpB,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,cAAc,CAAC,EAAE;oBAC3D,cAAc,EAAE;wBACd,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE;wBAC5D,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,EAAE;wBAC9D,KAAK,EAAE;4BACL,IAAI,EAAE,GAAG;4BACT,SAAS,EAAE,SAAS;4BACpB,SAAS,EAAE,OAAO;4BAClB,YAAY,EAAE,GAAG;yBAClB;wBACD,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;wBAC/D,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;wBACpB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;qBACtB;oBACD,YAAY,EAAE;wBACZ,SAAS,EAAE,MAAM;wBACjB,UAAU,EAAE,OAAO;wBACnB,SAAS,EAAE,OAAO;wBAClB,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC;wBAC/B,SAAS,EAAE,SAAS;wBACpB,aAAa,EAAE,GAAG;wBAClB,SAAS,EAAE,OAAO;wBAClB,UAAU,EAAE,GAAG;qBAChB;iBACF;gBACD,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,EAAE;gBACrD,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE;oBACnD,WAAW,EACT,4IAA4I;iBAC/I;aACF;SACF;KACF;QAED,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAlDrC,8BAAyB,GAAG,IAAI,CAAC;QAuDjC,qBAAgB,GAAG,GAAS,EAAE;YAC5B,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;QACxC,CAAC,CAAC;QAEF,oBAAe,GAAG,GAAS,EAAE;YAC3B,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC;QAXA,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;IACxC,CAAC;IAWO,aAAa;QACnB,MAAM,gBAAgB,GAAG,IAAA,0BAAmB,GAAE,CAAC;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAE5C,IAAI,CAAC,eAAe,EAAE;YACpB,OAAO;SACR;QAED,IAAI,SAAS,GAAG,eAAe,CAAC,YAAY,EAAE,CAAC;QAC/C,SAAS,GAAG,IAAA,gDAA8B,EAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1E,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,CAAC;IAEK,sBAAsB,CAAC,QAAQ;;YACnC,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;YAElD,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAE3E,IAAI,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;gBACvC,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;gBAEzE,QAAQ,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAC1C,iBAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;aACrC;YAED,IAAI,KAAK,CAAC;YACV,IAAI,IAAI,KAAK,CAAC,EAAE;gBACd,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;aACzD;iBAAM,IAAI,IAAI,KAAK,CAAC,EAAE;gBACrB,KAAK,GAAG,mBAAY,CAAC,WAAW,EAAE,CAAC;aACpC;iBAAM,IAAI,IAAI,KAAK,CAAC,EAAE;gBACrB,KAAK,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;aACxC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;YACxC,MAAM,YAAY,GAAG,QAAQ;iBAC1B,kBAAkB,EAAE;iBACpB,0BAA0B,CAAC,eAAe,EAAE,CAAC;YAEhD,MAAM,EACJ,OAAO,EACP,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,YAAY,GACb,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;YAEzC,MAAM,iBAAiB,GAAG,iCAA0B,CAAC,WAAW,CAAC;gBAC/D,KAAK;gBACL,UAAU,EAAE,YAAY,CAAC,aAAa,EAAE;gBACxC,cAAc,EAAE,QAAQ;aACzB,CAAC,CAAC;YAEH,iBAAiB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACtC,iBAAiB,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;YACpD,iBAAiB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAChD,iBAAiB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAChD,iBAAiB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAEhD,iBAAiB,CAAC,uBAAuB,EAAE,CAAC;YAC5C,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG;gBACpC,iBAAiB;gBACjB,KAAK;aACN,CAAC;YACF,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,YAAY,CAAC,MAAM,EAAE,CAAC;YACtB,QAAQ,CAAC,kBAAkB,EAAE,CAAC,MAAM,EAAE,CAAC;YAEvC,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC;QACzC,CAAC;KAAA;IAEa,iBAAiB;;YAC7B,MAAM,GAAG,GACP,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,MAAM,CAAC;iBAC9D,WAAW,CAAC;YAEjB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;YACjD,MAAM,SAAS,GAAG,2BAAoB,CAAC,WAAW,EAAE,CAAC;YACrD,SAAS,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC1C,SAAS,CAAC,MAAM,EAAE,CAAC;YAEnB,MAAM,QAAQ,GAAG,kBAAW,CAAC,WAAW,EAAE,CAAC;YAC3C,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC;YAChD,QAAQ,CAAC,YAAY,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAClD,MAAM,MAAM,GAAG,gBAAS,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC9B,MAAM,CAAC,2BAA2B,EAAE,CAAC;YAErC,MAAM,KAAK,GAAG,eAAQ,CAAC,WAAW,EAAE,CAAC;YACrC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACxB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;IAEO,oBAAoB,CAAC,oBAAyB;QACpD,MAAM,KAAK,GAAG,4BAAqB,CAAC,WAAW,EAAE,CAAC;QAClD,KAAK,CAAC,eAAe,mBAAM,oBAAoB,CAAC,YAAY,EAAG,CAAC;QAChE,KAAK,CAAC,oBAAoB,mBACrB,oBAAoB,CAAC,cAAc,CAAC,KAAK,EAC5C,CAAC;QACH,KAAK,CAAC,qBAAqB,mBACtB,oBAAoB,CAAC,cAAc,CAAC,MAAM,EAC7C,CAAC;QACH,KAAK,CAAC,oBAAoB,mBACrB,oBAAoB,CAAC,cAAc,CAAC,KAAK,EAC5C,CAAC;QACH,KAAK,CAAC,qBAAqB,mBACtB,oBAAoB,CAAC,cAAc,CAAC,MAAM,EAC7C,CAAC;QACH,KAAK,CAAC,oBAAoB,mBACrB,oBAAoB,CAAC,cAAc,CAAC,KAAK,EAC5C,CAAC;QACH,KAAK,CAAC,qBAAqB,mBACtB,oBAAoB,CAAC,cAAc,CAAC,MAAM,EAC7C,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAEK,wBAAwB;;YAC5B,MAAM,IAAI,GAAG,4BAAqB,CAAC,WAAW,EAAE,CAAC;YACjD,MAAM,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;YAE1E,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAEnC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1C,MAAM,UAAU,GAAG,MACjB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAC3C,cAAc,CAAC;gBACf,IAAI,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;;AA9MM,0BAAI,GAAG,CAAC,CAAC;AACT,0BAAI,GAAG,CAAC,CAAC;AACT,6BAAO,GAAG,CAAC,CAAC;AAIZ,0CAAoB,GAAG,iBAAiB,CAAC;AA2MlD,qBAAqB,CAAC,QAAQ,GAAG,mBAAmB,CAAC;AACrD,kBAAe,qBAAqB,CAAC"}

package/dist/cjs/tools/OverlayGridTool.d.ts

@@ -0,0 +1,31 @@
+import type { Types } from '@cornerstonejs/core';
+import { PublicToolProps, ToolProps, SVGDrawingHelper, Annotation } from '../types';
+import AnnotationDisplayTool from './base/AnnotationDisplayTool';
+export interface OverlayGridAnnotation extends Annotation {
+    data: {
+        viewportData: Map<string, object>;
+        pointSets: Array<object>;
+    };
+}
+declare class OverlayGridTool extends AnnotationDisplayTool {
+    static toolName: any;
+    touchDragCallback: any;
+    mouseDragCallback: any;
+    _throttledCalculateCachedStats: any;
+    isDrawing: boolean;
+    isHandleOutsideImage: boolean;
+    constructor(toolProps?: PublicToolProps, defaultToolProps?: ToolProps);
+    onSetToolEnabled: () => void;
+    onSetToolActive: () => void;
+    _init: () => void;
+    calculateImageIdPointSets: (imageId: string) => {
+        pointSet1: Types.Point3[];
+        pointSet2: Types.Point3[];
+    };
+    renderAnnotation: (enabledElement: Types.IEnabledElement, svgDrawingHelper: SVGDrawingHelper) => boolean;
+    private initializeViewportData;
+    private isPerpendicular;
+    private isParallel;
+    private getImageIdNormal;
+}
+export default OverlayGridTool;

package/dist/cjs/tools/OverlayGridTool.js

@@ -0,0 +1,170 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const gl_matrix_1 = require("gl-matrix");
+const core_1 = require("@cornerstonejs/core");
+const annotationState_1 = require("../stateManagement/annotation/annotationState");
+const ToolGroupManager_1 = require("../store/ToolGroupManager");
+const drawingSvg_1 = require("../drawingSvg");
+const triggerAnnotationRenderForViewportIds_1 = __importDefault(require("../utilities/triggerAnnotationRenderForViewportIds"));
+const AnnotationDisplayTool_1 = __importDefault(require("./base/AnnotationDisplayTool"));
+const { EPSILON } = core_1.CONSTANTS;
+class OverlayGridTool extends AnnotationDisplayTool_1.default {
+    constructor(toolProps = {}, defaultToolProps = {
+        supportedInteractionTypes: ['Mouse', 'Touch'],
+        configuration: {
+            sourceImageIds: [],
+        },
+    }) {
+        super(toolProps, defaultToolProps);
+        this.onSetToolEnabled = () => {
+            this._init();
+        };
+        this.onSetToolActive = () => {
+            this._init();
+        };
+        this._init = () => {
+            const sourceImageIds = this.configuration.sourceImageIds;
+            if (!(sourceImageIds === null || sourceImageIds === void 0 ? void 0 : sourceImageIds.length)) {
+                console.warn('OverlayGridTool: No sourceImageIds provided in configuration');
+                return;
+            }
+            const imagePlaneModule = core_1.metaData.get('imagePlaneModule', sourceImageIds[0]);
+            if (!imagePlaneModule) {
+                console.warn('OverlayGridTool: No imagePlaneModule found for sourceImageIds');
+                return;
+            }
+            const { frameOfReferenceUID } = imagePlaneModule;
+            const viewportsInfo = (0, ToolGroupManager_1.getToolGroup)(this.toolGroupId).viewportsInfo;
+            if (!(viewportsInfo === null || viewportsInfo === void 0 ? void 0 : viewportsInfo.length)) {
+                console.warn('OverlayGridTool: No viewports found');
+                return;
+            }
+            const annotations = (0, annotationState_1.getAnnotations)(this.getToolName(), frameOfReferenceUID);
+            if (!(annotations === null || annotations === void 0 ? void 0 : annotations.length)) {
+                const pointSets = sourceImageIds.map((id) => {
+                    return this.calculateImageIdPointSets(id);
+                });
+                const newAnnotation = {
+                    highlighted: true,
+                    invalidated: true,
+                    metadata: {
+                        toolName: this.getToolName(),
+                        FrameOfReferenceUID: frameOfReferenceUID,
+                        referencedImageId: null,
+                    },
+                    data: {
+                        viewportData: new Map(),
+                        pointSets,
+                    },
+                };
+                (0, annotationState_1.addAnnotation)(newAnnotation, frameOfReferenceUID);
+            }
+            (0, triggerAnnotationRenderForViewportIds_1.default)((0, core_1.getRenderingEngine)(viewportsInfo[0].renderingEngineId), viewportsInfo.map(({ viewportId }) => viewportId));
+        };
+        this.calculateImageIdPointSets = (imageId) => {
+            const { imagePositionPatient, rows, columns, rowCosines, columnCosines, rowPixelSpacing, columnPixelSpacing, } = core_1.metaData.get('imagePlaneModule', imageId);
+            const topLeft = [...imagePositionPatient];
+            const topRight = [...imagePositionPatient];
+            const bottomLeft = [...imagePositionPatient];
+            const bottomRight = [...imagePositionPatient];
+            gl_matrix_1.vec3.scaleAndAdd(topRight, imagePositionPatient, columnCosines, columns * columnPixelSpacing);
+            gl_matrix_1.vec3.scaleAndAdd(bottomLeft, imagePositionPatient, rowCosines, rows * rowPixelSpacing);
+            gl_matrix_1.vec3.scaleAndAdd(bottomRight, bottomLeft, columnCosines, columns * columnPixelSpacing);
+            const pointSet1 = [topLeft, bottomLeft, topRight, bottomRight];
+            const pointSet2 = [topLeft, topRight, bottomLeft, bottomRight];
+            return { pointSet1, pointSet2 };
+        };
+        this.renderAnnotation = (enabledElement, svgDrawingHelper) => {
+            const sourceImageIds = this.configuration.sourceImageIds;
+            let renderStatus = false;
+            if (!(sourceImageIds === null || sourceImageIds === void 0 ? void 0 : sourceImageIds.length)) {
+                return renderStatus;
+            }
+            const { viewport: targetViewport, FrameOfReferenceUID } = enabledElement;
+            const targetImageIds = targetViewport.getImageIds();
+            if (targetImageIds.length < 2) {
+                return renderStatus;
+            }
+            const annotations = (0, annotationState_1.getAnnotations)(this.getToolName(), FrameOfReferenceUID);
+            if (!(annotations === null || annotations === void 0 ? void 0 : annotations.length)) {
+                return renderStatus;
+            }
+            const annotation = annotations[0];
+            const { annotationUID } = annotation;
+            const { focalPoint, viewPlaneNormal } = targetViewport.getCamera();
+            const styleSpecifier = {
+                toolGroupId: this.toolGroupId,
+                toolName: this.getToolName(),
+                viewportId: enabledElement.viewport.id,
+            };
+            const imageIdNormal = (this.getImageIdNormal(sourceImageIds[0]));
+            if (this.isParallel(viewPlaneNormal, imageIdNormal)) {
+                return renderStatus;
+            }
+            const targetViewportPlane = core_1.utilities.planar.planeEquation(viewPlaneNormal, focalPoint);
+            const pointSets = annotation.data.pointSets;
+            const viewportData = annotation.data.viewportData;
+            for (let i = 0; i < sourceImageIds.length; i++) {
+                const { pointSet1, pointSet2 } = pointSets[i];
+                const targetData = viewportData.get(targetViewport.id) ||
+                    this.initializeViewportData(viewportData, targetViewport.id);
+                if (!targetData.pointSetsToUse[i]) {
+                    let pointSetToUse = pointSet1;
+                    let topBottomVec = gl_matrix_1.vec3.subtract(gl_matrix_1.vec3.create(), pointSet1[0], pointSet1[1]);
+                    topBottomVec = gl_matrix_1.vec3.normalize(gl_matrix_1.vec3.create(), topBottomVec);
+                    if (this.isPerpendicular(topBottomVec, viewPlaneNormal)) {
+                        pointSetToUse = pointSet2;
+                    }
+                    targetData.pointSetsToUse[i] = pointSetToUse;
+                    targetData.lineStartsWorld[i] = core_1.utilities.planar.linePlaneIntersection(pointSetToUse[0], pointSetToUse[1], targetViewportPlane);
+                    targetData.lineEndsWorld[i] = core_1.utilities.planar.linePlaneIntersection(pointSetToUse[2], pointSetToUse[3], targetViewportPlane);
+                }
+                const lineStartWorld = targetData.lineStartsWorld[i];
+                const lineEndWorld = targetData.lineEndsWorld[i];
+                styleSpecifier.annotationUID = annotationUID;
+                const lineWidth = this.getStyle('lineWidth', styleSpecifier, annotation);
+                const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
+                const color = this.getStyle('color', styleSpecifier, annotation);
+                const shadow = this.getStyle('shadow', styleSpecifier, annotation);
+                const canvasCoordinates = [lineStartWorld, lineEndWorld].map((world) => targetViewport.worldToCanvas(world));
+                const dataId = `${annotationUID}-line`;
+                const lineUID = `${i}`;
+                (0, drawingSvg_1.drawLine)(svgDrawingHelper, annotationUID, lineUID, canvasCoordinates[0], canvasCoordinates[1], {
+                    color,
+                    width: lineWidth,
+                    lineDash,
+                    shadow,
+                }, dataId);
+            }
+            renderStatus = true;
+            return renderStatus;
+        };
+        this.initializeViewportData = (viewportData, id) => {
+            viewportData.set(id, {
+                pointSetsToUse: [],
+                lineStartsWorld: [],
+                lineEndsWorld: [],
+            });
+            return viewportData.get(id);
+        };
+        this.isPerpendicular = (vec1, vec2) => {
+            const dot = gl_matrix_1.vec3.dot(vec1, vec2);
+            return Math.abs(dot) < EPSILON;
+        };
+    }
+    isParallel(vec1, vec2) {
+        return Math.abs(gl_matrix_1.vec3.dot(vec1, vec2)) > 1 - EPSILON;
+    }
+    getImageIdNormal(imageId) {
+        const { imageOrientationPatient } = core_1.metaData.get('imagePlaneModule', imageId);
+        const rowCosineVec = gl_matrix_1.vec3.fromValues(imageOrientationPatient[0], imageOrientationPatient[1], imageOrientationPatient[2]);
+        const colCosineVec = gl_matrix_1.vec3.fromValues(imageOrientationPatient[3], imageOrientationPatient[4], imageOrientationPatient[5]);
+        return gl_matrix_1.vec3.cross(gl_matrix_1.vec3.create(), rowCosineVec, colCosineVec);
+    }
+}
+OverlayGridTool.toolName = 'OverlayGrid';
+exports.default = OverlayGridTool;
+//# sourceMappingURL=OverlayGridTool.js.map

package/dist/cjs/tools/OverlayGridTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OverlayGridTool.js","sourceRoot":"","sources":["../../../src/tools/OverlayGridTool.ts"],"names":[],"mappings":";;;;;AAAA,yCAAiC;AACjC,8CAK6B;AAG7B,mFAGuD;AAEvD,gEAAyD;AAEzD,8CAAwD;AACxD,+HAAuG;AASvG,yFAAiE;AAEjE,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAS,CAAC;AAY9B,MAAM,eAAgB,SAAQ,+BAAqB;IASjD,YACE,YAA6B,EAAE,EAC/B,mBAA8B;QAC5B,yBAAyB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;QAC7C,aAAa,EAAE;YACb,cAAc,EAAE,EAAE;SACnB;KACF;QAED,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAGrC,qBAAgB,GAAG,GAAS,EAAE;YAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC;QAEF,oBAAe,GAAG,GAAS,EAAE;YAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC,CAAC;QAEF,UAAK,GAAG,GAAS,EAAE;YACjB,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;YACzD,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,CAAA,EAAE;gBAC3B,OAAO,CAAC,IAAI,CACV,8DAA8D,CAC/D,CAAC;gBACF,OAAO;aACR;YAED,MAAM,gBAAgB,GAAG,eAAQ,CAAC,GAAG,CACnC,kBAAkB,EAClB,cAAc,CAAC,CAAC,CAAC,CAClB,CAAC;YAEF,IAAI,CAAC,gBAAgB,EAAE;gBACrB,OAAO,CAAC,IAAI,CACV,+DAA+D,CAChE,CAAC;gBACF,OAAO;aACR;YAED,MAAM,EAAE,mBAAmB,EAAE,GAAG,gBAAgB,CAAC;YAEjD,MAAM,aAAa,GAAG,IAAA,+BAAY,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC;YAEnE,IAAI,CAAC,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,CAAA,EAAE;gBAC1B,OAAO,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;gBACpD,OAAO;aACR;YAED,MAAM,WAAW,GAAG,IAAA,gCAAc,EAAC,IAAI,CAAC,WAAW,EAAE,EAAE,mBAAmB,CAAC,CAAC;YAE5E,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBACxB,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;oBAE1C,OAAO,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;gBAEH,MAAM,aAAa,GAA0B;oBAC3C,WAAW,EAAE,IAAI;oBACjB,WAAW,EAAE,IAAI;oBACjB,QAAQ,EAAE;wBACR,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE;wBAC5B,mBAAmB,EAAE,mBAAmB;wBACxC,iBAAiB,EAAE,IAAI;qBACxB;oBACD,IAAI,EAAE;wBACJ,YAAY,EAAE,IAAI,GAAG,EAAE;wBACvB,SAAS;qBACV;iBACF,CAAC;gBAEF,IAAA,+BAAa,EAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;aACnD;YAED,IAAA,+CAAqC,EACnC,IAAA,yBAAkB,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,EACtD,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,CAClD,CAAC;QACJ,CAAC,CAAC;QAOF,8BAAyB,GAAG,CAAC,OAAe,EAAE,EAAE;YAC9C,MAAM,EACJ,oBAAoB,EACpB,IAAI,EACJ,OAAO,EACP,UAAU,EACV,aAAa,EACb,eAAe,EACf,kBAAkB,GACnB,GAAG,eAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;YAG9C,MAAM,OAAO,GAAiB,CAAC,GAAG,oBAAoB,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAiB,CAAC,GAAG,oBAAoB,CAAC,CAAC;YACzD,MAAM,UAAU,GAAiB,CAAC,GAAG,oBAAoB,CAAC,CAAC;YAC3D,MAAM,WAAW,GAAiB,CAAC,GAAG,oBAAoB,CAAC,CAAC;YAE5D,gBAAI,CAAC,WAAW,CACd,QAAQ,EACR,oBAAoB,EACpB,aAAa,EACb,OAAO,GAAG,kBAAkB,CAC7B,CAAC;YACF,gBAAI,CAAC,WAAW,CACd,UAAU,EACV,oBAAoB,EACpB,UAAU,EACV,IAAI,GAAG,eAAe,CACvB,CAAC;YAEF,gBAAI,CAAC,WAAW,CACd,WAAW,EACX,UAAU,EACV,aAAa,EACb,OAAO,GAAG,kBAAkB,CAC7B,CAAC;YAGF,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC/D,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;YAE/D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;QAClC,CAAC,CAAC;QAUF,qBAAgB,GAAG,CACjB,cAAqC,EACrC,gBAAkC,EACzB,EAAE;YACX,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;YAEzD,IAAI,YAAY,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,CAAA,EAAE;gBAC3B,OAAO,YAAY,CAAC;aACrB;YAED,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,mBAAmB,EAAE,GAAG,cAAc,CAAC;YACzE,MAAM,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;YACpD,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC7B,OAAO,YAAY,CAAC;aACrB;YAED,MAAM,WAAW,GAAG,IAAA,gCAAc,EAAC,IAAI,CAAC,WAAW,EAAE,EAAE,mBAAmB,CAAC,CAAC;YAC5E,IAAI,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAA,EAAE;gBACxB,OAAO,YAAY,CAAC;aACrB;YACD,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC;YAErC,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,cAAc,CAAC,SAAS,EAAE,CAAC;YAEnE,MAAM,cAAc,GAAmB;gBACrC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE;gBAC5B,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE;aACvC,CAAC;YACF,MAAM,aAAa,GAAiB,CAClC,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CACzC,CAAC;YAEF,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,aAAa,CAAC,EAAE;gBAEnD,OAAO,YAAY,CAAC;aACrB;YAED,MAAM,mBAAmB,GAAG,gBAAO,CAAC,MAAM,CAAC,aAAa,CACtD,eAAe,EACf,UAAU,CACX,CAAC;YAEF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC;YAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAE9C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAE9C,MAAM,UAAU,GACd,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;oBACnC,IAAI,CAAC,sBAAsB,CAAC,YAAY,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;gBAG/D,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE;oBACjC,IAAI,aAAa,GAAG,SAAS,CAAC;oBAE9B,IAAI,YAAY,GAAG,gBAAI,CAAC,QAAQ,CAC9B,gBAAI,CAAC,MAAM,EAAE,EACb,SAAS,CAAC,CAAC,CAAC,EACZ,SAAS,CAAC,CAAC,CAAC,CACb,CAAC;oBACF,YAAY,GAAG,gBAAI,CAAC,SAAS,CAC3B,gBAAI,CAAC,MAAM,EAAE,EACb,YAAY,CACG,CAAC;oBAIlB,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE;wBAEvD,aAAa,GAAG,SAAS,CAAC;qBAC3B;oBAED,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC;oBAE7C,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,gBAAO,CAAC,MAAM,CAAC,qBAAqB,CAClE,aAAa,CAAC,CAAC,CAAC,EAChB,aAAa,CAAC,CAAC,CAAC,EAChB,mBAAmB,CACpB,CAAC;oBAEF,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,gBAAO,CAAC,MAAM,CAAC,qBAAqB,CAChE,aAAa,CAAC,CAAC,CAAC,EAChB,aAAa,CAAC,CAAC,CAAC,EAChB,mBAAmB,CACpB,CAAC;iBACH;gBAED,MAAM,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBACrD,MAAM,YAAY,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;gBAEjD,cAAc,CAAC,aAAa,GAAG,aAAa,CAAC;gBAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;gBACzE,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;gBACvE,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;gBACjE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;gBAEnE,MAAM,iBAAiB,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACrE,cAAc,CAAC,aAAa,CAAC,KAAK,CAAC,CACpC,CAAC;gBAEF,MAAM,MAAM,GAAG,GAAG,aAAa,OAAO,CAAC;gBACvC,MAAM,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAA,qBAAW,EACT,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,iBAAiB,CAAC,CAAC,CAAC,EACpB,iBAAiB,CAAC,CAAC,CAAC,EACpB;oBACE,KAAK;oBACL,KAAK,EAAE,SAAS;oBAChB,QAAQ;oBACR,MAAM;iBACP,EACD,MAAM,CACP,CAAC;aACH;YAED,YAAY,GAAG,IAAI,CAAC;YAEpB,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC;QAEM,2BAAsB,GAAG,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE;YACpD,YAAY,CAAC,GAAG,CAAC,EAAE,EAAE;gBACnB,cAAc,EAAE,EAAE;gBAClB,eAAe,EAAE,EAAE;gBACnB,aAAa,EAAE,EAAE;aAClB,CAAC,CAAC;YAEH,OAAO,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC;QAEM,oBAAe,GAAG,CACxB,IAAkB,EAClB,IAAkB,EACT,EAAE;YACX,MAAM,GAAG,GAAG,gBAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;QACjC,CAAC,CAAC;IA/QF,CAAC;IAiRO,UAAU,CAAC,IAAkB,EAAE,IAAkB;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IACtD,CAAC;IAEO,gBAAgB,CAAC,OAAe;QACtC,MAAM,EAAE,uBAAuB,EAAE,GAAG,eAAQ,CAAC,GAAG,CAC9C,kBAAkB,EAClB,OAAO,CACR,CAAC;QACF,MAAM,YAAY,GAAG,gBAAI,CAAC,UAAU,CAClC,uBAAuB,CAAC,CAAC,CAAC,EAC1B,uBAAuB,CAAC,CAAC,CAAC,EAC1B,uBAAuB,CAAC,CAAC,CAAC,CAC3B,CAAC;QACF,MAAM,YAAY,GAAG,gBAAI,CAAC,UAAU,CAClC,uBAAuB,CAAC,CAAC,CAAC,EAC1B,uBAAuB,CAAC,CAAC,CAAC,EAC1B,uBAAuB,CAAC,CAAC,CAAC,CAC3B,CAAC;QACF,OAAO,gBAAI,CAAC,KAAK,CAAC,gBAAI,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,eAAe,CAAC,QAAQ,GAAG,aAAa,CAAC;AACzC,kBAAe,eAAe,CAAC"}

package/dist/cjs/tools/ReferenceLinesTool.d.ts

@@ -20,6 +20,9 @@ declare class ReferenceLines extends AnnotationDisplayTool {
     onCameraModified: (evt: Types.EventTypes.CameraModifiedEvent) => void;
     renderAnnotation: (enabledElement: Types.IEnabledElement, svgDrawingHelper: SVGDrawingHelper) => boolean;
     isPerpendicular: (vec1: Types.Point3, vec2: Types.Point3) => boolean;
+    private handleFullDimension;
+    intersectInfiniteLines(line1Start: Types.Point2, line1End: Types.Point2, line2Start: Types.Point2, line2End: Types.Point2): number[];
     isParallel(vec1: Types.Point3, vec2: Types.Point3): boolean;
+    isInBound(point: number[], dimensions: Types.Point3): boolean;
 }
 export default ReferenceLines;

package/dist/cjs/tools/ReferenceLinesTool.js

@@ -16,6 +16,7 @@ class ReferenceLines extends AnnotationDisplayTool_1.default {
         supportedInteractionTypes: ['Mouse', 'Touch'],
         configuration: {
             sourceViewportId: '',
+            showFullDimension: false,
         },
     }) {
         super(toolProps, defaultToolProps);
@@ -99,7 +100,7 @@ class ReferenceLines extends AnnotationDisplayTool_1.default {
             const topRight = annotation.data.handles.points[1];
             const bottomLeft = annotation.data.handles.points[2];
             const bottomRight = annotation.data.handles.points[3];
-            const { focalPoint, viewPlaneNormal } = targetViewport.getCamera();
+            const { focalPoint, viewPlaneNormal, viewUp } = targetViewport.getCamera();
             const { viewPlaneNormal: sourceViewPlaneNormal } = sourceViewport.getCamera();
             if (this.isParallel(viewPlaneNormal, sourceViewPlaneNormal)) {
                 return renderStatus;
@@ -127,7 +128,10 @@ class ReferenceLines extends AnnotationDisplayTool_1.default {
             const lineDash = this.getStyle('lineDash', styleSpecifier, annotation);
             const color = this.getStyle('color', styleSpecifier, annotation);
             const shadow = this.getStyle('shadow', styleSpecifier, annotation);
-            const canvasCoordinates = [lineStartWorld, lineEndWorld].map((world) => targetViewport.worldToCanvas(world));
+            let canvasCoordinates = [lineStartWorld, lineEndWorld].map((world) => targetViewport.worldToCanvas(world));
+            if (this.configuration.showFullDimension) {
+                canvasCoordinates = this.handleFullDimension(targetViewport, lineStartWorld, viewPlaneNormal, viewUp, lineEndWorld, canvasCoordinates);
+            }
             const dataId = `${annotationUID}-line`;
             const lineUID = '1';
             (0, drawingSvg_1.drawLine)(svgDrawingHelper, annotationUID, lineUID, canvasCoordinates[0], canvasCoordinates[1], {
@@ -144,9 +148,74 @@ class ReferenceLines extends AnnotationDisplayTool_1.default {
             return Math.abs(dot) < EPSILON;
         };
     }
+    handleFullDimension(targetViewport, lineStartWorld, viewPlaneNormal, viewUp, lineEndWorld, canvasCoordinates) {
+        const renderingEngine = targetViewport.getRenderingEngine();
+        const targetId = this.getTargetId(targetViewport);
+        const targetImage = this.getTargetIdImage(targetId, renderingEngine);
+        const referencedImageId = this.getReferencedImageId(targetViewport, lineStartWorld, viewPlaneNormal, viewUp);
+        if (referencedImageId && targetImage) {
+            try {
+                const { imageData, dimensions } = targetImage;
+                const [topLeftImageCoord, topRightImageCoord, bottomRightImageCoord, bottomLeftImageCoord,] = [
+                    imageData.indexToWorld([0, 0, 0]),
+                    imageData.indexToWorld([dimensions[0] - 1, 0, 0]),
+                    imageData.indexToWorld([
+                        dimensions[0] - 1,
+                        dimensions[1] - 1,
+                        0,
+                    ]),
+                    imageData.indexToWorld([0, dimensions[1] - 1, 0]),
+                ].map((world) => core_1.utilities.worldToImageCoords(referencedImageId, world));
+                const [lineStartImageCoord, lineEndImageCoord] = [
+                    lineStartWorld,
+                    lineEndWorld,
+                ].map((world) => core_1.utilities.worldToImageCoords(referencedImageId, world));
+                canvasCoordinates = [
+                    [topLeftImageCoord, topRightImageCoord],
+                    [topRightImageCoord, bottomRightImageCoord],
+                    [bottomLeftImageCoord, bottomRightImageCoord],
+                    [topLeftImageCoord, bottomLeftImageCoord],
+                ]
+                    .map(([start, end]) => this.intersectInfiniteLines(start, end, lineStartImageCoord, lineEndImageCoord))
+                    .filter((point) => point && this.isInBound(point, dimensions))
+                    .map((point) => {
+                    const world = core_1.utilities.imageToWorldCoords(referencedImageId, point);
+                    return targetViewport.worldToCanvas(world);
+                });
+            }
+            catch (err) {
+                console.log(err);
+            }
+        }
+        return canvasCoordinates;
+    }
+    intersectInfiniteLines(line1Start, line1End, line2Start, line2End) {
+        const [x1, y1] = line1Start;
+        const [x2, y2] = line1End;
+        const [x3, y3] = line2Start;
+        const [x4, y4] = line2End;
+        const a1 = y2 - y1;
+        const b1 = x1 - x2;
+        const c1 = x2 * y1 - x1 * y2;
+        const a2 = y4 - y3;
+        const b2 = x3 - x4;
+        const c2 = x4 * y3 - x3 * y4;
+        if (Math.abs(a1 * b2 - a2 * b1) < EPSILON) {
+            return;
+        }
+        const x = (b1 * c2 - b2 * c1) / (a1 * b2 - a2 * b1);
+        const y = (a2 * c1 - a1 * c2) / (a1 * b2 - a2 * b1);
+        return [x, y];
+    }
     isParallel(vec1, vec2) {
         return Math.abs(gl_matrix_1.vec3.dot(vec1, vec2)) > 1 - EPSILON;
     }
+    isInBound(point, dimensions) {
+        return (point[0] >= 0 &&
+            point[0] <= dimensions[0] &&
+            point[1] >= 0 &&
+            point[1] <= dimensions[1]);
+    }
 }
 ReferenceLines.toolName = 'ReferenceLines';
 exports.default = ReferenceLines;