leaflet-city-mapper 0.0.1 → 0.0.3

package/README.md

@@ -1,9 +1,9 @@
 # leaflet-city-mapper
 
-[![NPM version](https://img.shields.io/npm/v/leaflet-city-builder.svg?color=red)](https://www.npmjs.com/package/leaflet-city-builder)
+[![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, 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 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>
@@ -13,17 +13,17 @@ _For a working example see one of the following demos:_
 
 - [City of Paris in 3D](https://raruto.github.io/leaflet-city-mapper/examples/leaflet-city-mapper.html)
 - [Ancient Rome in 3D](https://raruto.github.io/leaflet-city-mapper/examples/leaflet-city-mapper-geojson.html)
+- [Native Leaflet layers on WebGPU](https://raruto.github.io/leaflet-city-mapper/examples/leaflet-city-mapper-native.html)
 
 ## How to use
 
-Load leaflet and leaflet-rotate first, then this plugin:
+Load Leaflet (the only runtime dependency), then 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-rotate@0.5.3/dist/leaflet-rotate.js"></script>
-<script src="https://unpkg.com/leaflet-city-mapper@0.0.1/dist/leaflet-city-mapper.js"></script>
+<script src="https://unpkg.com/leaflet-city-mapper@0.0.3/dist/leaflet-city-mapper.js"></script>
 ```
 And then set an approriate `source` param to layer constructor:
 
@@ -37,15 +37,30 @@ const buildings = new L.Layer({
   source: {
     type: 'geojson',
     url: GeoJSON,
-    featureStyle: ({ properties }) => ({ top: properties.height, color: properties.color }),
-    tooltipContent: ({ properties }) => `${properties.name}: ${properties.height} m`,
+    style: ({ properties }) => ({ top: properties.height, color: properties.color }),
+    tooltip: ({ properties }) => `${properties.name}: ${properties.height} m`,
   },
 }).addTo(map);
 ```
 
-After that, the [`dist/types/geojson.js`](./src/types/geojson.js) will be dynamically imported into the page and a 3D layer should appear onto the 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/`.
 
-For further customization, you can define custom [`types`](./src/types/geojson.js): just upload them to the same folder and they will be loaded automatically.
+Raster imagery blends coarse-to-fine on the terrain, retaining depth occlusion for 3D objects.
+
+### Time and walk controls
+
+```js
+const time = new L.Control.Time({ position: 'bottomright' });
+new L.Control.Layers({}, { Shadows: time.layer.addTo(map) }).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
 
@@ -54,15 +69,19 @@ The Paris example makes extensive use of [PMTiles](./build/pmtiles.js) to ensure
 ```shell
 npm run pmtiles
 node build/pmtiles.js --only=trees
+node build/pmtiles.js --jobs=6
+
 ```
 
+All 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
 
 Within your local development environment:
 
 ```shell
-git clone git@github.com:Raruto/leaflet-city-builder.git
-cd ./leaflet-city-builder
+git clone git@github.com:Raruto/leaflet-city-mapper.git
+cd ./leaflet-city-mapper
 
 npm i         # install dependencies
 npm run dev   # start dev server at: http://localhost:8080
@@ -70,8 +89,37 @@ npm run build # generate "dist" files (once)
 npm run test  # build and run browser tests
 ```
 
-After that you can start developing inside the `src` and `test` folders (eg. open "http://localhost:8080" in your browser to preview changes).
-
+After that you can start developing inside the `src` folder (eg. open "http://localhost:8080/examples" in your browser to preview changes).
+
+### Source layout
+
+```text
+src/
+  index.js           Public entry point and source registration
+  constants/         Exported module-level const bindings
+  camera/            Camera API, projection and animation
+  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
+  picking/           Raycasting, highlighting and feature interaction
+  rendering/         Frame stages, roof atlases, pipelines, meshes and textures
+  shadows/           Directional shadow maps, bounds and cache
+  lighting/          Point lights and spatial light grids
+  shaders/           Material shader generation
+  geometry/          Trees, lights, bridges, primitives and Leaflet vector geometry
+  triangulation/     Polygon triangulation and ring operations
+  collision/         Mesh intersection and collision queries
+  models/            glTF loading, decoding and materials
+  archives/          PMTiles archive reading and decompression
+  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
+  walk/              First-person walking
+  utils/             Shared colour and numeric helpers
+```
 
 **Compatibile with:**
 [![Leaflet 1.9.4 compatible!](https://img.shields.io/badge/Leaflet-1.9.4-1EB300.svg?style=flat)](http://leafletjs.com/reference.html) [![Leaflet 2.x compatible!](https://img.shields.io/badge/Leaflet-2.0.0--alpha.1-1EB300.svg?style=flat)](http://leafletjs.com/reference.html)

package/cucumber.mjs

@@ -1,5 +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,
 };