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 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | /**
* planarViewReference -- Spatial reference queries for cross-viewport
* synchronization and navigation.
*
* These functions let external consumers (tools, synchronizers, navigation
* controllers) ask questions about the planar viewport's current spatial
* state without reaching into internal rendering details:
*
* - "Which imageId is currently displayed?" (`getPlanarReferencedImageId`)
* - "What is the full ViewReference for this viewport?" (`getPlanarViewReference`)
* - "What is the stable identifier for this view?" (`getPlanarViewReferenceId`)
* - "Can this viewport display a given plane?" (`isPlanarPlaneViewable`)
* - "Can this viewport display a given ViewReference?" (`isPlanarReferenceViewable`)
*
* All functions accept the current PlanarViewState, the active PlanarRendering,
* and a PlanarViewportRenderContext so they can reconstruct the render camera
* on demand via `getPlanarResolvedICameraForReference`.
*/
import { vec3 } from 'gl-matrix';
import { ActorRenderMode } from '../../../types';
import type {
Point3,
ReferenceCompatibleOptions,
ViewReference,
ViewReferenceSpecifier,
} from '../../../types';
import type { PlaneRestriction } from '../../../types/IViewport';
import getClosestImageId from '../../../utilities/getClosestImageId';
import imageIdToURI from '../../../utilities/imageIdToURI';
import isEqual from '../../../utilities/isEqual';
import getVolumeViewReferenceId from '../../../utilities/getVolumeViewReferenceId';
import { updatePlaneRestriction } from '../../../utilities/updatePlaneRestriction';
import { getDimensionGroupReferenceContext } from '../genericViewportReferenceCompatibility';
import type {
PlanarViewState,
PlanarPayload,
PlanarViewportRenderContext,
} from './PlanarViewportTypes';
import { resolvePlanarViewportView } from './PlanarResolvedView';
import type { PlanarRendering } from './planarRuntimeTypes';
/**
* Returns the imageId that the viewport is currently displaying (or would
* display at a given `sliceIndex` override).
*
* For image-based paths (cpuImage, vtkImage) this is a direct index lookup.
* For volume paths (cpuVolume, vtkVolume) the computed camera's focalPoint
* and viewPlaneNormal are used to find the closest imageId in the volume's
* imageId list via `getClosestImageId`.
*
* @param args.viewState - The current semantic PlanarViewState.
* @param args.data - The loaded PlanarPayload (provides imageIds and volumeId).
* @param args.rendering - The active render-path state.
* @param args.renderContext - The viewport render context (provides canvas refs).
* @param args.viewRefSpecifier - Optional overrides (e.g. a specific sliceIndex).
* @returns The referenced imageId, or undefined if no rendering is active.
*/
export function getPlanarReferencedImageId(args: {
viewState: PlanarViewState;
data?: PlanarPayload;
frameOfReferenceUID?: string;
rendering?: PlanarRendering;
renderContext: PlanarViewportRenderContext;
viewRefSpecifier?: ViewReferenceSpecifier;
}): string | undefined {
const { rendering, viewRefSpecifier } = args;
if (!rendering) {
return;
}
const imageIds = getImageIds(args.data);
if (!imageIds.length) {
return;
}
if (
rendering.renderMode === ActorRenderMode.CPU_IMAGE ||
rendering.renderMode === ActorRenderMode.VTK_IMAGE
) {
const imageIdIndex =
typeof viewRefSpecifier?.sliceIndex === 'number'
? Math.min(
Math.max(0, viewRefSpecifier.sliceIndex),
imageIds.length - 1
)
: args.viewState?.slice?.kind === 'stackIndex'
? Math.min(
Math.max(0, args.viewState.slice.imageIdIndex),
imageIds.length - 1
)
: getCurrentSliceIndex(rendering);
return imageIds[imageIdIndex];
}
const resolvedView = getPlanarResolvedViewForReference({
viewState: args.viewState,
data: args.data,
frameOfReferenceUID: args.frameOfReferenceUID,
renderContext: args.renderContext,
rendering,
sliceIndex: viewRefSpecifier?.sliceIndex,
})?.toICamera();
if (!resolvedView?.focalPoint || !resolvedView.viewPlaneNormal) {
return imageIds[
Math.min(getCurrentSliceIndex(rendering), imageIds.length - 1)
];
}
return getClosestImageId(
rendering.imageVolume,
resolvedView.focalPoint,
resolvedView.viewPlaneNormal
);
}
/**
* Constructs a full `ViewReference` describing the viewport's current
* spatial state. This is the primary output consumed by cross-viewport
* synchronization (e.g. crosshairs, reference lines).
*
* The ViewReference includes:
* - `FrameOfReferenceUID` -- the DICOM frame of reference.
* - `cameraFocalPoint`, `viewPlaneNormal`, `viewUp` -- orientation.
* - `sliceIndex` -- current slice position.
* - `planeRestriction` -- the plane equation for viewable-plane checks.
* - `referencedImageId` / `referencedImageURI` -- for image-level sync.
* - `volumeId` -- for volume-level sync (volume paths only).
*
* For volume paths, uses `getTargetVolumeSpatialCamera` to compute the
* camera at a potentially overridden sliceIndex (from viewRefSpecifier).
*
* @returns A ViewReference suitable for `isReferenceViewable` comparisons.
*/
export function getPlanarViewReference(args: {
viewState: PlanarViewState;
dataId?: string;
frameOfReferenceUID: string;
data?: PlanarPayload;
rendering?: PlanarRendering;
renderContext: PlanarViewportRenderContext;
viewRefSpecifier?: ViewReferenceSpecifier;
}): ViewReference {
const { frameOfReferenceUID, rendering, viewRefSpecifier } = args;
const { dimensionGroupNumber } = getDimensionGroupReferenceContext(
args.data?.imageVolume
);
const sliceIndex =
viewRefSpecifier?.sliceIndex ??
(rendering ? getCurrentSliceIndex(rendering) : undefined);
const rangeEndSliceIndex = viewRefSpecifier?.rangeEndSliceIndex;
const targetCamera = getPlanarResolvedViewForReference({
...args,
sliceIndex,
})?.toICamera();
const cameraFocalPoint = toPoint3(targetCamera?.focalPoint);
const viewPlaneNormal = toPoint3(targetCamera?.viewPlaneNormal);
const viewUp = toPoint3(targetCamera?.viewUp);
const inPlaneVector2 =
viewUp && viewPlaneNormal
? toPoint3(
vec3.cross(
vec3.create(),
viewUp as unknown as vec3,
viewPlaneNormal as unknown as vec3
) as Point3
)
: undefined;
const viewReference: ViewReference = {
FrameOfReferenceUID: frameOfReferenceUID,
dataId: args.dataId,
dimensionGroupNumber,
cameraFocalPoint,
viewPlaneNormal,
viewUp,
sliceIndex,
planeRestriction:
viewPlaneNormal && viewUp && cameraFocalPoint
? {
FrameOfReferenceUID: frameOfReferenceUID,
point: toPoint3(viewRefSpecifier?.points?.[0]) || cameraFocalPoint,
inPlaneVector1: viewUp,
inPlaneVector2,
}
: undefined,
};
const referencedImageId = getPlanarReferencedImageId(args);
const rangeEndReferencedImageId =
typeof sliceIndex === 'number' &&
typeof rangeEndSliceIndex === 'number' &&
rangeEndSliceIndex > sliceIndex
? getPlanarReferencedImageId({
...args,
viewRefSpecifier: {
...viewRefSpecifier,
sliceIndex: rangeEndSliceIndex,
},
})
: undefined;
// Include the volumeId unless a frame-of-reference reference was explicitly
// requested (forFrameOfReference === true). A frame-of-reference reference
// is not volume specific - it must NOT carry a volumeId so it stays
// compatible with any view of the same FrameOfReferenceUID - whereas the
// default (undefined) and forFrameOfReference === false both bind to this
// volume. This must match BaseVolumeViewport.getViewReference.
if (
rendering &&
(rendering.renderMode === ActorRenderMode.CPU_VOLUME ||
rendering.renderMode === ActorRenderMode.VTK_VOLUME_SLICE) &&
viewRefSpecifier?.forFrameOfReference !== true
) {
viewReference.volumeId = args.data?.volumeId;
}
if (referencedImageId) {
viewReference.referencedImageId = referencedImageId;
viewReference.referencedImageURI = imageIdToURI(referencedImageId);
}
if (
rangeEndReferencedImageId &&
typeof rangeEndSliceIndex === 'number' &&
typeof sliceIndex === 'number' &&
rangeEndSliceIndex > sliceIndex
) {
viewReference.multiSliceReference = {
FrameOfReferenceUID: frameOfReferenceUID,
referencedImageId: rangeEndReferencedImageId,
referencedImageURI: imageIdToURI(rangeEndReferencedImageId),
sliceIndex: rangeEndSliceIndex,
};
}
if (viewRefSpecifier?.points && viewReference.planeRestriction) {
updatePlaneRestriction(viewRefSpecifier.points, viewReference);
}
return viewReference;
}
/**
* Returns a stable string identifier for the current view. Used for
* deduplication and caching in synchronization logic.
*
* For volume paths: `volume:{volumeId}:normal:{vpn}:slice:{index}`.
* For image paths: `imageId:{referencedImageId}`.
*
* @returns A view reference ID string, or null if no rendering is active.
*/
export function getPlanarViewReferenceId(args: {
viewState: PlanarViewState;
frameOfReferenceUID?: string;
data?: PlanarPayload;
rendering?: PlanarRendering;
renderContext: PlanarViewportRenderContext;
viewRefSpecifier?: ViewReferenceSpecifier;
}): string | null {
const { rendering, viewRefSpecifier } = args;
if (!rendering) {
return null;
}
if (
rendering.renderMode === ActorRenderMode.CPU_VOLUME ||
rendering.renderMode === ActorRenderMode.VTK_VOLUME_SLICE
) {
const resolvedView = getPlanarResolvedViewForReference({
...args,
sliceIndex: viewRefSpecifier?.sliceIndex,
})?.toICamera();
const sliceIndex =
viewRefSpecifier?.sliceIndex ?? getCurrentSliceIndex(rendering);
const volumeId = args.data?.volumeId;
if (!volumeId || !resolvedView?.viewPlaneNormal) {
return null;
}
return getVolumeViewReferenceId({
sliceIndex,
viewPlaneNormal: resolvedView.viewPlaneNormal as Point3,
volumeId,
});
}
const referencedImageId = getPlanarReferencedImageId(args);
return referencedImageId ? `imageId:${referencedImageId}` : null;
}
/**
* Tests whether a given plane (defined by a PlaneRestriction) is viewable
* in this viewport's current orientation.
*
* The check verifies:
* 1. Frame of reference matches.
* 2. The plane's in-plane vectors are perpendicular to this viewport's
* viewPlaneNormal (i.e. the plane is parallel to the viewing direction).
* 3. The plane passes through (or near) the current focal point.
*
* The `options.withOrientation` and `options.withNavigation` flags allow
* early-out at different strictness levels.
*
* @returns true if the plane is viewable in this viewport.
*/
export function isPlanarPlaneViewable(args: {
viewState: PlanarViewState;
frameOfReferenceUID: string;
planeRestriction: PlaneRestriction;
rendering?: PlanarRendering;
renderContext: PlanarViewportRenderContext;
options?: ReferenceCompatibleOptions;
}): boolean {
const { frameOfReferenceUID, options, planeRestriction } = args;
if (planeRestriction.FrameOfReferenceUID !== frameOfReferenceUID) {
return false;
}
const resolvedView = getPlanarResolvedViewForReference(args)?.toICamera();
const { focalPoint, viewPlaneNormal } = resolvedView || {};
if (!focalPoint || !viewPlaneNormal) {
return false;
}
if (options?.withOrientation) {
return true;
}
if (
planeRestriction.inPlaneVector1 &&
!isEqual(
0,
vec3.dot(
viewPlaneNormal as unknown as vec3,
planeRestriction.inPlaneVector1 as unknown as vec3
)
)
) {
return false;
}
if (
planeRestriction.inPlaneVector2 &&
!isEqual(
0,
vec3.dot(
viewPlaneNormal as unknown as vec3,
planeRestriction.inPlaneVector2 as unknown as vec3
)
)
) {
return false;
}
if (options?.withNavigation) {
return true;
}
const { point } = planeRestriction;
const pointVector = vec3.sub(
vec3.create(),
point as unknown as vec3,
focalPoint as unknown as vec3
);
return isEqual(0, vec3.dot(pointVector, viewPlaneNormal as unknown as vec3));
}
/**
* Tests whether a given ViewReference is viewable in this viewport.
*
* Delegates to `isPlanarPlaneViewable` if the view reference carries a
* planeRestriction. Otherwise checks orientation compatibility (viewPlaneNormal
* match, allowing negation for flipped views) and optionally verifies that
* the referenced imageId exists in this viewport's image set.
*
* @param args.viewRef - The ViewReference to test.
* @param args.options - Strictness flags:
* `withOrientation` -- only check that the orientation could display it
* (ignoring slice position).
* `withNavigation` -- check that the viewport could navigate to show it.
* @returns true if the reference is viewable.
*/
export function isPlanarReferenceViewable(args: {
viewState: PlanarViewState;
frameOfReferenceUID: string;
imageIds: string[];
rendering?: PlanarRendering;
renderContext: PlanarViewportRenderContext;
options?: ReferenceCompatibleOptions;
viewRef: ViewReference;
}): boolean {
const { frameOfReferenceUID, imageIds, options = {}, viewRef } = args;
if (!viewRef) {
return false;
}
if (viewRef.planeRestriction) {
return isPlanarPlaneViewable({
viewState: args.viewState,
frameOfReferenceUID,
options,
planeRestriction: viewRef.planeRestriction,
renderContext: args.renderContext,
rendering: args.rendering,
});
}
if (
viewRef.FrameOfReferenceUID &&
viewRef.FrameOfReferenceUID !== frameOfReferenceUID
) {
return false;
}
const resolvedView = getPlanarResolvedViewForReference(args)?.toICamera();
if (!resolvedView?.viewPlaneNormal) {
return false;
}
if (
viewRef.viewPlaneNormal &&
!isEqual(viewRef.viewPlaneNormal, resolvedView.viewPlaneNormal) &&
!isEqual(
vec3.negate(
vec3.create(),
resolvedView.viewPlaneNormal as unknown as vec3
) as unknown as Point3,
viewRef.viewPlaneNormal
)
) {
return Boolean(options.withOrientation);
}
if (viewRef.referencedImageId || viewRef.referencedImageURI) {
const referencedImageURI =
viewRef.referencedImageURI ||
imageIdToURI(viewRef.referencedImageId as string);
const currentSliceIndex = args.rendering
? getCurrentSliceIndex(args.rendering)
: 0;
const currentReferencedImageId = imageIds[currentSliceIndex];
if (
currentReferencedImageId &&
imageIdToURI(currentReferencedImageId) === referencedImageURI
) {
return true;
}
const foundSliceIndex = imageIds.findIndex(
(imageId) => imageIdToURI(imageId) === referencedImageURI
);
if (foundSliceIndex === -1) {
return false;
}
if (options.withNavigation) {
return true;
}
const rangeEndSliceIndex =
viewRef.multiSliceReference &&
imageIds.findIndex(
(imageId) =>
imageIdToURI(imageId) ===
imageIdToURI(viewRef.multiSliceReference.referencedImageId)
);
if (rangeEndSliceIndex !== undefined && rangeEndSliceIndex >= 0) {
return (
foundSliceIndex <= currentSliceIndex &&
currentSliceIndex <= rangeEndSliceIndex
);
}
return currentSliceIndex === foundSliceIndex;
}
const currentSliceIndex = args.rendering
? getCurrentSliceIndex(args.rendering)
: 0;
const { sliceIndex } = viewRef;
if (Array.isArray(sliceIndex)) {
return (
sliceIndex[0] <= currentSliceIndex && currentSliceIndex <= sliceIndex[1]
);
}
return sliceIndex === undefined || sliceIndex === currentSliceIndex;
}
/** Extracts the current slice index from any PlanarRendering variant. */
function getCurrentSliceIndex(rendering: PlanarRendering): number {
return rendering.currentImageIdIndex;
}
/** Extracts the imageId list from a PlanarPayload, preferring volume imageIds. */
function getImageIds(payload?: PlanarPayload): string[] {
return payload?.imageVolume?.imageIds || payload?.imageIds || [];
}
function toPoint3(point: Point3 | undefined): Point3 | undefined {
if (!point) {
return;
}
return [point[0], point[1], point[2]];
}
/**
* Resolves the current shared planar camera object for spatial reference
* queries. This reuses the same construction path as `PlanarViewport`.
*/
function getPlanarResolvedViewForReference(
args: Parameters<typeof resolvePlanarViewportView>[0]
) {
return resolvePlanarViewportView(args);
}
|