From 63ffb20819f6448b83edb52e23bd0bf89ebe0c20 Mon Sep 17 00:00:00 2001
From: Yann Lanthony <yann.lanthony@gmail.com>
Date: Thu, 12 Dec 2019 19:10:08 +0100
Subject: [PATCH] [ui][3D] add EnvironmentMapEntity to display equirectangular
 images

Load EXR files in the 3D viewport as environment maps mapped on a sphere "attached"  to the camera.
* improve exr loading strategy by considering depthmaps and env maps
* update to DepthMapEntity 2.1 (required to get the loading status)
---
 meshroom/ui/qml/Viewer3D/DepthMapLoader.qml   |  2 +-
 .../ui/qml/Viewer3D/EnvironmentMapEntity.qml  | 48 +++++++++++++++++++
 meshroom/ui/qml/Viewer3D/MediaLibrary.qml     |  4 ++
 meshroom/ui/qml/Viewer3D/MediaLoader.qml      | 36 ++++++++++----
 meshroom/ui/qml/Viewer3D/Viewer3D.qml         |  1 +
 5 files changed, 82 insertions(+), 9 deletions(-)
 create mode 100644 meshroom/ui/qml/Viewer3D/EnvironmentMapEntity.qml

diff --git a/meshroom/ui/qml/Viewer3D/DepthMapLoader.qml b/meshroom/ui/qml/Viewer3D/DepthMapLoader.qml
index 32f7ae1a..0f07ff91 100644
--- a/meshroom/ui/qml/Viewer3D/DepthMapLoader.qml
+++ b/meshroom/ui/qml/Viewer3D/DepthMapLoader.qml
@@ -1,4 +1,4 @@
-import DepthMapEntity 2.0
+import DepthMapEntity 2.1
 
 /**
  * Support for Depth Map files (EXR) in Qt3d.
diff --git a/meshroom/ui/qml/Viewer3D/EnvironmentMapEntity.qml b/meshroom/ui/qml/Viewer3D/EnvironmentMapEntity.qml
new file mode 100644
index 00000000..0bd8877b
--- /dev/null
+++ b/meshroom/ui/qml/Viewer3D/EnvironmentMapEntity.qml
@@ -0,0 +1,48 @@
+import QtQuick 2.9
+import Qt3D.Core 2.1
+import Qt3D.Render 2.1
+import Qt3D.Extras 2.10
+
+
+/**
+ * EnvironmentMap maps an equirectangular image on a Sphere.
+ * The 'position' property can be used to virually attach it to a camera
+ * and get the impression of an environment at an infinite distance.
+ */
+Entity {
+    id: root
+
+    /// Source of the equirectangular image
+    property url source
+    /// Radius of the sphere
+    property alias radius: sphereMesh.radius
+    /// Number of slices of the sphere
+    property alias slices: sphereMesh.slices
+    /// Number of rings of the sphere
+    property alias rings: sphereMesh.rings
+    /// Position of the sphere
+    property alias position: transform.translation
+
+    components: [
+        SphereMesh {
+            id: sphereMesh
+            radius: 1000
+            slices: 50
+            rings: 50
+        },
+        Transform {
+            id: transform
+            translation: root.position
+        },
+        DiffuseMapMaterial {
+            ambient: "#FFF"
+            shininess: 0
+            specular: "#000"
+            diffuse: TextureLoader {
+                magnificationFilter: Texture.Linear
+                mirrored: true
+                source: root.source
+            }
+        }
+    ]
+}
diff --git a/meshroom/ui/qml/Viewer3D/MediaLibrary.qml b/meshroom/ui/qml/Viewer3D/MediaLibrary.qml
index 56af1866..6542e2db 100644
--- a/meshroom/ui/qml/Viewer3D/MediaLibrary.qml
+++ b/meshroom/ui/qml/Viewer3D/MediaLibrary.qml
@@ -16,6 +16,9 @@ Entity {
     property bool pickingEnabled: false
     readonly property alias count: instantiator.count // number of instantiated media delegates
 
+    /// Camera to consider for positionning
+    property Camera camera: null
+
     /// True while at least one media is being loaded
     readonly property bool loading: {
         for(var i=0; i<m.mediaModel.count; ++i) {
@@ -173,6 +176,7 @@ Entity {
             // source based on currentSource + "requested" property
             readonly property string finalSource: model.requested ? currentSource : ""
 
+            camera: root.camera
             renderMode: root.renderMode
             enabled: visible
 
diff --git a/meshroom/ui/qml/Viewer3D/MediaLoader.qml b/meshroom/ui/qml/Viewer3D/MediaLoader.qml
index 936197a0..831cd619 100644
--- a/meshroom/ui/qml/Viewer3D/MediaLoader.qml
+++ b/meshroom/ui/qml/Viewer3D/MediaLoader.qml
@@ -1,7 +1,7 @@
 import QtQuick 2.9
 import Qt3D.Core 2.1
 import Qt3D.Render 2.1
-import Qt3D.Extras 2.1
+import Qt3D.Extras 2.10
 import QtQuick.Scene3D 2.0
 import "Materials"
 import Utils 1.0
@@ -20,6 +20,9 @@ import Utils 1.0
     property var object: null
     property int renderMode
 
+    /// Scene's current camera
+    property Camera camera: null
+
     property bool cached: false
 
     onSourceChanged: {
@@ -44,7 +47,7 @@ import Utils 1.0
 
         switch(Filepath.extension(source)) {
             case ".abc": if(Viewer3DSettings.supportAlembic) component = abcLoaderEntityComponent; break;
-            case ".exr": if(Viewer3DSettings.supportDepthMap) component = depthMapLoaderComponent; break;
+            case ".exr": if(Viewer3DSettings.supportDepthMap) component = exrLoaderComponent; break;
             case ".obj":
             default: component = sceneLoaderEntityComponent; break;
         }
@@ -103,14 +106,31 @@ import Utils 1.0
     }
 
     Component {
-        id: depthMapLoaderComponent
+        id: exrLoaderComponent
         MediaLoaderEntity {
-            id: depthMapLoaderEntity
+            id: exrLoaderEntity
             Component.onCompleted: {
-                var obj = Viewer3DSettings.depthMapLoaderComp.createObject(depthMapLoaderEntity, {
-                                               'source': source
-                                           });
-                faceCount = Scene3DHelper.faceCount(obj);
+                // EXR loading strategy:
+                //   - [1] as a depth map
+                var obj = Viewer3DSettings.depthMapLoaderComp.createObject(
+                            exrLoaderEntity, {
+                                'source': source
+                            });
+
+                if(obj.status === SceneLoader.Ready)
+                {
+                    faceCount = Scene3DHelper.faceCount(obj);
+                    root.status = SceneLoader.Ready;
+                    return;
+                }
+
+                //   - [2] as an environment map
+                obj.destroy()
+                obj = Qt.createComponent("EnvironmentMapEntity.qml").createObject(
+                            exrLoaderEntity, {
+                                'source': source,
+                                'position': Qt.binding(function() { return root.camera.position })
+                            });
                 root.status = SceneLoader.Ready;
             }
         }
diff --git a/meshroom/ui/qml/Viewer3D/Viewer3D.qml b/meshroom/ui/qml/Viewer3D/Viewer3D.qml
index eb96d978..8451fda7 100644
--- a/meshroom/ui/qml/Viewer3D/Viewer3D.qml
+++ b/meshroom/ui/qml/Viewer3D/Viewer3D.qml
@@ -221,6 +221,7 @@ FocusScope {
                 // Picking to set focus point (camera view center)
                 // Only activate it when a double click may happen or when the 'Control' key is pressed
                 pickingEnabled: cameraController.pickingActive || doubleClickTimer.running
+                camera: cameraSelector.camera
 
                 components: [
                     Transform {