• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

visgl / deck.gl / 21261550644

22 Jan 2026 07:13PM UTC coverage: 91.105% (-0.01%) from 91.115%
21261550644

Pull #9955

github

web-flow
Merge c9393dee3 into 83ac41278
Pull Request #9955: chore(mapbox): Remove internal deck mode from `MapboxLayer`

6862 of 7538 branches covered (91.03%)

Branch coverage included in aggregate %.

63 of 63 new or added lines in 4 files covered. (100.0%)

2 existing lines in 1 file now uncovered.

56811 of 62352 relevant lines covered (91.11%)

14389.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.96
/modules/mapbox/src/deck-utils.ts
1
// deck.gl
1✔
2
// SPDX-License-Identifier: MIT
1✔
3
// Copyright (c) vis.gl contributors
1✔
4

1✔
5
import {Deck, MapView, _GlobeView as GlobeView, _flatten as flatten} from '@deck.gl/core';
1✔
6
import type {Viewport, MapViewState, Layer} from '@deck.gl/core';
1✔
7
import type {Parameters} from '@luma.gl/core';
1✔
8
import type MapboxLayer from './mapbox-layer';
1✔
9
import type MapboxLayerGroup from './mapbox-layer-group';
1✔
10
import type {LayerOverlayProps, Map} from './types';
1✔
11

1✔
12
import {lngLatToWorld, unitsPerMeter} from '@math.gl/web-mercator';
1✔
13

1✔
14
const MAPBOX_VIEW_ID = 'mapbox';
1✔
15

1✔
16
type UserData = {
1✔
17
  currentViewport?: Viewport | null;
1✔
18
  mapboxLayers: Set<MapboxLayer<any>>;
1✔
19
  // mapboxVersion: {minor: number; major: number};
1✔
20
};
1✔
21

1✔
22
// Mercator constants
1✔
23
const TILE_SIZE = 512;
1✔
24
const DEGREES_TO_RADIANS = Math.PI / 180;
1✔
25

1✔
26
// Create an interleaved deck instance.
1✔
27
export function getDeckInstance({
1✔
28
  map,
14✔
29
  deck
14✔
30
}: {
14✔
31
  map: Map & {__deck?: Deck<any> | null};
14✔
32
  deck: Deck<any>;
14✔
33
}): Deck<any> {
14✔
34
  // Only create one deck instance per context
14✔
35
  if (map.__deck) {
14!
UNCOV
36
    return map.__deck;
×
UNCOV
37
  }
×
38

14✔
39
  // Only initialize certain props once per context
14✔
40
  const customRender = deck.props._customRender;
14✔
41
  const onLoad = deck.props.onLoad;
14✔
42

14✔
43
  const deckProps = {
14✔
44
    ...deck.props,
14✔
45
    _customRender: () => {
14✔
46
      map.triggerRepaint();
15✔
47
      // customRender may be subscribed by DeckGL React component to update child props
15✔
48
      // make sure it is still called
15✔
49
      // Hack - do not pass a redraw reason here to prevent the React component from clearing the context
15✔
50
      // Rerender will be triggered by MapboxLayer's render()
15✔
51
      customRender?.('');
15!
52
    }
15✔
53
  };
14✔
54
  deckProps.views ||= getDefaultView(map);
14✔
55

14✔
56
  // deck is using the WebGLContext created by mapbox,
14✔
57
  // block deck from setting the canvas size, and use the map's viewState to drive deck.
14✔
58
  Object.assign(deckProps, {
14✔
59
    width: null,
14✔
60
    height: null,
14✔
61
    touchAction: 'unset',
14✔
62
    viewState: getViewState(map)
14✔
63
  });
14✔
64
  if (deck.isInitialized) {
14✔
65
    watchMapMove(deck, map);
2✔
66
  } else {
14✔
67
    deckProps.onLoad = () => {
12✔
68
      onLoad?.();
10✔
69
      watchMapMove(deck, map);
10✔
70
    };
10✔
71
  }
12✔
72

14✔
73
  deck.setProps(deckProps);
14✔
74

14✔
75
  (deck.userData as UserData).mapboxLayers = new Set();
14✔
76
  map.__deck = deck;
14✔
77
  map.on('render', () => {
14✔
78
    if (deck.isInitialized) afterRender(deck, map);
17✔
79
  });
14✔
80

14✔
81
  return deck;
14✔
82
}
14✔
83

1✔
84
function watchMapMove(deck: Deck, map: Map & {__deck?: Deck | null}) {
12✔
85
  const _handleMapMove = () => {
12✔
86
    if (deck.isInitialized) {
1!
87
      // call view state methods
×
88
      onMapMove(deck, map);
×
89
    } else {
1✔
90
      // deregister itself when deck is finalized
1✔
91
      map.off('move', _handleMapMove);
1✔
92
    }
1✔
93
  };
1✔
94
  map.on('move', _handleMapMove);
12✔
95
}
12✔
96

1✔
97
export function removeDeckInstance(map: Map & {__deck?: Deck | null}) {
1✔
98
  map.__deck?.finalize();
10✔
99
  map.__deck = null;
10✔
100
}
10✔
101

1✔
102
export function getDefaultParameters(map: Map, interleaved: boolean): Parameters {
1✔
103
  const result: Parameters = interleaved
18✔
104
    ? {
14✔
105
        depthWriteEnabled: true,
14✔
106
        depthCompare: 'less-equal',
14✔
107
        depthBias: 0,
14✔
108
        blend: true,
14✔
109
        blendColorSrcFactor: 'src-alpha',
14✔
110
        blendColorDstFactor: 'one-minus-src-alpha',
14✔
111
        blendAlphaSrcFactor: 'one',
14✔
112
        blendAlphaDstFactor: 'one-minus-src-alpha',
14✔
113
        blendColorOperation: 'add',
14✔
114
        blendAlphaOperation: 'add'
14✔
115
      }
14✔
116
    : {};
4✔
117
  if (getProjection(map) === 'globe') {
18✔
118
    result.cullMode = 'back';
1✔
119
  }
1✔
120
  return result;
18✔
121
}
18✔
122

1✔
123
export function addLayer(deck: Deck, layer: MapboxLayer<any>): void {
1✔
124
  (deck.userData as UserData).mapboxLayers.add(layer);
18✔
125
}
18✔
126

1✔
127
export function removeLayer(deck: Deck, layer: MapboxLayer<any>): void {
1✔
128
  (deck.userData as UserData).mapboxLayers.delete(layer);
12✔
129
}
12✔
130

1✔
131
export function drawLayer(
1✔
132
  deck: Deck,
11✔
133
  map: Map,
11✔
134
  layer: MapboxLayer<any>,
11✔
135
  renderParameters: any
11✔
136
): void {
11✔
137
  let {currentViewport} = deck.userData as UserData;
11✔
138
  let clearStack: boolean = false;
11✔
139
  if (!currentViewport) {
11✔
140
    // This is the first layer drawn in this render cycle.
10✔
141
    // Generate viewport from the current map state.
10✔
142
    currentViewport = getViewport(deck, map, renderParameters);
10✔
143
    (deck.userData as UserData).currentViewport = currentViewport;
10✔
144
    clearStack = true;
10✔
145
  }
10✔
146

11✔
147
  if (!deck.isInitialized) {
11✔
148
    return;
1✔
149
  }
1✔
150

10✔
151
  deck._drawLayers('mapbox-repaint', {
10✔
152
    viewports: [currentViewport],
10✔
153
    layerFilter: params =>
10✔
154
      (!deck.props.layerFilter || deck.props.layerFilter(params)) &&
13✔
155
      (layer.id === params.layer.id || params.layer.props.operation.includes('terrain')),
10✔
156
    clearStack,
10✔
157
    clearCanvas: false
10✔
158
  });
10✔
159
}
10✔
160

1✔
161
export function drawLayerGroup(
1✔
162
  deck: Deck,
3✔
163
  map: Map,
3✔
164
  group: MapboxLayerGroup,
3✔
165
  renderParameters: any
3✔
166
): void {
3✔
167
  let {currentViewport} = deck.userData as UserData;
3✔
168
  let clearStack: boolean = false;
3✔
169
  if (!currentViewport) {
3✔
170
    // This is the first layer drawn in this render cycle.
3✔
171
    // Generate viewport from the current map state.
3✔
172
    currentViewport = getViewport(deck, map, renderParameters);
3✔
173
    (deck.userData as UserData).currentViewport = currentViewport;
3✔
174
    clearStack = true;
3✔
175
  }
3✔
176

3✔
177
  if (!deck.isInitialized) {
3!
178
    return;
×
179
  }
×
180

3✔
181
  deck._drawLayers('mapbox-repaint', {
3✔
182
    viewports: [currentViewport],
3✔
183
    layerFilter: params => {
3✔
184
      if (deck.props.layerFilter && !deck.props.layerFilter(params)) {
4!
185
        return false;
×
186
      }
×
187

4✔
188
      const layer = params.layer as Layer<LayerOverlayProps>;
4✔
189
      if (layer.props.beforeId === group.beforeId && layer.props.slot === group.slot) {
4✔
190
        return true;
4✔
191
      }
4!
192
      return false;
×
193
    },
4✔
194
    clearStack,
3✔
195
    clearCanvas: false
3✔
196
  });
3✔
197
}
3✔
198

1✔
199
export function getProjection(map: Map): 'mercator' | 'globe' {
1✔
200
  const projection = map.getProjection?.();
51✔
201
  const type =
51✔
202
    // maplibre projection spec
51✔
203
    projection?.type ||
51!
204
    // mapbox projection spec
×
205
    projection?.name;
×
206
  if (type === 'globe') {
51✔
207
    return 'globe';
4✔
208
  }
4✔
209
  if (type && type !== 'mercator') {
51!
210
    throw new Error('Unsupported projection');
×
211
  }
✔
212
  return 'mercator';
47✔
213
}
47✔
214

1✔
215
export function getDefaultView(map: Map): GlobeView | MapView {
1✔
216
  if (getProjection(map) === 'globe') {
25✔
217
    return new GlobeView({id: MAPBOX_VIEW_ID});
2✔
218
  }
2✔
219
  return new MapView({id: MAPBOX_VIEW_ID});
23✔
220
}
23✔
221

1✔
222
export function getViewState(map: Map): MapViewState & {
1✔
223
  repeat: boolean;
35✔
224
  padding: {
35✔
225
    left: number;
35✔
226
    right: number;
35✔
227
    top: number;
35✔
228
    bottom: number;
35✔
229
  };
35✔
230
} {
35✔
231
  const {lng, lat} = map.getCenter();
35✔
232

35✔
233
  const viewState: MapViewState & {
35✔
234
    repeat: boolean;
35✔
235
    padding: {
35✔
236
      left: number;
35✔
237
      right: number;
35✔
238
      top: number;
35✔
239
      bottom: number;
35✔
240
    };
35✔
241
  } = {
35✔
242
    // Longitude returned by getCenter can be outside of [-180, 180] when zooming near the anti meridian
35✔
243
    // https://github.com/visgl/deck.gl/issues/6894
35✔
244
    longitude: ((lng + 540) % 360) - 180,
35✔
245
    latitude: lat,
35✔
246
    zoom: map.getZoom(),
35✔
247
    bearing: map.getBearing(),
35✔
248
    pitch: map.getPitch(),
35✔
249
    padding: map.getPadding(),
35✔
250
    repeat: map.getRenderWorldCopies()
35✔
251
  };
35✔
252

35✔
253
  if (map.getTerrain?.()) {
35!
254
    // When the base map has terrain, we need to target the camera at the terrain surface
×
255
    centerCameraOnTerrain(map, viewState);
×
256
  }
×
257

35✔
258
  return viewState;
35✔
259
}
35✔
260

1✔
261
function centerCameraOnTerrain(map: Map, viewState: MapViewState) {
×
262
  if (map.getFreeCameraOptions) {
×
263
    // mapbox-gl v2
×
264
    const {position} = map.getFreeCameraOptions();
×
265
    if (!position || position.z === undefined) {
×
266
      return;
×
267
    }
×
268

×
269
    // @ts-ignore transform is not typed
×
270
    const height = map.transform.height;
×
271
    const {longitude, latitude, pitch} = viewState;
×
272

×
273
    // Convert mapbox mercator coordinate to deck common space
×
274
    const cameraX = position.x * TILE_SIZE;
×
275
    const cameraY = (1 - position.y) * TILE_SIZE;
×
276
    const cameraZ = position.z * TILE_SIZE;
×
277

×
278
    // Mapbox manipulates zoom in terrain mode, see discussion here: https://github.com/mapbox/mapbox-gl-js/issues/12040
×
279
    const center = lngLatToWorld([longitude, latitude]);
×
280
    const dx = cameraX - center[0];
×
281
    const dy = cameraY - center[1];
×
282
    const cameraToCenterDistanceGround = Math.sqrt(dx * dx + dy * dy);
×
283

×
284
    const pitchRadians = pitch! * DEGREES_TO_RADIANS;
×
285
    const altitudePixels = 1.5 * height;
×
286
    const scale =
×
287
      pitchRadians < 0.001
×
288
        ? // Pitch angle too small to deduce the look at point, assume elevation is 0
×
289
          (altitudePixels * Math.cos(pitchRadians)) / cameraZ
×
290
        : (altitudePixels * Math.sin(pitchRadians)) / cameraToCenterDistanceGround;
×
291
    viewState.zoom = Math.log2(scale);
×
292

×
293
    const cameraZFromSurface = (altitudePixels * Math.cos(pitchRadians)) / scale;
×
294
    const surfaceElevation = cameraZ - cameraZFromSurface;
×
295
    viewState.position = [0, 0, surfaceElevation / unitsPerMeter(latitude)];
×
296
  }
×
297
  // @ts-ignore transform is not typed
×
298
  else if (typeof map.transform.elevation === 'number') {
×
299
    // maplibre-gl
×
300
    // @ts-ignore transform is not typed
×
301
    viewState.position = [0, 0, map.transform.elevation];
×
302
  }
×
303
}
×
304

1✔
305
// Since maplibre-gl@5
1✔
306
// https://github.com/maplibre/maplibre-gl-js/blob/main/src/style/style_layer/custom_style_layer.ts
1✔
307
type MaplibreRenderParameters = {
1✔
308
  farZ: number;
1✔
309
  nearZ: number;
1✔
310
  fov: number;
1✔
311
  modelViewProjectionMatrix: number[];
1✔
312
  projectionMatrix: number[];
1✔
313
};
1✔
314

1✔
315
function getViewport(deck: Deck, map: Map, renderParameters?: unknown): Viewport {
17✔
316
  const viewState = getViewState(map);
17✔
317
  const {views} = deck.props;
17✔
318
  const view =
17✔
319
    (views && flatten(views).find((v: {id: string}) => v.id === MAPBOX_VIEW_ID)) ||
17✔
320
    getDefaultView(map);
1✔
321

17✔
322
  if (renderParameters) {
17!
323
    // Called from MapboxLayer.render
×
324
    // Magic number, matches mapbox-gl@>=1.3.0's projection matrix
×
325
    view.props.nearZMultiplier = 0.2;
×
326
  }
×
327

17✔
328
  // Get the base map near/far plane
17✔
329
  // renderParameters is maplibre API but not mapbox
17✔
330
  // Transform is not an official API, properties could be undefined for older versions
17✔
331
  const nearZ = (renderParameters as MaplibreRenderParameters)?.nearZ ?? map.transform._nearZ;
17!
332
  const farZ = (renderParameters as MaplibreRenderParameters)?.farZ ?? map.transform._farZ;
17!
333
  if (Number.isFinite(nearZ)) {
17!
334
    viewState.nearZ = nearZ / map.transform.height;
×
335
    viewState.farZ = farZ / map.transform.height;
×
336
  }
×
337
  // Otherwise fallback to default calculation using nearZMultiplier/farZMultiplier
17✔
338

17✔
339
  return view.makeViewport({
17✔
340
    width: deck.width,
17✔
341
    height: deck.height,
17✔
342
    viewState
17✔
343
  }) as Viewport;
17✔
344
}
17✔
345

1✔
346
function afterRender(deck: Deck, map: Map): void {
16✔
347
  const {mapboxLayers} = deck.userData as UserData;
16✔
348

16✔
349
  // Draw non-Mapbox layers
16✔
350
  const mapboxLayerIds = Array.from(mapboxLayers, layer => layer.id);
16✔
351
  const deckLayers = flatten(deck.props.layers, Boolean) as Layer[];
16✔
352
  const hasNonMapboxLayers = deckLayers.some(layer => layer && !mapboxLayerIds.includes(layer.id));
16✔
353
  let viewports = deck.getViewports();
16✔
354
  const mapboxViewportIdx = viewports.findIndex(vp => vp.id === MAPBOX_VIEW_ID);
16✔
355
  const hasNonMapboxViews = viewports.length > 1 || mapboxViewportIdx < 0;
16✔
356

16✔
357
  if (hasNonMapboxLayers || hasNonMapboxViews) {
16✔
358
    if (mapboxViewportIdx >= 0) {
5✔
359
      viewports = viewports.slice();
4✔
360
      viewports[mapboxViewportIdx] = getViewport(deck, map);
4✔
361
    }
4✔
362

5✔
363
    deck._drawLayers('mapbox-repaint', {
5✔
364
      viewports,
5✔
365
      layerFilter: params =>
5✔
366
        (!deck.props.layerFilter || deck.props.layerFilter(params)) &&
9✔
367
        (params.viewport.id !== MAPBOX_VIEW_ID || !mapboxLayerIds.includes(params.layer.id)),
7✔
368
      clearCanvas: false
5✔
369
    });
5✔
370
  }
5✔
371

16✔
372
  // End of render cycle, clear generated viewport
16✔
373
  (deck.userData as UserData).currentViewport = null;
16✔
374
}
16✔
375

1✔
376
function onMapMove(deck: Deck, map: Map): void {
×
377
  deck.setProps({
×
378
    viewState: getViewState(map)
×
379
  });
×
380
  // Camera changed, will trigger a map repaint right after this
×
381
  // Clear any change flag triggered by setting viewState so that deck does not request
×
382
  // a second repaint
×
383
  deck.needsRedraw({clearRedrawFlags: true});
×
384
}
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc