@idetik/core 0.27.0 → 0.27.2

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as gl_matrix from 'gl-matrix';
-import { vec3, mat4, quat, vec4, vec2 } from 'gl-matrix';
+import { vec2, mat4, vec3, quat, vec4 } from 'gl-matrix';
 import * as zarr from 'zarrita';
 import { Location, Readable } from 'zarrita';
 import { z } from 'zod';
@@ -98,7 +98,7 @@ type SliceCoordinates = {
     t?: number;
 };
 type ChunkSource = {
-    getLoader(): ChunkLoader;
+    get loader(): ChunkLoader;
 };
 type ChunkLoader = {
     getSourceDimensionMap(): SourceDimensionMap;
@@ -145,19 +145,17 @@ declare function createNoPrefetchPolicy(overrides?: Partial<ImageSourcePolicyCon
 
 declare class ChunkStore {
     private readonly chunks_;
-    private readonly loader_;
     private readonly lowestResLOD_;
     private readonly dimensions_;
     private readonly views_;
     private hasHadViews_;
-    constructor(loader: ChunkLoader);
+    constructor(dimensions: SourceDimensionMap);
     getChunkGrid(lod: number, t: number, c: number): Chunk[][][] | undefined;
     hasChunksAtTime(timeIndex: number): boolean;
     get lodCount(): number;
     get channelCount(): number;
     get dimensions(): SourceDimensionMap;
     getLowestResLOD(): number;
-    loadChunkData(chunk: Chunk, signal: AbortSignal): Promise<void>;
     addView(policy: ImageSourcePolicy): ChunkStoreView;
     get views(): ReadonlyArray<ChunkStoreView>;
     canDispose(): boolean;
@@ -169,6 +167,95 @@ declare class ChunkStore {
     private getAndValidateChannelDimension;
 }
 
+declare class Box2 {
+    min: vec2;
+    max: vec2;
+    /**
+     * Initializes as an empty box if no values are provided using the
+     * "empty-by-sentinel" pattern: min = +Infinity, max = -Infinity.
+     * This allows expansion functions to work without special-casing
+     * the first element, and avoids biasing toward (0,0).
+     */
+    constructor(min?: vec2, max?: vec2);
+    clone(): Box2;
+    isEmpty(): boolean;
+    static intersects(a: Box2, b: Box2): boolean;
+    static equals(a: Box2, b: Box2): boolean;
+    floor(): Box2;
+    toRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}
+
+declare class ChunkStoreView {
+    private readonly store_;
+    private policy_;
+    private policyChanged_;
+    private currentLOD_;
+    private lastViewBounds2D_;
+    private lastViewProjection_;
+    private lastZBounds_?;
+    private lastTCoord_?;
+    private lastCCoords_?;
+    private sourceMaxSquareDistance2D_;
+    private readonly chunkViewStates_;
+    private isDisposed_;
+    constructor(store: ChunkStore, policy: ImageSourcePolicy);
+    get chunkViewStates(): ReadonlyMap<Chunk, ChunkViewState>;
+    get isDisposed(): boolean;
+    get lodCount(): number;
+    get channelCount(): number;
+    getChunksToRender(): Chunk[];
+    updateChunksForImage(sliceCoords: SliceCoordinates, view: {
+        worldViewRect: Box2;
+        bufferWidthPx: number;
+    }): void;
+    updateChunksForVolume(sliceCoords: SliceCoordinates, viewProjection: mat4): void;
+    allVisibleFallbackLODLoaded(): boolean;
+    get currentLOD(): number;
+    maybeForgetChunk(chunk: Chunk): void;
+    dispose(): void;
+    setImageSourcePolicy(newPolicy: ImageSourcePolicy, key: symbol): void;
+    private setLOD;
+    private markTimeChunksForPrefetchImage;
+    private markTimeChunksForPrefetchVolume;
+    private computePriority;
+    private channelsOfInterest;
+    private chunkIndexRange;
+    private iterateChunksInBox;
+    private iterateAllChunksAtLod;
+    private getChunkAabb;
+    private fallbackLOD;
+    private timeIndex;
+    private getZBounds;
+    private viewBounds2DChanged;
+    private hasViewProjectionChanged;
+    private zBoundsChanged;
+    private cCoordsChanged;
+    private getPaddedBounds;
+    private squareDistance2D;
+}
+
+type QueueStats = {
+    pending: number;
+    running: number;
+};
+
+declare class ChunkManager {
+    private readonly stores_;
+    private readonly queue_;
+    get queueStats(): QueueStats;
+    get memoryStats(): {
+        cpuChunkBytes: number;
+        cpuChunkCount: number;
+    };
+    addView(source: ChunkSource, policy: ImageSourcePolicy): ChunkStoreView;
+    update(): void;
+}
+
 declare class Box3 {
     min: vec3;
     max: vec3;
@@ -266,29 +353,6 @@ declare class Color {
     private toHexComponent;
 }
 
-declare class Box2 {
-    min: vec2;
-    max: vec2;
-    /**
-     * Initializes as an empty box if no values are provided using the
-     * "empty-by-sentinel" pattern: min = +Infinity, max = -Infinity.
-     * This allows expansion functions to work without special-casing
-     * the first element, and avoids biasing toward (0,0).
-     */
-    constructor(min?: vec2, max?: vec2);
-    clone(): Box2;
-    isEmpty(): boolean;
-    static intersects(a: Box2, b: Box2): boolean;
-    static equals(a: Box2, b: Box2): boolean;
-    floor(): Box2;
-    toRect(): {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-}
-
 type CullingMode = "none" | "front" | "back" | "both";
 
 declare abstract class RenderableObject extends Node {
@@ -340,6 +404,7 @@ declare abstract class Camera extends RenderableObject {
     get viewMatrix(): mat4;
     get right(): vec3;
     get up(): vec3;
+    getViewProjection(): mat4;
     get frustum(): Frustum;
     abstract setAspectRatio(aspectRatio: number): void;
     abstract zoom(factor: number): void;
@@ -372,49 +437,6 @@ declare class EventDispatcher {
     private readonly handleEvent;
 }
 
-type LayerState = "initialized" | "loading" | "ready";
-type BlendMode = "none" | "normal" | "additive" | "subtractive" | "multiply" | "premultiplied";
-type StateChangeCallback = (newState: LayerState, prevState?: LayerState) => void;
-interface LayerOptions {
-    opacity?: number;
-    blendMode?: BlendMode;
-}
-type RenderContext = {
-    viewport: Viewport;
-};
-declare abstract class Layer {
-    abstract readonly type: string;
-    private objects_;
-    private state_;
-    private attached_;
-    private readonly callbacks_;
-    private opacity_;
-    blendMode: BlendMode;
-    constructor({ opacity, blendMode }?: LayerOptions);
-    get opacity(): number;
-    set opacity(value: number);
-    abstract update(context?: RenderContext): void;
-    onEvent(_: EventContext): void;
-    onAttached(context: IdetikContext): void;
-    onDetached(context: IdetikContext): void;
-    protected attach(_context: IdetikContext): void;
-    protected detach(_context: IdetikContext): void;
-    get objects(): RenderableObject[];
-    get state(): LayerState;
-    addStateChangeCallback(callback: StateChangeCallback): void;
-    removeStateChangeCallback(callback: StateChangeCallback): void;
-    hasMultipleLODs(): boolean;
-    protected setState(newState: LayerState): void;
-    protected addObject(object: RenderableObject): void;
-    protected removeObject(object: RenderableObject): void;
-    protected clearObjects(): void;
-    /**
-     * Get uniforms for shader program. Override in derived classes that need custom uniforms.
-     * @returns Object containing uniform name-value pairs
-     */
-    getUniforms(): Record<string, unknown>;
-}
-
 declare class OrthographicCamera extends Camera {
     private width_;
     private height_;
@@ -476,73 +498,56 @@ declare class Viewport {
     removeAllLayers(): void;
     updateSize(): void;
     getBoxRelativeTo(canvas: HTMLCanvasElement): Box2;
+    getBufferRect(): {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
     clientToClip(position: vec2, depth?: number): vec3;
     clientToWorld(position: vec2, depth?: number): vec3;
     private getBox;
     private updateAspectRatio;
 }
 
-declare class ChunkStoreView {
-    private readonly store_;
-    private policy_;
-    private policyChanged_;
-    private currentLOD_;
-    private lastViewBounds2D_;
-    private lastViewProjection_;
-    private lastZBounds_?;
-    private lastTCoord_?;
-    private lastCCoords_?;
-    private sourceMaxSquareDistance2D_;
-    private readonly chunkViewStates_;
-    private isDisposed_;
-    constructor(store: ChunkStore, policy: ImageSourcePolicy);
-    get chunkViewStates(): ReadonlyMap<Chunk, ChunkViewState>;
-    get isDisposed(): boolean;
-    get lodCount(): number;
-    get channelCount(): number;
-    getChunksToRender(): Chunk[];
-    updateChunksForImage(sliceCoords: SliceCoordinates, viewport: Viewport): void;
-    updateChunksForVolume(sliceCoords: SliceCoordinates, viewport: Viewport): void;
-    allVisibleFallbackLODLoaded(): boolean;
-    get currentLOD(): number;
-    maybeForgetChunk(chunk: Chunk): void;
-    dispose(): void;
-    setImageSourcePolicy(newPolicy: ImageSourcePolicy, key: symbol): void;
-    private setLOD;
-    private markTimeChunksForPrefetchImage;
-    private markTimeChunksForPrefetchVolume;
-    private computePriority;
-    private channelsOfInterest;
-    private chunkIndexRange;
-    private iterateChunksInBox;
-    private iterateAllChunksAtLod;
-    private getChunkAabb;
-    private fallbackLOD;
-    private timeIndex;
-    private getZBounds;
-    private viewBounds2DChanged;
-    private hasViewProjectionChanged;
-    private zBoundsChanged;
-    private cCoordsChanged;
-    private getPaddedBounds;
-    private squareDistance2D;
+type LayerState = "initialized" | "loading" | "ready";
+type BlendMode = "none" | "normal" | "additive" | "subtractive" | "multiply" | "premultiplied";
+type StateChangeCallback = (newState: LayerState, prevState?: LayerState) => void;
+interface LayerOptions {
+    opacity?: number;
+    blendMode?: BlendMode;
 }
-
-type QueueStats = {
-    pending: number;
-    running: number;
-};
-
-declare class ChunkManager {
-    private readonly stores_;
-    private readonly queue_;
-    get queueStats(): QueueStats;
-    get memoryStats(): {
-        cpuChunkBytes: number;
-        cpuChunkCount: number;
-    };
-    addView(source: ChunkSource, policy: ImageSourcePolicy): ChunkStoreView;
-    update(): void;
+declare abstract class Layer {
+    abstract readonly type: string;
+    private objects_;
+    private state_;
+    private attached_;
+    private readonly callbacks_;
+    private opacity_;
+    blendMode: BlendMode;
+    constructor({ opacity, blendMode }?: LayerOptions);
+    get opacity(): number;
+    set opacity(value: number);
+    abstract update(viewport?: Viewport): void;
+    onEvent(_: EventContext): void;
+    onAttached(context: IdetikContext): void;
+    onDetached(context: IdetikContext): void;
+    protected attach(_context: IdetikContext): void;
+    protected detach(_context: IdetikContext): void;
+    get objects(): RenderableObject[];
+    get state(): LayerState;
+    addStateChangeCallback(callback: StateChangeCallback): void;
+    removeStateChangeCallback(callback: StateChangeCallback): void;
+    hasMultipleLODs(): boolean;
+    protected setState(newState: LayerState): void;
+    protected addObject(object: RenderableObject): void;
+    protected removeObject(object: RenderableObject): void;
+    protected clearObjects(): void;
+    /**
+     * Get uniforms for shader program. Override in derived classes that need custom uniforms.
+     * @returns Object containing uniform name-value pairs
+     */
+    getUniforms(): Record<string, unknown>;
 }
 
 declare abstract class Renderer {
@@ -566,6 +571,8 @@ declare abstract class Renderer {
     get renderedObjects(): number;
     abstract get gpuTextureBytes(): number;
     abstract get gpuTextureCount(): number;
+    abstract uploadTexture(texture: Texture): void;
+    abstract disposeTexture(texture: Texture): void;
     set backgroundColor(color: ColorLike);
 }
 
@@ -1293,7 +1300,7 @@ declare class OmeZarrImageSource {
     private static openLoader;
     getDimensions(): SourceDimensionMap;
     getChannelCount(): number;
-    getLoader(): OmeZarrImageLoader;
+    get loader(): OmeZarrImageLoader;
     /**
      * Creates and opens an OmeZarrImageSource from an HTTP(S) URL.
      *
@@ -1370,7 +1377,7 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
     constructor({ source, sliceCoords, policy, channelProps, onPickValue, ...layerOptions }: ImageLayerProps);
     protected attach(context: IdetikContext): void;
     protected detach(_context: IdetikContext): void;
-    update(context?: RenderContext): void;
+    update(viewport?: Viewport): void;
     private updateChunks;
     hasMultipleLODs(): boolean;
     get lastPresentationTimeCoord(): number | undefined;
@@ -1440,7 +1447,7 @@ declare class VolumeLayer extends Layer implements ChannelsEnabled {
     private updateChunks;
     private updateVolumeTransform;
     private releaseAndRemoveVolume;
-    update(context?: RenderContext): void;
+    update(viewport?: Viewport): void;
     getUniforms(): Record<string, unknown>;
 }
 
@@ -1481,7 +1488,7 @@ declare class LabelLayer extends Layer {
     constructor({ source, sliceCoords, policy, colorMap, onPickValue, outlineSelected, ...layerOptions }: LabelLayerProps);
     protected attach(context: IdetikContext): void;
     protected detach(_context: IdetikContext): void;
-    update(context?: RenderContext): void;
+    update(viewport?: Viewport): void;
     private updateChunks;
     private isPresentationStale;
     onEvent(event: EventContext): void;