Globe - custom layers API and examples, globe dev guide #4577

kubapelc · 2024-08-19T08:14:54Z

This PR adds:

extended API for custom layers that makes writing custom layers for globe easier
examples of globe custom layers:
- a simple triangle
- custom tiles
- a 3D model on a globe)
a writeup / guide of how globe projecton works

Follow the links to read the writeup and see the globe custom layer examples. The custom layer args are now projection-dependent, are filled in by the transform class, and allow the user to write custom layers that under both projections.

kubapelc · 2024-08-19T08:16:20Z

@HarelM Please ping people who should also review the custom layer API.

codecov-commenter · 2024-08-19T08:17:58Z

Codecov Report

Attention: Patch coverage is 82.33216% with 50 lines in your changes missing coverage. Please review.

Project coverage is 87.49%. Comparing base (ed1437e) to head (0870639).
Report is 69 commits behind head on globe.

Files with missing lines	Patch %	Lines
src/geo/projection/globe_transform.ts	29.03%	22 Missing ⚠️
src/geo/projection/mercator_transform.ts	69.76%	13 Missing ⚠️
src/util/create_tile_mesh.ts	89.09%	8 Missing and 4 partials ⚠️
src/source/tile_id.ts	66.66%	2 Missing ⚠️
src/render/draw_custom.ts	94.73%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            globe    #4577      +/-   ##
==========================================
- Coverage   87.56%   87.49%   -0.07%     
==========================================
  Files         262      263       +1     
  Lines       37166    37293     +127     
  Branches     2588     2559      -29     
==========================================
+ Hits        32545    32631      +86     
- Misses       3556     3602      +46     
+ Partials     1065     1060       -5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

test/examples/globe-custom-simple.html

test/examples/globe-custom-tiles.html

src/render/draw_custom.ts

src/geo/projection/mercator_transform.ts

src/geo/projection/globe_utils.ts

klokan · 2024-08-19T09:42:17Z

Sounds amazing! Thanks @kubapelc

src/render/draw_custom.ts

developer-guides/globe.md

…sform directly

Co-authored-by: Harel M <harel.mazor@gmail.com>

src/render/program/projection_program.ts

src/util/create_tile_mesh.ts

src/render/program/projection_program.ts

src/style/style_layer/custom_style_layer.ts

src/util/create_tile_mesh.ts

Rename fields to camelCase, move it to a separate file

Fails other than raster-warped were caused by increasing pos matrix precision in mercator_transform to 64 bit floats

src/render/program/projection_program.ts

Co-authored-by: Harel M <harel.mazor@gmail.com>

src/util/create_tile_mesh.ts

test/examples/globe-3d-model.html

HarelM · 2024-08-26T11:43:08Z

@ibesora let me know if you have other concerns before I merge this into the globe branch.

# Conflicts: # test/build/min.test.ts # test/integration/render/tests/projection/globe/raster-planet/expected-flaky.png # test/integration/render/tests/projection/globe/raster-warped/expected-win-flaky4.png

HarelM · 2024-08-27T09:22:15Z

Let's remember to update the changelog with the breaking change that was done as part of this PR before we merge this to main and create version 5. It is tracked as part of #3834 in general.

kubapelc added 5 commits August 19, 2024 09:13

Port custom layer changes and globe docs

645e7f6

Port transform changes

77b1a46

Fix custom layer unit test

0081170

Fix failing render tests

2a068f3

Update build size

51d0a58