redesign mask editor so it shows already while editing what you will get (WYSIWYG)

This removes the necessity of ROI to implement the "show" button, to see the masking effects.

In a further step the mask presenter (which uses ROI functionality) could be removed, which was the motivation for the refactoring/redesign in the context of "remove ROI".

GUI/Views/MaskWidgets/EllipseView.cpp

@@ -46,15 +46,6 @@ void EllipseView::onPropertyChange(const QString& propertyName)
     }
 }
 
-void EllipseView::paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*)
-{
-    painter->setRenderHints(QPainter::Antialiasing);
-    bool mask_value = m_item->getItemValue(MaskItem::P_MASK_VALUE).toBool();
-    painter->setBrush(MaskEditorHelper::getMaskBrush(mask_value));
-    painter->setPen(MaskEditorHelper::getMaskPen(mask_value));
-    painter->drawEllipse(m_mask_rect);
-}
-
 void EllipseView::mouseMoveEvent(QGraphicsSceneMouseEvent* event)
 {
     if (m_activeHandleElement) {
@@ -105,6 +96,13 @@ void EllipseView::mouseMoveEvent(QGraphicsSceneMouseEvent* event)
     }
 }
 
+QPainterPath EllipseView::shape() const
+{
+    QPainterPath path;
+    path.addEllipse(m_mask_rect);
+    return path;
+}
+
 //! updates position of view using item properties
 
 void EllipseView::update_position()

GUI/Views/MaskWidgets/EllipseView.h

@@ -29,13 +29,13 @@ public:
     EllipseView();
 
 protected slots:
-    virtual void onChangedX();
-    virtual void onChangedY();
-    virtual void onPropertyChange(const QString& propertyName);
+    virtual void onChangedX() override;
+    virtual void onChangedY() override;
+    virtual void onPropertyChange(const QString& propertyName) override;
 
 protected:
-    void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*);
-    void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
+    virtual QPainterPath shape() const override;
+    virtual void mouseMoveEvent(QGraphicsSceneMouseEvent* event) override;
 
 private:
     void update_position();

GUI/Views/MaskWidgets/IShape2DView.cpp

@@ -16,6 +16,7 @@
 #include "GUI/Models/MaskItems.h"
 #include "GUI/Views/MaskWidgets/ISceneAdaptor.h"
 #include <QAction>
+#include <QGraphicsScene>
 #include <QGraphicsSceneContextMenuEvent>
 #include <QMenu>
 #include <QPainter>
@@ -78,6 +79,46 @@ void IShape2DView::setSceneAdaptor(const ISceneAdaptor* adaptor)
     }
 }
 
+void IShape2DView::paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*)
+{
+    const bool isMasked = m_item->getItemValue(MaskItem::P_MASK_VALUE).toBool();
+    painter->setBrush(MaskEditorHelper::getMaskBrush(isMasked));
+    painter->setPen(MaskEditorHelper::getMaskPen(isMasked));
+    painter->setRenderHints(QPainter::Antialiasing);
+    painter->drawPath(maskedShape());
+}
+
+QPainterPath IShape2DView::maskedShape() const
+{
+    static const QSet<MaskEditorHelper::EViewTypes> relevantMaskTypes = {
+        MaskEditorHelper::RECTANGLE, MaskEditorHelper::POLYGON, MaskEditorHelper::VERTICALLINE,
+        MaskEditorHelper::HORIZONTALLINE, MaskEditorHelper::ELLIPSE};
+
+    QPainterPath resultingShape = mapToScene(shape());
+    for (auto item : scene()->items()) {
+        const auto maskItem = dynamic_cast<IShape2DView*>(item);
+        if (!maskItem
+            || !relevantMaskTypes.contains((MaskEditorHelper::EViewTypes)maskItem->type()))
+            continue;
+
+        const bool isMaskingItem =
+            maskItem->parameterizedItem()->getItemValue(MaskItem::P_MASK_VALUE).toBool();
+        const bool isOnTop = maskItem->zValue() > zValue();
+        if (isMaskingItem || !isOnTop)
+            continue;
+
+        const auto maskItemShape = maskItem->mapToScene(maskItem->shape());
+        if (!maskItemShape.intersects(resultingShape))
+            continue;
+
+        // Item lays on top and is non-masking -> subtract the
+        // path of the item
+        resultingShape = resultingShape.subtracted(maskItemShape);
+    }
+
+    return mapFromScene(resultingShape);
+}
+
 double IShape2DView::par(const QString& property_name) const
 {
     return m_item->getItemValue(property_name).toReal();

GUI/Views/MaskWidgets/IShape2DView.h

@@ -50,6 +50,11 @@ protected slots:
     virtual void onPropertyChange(const QString&) {}
 
 protected:
+    virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*) override;
+
+    //! Returns the shape with all masking already applied.
+    QPainterPath maskedShape() const;
+
     double par(const QString& property_name) const;
     qreal toSceneX(const QString& property_name) const;
     qreal toSceneX(qreal value) const;

GUI/Views/MaskWidgets/LineViews.cpp

@@ -32,6 +32,13 @@ VerticalLineView::VerticalLineView()
     setCursor(Qt::SizeHorCursor);
 }
 
+QPainterPath VerticalLineView::shape() const
+{
+    QPainterPath p;
+    p.addRect(QRectF(-mask_visible_width / 2., 0.0, mask_visible_width, m_bounding_rect.height()));
+    return p;
+}
+
 void VerticalLineView::onChangedX()
 {
     setBlockOnProperty(true);
@@ -96,6 +103,14 @@ HorizontalLineView::HorizontalLineView()
     setCursor(Qt::SizeVerCursor);
 }
 
+QPainterPath HorizontalLineView::shape() const
+{
+    QPainterPath path;
+    path.addRect(
+        QRectF(0.0, -mask_visible_width / 2., m_bounding_rect.width(), mask_visible_width));
+    return path;
+}
+
 void HorizontalLineView::onChangedY()
 {
     setBlockOnProperty(true);

GUI/Views/MaskWidgets/LineViews.h

@@ -26,6 +26,7 @@ public:
     int type() const { return MaskEditorHelper::VERTICALLINE; }
 
     VerticalLineView();
+    virtual QPainterPath shape() const override;
 
 protected slots:
     virtual void update_view();
@@ -46,6 +47,7 @@ public:
     int type() const { return MaskEditorHelper::HORIZONTALLINE; }
 
     HorizontalLineView();
+    virtual QPainterPath shape() const override;
 
 protected slots:
     virtual void update_view();

GUI/Views/MaskWidgets/MaskEditorHelper.cpp

@@ -33,14 +33,10 @@ QPen MaskEditorHelper::getSelectionMarkerPen()
 
 QBrush MaskEditorHelper::getMaskBrush(bool mask_value)
 {
-    QBrush result;
-    result.setStyle(Qt::SolidPattern);
-    if (mask_value) {
-        result.setColor(QColor(209, 109, 97)); // deep red
-    } else {
-        result.setColor(QColor(0, 213, 106)); // deep green
-    }
-    return result;
+    if (!mask_value)
+        return Qt::NoBrush;
+
+    return QBrush(QColor(0, 0, 80)); // deep blue
 }
 
 QPen MaskEditorHelper::getMaskPen(bool mask_value)

GUI/Views/MaskWidgets/PolygonView.cpp

@@ -59,6 +59,14 @@ QPointF PolygonView::lastAddedPoint() const
     return childItems().size() ? childItems().back()->scenePos() : QPointF();
 }
 
+QPainterPath PolygonView::shape() const
+{
+    QPainterPath path;
+    path.addPolygon(m_polygon);
+    path.closeSubpath();
+    return path;
+}
+
 //! Returns true if there was a request to close polygon (emitted by its start point),
 //! and then closes a polygon. Returns true if polygon was closed.
 bool PolygonView::closePolygonIfNecessary()
@@ -86,21 +94,17 @@ bool PolygonView::isClosedPolygon()
     return m_item->getItemValue(PolygonItem::P_ISCLOSED).toBool();
 }
 
-void PolygonView::paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*)
+void PolygonView::paint(QPainter* painter, const QStyleOptionGraphicsItem* o, QWidget* w)
 {
-    ASSERT(m_item);
-    painter->setRenderHints(QPainter::Antialiasing);
-
-    bool mask_value = m_item->getItemValue(MaskItem::P_MASK_VALUE).toBool();
-    painter->setBrush(MaskEditorHelper::getMaskBrush(mask_value));
-    painter->setPen(MaskEditorHelper::getMaskPen(mask_value));
-
-    // painter->drawRect(m_bounding_rect);
-
-    painter->drawPolyline(m_polygon.toPolygon());
-
     if (isClosedPolygon())
-        painter->drawPolygon(m_polygon.toPolygon());
+        IShape2DView::paint(painter, o, w);
+    else {
+        ASSERT(m_item);
+        const bool mask_value = m_item->getItemValue(MaskItem::P_MASK_VALUE).toBool();
+        painter->setRenderHints(QPainter::Antialiasing);
+        painter->setPen(MaskEditorHelper::getMaskPen(mask_value));
+        painter->drawPolyline(m_polygon.toPolygon());
+    }
 }
 
 QVariant PolygonView::itemChange(QGraphicsItem::GraphicsItemChange change, const QVariant& value)

GUI/Views/MaskWidgets/PolygonView.h

@@ -31,6 +31,7 @@ public:
     void addView(IShape2DView* childView, int row);
     bool isClosedPolygon();
     QPointF lastAddedPoint() const;
+    virtual QPainterPath shape() const override;
 
 public slots:
     bool closePolygonIfNecessary();
@@ -40,7 +41,7 @@ protected slots:
     void update_view();
 
 protected:
-    void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*);
+    virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*) override;
     QVariant itemChange(GraphicsItemChange change, const QVariant& value);
     void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
 

GUI/Views/MaskWidgets/RectangleBaseView.cpp

@@ -75,8 +75,9 @@ void RectangleBaseView::update_bounding_rect()
 {
     if (m_item) {
         m_mask_rect = mask_rectangle();
-        m_bounding_rect = m_mask_rect.marginsAdded(
-            QMarginsF(bbox_margins, bbox_margins, bbox_margins, bbox_margins));
+        if (type() != MaskEditorHelper::REGIONOFINTEREST)
+            m_bounding_rect = m_mask_rect.marginsAdded(
+                QMarginsF(bbox_margins, bbox_margins, bbox_margins, bbox_margins));
     }
     for (QMap<SizeHandleElement::EHandleLocation, SizeHandleElement*>::iterator it =
              m_resize_handles.begin();

GUI/Views/MaskWidgets/RectangleView.cpp

@@ -19,6 +19,13 @@
 
 RectangleView::RectangleView() = default;
 
+QPainterPath RectangleView::shape() const
+{
+    QPainterPath path;
+    path.addRect(m_mask_rect);
+    return path;
+}
+
 void RectangleView::onChangedX()
 {
     setBlockOnProperty(true);
@@ -41,14 +48,6 @@ void RectangleView::onPropertyChange(const QString& propertyName)
         update_view();
 }
 
-void RectangleView::paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*)
-{
-    bool mask_value = m_item->getItemValue(MaskItem::P_MASK_VALUE).toBool();
-    painter->setBrush(MaskEditorHelper::getMaskBrush(mask_value));
-    painter->setPen(MaskEditorHelper::getMaskPen(mask_value));
-    painter->drawRect(m_mask_rect);
-}
-
 void RectangleView::mouseMoveEvent(QGraphicsSceneMouseEvent* event)
 {
     if (m_activeHandleElement) {

GUI/Views/MaskWidgets/RectangleView.h

@@ -27,14 +27,13 @@ public:
     int type() const { return MaskEditorHelper::RECTANGLE; }
 
     RectangleView();
-
+    virtual QPainterPath shape() const override;
 protected slots:
     virtual void onChangedX();
     virtual void onChangedY();
     virtual void onPropertyChange(const QString& propertyName);
 
 protected:
-    void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*);
     void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
 
 protected:

GUI/Views/MaskWidgets/RegionOfInterestView.cpp

@@ -13,16 +13,29 @@
 //  ************************************************************************************************
 
 #include "GUI/Views/MaskWidgets/RegionOfInterestView.h"
+#include "GUI/Views/MaskWidgets/ISceneAdaptor.h"
 #include <QPainter>
 
-//! Paints two-color tiny frame without filling.
+QRectF RegionOfInterestView::boundingRect() const
+{
+    return mapFromScene(m_adaptor->viewportRectangle()).boundingRect();
+}
+
+void RegionOfInterestView::update_view()
+{
+    RectangleView::update_view();
+    m_bounding_rect = m_adaptor->viewportRectangle();
+    update();
+}
 
 void RegionOfInterestView::paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*)
 {
-    painter->setPen(QPen(QColor(34, 67, 255)));
-    painter->drawRect(m_mask_rect);
+    QPainterPath outerRect;
+    outerRect.addRect(boundingRect());
+
+    QPainterPath innerRect;
+    innerRect.addRect(m_mask_rect);
 
-    QRectF secondRect = m_mask_rect.marginsAdded(QMarginsF(1, 1, 1, 1));
-    painter->setPen(QPen(QColor(255, 255, 245)));
-    painter->drawRect(secondRect);
+    painter->setBrush(MaskEditorHelper::getMaskBrush(true));
+    painter->drawPath(outerRect.subtracted(innerRect));
 }

GUI/Views/MaskWidgets/RegionOfInterestView.h

@@ -24,6 +24,10 @@ class RegionOfInterestView : public RectangleView {
 
 public:
     int type() const { return MaskEditorHelper::REGIONOFINTEREST; }
+    virtual QRectF boundingRect() const;
+
+protected slots:
+    void update_view();
 
 protected:
     void paint(QPainter* painter, const QStyleOptionGraphicsItem*, QWidget*);