feat(iv): add iv data and display windows overlay (#4443)

Adding data and display window overlay in iv.
Dashed line: Display window
Solid line: Data window

Off by default, select "Show display and data window borders" from the View menu.

---------

Signed-off-by: tkchanat <andychancse@gmail.com>

Author: tkchanat

src/iv/imageviewer.cpp

@@ -386,6 +386,12 @@ ImageViewer::createActions()
     //    toggleImageAct->setEnabled(true);
     connect(toggleImageAct, SIGNAL(triggered()), this, SLOT(toggleImage()));
 
+    toggleWindowGuidesAct
+        = new QAction(tr("Show display and data window borders"), this);
+    toggleWindowGuidesAct->setCheckable(true);
+    connect(toggleWindowGuidesAct, SIGNAL(triggered()), this,
+            SLOT(toggleWindowGuides()));
+
     slideShowAct = new QAction(tr("Start Slide Show"), this);
     connect(slideShowAct, SIGNAL(triggered()), this, SLOT(slideShow()));
 
@@ -674,6 +680,7 @@ ImageViewer::createMenus()
     viewMenu->addAction(prevImageAct);
     viewMenu->addAction(nextImageAct);
     viewMenu->addAction(toggleImageAct);
+    viewMenu->addAction(toggleWindowGuidesAct);
     viewMenu->addSeparator();
     viewMenu->addAction(zoomInAct);
     viewMenu->addAction(zoomOutAct);
@@ -1349,6 +1356,14 @@ ImageViewer::toggleImage()
 
 
 
+void
+ImageViewer::toggleWindowGuides()
+{
+    ((QOpenGLWidget*)(glwin))->update();
+}
+
+
+
 void
 ImageViewer::exposureMinusOneTenthStop()
 {

src/iv/imageviewer.h

@@ -223,6 +223,11 @@ class ImageViewer final : public QMainWindow {
         return showPixelviewWindowAct && showPixelviewWindowAct->isChecked();
     }
 
+    bool windowguidesOn(void) const
+    {
+        return toggleWindowGuidesAct && toggleWindowGuidesAct->isChecked();
+    }
+
     bool pixelviewFollowsMouse(void) const
     {
         return pixelviewFollowsMouseBox
@@ -268,11 +273,12 @@ private slots:
     /// change the zoom, even to fit on screen. If minsize is true, do not
     /// resize smaller than default_width x default_height.
     void fitWindowToImage(bool zoomok = true, bool minsize = false);
-    void fullScreenToggle();           ///< Toggle full screen mode
-    void about();                      ///< Show "about iv" dialog
-    void prevImage();                  ///< View previous image in sequence
-    void nextImage();                  ///< View next image in sequence
-    void toggleImage();                ///< View most recently viewed image
+    void fullScreenToggle();    ///< Toggle full screen mode
+    void about();               ///< Show "about iv" dialog
+    void prevImage();           ///< View previous image in sequence
+    void nextImage();           ///< View next image in sequence
+    void toggleImage();         ///< View most recently viewed image
+    void toggleWindowGuides();  ///< Toggle data and display window overlay
     void exposureMinusOneTenthStop();  ///< Decrease exposure 1/10 stop
     void exposureMinusOneHalfStop();   ///< Decrease exposure 1/2 stop
     void exposurePlusOneTenthStop();   ///< Increase exposure 1/10 stop
@@ -374,6 +380,7 @@ private slots:
     QAction* showInfoWindowAct;
     QAction* editPreferencesAct;
     QAction* showPixelviewWindowAct;
+    QAction* toggleWindowGuidesAct;
     QMenu *fileMenu, *editMenu, /**imageMenu,*/ *viewMenu, *toolsMenu,
         *helpMenu;
     QMenu* openRecentMenu;

src/iv/ivgl.cpp

@@ -472,6 +472,32 @@ gl_rect(float xmin, float ymin, float xmax, float ymax, float z = 0,
 
 
 
+static void
+gl_rect_border(float xmin, float ymin, float xmax, float ymax, float z = 0)
+{
+    glBegin(GL_LINE_LOOP);
+    glVertex3f(xmin, ymin, z);
+    glVertex3f(xmax, ymin, z);
+    glVertex3f(xmax, ymax, z);
+    glVertex3f(xmin, ymax, z);
+    glEnd();
+}
+
+
+
+static void
+gl_rect_dotted_border(float xmin, float ymin, float xmax, float ymax,
+                      float z = 0)
+{
+    glPushAttrib(GL_ENABLE_BIT);
+    glLineStipple(1, 0xF0F0);
+    glEnable(GL_LINE_STIPPLE);
+    gl_rect_border(xmin, ymin, xmax, ymax, z);
+    glPopAttrib();
+}
+
+
+
 static void
 handle_orientation(int orientation, int width, int height, float& scale_x,
                    float& scale_y, float& rotate_z, float& point_x,
@@ -634,6 +660,10 @@ IvGL::paintGL()
         }
     }
 
+    if (m_viewer.windowguidesOn()) {
+        paint_windowguides();
+    }
+
     glPopMatrix();
 
     if (m_viewer.pixelviewOn()) {
@@ -908,6 +938,41 @@ IvGL::paint_pixelview()
 
 
 
+void
+IvGL::paint_windowguides()
+{
+    IvImage* img = m_current_image;
+    const ImageSpec& spec(img->spec());
+
+    glDisable(GL_TEXTURE_2D);
+    glUseProgram(0);
+    glPushAttrib(GL_ENABLE_BIT);
+    glEnable(GL_COLOR_LOGIC_OP);
+    glLogicOp(GL_XOR);
+
+    // Data window
+    {
+        const float xmin = spec.x;
+        const float xmax = spec.x + spec.width;
+        const float ymin = spec.y;
+        const float ymax = spec.y + spec.height;
+        gl_rect_border(xmin, ymin, xmax, ymax);
+    }
+
+    // Display window
+    {
+        const float xmin = spec.full_x;
+        const float xmax = spec.full_x + spec.full_width;
+        const float ymin = spec.full_y;
+        const float ymax = spec.full_y + spec.full_height;
+        gl_rect_dotted_border(xmin, ymin, xmax, ymax);
+    }
+
+    glPopAttrib();
+}
+
+
+
 void
 IvGL::useshader(int tex_width, int tex_height, bool pixelview)
 {

src/iv/ivgl.h

@@ -151,6 +151,7 @@ class IvGL : public QOpenGLWidget, protected QOpenGLExtraFunctions {
     void focusOutEvent(QFocusEvent* event) override;
 
     void paint_pixelview();
+    void paint_windowguides();
     void glSquare(float xmin, float ymin, float xmax, float ymax, float z = 0);
 
     virtual void create_shaders(void);