New Hardware Renderer: Add tool brush to mapview.qml by UltraDagon · Pull Request #4547 · mapeditor/tiled

UltraDagon · 2026-06-18T21:01:48Z

This adds Tiled's existing basic tool functionality to the New Hardware Renderer's mapview.qml.

Adds a toolBrush MapItem to mapview.qml.
Adds a new RegionOverlay.qml element used to highlight some region of the map.
Adds a selectedRegion RegionOverlay for tile-selection-based tools.
Adds a brushRegion RegionOverlay for the ToolBrush's edit preview region.
Adds mouse functionality to singleFingerPanArea in mapview.qml.
Changes mapItem to update upon tool usage.
Adds a new EditableMap constructor, allowing for the usage of SharedMaps.
Adds sizeChange and tileSizeChanged signals to EditableMap.

Lesser changes:
Abstracted setRegion and translateRegion functions in BrushItem. Not required for this PR, but may be useful in the future to signal changes at the BrushItem level.

…qml; Moved the cursor tile coords math to it's own function

…defined

…ted layer

Created new signal in mapview.qml to update mapeditor's tool mouse position (Temporary) Moved the ToolBrush map setter code to on mouse move Changed the ToolBrush map setter code to use the currently selected tool's brushItem->map()

UltraDagon · 2026-06-23T10:01:27Z

Currently, toolBrushMap is set using dynamic_cast<AbstractTileTool*>(selectedTool())->brushItem()->map().get(). However, AbstractTileTool::brushItem() is normally protected, and I've made it public for the time being without rearranging it in the header file.

Is this the recommended way for me to obtain this map? If so, I can go ahead and move it to be a public getter.

I plan on integrating the quickBrushUpdated signal tomorrow, and then the colored overlays for using the different tools.

…related tools

This Depends is only there to make sure the plugin is compiled, but the plugin is loaded dynamically as a QML module.

bjorn

Nice to see things are coming together, but I had a lot of feedback. :-)

…efreshes upon map resize

initialize libtiledquick/mapitem's mEditableMap to nullptr so that it can be read during setmap removed unnecessary lines from mapview.qml renamed tilelayeritem's getlayer to layer added selectedTool boolean check to mapeditor::onquickmousecoordschanged changed dynamic_casts to qobject_casts

…ship in currentBrush() now applies to both renderers

…nges Added MapEditor::tileEditPreview() getter function Added AbstractTileTool::brushMap() getter function Moved toolBrushMap to a property var called toolPreviewMap to fix a garbage collector bug Need to add the Q_PROPERTY to mapeditor for the tileEditPreview. Pushed so that I can resume work on a difference machine.

…logic to be updated by mapview.qml

…review

…the map as an argument

…all tabs

UltraDagon · 2026-06-30T23:57:22Z

After linking a lot of these abstractTileTool signals, it might be better to link within the brushitems instead. Let me know what you think.

Edit: I did this with the region changes, which, to do so, led to me having to change brushItem from a QGraphicsItem to a QGraphicsObject.

Added RegionOverlay.qml to house the qml-based drawing of the overlay Added BrushItem::regionChanged signals Added BrushItem::setRegion and BrushItem::translateRegion functions Changed BrushItem to a QGraphicsObject (from QGraphicsItem) to support signals Fixed crash caused by toggling the New Hardware Renderer preference while a tile edit preview as active Minor code style changes in mapview.qml

UltraDagon · 2026-07-01T09:04:49Z

After adding the regionOverlay and rendering it using QML geometry, I think it might be better to change the griditem from being shader-based to QML geometry-based, as the current shader floating-point errors cause the regionOverlay to be slightly offset from the grid. Let me know what you think 😄

… children

bjorn · 2026-07-03T06:57:12Z

        QHashIterator<TileLayer*, QRegion> ri(paintedRegions);
        while (ri.hasNext()) {
            ri.next();
+            emit brushRegionChanged(ri.value());


This doesn't look like the right place to emit a brush region changed signal. The ri.value() is the region in which an edit was applied.

That makes sense. I've moved the brushRegionChanged to be mPreviewMap->modifiedTileRegion(), moved it out of the while loop, and changed the brushMapChanged to nullptr while dragging to paint.

…ounds Changed brushRegionOverlay to be visible/invisible when mouse is in/out of view Added validPolygons and invalidPolygons Q_PROPERTYs to RegionOverlay Changed StampBrush to hide tileEditPreview map upon drag Changed StampBrush's brush drag brushRegionChanged to be out of a for loop Added brushRegionChanged emits to AbstractTileSelectionTool and Eraser Removed unused AbstractTileTool::validRegion() getter

Added regionAlpha Q_PROPERTY to RegionOverlay Moved RegionOverlay's duplicate polygons code to it's own private function Changed toolBrush/regionOverlay to stay visible while mouse is pressed

Removed obsolete setTileEditPreview(nullptr)s Moved brushMapChanged and brushRegionChanged to more intuitive locations

UltraDagon · 2026-07-07T06:26:19Z

I'm not super familiar with working with smart pointers and wanted to make sure that my most recent commit (a75bf94) is done correctly. From testing, I believe that it is properly freeing the EditableMap and SharedMap memory when they go out of scope, and mTileEditPreview should be the final owner of the toolBrush SharedMap.

Let me know if I misunderstood anything while making this. Thanks!

UltraDagon · 2026-07-07T06:47:39Z

I also went ahead and undrafted the PR and updated the description since, once this is touched up and finalized, it should be a good stopping point before creating new PRs for other features.

…erlay code tweaks

UltraDagon · 2026-07-08T03:54:25Z

I'm not super familiar with working with smart pointers and wanted to make sure that my most recent commit (a75bf94) is done correctly. From testing, I believe that it is properly freeing the EditableMap and SharedMap memory when they go out of scope, and mTileEditPreview should be the final owner of the toolBrush SharedMap.

Let me know if I misunderstood anything while making this. Thanks!

Talked a bit with Adam about this and added some safeguards to make sure this new constructor isn't misused in the future. I was also thinking that it could be possible to give MapItem the option to work how it used to, taking in a standard map, to avoid having to cast to an EditableMap. I'm not entirely sure, but I don't believe that the ToolBrush MapItem uses any EditableMap-specific features.

The selected tool is only activated on a scene when there is a view using it, so the TILEDQUICK_LIB mouse handlers should not call into the tool when mViewWithTool is not set. Added MapEditor::activeTool, which checks this, and used it in place of selectedTool in these handlers.

bjorn

@UltraDagon It's really great to see this is actually working and to be able to edit with all those existing tools while using the new renderer!

I left a bunch of minor and some larger points of feedback, but it seems to me you're on track to get this merged by the end of the week. :-)

bjorn · 2026-07-08T11:40:21Z

        cpp.includePaths: exportingProduct.sourceDirectory
    }

+    Depends { name: "Qt.core" }


Why was this added here? I think that should be already covered by this line above:

Depends { name: "Qt"; submodules: ["quick","shadertools"]; versionAtLeast: "6.5" }

Sorry about that, Qt Creator auto adds it whenever I add new files and I must have forgot to remove it.

bjorn · 2026-07-08T14:49:48Z

+    , mRegion(QRegion())
+    , mMapRect(QRect())


No need to explicitly write the initialization if it's the same as the default initialization, just leave it out in that case.

bjorn · 2026-07-08T14:53:21Z

 }

+Tiled::TileLayer *TileLayerItem::layer() {
+    return mLayer;


A good candidate for inlining. :-)

bjorn · 2026-07-08T14:58:20Z

+{
+    if (!map) {
+        mTileEditPreview.reset();
+        return;


I think this branch is missing the emit tileEditPreviewChanged()? You can also consider:

mTileEditPreview = map ? std::make_unique<EditableMap>(map) : nullptr; emit tileEditPreviewChanged();

(not sure if it works exactly like that, might need std::unique_ptr<EditableMap>() instead of nullptr to match the type)

It seems like it should do the same thing. I used your suggested change.

bjorn · 2026-07-08T15:00:05Z

    void setSelectedTool(AbstractTool *tool);

+#ifdef TILEDQUICK_LIB
+    Q_INVOKABLE void setQuickMouseCoords(QPointF coords);


I guess as implemented this function should just be called quickMouseMoved for consistency.

bjorn · 2026-07-08T15:08:18Z

+    mRegion = region;
+}
+
+void BrushItem::translateRegion(const QPoint &p)


What is this function for? Also setRegion seems superfluous.

setRegion and translateRegion were remnants from when I was getting signals from brushItem changes, so they're no longer needed, but I had left them in anyway in case they were needed in the future to more easily send signals. I'll remove them since they don't seem necessary or hard to re-add if needed in the future.

bjorn · 2026-07-08T15:12:16Z

+    id: regionOverlay
+
+    property var scale
+    // TODO: Draw only visible area


I guess we can remove that TODO for now, because it's unclear how that's supposed to work and also whether it will be more efficient anyway.

Hopefully the Shape item will already do some optimizations, but even if it doesn't, adjusting its shapes based on the visible area would also have a certain performance overhead.

bjorn · 2026-07-08T15:13:19Z

+        var tileCoords = mapItem.screenToTileCoords(mapRelativeCoords.x, mapRelativeCoords.y)
+
+        return tileCoords


Let's shorten this a bit. :-)

Suggested change

var tileCoords = mapItem.screenToTileCoords(mapRelativeCoords.x, mapRelativeCoords.y)

return tileCoords

return mapItem.screenToTileCoords(mapRelativeCoords.x, mapRelativeCoords.y)

bjorn · 2026-07-08T15:13:49Z

+        var mapRelativeCoords = singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)
+        return mapRelativeCoords


Suggested change

var mapRelativeCoords = singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)

return mapRelativeCoords

return singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)

bjorn · 2026-07-08T15:54:26Z

    WangBrush *mWangBrush;
    EditPolygonTool *mEditPolygonTool;

+    std::unique_ptr<EditableMap> mTileEditPreview;


I think it's a problem to use std::unique_ptr<EditableMap> here and also pass the EditableMap* into the QML context, from where it is passed on to MapItem. We're probably kind of lucky when the unique_ptr deletes the EditableMap instance, that the MapItem no longer references that pointer.

When we create the EditableMap instance, actually its EditableObject parent constructor will set it as the Object::mEditable. That means it probably suffices to just store a SharedMap mTileEditPreview here, and we can create its EditableMap instance on-demand in MapEditor::tileEditRegion, using EditableObject::find(mTileEditPreview.get()) to reuse an existing editable instance when possible.

Removed unnecessary Qt.core dependency from libtiledquick.qbs Removed redundant RegionOverlay mRegion and mMapRect initializations Changed TileLayerItem::layer to be inline Renamed MapEditor's setQuickMouseCoords to quickMouseMoved Removed redundant EditableMap mSharedMap default assignment Removed unnecessary setRegion and translateRegion functions from BrushItem Removed TODO comment from RegionOverlay Shortened mapRelativeCoords function in mapview.qml Removed unused cursorTileCoords function from mapview.qml Changed mTileEditPreview to be a SharedMap Changed tileEditPreview to create the new editableMap instance on request

Created new mapItem instance for rendering the tool brush on mapview.…

0b03c73

…qml; Moved the cursor tile coords math to it's own function

UltraDagon force-pushed the nhr/tool-brush branch from 4a8a8b4 to 0b03c73 Compare June 18, 2026 21:23

UltraDagon added 3 commits June 19, 2026 02:30

Fixed tool brush mapitem to no longer cause errors when the map is un…

6760a51

…defined

mapview.qml updates upon old editor tool usage

f530985

Added sizeChanged and tileSizeChanged notify signals to editablemap

0005b76

UltraDagon commented Jun 20, 2026

View reviewed changes

Comment thread src/tiled/editablemap.cpp

UltraDagon added 2 commits June 20, 2026 03:12

Changed libtiledquick/mapitem::repaintRegion to only update the affec…

451055f

…ted layer

UltraDagon and others added 2 commits June 23, 2026 19:41

Moved quick brush changes to onQuickBrushChanged and set up emits in …

85dcc28

…related tools

Don't link to the tiledquickplugin

833bbf0

This Depends is only there to make sure the plugin is compiled, but the plugin is loaded dynamically as a QML module.

bjorn requested changes Jun 24, 2026

View reviewed changes

UltraDagon added 12 commits June 24, 2026 13:56

Changed editablemap's size signals to be sent properly; MapItem now r…

b07fc43

…efreshes upon map resize

Added disconnects for libtiledquick/mapitem's setmap connections

9ca0d81

Renamed quickBrushChanged signal to brushMapChanged; Javascript owner…

2e3f22b

…ship in currentBrush() now applies to both renderers

Moved brushChanged logic to a Q_PROPERTY and quickMouseCoordsChanged …

e096b8d

…logic to be updated by mapview.qml

Fixed ifdefs for TILEDQUICK_LIB

8c3e48f

Created template classes and setup for regionOverlay

4cbb046

Fixed crash that happened upon QML's garbage collection for tileEditP…

e6ac0b9

…review

Fixed small typo in mapview.qml

5775da4

Fixed memory leak with setTileEditPreview; brushMapChanged now takes …

26b461f

…the map as an argument

Removed AbstractTileTool::toolBrush(); Fixed crash caused by closing …

fc5b3ec

…all tabs

UltraDagon added 2 commits July 1, 2026 23:10

Linked quick mouse onPress and onRelease events to selectedTool

163e803

Moved tileEditRegionChanged code from brushItem to abstractTileTool &…

40b1776

… children

bjorn reviewed Jul 3, 2026

View reviewed changes

UltraDagon added 3 commits July 4, 2026 19:02

Added selectedRegionOverlay; RegionOverlay tweaks

d4a3f4a

Added regionAlpha Q_PROPERTY to RegionOverlay Moved RegionOverlay's duplicate polygons code to it's own private function Changed toolBrush/regionOverlay to stay visible while mouse is pressed

Added EditableMap constructor for using SharedMaps

a75bf94

Removed obsolete setTileEditPreview(nullptr)s Moved brushMapChanged and brushRegionChanged to more intuitive locations

UltraDagon marked this pull request as ready for review July 7, 2026 06:45

Added safeguard for new EditableMap constructor usage; Small RegionOv…

4dfaad9

…erlay code tweaks

bjorn requested changes Jul 8, 2026

View reviewed changes

		var tileCoords = mapItem.screenToTileCoords(mapRelativeCoords.x, mapRelativeCoords.y)

		return tileCoords

		var mapRelativeCoords = singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)
		return mapRelativeCoords

	var mapRelativeCoords = singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)
	return mapRelativeCoords
	return singleFingerPanArea.mapToItem(mapItem, singleFingerPanArea.mouseX, singleFingerPanArea.mouseY)

Uh oh!

Uh oh!

Conversation

UltraDagon commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

UltraDagon commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bjorn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

UltraDagon commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UltraDagon commented Jul 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

UltraDagon commented Jul 7, 2026

Uh oh!

UltraDagon commented Jul 7, 2026

Uh oh!

UltraDagon commented Jul 8, 2026

Uh oh!

bjorn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

UltraDagon commented Jun 18, 2026 •

edited

Loading

UltraDagon commented Jun 23, 2026 •

edited

Loading

UltraDagon commented Jun 30, 2026 •

edited

Loading