Allow ignoring mouse events for freehand tool

An attempted hack around XP Pen problems when it is in relative mode. It
seems to send mouse events first and then doesn't send tablet events
when those are accepted, so this is a hack around that which will ignore
those mouse events altogether when the freehand tool is active to test
that theory. This isn't ideal like this though, since it will also
ignore mouse inputs when using canvas shortcuts and doesn't update the
outline position while the tool is active. It may get reverted or
adjusted further from here.

src/desktop/dialogs/settingsdialog/tablet.cpp

@@ -100,6 +100,11 @@ void Tablet::initTablet(
 	settings.bindTabletEvents(pressure);
 	form->addRow(tr("Pen pressure:"), pressure);
 
+	auto *ignoreMouse =
+		new QCheckBox(tr("Ignore mouse when using freehand tool"));
+	settings.bindIgnoreMouse(ignoreMouse);
+	form->addRow(nullptr, ignoreMouse);
+
 	auto *smoothing = new KisSliderSpinBox;
 	smoothing->setMaximum(libclient::settings::maxSmoothing);
 	smoothing->setPrefix(tr("Global smoothing: "));

src/desktop/mainwindow.cpp

@@ -2511,6 +2511,7 @@ void MainWindow::toggleTabletEventLog()
 				DP_event_log_write_meta("Input: %s", tabletinput::current());
 				const desktop::settings::Settings &settings = dpApp().settings();
 				DP_event_log_write_meta("Tablet enabled: %d", settings.tabletEvents());
+				DP_event_log_write_meta("Ignore mouse: %d", settings.ignoreMouse());
 				DP_event_log_write_meta("Tablet eraser action: %d", settings.tabletEraserAction());
 				DP_event_log_write_meta("One-finger touch action: %d", settings.oneFingerTouch());
 				DP_event_log_write_meta("Two-finger pinch action: %d", settings.twoFingerPinch());

src/desktop/scene/canvasview.cpp

@@ -252,6 +252,7 @@ CanvasView::CanvasView(QWidget *parent)
 	settings.bindTabletEvents(this, &widgets::CanvasView::setTabletEnabled);
 	settings.bindTouchGestures(
 		this, &widgets::CanvasView::setTouchUseGestureEvents);
+	settings.bindIgnoreMouse(this, &widgets::CanvasView::setIgnoreMouse);
 	settings.bindRenderSmooth(this, &widgets::CanvasView::setRenderSmooth);
 	settings.bindRenderUpdateFull(
 		this, &widgets::CanvasView::setRenderUpdateFull);
@@ -854,12 +855,13 @@ void CanvasView::setToolCursor(const QCursor &cursor)
 
 void CanvasView::setToolCapabilities(
 	bool allowColorPick, bool allowToolAdjust, bool toolHandlesRightClick,
-	bool fractionalTool)
+	bool fractionalTool, bool toolSupportsPressure)
 {
 	m_allowColorPick = allowColorPick;
 	m_allowToolAdjust = allowToolAdjust;
 	m_toolHandlesRightClick = toolHandlesRightClick;
 	m_fractionalTool = fractionalTool;
+	m_toolSupportsPressure = toolSupportsPressure;
 	m_touch->setAllowColorPick(allowColorPick);
 }
 
@@ -1367,7 +1369,7 @@ void CanvasView::mousePressEvent(QMouseEvent *event)
 	updateCursorPos(mousePos);
 
 	if((m_enableTablet && isSynthetic(event)) || isSyntheticTouch(event) ||
-	   touching || !m_tabletEventTimer.hasExpired()) {
+	   touching || shouldIgnoreMouse() || !m_tabletEventTimer.hasExpired()) {
 		return;
 	}
 
@@ -1443,7 +1445,7 @@ void CanvasView::mouseMoveEvent(QMouseEvent *event)
 	updateCursorPos(mousePos);
 
 	if((m_enableTablet && isSynthetic(event)) || isSyntheticTouch(event) ||
-	   m_pendown == TABLETDOWN || touching ||
+	   m_pendown == TABLETDOWN || touching || shouldIgnoreMouse() ||
 	   (m_pendown && !m_tabletEventTimer.hasExpired())) {
 		return;
 	}
@@ -1603,7 +1605,7 @@ void CanvasView::mouseReleaseEvent(QMouseEvent *event)
 	updateCursorPos(mousePos);
 
 	if((m_enableTablet && isSynthetic(event)) || isSyntheticTouch(event) ||
-	   touching || !m_tabletEventTimer.hasExpired()) {
+	   touching || shouldIgnoreMouse() || !m_tabletEventTimer.hasExpired()) {
 		return;
 	}
 

src/desktop/scene/canvasview.h

@@ -91,6 +91,7 @@ class CanvasView final : public QGraphicsView {
 
 	//! Enable/disable tablet event handling
 	void setTabletEnabled(bool enable) { m_enableTablet = enable; }
+	void setIgnoreMouse(bool ignoreMouse) { m_ignoreMouse = ignoreMouse; }
 
 	//! Enable/disable touch gestures
 	void setTouchUseGestureEvents(bool touchUseGestureEvents);
@@ -228,7 +229,7 @@ public slots:
 	void setToolCursor(const QCursor &cursor);
 	void setToolCapabilities(
 		bool allowColorPick, bool allowToolAdjust, bool toolHandlesRightClick,
-		bool fractionalTool);
+		bool fractionalTool, bool toolSupportsPressure);
 
 	void setBrushCursorStyle(int style);
 	void setEraseCursorStyle(int style);
@@ -360,6 +361,11 @@ private slots:
 	void showTransformNotice(const QString &text);
 	void updateLockNotice();
 
+	bool shouldIgnoreMouse() const
+	{
+		return m_ignoreMouse && m_toolSupportsPressure;
+	}
+
 	Qt::KeyboardModifiers getKeyboardModifiers(const QKeyEvent *keyev) const;
 	Qt::KeyboardModifiers getMouseModifiers(const QMouseEvent *mouseev) const;
 	Qt::KeyboardModifiers getTabletModifiers(const QTabletEvent *tabev) const;
@@ -387,6 +393,7 @@ private slots:
 	bool m_allowToolAdjust;
 	bool m_toolHandlesRightClick;
 	bool m_fractionalTool;
+	bool m_toolSupportsPressure = false;
 	PenMode m_penmode;
 	QDeadlineTimer m_tabletEventTimer;
 	int m_tabletEventTimerDelay;
@@ -430,6 +437,7 @@ private slots:
 
 	bool m_useGestureEvents = false;
 	bool m_enableTablet;
+	bool m_ignoreMouse = false;
 	bool m_locked;
 	QString m_lockDescription;
 	int m_toolState;

src/desktop/scene/scenewrapper.cpp

@@ -19,7 +19,7 @@
 #include "libclient/tools/toolcontroller.h"
 #include <functional>
 
-using std::placeholders::_5;
+using std::placeholders::_6;
 
 namespace drawingboard {
 
@@ -346,7 +346,7 @@ void SceneWrapper::connectDocument(Document *doc)
 	connect(
 		toolCtrl, &tools::ToolController::toolCapabilitiesChanged, m_scene,
 		std::bind(
-			&drawingboard::CanvasScene::setSelectionIgnored, m_scene, _5));
+			&drawingboard::CanvasScene::setSelectionIgnored, m_scene, _6));
 	m_scene->setSelectionIgnored(toolCtrl->activeToolIgnoresSelections());
 
 	connect(
@@ -361,7 +361,8 @@ void SceneWrapper::connectDocument(Document *doc)
 		toolCtrl->activeToolAllowColorPick(),
 		toolCtrl->activeToolAllowToolAdjust(),
 		toolCtrl->activeToolHandlesRightClick(),
-		toolCtrl->activeToolIsFractional());
+		toolCtrl->activeToolIsFractional(),
+		toolCtrl->activeToolSupportsPressure());
 
 	connect(
 		m_view, &CanvasView::penDown, toolCtrl,

src/desktop/settings_table.h

@@ -139,6 +139,7 @@ SETTING(fontSize                  , FontSize                  , "settings/fontSi
 SETTING(globalPressureCurve       , GlobalPressureCurve       , "settings/input/globalcurve"            , GLOBAL_PRESSURE_CURVE_DEFAULT)
 SETTING(hostEnableAdvanced        , HostEnableAdvanced        , "history/hostenableadvanced"            , false)
 SETTING(ignoreCarrierGradeNat     , IgnoreCarrierGradeNat     , "history/cgnalert"                      , false)
+SETTING(ignoreMouse               , IgnoreMouse               , "settings/input/ignoremouse"            , false)
 SETTING(inputPresets              , InputPresets              , "inputpresets"                          , QVector<QVariantMap>())
 SETTING(insecurePasswordStorage   , InsecurePasswordStorage   , "settings/insecurepasswordstorage"      , false)
 SETTING_GETSET_V(

src/desktop/view/canvascontroller.cpp

@@ -184,6 +184,7 @@ CanvasController::CanvasController(CanvasScene *scene, QWidget *parent)
 		this, &CanvasController::setClearColor);
 	settings.bindRenderSmooth(this, &CanvasController::setRenderSmooth);
 	settings.bindTabletEvents(this, &CanvasController::setTabletEnabled);
+	settings.bindIgnoreMouse(this, &CanvasController::setIgnoreMouse);
 	settings.bindBrushOutlineWidth(this, &CanvasController::setOutlineWidth);
 	settings.bindGlobalPressureCurve(
 		this, &CanvasController::setSerializedPressureCurve);
@@ -609,6 +610,7 @@ void CanvasController::handleMouseMove(QMouseEvent *event)
 
 	if((!m_tabletEnabled || !isSynthetic(event)) && !isSyntheticTouch(event) &&
 	   m_penState != PenState::TabletDown && !touching &&
+	   !shouldIgnoreMouse() &&
 	   (m_penState == PenState::Up || m_tabletEventTimer.hasExpired())) {
 		if(m_penState != PenState::Up && buttons == Qt::NoButton) {
 			handleMouseRelease(event);
@@ -633,7 +635,7 @@ void CanvasController::handleMousePress(QMouseEvent *event)
 		int(m_penState), int(touching), qulonglong(event->timestamp()));
 
 	if(((!m_tabletEnabled || !isSynthetic(event))) &&
-	   !isSyntheticTouch(event) && !touching &&
+	   !isSyntheticTouch(event) && !touching && !shouldIgnoreMouse() &&
 	   m_tabletEventTimer.hasExpired()) {
 		event->accept();
 		penPressEvent(
@@ -655,7 +657,7 @@ void CanvasController::handleMouseRelease(QMouseEvent *event)
 		int(m_penState), int(touching), qulonglong(event->timestamp()));
 
 	if((!m_tabletEnabled || !isSynthetic(event)) && !isSyntheticTouch(event) &&
-	   !touching) {
+	   !touching && !shouldIgnoreMouse()) {
 		event->accept();
 		penReleaseEvent(
 			QDateTime::currentMSecsSinceEpoch(), posf, event->button(),
@@ -1175,6 +1177,11 @@ void CanvasController::setTabletEnabled(bool tabletEnabled)
 	m_tabletEnabled = tabletEnabled;
 }
 
+void CanvasController::setIgnoreMouse(bool ignoreMouse)
+{
+	m_ignoreMouse = ignoreMouse;
+}
+
 void CanvasController::setSerializedPressureCurve(
 	const QString &serializedPressureCurve)
 {
@@ -1276,12 +1283,13 @@ void CanvasController::setPointerTracking(bool pointerTracking)
 
 void CanvasController::setToolCapabilities(
 	bool allowColorPick, bool allowToolAdjust, bool toolHandlesRightClick,
-	bool fractionalTool)
+	bool fractionalTool, bool toolSupportsPressure)
 {
 	m_allowColorPick = allowColorPick;
 	m_allowToolAdjust = allowToolAdjust;
 	m_toolHandlesRightClick = toolHandlesRightClick;
 	m_fractionalTool = fractionalTool;
+	m_toolSupportsPressure = toolSupportsPressure;
 	m_touch->setAllowColorPick(allowColorPick);
 }
 

src/desktop/view/canvascontroller.h

@@ -139,7 +139,7 @@ class CanvasController : public QObject {
 	void setPointerTracking(bool pointerTracking);
 	void setToolCapabilities(
 		bool allowColorPick, bool allowToolAdjust, bool toolHandlesRightClick,
-		bool fractionalTool);
+		bool fractionalTool, bool toolSupportsPressure);
 	void setToolCursor(const QCursor &toolCursor);
 	void setBrushBlendMode(int brushBlendMode);
 
@@ -210,6 +210,7 @@ class CanvasController : public QObject {
 	void setClearColor(const QColor clearColor);
 	void setRenderSmooth(bool renderSmooth);
 	void setTabletEnabled(bool tabletEnabled);
+	void setIgnoreMouse(bool ignoreMouse);
 	void setSerializedPressureCurve(const QString &serializedPressureCurve);
 	void setOutlineWidth(qreal outlineWidth);
 	void setCanvasShortcuts(QVariantMap canvasShortcuts);
@@ -266,6 +267,11 @@ class CanvasController : public QObject {
 	static bool isSynthetic(QMouseEvent *event);
 	static bool isSyntheticTouch(QMouseEvent *event);
 
+	bool shouldIgnoreMouse() const
+	{
+		return m_ignoreMouse && m_toolSupportsPressure;
+	}
+
 	Qt::KeyboardModifiers getKeyboardModifiers(const QKeyEvent *event) const;
 	Qt::KeyboardModifiers getMouseModifiers(const QMouseEvent *event) const;
 	Qt::KeyboardModifiers getTabletModifiers(const QTabletEvent *event) const;
@@ -338,6 +344,7 @@ class CanvasController : public QObject {
 	QColor m_clearColor;
 	bool m_renderSmooth = false;
 	bool m_tabletEnabled = true;
+	bool m_ignoreMouse = false;
 	KisCubicCurve m_pressureCurve;
 	bool m_pixelGrid = true;
 	bool m_pointerTracking = false;
@@ -387,6 +394,7 @@ class CanvasController : public QObject {
 	bool m_allowToolAdjust = false;
 	bool m_toolHandlesRightClick = false;
 	bool m_fractionalTool = false;
+	bool m_toolSupportsPressure = false;
 
 #ifdef __EMSCRIPTEN__
 	bool m_enableEraserOverride = false;

src/desktop/view/viewwrapper.cpp

@@ -22,7 +22,7 @@
 #include "libclient/tools/toolcontroller.h"
 #include <functional>
 
-using std::placeholders::_5;
+using std::placeholders::_6;
 
 namespace view {
 
@@ -333,7 +333,7 @@ void ViewWrapper::connectDocument(Document *doc)
 		&tools::ToolController::offsetActiveTool);
 	connect(
 		toolCtrl, &tools::ToolController::toolCapabilitiesChanged, m_scene,
-		std::bind(&view::CanvasScene::setSelectionIgnored, m_scene, _5));
+		std::bind(&view::CanvasScene::setSelectionIgnored, m_scene, _6));
 	m_scene->setSelectionIgnored(toolCtrl->activeToolIgnoresSelections());
 
 	connect(
@@ -348,7 +348,8 @@ void ViewWrapper::connectDocument(Document *doc)
 		toolCtrl->activeToolAllowColorPick(),
 		toolCtrl->activeToolAllowToolAdjust(),
 		toolCtrl->activeToolHandlesRightClick(),
-		toolCtrl->activeToolIsFractional());
+		toolCtrl->activeToolIsFractional(),
+		toolCtrl->activeToolSupportsPressure());
 
 	connect(
 		m_controller, &CanvasController::penDown, toolCtrl,

src/libclient/tools/annotation.cpp

@@ -12,7 +12,7 @@ namespace tools {
 Annotation::Annotation(ToolController &owner)
 	: Tool(
 		  owner, ANNOTATION, QCursor(QPixmap(":cursors/text.png"), 2, 2), false,
-		  false, true, false, true)
+		  false, true, false, false, true)
 	, m_selectedId{0}
 {
 }

src/libclient/tools/beziertool.cpp

@@ -19,7 +19,7 @@ using canvas::Point;
 static constexpr long long DELTA_MSEC = 10;
 
 BezierTool::BezierTool(ToolController &owner)
-	: Tool(owner, BEZIER, QCursor(QPixmap(":cursors/curve.png"), 2, 2), true, true, false, true, true)
+	: Tool(owner, BEZIER, QCursor(QPixmap(":cursors/curve.png"), 2, 2), true, true, false, true, false, true)
 	, m_brushEngine{}
 {
 }

src/libclient/tools/colorpicker.cpp

@@ -10,7 +10,7 @@ namespace tools {
 ColorPicker::ColorPicker(ToolController &owner)
 	: Tool(
 		  owner, PICKER, QCursor(QPixmap(":/cursors/colorpicker.png"), 2, 29),
-		  false, true, false, true, false)
+		  false, true, false, true, false, false)
 {
 }
 

src/libclient/tools/floodfill.cpp

@@ -114,7 +114,7 @@ FloodFill::FloodFill(ToolController &owner)
 	: Tool(
 		  owner, FLOODFILL,
 		  QCursor(QPixmap(QStringLiteral(":cursors/bucket.png")), 2, 29), true,
-		  true, false, false, false)
+		  true, false, false, false, false)
 	, m_kernel(int(DP_FLOOD_FILL_KERNEL_ROUND))
 	, m_blendMode(DP_BLEND_MODE_NORMAL)
 	, m_originalBlendMode(m_blendMode)

src/libclient/tools/freehand.cpp

@@ -13,7 +13,7 @@ namespace tools {
 Freehand::Freehand(ToolController &owner, bool isEraser)
 	: Tool(
 		  owner, isEraser ? ERASER : FREEHAND, Qt::CrossCursor, true, true,
-		  false, false, true)
+		  false, false, true, true)
 	, m_pollTimer{}
 	, m_brushEngine{std::bind(&Freehand::pollControl, this, _1)}
 	, m_drawing(false)

src/libclient/tools/inspector.cpp

@@ -8,7 +8,7 @@ namespace tools {
 Inspector::Inspector(ToolController &owner)
 	: Tool(
 		  owner, INSPECTOR, QCursor(Qt::WhatsThisCursor), false, false, false,
-		  true, false)
+		  true, false, false)
 {
 }
 

src/libclient/tools/laser.cpp

@@ -10,7 +10,7 @@ namespace tools {
 LaserPointer::LaserPointer(ToolController &owner)
 	: Tool(
 		  owner, LASERPOINTER, QCursor(QPixmap(":cursors/arrow.png"), 0, 0),
-		  false, true, false, false, false)
+		  false, true, false, false, false, false)
 	, m_persistence(1)
 	, m_drawing(false)
 {

src/libclient/tools/magicwand.cpp

@@ -87,7 +87,7 @@ class MagicWandTool::Task final : public ToolController::Task {
 MagicWandTool::MagicWandTool(ToolController &owner)
 	: Tool(
 		  owner, MAGICWAND, QCursor(QPixmap(":cursors/magicwand.png"), 2, 2),
-		  true, false, false, false, false)
+		  true, false, false, false, false, false)
 	, m_wandCursor(cursor())
 {
 }

src/libclient/tools/pan.cpp

@@ -9,7 +9,7 @@ namespace tools {
 PanTool::PanTool(ToolController &owner)
 	: Tool(
 		  owner, PAN, QCursor(Qt::OpenHandCursor), true, false, false, true,
-		  false)
+		  false, false)
 {
 }
 

src/libclient/tools/selection.cpp

@@ -9,7 +9,7 @@
 namespace tools {
 
 SelectionTool::SelectionTool(ToolController &owner, Type type, QCursor cursor)
-	: Tool(owner, type, cursor, true, false, false, true, false)
+	: Tool(owner, type, cursor, true, false, false, true, false, false)
 {
 }
 

src/libclient/tools/shapetools.h

@@ -13,7 +13,7 @@ namespace tools {
 class ShapeTool : public Tool {
 public:
 	ShapeTool(ToolController &owner, Type type, QCursor cursor)
-		: Tool(owner, type, cursor, true, true, false, true, true)
+		: Tool(owner, type, cursor, true, true, false, true, false, true)
 	{
 	}
 

src/libclient/tools/tool.cpp

@@ -16,7 +16,7 @@ void Tool::setHandlesRightClick(bool handlesRightClick)
 		if(isActiveTool()) {
 			emit m_owner.toolCapabilitiesChanged(
 				m_allowColorPick, m_allowToolAdjust, m_handlesRightClick,
-				m_fractional, m_ignoresSelections);
+				m_fractional, m_supportsPressure, m_ignoresSelections);
 		}
 	}
 }