Sky Implementation according to spec #3645

prozessor13 · 2024-01-30T08:57:36Z

This PR is a successor of #1713 which is working with the actual maplibre-codebase. Writing Tests is still an open issue for which i currently do not have any time :/

codecov-commenter · 2024-01-30T09:06:16Z

Codecov Report

Attention: Patch coverage is 92.83489% with 23 lines in your changes missing coverage. Please review.

Project coverage is 87.77%. Comparing base (863541f) to head (592ded2).
Report is 25 commits behind head on main.

✅ All tests successful. No failed tests found.

Files	Patch %	Lines
src/render/mesh.ts	61.90%	8 Missing ⚠️
src/style/sky.ts	91.95%	3 Missing and 4 partials ⚠️
src/render/program/terrain_program.ts	82.14%	0 Missing and 5 partials ⚠️
src/style/style.ts	95.45%	0 Missing and 2 partials ⚠️
src/style/light.ts	87.50%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3645      +/-   ##
==========================================
- Coverage   87.91%   87.77%   -0.14%     
==========================================
  Files         242      246       +4     
  Lines       33082    33361     +279     
  Branches     2158     2219      +61     
==========================================
+ Hits        29084    29283     +199     
- Misses       3029     3056      +27     
- Partials      969     1022      +53

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

src/geo/transform.ts

HarelM · 2024-01-31T13:59:29Z

I've opened the following issue for the spec as I have forgot to add the diff part of the sky to the relevant place in the code.
maplibre/maplibre-style-spec#517

src/shaders/terrain.fragment.glsl

src/style/sky.ts

src/style/style.ts

src/ui/map.ts

test/examples/3d-terrain.html

HarelM · 2024-01-31T14:11:43Z

Thanks for putting this together again!!
@acalcutt do you want to open a PR against this branch to add tests instead of this PR:

Sky fog test #2974

@ibesora do we want to wait with this PR for GSoC or can we change plans in case of this being completed before the program starts?

acalcutt · 2024-02-01T05:51:25Z

Thanks for putting this together again!! @acalcutt do you want to open a PR against this branch to add tests instead of this PR:

Sky fog test #2974

I've never been the best at adding test, but I added a few expect tests in
#3648

HarelM · 2024-02-01T14:12:26Z

@prozessor13 can I delete sky branch and leave only sky2?

HarelM · 2024-02-01T14:25:08Z

@acalcutt feel free to fix the unit tests as well while you are at it :-)

acalcutt · 2024-02-01T20:18:41Z

I'm not sure I understand those errors

Error: TypeError: painter.transform.calculateFogMatrix is not a function

    at drawTerrain (src/render/draw_terrain.ts:88:45)
    at RenderToTexture.renderLayer (src/render/render_to_texture.ts:[18](https://github.com/maplibre/maplibre-gl-js/actions/runs/7742575082/job/21112014472?pr=3645#step:6:19)7:24)
    at Object.<anonymous> (src/render/render_to_texture.test.ts:119:20)

isn't it a function?

maplibre-gl-js/src/geo/transform.ts

Lines 724 to 736 in 32ae12b

    
           calculateFogMatrix(unwrappedTileID: UnwrappedTileID): mat4 { 
        
               const posMatrixKey = unwrappedTileID.key; 
        
               const cache = this._fogMatrixCache; 
        
               if (cache[posMatrixKey]) { 
        
                   return cache[posMatrixKey]; 
        
               } 
        
               const fogMatrix = this.calculateTileMatrix(unwrappedTileID); 
        
               mat4.multiply(fogMatrix, this.fogMatrix, fogMatrix); 
        
               cache[posMatrixKey] = new Float32Array(fogMatrix); 
        
               return cache[posMatrixKey]; 
        
           }

HarelM · 2024-02-01T22:58:13Z

The tests are mocking stuff, if the mock doesn't have a function that the test need you'll see this error.
I'll take a look later this week.

ibesora · 2024-02-02T06:44:23Z

@ibesora do we want to wait with this PR for GSoC or can we change plans in case of this being completed before the program starts?

I don’t think it’s worth waiting for GSoC if this is good to go… but we’ll need to find something else for GSoC. I didn’t realize this was so close to being done

* try to fix calculateFogMatrix error * Raise expectedBytes for maplibre-gl.js size

HarelM · 2024-02-02T09:46:11Z

I've merged the tests fix, and merged main branch.
Let's see what the coverage is reporting and decide how to continue.

test/build/min.test.ts

HarelM · 2024-02-02T10:00:53Z

but we’ll need to find something else for GSoC

Increasing coverage is always an option.
Helping the globe effort might be a good idea too.
Supporting multiple coordinate systems is always high up.
Improving performance.
Ping me on slack if you want to brain storm.

HarelM · 2024-06-22T21:05:31Z

I've added the relevant unit test to make sure the bug won't happen in the future.
I also moved a sky test under a sky folder.
@louwers note that merging this to main, which should happen soon might create an issue with the parity render tests, this is expected, I have created a folder named sky to hold other sky related tests so you can ignore them until the native parity is completed.

Pheonor

Adding the fog call systematically, even when not used could propably be avoided with a simple chech in the painter class.

src/render/painter.ts

src/render/draw_sky.ts

src/style/style.ts

…o sky2

HarelM · 2024-06-26T06:44:47Z

This is now ready to be merged. I'll merge it tomorrow if there's no new review changes requirements.

docs/guides/large-data.md

HarelM · 2024-06-27T07:14:52Z

Good luck to us all.
I'm pushing the button.

### Motivation Upgrade maplibre to latest version, so we can have sky box support. maplibre/maplibre-gl-js#3645 ### Modifications ### Verification

chrisgervang · 2024-07-30T23:19:58Z

src/ui/map_tests/map_style.test.ts

@@ -475,4 +475,44 @@ describe('#getStyle', () => {
        expect(spy).not.toHaveBeenCalled();
    });

+    describe('#setSky', () => {


How should one unset the sky? (revert back to the default white). It seems calling setSky({}) doesn't do it, and setSky() isn't allowed by the typing but reverts back to white, as desired.. could the type just need a tweak?

Does setSky(undefined) works?

setSky() and setSky(undefined) work, but then reversing it seems to not work quite right. Turning the sky off is no problem, but then calling setSky with the same sky object as before doesn't render until the sky color value is different.

sky_toggle.mov

I think the typescript type should be relaxed to accept undefined.

Feel free to submit a PR to fix this, probably a missing implementation for this case...

Uranbold · 2024-09-11T02:04:56Z

Hello guys. Will that fog-ground-blend work on 2D? I'm using the fog ground but it looks like this.

HarelM · 2024-09-11T06:22:51Z

Fog was only added to the terrain...

Uranbold · 2024-09-12T02:37:58Z

a Vector map with Fog will look cool. Please consider it :)

HarelM · 2024-09-12T07:57:43Z

Sure will, you should consider taking the time to implement this and open a PR :-)

Max Demmelbauer added 2 commits January 19, 2024 08:10

copy code from old sky branch, but this branch is not ready yet

ae58a36

add missing _fogMatrixCache clearance

5af7c1c

ibesora mentioned this pull request Jan 31, 2024

Call for Google Summer of Code 2024 Projects, Mentors & Contributors maplibre/maplibre#355

Closed