leaflet-city-mapper 0.0.9 → 0.1.1

package/src/globals/hull.js

@@ -1,3 +1,8 @@
+/**
+ * Boat hull footprint used to construct the vessel model.
+ *
+ * @type {Array<Array<number>>}
+ */
 export const hull = [
   [-5.5, 30],
   [5.5, 30],

package/src/globals/instanceLayout.js

@@ -1,3 +1,8 @@
+/**
+ * WebGPU vertex layout for four-component per-instance offsets.
+ *
+ * @type {Object}
+ */
 export const instanceLayout = Object.freeze({
   arrayStride: 16,
   stepMode: 'instance',

package/src/globals/lampDirections.js

@@ -1,8 +1,13 @@
-export const lampDirections = [
-  { x: Math.cos(0 * Math.PI / 3), y: Math.sin(0 * Math.PI / 3), nx: Math.cos(0.5 * Math.PI / 3), nz: -Math.sin(0.5 * Math.PI / 3) },
-  { x: Math.cos(1 * Math.PI / 3), y: Math.sin(1 * Math.PI / 3), nx: Math.cos(1.5 * Math.PI / 3), nz: -Math.sin(1.5 * Math.PI / 3) },
-  { x: Math.cos(2 * Math.PI / 3), y: Math.sin(2 * Math.PI / 3), nx: Math.cos(2.5 * Math.PI / 3), nz: -Math.sin(2.5 * Math.PI / 3) },
-  { x: Math.cos(3 * Math.PI / 3), y: Math.sin(3 * Math.PI / 3), nx: Math.cos(3.5 * Math.PI / 3), nz: -Math.sin(3.5 * Math.PI / 3) },
-  { x: Math.cos(4 * Math.PI / 3), y: Math.sin(4 * Math.PI / 3), nx: Math.cos(4.5 * Math.PI / 3), nz: -Math.sin(4.5 * Math.PI / 3) },
-  { x: Math.cos(5 * Math.PI / 3), y: Math.sin(5 * Math.PI / 3), nx: Math.cos(5.5 * Math.PI / 3), nz: -Math.sin(5.5 * Math.PI / 3) },
-];
+/**
+ * Ring vertex directions and face normals for lamp geometry.
+ *
+ * @type {Array<Object>}
+ */
+export const lampDirections = [
+  { x: Math.cos(0 * Math.PI / 3), y: Math.sin(0 * Math.PI / 3), nx: Math.cos(0.5 * Math.PI / 3), nz: -Math.sin(0.5 * Math.PI / 3) },
+  { x: Math.cos(1 * Math.PI / 3), y: Math.sin(1 * Math.PI / 3), nx: Math.cos(1.5 * Math.PI / 3), nz: -Math.sin(1.5 * Math.PI / 3) },
+  { x: Math.cos(2 * Math.PI / 3), y: Math.sin(2 * Math.PI / 3), nx: Math.cos(2.5 * Math.PI / 3), nz: -Math.sin(2.5 * Math.PI / 3) },
+  { x: Math.cos(3 * Math.PI / 3), y: Math.sin(3 * Math.PI / 3), nx: Math.cos(3.5 * Math.PI / 3), nz: -Math.sin(3.5 * Math.PI / 3) },
+  { x: Math.cos(4 * Math.PI / 3), y: Math.sin(4 * Math.PI / 3), nx: Math.cos(4.5 * Math.PI / 3), nz: -Math.sin(4.5 * Math.PI / 3) },
+  { x: Math.cos(5 * Math.PI / 3), y: Math.sin(5 * Math.PI / 3), nx: Math.cos(5.5 * Math.PI / 3), nz: -Math.sin(5.5 * Math.PI / 3) },
+];

package/src/globals/layerControlAddItem.js

@@ -1,3 +1,8 @@
-import { L } from './L.js';
-
-export const layerControlAddItem = L?.LayersControl?.prototype._addItem;
+import { L } from './L.js';
+
+/**
+ * Original Leaflet layers control item builder, when available.
+ *
+ * @type {Function|undefined}
+ */
+export const layerControlAddItem = L?.LayersControl?.prototype._addItem;

package/src/globals/layerProto.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for the original Leaflet layer prototype methods.
+ *
+ * @type {{value: Object|undefined}}
+ */
 export const layerProto = { value: undefined };

package/src/globals/leafletLayer.js

@@ -1,3 +1,8 @@
-import { L } from './L.js';
-
-export const leafletLayer = L?.Layer;
+import { L } from './L.js';
+
+/**
+ * Original Leaflet Layer constructor before its contract is extended.
+ *
+ * @type {Function|undefined}
+ */
+export const leafletLayer = L?.Layer;

package/src/globals/lightScale.js

@@ -1 +1,6 @@
-export const lightScale = 0.03 / (4 * Math.PI);
+/**
+ * Scale converting point light flux to renderer intensity.
+ *
+ * @type {number}
+ */
+export const lightScale = 0.03 / (4 * Math.PI);

package/src/globals/limbs.js

@@ -1,4 +1,8 @@
-// [part, pivot x, pivot y, swing sign]
+/**
+ * Walker part names, pivot coordinates and swing signs.
+ *
+ * @type {Array<Array>}
+ */
 export const limbs = [
   ['body', 0, 0, 0],
   ['leg', -0.09, 0.9, 1],

package/src/globals/loading.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for the serialized layer initialization chain.
+ *
+ * @type {{value: Promise}}
+ */
 export const loading = { value: Promise.resolve() };

package/src/globals/mapMethods.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for original Leaflet map prototype methods.
+ *
+ * @type {{value: Object|undefined}}
+ */
 export const mapMethods = { value: undefined };

package/src/globals/markerMethods.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for original Leaflet marker prototype methods.
+ *
+ * @type {{value: Object|undefined}}
+ */
 export const markerMethods = { value: undefined };

package/src/globals/markerPanFrame.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for the scheduled marker autopan frame.
+ *
+ * @type {{value: number|null}}
+ */
 export const markerPanFrame = { value: null };

package/src/globals/meshBindGroup.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable GPU bind group descriptor for mesh resources.
+ *
+ * @type {Object}
+ */
 export const meshBindGroup = {
   layout: null,
   entries: null

package/src/globals/meshBuffer.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable GPU vertex buffer descriptor for mesh geometry.
+ *
+ * @type {Object}
+ */
 export const meshBuffer = {
   size: null,
   usage: null

package/src/globals/meshCopySize.js

@@ -1 +1,6 @@
+/**
+ * Reusable width and height for mesh image texture copies.
+ *
+ * @type {Array<number|null>}
+ */
 export const meshCopySize = [null, null];

package/src/globals/meshImage.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable source descriptor for mesh image texture copies.
+ *
+ * @type {Object}
+ */
 export const meshImage = {
   source: null,
   flipY: null

package/src/globals/meshLayoutEntry.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group layout entry for dynamically offset mesh uniforms.
+ *
+ * @type {Object}
+ */
 export const meshLayoutEntry = {
   binding: 0,
   visibility: null,

package/src/globals/meshOffsets.js

@@ -1 +1,6 @@
+/**
+ * Reusable dynamic uniform buffer offset list for mesh drawing.
+ *
+ * @type {Array<number|null>}
+ */
 export const meshOffsets = [null];

package/src/globals/meshPipeline.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable WebGPU render pipeline descriptor for scene meshes.
+ *
+ * @type {Object}
+ */
 export const meshPipeline = {
   layout: null,
   vertex: {

package/src/globals/meshStack.js

@@ -1,3 +1,8 @@
+/**
+ * Animation query options including descendants of the map container.
+ *
+ * @type {Object}
+ */
 export const meshStack = {
   subtree: true
 };

package/src/globals/meshTarget.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable destination descriptor for mesh image texture copies.
+ *
+ * @type {Object}
+ */
 export const meshTarget = {
   texture: null
 };

package/src/globals/moves.js

@@ -1,4 +1,8 @@
-// W/S (↑/↓) run forward/back along the heading, A/D (←/→) turn: [forward, turn].
+/**
+ * Walking key bindings as forward and turn multipliers: W/S move and A/D turn.
+ *
+ * @type {Object<string, Array<number>>}
+ */
 export const moves = {
   KeyW: [1, 0],
   ArrowUp: [1, 0],

package/src/globals/mvtTextDecoder.js

@@ -1 +1,6 @@
-export const mvtTextDecoder = new TextDecoder('utf-8', { fatal: true });
+/**
+ * Strict UTF-8 decoder used for vector tile strings.
+ *
+ * @type {TextDecoder}
+ */
+export const mvtTextDecoder = new TextDecoder('utf-8', { fatal: true });

package/src/globals/nativeMethodHandlers.js

@@ -13,6 +13,11 @@ import { nativeSetZIndexOffset } from '../native/nativeSetZIndexOffset.js';
 import { nativeBringToFront } from '../native/nativeBringToFront.js';
 import { nativeBringToBack } from '../native/nativeBringToBack.js';
 
+/**
+ * Native layer method wrappers indexed by the Leaflet method they replace.
+ *
+ * @type {Object<string, Function>}
+ */
 export const nativeMethodHandlers = {
   setLatLng: nativeSetLatLng,
   setLatLngs: nativeSetLatLngs,

package/src/globals/nativeScalableStyleKeys.js

@@ -1 +1,6 @@
-export const nativeScalableStyleKeys = new Set(['color', 'opacity', 'weight', 'fillColor', 'fillOpacity']);
+/**
+ * Native style properties that can be updated without rebuilding geometry.
+ *
+ * @type {Set<string>}
+ */
+export const nativeScalableStyleKeys = new Set(['color', 'opacity', 'weight', 'fillColor', 'fillOpacity']);

package/src/globals/nextId.js

@@ -1 +1,6 @@
+/**
+ * Mutable counter supplying scene object identifiers.
+ *
+ * @type {{value: number}}
+ */
 export const nextId = { value: 0 };

package/src/globals/normalLayout.js

@@ -1,3 +1,8 @@
+/**
+ * WebGPU vertex buffer layout for three-component normals.
+ *
+ * @type {Object}
+ */
 export const normalLayout = Object.freeze({
   arrayStride: 12,
   attributes: Object.freeze([Object.freeze({

package/src/globals/paints.js

@@ -1,5 +1,10 @@
 // Built-in vehicles for the 'traffic' type. Models are [ring of [x, z], bottom, top, rgb, topRing?] convex prisms in metres;
 // forward is -z, right is +x. `topRing` (same length as `ring`) tapers the prism; rgb components above 1 are self-lit lamps.
+/**
+ * RGB paint colors used by built-in vehicle and pedestrian models.
+ *
+ * @type {Array<Array<number>>}
+ */
 export const paints = [
   [0.86, 0.86, 0.88],
   [0.1, 0.1, 0.12],

package/src/globals/parts.js

@@ -4,6 +4,11 @@ import { shirt as sharedShirt } from './shirt.js';
 import { skin as sharedSkin } from './skin.js';
 import { dark as sharedDark } from './dark.js';
 
+/**
+ * Extruded body, leg and arm parts shared by walker and pedestrian models.
+ *
+ * @type {Object<string, Array>}
+ */
 export const parts = {
   body: [
     [box(-0.17, 0.17, -0.1, 0.1), 0.82, 0.95, sharedTrousers],

package/src/globals/pendingGridFades.js

@@ -1 +1,6 @@
+/**
+ * Pending grid fade revisions keyed by layer.
+ *
+ * @type {Map<Object, number>}
+ */
 export const pendingGridFades = new Map();

package/src/globals/pendingInitializations.js

@@ -1 +1,6 @@
+/**
+ * Layer initialization jobs waiting for serialized execution.
+ *
+ * @type {Array}
+ */
 export const pendingInitializations = [];

package/src/globals/pendingMapChanges.js

@@ -1 +1,6 @@
+/**
+ * Queued layers awaiting map change processing.
+ *
+ * @type {Array<Object>}
+ */
 export const pendingMapChanges = [];

package/src/globals/pendingMarkerPan.js

@@ -1 +1,6 @@
+/**
+ * Pending marker autopan events keyed by drag handler.
+ *
+ * @type {Map<Object, Object>}
+ */
 export const pendingMarkerPan = new Map();

package/src/globals/pendingPlacements.js

@@ -1 +1,6 @@
+/**
+ * Queued layer-control placement states.
+ *
+ * @type {Array<Object>}
+ */
 export const pendingPlacements = [];

package/src/globals/pendingRasterLoads.js

@@ -1 +1,6 @@
+/**
+ * Raster layers waiting to emit a load event.
+ *
+ * @type {Array<Object>}
+ */
 export const pendingRasterLoads = [];

package/src/globals/pendingUpdates.js

@@ -1 +1,6 @@
+/**
+ * Shared scene owners awaiting a render update.
+ *
+ * @type {Set<Object>}
+ */
 export const pendingUpdates = new Set();

package/src/globals/pendingZoomAnimations.js

@@ -1 +1,6 @@
+/**
+ * Layers waiting for zoom animation rendering.
+ *
+ * @type {Array<Object>}
+ */
 export const pendingZoomAnimations = [];

package/src/globals/pipelineLayout.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable GPU pipeline layout descriptor for material bind group layouts.
+ *
+ * @type {Object}
+ */
 export const pipelineLayout = {
   bindGroupLayouts: [null, null]
 };

package/src/globals/popupEvents.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for Leaflet's original popup event method.
+ *
+ * @type {{value: Function|undefined}}
+ */
 export const popupEvents = { value: undefined };

package/src/globals/popupPan.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for Leaflet's original popup autopan method.
+ *
+ * @type {{value: Function|undefined}}
+ */
 export const popupPan = { value: undefined };

package/src/globals/popupPosition.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for Leaflet's original popup position update method.
+ *
+ * @type {{value: Function|undefined}}
+ */
 export const popupPosition = { value: undefined };

package/src/globals/positionLayout.js

@@ -1,3 +1,8 @@
+/**
+ * WebGPU vertex buffer layout for three-component positions.
+ *
+ * @type {Object}
+ */
 export const positionLayout = Object.freeze({
   arrayStride: 12,
   attributes: Object.freeze([Object.freeze({

package/src/globals/programEntries.js

@@ -1 +1,6 @@
+/**
+ * Reusable bind group layout entry list for material programs.
+ *
+ * @type {Array}
+ */
 export const programEntries = [];

package/src/globals/programLayout.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group layout descriptor for material programs.
+ *
+ * @type {Object}
+ */
 export const programLayout = {
   entries: null
 };

package/src/globals/radians.js

@@ -1 +1,6 @@
+/**
+ * Conversion factor from degrees to radians.
+ *
+ * @type {number}
+ */
 export const radians = Math.PI / 180;

package/src/globals/rasterBuffer.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable GPU buffer descriptor for raster quad geometry.
+ *
+ * @type {Object}
+ */
 export const rasterBuffer = {
   size: null,
   usage: null

package/src/globals/rasterIndices.js

@@ -1 +1,6 @@
+/**
+ * Triangle indices for raster quad geometry.
+ *
+ * @type {Array<number>}
+ */
 export const rasterIndices = [0, 2, 1, 1, 2, 3];

package/src/globals/rasterNormals.js

@@ -1 +1,6 @@
+/**
+ * Upward vertex normals for raster quad geometry.
+ *
+ * @type {Array<number>}
+ */
 export const rasterNormals = [0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0];

package/src/globals/rasterPoint.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable projected point for raster tile placement.
+ *
+ * @type {{x: number, y: number}}
+ */
 export const rasterPoint = {
   x: 0,
   y: 0

package/src/globals/rasterPositions.js

@@ -1 +1,6 @@
+/**
+ * Unit raster quad vertex positions in the horizontal plane.
+ *
+ * @type {Array<number>}
+ */
 export const rasterPositions = [0, 0, 0, 1, 0, 0, 0, 0, 1, 1, 0, 1];

package/src/globals/rasterSampler.js

@@ -1,3 +1,8 @@
+/**
+ * Linear, clamp-to-edge sampling options for raster textures.
+ *
+ * @type {Object}
+ */
 export const rasterSampler = {
   addressModeU: 'clamp-to-edge',
   addressModeV: 'clamp-to-edge',

package/src/globals/rasterTexture.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable RGBA texture descriptor for raster tile images.
+ *
+ * @type {Object}
+ */
 export const rasterTexture = {
   size: [null, null],
   format: 'rgba8unorm',

package/src/globals/rasterUVs.js

@@ -1 +1,6 @@
+/**
+ * Texture coordinates for raster quad vertices.
+ *
+ * @type {Array<number>}
+ */
 export const rasterUVs = [0, 0, 1, 0, 0, 1, 1, 1];

package/src/globals/removeLayer.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for Leaflet's original map removeLayer method.
+ *
+ * @type {{value: Function|undefined}}
+ */
 export const removeLayer = { value: undefined };

package/src/globals/renderEmpty.js

@@ -1 +1,6 @@
+/**
+ * Immutable empty list for optional rendering and terrain collections.
+ *
+ * @type {ReadonlyArray}
+ */
 export const renderEmpty = Object.freeze([]);

package/src/globals/ringDirections.js

@@ -1,3 +1,8 @@
+/**
+ * Octagonal ring directions and face normals used for tree geometry.
+ *
+ * @type {Array<Object>}
+ */
 export const ringDirections = [{
     x: Math.cos(0 * Math.PI / 4),
     y: Math.sin(0 * Math.PI / 4),

package/src/globals/roofBindGroup.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group descriptor for compositing roof raster tiles.
+ *
+ * @type {Object}
+ */
 export const roofBindGroup = {
   layout: null,
   entries: [{

package/src/globals/roofBlitSampler.js

@@ -1,3 +1,8 @@
+/**
+ * Linear sampler options for compositing roof raster tiles.
+ *
+ * @type {Object}
+ */
 export const roofBlitSampler = {
   magFilter: 'linear',
   minFilter: 'linear'

package/src/globals/roofBuffer.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable uniform buffer descriptor for roof tile opacities.
+ *
+ * @type {Object}
+ */
 export const roofBuffer = {
   size: null,
   usage: null

package/src/globals/roofCommands.js

@@ -1 +1,6 @@
+/**
+ * Reusable command buffer list for roof atlas composition.
+ *
+ * @type {Array}
+ */
 export const roofCommands = [null];

package/src/globals/roofCopySize.js

@@ -1 +1,6 @@
+/**
+ * Reusable image copy extent for roof raster tiles.
+ *
+ * @type {Array<number|null>}
+ */
 export const roofCopySize = [null, null];

package/src/globals/roofImage.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable image copy source descriptor for roof raster tiles.
+ *
+ * @type {Object}
+ */
 export const roofImage = {
   source: null
 };

package/src/globals/roofMin.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable minimum projected coordinate for roof atlas bounds.
+ *
+ * @type {{x: number, y: number}}
+ */
 export const roofMin = {
   x: 0,
   y: 0

package/src/globals/roofOpacities.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for the roof atlas tile opacity upload buffer.
+ *
+ * @type {{value: Float32Array}}
+ */
 export const roofOpacities = { value: new Float32Array(64) };

package/src/globals/roofPass.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable render pass descriptor for composing the roof atlas.
+ *
+ * @type {Object}
+ */
 export const roofPass = {
   colorAttachments: [{
     view: null,

package/src/globals/roofPipeline.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable pipeline descriptor for alpha-blended roof tile composition.
+ *
+ * @type {Object}
+ */
 export const roofPipeline = {
   layout: 'auto',
   vertex: {

package/src/globals/roofSampler.js

@@ -1,3 +1,8 @@
+/**
+ * Clamp-to-edge sampling options for the roof raster atlas.
+ *
+ * @type {Object}
+ */
 export const roofSampler = {
   addressModeU: 'clamp-to-edge',
   addressModeV: 'clamp-to-edge'