@cornerstonejs/tools 5.4.16 → 5.5.0

package/dist/esm/utilities/spatial/getViewportPlane.js

@@ -0,0 +1,33 @@
+import { vec3 } from 'gl-matrix';
+import getViewportICamera from '../getViewportICamera.js';
+const MIN_NORMAL_LENGTH = 1e-10;
+function isFinitePoint3(point) {
+    return (Array.isArray(point) &&
+        point.length === 3 &&
+        point.every((v) => Number.isFinite(v)));
+}
+export default function getViewportPlane(viewport) {
+    if (!viewport) {
+        return null;
+    }
+    let camera;
+    try {
+        camera = getViewportICamera(viewport);
+    }
+    catch {
+        return null;
+    }
+    const viewPlaneNormal = camera?.viewPlaneNormal;
+    const focalPoint = camera?.focalPoint;
+    if (!isFinitePoint3(viewPlaneNormal) || !isFinitePoint3(focalPoint)) {
+        return null;
+    }
+    if (vec3.length(viewPlaneNormal) < MIN_NORMAL_LENGTH) {
+        return null;
+    }
+    const normal = vec3.normalize(vec3.create(), viewPlaneNormal);
+    return {
+        normal: [normal[0], normal[1], normal[2]],
+        point: [focalPoint[0], focalPoint[1], focalPoint[2]],
+    };
+}

package/dist/esm/utilities/spatial/index.d.ts

@@ -0,0 +1,11 @@
+import getViewportPlane from './getViewportPlane.js';
+import intersectPlanes from './intersectPlanes.js';
+import projectPointToPlane from './projectPointToPlane.js';
+import distancePointToPlane from './distancePointToPlane.js';
+import clipWorldLineToViewportCanvas from './clipWorldLineToViewportCanvas.js';
+import areViewportsSpatiallyLinked from './areViewportsSpatiallyLinked.js';
+import translateViewportAlongNormal from './translateViewportAlongNormal.js';
+import rotateViewportAroundWorldPoint from './rotateViewportAroundWorldPoint.js';
+import getDisplayedCanvasSize from './getDisplayedCanvasSize.js';
+export type { Mat4, Plane, WorldLine, SpatialLinkPolicy, SpatialLinkOptions, } from './types.js';
+export { getViewportPlane, intersectPlanes, projectPointToPlane, distancePointToPlane, clipWorldLineToViewportCanvas, areViewportsSpatiallyLinked, translateViewportAlongNormal, rotateViewportAroundWorldPoint, getDisplayedCanvasSize, };

package/dist/esm/utilities/spatial/index.js

@@ -0,0 +1,10 @@
+import getViewportPlane from './getViewportPlane.js';
+import intersectPlanes from './intersectPlanes.js';
+import projectPointToPlane from './projectPointToPlane.js';
+import distancePointToPlane from './distancePointToPlane.js';
+import clipWorldLineToViewportCanvas from './clipWorldLineToViewportCanvas.js';
+import areViewportsSpatiallyLinked from './areViewportsSpatiallyLinked.js';
+import translateViewportAlongNormal from './translateViewportAlongNormal.js';
+import rotateViewportAroundWorldPoint from './rotateViewportAroundWorldPoint.js';
+import getDisplayedCanvasSize from './getDisplayedCanvasSize.js';
+export { getViewportPlane, intersectPlanes, projectPointToPlane, distancePointToPlane, clipWorldLineToViewportCanvas, areViewportsSpatiallyLinked, translateViewportAlongNormal, rotateViewportAroundWorldPoint, getDisplayedCanvasSize, };

package/dist/esm/utilities/spatial/intersectPlanes.d.ts

@@ -0,0 +1,2 @@
+import type { Plane, WorldLine } from './types.js';
+export default function intersectPlanes(planeA: Plane, planeB: Plane): WorldLine | null;

package/dist/esm/utilities/spatial/intersectPlanes.js

@@ -0,0 +1,30 @@
+import { vec3 } from 'gl-matrix';
+const PARALLEL_EPSILON = 1e-6;
+export default function intersectPlanes(planeA, planeB) {
+    if (!planeA || !planeB) {
+        return null;
+    }
+    const normalA = vec3.normalize(vec3.create(), planeA.normal);
+    const normalB = vec3.normalize(vec3.create(), planeB.normal);
+    const direction = vec3.cross(vec3.create(), normalA, normalB);
+    const directionLengthSquared = vec3.squaredLength(direction);
+    if (directionLengthSquared < PARALLEL_EPSILON * PARALLEL_EPSILON) {
+        return null;
+    }
+    const dA = vec3.dot(normalA, planeA.point);
+    const dB = vec3.dot(normalB, planeB.point);
+    const nBCrossDir = vec3.cross(vec3.create(), normalB, direction);
+    const dirCrossNA = vec3.cross(vec3.create(), direction, normalA);
+    const point = vec3.create();
+    vec3.scaleAndAdd(point, point, nBCrossDir, dA);
+    vec3.scaleAndAdd(point, point, dirCrossNA, dB);
+    vec3.scale(point, point, 1 / directionLengthSquared);
+    vec3.normalize(direction, direction);
+    if (![...point, ...direction].every((component) => Number.isFinite(component))) {
+        return null;
+    }
+    return {
+        point: [point[0], point[1], point[2]],
+        direction: [direction[0], direction[1], direction[2]],
+    };
+}

package/dist/esm/utilities/spatial/projectPointToPlane.d.ts

@@ -0,0 +1,3 @@
+import type { Types } from '@cornerstonejs/core';
+import type { Plane } from './types.js';
+export default function projectPointToPlane(point: Types.Point3, plane: Plane): Types.Point3;

package/dist/esm/utilities/spatial/projectPointToPlane.js

@@ -0,0 +1,11 @@
+import { vec3 } from 'gl-matrix';
+import distancePointToPlane from './distancePointToPlane.js';
+export default function projectPointToPlane(point, plane) {
+    const normal = vec3.normalize(vec3.create(), plane.normal);
+    const distance = distancePointToPlane(point, plane);
+    return [
+        point[0] - distance * normal[0],
+        point[1] - distance * normal[1],
+        point[2] - distance * normal[2],
+    ];
+}

package/dist/esm/utilities/spatial/rotateViewportAroundWorldPoint.d.ts

@@ -0,0 +1,2 @@
+import type { Types } from '@cornerstonejs/core';
+export default function rotateViewportAroundWorldPoint(viewport: Types.IViewport, pivot: Types.Point3, axis: Types.Point3, angle: number): boolean;

package/dist/esm/utilities/spatial/rotateViewportAroundWorldPoint.js

@@ -0,0 +1,34 @@
+import { mat4, vec3 } from 'gl-matrix';
+import { utilities as csUtils } from '@cornerstonejs/core';
+export default function rotateViewportAroundWorldPoint(viewport, pivot, axis, angle) {
+    if (!viewport || !pivot || !axis || !Number.isFinite(angle) || angle === 0) {
+        return false;
+    }
+    if (csUtils.isGenericViewport(viewport)) {
+        return false;
+    }
+    const normalizedAxis = vec3.normalize(vec3.create(), axis);
+    if (vec3.length(normalizedAxis) < 1e-10) {
+        return false;
+    }
+    const camera = viewport.getCamera?.();
+    const { position, focalPoint, viewUp } = camera ?? {};
+    if (!position || !focalPoint || !viewUp) {
+        return false;
+    }
+    const transform = mat4.create();
+    mat4.translate(transform, transform, pivot);
+    mat4.rotate(transform, transform, angle, normalizedAxis);
+    mat4.translate(transform, transform, [-pivot[0], -pivot[1], -pivot[2]]);
+    const newPosition = vec3.transformMat4(vec3.create(), position, transform);
+    const newFocalPoint = vec3.transformMat4(vec3.create(), focalPoint, transform);
+    const viewUpPoint = vec3.add(vec3.create(), position, viewUp);
+    const newViewUpPoint = vec3.transformMat4(vec3.create(), viewUpPoint, transform);
+    const newViewUp = vec3.subtract(vec3.create(), newViewUpPoint, newPosition);
+    viewport.setCamera({
+        position: [newPosition[0], newPosition[1], newPosition[2]],
+        focalPoint: [newFocalPoint[0], newFocalPoint[1], newFocalPoint[2]],
+        viewUp: [newViewUp[0], newViewUp[1], newViewUp[2]],
+    });
+    return true;
+}

package/dist/esm/utilities/spatial/translateViewportAlongNormal.d.ts

@@ -0,0 +1,2 @@
+import type { Types } from '@cornerstonejs/core';
+export default function translateViewportAlongNormal(viewport: Types.IViewport, distance: number): boolean;

package/dist/esm/utilities/spatial/translateViewportAlongNormal.js

@@ -0,0 +1,36 @@
+import { vec3 } from 'gl-matrix';
+import { utilities as csUtils } from '@cornerstonejs/core';
+import getViewportICamera from '../getViewportICamera.js';
+import { navigatePlanarViewportToPoint } from '../genericViewportToolHelpers.js';
+export default function translateViewportAlongNormal(viewport, distance) {
+    if (!viewport || !Number.isFinite(distance) || distance === 0) {
+        return false;
+    }
+    let camera;
+    try {
+        camera = getViewportICamera(viewport);
+    }
+    catch {
+        return false;
+    }
+    const viewPlaneNormal = camera?.viewPlaneNormal;
+    const focalPoint = camera?.focalPoint;
+    const position = camera?.position;
+    if (!viewPlaneNormal || !focalPoint || !position) {
+        return false;
+    }
+    const newFocalPoint = vec3.scaleAndAdd(vec3.create(), focalPoint, viewPlaneNormal, distance);
+    const newPosition = vec3.scaleAndAdd(vec3.create(), position, viewPlaneNormal, distance);
+    if (csUtils.isGenericViewport(viewport)) {
+        return navigatePlanarViewportToPoint(viewport, [
+            newFocalPoint[0],
+            newFocalPoint[1],
+            newFocalPoint[2],
+        ]);
+    }
+    viewport.setCamera({
+        focalPoint: [newFocalPoint[0], newFocalPoint[1], newFocalPoint[2]],
+        position: [newPosition[0], newPosition[1], newPosition[2]],
+    });
+    return true;
+}

package/dist/esm/utilities/spatial/types.d.ts

@@ -0,0 +1,19 @@
+import type { Types } from '@cornerstonejs/core';
+export type Mat4 = number[] | Float32Array;
+export type Plane = {
+    normal: Types.Point3;
+    point: Types.Point3;
+};
+export type WorldLine = {
+    point: Types.Point3;
+    direction: Types.Point3;
+};
+export type SpatialLinkPolicy = 'toolGroup' | 'frameOfReferenceUID' | 'explicit';
+export type SpatialLinkOptions = {
+    policy: SpatialLinkPolicy;
+    explicitLinks?: Array<{
+        sourceViewportId: string;
+        targetViewportId: string;
+    }>;
+    registrationTransforms?: Map<string, Mat4>;
+};

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.4.16";
+export declare const version = "5.5.0";

package/dist/esm/version.js

@@ -1 +1 @@
-export const version = '5.4.16';
+export const version = '5.5.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cornerstonejs/tools",
-  "version": "5.4.16",
+  "version": "5.5.0",
   "description": "Cornerstone3D Tools",
   "types": "./dist/esm/index.d.ts",
   "module": "./dist/esm/index.js",
@@ -126,11 +126,11 @@
     "lodash.get": "4.4.2"
   },
   "devDependencies": {
-    "@cornerstonejs/core": "5.4.16",
+    "@cornerstonejs/core": "5.5.0",
     "canvas": "3.2.0"
   },
   "peerDependencies": {
-    "@cornerstonejs/core": "5.4.16",
+    "@cornerstonejs/core": "5.5.0",
     "@kitware/vtk.js": "35.5.3",
     "@types/d3-array": "3.2.1",
     "@types/d3-interpolate": "3.0.4",
@@ -149,5 +149,5 @@
     "type": "individual",
     "url": "https://ohif.org/donate"
   },
-  "gitHead": "6d2d80bfa445c91deafe0d7e4a02b8de1a4a4da8"
+  "gitHead": "9a6e9edc926a53324461f17358dd034d009e4137"
 }