BoxZoomTool: New tool for zoom-to-box (GH-2360)

Co-authored-by: Kai Pastor <[email protected]>
Co-authored-by: Matthias Kühlewein <[email protected]>

Author: 3 people

images/cursor-zoom.png

@@ -28,6 +28,7 @@
         <file>images/cursor-invisible.png</file>
         <file>images/cursor-rotate.png</file>
         <file>images/cursor-scale.png</file>
+        <file>images/cursor-zoom.png</file>
         <file>images/cut.png</file>
         <file>images/delete.png</file>
         <file>images/draw-circle.png</file>
@@ -111,6 +112,7 @@
         <file>images/tool-touch-cursor.png</file>
         <file>images/undo.png</file>
         <file>images/view-baseline.png</file>
+        <file>images/view-box-zoom.png</file>
         <file>images/view-hatch-areas.png</file>
         <file>images/view-show-all.png</file>
         <file>images/view-zoom-in.png</file>

images/view-box-zoom.png

@@ -226,6 +226,7 @@ set(Mapper_Common_SRCS
   templates/template_track.cpp
   templates/world_file.cpp
 
+  tools/box_zoom_tool.cpp
   tools/cut_tool.cpp
   tools/cut_hole_tool.cpp
   tools/cutout_operation.cpp

resources.qrc

@@ -143,6 +143,7 @@
 #include "templates/template.h"
 #include "templates/template_dialog_reopen.h"
 #include "templates/template_track.h"
+#include "tools/box_zoom_tool.h"
 #include "tools/cut_tool.h"
 #include "tools/cut_hole_tool.h"
 #include "tools/cutout_tool.h"
@@ -1006,6 +1007,7 @@ void MapEditorController::createActions()
 	follow_position_act = newCheckAction("follow-position", tr("Keep my location on screen"), this, SLOT(followPositionClicked(bool)), nullptr, QString{}, "view_menu.html");
 	zoom_in_act = newAction("zoomin", tr("Zoom in"), this, SLOT(zoomIn()), "view-zoom-in.png", QString{}, "view_menu.html");
 	zoom_out_act = newAction("zoomout", tr("Zoom out"), this, SLOT(zoomOut()), "view-zoom-out.png", QString{}, "view_menu.html");
+	box_zoom_act = newCheckAction("boxzoom", tr("Zoom to box"), this, SLOT(boxZoom(bool)), "view-box-zoom.png", QString{}, "view_menu.html");
 	show_all_act = newAction("showall", tr("Show whole map"), this, SLOT(showWholeMap()), "view-show-all.png", QString{}, "view_menu.html");
 	fullscreen_act = newAction("fullscreen", tr("Toggle fullscreen mode"), window, SLOT(toggleFullscreenMode()), nullptr, QString{}, "view_menu.html");
 	custom_zoom_act = newAction("setzoom", tr("Set custom zoom factor..."), this, SLOT(setCustomZoomFactorClicked()), nullptr, QString{}, "view_menu.html");
@@ -1186,6 +1188,7 @@ void MapEditorController::createMenuAndToolbars()
 	view_menu->addAction(pan_act);
 	view_menu->addAction(zoom_in_act);
 	view_menu->addAction(zoom_out_act);
+	view_menu->addAction(box_zoom_act);
 	view_menu->addAction(show_all_act);
 	view_menu->addAction(custom_zoom_act);
 	view_menu->addSeparator();
@@ -1319,6 +1322,7 @@ void MapEditorController::createMenuAndToolbars()
 	toolbar_view->addAction(pan_act);
 	toolbar_view->addAction(zoom_in_act);
 	toolbar_view->addAction(zoom_out_act);
+	toolbar_view->addAction(box_zoom_act);
 	toolbar_view->addAction(show_all_act);
 	toolbar_view->addAction(template_window_act);
 
@@ -2084,10 +2088,20 @@ void MapEditorController::zoomIn()
 {
 	main_view->zoomSteps(1);
 }
+
 void MapEditorController::zoomOut()
 {
 	main_view->zoomSteps(-1);
 }
+
+void MapEditorController::boxZoom(bool checked)
+{
+	if (checked)
+		setTool(new BoxZoomTool(this, box_zoom_act));
+	else
+		setTool(nullptr);
+}
+
 void MapEditorController::setCustomZoomFactorClicked()
 {
 	bool ok;
@@ -2448,7 +2462,7 @@ void MapEditorController::selectedSymbolsChanged()
 		if (symbol && !symbol->isHidden() && !symbol->isProtected() && current_tool)
 		{
 			// Auto-switch to a draw tool when selecting a symbol under certain conditions
-			if (current_tool->toolType() == MapEditorTool::Pan || current_tool->toolType() == MapEditorTool::Scribble
+			if (current_tool->toolType() == MapEditorTool::Pan || current_tool->toolType() == MapEditorTool::BoxZoom || current_tool->toolType() == MapEditorTool::Scribble
 			    || ((current_tool->toolType() == MapEditorTool::EditLine || current_tool->toolType() == MapEditorTool::EditPoint) && map->getNumSelectedObjects() == 0))
 			{
 				current_tool->switchToDefaultDrawTool(active_symbol);
@@ -4299,6 +4313,7 @@ QHash<const Symbol*, Symbol*> MapEditorController::importMap(
 void MapEditorController::setViewOptionsEnabled(bool enabled)
 {
 	pan_act->setEnabled(enabled);
+	box_zoom_act->setEnabled(enabled);
 	show_grid_act->setEnabled(enabled);
 // 	hatch_areas_view_act->setEnabled(enabled);
 // 	baseline_view_act->setEnabled(enabled);

src/CMakeLists.txt

@@ -310,6 +310,8 @@ public slots:
 	void zoomIn();
 	/** Zooms out in the current map widget. */
 	void zoomOut();
+	/** Activates the box zoom tool. */
+	void boxZoom(bool checked);
 	/** Shows the dialog to set a custom zoom factor in the current map widget. */
 	void setCustomZoomFactorClicked();
 
@@ -726,6 +728,7 @@ protected slots:
 	QAction* follow_position_act = {};
 	QAction* zoom_in_act = {};
 	QAction* zoom_out_act = {};
+	QAction* box_zoom_act = {};
 	QAction* show_all_act = {};
 	QAction* fullscreen_act = {};
 	QAction* custom_zoom_act = {};

src/gui/map/map_editor.cpp

@@ -0,0 +1,113 @@
+/*
+ *    Copyright 2025 Andreas Bertheussen
+ *
+ *    This file is part of OpenOrienteering.
+ *
+ *    OpenOrienteering is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    OpenOrienteering is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with OpenOrienteering.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "box_zoom_tool.h"
+
+#include <Qt>
+#include <QCursor>
+#include <QKeyEvent>
+#include <QPixmap>
+#include <QRectF>
+
+#include "core/map_coord.h"
+#include "gui/main_window.h"
+#include "gui/map/map_widget.h"
+#include "tools/tool.h"
+#include "util/util.h"
+
+namespace OpenOrienteering {
+
+BoxZoomTool::BoxZoomTool(MapEditorController* editor, QAction* tool_action)
+ : MapEditorToolBase( scaledToScreen(QCursor{ QPixmap(QString::fromLatin1(":/images/cursor-zoom.png")), 12, 12 }), BoxZoom, editor, tool_action)
+{
+	useTouchCursor(false);
+}
+
+BoxZoomTool::~BoxZoomTool() = default;
+
+void BoxZoomTool::clickPress()
+{
+	startDragging();
+}
+
+bool BoxZoomTool::keyPress(QKeyEvent* event)
+{
+	if (event->key() == Qt::Key_Escape && isDragging())
+	{
+		cancelDragging();
+		return true;
+	}
+	return false;
+}
+
+void BoxZoomTool::dragStart()
+{
+	mainWindow()->clearStatusBarMessage();
+	setEditingInProgress(true);
+	updateDirtyRect();
+}
+
+void BoxZoomTool::dragMove()
+{
+	updateDirtyRect();
+}
+
+void BoxZoomTool::dragFinish()
+{
+	constexpr auto min_size = 1; // mm
+	auto const rect = QRectF(click_pos_map, cur_pos_map).normalized();
+	if (rect.width() >= min_size && rect.height() >= min_size)
+		mapWidget()->adjustViewToRect(rect, MapWidget::ContinuousZoom);
+	else
+		mainWindow()->showStatusBarMessage(tr("The selected box is too small."), 2000);
+
+	updateDirtyRect();
+	setEditingInProgress(false);
+}
+
+void BoxZoomTool::dragCanceled()
+{
+	updateDirtyRect();
+	setEditingInProgress(false);
+}
+
+void BoxZoomTool::updateStatusText()
+{
+	setStatusBarText(tr("<b>Drag</b>: Select area to zoom in on. "));
+}
+
+void BoxZoomTool::objectSelectionChangedImpl()
+{}
+
+void BoxZoomTool::drawImpl(QPainter* painter, MapWidget* widget)
+{
+	drawSelectionOrPreviewObjects(painter, widget, false);
+
+	if (isDragging())
+		drawSelectionBox(painter, widget, click_pos_map, cur_pos_map);
+}
+
+int BoxZoomTool::updateDirtyRectImpl(QRectF& rect)
+{
+	rectIncludeSafe(rect, click_pos_map);
+	rectInclude(rect, cur_pos_map);
+	return 5;
+}
+
+}  // namespace OpenOrienteering

src/gui/map/map_editor.h

@@ -0,0 +1,67 @@
+/*
+ *    Copyright 2025 Andreas Bertheussen
+ *
+ *    This file is part of OpenOrienteering.
+ *
+ *    OpenOrienteering is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    OpenOrienteering is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with OpenOrienteering.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#ifndef OPENORIENTEERING_BOX_ZOOM_TOOL_H
+#define OPENORIENTEERING_BOX_ZOOM_TOOL_H
+
+#include <QObject>
+#include <QString>
+
+#include "tools/tool_base.h"
+
+class QAction;
+class QKeyEvent;
+class QPainter;
+class QRectF;
+
+namespace OpenOrienteering {
+
+class MapEditorController;
+class MapWidget;
+
+
+/**
+ * Tool to zoom to a user defined region.
+ */
+class BoxZoomTool : public MapEditorToolBase
+{
+	Q_OBJECT
+public:
+	BoxZoomTool(MapEditorController* editor, QAction* tool_action);
+	~BoxZoomTool() override;
+
+protected:
+	void updateStatusText() override;
+	void objectSelectionChangedImpl() override;
+	void clickPress() override;
+	bool keyPress(QKeyEvent* event) override;
+	void dragStart() override;
+	void dragMove() override;
+	void dragFinish() override;
+	void dragCanceled() override;
+
+	void drawImpl(QPainter* painter, MapWidget* widget) override;
+	int updateDirtyRectImpl(QRectF& rect) override;
+};
+
+
+}  // namespace OpenOrienteering
+
+#endif

src/tools/box_zoom_tool.cpp

@@ -90,6 +90,7 @@ Q_OBJECT
 		DrawFreehand  = 8,
 		Pan           = 9,
 		Scribble      = 10,
+		BoxZoom       = 11,
 		Other         = 0
 	};