[3D] add support for gl_clipdistance + scene rotation (part 2) #58051

ptitjano · 2024-07-10T09:27:48Z

Description

This PR achieves the same result as #57593 but with the gl_clipDistance approach from #57899

It is possible to limit the extent of a 3d view. However, the extents is always axis aligned: it is aligned with the true north. This PR adds the possibility to define a rotation angle around the Z axis. This way, the previously axis aligned extent can now have an arbitrary azimuth.

Previously, it was possible to fully describe the extent with a QgsRectangle. Now, a more general QgsOrientedBox3D is used to describe the limits of the scene. This allows to define a custom Z rotation. Then, the ClipPlane equations from #57899 are updated to take into account the rotation.

A new 3d extent widget is introduced. It allows to properly set a custom orientation

An example

This PR contains the commits from #57899

This is not used at the moment. It will be used in the following commits to define the clip plane equations.

There is no need to define a special vertex shader code for this material, it can use the default case. This way, it reduces the number of vertex shader files.

This will be used by `QgsPhongMaterialSettings` in the next commit.

This commit makes two changes to `QgsPhongMaterialSettings`: 1. It merges `dataDefinedMaterial()` and `constantColorMaterial` into one new function: `buildMaterial`. 2. The fragment shader files `phongDataDefined.frag` and `phongConstant.frag` are merged into a new file `phong.frag`. This is achieved by a `#define` logic. If `DATA_DEFINED` is defined, this is the dataDefined case. Otherwise, this is the constant case.

This is similar to the previous QgsPhongMaterialSettings change: This commit makes two changes to `QgsGoochMaterialSettings`: 1. It merges `dataDefinedMaterial()` and `constantColorMaterial` into one new function: `buildMaterial`. 2. There is one fragment shader file called `gooch.frag`. This is achieved by a `#define` logic. If `DATA_DEFINED` is defined, this is the dataDefined case. Otherwise, this is the constant case.

There is no need to define a special vertex shader code for this material, it can use the default case. This way, it reduces the number of vertex shader files.

This is the same material as the qt3d one: `Qt3DExtras::QTextureMaterial`. It will also be used in the following commits to define the gl_ClipDistance for the textured terrain.

This is the same material as the qt3d one: `Qt3DExtras::QgsMaskedTexturedMaterial`. It will also be used in the following commits to define the gl_ClipDistance for the non texture case of the terrain.

There is no functional change. It is simply needed to add gl_ClipDistance support to the terrain shaders in the next commits.

`Qt3DRender::QClipPlane` enable OpenGL clipping plane that can be used in shaders using gl_ClipDistance. This change adds 4 clipPlane. This will be used to clip the 3dScene at Xmin / Xmax / Ymin / Ymax. This change has no effect at the moment because `gl_ClipDistance` needs to be computed in each vertex or geometry shader file. This will be achieved in the following commits.

github-actions · 2024-07-10T11:41:56Z

🪟 Windows builds ready!

Windows builds of this PR are available for testing here. Debug symbols for this build are available here.

(Built from commit f7b807c)

github-actions · 2024-07-10T13:26:34Z

Tests failed for Qt 6

One or more tests failed using the build from commit c5e2cfc

flat_terrain_filtered_3 (testFilteredFlatTerrain)

flat_terrain_filtered_3

Test failed at testFilteredFlatTerrain at tests/src/3d/testqgs3drendering.cpp:1489

Rendered image did not match tests/testdata/control_images/3d/expected_flat_terrain_filtered_3/expected_flat_terrain_filtered_3.png (found 17267 pixels different)

pointcloud_3d_filtered_scene_extent_rotation (testPointCloudFilteredSceneExtent)

pointcloud_3d_filtered_scene_extent_rotation

Test failed at testPointCloudFilteredSceneExtent at tests/src/3d/testqgspointcloud3drendering.cpp:522

Rendered image did not match tests/testdata/control_images/3d/expected_pointcloud_3d_filtered_scene_extent_rotation/expected_pointcloud_3d_filtered_scene_extent_rotation.png (found 1615 pixels different)

The full test report (included comparison of rendered vs expected images) can be found here.

Further documentation on the QGIS test infrastructure can be found in the Developer's Guide.

This is achieved with two changes: 1. define the plane equation as uniform with the `Qgs3DUtils::addBoundingBoxParametersToEffect` call 2. include `clipplane.inc` file in the vertex shader file and call setClipDistance() With these changes, the planes defined in the framegraph are used. The associated unit test needs to be updated because the objects at the border of the scene are now partially cut.

All the existing parameters are stored in `Qgs3DMapSettings`. Therefore, `Qgs3DMapSettings` can be directly used.

This is achieved with two changes: 1. define the plane equation as uniform with the `Qgs3DUtils::addBoundingBoxParametersToEffect` call 2. include `clipplane.inc` file in the vertex shader file and call setClipDistance() With these changes, the planes defined in the framegraph are used.

This one is a little bit to the other ones. Indeed, lines has a geometry shader with redefine gl_Position. Therefore, gl_ClipDistance needs to be computed in the geometry shader file. With these changes, the planes defined in the framegraph are used.

wonder-sk · 2024-07-18T21:38:56Z

The usability of the 3D extent widget worries me a lot - if I understand correctly, one needs to pick a 2D extent (axis aligned), and then set rotation afterwards? That would be IMHO quite tricky to properly pick some rotated area of interest.

I believe what would work better is some kind of 3D box (or 2D box in 2D map canvas) that can be moved around interactively with mouse in 3D or 2D canvas, expanded/collapsed and rotated - just like what CloudCompare or Potree offer...

ptitjano · 2024-07-19T09:52:01Z

The usability of the 3D extent widget worries me a lot - if I understand correctly, one needs to pick a 2D extent (axis aligned), and then set rotation afterwards? That would be IMHO quite tricky to properly pick some rotated area of interest.

I believe what would work better is some kind of 3D box (or 2D box in 2D map canvas) that can be moved around interactively with mouse in 3D or 2D canvas, expanded/collapsed and rotated - just like what CloudCompare or Potree offer...

I agree that this would be a nice feature. However, the main use case for this rotation parameter is for people who already know the coordinates of the box. They won't draw a box on the 3D/2D canvas. They need a dialog box to enter Xmin/Xmax Ymin/Ymax and the rotation angle. This is exactly what this PR achieves.

At the moment, it is only possible to draw an axis aligned box on the 2d canvas. With this PR, there is no usability regression, it is still possible. I agree that this is tricky to draw a rotated area of interest. But on current master, it is impossible. Besides, when I first proposed it, the first comments noted that this was an edge case. Again, I'm trying to accommodate people who already know the coordinates of the area of interest and want to type them.

I have already made the following changes:

do some opengl clipping
store the coordinates in a QgsOrientedBox3D
completely rewrite the material logic with the introduction of a base class

I agreed to make all these changes because I truly believe they are good things and it would have been difficult to improve the situation with the previous approach.

The feature you are proposing will likely take months to develop. I would like to move forward. We can defer it to a future PR and discuss it later to have a solution we all agree on.

Thanks for all your comments and review work.
Also, I'm gonna be on vacation for the next two weeks. So don't be surprised if I don't answer.

nyalldawson · 2024-07-23T04:15:16Z

I agree that this would be a nice feature. However, the main use case for this rotation parameter is for people who already know the coordinates of the box. They won't draw a box on the 3D/2D canvas. They need a dialog box to enter Xmin/Xmax Ymin/Ymax and the rotation angle. This is exactly what this PR achieves.

For the record, I don't particularly like the new widget either. I don't think all the near-duplicate code is needed vs the existing extent widget, and I don't like that it's appearance is completely different from the other one.

Here's what I'd propose as a middle ground/way forward

Leave the API as is, with the rectangle extent + rotation property
Drop the custom extent+rotation widget, and consequently don't show the rotation property as a user-settable property by default
Make sure the rotation property is exposed to sip and accessible to plugins, and then write a small plugin which allows users to set the rotation clipping for 3d views

What do you think?

github-actions · 2024-08-07T02:42:12Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

github-actions · 2024-08-24T02:45:46Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

github-actions · 2024-09-10T02:45:55Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

qgis-bot · 2024-09-24T08:41:14Z

@ptitjano

This pull request has been tagged for the changelog.

The description will be harvested so please provide a "nearly-ready" text for the final changelog
If possible, add a nice illustration of the feature. Only the first one in the description will be harvested (GIF accepted as well)
If you can, it's better to give credits to your sponsor, see below for different formats.

You can edit the description.

Format available for credits

Funded by NAME
Funded by URL
Funded by NAME URL
Sponsored by NAME
Sponsored by URL
Sponsored by NAME URL

Thank you!

github-actions · 2024-10-09T02:47:24Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

github-actions · 2024-12-18T02:50:04Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

github-actions · 2024-12-26T02:47:10Z

While we hate to see this happen, this PR has been automatically closed because it has not had any activity in the last 21 days. If this pull request should be reconsidered, please follow the guidelines in the previous comment and reopen this pull request. Or, if you have any further questions, just ask! We love to help, and if there's anything the QGIS project can do to help push this PR forward please let us know how we can assist.

github-actions · 2025-01-24T02:46:15Z

The QGIS project highly values your contribution and would love to see this work merged! Unfortunately this PR has not had any activity in the last 14 days and is being automatically marked as "stale". If you think this pull request should be merged, please check

that all unit tests are passing
that all comments by reviewers have been addressed
that there is enough information for reviewers, in particular
- link to any issues which this pull request fixes
- add a description of workflows which this pull request fixes
- add screenshots if applicable
that you have written unit tests where possible
In case you should have any uncertainty, please leave a comment and we will be happy to help you proceed with this pull request.
If there is no further activity on this pull request, it will be closed in a week.

ptitjano added 11 commits July 2, 2024 18:11

qgsabstractmaterialsettings: Add mapSettings parameter to toMaterial

268e2f9

This is not used at the moment. It will be used in the following commits to define the clip plane equations.

qgsphongmaterialsettings: Use default vertex for the constant case

bc19fab

There is no need to define a special vertex shader code for this material, it can use the default case. This way, it reduces the number of vertex shader files.

qgsmetalroughmaterial: Move add addDefinesToShaderCode to Qgs3DUtils

7ea241f

This will be used by `QgsPhongMaterialSettings` in the next commit.

qgsphongtexturedmaterialsettings: Use default.vert vertex

e51eb79

There is no need to define a special vertex shader code for this material, it can use the default case. This way, it reduces the number of vertex shader files.

qgsmetalroughmaterial: Add qgs3dmapsettings parameter

c1d16c1

3d: Introduce QgsTextureMaterial

34e88e8

This is the same material as the qt3d one: `Qt3DExtras::QTextureMaterial`. It will also be used in the following commits to define the gl_ClipDistance for the textured terrain.

3d: Introduce QgsDiffuseSpecularMaterial

4be6e52

This is the same material as the qt3d one: `Qt3DExtras::QgsMaskedTexturedMaterial`. It will also be used in the following commits to define the gl_ClipDistance for the non texture case of the terrain.

terrain: use QgsTextureMaterial and QgsDiffuseSpecularMaterial

f48b6b4

There is no functional change. It is simply needed to add gl_ClipDistance support to the terrain shaders in the next commits.

github-actions bot added this to the 3.40.0 milestone Jul 10, 2024

ptitjano mentioned this pull request Jul 10, 2024

[3D] Add support for a rotated 3d scene #57593

Closed

ptitjano self-assigned this Jul 10, 2024

ptitjano added Feature 3D Relates to QGIS' 3D engine or rendering labels Jul 10, 2024

ptitjano force-pushed the 3d-clip-part2-rotate branch 2 times, most recently from e24ff44 to 8ea3d0b Compare July 10, 2024 09:59

ptitjano force-pushed the 3d-clip-part2-rotate branch from 8ea3d0b to 93909c8 Compare July 10, 2024 13:21

ptitjano force-pushed the 3d-clip-part2-rotate branch 2 times, most recently from c5e2cfc to f7b807c Compare July 10, 2024 17:45

ptitjano added 7 commits July 12, 2024 09:25

qgsdemterraintileloader: Simplify createTextureComponent signature

d29b940

All the existing parameters are stored in `Qgs3DMapSettings`. Therefore, `Qgs3DMapSettings` can be directly used.

ptitjano force-pushed the 3d-clip-part2-rotate branch from f7b807c to 583ead4 Compare July 12, 2024 07:33

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Aug 7, 2024

ptitjano removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Aug 9, 2024

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Aug 24, 2024

ptitjano removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Aug 26, 2024

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Sep 10, 2024

nyalldawson added the Freeze Exempt Feature Freeze exemption granted label Sep 13, 2024

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Sep 14, 2024

zacharlie added the Changelog Items that are queued to appear in the visual changelog - remove after harvesting label Sep 24, 2024

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 9, 2024

ptitjano removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Oct 9, 2024

nyalldawson added Frozen Feature freeze - Do not merge! and removed Freeze Exempt Feature Freeze exemption granted labels Oct 17, 2024

nyalldawson removed the Frozen Feature freeze - Do not merge! label Dec 3, 2024

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Dec 18, 2024

github-actions bot closed this Dec 26, 2024

ptitjano reopened this Jan 9, 2025

github-actions bot removed the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jan 9, 2025

github-actions bot added the stale Uh oh! Seems this work is abandoned, and the PR is about to close. label Jan 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3D] add support for gl_clipdistance + scene rotation (part 2) #58051

[3D] add support for gl_clipdistance + scene rotation (part 2) #58051

ptitjano commented Jul 10, 2024

github-actions bot commented Jul 10, 2024 •

edited

Loading

github-actions bot commented Jul 10, 2024 •

edited

Loading

wonder-sk commented Jul 18, 2024

ptitjano commented Jul 19, 2024

nyalldawson commented Jul 23, 2024

github-actions bot commented Aug 7, 2024

github-actions bot commented Aug 24, 2024

github-actions bot commented Sep 10, 2024

qgis-bot commented Sep 24, 2024

github-actions bot commented Oct 9, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 26, 2024

github-actions bot commented Jan 24, 2025

[3D] add support for gl_clipdistance + scene rotation (part 2) #58051

Are you sure you want to change the base?

[3D] add support for gl_clipdistance + scene rotation (part 2) #58051

Conversation

ptitjano commented Jul 10, 2024

Description

github-actions bot commented Jul 10, 2024 • edited Loading

🪟 Windows builds ready!

github-actions bot commented Jul 10, 2024 • edited Loading

Tests failed for Qt 6

flat_terrain_filtered_3 (testFilteredFlatTerrain)

flat_terrain_filtered_3

pointcloud_3d_filtered_scene_extent_rotation (testPointCloudFilteredSceneExtent)

pointcloud_3d_filtered_scene_extent_rotation

wonder-sk commented Jul 18, 2024

ptitjano commented Jul 19, 2024

nyalldawson commented Jul 23, 2024

github-actions bot commented Aug 7, 2024

github-actions bot commented Aug 24, 2024

github-actions bot commented Sep 10, 2024

qgis-bot commented Sep 24, 2024

github-actions bot commented Oct 9, 2024

github-actions bot commented Dec 18, 2024

github-actions bot commented Dec 26, 2024

github-actions bot commented Jan 24, 2025

github-actions bot commented Jul 10, 2024 •

edited

Loading

github-actions bot commented Jul 10, 2024 •

edited

Loading