@navaramap/three 0.0.0 → 0.0.2

package/src/declutter/kernel.ts

@@ -0,0 +1,46 @@
+/**
+ * The pure numeric placement kernel used by {@link DeclutterManager}.
+ *
+ * Given a flat list of candidates and the camera, it projects each anchor to a
+ * screen-pixel box, sorts by priority (with placement hysteresis), and greedily
+ * claims space in a uniform screen-space grid — returning one `hidden` flag
+ * (`0` = shown, `1` = hidden) per candidate, in input order.
+ *
+ * The production implementation is the Rust `declutterPlace` in
+ * `navara_wasm_api` (see {@link wasmDeclutterKernel}); the projection, collision
+ * grid, and greedy placement all live there. Injecting it keeps the manager free
+ * of an import-time WASM dependency, so its orchestration is unit-tested with a
+ * stub. Placement correctness itself is covered by the crate's Rust tests.
+ */
+export type DeclutterKernel = {
+  /**
+   * @param candidates Packed `f64` data, {@link CANDIDATE_STRIDE} values per
+   *   candidate; pass a subarray of exactly `n * CANDIDATE_STRIDE`.
+   * @param view Column-major view matrix (inverse of `camera.matrixWorld`), 16.
+   * @param proj Column-major projection matrix, 16.
+   * @returns One `hidden` flag (`0`/`1`) per candidate, in input order.
+   */
+  place(
+    candidates: Float64Array,
+    view: Float64Array,
+    proj: Float64Array,
+    cameraX: number,
+    cameraY: number,
+    cameraZ: number,
+    near: number,
+    widthPx: number,
+    heightPx: number,
+    fovRad: number,
+    paddingPx: number,
+    hysteresisPx: number,
+  ): Uint8Array;
+};
+
+/**
+ * Number of `f64` values per candidate in the packed kernel input. Must stay in
+ * sync with `CANDIDATE_STRIDE` in `crates/navara_wasm_api/src/declutter.rs`.
+ *
+ * Layout: `[anchorX, anchorY, anchorZ, addHeight, minX, maxX, minY, maxY,
+ * sizeInMeters, priority, isShown]`.
+ */
+export const CANDIDATE_STRIDE = 11;

package/src/declutter/types.ts

@@ -0,0 +1,61 @@
+/**
+ * One label/sprite competing for screen space in a declutter pass.
+ *
+ * The local box is expressed around the projected anchor in the shader's
+ * billboard-local units — CSS pixels when `sizeInMeters` is false, meters
+ * otherwise — with +X right and +Y up (view-space convention). The manager
+ * converts it to a screen-pixel AABB using the same `nvr_pxToWorld` math the
+ * vertex shaders use, so the collision box matches what is actually drawn.
+ */
+export type DeclutterCandidate = {
+  /** World-space anchor in ECEF meters (f64), before the height offset. */
+  anchorX: number;
+  anchorY: number;
+  anchorZ: number;
+  /** Extra offset in meters along the spherical surface normal — CPU mirror
+   *  of `mvr_getMvHeightOffset` (sprite_height_pars_vertex.glsl). */
+  addHeight: number;
+  /** Local box around the anchor (px or meters, see `sizeInMeters`). */
+  minX: number;
+  maxX: number;
+  minY: number;
+  maxY: number;
+  /** Unit of the local box, mirroring the material's `sizeInMeters`. */
+  sizeInMeters: boolean;
+  /** Placement priority: higher wins an overlap. */
+  priority: number;
+  /** Whether the label is currently shown (its fade target is "visible").
+   *  Feeds placement hysteresis: shown labels win equal-priority ties and
+   *  tolerate marginal overlaps, so slow camera drift doesn't make near-tied
+   *  labels flicker in and out. */
+  isShown: boolean;
+  /** Participant that owns this candidate; receives the placement result. */
+  owner: DeclutterParticipant;
+  /** Participant-defined id (mesh index for text batches, instance index for
+   *  sprites) passed back to `applyDeclutter`. */
+  handle: number;
+};
+
+/** Duration of the show/hide fade applied to placement results (ms). */
+export const DECLUTTER_FADE_MS = 300;
+
+/** A mesh that contributes label candidates to the shared declutter pass. */
+export type DeclutterParticipant = {
+  /**
+   * Append the currently-visible, declutter-enabled candidates to `out`.
+   * Called once per placement pass; must not retain `out`.
+   */
+  collectDeclutterCandidates: (out: DeclutterCandidate[]) => void;
+  /**
+   * Apply a placement result as the label's fade *target*. Must be cheap and
+   * idempotent — the pass calls it for every candidate on every run, most
+   * often with an unchanged value.
+   */
+  applyDeclutter: (handle: number, hidden: boolean) => void;
+  /**
+   * Advance this participant's hide factors toward their targets by
+   * `deltaMs / DECLUTTER_FADE_MS`. Called by the manager every update while
+   * anything is fading; returns true while any label is still mid-fade.
+   */
+  stepDeclutterFade: (deltaMs: number) => boolean;
+};

package/src/declutter/wasmKernel.ts

@@ -0,0 +1,13 @@
+import { declutterPlace } from "@navaramap/engine-api";
+
+import type { DeclutterKernel } from "./kernel";
+
+/**
+ * @internal
+ * {@link DeclutterKernel} backed by the Rust `declutterPlace` in
+ * `navara_wasm_api`. The WASM module must be initialized (via `initNavaraApi()`)
+ * before the first placement pass runs; `ThreeView` awaits that during setup.
+ */
+export const wasmDeclutterKernel: DeclutterKernel = {
+  place: declutterPlace,
+};

package/src/device.ts

@@ -50,6 +50,16 @@ export function isMobileDevice(): boolean {
 /** Maximum pixel ratio for mobile devices to balance quality vs performance */
 const MOBILE_MAX_PIXEL_RATIO = 1.0;
 
+/**
+ * Default pixel-ratio cap applied on every mobile device (without opting into
+ * `mobileOptimization`). The fixed screen-sized render-target stack (composer
+ * buffers, gbuffer MRT, depth textures — ~100 B/px, counted by the ledger as
+ * `fixed_gpu_bytes`) grows quadratically with the drawing-buffer size: at
+ * DPR 3 it alone can exceed a mobile tile-cache budget and permanently close
+ * the load gate. Above DPR 2 the sharpness gain is marginal on phone screens.
+ */
+const MOBILE_DEFAULT_MAX_PIXEL_RATIO = 2.0;
+
 export type DevicePixelRatioOptions = {
   /** User-specified pixel ratio override (takes precedence over all other settings) */
   override?: number;
@@ -389,7 +399,9 @@ export function getDefaultDynamicSse(): DynamicSseSettings {
 
 /**
  * Gets an appropriate pixel ratio for the current device.
- * Caps the ratio on mobile devices only when mobileOptimization is enabled.
+ * Mobile devices are capped at 2 by default (see
+ * {@link MOBILE_DEFAULT_MAX_PIXEL_RATIO}), and at 1 when mobileOptimization
+ * is enabled; an explicit `override` (the `pixelRatio` option) bypasses both.
  *
  * @param options - Configuration options for pixel ratio
  * @returns Pixel ratio appropriate for the device
@@ -405,9 +417,11 @@ export function getDevicePixelRatio(options?: DevicePixelRatioOptions): number {
 
   const deviceRatio = window.devicePixelRatio ?? 1;
 
-  // Only cap pixel ratio on mobile when mobileOptimization is enabled
-  if (options?.mobileOptimization && isMobileDevice()) {
-    return Math.min(deviceRatio, MOBILE_MAX_PIXEL_RATIO);
+  if (isMobileDevice()) {
+    const cap = options?.mobileOptimization
+      ? MOBILE_MAX_PIXEL_RATIO
+      : MOBILE_DEFAULT_MAX_PIXEL_RATIO;
+    return Math.min(deviceRatio, cap);
   }
 
   return deviceRatio;

package/src/evaluations/FeatureEvaluator.ts

@@ -55,6 +55,9 @@ export type EvaluatableMaterialProperty = {
   size: AvailableMaterialProperty["size"];
   /** Opacity expression from layer configuration (for polygons/points/text where supported). */
   opacity: AvailableMaterialProperty["opacity"];
+  /** Per-feature declutter placement priority (for points/billboards/text);
+   *  higher wins an overlap. Overrides the layer's `declutterPriority`. */
+  declutterPriority: AvailableMaterialProperty["declutterPriority"];
   /** Image URL for billboards; packed into a shared per-mesh texture atlas. */
   image: string;
 };
@@ -70,6 +73,7 @@ type EvaluatedMaterialProperty = {
   width: number;
   size: number;
   opacity: number;
+  declutterPriority: number;
   image: string | null;
 };
 
@@ -308,6 +312,8 @@ export class FeatureEvaluator {
    * - `width` - Line width in pixels (for polylines)
    * - `size` - Feature size in pixels (for points/text)
    * - `opacity` - Feature opacity 0-1
+   * - `declutterPriority` - Placement priority for decluttering; higher wins
+   *   an overlap (for points/billboards/text with `declutter` enabled)
    * - `image` - Image URL (for billboards); loaded once per distinct URL and
    *   packed into the layer's texture atlas. Return `null` to clear a
    *   previous per-feature image and revert to the material's default `url`;
@@ -387,6 +393,12 @@ export class FeatureEvaluator {
       if (evaluated.opacity != null) {
         obj.setFeatureOpacityByBatchId(batchId, evaluated.opacity);
       }
+      if (evaluated.declutterPriority != null) {
+        obj.setFeatureDeclutterPriorityByBatchId(
+          batchId,
+          evaluated.declutterPriority,
+        );
+      }
       if ("image" in evaluated) {
         // Async by nature (the image may need fetching); the atlas dedupes
         // loads by URL so evaluating many features costs one fetch per image.
@@ -415,6 +427,15 @@ export class FeatureEvaluator {
       if (evaluated.opacity != null && obj instanceof BatchedSdfTextMesh) {
         obj.setFeatureOpacityByBatchIndex(batchIndex, evaluated.opacity);
       }
+      if (
+        evaluated.declutterPriority != null &&
+        obj instanceof BatchedSdfTextMesh
+      ) {
+        obj.setFeatureDeclutterPriorityByBatchIndex(
+          batchIndex,
+          evaluated.declutterPriority,
+        );
+      }
       return;
     }
 

package/src/event/context.ts

@@ -7,6 +7,7 @@ import type {
 import type {
   DelegatedWorkerTasksResult,
   ElevationDecoder,
+  RasterTileState,
   ReconstructableEntity,
   ReturnedTransferablePolygonBatchedFeature,
   ReturnedTransferablePolylineBatchedFeature,
@@ -21,6 +22,7 @@ import type { Texture } from "three";
 import type { ViewEvents } from "..";
 import type { ThreeViewCamera } from "../camera";
 import type { ViewContext } from "../core";
+import type { DeclutterManager } from "../declutter";
 import type { LayersManager } from "../layersManager";
 import type { TileMesh } from "../mesh/tile";
 import type { Scenes, TexturizedSceneByTileCoordinates } from "../scene";
@@ -106,6 +108,10 @@ export type TileHandler = {
   getTileElevationDecoder: (handle: bigint) => ElevationDecoder | undefined;
   getVectorTileStates: (handle: bigint) => VectorTileState[] | undefined;
   vectorRevision: () => number;
+  /** The WM raster tiles to bake into per-layer drape render targets for a
+   * terrain tile (Geographic terrain only; empty on WebMercator terrain). */
+  getRasterTileStates: (handle: bigint) => RasterTileState[] | undefined;
+  rasterRevision: () => number;
   /** Reports a terrain tile's drape render-target GPU footprint (bytes) so the
    * memory ledger tracks clamp-to-ground vector bakes that scale with terrain
    * subdivision past the vector `maxZoom`. Pass 0 to release on dispose. */
@@ -115,6 +121,12 @@ export type TileHandler = {
     textureZoom: number,
     textureWidth: number,
   ) => number;
+  /** Rust's clamped WebMercator northing (`navara_geometry::mercator_y`).
+   * The composite paste derives its per-slot reprojection constants through
+   * this so paste and bake (`uv_rect_from_extents_mercator`) share one
+   * implementation — a drifting reimplementation misaligns the pasted
+   * latitude band (and NaNs on the unclamped polar band). */
+  mercatorY: (lat: number) => number;
 };
 
 /**
@@ -209,6 +221,7 @@ type EventContextArgs = {
   textureFragmentIndex?: Map<string, Set<TextureSlot>>;
   tileMeshToFragmentIds?: Map<TileMesh, Set<string>>;
   hillshadeContext?: HillshadeContext;
+  declutter?: DeclutterManager;
 };
 
 /**
@@ -243,6 +256,9 @@ export class EventContext {
   readonly textureFragmentIndex?: Map<string, Set<TextureSlot>>;
   readonly tileMeshToFragmentIds?: Map<TileMesh, Set<string>>;
   readonly hillshadeContext?: HillshadeContext;
+  /** Shared screen-space label declutterer; text/sprite meshes register as
+   *  participants on creation. Optional so headless contexts can skip it. */
+  readonly declutter?: DeclutterManager;
 
   updatedAt = 0;
 
@@ -275,5 +291,6 @@ export class EventContext {
     this.textureFragmentIndex = args.textureFragmentIndex;
     this.tileMeshToFragmentIds = args.tileMeshToFragmentIds;
     this.hillshadeContext = args.hillshadeContext;
+    this.declutter = args.declutter;
   }
 }

package/src/event/features/modelGpuBytes.ts

@@ -60,9 +60,7 @@ export function sumModelGpuBytes(obj: Object3D): number {
       }
     }
     const material = (node as Mesh | Points).material as
-      | Material
-      | Material[]
-      | undefined;
+      Material | Material[] | undefined;
     const materials = Array.isArray(material)
       ? material
       : material

package/src/event/hillshade.test.ts

@@ -494,9 +494,8 @@ describe("hillshade normal map generation", () => {
     expect(loadedTexs.has(entityId)).toBe(true);
     const normalMap = loadedTexs.get(entityId);
     expect(normalMap).toBeInstanceOf(Texture);
-    if (normalMap) {
-      expect((normalMap.image as { width: number }).width).toBe(4); // Content size (no padding in normal map)
-    }
+    // Content size (no padding in normal map)
+    expect((normalMap?.image as { width: number } | undefined)?.width).toBe(4);
 
     // Verify temp DEM entry was stored for edge updates
     const tempDem = hillshadeContext.getTempDem(entityId);
@@ -584,16 +583,11 @@ describe("hillshade normal map generation", () => {
         target_entity_gen: 123,
       } as HillshadeBackfilledEvent);
 
-      if (direction < 3) {
-        // Not all edges received yet
-        expect(hillshadeContext.getTempDem(entityId)).toBeDefined();
-        expect(hillshadeContext.getTempDem(entityId)?.receivedEdges.size).toBe(
-          direction + 1,
-        );
-      } else {
-        // All 4 edges received, temp DEM should be cleaned up
-        expect(hillshadeContext.getTempDem(entityId)).toBeUndefined();
-      }
+      // The temp DEM tracks received edges until all 4 arrive, then it is
+      // cleaned up (so `getTempDem` returns undefined on the last iteration).
+      expect(hillshadeContext.getTempDem(entityId)?.receivedEdges.size).toBe(
+        direction < 3 ? direction + 1 : undefined,
+      );
     }
 
     // Verify texture still exists after cleanup

package/src/event/index.ts

@@ -23,7 +23,7 @@ import { BatchedSdfTextMesh, Layer } from "..";
 import { disposeTexture } from "../loaders";
 import { getImageDataFromBlob } from "../tasks/getImageDataFromBlob";
 
-import { EventContext } from "./context";
+import { type EventContext } from "./context";
 import {
   checkFeatureParallel,
   processRenderableFeatureAdded,
@@ -463,12 +463,11 @@ async function processRequestedData(ctx: EventContext, req: DataRequestEvent) {
           return;
         }
 
-        let u8a: Uint8Array | null = new Uint8Array(data);
+        const u8a = new Uint8Array(data);
         buf.setU8(req.handle, req.bits, u8a);
 
         // Prevent memory leak
         u8a.set([]);
-        u8a = null;
 
         data.set([]);
       })

package/src/event/tileHandler.ts

@@ -0,0 +1,54 @@
+import { mercatorY, type Core } from "@navaramap/engine";
+
+import type { TileHandler } from "./context";
+
+export type TileHandlerDeps = {
+  /** Accessor (not a snapshot) — the Core is created asynchronously after
+   * WASM init and can be dropped on dispose. */
+  getCore: () => Core | undefined;
+  /** Per-frame cached revision snapshots (refreshed once per `_render`), so
+   * per-tile `onBeforeRender` gating costs no WASM-boundary call. */
+  getVectorRevision: () => number;
+  getRasterRevision: () => number;
+};
+
+/**
+ * Build the {@link TileHandler} context over a WASM `Core`. Extracted from
+ * `ThreeView` so tests can assemble the same handler over a shared test engine
+ * (`test-utils/engine.ts`) instead of stubbing the Rust-backed functions.
+ */
+export function createTileHandler(deps: TileHandlerDeps): TileHandler {
+  const { getCore } = deps;
+  return {
+    getMartini: (id) => {
+      return getCore()?.getMartini(id);
+    },
+    getTile: (handle) => {
+      return getCore()?.getTile(handle);
+    },
+    getParentTile: (handle) => {
+      return getCore()?.getParentTile(handle);
+    },
+    getTileElevationDecoder: (handle) => {
+      return getCore()?.getTileElevationDecoder(handle);
+    },
+    getVectorTileStates: (handle) => {
+      return getCore()?.getVectorTileStates(handle);
+    },
+    vectorRevision: deps.getVectorRevision,
+    getRasterTileStates: (handle) => {
+      return getCore()?.getRasterTileStates(handle);
+    },
+    rasterRevision: deps.getRasterRevision,
+    reportDrapeGpuBytes: (handle, bytes) => {
+      getCore()?.reportTerrainDrapeGpuBytes(handle, bytes);
+    },
+    calcMetersPerTexel: (tileHandle, textureZoom, textureWidth) => {
+      return (
+        getCore()?.calcMetersPerTexel(tileHandle, textureZoom, textureWidth) ??
+        1.0
+      );
+    },
+    mercatorY,
+  };
+}