From b942eb8b694721d9f3607a8eb1c0a550f7290599 Mon Sep 17 00:00:00 2001
From: ivmartel <ivmartel@gmail.com>
Date: Wed, 30 Nov 2022 11:29:17 +0100
Subject: [PATCH] Add scroll tooltip with pixel value, fixes #1273

---
 src/app/viewController.js |  9 +++++
 src/tools/scroll.js       | 80 ++++++++++++++++++++++++++++++++++++++-
 tests/pacs/viewer.html    | 10 +++++
 3 files changed, 98 insertions(+), 1 deletion(-)

diff --git a/src/app/viewController.js b/src/app/viewController.js
index b2dbe1dce0..cb6537db33 100644
--- a/src/app/viewController.js
+++ b/src/app/viewController.js
@@ -212,6 +212,15 @@ dwv.ctrl.ViewController = function (view) {
     return value;
   };
 
+  /**
+   * Get the image pixel unit.
+   *
+   * @returns {string} The unit
+   */
+  this.getPixelUnit = function () {
+    return view.getImage().getMeta().pixelUnit;
+  };
+
   /**
    * Get some values from the associated image in a region.
    *
diff --git a/src/tools/scroll.js b/src/tools/scroll.js
index 36bfe57d78..eb6cd99a81 100644
--- a/src/tools/scroll.js
+++ b/src/tools/scroll.js
@@ -91,12 +91,22 @@ dwv.tool.Scroll = function (app) {
    */
   var wheelDeltaY = 0;
 
+  /**
+   * Option to show or not a value tooltip on mousemove.
+   *
+   * @type {boolean}
+   */
+  var displayTooltip = false;
+
   /**
    * Handle mouse down event.
    *
    * @param {object} event The mouse down event.
    */
   this.mousedown = function (event) {
+    // optional tooltip
+    removeTooltipDiv();
+
     // stop viewer if playing
     var layerDetails = dwv.gui.getLayerDetailsFromEvent(event);
     var layerGroup = app.getLayerGroupById(layerDetails.groupId);
@@ -124,6 +134,10 @@ dwv.tool.Scroll = function (app) {
    */
   this.mousemove = function (event) {
     if (!self.started) {
+      // optional tooltip
+      if (displayTooltip) {
+        showTooltip(event);
+      }
       return;
     }
 
@@ -187,6 +201,8 @@ dwv.tool.Scroll = function (app) {
    */
   this.mouseout = function (event) {
     self.mouseup(event);
+    // remove possible tooltip div
+    removeTooltipDiv();
   };
 
   /**
@@ -278,6 +294,7 @@ dwv.tool.Scroll = function (app) {
     event.context = 'dwv.tool.Scroll';
     app.onKeydown(event);
   };
+
   /**
    * Handle double click.
    *
@@ -291,13 +308,74 @@ dwv.tool.Scroll = function (app) {
     viewController.play();
   };
 
+  /**
+   * Displays a tooltip in a temparary `span`.
+   * Works with css to hide/show the span only on mouse hover.
+   *
+   * @param {object} event The mouse move event.
+   */
+  function showTooltip(event) {
+    // remove previous div
+    removeTooltipDiv();
+
+    // get image value at position
+    var layerDetails = dwv.gui.getLayerDetailsFromEvent(event);
+    var layerGroup = app.getLayerGroupById(layerDetails.groupId);
+    var viewLayer = layerGroup.getActiveViewLayer();
+    var viewController = viewLayer.getViewController();
+    var planePos = viewLayer.displayToPlanePos(event._x, event._y);
+    var position = viewController.getPositionFrom2D(planePos.x, planePos.y);
+    var value = viewController.getRescaledImageValue(position);
+
+    // create
+    if (typeof value !== 'undefined') {
+      var span = document.createElement('span');
+      span.id = 'scroll-tooltip';
+      // place span in layer group to avoid upper layer opacity
+      var layerDiv = document.getElementById(viewLayer.getId());
+      layerDiv.parentElement.appendChild(span);
+      // position tooltip
+      span.style.left = (event._x + 10) + 'px';
+      span.style.top = (event._y + 10) + 'px';
+      var text = dwv.utils.precisionRound(value, 3);
+      if (typeof viewController.getPixelUnit() !== 'undefined') {
+        text += ' ' + viewController.getPixelUnit();
+      }
+      span.appendChild(document.createTextNode(text));
+    }
+  }
+
+  /**
+   * Remove the tooltip html div.
+   */
+  function removeTooltipDiv() {
+    var div = document.getElementById('scroll-tooltip');
+    if (div) {
+      div.remove();
+    }
+  }
+
   /**
    * Activate the tool.
    *
    * @param {boolean} _bool The flag to activate or not.
    */
   this.activate = function (_bool) {
-    // does nothing
+    // remove tooltip html when deactivating
+    if (!_bool) {
+      removeTooltipDiv();
+    }
+  };
+
+  /**
+   * Set the tool live features: disaply tooltip.
+   *
+   * @param {object} features The list of features.
+   */
+  this.setFeatures = function (features) {
+    if (typeof features.displayTooltip !== 'undefined') {
+      displayTooltip = features.displayTooltip;
+    }
   };
 
   /**
diff --git a/tests/pacs/viewer.html b/tests/pacs/viewer.html
index aa76417c9f..f0e195654b 100644
--- a/tests/pacs/viewer.html
+++ b/tests/pacs/viewer.html
@@ -60,6 +60,16 @@
 .line {
   padding: 5px;
 }
+.layerGroup span {
+  display: none;
+  background-color: palegreen;
+  padding: 2px;
+}
+.layerGroup:hover span {
+  display: inline-block;
+  position: absolute;
+  overflow: hidden;
+}
 </style>
 <!-- Third party (load) -->
 <script type="text/javascript" src="../../node_modules/jszip/dist/jszip.min.js"></script>