@idetik/core 0.33.0 → 0.35.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as gl_matrix from 'gl-matrix';
-import { vec2, mat4, vec3, quat, vec4 } from 'gl-matrix';
+import { vec2, mat4, vec3, vec4, quat } from 'gl-matrix';
 import * as zarr from 'zarrita';
 import { Location, Readable } from 'zarrita';
 import { z } from 'zod';
@@ -37,6 +37,12 @@ declare abstract class Texture extends Node {
     get type(): string;
 }
 
+type SpatialAxis = "x" | "y" | "z";
+type SliceAxes = {
+    u: SpatialAxis;
+    v: SpatialAxis;
+    w: SpatialAxis;
+};
 type SliceOrientation = "XY" | "XZ" | "YZ";
 
 declare const chunkDataTypes: readonly [Int8ArrayConstructor, Int16ArrayConstructor, Int32ArrayConstructor, Uint8ArrayConstructor, Uint16ArrayConstructor, Uint32ArrayConstructor, Float32ArrayConstructor];
@@ -171,7 +177,7 @@ declare class ChunkStore {
     get channelCount(): number;
     get dimensions(): SourceDimensionMap;
     getLowestResLOD(): number;
-    addView(policy: ImageSourcePolicy): ChunkStoreView;
+    addView(policy: ImageSourcePolicy, axes?: SliceAxes): ChunkStoreView;
     get views(): ReadonlyArray<ChunkStoreView>;
     canDispose(): boolean;
     updateAndCollectChunkChanges(): Set<Chunk>;
@@ -220,11 +226,12 @@ declare class ChunkStoreView {
     private readonly sourceMaxSquareDistance2D_;
     private readonly chunkViewStates_;
     private isDisposed_;
-    constructor(store: ChunkStore, policy: ImageSourcePolicy);
+    constructor(store: ChunkStore, policy: ImageSourcePolicy, axes?: SliceAxes);
     get chunkViewStates(): ReadonlyMap<Chunk, ChunkViewState>;
     get isDisposed(): boolean;
     get lodCount(): number;
     get channelCount(): number;
+    getWholePlaneRect(): Box2;
     getChunksToRender(): Chunk[];
     updateChunksForImage(sliceCoords: SliceCoordinates, view: {
         worldViewRect: Box2;
@@ -278,7 +285,7 @@ declare class ChunkManager {
         cpuChunkBytes: number;
         cpuChunkCount: number;
     };
-    addView(source: ChunkSource, policy: ImageSourcePolicy): ChunkStoreView;
+    addView(source: ChunkSource, policy: ImageSourcePolicy, axes?: SliceAxes): ChunkStoreView;
     update(): void;
     private releaseChunk;
     private enqueueWithinBudget;
@@ -289,6 +296,34 @@ declare class ChunkManager {
     private disposeChunkTexture;
 }
 
+/** @group Layer Configuration */
+type ColorLike = Color | vec3 | vec4 | string;
+/** @group Layer Configuration */
+declare class Color {
+    static readonly RED: Color;
+    static readonly GREEN: Color;
+    static readonly BLUE: Color;
+    static readonly YELLOW: Color;
+    static readonly MAGENTA: Color;
+    static readonly CYAN: Color;
+    static readonly BLACK: Color;
+    static readonly WHITE: Color;
+    static readonly TRANSPARENT: Color;
+    private readonly rgba_;
+    constructor(r: number, g: number, b: number, a?: number);
+    get rgb(): [number, number, number];
+    get rgba(): readonly [number, number, number, number];
+    get r(): number;
+    get g(): number;
+    get b(): number;
+    get a(): number;
+    get rgbHex(): string;
+    get packed(): number;
+    static from(colorLike: ColorLike): Color;
+    static fromRgbHex(hex: string): Color;
+    private toHexComponent;
+}
+
 declare class Box3 {
     min: vec3;
     max: vec3;
@@ -360,34 +395,6 @@ declare class TrsTransform {
 
 type Shader = "floatScalarImage" | "floatVolume" | "intLabelImage" | "intScalarImage" | "intVolume" | "labelImage" | "points" | "projectedLine" | "uintScalarImage" | "uintVolume" | "wireframe";
 
-/** @group Layer Configuration */
-type ColorLike = Color | vec3 | vec4 | string;
-/** @group Layer Configuration */
-declare class Color {
-    static readonly RED: Color;
-    static readonly GREEN: Color;
-    static readonly BLUE: Color;
-    static readonly YELLOW: Color;
-    static readonly MAGENTA: Color;
-    static readonly CYAN: Color;
-    static readonly BLACK: Color;
-    static readonly WHITE: Color;
-    static readonly TRANSPARENT: Color;
-    private readonly rgba_;
-    constructor(r: number, g: number, b: number, a?: number);
-    get rgb(): [number, number, number];
-    get rgba(): readonly [number, number, number, number];
-    get r(): number;
-    get g(): number;
-    get b(): number;
-    get a(): number;
-    get rgbHex(): string;
-    get packed(): number;
-    static from(colorLike: ColorLike): Color;
-    static fromRgbHex(hex: string): Color;
-    private toHexComponent;
-}
-
 type CullingMode = "none" | "front" | "back" | "both";
 
 declare abstract class RenderableObject extends Node {
@@ -515,8 +522,9 @@ declare class OrthographicCamera extends Camera {
     private height_;
     private viewportAspectRatio_;
     private viewportSize_;
-    private readonly axes_;
-    private readonly rotation_;
+    private axes_;
+    private rotation_;
+    private orientation_;
     /**
      * Creates an orthographic camera framing the given world-space rectangle.
      *
@@ -532,6 +540,13 @@ declare class OrthographicCamera extends Camera {
     setAspectRatio(aspectRatio: number): void;
     setFrame(left: number, right: number, bottom: number, top: number): void;
     get type(): CameraType;
+    get orientation(): SliceOrientation;
+    /**
+     * Changes the slice orientation the camera faces. The current frame and
+     * zoom carry over numerically to the new plane axes. Call {@link setFrame}
+     * to reframe the view for the new plane.
+     */
+    setOrientation(orientation: SliceOrientation): void;
     zoom(factor: number): void;
     getWorldViewRect(): Box2;
     protected updateProjectionMatrix(): void;
@@ -692,6 +707,7 @@ type IdetikParams = {
     memoryLimitMB?: number;
     maxConcurrentRequests?: number;
     maxGpuUploadsPerUpdate?: number;
+    backgroundColor?: ColorLike;
 };
 type IdetikContext = {
     chunkManager: ChunkManager;
@@ -1490,6 +1506,7 @@ type ImageLayerProps = LayerOptions & {
     source: ChunkSource;
     sliceCoords: SliceCoordinates;
     policy: ImageSourcePolicy;
+    orientation?: SliceOrientation;
     channelProps?: ChannelProps[];
     onPickValue?: (info: PointPickingResult) => void;
 };
@@ -1511,7 +1528,9 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
     readonly type = "ImageLayer";
     private readonly source_;
     private readonly sliceCoords_;
-    private readonly axes_;
+    private axes_;
+    private planeRotation_;
+    private orientation_;
     private readonly onPickValue_?;
     private readonly visibleChunks_;
     private readonly pool_;
@@ -1520,16 +1539,23 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
     private policy_;
     private channelProps_?;
     private chunkStoreView_?;
+    private context_?;
     private pointerDownPos_;
     private debugMode_;
     private static readonly STALE_PRESENTATION_MS_;
     private lastPresentationTimeStamp_?;
     private lastPresentationTimeCoord_?;
     private readonly wireframeColors_;
-    constructor({ source, sliceCoords, policy, channelProps, onPickValue, ...layerOptions }: ImageLayerProps);
+    constructor({ source, sliceCoords, policy, orientation, channelProps, onPickValue, ...layerOptions }: ImageLayerProps);
     protected attach(context: IdetikContext): void;
     protected detach(_context: IdetikContext): void;
     update(viewport?: Viewport): void;
+    get orientation(): SliceOrientation;
+    /**
+     * Changes the slice orientation at runtime. Visible renderables are rebuilt
+     * for the new plane, chunks already resident in the shared cache are reused.
+     */
+    setOrientation(orientation: SliceOrientation): void;
     private updateChunks;
     hasMultipleLODs(): boolean;
     get lastPresentationTimeCoord(): number | undefined;
@@ -1619,6 +1645,7 @@ type LabelLayerProps = LayerOptions & {
     source: ChunkSource;
     sliceCoords: SliceCoordinates;
     policy: ImageSourcePolicy;
+    orientation?: SliceOrientation;
     colorMap?: LabelColorMapProps;
     onPickValue?: (info: PointPickingResult) => void;
     outlineSelected?: boolean;
@@ -1628,7 +1655,9 @@ declare class LabelLayer extends Layer {
     readonly type = "LabelLayer";
     private readonly source_;
     private readonly sliceCoords_;
-    private readonly axes_;
+    private axes_;
+    private planeRotation_;
+    private orientation_;
     private readonly onPickValue_?;
     private readonly outlineSelected_;
     private readonly visibleChunks_;
@@ -1637,14 +1666,21 @@ declare class LabelLayer extends Layer {
     private selectedValue_;
     private policy_;
     private chunkStoreView_?;
+    private context_?;
     private pointerDownPos_;
     private static readonly STALE_PRESENTATION_MS_;
     private lastPresentationTimeStamp_?;
     private lastPresentationTimeCoord_?;
-    constructor({ source, sliceCoords, policy, colorMap, onPickValue, outlineSelected, ...layerOptions }: LabelLayerProps);
+    constructor({ source, sliceCoords, policy, orientation, colorMap, onPickValue, outlineSelected, ...layerOptions }: LabelLayerProps);
     protected attach(context: IdetikContext): void;
     protected detach(_context: IdetikContext): void;
     update(viewport?: Viewport): void;
+    get orientation(): SliceOrientation;
+    /**
+     * Changes the slice orientation at runtime. Visible renderables are rebuilt
+     * for the new plane, chunks already resident in the shared cache are reused.
+     */
+    setOrientation(orientation: SliceOrientation): void;
     private updateChunks;
     hasMultipleLODs(): boolean;
     private isPresentationStale;
@@ -2039,4 +2075,4 @@ type Image = z.infer<typeof Image>;
 type OmeZarrImage = Image;
 
 export { AxesLayer, Color, Idetik, ImageLayer, ImageRenderable, LabelColorMap, LabelImageRenderable, LabelLayer, Layer, OmeZarrImageSource, OrbitControls, OrthographicCamera, PanZoomControls, PerspectiveCamera, Points, ProjectedLine, VolumeLayer, VolumeRenderable, createExplorationPolicy, createImageSourcePolicy, createNoPrefetchPolicy, createPlaybackPolicy, loadOmeZarrPlate, loadOmeZarrWell, loadOmeroChannels, loadOmeroDefaults };
-export type { ChannelProps, ColorLike, LayerState, MemoryStats, OmeZarrImage, Overlay, SliceCoordinates };
+export type { ChannelProps, ColorLike, LayerState, MemoryStats, OmeZarrImage, Overlay, SliceCoordinates, SliceOrientation };