All files / core/src/RenderingEngine/GenericViewport viewportProjection.ts

73.52% Statements 25/34
55% Branches 11/20
60% Functions 6/10
73.52% Lines 25/34

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                                                                                                                                                                                                                                                                                                                                                    4x     4x                   128x                             640x                                       4x       4x   4x 20x       20x   20x   20x                                                                                                           2x 2x         2x 2x                                                                   2x 2x         2x 2x                                             128x   128x 128x 128x 128x 128x      
import type {
  ProjectionPresentation,
  ProjectionRequest,
  ProjectionSnapshot,
  ProjectionWriteOptions,
  ViewportProjectionAdapter,
} from './ViewportProjectionTypes';
import { ViewportType } from '../../enums';
import type { ViewPresentation } from '../../types';
import { planarProjectionAdapter } from './Planar/planarProjectionAdapter';
import type {
  PlanarProjectionRequest,
  PlanarProjectionSnapshot,
} from './Planar/PlanarProjectionTypes';
import type {
  PlanarViewPresentation,
  PlanarViewState,
} from './Planar/PlanarViewportTypes';
import { volume3DProjectionAdapter } from './Volume3D/volume3DProjectionAdapter';
import type {
  Volume3DProjectionPresentation,
  Volume3DProjectionRequest,
  Volume3DProjectionSnapshot,
} from './Volume3D/Volume3DProjectionTypes';
import type { Volume3DCamera } from './Volume3D/viewport3DTypes';
import { videoProjectionAdapter } from './Video/videoProjectionAdapter';
import type {
  VideoProjectionRequest,
  VideoProjectionSnapshot,
} from './Video/VideoProjectionTypes';
import type { VideoViewState } from './Video/VideoViewportTypes';
import { ecgProjectionAdapter } from './ECG/ecgProjectionAdapter';
import type {
  ECGProjectionRequest,
  ECGProjectionSnapshot,
} from './ECG/ECGProjectionTypes';
import type { ECGViewState } from './ECG/ECGViewportTypes';
import { wsiProjectionAdapter } from './WSI/wsiProjectionAdapter';
import type {
  WSIProjectionRequest,
  WSIProjectionSnapshot,
} from './WSI/WSIProjectionTypes';
import type { WSIViewState } from './WSI/WSIViewportTypes';
 
type ViewportLike = {
  type?: string;
};
 
type RegisteredProjectionAdapter = ViewportProjectionAdapter<
  unknown,
  unknown,
  ProjectionSnapshot<unknown, ProjectionPresentation<unknown>>
>;
 
export type BuiltInViewportProjectionByKind = {
  planar: {
    presentation: PlanarViewPresentation;
    request: PlanarProjectionRequest;
    snapshot: PlanarProjectionSnapshot;
    viewState: PlanarViewState;
    viewportType: ViewportType.PLANAR_NEXT;
  };
  volume3d: {
    presentation: Volume3DProjectionPresentation;
    request: Volume3DProjectionRequest;
    snapshot: Volume3DProjectionSnapshot;
    viewState: Volume3DCamera;
    viewportType: ViewportType.VOLUME_3D_NEXT;
  };
  video: {
    presentation: ViewPresentation;
    request: VideoProjectionRequest;
    snapshot: VideoProjectionSnapshot;
    viewState: VideoViewState;
    viewportType: ViewportType.VIDEO_NEXT;
  };
  ecg: {
    presentation: ViewPresentation;
    request: ECGProjectionRequest;
    snapshot: ECGProjectionSnapshot;
    viewState: ECGViewState;
    viewportType: ViewportType.ECG_NEXT;
  };
  wsi: {
    presentation: ViewPresentation;
    request: WSIProjectionRequest;
    snapshot: WSIProjectionSnapshot;
    viewState: WSIViewState;
    viewportType: ViewportType.WHOLE_SLIDE_NEXT;
  };
};
 
export type BuiltInViewportProjectionKind =
  keyof BuiltInViewportProjectionByKind;
 
export type BuiltInViewportProjectionByType = {
  [ViewportType.PLANAR_NEXT]: BuiltInViewportProjectionByKind['planar'];
  [ViewportType.VOLUME_3D_NEXT]: BuiltInViewportProjectionByKind['volume3d'];
  [ViewportType.VIDEO_NEXT]: BuiltInViewportProjectionByKind['video'];
  [ViewportType.ECG_NEXT]: BuiltInViewportProjectionByKind['ecg'];
  [ViewportType.WHOLE_SLIDE_NEXT]: BuiltInViewportProjectionByKind['wsi'];
};
 
export type BuiltInViewportProjectionType =
  keyof BuiltInViewportProjectionByType;
 
export type ProjectionSnapshotForKind<
  TKind extends BuiltInViewportProjectionKind,
> = BuiltInViewportProjectionByKind[TKind]['snapshot'];
 
export type ProjectionPresentationForKind<
  TKind extends BuiltInViewportProjectionKind,
> = BuiltInViewportProjectionByKind[TKind]['presentation'];
 
export type ProjectionViewStateForKind<
  TKind extends BuiltInViewportProjectionKind,
> = BuiltInViewportProjectionByKind[TKind]['viewState'];
 
export type ProjectionSnapshotForViewportType<
  TViewportType extends BuiltInViewportProjectionType,
> = BuiltInViewportProjectionByType[TViewportType]['snapshot'];
 
export type ProjectionPresentationForViewportType<
  TViewportType extends BuiltInViewportProjectionType,
> = BuiltInViewportProjectionByType[TViewportType]['presentation'];
 
export type ProjectionViewStateForViewportType<
  TViewportType extends BuiltInViewportProjectionType,
> = BuiltInViewportProjectionByType[TViewportType]['viewState'];
 
type BuiltInProjectionViewport = {
  type: BuiltInViewportProjectionType;
};
 
type ProjectionForViewport<TViewport> = TViewport extends {
  type: infer TViewportType;
}
  ? TViewportType extends BuiltInViewportProjectionType
    ? BuiltInViewportProjectionByType[TViewportType]
    : never
  : never;
 
type ProjectionRequestForKind<TKind extends BuiltInViewportProjectionKind> =
  Omit<BuiltInViewportProjectionByKind[TKind]['request'], 'viewport'> & {
    kind: TKind;
  };
 
type ProjectionRequestForViewport<TViewport extends BuiltInProjectionViewport> =
  Omit<ProjectionForViewport<TViewport>['request'], 'viewport'>;
 
export type ProjectionSnapshotForViewport<
  TViewport extends BuiltInProjectionViewport,
> = ProjectionForViewport<TViewport>['snapshot'];
 
export type ProjectionPresentationForViewport<
  TViewport extends BuiltInProjectionViewport,
> = ProjectionForViewport<TViewport>['presentation'];
 
export type ProjectionViewStateForViewport<
  TViewport extends BuiltInProjectionViewport,
> = ProjectionForViewport<TViewport>['viewState'];
 
/**
 * Resolve the viewport type used for adapter lookup.
 *
 * Explicit request values win so tests and external callers can query an
 * adapter without requiring a full viewport instance.
 */
function getViewportType(request: ProjectionRequest): string | undefined {
  const viewportType =
    request.viewportType ??
    (request.viewport as ViewportLike | undefined)?.type;
 
  return viewportType === undefined ? undefined : String(viewportType);
}
 
/**
 * Package-level viewport projection facade.
 *
 * The service is intentionally global to the package so custom synchronizers
 * can resolve projection behavior without reaching into a rendering engine.
 */
class ViewportProjectionService {
  private readonly adapters = new Map<string, RegisteredProjectionAdapter>();
 
  /**
   * Register or replace an adapter by id.
   */
  register<
    TViewState,
    TPresentation,
    TSnapshot extends ProjectionSnapshot<
      TViewState,
      ProjectionPresentation<unknown>
    >,
  >(
    adapter: ViewportProjectionAdapter<TViewState, TPresentation, TSnapshot>
  ): void {
    this.adapters.set(
      adapter.id,
      adapter as unknown as RegisteredProjectionAdapter
    );
  }
 
  /**
   * Remove an adapter by id.
   */
  unregister(adapterId: string): void {
    this.adapters.delete(adapterId);
  }
 
  /**
   * Find the adapter matching the viewport type and optional projection kind.
   */
  getAdapter(
    viewport: unknown,
    request: Omit<ProjectionRequest, 'viewport'> = {}
  ): RegisteredProjectionAdapter | undefined {
    const projectionRequest: ProjectionRequest = {
      ...request,
      viewport,
    };
    const viewportType = getViewportType(projectionRequest);
 
    for (const adapter of this.adapters.values()) {
      Iif (request.kind && adapter.id !== request.kind) {
        continue;
      }
 
      Eif (
        viewportType &&
        !adapter.viewportTypes.some((type) => String(type) === viewportType)
      ) {
        continue;
      }
 
      return adapter;
    }
  }
 
  /**
   * Resolve a projection snapshot for the given viewport.
   */
  get<TKind extends BuiltInViewportProjectionKind>(
    viewport: unknown,
    request: ProjectionRequestForKind<TKind>
  ): ProjectionSnapshotForKind<TKind> | undefined;
  get<TViewport extends BuiltInProjectionViewport>(
    viewport: TViewport,
    request?: ProjectionRequestForViewport<TViewport>
  ): ProjectionSnapshotForViewport<TViewport> | undefined;
  get<TSnapshot extends ProjectionSnapshot = ProjectionSnapshot>(
    viewport: unknown,
    request?: Omit<ProjectionRequest, 'viewport'>
  ): TSnapshot | undefined;
  get<TSnapshot extends ProjectionSnapshot = ProjectionSnapshot>(
    viewport: unknown,
    request: Omit<ProjectionRequest, 'viewport'> = {}
  ): TSnapshot | undefined {
    const adapter = this.getAdapter(viewport, request);
 
    return adapter?.getSnapshot({
      ...request,
      viewport,
    }) as TSnapshot | undefined;
  }
 
  /**
   * Resolve a projection snapshot and convert it to the adapter's public
   * view-presentation shape.
   */
  getPresentation<TKind extends BuiltInViewportProjectionKind>(
    viewport: unknown,
    request: ProjectionRequestForKind<TKind>
  ): ProjectionPresentationForKind<TKind> | undefined;
  getPresentation<TViewport extends BuiltInProjectionViewport>(
    viewport: TViewport,
    request?: ProjectionRequestForViewport<TViewport>
  ): ProjectionPresentationForViewport<TViewport> | undefined;
  getPresentation<TPresentation = unknown>(
    viewport: unknown,
    request?: Omit<ProjectionRequest, 'viewport'>
  ): TPresentation | undefined;
  getPresentation<TPresentation = unknown>(
    viewport: unknown,
    request: Omit<ProjectionRequest, 'viewport'> = {}
  ): TPresentation | undefined {
    const adapter = this.getAdapter(viewport, request);
    const snapshot = adapter?.getSnapshot({
      ...request,
      viewport,
    });
 
    Eif (!snapshot) {
      return;
    }
 
    return adapter.getPresentation(snapshot, request.selector) as TPresentation;
  }
 
  /**
   * Resolve a projection snapshot and calculate the next semantic view state
   * for the requested presentation patch.
   */
  withPresentation<TKind extends BuiltInViewportProjectionKind>(
    viewport: unknown,
    presentation: Partial<ProjectionPresentationForKind<TKind>>,
    request: ProjectionRequestForKind<TKind>,
    options?: ProjectionWriteOptions
  ): ProjectionViewStateForKind<TKind> | undefined;
  withPresentation<TViewport extends BuiltInProjectionViewport>(
    viewport: TViewport,
    presentation: Partial<ProjectionPresentationForViewport<TViewport>>,
    request?: ProjectionRequestForViewport<TViewport>,
    options?: ProjectionWriteOptions
  ): ProjectionViewStateForViewport<TViewport> | undefined;
  withPresentation<TViewState = unknown, TPresentation = unknown>(
    viewport: unknown,
    presentation: Partial<TPresentation>,
    request?: Omit<ProjectionRequest, 'viewport'>,
    options?: ProjectionWriteOptions
  ): TViewState | undefined;
  withPresentation<TViewState = unknown, TPresentation = unknown>(
    viewport: unknown,
    presentation: Partial<TPresentation>,
    request: Omit<ProjectionRequest, 'viewport'> = {},
    options?: ProjectionWriteOptions
  ): TViewState | undefined {
    const adapter = this.getAdapter(viewport, request);
    const snapshot = adapter?.getSnapshot({
      ...request,
      viewport,
    });
 
    Eif (!snapshot) {
      return;
    }
 
    return adapter.withPresentation(snapshot, presentation, options) as
      | TViewState
      | undefined;
  }
 
  /**
   * Return registered adapters in registration order.
   */
  getRegisteredAdapters(): RegisteredProjectionAdapter[] {
    return Array.from(this.adapters.values());
  }
 
  /**
   * Remove all adapters. Intended for isolated tests and custom bootstrapping.
   */
  clear(): void {
    this.adapters.clear();
  }
}
 
const viewportProjection = new ViewportProjectionService();
 
viewportProjection.register(planarProjectionAdapter);
viewportProjection.register(volume3DProjectionAdapter);
viewportProjection.register(videoProjectionAdapter);
viewportProjection.register(ecgProjectionAdapter);
viewportProjection.register(wsiProjectionAdapter);
 
export { ViewportProjectionService, viewportProjection };