@math.gl/web-mercator 3.5.6 → 3.6.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assert.d.ts +2 -0
- package/dist/assert.d.ts.map +1 -0
- package/dist/assert.js +8 -0
- package/dist/es5/assert.js.map +1 -1
- package/dist/es5/fit-bounds.js +33 -37
- package/dist/es5/fit-bounds.js.map +1 -1
- package/dist/es5/fly-to-viewport.js +23 -16
- package/dist/es5/fly-to-viewport.js.map +1 -1
- package/dist/es5/get-bounds.js +1 -1
- package/dist/es5/get-bounds.js.map +1 -1
- package/dist/es5/index.js +6 -0
- package/dist/es5/index.js.map +1 -1
- package/dist/es5/math-utils.js +8 -9
- package/dist/es5/math-utils.js.map +1 -1
- package/dist/es5/normalize-viewport-props.js +10 -10
- package/dist/es5/normalize-viewport-props.js.map +1 -1
- package/dist/es5/web-mercator-utils.js +47 -61
- package/dist/es5/web-mercator-utils.js.map +1 -1
- package/dist/es5/web-mercator-viewport.js +69 -51
- package/dist/es5/web-mercator-viewport.js.map +1 -1
- package/dist/esm/assert.js.map +1 -1
- package/dist/esm/fit-bounds.js +29 -34
- package/dist/esm/fit-bounds.js.map +1 -1
- package/dist/esm/fly-to-viewport.js +13 -9
- package/dist/esm/fly-to-viewport.js.map +1 -1
- package/dist/esm/get-bounds.js +1 -1
- package/dist/esm/get-bounds.js.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/math-utils.js +6 -3
- package/dist/esm/math-utils.js.map +1 -1
- package/dist/esm/normalize-viewport-props.js +13 -9
- package/dist/esm/normalize-viewport-props.js.map +1 -1
- package/dist/esm/web-mercator-utils.js +47 -52
- package/dist/esm/web-mercator-utils.js.map +1 -1
- package/dist/esm/web-mercator-viewport.js +76 -34
- package/dist/esm/web-mercator-viewport.js.map +1 -1
- package/dist/fit-bounds.d.ts +50 -0
- package/dist/fit-bounds.d.ts.map +1 -0
- package/dist/fit-bounds.js +63 -0
- package/dist/fly-to-viewport.d.ts +19 -0
- package/dist/fly-to-viewport.d.ts.map +1 -0
- package/dist/fly-to-viewport.js +87 -0
- package/dist/get-bounds.d.ts +3 -0
- package/dist/get-bounds.d.ts.map +1 -0
- package/dist/get-bounds.js +51 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +8 -0
- package/dist/math-utils.d.ts +7 -0
- package/dist/math-utils.d.ts.map +1 -0
- package/dist/math-utils.js +26 -0
- package/dist/normalize-viewport-props.d.ts +16 -0
- package/dist/normalize-viewport-props.d.ts.map +1 -0
- package/dist/normalize-viewport-props.js +41 -0
- package/dist/{es5/web-mercator-utils.d.ts → web-mercator-utils.d.ts} +78 -94
- package/dist/web-mercator-utils.d.ts.map +1 -0
- package/dist/web-mercator-utils.js +290 -0
- package/dist/web-mercator-viewport.d.ts +182 -0
- package/dist/web-mercator-viewport.d.ts.map +1 -0
- package/dist/web-mercator-viewport.js +281 -0
- package/package.json +4 -4
- package/src/{assert.js → assert.ts} +1 -1
- package/src/fit-bounds.ts +127 -0
- package/src/{fly-to-viewport.js → fly-to-viewport.ts} +52 -14
- package/src/{get-bounds.js → get-bounds.ts} +7 -5
- package/src/{index.js → index.ts} +5 -0
- package/src/math-utils.ts +32 -0
- package/src/{normalize-viewport-props.js → normalize-viewport-props.ts} +19 -10
- package/src/{web-mercator-utils.js → web-mercator-utils.ts} +186 -76
- package/src/web-mercator-viewport.ts +415 -0
- package/dist/es5/fit-bounds.d.ts +0 -64
- package/dist/es5/fly-to-viewport.d.ts +0 -31
- package/dist/es5/get-bounds.d.ts +0 -3
- package/dist/es5/index.d.ts +0 -23
- package/dist/es5/normalize-viewport-props.d.ts +0 -16
- package/dist/es5/web-mercator-viewport.d.ts +0 -187
- package/dist/esm/fit-bounds.d.ts +0 -64
- package/dist/esm/fly-to-viewport.d.ts +0 -31
- package/dist/esm/get-bounds.d.ts +0 -3
- package/dist/esm/index.d.ts +0 -23
- package/dist/esm/normalize-viewport-props.d.ts +0 -16
- package/dist/esm/web-mercator-utils.d.ts +0 -189
- package/dist/esm/web-mercator-viewport.d.ts +0 -187
- package/src/fit-bounds.d.ts +0 -64
- package/src/fit-bounds.js +0 -84
- package/src/fly-to-viewport.d.ts +0 -31
- package/src/get-bounds.d.ts +0 -3
- package/src/index.d.ts +0 -23
- package/src/math-utils.js +0 -28
- package/src/normalize-viewport-props.d.ts +0 -16
- package/src/web-mercator-utils.d.ts +0 -189
- package/src/web-mercator-viewport.d.ts +0 -187
- package/src/web-mercator-viewport.js +0 -262
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
// TODO - THE UTILITIES IN THIS FILE SHOULD BE IMPORTED FROM WEB-MERCATOR-VIEWPORT MODULE
|
|
2
|
+
import { createMat4, transformVector, log2 } from './math-utils';
|
|
3
|
+
import * as mat4 from 'gl-matrix/mat4';
|
|
4
|
+
import * as vec2 from 'gl-matrix/vec2';
|
|
5
|
+
import * as vec3 from 'gl-matrix/vec3';
|
|
6
|
+
import assert from './assert';
|
|
7
|
+
// CONSTANTS
|
|
8
|
+
const PI = Math.PI;
|
|
9
|
+
const PI_4 = PI / 4;
|
|
10
|
+
const DEGREES_TO_RADIANS = PI / 180;
|
|
11
|
+
const RADIANS_TO_DEGREES = 180 / PI;
|
|
12
|
+
const TILE_SIZE = 512;
|
|
13
|
+
// Average circumference (40075 km equatorial, 40007 km meridional)
|
|
14
|
+
const EARTH_CIRCUMFERENCE = 40.03e6;
|
|
15
|
+
// Latitude that makes a square world, 2 * atan(E ** PI) - PI / 2
|
|
16
|
+
export const MAX_LATITUDE = 85.051129;
|
|
17
|
+
// Mapbox default altitude
|
|
18
|
+
export const DEFAULT_ALTITUDE = 1.5;
|
|
19
|
+
/** Logarithimic zoom to linear scale **/
|
|
20
|
+
export function zoomToScale(zoom) {
|
|
21
|
+
return Math.pow(2, zoom);
|
|
22
|
+
}
|
|
23
|
+
/** Linear scale to logarithimic zoom **/
|
|
24
|
+
export function scaleToZoom(scale) {
|
|
25
|
+
return log2(scale);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Project [lng,lat] on sphere onto [x,y] on 512*512 Mercator Zoom 0 tile.
|
|
29
|
+
* Performs the nonlinear part of the web mercator projection.
|
|
30
|
+
* Remaining projection is done with 4x4 matrices which also handles
|
|
31
|
+
* perspective.
|
|
32
|
+
*
|
|
33
|
+
* @param lngLat - [lng, lat] coordinates
|
|
34
|
+
* Specifies a point on the sphere to project onto the map.
|
|
35
|
+
* @return [x,y] coordinates.
|
|
36
|
+
*/
|
|
37
|
+
export function lngLatToWorld(lngLat) {
|
|
38
|
+
const [lng, lat] = lngLat;
|
|
39
|
+
assert(Number.isFinite(lng));
|
|
40
|
+
assert(Number.isFinite(lat) && lat >= -90 && lat <= 90, 'invalid latitude');
|
|
41
|
+
const lambda2 = lng * DEGREES_TO_RADIANS;
|
|
42
|
+
const phi2 = lat * DEGREES_TO_RADIANS;
|
|
43
|
+
const x = (TILE_SIZE * (lambda2 + PI)) / (2 * PI);
|
|
44
|
+
const y = (TILE_SIZE * (PI + Math.log(Math.tan(PI_4 + phi2 * 0.5)))) / (2 * PI);
|
|
45
|
+
return [x, y];
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Unproject world point [x,y] on map onto {lat, lon} on sphere
|
|
49
|
+
*
|
|
50
|
+
* @param xy - array with [x,y] members
|
|
51
|
+
* representing point on projected map plane
|
|
52
|
+
* @return - array with [x,y] of point on sphere.
|
|
53
|
+
* Has toArray method if you need a GeoJSON Array.
|
|
54
|
+
* Per cartographic tradition, lat and lon are specified as degrees.
|
|
55
|
+
*/
|
|
56
|
+
export function worldToLngLat(xy) {
|
|
57
|
+
const [x, y] = xy;
|
|
58
|
+
const lambda2 = (x / TILE_SIZE) * (2 * PI) - PI;
|
|
59
|
+
const phi2 = 2 * (Math.atan(Math.exp((y / TILE_SIZE) * (2 * PI) - PI)) - PI_4);
|
|
60
|
+
return [lambda2 * RADIANS_TO_DEGREES, phi2 * RADIANS_TO_DEGREES];
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Returns the zoom level that gives a 1 meter pixel at a certain latitude
|
|
64
|
+
* 1 = C*cos(y)/2^z/TILE_SIZE = C*cos(y)/2^(z+9)
|
|
65
|
+
*/
|
|
66
|
+
export function getMeterZoom(options) {
|
|
67
|
+
const { latitude } = options;
|
|
68
|
+
assert(Number.isFinite(latitude));
|
|
69
|
+
const latCosine = Math.cos(latitude * DEGREES_TO_RADIANS);
|
|
70
|
+
return scaleToZoom(EARTH_CIRCUMFERENCE * latCosine) - 9;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Calculate distance scales in meters around current lat/lon, both for
|
|
74
|
+
* degrees and pixels.
|
|
75
|
+
* In mercator projection mode, the distance scales vary significantly
|
|
76
|
+
* with latitude.
|
|
77
|
+
*/
|
|
78
|
+
export function getDistanceScales(options) {
|
|
79
|
+
const { latitude, longitude, highPrecision = false } = options;
|
|
80
|
+
assert(Number.isFinite(latitude) && Number.isFinite(longitude));
|
|
81
|
+
const worldSize = TILE_SIZE;
|
|
82
|
+
const latCosine = Math.cos(latitude * DEGREES_TO_RADIANS);
|
|
83
|
+
/**
|
|
84
|
+
* Number of pixels occupied by one degree longitude around current lat/lon:
|
|
85
|
+
unitsPerDegreeX = d(lngLatToWorld([lng, lat])[0])/d(lng)
|
|
86
|
+
= scale * TILE_SIZE * DEGREES_TO_RADIANS / (2 * PI)
|
|
87
|
+
unitsPerDegreeY = d(lngLatToWorld([lng, lat])[1])/d(lat)
|
|
88
|
+
= -scale * TILE_SIZE * DEGREES_TO_RADIANS / cos(lat * DEGREES_TO_RADIANS) / (2 * PI)
|
|
89
|
+
*/
|
|
90
|
+
const unitsPerDegreeX = worldSize / 360;
|
|
91
|
+
const unitsPerDegreeY = unitsPerDegreeX / latCosine;
|
|
92
|
+
/**
|
|
93
|
+
* Number of pixels occupied by one meter around current lat/lon:
|
|
94
|
+
*/
|
|
95
|
+
const altUnitsPerMeter = worldSize / EARTH_CIRCUMFERENCE / latCosine;
|
|
96
|
+
/**
|
|
97
|
+
* LngLat: longitude -> east and latitude -> north (bottom left)
|
|
98
|
+
* UTM meter offset: x -> east and y -> north (bottom left)
|
|
99
|
+
* World space: x -> east and y -> south (top left)
|
|
100
|
+
*
|
|
101
|
+
* Y needs to be flipped when converting delta degree/meter to delta pixels
|
|
102
|
+
*/
|
|
103
|
+
const result = {
|
|
104
|
+
unitsPerMeter: [altUnitsPerMeter, altUnitsPerMeter, altUnitsPerMeter],
|
|
105
|
+
metersPerUnit: [1 / altUnitsPerMeter, 1 / altUnitsPerMeter, 1 / altUnitsPerMeter],
|
|
106
|
+
unitsPerDegree: [unitsPerDegreeX, unitsPerDegreeY, altUnitsPerMeter],
|
|
107
|
+
degreesPerUnit: [1 / unitsPerDegreeX, 1 / unitsPerDegreeY, 1 / altUnitsPerMeter]
|
|
108
|
+
};
|
|
109
|
+
/**
|
|
110
|
+
* Taylor series 2nd order for 1/latCosine
|
|
111
|
+
f'(a) * (x - a)
|
|
112
|
+
= d(1/cos(lat * DEGREES_TO_RADIANS))/d(lat) * dLat
|
|
113
|
+
= DEGREES_TO_RADIANS * tan(lat * DEGREES_TO_RADIANS) / cos(lat * DEGREES_TO_RADIANS) * dLat
|
|
114
|
+
*/
|
|
115
|
+
if (highPrecision) {
|
|
116
|
+
const latCosine2 = (DEGREES_TO_RADIANS * Math.tan(latitude * DEGREES_TO_RADIANS)) / latCosine;
|
|
117
|
+
const unitsPerDegreeY2 = (unitsPerDegreeX * latCosine2) / 2;
|
|
118
|
+
const altUnitsPerDegree2 = (worldSize / EARTH_CIRCUMFERENCE) * latCosine2;
|
|
119
|
+
const altUnitsPerMeter2 = (altUnitsPerDegree2 / unitsPerDegreeY) * altUnitsPerMeter;
|
|
120
|
+
result.unitsPerDegree2 = [0, unitsPerDegreeY2, altUnitsPerDegree2];
|
|
121
|
+
result.unitsPerMeter2 = [altUnitsPerMeter2, 0, altUnitsPerMeter2];
|
|
122
|
+
}
|
|
123
|
+
// Main results, used for converting meters to latlng deltas and scaling offsets
|
|
124
|
+
return result;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Offset a lng/lat position by meterOffset (northing, easting)
|
|
128
|
+
*/
|
|
129
|
+
export function addMetersToLngLat(lngLatZ, xyz) {
|
|
130
|
+
const [longitude, latitude, z0] = lngLatZ;
|
|
131
|
+
const [x, y, z] = xyz;
|
|
132
|
+
const { unitsPerMeter, unitsPerMeter2 } = getDistanceScales({
|
|
133
|
+
longitude,
|
|
134
|
+
latitude,
|
|
135
|
+
highPrecision: true
|
|
136
|
+
});
|
|
137
|
+
const worldspace = lngLatToWorld(lngLatZ);
|
|
138
|
+
worldspace[0] += x * (unitsPerMeter[0] + unitsPerMeter2[0] * y);
|
|
139
|
+
worldspace[1] += y * (unitsPerMeter[1] + unitsPerMeter2[1] * y);
|
|
140
|
+
const newLngLat = worldToLngLat(worldspace);
|
|
141
|
+
const newZ = (z0 || 0) + (z || 0);
|
|
142
|
+
return Number.isFinite(z0) || Number.isFinite(z) ? [newLngLat[0], newLngLat[1], newZ] : newLngLat;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* view and projection matrix creation is intentionally kept compatible with
|
|
147
|
+
* mapbox-gl's implementation to ensure that seamless interoperation
|
|
148
|
+
* with mapbox and react-map-gl. See: https://github.com/mapbox/mapbox-gl-js
|
|
149
|
+
*/
|
|
150
|
+
export function getViewMatrix(options) {
|
|
151
|
+
const {
|
|
152
|
+
// Viewport props
|
|
153
|
+
height, pitch, bearing, altitude,
|
|
154
|
+
// Pre-calculated parameters
|
|
155
|
+
scale, center } = options;
|
|
156
|
+
// VIEW MATRIX: PROJECTS MERCATOR WORLD COORDINATES
|
|
157
|
+
// Note that mercator world coordinates typically need to be flipped
|
|
158
|
+
//
|
|
159
|
+
// Note: As usual, matrix operation orders should be read in reverse
|
|
160
|
+
// since vectors will be multiplied from the right during transformation
|
|
161
|
+
const vm = createMat4();
|
|
162
|
+
// Move camera to altitude (along the pitch & bearing direction)
|
|
163
|
+
mat4.translate(vm, vm, [0, 0, -altitude]);
|
|
164
|
+
// Rotate by bearing, and then by pitch (which tilts the view)
|
|
165
|
+
mat4.rotateX(vm, vm, -pitch * DEGREES_TO_RADIANS);
|
|
166
|
+
mat4.rotateZ(vm, vm, bearing * DEGREES_TO_RADIANS);
|
|
167
|
+
const relativeScale = scale / height;
|
|
168
|
+
mat4.scale(vm, vm, [relativeScale, relativeScale, relativeScale]);
|
|
169
|
+
if (center) {
|
|
170
|
+
mat4.translate(vm, vm, vec3.negate([], center));
|
|
171
|
+
}
|
|
172
|
+
return vm;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Calculates mapbox compatible projection matrix from parameters
|
|
176
|
+
*
|
|
177
|
+
* @param options.width Width of "viewport" or window
|
|
178
|
+
* @param options.height Height of "viewport" or window
|
|
179
|
+
* @param options.pitch Camera angle in degrees (0 is straight down)
|
|
180
|
+
* @param options.fovy field of view in degrees
|
|
181
|
+
* @param options.altitude if provided, field of view is calculated using `altitudeToFovy()`
|
|
182
|
+
* @param options.nearZMultiplier control z buffer
|
|
183
|
+
* @param options.farZMultiplier control z buffer
|
|
184
|
+
* @returns project parameters object
|
|
185
|
+
*/
|
|
186
|
+
export function getProjectionParameters(options) {
|
|
187
|
+
const { width, height, altitude, pitch = 0, nearZMultiplier = 1, farZMultiplier = 1 } = options;
|
|
188
|
+
let { fovy = altitudeToFovy(DEFAULT_ALTITUDE) } = options;
|
|
189
|
+
// For back-compatibility allow field of view to be
|
|
190
|
+
// derived from altitude
|
|
191
|
+
if (altitude !== undefined) {
|
|
192
|
+
fovy = altitudeToFovy(altitude);
|
|
193
|
+
}
|
|
194
|
+
const halfFov = 0.5 * fovy * DEGREES_TO_RADIANS;
|
|
195
|
+
const focalDistance = fovyToAltitude(fovy);
|
|
196
|
+
// Find the distance from the center point to the center top
|
|
197
|
+
// in focal distance units using law of sines.
|
|
198
|
+
const pitchRadians = pitch * DEGREES_TO_RADIANS;
|
|
199
|
+
const topHalfSurfaceDistance = (Math.sin(halfFov) * focalDistance) /
|
|
200
|
+
Math.sin(Math.min(Math.max(Math.PI / 2 - pitchRadians - halfFov, 0.01), Math.PI - 0.01));
|
|
201
|
+
// Calculate z value of the farthest fragment that should be rendered.
|
|
202
|
+
const farZ = Math.sin(pitchRadians) * topHalfSurfaceDistance + focalDistance;
|
|
203
|
+
return {
|
|
204
|
+
fov: 2 * halfFov,
|
|
205
|
+
aspect: width / height,
|
|
206
|
+
focalDistance,
|
|
207
|
+
near: nearZMultiplier,
|
|
208
|
+
far: farZ * farZMultiplier
|
|
209
|
+
};
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* CALCULATE PROJECTION MATRIX: PROJECTS FROM CAMERA (VIEW) SPACE TO CLIPSPACE
|
|
213
|
+
*
|
|
214
|
+
* To match mapbox's z buffer:
|
|
215
|
+
* - \<= 0.28: nearZMultiplier: 0.1, farZmultiplier: 1
|
|
216
|
+
* - \>= 0.29: nearZMultiplier: 1 / height, farZMultiplier: 1.01
|
|
217
|
+
*
|
|
218
|
+
* @param options Viewport options
|
|
219
|
+
* @param options.width Width of "viewport" or window
|
|
220
|
+
* @param options.height Height of "viewport" or window
|
|
221
|
+
* @param options.pitch Camera angle in degrees (0 is straight down)
|
|
222
|
+
* @param options.fovy field of view in degrees
|
|
223
|
+
* @param options.altitude if provided, field of view is calculated using `altitudeToFovy()`
|
|
224
|
+
* @param options.nearZMultiplier control z buffer
|
|
225
|
+
* @param options.farZMultiplier control z buffer
|
|
226
|
+
* @returns 4x4 projection matrix
|
|
227
|
+
*/
|
|
228
|
+
export function getProjectionMatrix(options) {
|
|
229
|
+
const { fov, aspect, near, far } = getProjectionParameters(options);
|
|
230
|
+
const projectionMatrix = mat4.perspective([], fov, // fov in radians
|
|
231
|
+
aspect, // aspect ratio
|
|
232
|
+
near, // near plane
|
|
233
|
+
far // far plane
|
|
234
|
+
);
|
|
235
|
+
return projectionMatrix;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* Convert an altitude to field of view such that the
|
|
240
|
+
* focal distance is equal to the altitude
|
|
241
|
+
*
|
|
242
|
+
* @param altitude - altitude of camera in screen units
|
|
243
|
+
* @return fovy field of view in degrees
|
|
244
|
+
*/
|
|
245
|
+
export function altitudeToFovy(altitude) {
|
|
246
|
+
return 2 * Math.atan(0.5 / altitude) * RADIANS_TO_DEGREES;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* Convert an field of view such that the
|
|
251
|
+
* focal distance is equal to the altitude
|
|
252
|
+
*
|
|
253
|
+
* @param fovy - field of view in degrees
|
|
254
|
+
* @return altitude altitude of camera in screen units
|
|
255
|
+
*/
|
|
256
|
+
export function fovyToAltitude(fovy) {
|
|
257
|
+
return 0.5 / Math.tan(0.5 * fovy * DEGREES_TO_RADIANS);
|
|
258
|
+
}
|
|
259
|
+
// Project flat coordinates to pixels on screen.
|
|
260
|
+
export function worldToPixels(xyz, pixelProjectionMatrix) {
|
|
261
|
+
const [x, y, z = 0] = xyz;
|
|
262
|
+
assert(Number.isFinite(x) && Number.isFinite(y) && Number.isFinite(z));
|
|
263
|
+
return transformVector(pixelProjectionMatrix, [x, y, z, 1]);
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Unproject pixels on screen to flat coordinates.
|
|
267
|
+
*
|
|
268
|
+
* @param xyz - pixel coordinate on screen.
|
|
269
|
+
* @param pixelUnprojectionMatrix - unprojection matrix 4x4
|
|
270
|
+
* @param targetZ - if pixel coordinate does not have a 3rd component (depth),
|
|
271
|
+
* targetZ is used as the elevation plane to unproject onto
|
|
272
|
+
* @return [x, y, Z] flat coordinates on 512*512 Mercator Zoom 0 tile.
|
|
273
|
+
*/
|
|
274
|
+
export function pixelsToWorld(xyz, pixelUnprojectionMatrix, targetZ = 0) {
|
|
275
|
+
const [x, y, z] = xyz;
|
|
276
|
+
assert(Number.isFinite(x) && Number.isFinite(y), 'invalid pixel coordinate');
|
|
277
|
+
if (Number.isFinite(z)) {
|
|
278
|
+
// Has depth component
|
|
279
|
+
const coord = transformVector(pixelUnprojectionMatrix, [x, y, z, 1]);
|
|
280
|
+
return coord;
|
|
281
|
+
}
|
|
282
|
+
// since we don't know the correct projected z value for the point,
|
|
283
|
+
// unproject two points to get a line and then find the point on that line with z=0
|
|
284
|
+
const coord0 = transformVector(pixelUnprojectionMatrix, [x, y, 0, 1]);
|
|
285
|
+
const coord1 = transformVector(pixelUnprojectionMatrix, [x, y, 1, 1]);
|
|
286
|
+
const z0 = coord0[2];
|
|
287
|
+
const z1 = coord1[2];
|
|
288
|
+
const t = z0 === z1 ? 0 : ((targetZ || 0) - z0) / (z1 - z0);
|
|
289
|
+
return vec2.lerp([], coord0, coord1, t);
|
|
290
|
+
}
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
import { DistanceScales } from './web-mercator-utils';
|
|
2
|
+
import type { FitBoundsOptions } from './fit-bounds';
|
|
3
|
+
/**
|
|
4
|
+
* @param width=1 - Width of "viewport" or window
|
|
5
|
+
* @param height=1 - Height of "viewport" or window
|
|
6
|
+
* @param scale=1 - Either use scale or zoom
|
|
7
|
+
* @param pitch=0 - Camera angle in degrees (0 is straight down)
|
|
8
|
+
* @param bearing=0 - Map rotation in degrees (0 means north is up)
|
|
9
|
+
* @param fovy= - Field of view of camera in degrees
|
|
10
|
+
* @param altitude= - Altitude of camera in screen units
|
|
11
|
+
*
|
|
12
|
+
* Web mercator projection short-hand parameters
|
|
13
|
+
* @param latitude - Center of viewport on map
|
|
14
|
+
* @param longitude - Center of viewport on map
|
|
15
|
+
* @param zoom - Scale = Math.pow(2,zoom) on map
|
|
16
|
+
|
|
17
|
+
* Notes:
|
|
18
|
+
* - Only one of center or [latitude, longitude] can be specified
|
|
19
|
+
* - [latitude, longitude] can only be specified when "mercator" is true
|
|
20
|
+
* - Altitude has a default value that matches assumptions in mapbox-gl
|
|
21
|
+
* - Field of view is independent from altitude, provide `altitudeToFovy(1.5)` (default value) to match assumptions in mapbox-gl
|
|
22
|
+
* - width and height are forced to 1 if supplied as 0, to avoid
|
|
23
|
+
* division by zero. This is intended to reduce the burden of apps to
|
|
24
|
+
* to check values before instantiating a Viewport.
|
|
25
|
+
*/
|
|
26
|
+
export declare type WebMercatorViewportProps = {
|
|
27
|
+
width: number;
|
|
28
|
+
height: number;
|
|
29
|
+
latitude?: number;
|
|
30
|
+
longitude?: number;
|
|
31
|
+
position?: number[];
|
|
32
|
+
zoom?: number;
|
|
33
|
+
pitch?: number;
|
|
34
|
+
bearing?: number;
|
|
35
|
+
altitude?: number;
|
|
36
|
+
fovy?: number;
|
|
37
|
+
nearZMultiplier?: number;
|
|
38
|
+
farZMultiplier?: number;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* The WebMercatorViewport class creates
|
|
42
|
+
* - view/projection matrices
|
|
43
|
+
* - "uniform values" (for shaders) from mercator params
|
|
44
|
+
*
|
|
45
|
+
* Note: Instances are immutable in the sense that they only have accessors.
|
|
46
|
+
* A new viewport instance should be created if any parameters have changed.
|
|
47
|
+
*/
|
|
48
|
+
export default class WebMercatorViewport {
|
|
49
|
+
readonly latitude: number;
|
|
50
|
+
readonly longitude: number;
|
|
51
|
+
readonly zoom: number;
|
|
52
|
+
readonly pitch: number;
|
|
53
|
+
readonly bearing: number;
|
|
54
|
+
readonly altitude: number;
|
|
55
|
+
readonly fovy: number;
|
|
56
|
+
readonly meterOffset: number[];
|
|
57
|
+
readonly center: number[];
|
|
58
|
+
readonly width: number;
|
|
59
|
+
readonly height: number;
|
|
60
|
+
readonly scale: number;
|
|
61
|
+
readonly distanceScales: DistanceScales;
|
|
62
|
+
readonly viewMatrix: number[];
|
|
63
|
+
readonly projectionMatrix: number[];
|
|
64
|
+
viewProjectionMatrix: number[];
|
|
65
|
+
pixelProjectionMatrix: number[];
|
|
66
|
+
pixelUnprojectionMatrix: number[];
|
|
67
|
+
/**
|
|
68
|
+
* @classdesc
|
|
69
|
+
* Creates view/projection matrices from mercator params
|
|
70
|
+
* Note: The Viewport is immutable in the sense that it only has accessors.
|
|
71
|
+
* A new viewport instance should be created if any parameters have changed.
|
|
72
|
+
*/
|
|
73
|
+
constructor(props?: WebMercatorViewportProps);
|
|
74
|
+
_initMatrices(): void;
|
|
75
|
+
/** Two viewports are equal if width and height are identical, and if
|
|
76
|
+
* their view and projection matrices are (approximately) equal.
|
|
77
|
+
*/
|
|
78
|
+
equals(viewport: WebMercatorViewport | null): boolean;
|
|
79
|
+
/**
|
|
80
|
+
* Projects xyz (possibly latitude and longitude) to pixel coordinates in window
|
|
81
|
+
* using viewport projection parameters
|
|
82
|
+
* - [longitude, latitude] to [x, y]
|
|
83
|
+
* - [longitude, latitude, Z] => [x, y, z]
|
|
84
|
+
* Note: By default, returns top-left coordinates for canvas/SVG type render
|
|
85
|
+
*
|
|
86
|
+
* @param lngLatZ - [lng, lat] or [lng, lat, Z]
|
|
87
|
+
* @param options - options
|
|
88
|
+
* @param options.topLeft=true - Whether projected coords are top left
|
|
89
|
+
* @return - screen coordinates [x, y] or [x, y, z], z as pixel depth
|
|
90
|
+
*/
|
|
91
|
+
project(lngLatZ: number[], options?: {
|
|
92
|
+
topLeft?: boolean;
|
|
93
|
+
}): number[];
|
|
94
|
+
/**
|
|
95
|
+
* Unproject pixel coordinates on screen onto world coordinates, possibly `[lon, lat]` on map.
|
|
96
|
+
*
|
|
97
|
+
* - [x, y] => [lng, lat]
|
|
98
|
+
* - [x, y, z] => [lng, lat, Z]
|
|
99
|
+
*
|
|
100
|
+
* @param xyz - screen coordinates, z as pixel depth
|
|
101
|
+
* @param options - options
|
|
102
|
+
* @param options.topLeft=true - Whether projected coords are top left
|
|
103
|
+
* @param options.targetZ=0 - If pixel depth is unknown, targetZ is used as
|
|
104
|
+
* the elevation plane to unproject onto
|
|
105
|
+
* @return - [lng, lat, Z] or [X, Y, Z]
|
|
106
|
+
*/
|
|
107
|
+
unproject(xyz: number[], options?: {
|
|
108
|
+
topLeft?: boolean;
|
|
109
|
+
targetZ?: number;
|
|
110
|
+
}): number[];
|
|
111
|
+
projectPosition(xyz: number[]): [number, number, number];
|
|
112
|
+
unprojectPosition(xyz: number[]): [number, number, number];
|
|
113
|
+
/**
|
|
114
|
+
* Project [lng,lat] on sphere onto [x,y] on 512*512 Mercator Zoom 0 tile.
|
|
115
|
+
* Performs the nonlinear part of the web mercator projection.
|
|
116
|
+
* Remaining projection is done with 4x4 matrices which also handles
|
|
117
|
+
* perspective.
|
|
118
|
+
*
|
|
119
|
+
* @param lngLat - [lng, lat] coordinates
|
|
120
|
+
* Specifies a point on the sphere to project onto the map.
|
|
121
|
+
* @return [x,y] coordinates.
|
|
122
|
+
*/
|
|
123
|
+
projectFlat(lngLat: number[]): number[];
|
|
124
|
+
/**
|
|
125
|
+
* Unproject world point [x,y] on map onto {lat, lon} on sphere
|
|
126
|
+
*
|
|
127
|
+
* @param xy - array with [x,y] members
|
|
128
|
+
* representing point on projected map plane
|
|
129
|
+
* @return - array with [lat,lon] of point on sphere.
|
|
130
|
+
* Has toArray method if you need a GeoJSON Array.
|
|
131
|
+
* Per cartographic tradition, lat and lon are specified as degrees.
|
|
132
|
+
*/
|
|
133
|
+
unprojectFlat(xy: number[]): number[];
|
|
134
|
+
/**
|
|
135
|
+
* Get the map center that place a given [lng, lat] coordinate at screen point [x, y]
|
|
136
|
+
* @param opt
|
|
137
|
+
* @param opt.lngLat - [lng,lat] coordinates
|
|
138
|
+
* Specifies a point on the sphere.
|
|
139
|
+
* @param opt.pos - [x,y] coordinates
|
|
140
|
+
* Specifies a point on the screen.
|
|
141
|
+
* @return [lng,lat] new map center.
|
|
142
|
+
*/
|
|
143
|
+
getMapCenterByLngLatPosition({ lngLat, pos }: {
|
|
144
|
+
lngLat: number[];
|
|
145
|
+
pos: number[];
|
|
146
|
+
}): number[];
|
|
147
|
+
/**
|
|
148
|
+
* Returns a new viewport that fit around the given rectangle.
|
|
149
|
+
* Only supports non-perspective mode.
|
|
150
|
+
* @param bounds - [[lon, lat], [lon, lat]]
|
|
151
|
+
* @param [options]
|
|
152
|
+
* @param [options.padding] - The amount of padding in pixels to add to the given bounds.
|
|
153
|
+
* @param [options.offset] - The center of the given bounds relative to the map's center,
|
|
154
|
+
* [x, y] measured in pixels.
|
|
155
|
+
* @returns {WebMercatorViewport}
|
|
156
|
+
*/
|
|
157
|
+
fitBounds(bounds: [[number, number], [number, number]], options?: Omit<FitBoundsOptions, 'width' | 'height' | 'bounds'>): WebMercatorViewport;
|
|
158
|
+
/**
|
|
159
|
+
* Returns the bounding box of the viewport.
|
|
160
|
+
* @param [options]
|
|
161
|
+
* @param [options.z] - The altitude at which the bounds should be calculated.
|
|
162
|
+
* @returns {Array} bounds - [[lon, lat], [lon, lat]]
|
|
163
|
+
*/
|
|
164
|
+
getBounds(options?: {
|
|
165
|
+
z?: number;
|
|
166
|
+
}): number[][];
|
|
167
|
+
/**
|
|
168
|
+
* Returns the bounding box of the viewport.
|
|
169
|
+
* @param [options]
|
|
170
|
+
* @param [options.z] - The altitude at which the bounds should be calculated.
|
|
171
|
+
* @returns {Array} an array of 4 points that define the visible region
|
|
172
|
+
*/
|
|
173
|
+
getBoundingRegion(options?: {
|
|
174
|
+
z?: number;
|
|
175
|
+
}): number[][];
|
|
176
|
+
/** @deprecated Legacy method name */
|
|
177
|
+
getLocationAtPoint({ lngLat, pos }: {
|
|
178
|
+
lngLat: number[];
|
|
179
|
+
pos: number[];
|
|
180
|
+
}): number[];
|
|
181
|
+
}
|
|
182
|
+
//# sourceMappingURL=web-mercator-viewport.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"web-mercator-viewport.d.ts","sourceRoot":"","sources":["../src/web-mercator-viewport.ts"],"names":[],"mappings":"AAGA,OAAO,EAYL,cAAc,EACf,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AAMnD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,oBAAY,wBAAwB,GAAG;IAErC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAE1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAExC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAEpC,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,uBAAuB,EAAE,MAAM,EAAE,CAAC;IAElC;;;;;OAKG;gBAES,KAAK,GAAE,wBAAgD;IAgGnE,aAAa,IAAI,IAAI;IAoCrB;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,GAAG,OAAO;IAarD;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAM,GAAG,MAAM,EAAE;IAUvE;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAM,GAAG,MAAM,EAAE;IAkBvF,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAMxD,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;IAM1D;;;;;;;;;OASG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAIvC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAIrC;;;;;;;;OAQG;IACH,4BAA4B,CAAC,EAAC,MAAM,EAAE,GAAG,EAAC,EAAE;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,GAAG,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,MAAM,EAAE;IAQxF;;;;;;;;;OASG;IACH,SAAS,CACP,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAC5C,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAM,GAClE,mBAAmB;IAMtB;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,MAAM,EAAE,EAAE;IAa7C;;;;;OAKG;IACH,iBAAiB,CAAC,OAAO,GAAE;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAM,GAAG,MAAM,EAAE,EAAE;IAMzD,qCAAqC;IACrC,kBAAkB,CAAC,EAAC,MAAM,EAAE,GAAG,EAAC,EAAE;QAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAAC,GAAG,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,MAAM,EAAE;CAG/E"}
|