Provide feedback when the Terrain Brush can't find some tiles (#3778)

When the Terrain Brush and Wang Fill Mode can't find some tiles, these locations are now marked in red and the text "Missing terrain transition" appears on the status bar. This change does not affect the Stamp Brush in Wang Fill Mode for now, and the "Missing terrain transition" text only appears for the Terrain Brush.
mapeditor · Aug 4, 2023 · 396eeff · 396eeff
1 parent fb2390a
commit 396eeff
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 61 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,7 @@
 ### Unreleased
 
 * Added support for setting custom properties on the project (#2903)
+* Added feedback when Terrain Brush and Terrain Fill Mode can't find a tile
 * Removed Space and Ctrl+Space shortcuts from Layers view to avoid conflict with panning (#3672)
 * Display the image base name for unnamed tile objects referring to single images
 * Scripting: Added API for editing tile layers using terrain sets (with a-morphous, #3758)

diff --git a/src/tiled/abstracttilefilltool.cpp b/src/tiled/abstracttilefilltool.cpp
@@ -22,6 +22,7 @@
 #include "brushitem.h"
 #include "mapdocument.h"
 #include "stampactions.h"
+#include "wangbrush.h"
 #include "wangfiller.h"
 
 #include <QAction>
@@ -32,9 +33,10 @@ AbstractTileFillTool::AbstractTileFillTool(Id id,
                                            const QString &name,
                                            const QIcon &icon,
                                            const QKeySequence &shortcut,
-                                           BrushItem *brushItem,
                                            QObject *parent)
-    : AbstractTileTool(id, name, icon, shortcut, brushItem, parent)
+    : AbstractTileTool(id, name, icon, shortcut,
+                       new WangBrushItem,
+                       parent)
     , mFillMethod(TileFill)
     , mStampActions(new StampActions(this))
     , mWangSet(nullptr)
@@ -194,6 +196,8 @@ void AbstractTileFillTool::updatePreview(const QRegion &fillRegion)
     mFillBounds = fillRegion.boundingRect();
     auto preview = SharedMap::create(mapDocument()->map()->parameters());
 
+    static_cast<WangBrushItem*>(brushItem())->setInvalidTiles(QRegion());
+
     switch (mFillMethod) {
     case TileFill:
         fillWithStamp(*preview, mStamp, fillRegion);
@@ -230,6 +234,8 @@ void AbstractTileFillTool::updatePreview(const QRegion &fillRegion)
 void AbstractTileFillTool::clearOverlay()
 {
     brushItem()->clear();
+    static_cast<WangBrushItem*>(brushItem())->setInvalidTiles(QRegion());
+
     mPreviewMap.clear();
 }
 
@@ -289,6 +295,8 @@ void AbstractTileFillTool::wangFill(TileLayer &tileLayerToFill,
     WangFiller wangFiller(*mWangSet, backgroundTileLayer, mapDocument()->renderer());
     wangFiller.setRegion(region);
     wangFiller.apply(tileLayerToFill);
+
+    static_cast<WangBrushItem*>(brushItem())->setInvalidTiles(wangFiller.invalidRegion());
 }
 
 void AbstractTileFillTool::fillWithStamp(Map &map,

diff --git a/src/tiled/abstracttilefilltool.h b/src/tiled/abstracttilefilltool.h
@@ -49,7 +49,6 @@ class AbstractTileFillTool : public AbstractTileTool
                          const QString &name,
                          const QIcon &icon,
                          const QKeySequence &shortcut,
-                         BrushItem *brushItem = nullptr,
                          QObject *parent = nullptr);
     ~AbstractTileFillTool() override;
 

diff --git a/src/tiled/bucketfilltool.cpp b/src/tiled/bucketfilltool.cpp
@@ -42,7 +42,6 @@ BucketFillTool::BucketFillTool(QObject *parent)
                            QIcon(QLatin1String(
                                    ":images/22/stock-tool-bucket-fill.png")),
                            QKeySequence(Qt::Key_F),
-                           nullptr,
                            parent)
     , mLastFillMethod(mFillMethod)
 {

diff --git a/src/tiled/shapefilltool.cpp b/src/tiled/shapefilltool.cpp
@@ -41,7 +41,6 @@ ShapeFillTool::ShapeFillTool(QObject *parent)
                            QIcon(QLatin1String(
                                      ":images/22/rectangle-fill.png")),
                            QKeySequence(Qt::Key_P),
-                           nullptr,
                            parent)
     , mToolBehavior(Free)
     , mCurrentShape(Rect)

diff --git a/src/tiled/wangbrush.cpp b/src/tiled/wangbrush.cpp
@@ -22,7 +22,6 @@
 #include "wangbrush.h"
 
 #include "addremovetileset.h"
-#include "brushitem.h"
 #include "containerhelpers.h"
 #include "geometry.h"
 #include "hexagonalrenderer.h"
@@ -38,53 +37,30 @@
 
 namespace Tiled {
 
-class WangBrushItem : public BrushItem
-{
-public:
-    WangBrushItem()
-        : BrushItem()
-        , mIsValid(true) {}
-
-    QRectF boundingRect() const override;
-
-    void paint(QPainter *painter,
-               const QStyleOptionGraphicsItem *option,
-               QWidget *widget) override;
-
-    void setInvalidTiles(const QRegion &region = QRegion());
-    bool isValid() const { return mIsValid; }
-
-private:
-    //there is a current brush
-    bool mIsValid;
-    //The tiles which can't be painted.
-    QRegion mInvalidTiles;
-};
-
 QRectF WangBrushItem::boundingRect() const
 {
-    if (mIsValid) {
-        return BrushItem::boundingRect();
-    } else {
-        QRect bounds = mInvalidTiles.boundingRect();
-        QRectF bounding = mapDocument()->renderer()->boundingRect(bounds);
+    auto bounds = BrushItem::boundingRect();
 
-        // Adjust for border drawn at tile selection edges
-        bounding.adjust(-1, -1, 1, 1);
+    if (!isValid()) {
+        QRect invalidTileBounds = mInvalidTiles.boundingRect();
+        QRectF invalidPixelBounds = mapDocument()->renderer()->boundingRect(invalidTileBounds);
 
-        return bounding;
+        // Adjust for border drawn at tile selection edges
+        bounds |= invalidPixelBounds.adjusted(-1, -1, 1, 1);
     }
+
+    return bounds;
 }
 
 void WangBrushItem::paint(QPainter *painter,
                           const QStyleOptionGraphicsItem *option,
                           QWidget *widget)
 {
-    if (mIsValid) {
-        BrushItem::paint(painter, option, widget);
-    } else {
+    BrushItem::paint(painter, option, widget);
+
+    if (!isValid()) {
         const MapRenderer *renderer = mapDocument()->renderer();
-        QColor invalid(255, 0, 0, 64);
+        const QColor invalid(255, 0, 0, 128);
 
         renderer->drawTileSelection(painter,
                                     mInvalidTiles,
@@ -95,16 +71,14 @@ void WangBrushItem::paint(QPainter *painter,
 
 void WangBrushItem::setInvalidTiles(const QRegion &region)
 {
-    if (region.isEmpty()) {
-        mIsValid = true;
-    } else {
-        mIsValid = false;
-        mInvalidTiles = region;
+    if (mInvalidTiles == region)
+        return;
 
-        update();
-    }
+    mInvalidTiles = region;
+    update();
 }
 
+
 WangBrush::WangBrush(QObject *parent)
     : AbstractTileTool("WangTool",
                        tr("Terrain Brush"),
@@ -498,15 +472,6 @@ static constexpr QPoint aroundTilePoints[WangId::NumIndexes] = {
     QPoint(-1, -1)
 };
 
-//  3 0
-//  2 1
-static constexpr QPoint aroundVertexPoints[WangId::NumCorners] = {
-    QPoint( 0, -1),
-    QPoint( 0,  0),
-    QPoint(-1,  0),
-    QPoint(-1, -1)
-};
-
 void WangBrush::updateBrush()
 {
     brushItem()->clear();
@@ -591,7 +556,7 @@ void WangBrush::updateBrush()
     wangFiller.setCorrectionsEnabled(true);
     wangFiller.apply(*stamp);
 
-    static_cast<WangBrushItem*>(brushItem())->setInvalidTiles();
+    static_cast<WangBrushItem*>(brushItem())->setInvalidTiles(wangFiller.invalidRegion());
 
     // Translate to map coordinate space and normalize stamp
     QRegion brushRegion = stamp->region([] (const Cell &cell) { return cell.checked(); });

diff --git a/src/tiled/wangbrush.h b/src/tiled/wangbrush.h
@@ -22,11 +22,31 @@
 #pragma once
 
 #include "abstracttiletool.h"
+#include "brushitem.h"
 #include "wangfiller.h"
 #include "wangset.h"
 
 namespace Tiled {
 
+class WangBrushItem : public BrushItem
+{
+public:
+    WangBrushItem() {}
+
+    QRectF boundingRect() const override;
+
+    void paint(QPainter *painter,
+               const QStyleOptionGraphicsItem *option,
+               QWidget *widget) override;
+
+    void setInvalidTiles(const QRegion &region);
+    bool isValid() const { return mInvalidTiles.isEmpty(); }
+
+private:
+    // The tiles which can't be painted.
+    QRegion mInvalidTiles;
+};
+
 class WangBrush : public AbstractTileTool
 {
     Q_OBJECT

diff --git a/src/tiled/wangfiller.cpp b/src/tiled/wangfiller.cpp
@@ -182,8 +182,13 @@ static void updateAdjacent(WangFiller::CellInfo &adjacentInfo, WangId wangId, in
     }
 }
 
+/**
+ * Applies the scheduled Wang changes to the \a target layer.
+ */
 void WangFiller::apply(TileLayer &target)
 {
+    mInvalidRegion = QRegion();
+
     auto &grid = mFillRegion.grid;
     auto &region = mFillRegion.region;
 
@@ -249,7 +254,7 @@ void WangFiller::apply(TileLayer &target)
 
         Cell cell;
         if (!findBestMatch(target, grid, QPoint(x, y), cell)) {
-            // TODO: error feedback
+            mInvalidRegion += QRect(x, y, 1, 1);
             return;
         }
 

diff --git a/src/tiled/wangfiller.h b/src/tiled/wangfiller.h
@@ -84,10 +84,13 @@ class WangFiller
     void setCorner(QPoint vertexPos, int color);
     void setEdge(QPoint pos, WangId::Index index, int color);
 
+    void apply(TileLayer &target);
+
     /**
-     * Applies the scheduled Wang changes to the \a target layer.
+     * Returns the region with locations for which a matching tile could not be
+     * found in the last call to apply().
      */
-    void apply(TileLayer &target);
+    const QRegion &invalidRegion() const { return mInvalidRegion; }
 
 private:
     /**
@@ -109,6 +112,7 @@ class WangFiller
     bool mCorrectionsEnabled = false;
     bool mErasingEnabled = true;
     FillRegion mFillRegion;
+    QRegion mInvalidRegion;
 
     QPainter *mDebugPainter = nullptr;
 };