@idetik/core 0.35.4 → 0.36.0

package/dist/index.d.ts

@@ -124,7 +124,7 @@ type ChunkLoader = {
 
 declare const ALL_CATEGORIES: readonly ["fallbackVisible", "prefetchTime", "visibleCurrent", "fallbackBackground", "prefetchSpace"];
 type PriorityCategory = (typeof ALL_CATEGORIES)[number];
-type ImageSourcePolicyConfig = {
+type ImageSourcePolicyProps = {
     profile?: string;
     prefetch: {
         x: number;
@@ -156,13 +156,13 @@ type ImageSourcePolicy = Readonly<{
     };
 }>;
 /** @group Layer Configuration */
-declare function createImageSourcePolicy(config: ImageSourcePolicyConfig): ImageSourcePolicy;
+declare function createImageSourcePolicy(config: ImageSourcePolicyProps): ImageSourcePolicy;
 /** @group Layer Configuration */
-declare function createExplorationPolicy(overrides?: Partial<ImageSourcePolicyConfig>): ImageSourcePolicy;
+declare function createExplorationPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
 /** @group Layer Configuration */
-declare function createPlaybackPolicy(overrides?: Partial<ImageSourcePolicyConfig>): ImageSourcePolicy;
+declare function createPlaybackPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
 /** @group Layer Configuration */
-declare function createNoPrefetchPolicy(overrides?: Partial<ImageSourcePolicyConfig>): ImageSourcePolicy;
+declare function createNoPrefetchPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
 
 declare class ChunkStore {
     private readonly chunks_;
@@ -494,12 +494,13 @@ declare class EventDispatcher {
     private isConnected_;
     constructor(element: HTMLElement);
     addEventListener(listener: Listener): void;
+    removeEventListener(listener: Listener): void;
     connect(): void;
     disconnect(): void;
     private readonly handleEvent;
 }
 
-type OrthographicCameraOptions = {
+type OrthographicCameraProps = {
     near?: number;
     far?: number;
     orientation?: SliceOrientation;
@@ -535,7 +536,7 @@ declare class OrthographicCamera extends Camera {
      * @param options - Near/far clipping plane distances (default `-1e6` and
      *   `1e6`) and the slice orientation the camera faces (default `"XY"`).
      */
-    constructor(left: number, right: number, top: number, bottom: number, options?: OrthographicCameraOptions);
+    constructor(left: number, right: number, top: number, bottom: number, options?: OrthographicCameraProps);
     get viewportSize(): [number, number];
     setAspectRatio(aspectRatio: number): void;
     setFrame(left: number, right: number, bottom: number, top: number): void;
@@ -572,14 +573,14 @@ declare class PanZoomControls implements CameraControls {
     private onPointerEnd;
 }
 
-interface ViewportConfig {
+interface ViewportProps {
     id?: string;
     element?: HTMLElement;
     camera: Camera;
     layers?: Layer[];
     cameraControls?: CameraControls;
 }
-interface ViewportProps extends ViewportConfig {
+interface ResolvedViewportProps extends ViewportProps {
     id: string;
     element: HTMLElement;
     context: IdetikContext;
@@ -592,7 +593,7 @@ declare class Viewport {
     cameraControls?: CameraControls;
     private readonly context_;
     private layers_;
-    constructor(props: ViewportProps);
+    constructor(props: ResolvedViewportProps);
     get layers(): readonly Layer[];
     addLayer(layer: Layer): void;
     removeLayer(layer: Layer): void;
@@ -615,7 +616,7 @@ declare class Viewport {
 type LayerState = "initialized" | "loading" | "ready";
 type BlendMode = "none" | "normal" | "additive" | "subtractive" | "multiply" | "premultiplied";
 type StateChangeCallback = (newState: LayerState, prevState?: LayerState) => void;
-interface LayerOptions {
+interface LayerProps {
     opacity?: number;
     blendMode?: BlendMode;
 }
@@ -637,13 +638,13 @@ interface LayerOptions {
  */
 declare abstract class Layer {
     abstract readonly type: string;
-    private objects_;
+    private readonly coverageGroups_;
     private state_;
     private attached_;
     private readonly callbacks_;
     private opacity_;
     blendMode: BlendMode;
-    constructor({ opacity, blendMode }?: LayerOptions);
+    constructor({ opacity, blendMode }?: LayerProps);
     get opacity(): number;
     set opacity(value: number);
     abstract update(viewport?: Viewport): void;
@@ -652,14 +653,12 @@ declare abstract class Layer {
     onDetached(context: IdetikContext): void;
     protected attach(_context: IdetikContext): void;
     protected detach(_context: IdetikContext): void;
-    get objects(): RenderableObject[];
+    get coverageGroups(): ReadonlyMap<number | null, readonly 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 addObject(object: RenderableObject, coverageGroup?: number | null): void;
     protected clearObjects(): void;
     /**
      * Get uniforms for shader program. Override in derived classes that need custom uniforms.
@@ -674,7 +673,7 @@ declare abstract class Renderer {
     private height_;
     protected renderedObjects_: number;
     protected abstract resize(width: number, height: number): void;
-    protected abstract renderObject(layer: Layer, objectIndex: number, camera: Camera): void;
+    protected abstract renderObject(layer: Layer, object: RenderableObject, camera: Camera): void;
     protected abstract clear(): void;
     constructor(canvas: HTMLCanvasElement);
     beginFrame(): void;
@@ -696,9 +695,9 @@ type Overlay = {
     update(idetik: Idetik): void;
 };
 /** @inline */
-type IdetikParams = {
+type IdetikProps = {
     canvas: HTMLCanvasElement;
-    viewports?: ViewportConfig[];
+    viewports?: ViewportProps[];
     overlays?: Overlay[];
     showStats?: boolean;
     memoryLimitMB?: number;
@@ -787,7 +786,7 @@ declare class Idetik {
      *
      * @throws {Error} If viewports have duplicate IDs or shared elements
      */
-    constructor(params: IdetikParams, renderer?: Renderer);
+    constructor(params: IdetikProps, renderer?: Renderer);
     get chunkQueueStats(): QueueStats;
     get memoryStats(): MemoryStats;
     get renderedObjects(): number;
@@ -796,7 +795,7 @@ declare class Idetik {
     get viewports(): readonly Viewport[];
     get running(): boolean;
     getViewport(id: string): Viewport | undefined;
-    addViewport(config: ViewportConfig): Viewport;
+    addViewport(props: ViewportProps): Viewport;
     removeViewport(viewport: Viewport): boolean;
     addOverlay(overlay: Overlay): void;
     removeOverlay(overlay: Overlay): boolean;
@@ -1495,7 +1494,7 @@ interface PointPickingResult {
 }
 
 /** @inline */
-type ImageLayerProps = LayerOptions & {
+type ImageLayerProps = LayerProps & {
     source: ChunkSource;
     sliceCoords: SliceCoordinates;
     policy: ImageSourcePolicy;
@@ -1526,6 +1525,7 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
     private orientation_;
     private readonly onPickValue_?;
     private readonly visibleChunks_;
+    private orderedChunks_;
     private readonly pool_;
     private readonly initialChannelProps_?;
     private readonly channelChangeCallbacks_;
@@ -1550,7 +1550,7 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
      */
     setOrientation(orientation: SliceOrientation): void;
     private updateChunks;
-    hasMultipleLODs(): boolean;
+    private rebuildRenderGroups;
     get lastPresentationTimeCoord(): number | undefined;
     private isPresentationStale;
     onEvent(event: EventContext): void;
@@ -1594,7 +1594,7 @@ declare class VolumeLayer extends Layer implements ChannelsEnabled {
     private readonly pool_;
     private readonly initialChannelProps_?;
     private readonly channelChangeCallbacks_;
-    private sourcePolicy_;
+    private policy_;
     private chunkStoreView_?;
     private channelProps_?;
     private lastLoadedTime_;
@@ -1607,7 +1607,7 @@ declare class VolumeLayer extends Layer implements ChannelsEnabled {
     earlyTerminationAlpha: number;
     get debugShowWireframes(): boolean;
     set debugShowWireframes(value: boolean);
-    set sourcePolicy(newPolicy: ImageSourcePolicy);
+    set imageSourcePolicy(newPolicy: ImageSourcePolicy);
     setChannelProps(channelProps: ChannelProps[]): void;
     get channelProps(): ChannelProps[] | undefined;
     resetChannelProps(): void;
@@ -1621,6 +1621,7 @@ declare class VolumeLayer extends Layer implements ChannelsEnabled {
     private updateVolumeTransform;
     private releaseAndRemoveVolume;
     update(viewport?: Viewport): void;
+    private rebuildObjects;
     getUniforms(): Record<string, unknown>;
 }
 
@@ -1633,8 +1634,36 @@ declare class LabelColorMap {
     readonly cycle: ReadonlyArray<Color>;
     constructor(props?: LabelColorMapProps);
 }
+type LabelImageRenderableProps = {
+    width: number;
+    height: number;
+    imageData: Texture;
+    colorMap: LabelColorMap;
+    outlineSelected?: boolean;
+    selectedValue?: number | null;
+};
+/** @group Renderable Objects */
+declare class LabelImageRenderable extends RenderableObject {
+    private outlineSelected_;
+    private selectedValue_;
+    worldToTexCoord: mat4;
+    constructor(props: LabelImageRenderableProps);
+    get type(): string;
+    getUniforms(): {
+        u_imageSampler: number;
+        u_colorCycleSampler: number;
+        u_colorLookupTableSampler: number;
+        u_outlineSelected: number;
+        u_selectedValue: number;
+        u_worldToTexCoord: mat4;
+    };
+    setColorMap(colorMap: LabelColorMap): void;
+    setSelectedValue(value: number | null): void;
+    private makeColorCycleTexture;
+    private makeColorLookupTableTexture;
+}
 
-type LabelLayerProps = LayerOptions & {
+type LabelLayerProps = LayerProps & {
     source: ChunkSource;
     sliceCoords: SliceCoordinates;
     policy: ImageSourcePolicy;
@@ -1675,7 +1704,6 @@ declare class LabelLayer extends Layer {
      */
     setOrientation(orientation: SliceOrientation): void;
     private updateChunks;
-    hasMultipleLODs(): boolean;
     private isPresentationStale;
     onEvent(event: EventContext): void;
     private pickAtRay;
@@ -1717,45 +1745,16 @@ declare class ImageRenderable extends RenderableObject {
     getUniforms(): UniformValues;
 }
 
-type LabelImageRenderableProps = {
-    width: number;
-    height: number;
-    imageData: Texture;
-    colorMap: LabelColorMap;
-    outlineSelected?: boolean;
-    selectedValue?: number | null;
-};
-/** @group Renderable Objects */
-declare class LabelImageRenderable extends RenderableObject {
-    private outlineSelected_;
-    private selectedValue_;
-    worldToTexCoord: mat4;
-    constructor(props: LabelImageRenderableProps);
-    get type(): string;
-    getUniforms(): {
-        u_imageSampler: number;
-        u_colorCycleSampler: number;
-        u_colorLookupTableSampler: number;
-        u_outlineSelected: number;
-        u_selectedValue: number;
-        u_worldToTexCoord: mat4;
-    };
-    setColorMap(colorMap: LabelColorMap): void;
-    setSelectedValue(value: number | null): void;
-    private makeColorCycleTexture;
-    private makeColorLookupTableTexture;
-}
-
 type Marker = "circle" | "square" | "triangle";
-type PointProperties = {
+type PointProps = {
     position: vec3;
     color: ColorLike;
     size: number;
     marker: Marker;
 };
 /** @group Renderable Objects */
-declare class Points extends RenderableObject {
-    constructor(points: PointProperties[]);
+declare class PointsRenderable extends RenderableObject {
+    constructor(points: PointProps[]);
     get type(): string;
 }
 
@@ -1765,16 +1764,16 @@ declare class ProjectedLineGeometry extends Geometry {
     private createIndex;
 }
 
-type LineParameters = {
+type ProjectedLineRenderableProps = {
     geometry: ProjectedLineGeometry;
     color: ColorLike;
     width: number;
 };
 /** @group Renderable Objects */
-declare class ProjectedLine extends RenderableObject {
+declare class ProjectedLineRenderable extends RenderableObject {
     private color_;
     private width_;
-    constructor({ geometry, color, width }: LineParameters);
+    constructor({ geometry, color, width }: ProjectedLineRenderableProps);
     get type(): string;
     get color(): Color;
     set color(value: ColorLike);
@@ -1808,7 +1807,7 @@ declare class VolumeRenderable extends RenderableObject {
     setChannelProperty<K extends keyof ChannelProps>(channelIndex: number, property: K, value: Required<ChannelProps>[K]): void;
 }
 
-type PerspectiveCameraOptions = {
+type PerspectiveCameraProps = {
     fov?: number;
     aspectRatio?: number;
     near?: number;
@@ -1819,7 +1818,7 @@ type PerspectiveCameraOptions = {
 declare class PerspectiveCamera extends Camera {
     private fov_;
     private aspectRatio_;
-    constructor(options?: PerspectiveCameraOptions);
+    constructor(options?: PerspectiveCameraProps);
     setAspectRatio(aspectRatio: number): void;
     get type(): CameraType;
     get fov(): number;
@@ -1827,7 +1826,7 @@ declare class PerspectiveCamera extends Camera {
     protected updateProjectionMatrix(): void;
 }
 
-type OrbitParams = {
+type OrbitControlsProps = {
     radius?: number;
     yaw?: number;
     pitch?: number;
@@ -1843,7 +1842,7 @@ declare class OrbitControls implements CameraControls {
     private readonly currCenter_;
     private readonly dampingFactor_;
     private currMouseButton_;
-    constructor(camera: PerspectiveCamera, params?: OrbitParams);
+    constructor(camera: PerspectiveCamera, params?: OrbitControlsProps);
     get isMoving(): boolean;
     onEvent(event: EventContext): void;
     onUpdate(dt: number): void;
@@ -2067,5 +2066,5 @@ 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 { AxesLayer, Color, Idetik, ImageLayer, ImageRenderable, LabelColorMap, LabelImageRenderable, LabelLayer, Layer, OmeZarrImageSource, OrbitControls, OrthographicCamera, PanZoomControls, PerspectiveCamera, PointsRenderable, ProjectedLineRenderable, VolumeLayer, VolumeRenderable, createExplorationPolicy, createImageSourcePolicy, createNoPrefetchPolicy, createPlaybackPolicy, loadOmeZarrPlate, loadOmeZarrWell, loadOmeroChannels, loadOmeroDefaults };
 export type { ChannelProps, ColorLike, LayerState, MemoryStats, OmeZarrImage, Overlay, SliceCoordinates, SliceOrientation };