leaflet-city-mapper 0.0.8 → 0.1.0

package/src/globals/cogTags.js

@@ -1 +1,6 @@
+/**
+ * TIFF tag identifiers read from COG image directories.
+ *
+ * @type {Array<number>}
+ */
 export const cogTags = [256, 257, 258, 259, 262, 277, 284, 317, 322, 323, 324, 325, 339, 33550, 33922, 34735];

package/src/globals/colorLayout.js

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

package/src/globals/colorTexture.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable multisampled color texture descriptor for renderer resizing.
+ *
+ * @type {Object}
+ */
 export const colorTexture = {
   size: [null, null],
   format: null,

package/src/globals/coreEventTypes.js

@@ -1,3 +1,8 @@
+/**
+ * Mouse and pointer event types eligible for native GPU hit testing.
+ *
+ * @type {Set<string>}
+ */
 export const coreEventTypes = new Set([
   'click', 'preclick', 'dblclick', 'contextmenu', 'mousedown', 'mouseup', 'mousemove', 'mouseover', 'mouseout',
   'pointerdown', 'pointerup', 'pointermove', 'pointerover', 'pointerout',

package/src/globals/coreMatrixKeys.js

@@ -1,3 +1,8 @@
+/**
+ * DOMMatrix component names in matrix storage order.
+ *
+ * @type {ReadonlyArray<string>}
+ */
 export const coreMatrixKeys = Object.freeze([
   'm11', 'm12', 'm13', 'm14', 'm21', 'm22', 'm23', 'm24',
   'm31', 'm32', 'm33', 'm34', 'm41', 'm42', 'm43', 'm44',

package/src/globals/coreQuadIndices.js

@@ -1 +1,6 @@
+/**
+ * Triangle vertex order for a four-corner textured quad.
+ *
+ * @type {ReadonlyArray<number>}
+ */
 export const coreQuadIndices = Object.freeze([0, 2, 1, 1, 2, 3]);

package/src/globals/coreQuadUV.js

@@ -1 +1,6 @@
+/**
+ * Texture coordinates for the four corners of a quad.
+ *
+ * @type {ReadonlyArray<number>}
+ */
 export const coreQuadUV = Object.freeze([0, 0, 1, 0, 0, 1, 1, 1]);

package/src/globals/coreSampler.js

@@ -1,3 +1,8 @@
+/**
+ * Linear filtering options for native image textures.
+ *
+ * @type {Object}
+ */
 export const coreSampler = Object.freeze({
   minFilter: 'linear',
   magFilter: 'linear'

package/src/globals/coreWhite.js

@@ -1 +1,6 @@
+/**
+ * White RGB color used for textured native meshes.
+ *
+ * @type {ReadonlyArray<number>}
+ */
 export const coreWhite = Object.freeze([1, 1, 1]);

package/src/globals/cosObliquity.js

@@ -1,3 +1,8 @@
 import { radians } from './radians.js';
 
+/**
+ * Cosine of Earth's axial obliquity used in celestial position calculations.
+ *
+ * @type {number}
+ */
 export const cosObliquity = Math.cos(23.4397 * radians);

package/src/globals/coverageTiles.js

@@ -1 +1,6 @@
+/**
+ * Reusable raster tile coverage map for selecting visible tiles.
+ *
+ * @type {Map}
+ */
 export const coverageTiles = new Map();

package/src/globals/dark.js

@@ -1 +1,6 @@
+/**
+ * Dark RGB color used in vehicle model parts.
+ *
+ * @type {Array<number>}
+ */
 export const dark = [0.08, 0.07, 0.06];

package/src/globals/defaultMaterial.js

@@ -1 +1,6 @@
+/**
+ * Immutable empty material options used when no material is supplied.
+ *
+ * @type {Object}
+ */
 export const defaultMaterial = Object.freeze({});

package/src/globals/degrees.js

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

package/src/globals/demBuffer.js

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

package/src/globals/demLayout.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable data layout descriptor for uploading elevation textures.
+ *
+ * @type {Object}
+ */
 export const demLayout = {
   bytesPerRow: null
 };

package/src/globals/demSize.js

@@ -1 +1,6 @@
+/**
+ * Reusable extent for elevation texture uploads.
+ *
+ * @type {Array<number|null>}
+ */
 export const demSize = [null, null];

package/src/globals/demTarget.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable destination descriptor for elevation texture uploads.
+ *
+ * @type {Object}
+ */
 export const demTarget = {
   texture: null
 };

package/src/globals/demTexture.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable single-channel float texture descriptor for elevation data.
+ *
+ * @type {Object}
+ */
 export const demTexture = {
   size: [null, null],
   format: 'r32float',

package/src/globals/depthBindGroup.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group descriptor for the shadow depth uniform buffer.
+ *
+ * @type {Object}
+ */
 export const depthBindGroup = {
   layout: null,
   entries: [{

package/src/globals/depthTexture.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable multisampled depth texture descriptor for renderer resizing.
+ *
+ * @type {Object}
+ */
 export const depthTexture = {
   size: [null, null],
   format: 'depth24plus',

package/src/globals/directoryReader.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable byte cursor for decoding archive directories.
+ *
+ * @type {Object}
+ */
 export const directoryReader = {
   bytes: null,
   cursor: 0

package/src/globals/disabledShadow.js

@@ -1 +1,6 @@
+/**
+ * Shadow uniform data used when sunlight shadows are disabled.
+ *
+ * @type {Float32Array}
+ */
 export const disabledShadow = new Float32Array([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0]);

package/src/globals/drawEntries.js

@@ -1 +1,6 @@
+/**
+ * Reusable bind group entries assembled when binding mesh textures.
+ *
+ * @type {Array}
+ */
 export const drawEntries = [];

package/src/globals/drawFrameEntry.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group entry for the frame uniform buffer.
+ *
+ * @type {Object}
+ */
 export const drawFrameEntry = {
   binding: 1,
   resource: {

package/src/globals/drawMeshEntry.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group entry for the mesh uniform buffer.
+ *
+ * @type {Object}
+ */
 export const drawMeshEntry = {
   binding: 0,
   resource: {

package/src/globals/drawSamplerEntries.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable sampler bind group entries for mesh textures.
+ *
+ * @type {Array<Object>}
+ */
 export const drawSamplerEntries = [{
     binding: null,
     resource: null

package/src/globals/drawTerrainEntry.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable bind group entry for a terrain elevation texture view.
+ *
+ * @type {Object}
+ */
 export const drawTerrainEntry = {
   binding: 2,
   resource: null

package/src/globals/drawTextureEntries.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable texture view bind group entries for mesh materials.
+ *
+ * @type {Array<Object>}
+ */
 export const drawTextureEntries = [{
     binding: null,
     resource: null

package/src/globals/earthCirc.js

@@ -1 +1,6 @@
+/**
+ * Equatorial circumference in meters using the Web Mercator Earth radius.
+ *
+ * @type {number}
+ */
 export const earthCirc = 2 * Math.PI * 6378137;

package/src/globals/elevationWGSL.js

@@ -1,6 +1,8 @@
 /**
  * WGSL twin of getElevation for the vertex shader: bilinear DEM pixels, or the first valid
  * neighbour near no-data (stored as -1e9), else `base`. Expects `dem: texture_2d<f32>`.
+ *
+ * @type {string}
  */
 export const elevationWGSL = /* wgsl */`
   fn demSample(pixel: vec2<i32>) -> f32 {

package/src/globals/fragmentShader.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable shader module descriptor for material fragment code.
+ *
+ * @type {Object}
+ */
 export const fragmentShader = {
   code: null
 };

package/src/globals/frameBuffer.js

@@ -1,3 +1,8 @@
+/**
+ * Reusable GPU uniform buffer descriptor for frame rendering.
+ *
+ * @type {Object}
+ */
 export const frameBuffer = {
   size: null,
   usage: null

package/src/globals/frameCommands.js

@@ -1 +1,6 @@
+/**
+ * Reusable command buffer list for a rendered frame submission.
+ *
+ * @type {Array}
+ */
 export const frameCommands = [null];

package/src/globals/frameLayoutEntry.js

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

package/src/globals/geometryDecoder.js

@@ -1 +1,6 @@
+/**
+ * Reusable text decoder for model data.
+ *
+ * @type {TextDecoder}
+ */
 export const geometryDecoder = new TextDecoder();

package/src/globals/geometryEmpty.js

@@ -1 +1,6 @@
+/**
+ * Shared empty list for optional model, geometry and scene collections.
+ *
+ * @type {Array}
+ */
 export const geometryEmpty = [];

package/src/globals/geometryImageOptions.js

@@ -1,3 +1,8 @@
+/**
+ * Model image decoding options preserving unpremultiplied and unconverted colors.
+ *
+ * @type {Object}
+ */
 export const geometryImageOptions = {
   premultiplyAlpha: 'none',
   colorSpaceConversion: 'none'

package/src/globals/geometryPixelStates.js

@@ -1 +1,6 @@
+/**
+ * Stack of native vector projection states used during geometry generation.
+ *
+ * @type {Array<Object>}
+ */
 export const geometryPixelStates = [];

package/src/globals/geometryQuaternion.js

@@ -1 +1,6 @@
+/**
+ * Identity quaternion used for model nodes without rotation.
+ *
+ * @type {Array<number>}
+ */
 export const geometryQuaternion = [0, 0, 0, 1];

package/src/globals/geometryScale.js

@@ -1 +1,6 @@
+/**
+ * Unit scale used for model nodes without a scale.
+ *
+ * @type {Array<number>}
+ */
 export const geometryScale = [1, 1, 1];

package/src/globals/geometrySemantics.js

@@ -1,3 +1,8 @@
+/**
+ * Mapping from glTF attribute semantics to internal geometry attribute names.
+ *
+ * @type {Array<Array<string>>}
+ */
 export const geometrySemantics = [
   ['POSITION', 'position'],
   ['NORMAL', 'normal'],

package/src/globals/geometryTranslation.js

@@ -1 +1,6 @@
+/**
+ * Zero translation used for model nodes without a translation.
+ *
+ * @type {Array<number>}
+ */
 export const geometryTranslation = [0, 0, 0];

package/src/globals/geometryWorkerUrl.js

@@ -1,3 +1,8 @@
+/**
+ * Default URL of the geometry worker for module and bundled builds.
+ *
+ * @type {string}
+ */
 export const geometryWorkerUrl = import.meta?.url
   ? new URL('../workers/geometryWorker.js', import.meta.url).href
   : new URL('leaflet-city-mapper-worker.js', document.currentScript?.src || document.baseURI).href;

package/src/globals/glass.js

@@ -1 +1,6 @@
+/**
+ * Dark glass RGB color used in vehicle models.
+ *
+ * @type {Array<number>}
+ */
 export const glass = [0.12, 0.15, 0.18];

package/src/globals/gridEvents.js

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

package/src/globals/gridFadeFrame.js

@@ -1 +1,6 @@
+/**
+ * Mutable holder for the shared grid fade animation frame.
+ *
+ * @type {{value: number|null}}
+ */
 export const gridFadeFrame = { value: null };

package/src/globals/halfRadians.js

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

package/src/globals/headerBounds.js

@@ -1 +1,6 @@
+/**
+ * Archive header bounds field names in encoded order.
+ *
+ * @type {Array<string>}
+ */
 export const headerBounds = ['minLon', 'minLat', 'maxLon', 'maxLat'];

package/src/globals/headerFlags.js

@@ -1 +1,6 @@
+/**
+ * Archive header byte field names in encoded order.
+ *
+ * @type {Array<string>}
+ */
 export const headerFlags = ['clustered', 'internalCompression', 'tileCompression', 'tileType', 'minZoom', 'maxZoom'];

package/src/globals/headerOffsets.js

@@ -1,3 +1,8 @@
+/**
+ * Archive header offset, length and tile count field names in encoded order.
+ *
+ * @type {Array<string>}
+ */
 export const headerOffsets = [
   'rootDirectoryOffset', 'rootDirectoryLength', 'jsonMetadataOffset', 'jsonMetadataLength',
   'leafDirectoryOffset', 'leafDirectoryLength', 'tileDataOffset', 'tileDataLength',

package/src/globals/headlight.js

@@ -1 +1,6 @@
+/**
+ * Bright RGB color used for vehicle headlights.
+ *
+ * @type {Array<number>}
+ */
 export const headlight = [1.9, 1.85, 1.7];

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,3 +1,8 @@
+/**
+ * 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) },

package/src/globals/layerControlAddItem.js

@@ -1,3 +1,8 @@
 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';
 
+/**
+ * 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 @@
+/**
+ * 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: {