[3D] add support for gl_clipdistance (part 1) #57899
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tests failed for Qt 6One or more tests failed using the build from commit b3e8f7e pointcloud_3d_singlecolor (testPointCloudSingleColor)pointcloud_3d_singlecolorTest failed at testPointCloudSingleColor at tests/src/3d/testqgspointcloud3drendering.cpp:276
pointcloud_3d_colorramp (testPointCloudAttributeByRamp)pointcloud_3d_colorrampTest failed at testPointCloudAttributeByRamp at tests/src/3d/testqgspointcloud3drendering.cpp:316
pointcloud_3d_classification (testPointCloudClassification)pointcloud_3d_classificationTest failed at testPointCloudClassification at tests/src/3d/testqgspointcloud3drendering.cpp:353
pointcloud_3d_classification_pointsizes (testPointCloudClassificationOverridePointSizes)pointcloud_3d_classification_pointsizesTest failed at testPointCloudClassificationOverridePointSizes at tests/src/3d/testqgspointcloud3drendering.cpp:392
pointcloud_3d_filtered_classification (testPointCloudFilteredClassification)pointcloud_3d_filtered_classificationTest failed at testPointCloudFilteredClassification at tests/src/3d/testqgspointcloud3drendering.cpp:430
pointcloud_3d_filtered_scene_extent (testPointCloudFilteredSceneExtent)pointcloud_3d_filtered_scene_extentTest failed at testPointCloudFilteredSceneExtent at tests/src/3d/testqgspointcloud3drendering.cpp:472
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. |
Tests failed for Qt 5One or more tests failed using the build from commit b3e8f7e pointcloud_3d_singlecolor (testPointCloudSingleColor)pointcloud_3d_singlecolorTest failed at testPointCloudSingleColor at tests/src/3d/testqgspointcloud3drendering.cpp:276
pointcloud_3d_colorramp (testPointCloudAttributeByRamp)pointcloud_3d_colorrampTest failed at testPointCloudAttributeByRamp at tests/src/3d/testqgspointcloud3drendering.cpp:316
pointcloud_3d_classification (testPointCloudClassification)pointcloud_3d_classificationTest failed at testPointCloudClassification at tests/src/3d/testqgspointcloud3drendering.cpp:353
pointcloud_3d_classification_pointsizes (testPointCloudClassificationOverridePointSizes)pointcloud_3d_classification_pointsizesTest failed at testPointCloudClassificationOverridePointSizes at tests/src/3d/testqgspointcloud3drendering.cpp:392
pointcloud_3d_filtered_classification (testPointCloudFilteredClassification)pointcloud_3d_filtered_classificationTest failed at testPointCloudFilteredClassification at tests/src/3d/testqgspointcloud3drendering.cpp:430
pointcloud_3d_filtered_scene_extent (testPointCloudFilteredSceneExtent)pointcloud_3d_filtered_scene_extentTest failed at testPointCloudFilteredSceneExtent at tests/src/3d/testqgspointcloud3drendering.cpp:472
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. |
nyalldawson
reviewed
Jun 26, 2024
| @@ -179,7 +180,7 @@ class _3D_EXPORT QgsAbstractMaterialSettings SIP_ABSTRACT | |||
| * The \a technique argument specifies the rendering technique which will be used with the returned | |||
| * material. | |||
| */ | |||
| virtual Qt3DRender::QMaterial *toMaterial( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const = 0 SIP_FACTORY; | |||
| virtual Qt3DRender::QMaterial *toMaterial( const Qgs3DMapSettings &mapSettings, QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const = 0 SIP_FACTORY; | |||
There was a problem hiding this comment.
@wonder-sk is this safe? Qgs3DMapSettings is a QObject, but AFAICS we are accessing this on non-main threads. (Both in master and more so with this PR).
I'd argue we should be moving the properties required for material / symbol / entity creation to a different class which is cheap to copy and not a QObject, and then pass this new class around for uses like this.
There was a problem hiding this comment.
@nyalldawson Do you prefer we create a function in Qgs3DMapSettings to extract a simple struct (with the needed values) to pass as parameter in toMaterial?
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.
ptitjano
force-pushed
the
3d-clip-part1
branch
2 times, most recently
from
656cf3c
to
6718c15
Compare
ptitjano
changed the title
benoitdm-oslandia
approved these changes
Jul 11, 2024
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 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 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 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.
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 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 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.
|
hi @ptitjano - sorry for taking so long to review this PR (holiday season is in full swing!) Thanks a lot for your efforts, going the route of clipping planes! It would be great to split this kind of work into smaller bits, it would make the review easier (e.g. one PR for addition of new materials, one PR for phong shaders refactoring, one PR for addition of clipping planes). As for the code changes:
I think the Phong material implementation needs to be cleaned up and clipping planes implementation needs to be updated before we can merge this... |
This was referenced Jul 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for gl_clipdistance as suggested by @wonder-sk in #57593 (review)
This allows to properly cut objects which are outside of the 3d scene extent. Contrary to #57593 it does not contain the rotation part. It will be added in a following PR. This is still useful in the general case to propery cut the objects at the border of the scene:
without gl_clipdistance
with gl_clipdistance
The PR itself is quite simple. 3 changes are needed:
Qt3DRender::QClipPlanein the framegraph to addgl_clipDistancesupportFor each material:
-call
Qgs3DUtils::addBoundingBoxParametersToEffectto define the plane equation as uniform for the equationgl_clipistancein each vertex or geometry shader by callingsetClipDistance(see shaders/clipplane.inc)The other changes provide some cleanup in the materials to limit the number of shader files and reduce the maintenance burden.
This should work for all the data sources (raster, vector, mesh, pointcloud, etc..)