@idetik/core 0.35.4 → 0.35.5

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;
 }
@@ -643,7 +644,7 @@ declare abstract class Layer {
     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;
@@ -696,9 +697,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 +788,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 +797,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 +1496,7 @@ interface PointPickingResult {
 }
 
 /** @inline */
-type ImageLayerProps = LayerOptions & {
+type ImageLayerProps = LayerProps & {
     source: ChunkSource;
     sliceCoords: SliceCoordinates;
     policy: ImageSourcePolicy;
@@ -1594,7 +1595,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 +1608,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;
@@ -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;
@@ -1717,45 +1746,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 +1765,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 +1808,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 +1819,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 +1827,7 @@ declare class PerspectiveCamera extends Camera {
     protected updateProjectionMatrix(): void;
 }
 
-type OrbitParams = {
+type OrbitControlsProps = {
     radius?: number;
     yaw?: number;
     pitch?: number;
@@ -1843,7 +1843,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 +2067,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 };

package/dist/index.js

@@ -2733,6 +2733,12 @@ class dQ {
   addEventListener(A) {
     this.listeners_.push(A);
   }
+  removeEventListener(A) {
+    const I = this.listeners_.indexOf(A);
+    if (I === -1)
+      throw new Error(`Listener to remove could not be found: ${A}`);
+    this.listeners_.splice(I, 1);
+  }
   connect() {
     if (this.isConnected_) {
       k.warn(
@@ -3081,11 +3087,7 @@ class ho {
     return this.viewports_.find((I) => I.id === A);
   }
   addViewport(A) {
-    const [I] = _g(
-      [A],
-      this.canvas,
-      this.context_
-    );
+    const [I] = _g([A], this.canvas, this.context_);
     return jB(I, this.viewports_), this.viewports_.push(I), this.running && (I.events.connect(), I.element !== this.canvas && this.sizeObserver_.observe(I.element)), k.info("Idetik", `Added viewport "${I.id}"`), I;
   }
   removeViewport(A) {
@@ -11915,7 +11917,7 @@ class KI {
   }
   removeStateChangeCallback(A) {
     const I = this.callbacks_.indexOf(A);
-    if (I === void 0)
+    if (I === -1)
       throw new Error(`Callback to remove could not be found: ${A}`);
     this.callbacks_.splice(I, 1);
   }
@@ -12210,7 +12212,7 @@ class Hi extends xA {
     super(), this.geometry = A, this.color_ = x.from(I), this.width_ = B, this.programName = "projectedLine";
   }
   get type() {
-    return "ProjectedLine";
+    return "ProjectedLineRenderable";
   }
   get color() {
     return this.color_;
@@ -12871,7 +12873,7 @@ class Fo extends KI {
   pool_ = new pg();
   initialChannelProps_;
   channelChangeCallbacks_ = [];
-  sourcePolicy_;
+  policy_;
   chunkStoreView_;
   channelProps_;
   lastLoadedTime_ = void 0;
@@ -12893,8 +12895,8 @@ class Fo extends KI {
       this.debugShowWireframes_ = A;
     }
   }
-  set sourcePolicy(A) {
-    this.sourcePolicy_ !== A && (this.sourcePolicy_ = A, this.chunkStoreView_ && this.chunkStoreView_.setImageSourcePolicy(
+  set imageSourcePolicy(A) {
+    this.policy_ !== A && (this.policy_ = A, this.chunkStoreView_ && this.chunkStoreView_.setImageSourcePolicy(
       A,
       YI
     ));
@@ -12918,12 +12920,12 @@ class Fo extends KI {
   }
   removeChannelChangeCallback(A) {
     const I = this.channelChangeCallbacks_.indexOf(A);
-    if (I === void 0)
+    if (I === -1)
       throw new Error(`Callback to remove could not be found: ${A}`);
     this.channelChangeCallbacks_.splice(I, 1);
   }
   constructor({ source: A, sliceCoords: I, policy: B, channelProps: C }) {
-    super({ blendMode: "premultiplied" }), this.source_ = A, this.sliceCoords_ = I, this.sourcePolicy_ = B, this.initialChannelProps_ = C, this.channelProps_ = C, this.setState("initialized");
+    super({ blendMode: "premultiplied" }), this.source_ = A, this.sliceCoords_ = I, this.policy_ = B, this.initialChannelProps_ = C, this.channelProps_ = C, this.setState("initialized");
   }
   getOrCreateVolume(A, I) {
     const B = this.currentVolumes_.get(A);
@@ -12939,7 +12941,7 @@ class Fo extends KI {
   attach(A) {
     this.chunkStoreView_ = A.chunkManager.addView(
       this.source_,
-      this.sourcePolicy_
+      this.policy_
     ), hC(
       this.channelProps_,
       this.chunkStoreView_.channelCount
@@ -13040,37 +13042,63 @@ class lB extends Fg {
     return this.height_;
   }
 }
-const nC = /* @__PURE__ */ new Set(["byte", "short", "int"]), Pi = /* @__PURE__ */ new Set([
+const Pi = [
+  [1, 0.5, 0.5],
+  [0.5, 1, 0.5],
+  [0.5, 0.5, 1],
+  [0.5, 1, 1],
+  [1, 0.5, 1],
+  [1, 1, 0.5]
+];
+function Oi(g) {
+  return g = g ?? /* @__PURE__ */ new Map(), new Map(
+    Array.from(g.entries()).map(([A, I]) => [
+      A,
+      x.from(I)
+    ])
+  );
+}
+function Vi(g) {
+  return g = g ?? Pi, g.map(x.from);
+}
+class fB {
+  lookupTable;
+  cycle;
+  constructor(A = {}) {
+    this.lookupTable = Oi(A.lookupTable), this.cycle = Vi(A.cycle);
+  }
+}
+const nC = /* @__PURE__ */ new Set(["byte", "short", "int"]), vi = /* @__PURE__ */ new Set([
   "unsigned_byte",
   "unsigned_short",
   "unsigned_int"
 ]);
-function Oi(g) {
+function Xi(g) {
   if (g.dataFormat !== "scalar")
     throw new Error(
       `Image data format must be scalar, instead found: ${g.dataFormat}`
     );
-  if (!nC.has(g.dataType) && !Pi.has(g.dataType))
+  if (!nC.has(g.dataType) && !vi.has(g.dataType))
     throw new Error(
       `Image data type must be an integer, instead found: ${g.dataType}`
     );
   return g;
 }
-function Vi(g) {
+function ji(g) {
   return nC.has(g.dataType) ? "intLabelImage" : "labelImage";
 }
-class vi extends xA {
+class zi extends xA {
   outlineSelected_;
   selectedValue_;
   worldToTexCoord = $();
   constructor(A) {
-    super(), this.geometry = new tC(A.width, A.height, 1, 1), this.setTexture(0, Oi(A.imageData));
+    super(), this.geometry = new tC(A.width, A.height, 1, 1), this.setTexture(0, Xi(A.imageData));
     const I = this.makeColorCycleTexture(A.colorMap.cycle);
     this.setTexture(1, I);
     const B = this.makeColorLookupTableTexture(
       A.colorMap.lookupTable
     );
-    this.setTexture(2, B), this.outlineSelected_ = A.outlineSelected ?? !1, this.selectedValue_ = A.selectedValue ?? null, this.programName = Vi(A.imageData);
+    this.setTexture(2, B), this.outlineSelected_ = A.outlineSelected ?? !1, this.selectedValue_ = A.selectedValue ?? null, this.programName = ji(A.imageData);
   }
   get type() {
     return "LabelImageRenderable";
@@ -13103,32 +13131,6 @@ class vi extends xA {
     return Q.set(I, 0), Q.set(B, C), new lB(Q, C, 2);
   }
 }
-const Xi = [
-  [1, 0.5, 0.5],
-  [0.5, 1, 0.5],
-  [0.5, 0.5, 1],
-  [0.5, 1, 1],
-  [1, 0.5, 1],
-  [1, 1, 0.5]
-];
-function ji(g) {
-  return g = g ?? /* @__PURE__ */ new Map(), new Map(
-    Array.from(g.entries()).map(([A, I]) => [
-      A,
-      x.from(I)
-    ])
-  );
-}
-function zi(g) {
-  return g = g ?? Xi, g.map(x.from);
-}
-class fB {
-  lookupTable;
-  cycle;
-  constructor(A = {}) {
-    this.lookupTable = ji(A.lookupTable), this.cycle = zi(A.cycle);
-  }
-}
 class GC extends KI {
   type = "LabelLayer";
   source_;
@@ -13309,7 +13311,7 @@ class GC extends KI {
     return C ? (C.setTexture(0, I), C.setColorMap(this.colorMap_), C.setSelectedValue(this.selectedValue_), this.updateLabelChunk(C, A), C) : this.createLabel(A, I);
   }
   createLabel(A, I) {
-    const B = new vi({
+    const B = new zi({
       width: A.shape[this.axes_.u],
       height: A.shape[this.axes_.v],
       imageData: I,
@@ -13402,7 +13404,7 @@ class ro extends xA {
     }), this.geometry = B, this.setTexture(0, $i());
   }
   get type() {
-    return "Points";
+    return "PointsRenderable";
   }
 }
 let PI;
@@ -13913,7 +13915,7 @@ export {
   eC as ImageLayer,
   li as ImageRenderable,
   fB as LabelColorMap,
-  vi as LabelImageRenderable,
+  zi as LabelImageRenderable,
   GC as LabelLayer,
   KI as Layer,
   OA as OmeZarrImageSource,
@@ -13921,8 +13923,8 @@ export {
   Ro as OrthographicCamera,
   No as PanZoomControls,
   co as PerspectiveCamera,
-  ro as Points,
-  Hi as ProjectedLine,
+  ro as PointsRenderable,
+  Hi as ProjectedLineRenderable,
   Fo as VolumeLayer,
   mi as VolumeRenderable,
   Uo as createExplorationPolicy,