leaflet-city-mapper 0.0.3 → 0.0.5

package/README.md

@@ -3,7 +3,7 @@
 [![NPM version](https://img.shields.io/npm/v/leaflet-city-mapper.svg?color=red)](https://www.npmjs.com/package/leaflet-city-mapper)
 [![License](https://img.shields.io/badge/license-GPL%203-blue.svg?style=flat)](LICENSE)
 
-**Your data, on a rotated and pitched Leaflet map:** a small 3D rendering engine (WebGPU) packaged onto standard `L.Layer`. Available sources: extruded GeoJSON, glTF models, raster PMTiles and terrain layers.
+**Your data, on a rotated and pitched Leaflet map:** a small 3D rendering engine (WebGPU) packaged onto standard `L.Layer`. Available sources: extruded GeoJSON, glTF models, raster PMTiles, COG and terrain layers.
 
 <p align="center">
     <a href="https://raruto.github.io/leaflet-city-mapper/examples/leaflet-city-mapper.html"><img src="https://raruto.github.io/img/leaflet-city-mapper.png" alt="Leaflet 3D City Mapper" /></a>
@@ -17,63 +17,58 @@ _For a working example see one of the following demos:_
 
 ## How to use
 
-Load Leaflet (the only runtime dependency), then this plugin:
-
+Just load Leaflet before this plugin:
 
 ```html
 <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9/dist/leaflet.css">
 <script src="https://unpkg.com/leaflet@1.9/dist/leaflet.js"></script>
-<script src="https://unpkg.com/leaflet-city-mapper@0.0.3/dist/leaflet-city-mapper.js"></script>
+<script src="https://unpkg.com/leaflet-city-mapper@0.0.5/dist/leaflet-city-mapper.js"></script>
 ```
-And then set an approriate `source` param to layer constructor:
+
+And then create a native `L.Layer`:
 
 ```js
-new L.Layer({ source: .. })
+new L.Layer({ source: { /* source options */ } })
 ```
-For example, here you can use a `geojson` object, like this:
+For example, here is how you can load a `geojson` object:
 
 ```js
 const buildings = new L.Layer({
   source: {
     type: 'geojson',
-    url: GeoJSON,
+    data: GeoJSON,
     style: ({ properties }) => ({ top: properties.height, color: properties.color }),
     tooltip: ({ properties }) => `${properties.name}: ${properties.height} m`,
+    roofTexture: true,
+    wallTexture: 0.75,
   },
 }).addTo(map);
 ```
 
-The build produces a single self-contained [`dist/leaflet-city-mapper.js`](./dist/leaflet-city-mapper.js) bundle; Leaflet remains an external dependency. Vector/raster and feature initializers run on demand, while shared scene, rendering, geometry, glTF and PMTiles source lives in focused folders under `src/`.
-
-Raster imagery blends coarse-to-fine on the terrain, retaining depth occlusion for 3D objects.
-
 ### Time and walk controls
 
+The walk camera follows vertical ascent and descent as well as horizontal
+movement. Releasing Space lets the walker land on loaded building roofs;
+walking off an edge resumes falling toward the terrain or the next roof below.
+
 ```js
-const time = new L.Control.Time({ position: 'bottomright' });
-new L.Control.Layers({}, { Shadows: time.layer.addTo(map) }).addTo(map);
+const time = new L.Control.Time({ position: 'bottomright' }).layer.addTo(map);
 const walk = new L.Control.Walk({ speed: 6, distance: 20 }).addTo(map);
 ```
 
-Time stays under **Shadows** in the layers control; its checkbox enables/disables
-the clock, sky and shadows together. Use `time.addTo(map)` instead for a standalone
-control. `time.time` and `time.live` expose the selected UTC time and live mode.
-Walk exposes `walk.walker` (`latlng`, `heading`, `phase`); W/S move, A/D turn,
-drag looks around and Esc exits. Both controls support `remove()` and re-adding.
-These replace the former `sunlight` and `walk` layer source types.
-
 ### Update demo data
 
-The Paris example makes extensive use of [PMTiles](./build/pmtiles.js) to ensure offline access / long-term availability of the map. To update them:
+The examples makes extensive use of [PMTiles](./build/pmtiles.js) to ensure offline access / long-term availability of the maps. To update them:
 
 ```shell
 npm run pmtiles
 node build/pmtiles.js --only=trees
+node build/pmtiles.js --only=colosseum
 node build/pmtiles.js --jobs=6
-
+node build/pmtiles.js --self-test
 ```
 
-All archives use the buildings bbox (default: `2.26,48.835,2.38,48.885`). Use `--bbox=west,south,east,north` to override it.
+Paris archives use the buildings bbox (default: `2.26,48.835,2.38,48.885`). Use `--bbox=west,south,east,north` to override it.
 
 ### Build Guide
 
@@ -85,7 +80,7 @@ cd ./leaflet-city-mapper
 
 npm i         # install dependencies
 npm run dev   # start dev server at: http://localhost:8080
-npm run build # generate "dist" files (once)
+npm run build # generate "dist" bundles and minified "libs" files (once)
 npm run test  # build and run browser tests
 ```
 
@@ -96,29 +91,42 @@ After that you can start developing inside the `src` folder (eg. open "http://lo
 ```text
 src/
   index.js           Public entry point and source registration
-  constants/         Exported module-level const bindings
-  camera/            Camera API, projection and animation
+  globals/           One shared constant or mutable cell per module
+  weakmaps/          One private WeakMap per map/layer state field
+  camera/            Leaflet camera API and scene camera state
   controls/          Compass, dragging, touch and resizing
-  core/              Leaflet layer integration, events, mutations and overlays
-  scene/             Source routing, lifecycle, graph nodes and transforms
-  sources/           GeoJSON and streamed source geometry
+  core/              Leaflet hooks, camera-aware overlays and readiness
+  native/            Native Leaflet layers rendered through WebGPU
+  layer-controls/    Layer entry placement and progress indicators
+  scene/             Source routing, lifecycle and graph nodes
+  sources/           GeoJSON and streamed source loading and assembly
+  workers/           Cancellable geometry tasks and worker entry point
   picking/           Raycasting, highlighting and feature interaction
-  rendering/         Frame stages, roof atlases, pipelines, meshes and textures
-  shadows/           Directional shadow maps, bounds and cache
+  rendering/         Frame stages, draw pipelines and mesh lifecycle
+  gpu/               Device initialization, renderer resources and diagnostics
+  materials/         Material programs, uniforms, glTF materials and cutouts
+  textures/          Image loading, texture upload/binding and roof atlases
+  animations/        Camera transitions, zoom synchronization and tile fading
+  shadows/           Directional shadow maps and cache
   lighting/          Point lights and spatial light grids
   shaders/           Material shader generation
-  geometry/          Trees, lights, bridges, primitives and Leaflet vector geometry
+  geometry/          Mesh construction, bounds, grids, vectors and route geometry
+  projections/       Map, screen and local coordinate conversion
+  transforms/        Local/world matrices and glTF node transforms
   triangulation/     Polygon triangulation and ring operations
   collision/         Mesh intersection and collision queries
-  models/            glTF loading, decoding and materials
+  models/            glTF loading, decoding and scene assembly
   archives/          PMTiles archive reading and decompression
+  cog/               Supported GeoTIFF directories, byte ranges and tile decoding
   raster/            Raster tile loading, attachment and lifecycle
   traffic/           Routes, scheduling, simulation, loading and rendering
   vehicles/          Vehicle model geometry
   terrain/           Terrain loading and sampling
-  sunlight/          Sun, moon, sky and time controls
+  astronomy/         Sun/moon position and observer/date validation
+  sunlight/          Sky, celestial display and time controls
   walk/              First-person walking
-  utils/             Shared colour and numeric helpers
+  colors/            Colour parsing, conversion, interpolation and formatting
+  utils/             Shared numeric and no-op helpers
 ```
 
 **Compatibile with:**

package/cucumber.mjs

@@ -1,9 +1,9 @@
-import { availableParallelism } from 'node:os';
-
-export default {
-    paths: ['test/features/**/*.feature'],
-    import: ['test/support/**/*.js', 'test/steps/**/*.js'],
-    format: ['progress'],
-    parallel: 1, // availableParallelism(),
-    failFast: false,
-};
+import { availableParallelism } from 'node:os';
+
+export default {
+    paths: ['test/features/**/*.feature'],
+    import: ['test/fixtures/leaflet.js', 'test/support/**/*.js', 'test/steps/**/*.js'],
+    format: ['progress'],
+    parallel: 1, // availableParallelism(),
+    failFast: false,
+};