add SLiMgui color scales window to Help menu

Author: bhaller

QtSLiM/QtSLiMAppDelegate.cpp

@@ -850,40 +850,46 @@ void QtSLiMAppDelegate::addActionsForGlobalMenuItems(QWidget *window)
     }
     {
         QAction *actionShowCycle_WF = new QAction("Show WF Tick Cycle", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowCycle_WF->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowCycle_WF, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showCycle_WF);
         window->addAction(actionShowCycle_WF);
     }
     {
         QAction *actionShowCycle_nonWF = new QAction("Show nonWF Tick Cycle", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowCycle_nonWF->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowCycle_nonWF, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showCycle_nonWF);
         window->addAction(actionShowCycle_nonWF);
     }
     {
         QAction *actionShowCycle_WF_MS = new QAction("Show WF Tick Cycle (Multispecies)", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowCycle_WF_MS->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowCycle_WF_MS, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showCycle_WF_MS);
         window->addAction(actionShowCycle_WF_MS);
     }
     {
         QAction *actionShowCycle_nonWF_MS = new QAction("Show nonWF Tick Cycle (Multispecies)", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowCycle_nonWF_MS->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowCycle_nonWF_MS, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showCycle_nonWF_MS);
         window->addAction(actionShowCycle_nonWF_MS);
     }
     {
         QAction *actionShowColorChart = new QAction("Show Color Chart", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowColorChart->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowColorChart, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showColorChart);
         window->addAction(actionShowColorChart);
     }
     {
         QAction *actionShowPlotSymbols = new QAction("Show Plot Symbols", this);
-        //actionAbout->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        //actionShowPlotSymbols->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
         connect(actionShowPlotSymbols, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showPlotSymbols);
         window->addAction(actionShowPlotSymbols);
     }
+    {
+        QAction *actionShowColorScales = new QAction("Show SLiMgui Color Scales", this);
+        //actionShowColorScales->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
+        connect(actionShowColorScales, &QAction::triggered, qtSLiMAppDelegate, &QtSLiMAppDelegate::dispatch_showColorScales);
+        window->addAction(actionShowColorScales);
+    }
     {
         QAction *actionHelp = new QAction("Help", this);
         //actionHelp->setShortcut(flagsAndKey(Qt::ControlModifier, Qt::Key_Comma));
@@ -1311,6 +1317,43 @@ void QtSLiMAppDelegate::dispatch_showPlotSymbols(void)
         QtSLiMMakeWindowVisibleAndExposed(imageWindow);
 }
 
+void QtSLiMAppDelegate::dispatch_showColorScales(void)
+{
+    // This shows a global window that displays SLiMgui's color scales.  Unlike the above global image
+    // windows shown by globalImageWindowWithPath(), this window is drawn dynamically by a custom widget.
+    // This code is based on the code in globalImageWindowWithPath(), with that custom widget.
+    int window_width = round(301);
+    int window_height = round(197);
+    
+    QWidget *image_window = new QWidget(nullptr, Qt::Window | Qt::Tool);    // a parentless standalone window
+    
+    image_window->setWindowTitle("SLiMgui Color Scales");
+    image_window->setFixedSize(window_width, window_height);
+    
+    // Make the custom widget
+    QtSLiMColorScaleWidget *colorScaleView = new QtSLiMColorScaleWidget(image_window);
+    
+    // Install imageView in the window
+    QVBoxLayout *topLayout = new QVBoxLayout;
+    
+    image_window->setLayout(topLayout);
+    topLayout->setContentsMargins(0, 0, 0, 0);
+    topLayout->setSpacing(0);
+    topLayout->addWidget(colorScaleView);
+    
+    // Position the window nicely
+    //positionNewSubsidiaryWindow(image_window);
+    
+    // make window actions for all global menu items
+    // this does not seem to be necessary on macOS, but maybe it is on Linux; will need testing FIXME
+    //qtSLiMAppDelegate->addActionsForGlobalMenuItems(this);
+    
+    image_window->setAttribute(Qt::WA_DeleteOnClose, true);
+    
+    if (image_window)
+        QtSLiMMakeWindowVisibleAndExposed(image_window);
+}
+
 void QtSLiMAppDelegate::dispatch_help(void)
 {
     QtSLiMHelpWindow &helpWindow = QtSLiMHelpWindow::instance();

QtSLiM/QtSLiMAppDelegate.h

@@ -114,6 +114,7 @@ public slots:
     void dispatch_showCycle_nonWF_MS(void);
     void dispatch_showColorChart(void);
     void dispatch_showPlotSymbols(void);
+    void dispatch_showColorScales(void);
     void dispatch_help(void);
     void dispatch_quit(void);
 

QtSLiM/QtSLiMExtras.cpp

@@ -277,6 +277,138 @@ void RGBForSelectionCoeff(double value, float *colorRed, float *colorGreen, floa
 	}
 }
 
+QtSLiMColorScaleWidget::QtSLiMColorScaleWidget(QWidget *p_parent) : QWidget(p_parent),
+    fitnessTicks({"0.0", "0.5", "1.0", "1.5", "2.0"}),
+    effectTicks({"-1.0", "-0.5", "0.0", "0.5", "1.0"})
+{
+    setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Ignored);
+}
+
+void QtSLiMColorScaleWidget::paintEvent(QPaintEvent * /*p_paintEvent*/)
+{
+    // we're designed to fit in a fixed size of 301 x 197; see dispatch_showColorScales()
+    //QRect overallRect = contentsRect();
+    QPainter painter(this);
+    QRect stripe1 = QRect(15, 33, 271, 20);     // odd width so we have a central pixel of exactly yellow
+    QRect stripe2 = QRect(15, 105, 271, 20);    // odd width so we have a central pixel of exactly yellow
+    
+    static QFont *labelFont = nullptr;
+    
+    if (!labelFont)
+    {
+        labelFont = new QFont();
+#ifdef __linux__
+        labelFont->setPointSize(10);
+#else
+        labelFont->setPointSize(12);
+#endif
+        labelFont->setBold(true);
+    }
+    painter.setFont(*labelFont);
+    
+    const double labelYOffset = -8;
+    
+    // Fitness color scale
+    painter.drawText(stripe1.x(), stripe1.y() + labelYOffset, "Individual fitness scale:");
+    
+    for (int x = stripe1.left() + 1; x <= (stripe1.left() + 1) + (stripe1.width() - 3); ++x)
+    {
+        const double scalingFactor = 0.8;   // this is constant in QtSLiM; there used to be a slider
+        QRect sliver(x, stripe1.top() + 1, 1, stripe1.height() - 2);
+        double sliverFraction = (x - (stripe1.left() + 1)) / (stripe1.width() - 3.0);
+        double fitness = sliverFraction * 2.0;     // cover fitness values of 0.0 to 2.0
+        float r, g, b;
+        RGBForFitness(fitness, &r, &g, &b, scalingFactor);
+        painter.fillRect(sliver, QColor(round(r * 255), round(g * 255), round(b * 255)));
+    }
+    
+    QtSLiMFrameRect(stripe1, Qt::black, painter);
+    
+    // Mutation effect color scale
+    painter.drawText(stripe2.x(), stripe2.y() + labelYOffset, "Mutation effect scale:");
+    
+    for (int x = stripe2.left() + 1; x <= (stripe2.left() + 1) + (stripe2.width() - 3); ++x)
+    {
+        const double scalingFactor = 0.8;   // this is constant in QtSLiM; there used to be a slider
+        QRect sliver(x, stripe2.top() + 1, 1, stripe2.height() - 2);
+        double sliverFraction = (x - (stripe2.left() + 1)) / (stripe2.width() - 3.0);
+        double fitness = sliverFraction * 2.0 - 1;     // cover mutation effect values of -1.0 to 1.0
+        float r, g, b;
+        RGBForSelectionCoeff(fitness, &r, &g, &b, scalingFactor);
+        painter.fillRect(sliver, QColor(round(r * 255), round(g * 255), round(b * 255)));
+        
+        //qDebug() << "x =" << x << " << sliverFraction =" << sliverFraction << " fitness =" << fitness;
+    }
+    
+    QtSLiMFrameRect(stripe2, Qt::black, painter);
+    
+    // Draw axis scales
+    static QFont *tickFont = nullptr;
+    
+    if (!tickFont)
+    {
+        tickFont = new QFont();
+#ifdef __linux__
+        tickFont->setPointSize(8);
+#else
+        tickFont->setPointSize(10);
+#endif
+    }
+    painter.setFont(*tickFont);
+    
+    QFontMetricsF fontMetrics(*tickFont);
+    
+    for (int tickIndex = 0; tickIndex < 5; tickIndex++)
+    {
+        bool longTick = (tickIndex % 2 == 0);
+        int tickX = round(stripe1.left() + 1 + (tickIndex / 4.0) * (stripe1.width() - 3.0));
+        QString tickLabel;
+        double tickLabelWidth;
+        
+        // label stripe 1
+        tickLabel = fitnessTicks[tickIndex];
+        
+#if (QT_VERSION < QT_VERSION_CHECK(5, 11, 0))
+        tickLabelWidth = fontMetrics.width(tickLabel);               // deprecated in 5.11
+#else
+        tickLabelWidth = fontMetrics.horizontalAdvance(tickLabel);   // added in Qt 5.11
+#endif
+        
+        painter.fillRect(tickX, stripe1.bottom() + 1, 1, longTick ? 4 : 2, Qt::black);
+        painter.drawText(QPointF(tickX - tickLabelWidth / 2.0 + 1, stripe1.bottom() + 16), tickLabel);
+        
+        // label stripe 2
+        tickLabel = effectTicks[tickIndex];
+        
+#if (QT_VERSION < QT_VERSION_CHECK(5, 11, 0))
+        tickLabelWidth = fontMetrics.width(tickLabel);               // deprecated in 5.11
+#else
+        tickLabelWidth = fontMetrics.horizontalAdvance(tickLabel);   // added in Qt 5.11
+#endif
+        
+        painter.fillRect(tickX, stripe2.bottom() + 1, 1, longTick ? 4 : 2, Qt::black);
+        painter.drawText(QPointF(tickX - tickLabelWidth / 2.0 + 1, stripe2.bottom() + 16), tickLabel);
+    }
+    
+    // add final notes in italic
+    static QFont *noteFont = nullptr;
+    
+    if (!noteFont)
+    {
+        noteFont = new QFont();
+#ifdef __linux__
+        noteFont->setPointSize(9);
+#else
+        noteFont->setPointSize(11);
+#endif
+        noteFont->setItalic(true);
+    }
+    painter.setFont(*noteFont);
+    
+    painter.drawText(stripe1.x(), stripe2.bottom() + 44, "Yellow indicates neutrality on both color scales.");
+    painter.drawText(stripe1.x(), stripe2.bottom() + 58, "Both scales fade out to white for large values.");
+}
+
 // A subclass of QLineEdit that selects all its text when it receives keyboard focus
 // thanks to https://stackoverflow.com/a/51807268/2752221
 QtSLiMGenerationLineEdit::QtSLiMGenerationLineEdit(const QString &contents, QWidget *p_parent) : QLineEdit(contents, p_parent)

QtSLiM/QtSLiMExtras.h

@@ -36,6 +36,7 @@
 #include <QStatusBar>
 #include <QPlainTextEdit>
 #include <QLabel>
+#include <QStaticText>
 
 #include <cmath>
 #include <algorithm>
@@ -68,6 +69,16 @@ QColor QtSLiMColorWithHSV(double p_hue, double p_saturation, double p_value, dou
 void RGBForFitness(double fitness, float *colorRed, float *colorGreen, float *colorBlue, double scalingFactor);
 void RGBForSelectionCoeff(double selectionCoeff, float *colorRed, float *colorGreen, float *colorBlue, double scalingFactor);
 
+// A color scale widget that shows the color scales for fitness and selection coefficients
+class QtSLiMColorScaleWidget : public QWidget
+{
+public:
+    QtSLiMColorScaleWidget(QWidget *p_parent);
+protected:
+    virtual void paintEvent(QPaintEvent *p_paintEvent) override;
+private:
+    std::vector<QString> fitnessTicks, effectTicks;
+};
 
 // Whether we're in "dark mode" for user interface rendering
 bool QtSLiMInDarkMode(void);    

QtSLiM/QtSLiMScriptTextEdit.cpp

@@ -3154,7 +3154,7 @@ void QtSLiMScriptTextEdit::highlightCurrentLine()
             // check when/how the message is sent
         }
 
-        qDebug() << "highlightCurrentLine() with position" << selection.cursor.selectionStart();
+        //qDebug() << "highlightCurrentLine() with position" << selection.cursor.selectionStart();
 
         extra_selections.append(selection);
     }