leaflet-city-mapper 0.0.2 → 0.0.4

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>
@@ -13,50 +13,62 @@ _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/examples/leaflet-city-mapper-native.html)
+- [Native Leaflet layers on WebGPU](https://raruto.github.io/leaflet-city-mapper/examples/leaflet-city-mapper-native.html)
 
 ## 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.2/dist/leaflet-city-mapper.js"></script>
+<script src="https://unpkg.com/leaflet-city-mapper@0.0.4/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);
 ```
 
-Vector and raster layers are initialized in [`src/index.js`](./src/index.js); their rendering utilities are loaded only when needed. Terrain, sunlight, traffic and walk initializers are also loaded lazily from [`src/utils`](./src/utils).
+### 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' }).layer.addTo(map);
+const walk = new L.Control.Walk({ speed: 6, distance: 20 }).addTo(map);
+```
 
 ### 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
 
@@ -68,12 +80,42 @@ 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
 ```
 
 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
+  globals/           One shared constant or mutable cell per module
+  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
+  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
+  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

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