refactor: format + lint + cleanup

briossant · briossant · commit 7d0305266c2f · 2025-10-30T16:12:39.000+01:00
diff --git a/package.json b/package.json
@@ -528,7 +528,6 @@
       "neuroglancer/kvstore/zip:disabled": "./src/util/false.ts",
       "default": "./src/kvstore/zip/register_backend.ts"
     },
-    "#kvstore/indexeddb/register": "./src/kvstore/indexeddb/register.ts",
     "#layer/annotation": {
       "neuroglancer/layer/annotation:enabled": "./src/layer/annotation/index.ts",
       "neuroglancer/layer:none_by_default": "./src/util/false.ts",
@@ -553,12 +552,6 @@
       "neuroglancer/layer/single_mesh:disabled": "./src/util/false.ts",
       "default": "./src/layer/single_mesh/index.ts"
     },
-    "#layer/vox": {
-      "neuroglancer/layer/vox:enabled": "./src/layer/vox/index.ts",
-      "neuroglancer/layer:none_by_default": "./src/util/false.ts",
-      "neuroglancer/layer/vox:disabled": "./src/util/false.ts",
-      "default": "./src/layer/vox/index.ts"
-    },
     "#main": {
       "neuroglancer/python": "./src/main_python.ts",
       "default": "./src/main.ts"
diff --git a/src/kvstore/opfs/backend.ts b/src/kvstore/opfs/backend.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2025
+ * Copyright 2025 Google Inc.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
diff --git a/src/kvstore/opfs/common.ts b/src/kvstore/opfs/common.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2025
+ * Copyright 2025 Google Inc.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
diff --git a/src/kvstore/opfs/register_backend.ts b/src/kvstore/opfs/register_backend.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2025
+ * Copyright 2025 Google Inc.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
diff --git a/src/kvstore/opfs/register_frontend.ts b/src/kvstore/opfs/register_frontend.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2025
+ * Copyright 2025 Google Inc.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
diff --git a/src/layer/enabled_frontend_modules.ts b/src/layer/enabled_frontend_modules.ts
@@ -3,4 +3,3 @@ import "#layer/annotation";
 import "#layer/image";
 import "#layer/segmentation";
 import "#layer/single_mesh";
-import "#layer/vox";
diff --git a/src/layer/vox/controls.ts b/src/layer/vox/controls.ts
@@ -1,3 +1,19 @@
+/**
+ * @license
+ * Copyright 2025 Google Inc.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import type { UserLayerConstructor } from "#src/layer/index.js";
 import { LayerActionContext } from "#src/layer/index.js";
 import type { UserLayerWithVoxelEditing } from "#src/layer/vox/index.js";
@@ -15,7 +31,10 @@ import { colorLayerControl } from "#src/widget/layer_control_color.js";
 import { enumLayerControl } from "#src/widget/layer_control_enum.js";
 import { rangeLayerControl } from "#src/widget/layer_control_range.js";
 
-class BigIntAsTrackableRGB extends RefCounted implements WatchableValueInterface<vec3> {
+class BigIntAsTrackableRGB
+  extends RefCounted
+  implements WatchableValueInterface<vec3>
+{
   changed = new NullarySignal();
   private tempColor = vec3.create();
 
@@ -88,7 +107,10 @@ export const VOXEL_LAYER_CONTROLS: LayerControlDefinition<UserLayerWithVoxelEdit
     {
       label: "Paint Color",
       toolJson: { type: "vox-paint-color" },
-      ...colorLayerControl((layer: UserLayerWithVoxelEditing) => new BigIntAsTrackableRGB(layer.paintValue)),
+      ...colorLayerControl(
+        (layer: UserLayerWithVoxelEditing) =>
+          new BigIntAsTrackableRGB(layer.paintValue),
+      ),
     },
     {
       label: "Paint Value",
@@ -120,7 +142,10 @@ export const VOXEL_LAYER_CONTROLS: LayerControlDefinition<UserLayerWithVoxelEdit
       ...buttonLayerControl({
         text: "Random",
         onClick: (layer) =>
-          layer.handleVoxAction("randomize-paint-value", new LayerActionContext()),
+          layer.handleVoxAction(
+            "randomize-paint-value",
+            new LayerActionContext(),
+          ),
       }),
     },
   ];
diff --git a/src/layer/vox/index.ts b/src/layer/vox/index.ts
@@ -17,8 +17,8 @@
 import type {
   LayerActionContext,
   MouseSelectionState,
-  UserLayer,
 } from "#src/layer/index.js";
+import { UserLayer } from "#src/layer/index.js";
 import type { LoadedDataSubsource } from "#src/layer/layer_data_source.js";
 import { VoxToolTab } from "#src/layer/vox/tabs/tools.js";
 import type {
@@ -48,14 +48,10 @@ import {
 } from "#src/util/json.js";
 import { TrackableEnum } from "#src/util/trackable_enum.js";
 import { VoxelPreviewMultiscaleSource } from "#src/voxel_annotation/PreviewMultiscaleChunkSource.js";
-import type { VoxelEditControllerHost } from "#src/voxel_annotation/edit_controller.js";
+import type { VoxelEditControllerHost } from "#src/voxel_annotation/base.js";
+import { BrushShape } from "#src/voxel_annotation/base.js";
 import { VoxelEditController } from "#src/voxel_annotation/edit_controller.js";
 
-export enum BrushShape {
-  DISK = 0,
-  SPHERE = 1,
-}
-
 const BRUSH_SIZE_JSON_KEY = "brushSize";
 const ERASE_MODE_JSON_KEY = "eraseMode";
 const BRUSH_SHAPE_JSON_KEY = "brushShape";
@@ -154,10 +150,16 @@ export class VoxelEditingContext
 
     for (let chunkDim = 0; chunkDim < 3; ++chunkDim) {
       let sum = 0;
-      for (let globalDim = 0; globalDim < Math.min(globalRank, 3); ++globalDim) {
+      for (
+        let globalDim = 0;
+        globalDim < Math.min(globalRank, 3);
+        ++globalDim
+      ) {
         const layerDim = globalToRenderLayerDimensions[globalDim];
         if (layerDim !== -1) {
-          sum += layerToChunkTransform[chunkDim + layerDim * (layerRank + 1)] * globalNormal[globalDim];
+          sum +=
+            layerToChunkTransform[chunkDim + layerDim * (layerRank + 1)] *
+            globalNormal[globalDim];
         }
       }
       voxelNormal[chunkDim] = sum;
@@ -243,11 +245,23 @@ export function UserLayerWithVoxelEditingMixin<
 
     restoreState(specification: any) {
       super.restoreState(specification);
-      verifyOptionalObjectProperty(specification, BRUSH_SIZE_JSON_KEY, v => this.voxBrushRadius.restoreState(v));
-      verifyOptionalObjectProperty(specification, ERASE_MODE_JSON_KEY, v => this.voxEraseMode.restoreState(v));
-      verifyOptionalObjectProperty(specification, BRUSH_SHAPE_JSON_KEY, v => this.voxBrushShape.restoreState(v));
-      verifyOptionalObjectProperty(specification, FLOOD_FILL_MAX_VOXELS_JSON_KEY, v => this.voxFloodMaxVoxels.restoreState(v));
-      verifyOptionalObjectProperty(specification, PAINT_VALUE_JSON_KEY, v => this.paintValue.restoreState(v));
+      verifyOptionalObjectProperty(specification, BRUSH_SIZE_JSON_KEY, (v) =>
+        this.voxBrushRadius.restoreState(v),
+      );
+      verifyOptionalObjectProperty(specification, ERASE_MODE_JSON_KEY, (v) =>
+        this.voxEraseMode.restoreState(v),
+      );
+      verifyOptionalObjectProperty(specification, BRUSH_SHAPE_JSON_KEY, (v) =>
+        this.voxBrushShape.restoreState(v),
+      );
+      verifyOptionalObjectProperty(
+        specification,
+        FLOOD_FILL_MAX_VOXELS_JSON_KEY,
+        (v) => this.voxFloodMaxVoxels.restoreState(v),
+      );
+      verifyOptionalObjectProperty(specification, PAINT_VALUE_JSON_KEY, (v) =>
+        this.paintValue.restoreState(v),
+      );
     }
 
     getVoxelPaintValue(erase: boolean): bigint {
@@ -258,7 +272,6 @@ export function UserLayerWithVoxelEditingMixin<
       this.paintValue.value = value;
     }
 
-
     abstract _createVoxelRenderLayer(
       source: MultiscaleVolumeChunkSource,
       transform: WatchableValueInterface<RenderLayerTransformOrError>,
diff --git a/src/layer/vox/style.css b/src/layer/vox/style.css
@@ -14,29 +14,17 @@
  * limitations under the License.
  */
 
-:root {
-  /* best-effort variables if app doesn't define them */
-  --ng-bg: rgba(20, 22, 27, 0.9);
-  --ng-card: rgba(255, 255, 255, 0.04);
-  --ng-border: rgba(255, 255, 255, 0.15);
-  --ng-text: rgba(230, 230, 235, 0.95);
-  --ng-muted: rgba(230, 230, 235, 0.65);
-  --ng-accent: #3a6df0;
-}
-
 .neuroglancer-vox-row label {
   flex: 0 0 140px;
   min-width: 0;
   font-weight: 500;
-  color: var(--ng-muted);
 }
 
 .neuroglancer-vox-status {
   display: block;
   flex: 1 1 100%;
   min-width: 100%;
   padding-top: 4px;
-  color: var(--ng-muted);
 }
 
 .neuroglancer-vox-settings-tab button:hover,
diff --git a/src/sliceview/frontend.ts b/src/sliceview/frontend.ts
@@ -438,14 +438,6 @@ export class SliceView extends Base {
             lastSeenGeneration: curUpdateGeneration,
             displayDimensionRenderInfo,
           };
-          if ((renderLayer as any).constructor?.type === "vox") {
-            console.log(
-              "[SliceView.updateVisibleLayersNow] new vox layerInfo created, allSources orientations=",
-              layerInfo.allSources.length,
-              "first orientation scales=",
-              layerInfo.allSources[0]?.length ?? 0,
-            );
-          }
           disposers.push(renderLayer.messages.addChild(layerInfo.messages));
           visibleLayers.set(renderLayer.addRef(), layerInfo);
           this.bindVisibleRenderLayer(renderLayer, disposers);
@@ -463,14 +455,6 @@ export class SliceView extends Base {
             renderLayer,
             layerInfo.messages,
           );
-          if ((renderLayer as any).constructor?.type === "vox") {
-            console.log(
-              "[SliceView.updateVisibleLayersNow] vox layer transform changed, new allSources orientations=",
-              layerInfo.allSources.length,
-              "first orientation scales=",
-              layerInfo.allSources[0]?.length ?? 0,
-            );
-          }
           disposeTransformedSources(renderLayer, allSources);
           layerInfo.visibleSources.length = 0;
           layerInfo.displayDimensionRenderInfo = displayDimensionRenderInfo;
@@ -730,14 +714,7 @@ export interface SliceViewChunkSource {
 
 /*
 export class SliceViewChunk extends Chunk {
-  chunkGridPosition: vec3;
-  declare source: SliceViewChunkSource;
-
-  constructor(source: SliceViewChunkSource, x: any) {
-    super(source);
-    this.chunkGridPosition = x.chunkGridPosition;
-    this.state = ChunkState.SYSTEM_MEMORY;
-  }
+  // MOVED to chunk_base.ts to avoid import loop
 }
 */
 
diff --git a/src/sliceview/volume/registry.ts b/src/sliceview/volume/registry.ts
@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2020 Google Inc.
+ * Copyright 2025 Google Inc.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
diff --git a/src/ui/voxel_annotations.ts b/src/ui/voxel_annotations.ts
@@ -15,15 +15,18 @@
  */
 
 import type { MouseSelectionState } from "#src/layer/index.js";
-import type { UserLayerWithVoxelEditing, VoxelEditingContext } from "#src/layer/vox/index.js";
-import { BrushShape } from "#src/layer/vox/index.js";
+import type {
+  UserLayerWithVoxelEditing,
+  VoxelEditingContext,
+} from "#src/layer/vox/index.js";
 import type { RenderedDataPanel } from "#src/rendered_data_panel.js";
 import { StatusMessage } from "#src/status.js";
 import { LayerTool, registerTool, type ToolActivation } from "#src/ui/tool.js";
 import { vec3 } from "#src/util/geom.js";
 import { EventActionMap } from "#src/util/mouse_bindings.js";
 import { startRelativeMouseDrag } from "#src/util/mouse_drag.js";
 import { NullarySignal } from "#src/util/signal.js";
+import { BrushShape } from "#src/voxel_annotation/base.js";
 
 export const BRUSH_TOOL_ID = "vox-brush";
 export const FLOODFILL_TOOL_ID = "vox-flood-fill";
@@ -48,8 +51,10 @@ abstract class BaseVoxelTool extends LayerTool<UserLayerWithVoxelEditing> {
       | Float32Array
       | undefined;
     if (!mouseState?.active || !vox) return undefined;
-    if(!mouseState.planeNormal) return;
-    const planeNormal =  editContext.transformGlobalToVoxelNormal(mouseState.planeNormal);
+    if (!mouseState.planeNormal) return;
+    const planeNormal = editContext.transformGlobalToVoxelNormal(
+      mouseState.planeNormal,
+    );
     if (!mouseState?.active || !vox || !planeNormal) return undefined;
     const CHUNK_POSITION_EPSILON = 1e-3;
     const shiftedVox = new Float32Array(3);
@@ -252,9 +257,7 @@ export class VoxelBrushTool extends BaseVoxelTool {
       );
     }
 
-    const value = this.layer.getVoxelPaintValue(
-      this.layer.voxEraseMode.value,
-    );
+    const value = this.layer.getVoxelPaintValue(this.layer.voxEraseMode.value);
 
     this.paintPoints([new Float32Array([start[0], start[1], start[2]])], value);
     this.lastPoint = start;
@@ -296,7 +299,9 @@ export class VoxelBrushTool extends BaseVoxelTool {
     const shapeEnum = this.layer.voxBrushShape.value;
     let basis = undefined as undefined | { u: Float32Array; v: Float32Array };
     if (shapeEnum === BrushShape.DISK && this.currentMouseState?.planeNormal) {
-      const n =  editContext.transformGlobalToVoxelNormal(this.currentMouseState.planeNormal);
+      const n = editContext.transformGlobalToVoxelNormal(
+        this.currentMouseState.planeNormal,
+      );
       const u = vec3.create();
       const tempVec =
         Math.abs(vec3.dot(n, vec3.fromValues(1, 0, 0))) < 0.9
@@ -309,7 +314,6 @@ export class VoxelBrushTool extends BaseVoxelTool {
       basis = { u, v };
     }
 
-
     for (const p of points)
       editContext.controller?.paintBrushWithShape(
         p,
@@ -363,8 +367,10 @@ export class VoxelFloodFillTool extends BaseVoxelTool {
       return;
     }
     const seed = this.getPoint(this.mouseState);
-    if(!this.mouseState.planeNormal) return;
-    const planeNormal =  editContext.transformGlobalToVoxelNormal(this.mouseState.planeNormal);
+    if (!this.mouseState.planeNormal) return;
+    const planeNormal = editContext.transformGlobalToVoxelNormal(
+      this.mouseState.planeNormal,
+    );
     if (!seed || !planeNormal) return;
     try {
       const value = this.layer.getVoxelPaintValue(
diff --git a/src/voxel_annotation/TODOs.md b/src/voxel_annotation/TODOs.md
@@ -3,12 +3,11 @@
 ### priority
 
 - url completion for the ssa+https source
-- add json state for all tools and settings of voxel painting
-- replace the current label system with a new system linked to the segment in the segmentation layer and with a color picker for the image layer -> FOR TOMORROW
 - fix the case of multiple datasources in the same layer
 
 ### later
 
+- should we allow drawing even when there are no writable volume, and in that case inform the user about it and only draw edits in the preview layer? I am not sure about the real use cases tho.
 - add preview for the undo/redo
 - optimize flood fill tool (it is too slow on area containing uncached chunks, due to the getEnsuredValueAt() calls)
 - the flood fill sometimes leaves artifacts in sharp areas (maybe increase fillBorderRegion() radius)
diff --git a/src/voxel_annotation/base.ts b/src/voxel_annotation/base.ts
@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+import type { MultiscaleVolumeChunkSource } from "#src/sliceview/volume/frontend.js";
+import type { VoxelPreviewMultiscaleSource } from "#src/voxel_annotation/PreviewMultiscaleChunkSource.js";
+import type { RPC } from "#src/worker_rpc.js";
+
 export const VOX_RELOAD_CHUNKS_RPC_ID = "vox.chunk.reload";
 export const VOX_EDIT_BACKEND_RPC_ID = "vox.EditBackend";
 export const VOX_EDIT_COMMIT_VOXELS_RPC_ID = "vox.edit.commitVoxels";
@@ -68,3 +72,14 @@ export function parseVoxChunkKey(key: string) {
     chunkKey: key.split("#")[1],
   };
 }
+
+export enum BrushShape {
+  DISK = 0,
+  SPHERE = 1,
+}
+
+export interface VoxelEditControllerHost {
+  primarySource: MultiscaleVolumeChunkSource;
+  previewSource: VoxelPreviewMultiscaleSource;
+  rpc: RPC;
+}
diff --git a/src/voxel_annotation/edit_controller.ts b/src/voxel_annotation/edit_controller.ts
diff --git a/src/voxel_annotation/labels.ts b/src/voxel_annotation/labels.ts
diff --git a/src/widget/layer_control_button.ts b/src/widget/layer_control_button.ts
