gui: add background controls to display controls

Signed-off-by: Peter Gadfort <gadfort@zeroasic.com>

Author: gadfort

src/gui/src/displayControls.cpp

@@ -489,6 +489,7 @@ DisplayControls::DisplayControls(QWidget* parent)
 
   region_color_ = QColor(0x70, 0x70, 0x70, 0x70);  // semi-transparent mid-gray
   region_pattern_ = Qt::SolidPattern;
+  background_color_ = Qt::black;
   makeLeafItem(misc_.scale_bar, "Scale bar", misc, Qt::Checked);
   makeLeafItem(misc_.access_points, "Access points", misc, Qt::Unchecked);
   makeLeafItem(
@@ -499,6 +500,8 @@ DisplayControls::DisplayControls(QWidget* parent)
   makeLeafItem(
       misc_.manufacturing_grid, "Manufacturing grid", misc, Qt::Unchecked);
   makeLeafItem(misc_.gcell_grid, "GCell grid", misc, Qt::Unchecked);
+  makeLeafItem(
+      misc_.background, "Background", misc, {}, false, background_color_);
   toggleParent(misc_group_);
 
   checkLiberty();
@@ -523,6 +526,8 @@ DisplayControls::DisplayControls(QWidget* parent)
           this,
           &DisplayControls::itemContextMenu);
 
+  connect(
+      this, &DisplayControls::colorChanged, this, &DisplayControls::changed);
   // register renderers
   if (gui::Gui::get() != nullptr) {
     for (auto renderer : gui::Gui::get()->renderers()) {
@@ -604,7 +609,9 @@ void DisplayControls::writeSettingsForRow(QSettings* settings,
                           name->child(r, Selectable));
     }
   } else {
-    settings->setValue("visible", asBool(visible));
+    if (visible != nullptr) {
+      settings->setValue("visible", asBool(visible));
+    }
     if (selectable != nullptr) {
       settings->setValue("selectable", asBool(selectable));
     }
@@ -643,7 +650,9 @@ void DisplayControls::readSettingsForRow(QSettings* settings,
                          name->child(r, Selectable));
     }
   } else {
-    visible->setCheckState(getChecked(settings, "visible", visible));
+    if (visible != nullptr) {
+      visible->setCheckState(getChecked(settings, "visible", visible));
+    }
     if (selectable != nullptr) {
       selectable->setCheckState(getChecked(settings, "selectable", selectable));
     }
@@ -680,6 +689,7 @@ void DisplayControls::readSettings(QSettings* settings)
 
   settings->beginGroup("other");
   settings->beginGroup("color");
+  getColor(misc_.background, background_color_, "background");
   getColor(
       blockages_.blockages, placement_blockage_color_, "blockages_placement");
   getColor(rulers_, ruler_color_, "ruler");
@@ -753,6 +763,7 @@ void DisplayControls::writeSettings(QSettings* settings)
 
   settings->beginGroup("other");
   settings->beginGroup("color");
+  settings->setValue("background", background_color_);
   settings->setValue("blockages_placement", placement_blockage_color_);
   settings->setValue("ruler", ruler_color_);
   settings->setValue("instance_name", instance_name_color_);
@@ -876,7 +887,9 @@ void DisplayControls::toggleParent(const QStandardItem* parent,
 
 void DisplayControls::toggleParent(ModelRow& row)
 {
-  toggleParent(row.name, row.visible, Visible);
+  if (row.visible != nullptr) {
+    toggleParent(row.name, row.visible, Visible);
+  }
   if (row.selectable != nullptr) {
     toggleParent(row.name, row.selectable, Selectable);
   }
@@ -1001,7 +1014,9 @@ void DisplayControls::displayItemDblClicked(const QModelIndex& index)
     bool has_sibling = false;
 
     // check if placement
-    if (color_item == blockages_.blockages.swatch) {
+    if (color_item == misc_.background.swatch) {
+      item_color = &background_color_;
+    } else if (color_item == blockages_.blockages.swatch) {
       item_color = &placement_blockage_color_;
       item_pattern = &placement_blockage_pattern_;
     } else if (color_item == misc_.regions.swatch) {
@@ -1065,7 +1080,7 @@ void DisplayControls::displayItemDblClicked(const QModelIndex& index)
         *item_pattern = display_dialog->getSelectedPattern();
       }
       view_->repaint();
-      emit changed();
+      emit colorChanged();
     }
   }
 }
@@ -1291,7 +1306,7 @@ QStandardItem* DisplayControls::makeParentItem(ModelRow& row,
 void DisplayControls::makeLeafItem(ModelRow& row,
                                    const QString& text,
                                    QStandardItem* parent,
-                                   Qt::CheckState checked,
+                                   std::optional<Qt::CheckState> checked,
                                    bool add_selectable,
                                    const QColor& color,
                                    const QVariant& user_data)
@@ -1309,16 +1324,18 @@ void DisplayControls::makeLeafItem(ModelRow& row,
     row.swatch->setData(user_data, user_data_item_idx_);
   }
 
-  row.visible = new QStandardItem("");
-  row.visible->setCheckable(true);
-  row.visible->setEditable(false);
-  row.visible->setCheckState(checked);
+  if (checked.has_value()) {
+    row.visible = new QStandardItem("");
+    row.visible->setCheckable(true);
+    row.visible->setEditable(false);
+    row.visible->setCheckState(checked.value());
+  }
 
   if (add_selectable) {
     row.selectable = new QStandardItem("");
     row.selectable->setCheckable(true);
     row.selectable->setEditable(false);
-    row.selectable->setCheckState(checked);
+    row.selectable->setCheckState(checked.value_or(Qt::Unchecked));
   }
 
   parent->appendRow({row.name, row.swatch, row.visible, row.selectable});
@@ -1354,6 +1371,11 @@ QIcon DisplayControls::makeSwatchIcon(const QColor& color)
   return QIcon(swatch);
 }
 
+QColor DisplayControls::background()
+{
+  return background_color_;
+}
+
 QColor DisplayControls::color(const dbTechLayer* layer)
 {
   auto it = layer_color_.find(layer);

src/gui/src/displayControls.h

@@ -20,6 +20,7 @@
 #include <QVBoxLayout>
 #include <functional>
 #include <map>
+#include <optional>
 #include <set>
 #include <string>
 #include <vector>
@@ -166,6 +167,7 @@ class DisplayControls : public QDockWidget,
   void restoreTclCommands(std::vector<std::string>& cmds);
 
   // From the Options API
+  QColor background() override;
   QColor color(const odb::dbTechLayer* layer) override;
   Qt::BrushStyle pattern(const odb::dbTechLayer* layer) override;
   QColor placementBlockageColor() override;
@@ -236,6 +238,7 @@ class DisplayControls : public QDockWidget,
  signals:
   // The display options have changed and clients need to update
   void changed();
+  void colorChanged();
 
   // Emit a selected tech layer
   void selected(const Selected& selected);
@@ -368,6 +371,7 @@ class DisplayControls : public QDockWidget,
     ModelRow module;
     ModelRow manufacturing_grid;
     ModelRow gcell_grid;
+    ModelRow background;
   };
 
   struct InstanceShapeModels
@@ -415,7 +419,7 @@ class DisplayControls : public QDockWidget,
   void makeLeafItem(ModelRow& row,
                     const QString& text,
                     QStandardItem* parent,
-                    Qt::CheckState checked,
+                    std::optional<Qt::CheckState> checked,
                     bool add_selectable = false,
                     const QColor& color = Qt::transparent,
                     const QVariant& user_data = QVariant());
@@ -530,6 +534,8 @@ class DisplayControls : public QDockWidget,
 
   std::map<const odb::dbSite*, QColor> site_color_;
 
+  QColor background_color_;
+
   QColor placement_blockage_color_;
   Qt::BrushStyle placement_blockage_pattern_;
 

src/gui/src/layoutTabs.cpp

@@ -43,6 +43,22 @@ LayoutTabs::LayoutTabs(Options* options,
   connect(this, &QTabWidget::currentChanged, this, &LayoutTabs::tabChange);
 }
 
+void LayoutTabs::updateBackgroundColors()
+{
+  for (LayoutViewer* viewer : viewers_) {
+    updateBackgroundColor(viewer);
+    viewer->fullRepaint();
+  }
+}
+
+void LayoutTabs::updateBackgroundColor(LayoutViewer* viewer)
+{
+  QPalette palette;
+  palette.setColor(QPalette::Window, options_->background());
+  viewer->setPalette(palette);
+  viewer->setAutoFillBackground(true);
+}
+
 void LayoutTabs::blockLoaded(odb::dbBlock* block)
 {
   // Check if we already have a tab for this block
@@ -80,12 +96,7 @@ void LayoutTabs::blockLoaded(odb::dbBlock* block)
   const auto name = fmt::format("{} ({})", block->getName(), tech->getName());
   addTab(scroll, name.c_str());
 
-  // This has to be done after addTab.  For unexplained reasons it
-  // doesn't work for all users if done in LayoutViewer::LayoutViewer.
-  QPalette palette;
-  palette.setColor(QPalette::Window, LayoutViewer::background());
-  viewer->setPalette(palette);
-  viewer->setAutoFillBackground(true);
+  updateBackgroundColor(viewer);
 
   // forward signals from the viewer upward
   connect(viewer, &LayoutViewer::location, this, &LayoutTabs::location);

src/gui/src/layoutTabs.h

@@ -77,6 +77,8 @@ class LayoutTabs : public QTabWidget
 
  public slots:
   void tabChange(int index);
+  void updateBackgroundColors();
+  void updateBackgroundColor(LayoutViewer* viewer);
 
   // These are just forwarding to the current LayoutViewer
   void zoomIn();

src/gui/src/layoutViewer.cpp

@@ -1733,10 +1733,15 @@ void LayoutViewer::updatePixmap(const QImage& image, const QRect& bounds)
 void LayoutViewer::drawLoadingIndicator(QPainter* painter, const QRect& bounds)
 {
   const QRect background = computeIndicatorBackground(painter, bounds);
+  const QColor background_color = options_->background();
 
-  painter->fillRect(background, Qt::black);  // to help visualize
+  painter->fillRect(background, background_color);  // to help visualize
 
-  painter->setPen(QPen(Qt::white, 2));
+  const QColor text_color(255 - background_color.red(),
+                          255 - background_color.green(),
+                          255 - background_color.blue());
+
+  painter->setPen(QPen(text_color, 2));
   painter->drawText(background.left(),
                     background.bottom(),
                     QString::fromStdString(loading_indicator_));
@@ -2096,7 +2101,7 @@ void LayoutViewer::saveImage(const QString& filepath,
                       highlighted_,
                       rulers_,
                       render_ratio,
-                      background());
+                      options_->background());
   pixels_per_dbu_ = old_pixels_per_dbu;
 
   if (!img.save(save_filepath)) {

src/gui/src/layoutViewer.h

@@ -254,8 +254,6 @@ class LayoutViewer : public QWidget
   void commandFinishedExecuting();
   void executionPaused();
 
-  static QColor background() { return Qt::black; }
-
  private slots:
   void setBlock(odb::dbBlock* block);
   void updatePixmap(const QImage& image, const QRect& bounds);

src/gui/src/mainWindow.cpp

@@ -150,6 +150,10 @@ MainWindow::MainWindow(bool load_settings, QWidget* parent)
           &LayoutTabs::executionPaused);
   connect(
       controls_, &DisplayControls::changed, viewers_, &LayoutTabs::fullRepaint);
+  connect(controls_,
+          &DisplayControls::colorChanged,
+          viewers_,
+          &LayoutTabs::updateBackgroundColors);
   connect(controls_,
           &DisplayControls::changed,
           hierarchy_widget_,

src/gui/src/options.h

@@ -21,6 +21,7 @@ class Options
 {
  public:
   virtual ~Options() {}
+  virtual QColor background() = 0;
   virtual QColor color(const odb::dbTechLayer* layer) = 0;
   virtual Qt::BrushStyle pattern(const odb::dbTechLayer* layer) = 0;
   virtual QColor placementBlockageColor() = 0;