From 8e00035f086c62558d03217a1f4c03594618344e Mon Sep 17 00:00:00 2001
From: Markus Sauermann <6299227+Sauermann@users.noreply.github.com>
Date: Sun, 1 Dec 2024 00:45:09 +0100
Subject: [PATCH] Introduce `Viewport` functions for keeping the mouse over
state consistent
---
doc/classes/Viewport.xml | 14 ++++++++++++++
scene/main/viewport.cpp | 18 ++++++++++++++++++
scene/main/viewport.h | 2 ++
3 files changed, 34 insertions(+)
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml
index 3e772c4e884..1f28a344313 100644
--- a/doc/classes/Viewport.xml
+++ b/doc/classes/Viewport.xml
@@ -188,6 +188,20 @@
If [member handle_input_locally] is set to [code]false[/code], this method will try finding the first parent viewport that is set to handle input locally, and return its value for [method is_input_handled] instead.
+
+
+
+ Inform the Viewport that the mouse has entered its area. Use this function before sending an [InputEventMouseButton] or [InputEventMouseMotion] to the [Viewport] with [method Viewport.push_input]. See also [method notify_mouse_exited].
+ [b]Note:[/b] In most cases, it is not necessary to call this function because [SubViewport] nodes that are children of [SubViewportContainer] are notified automatically. This is only necessary when interacting with viewports in non-default ways, for example as textures in [TextureRect] or with an [Area3D] that forwards input events.
+
+
+
+
+
+ Inform the Viewport that the mouse has left its area. Use this function when the node that displays the viewport notices the mouse has left the area of the displayed viewport. See also [method notify_mouse_entered].
+ [b]Note:[/b] In most cases, it is not necessary to call this function because [SubViewport] nodes that are children of [SubViewportContainer] are notified automatically. This is only necessary when interacting with viewports in non-default ways, for example as textures in [TextureRect] or with an [Area3D] that forwards input events.
+
+
diff --git a/scene/main/viewport.cpp b/scene/main/viewport.cpp
index 6c83c7843fb..6073a2950fb 100644
--- a/scene/main/viewport.cpp
+++ b/scene/main/viewport.cpp
@@ -3257,6 +3257,22 @@ void Viewport::_push_unhandled_input_internal(const Ref &p_event) {
}
}
+void Viewport::notify_mouse_entered() {
+ if (gui.mouse_in_viewport) {
+ WARN_PRINT_ED("The Viewport was previously notified that the mouse is in its area. There is no need to notify it at this time.");
+ return;
+ }
+ notification(NOTIFICATION_VP_MOUSE_ENTER);
+}
+
+void Viewport::notify_mouse_exited() {
+ if (!gui.mouse_in_viewport) {
+ WARN_PRINT_ED("The Viewport was previously notified that the mouse has left its area. There is no need to notify it at this time.");
+ return;
+ }
+ _mouse_leave_viewport();
+}
+
void Viewport::set_physics_object_picking(bool p_enable) {
ERR_MAIN_THREAD_GUARD;
physics_object_picking = p_enable;
@@ -4679,6 +4695,8 @@ void Viewport::_bind_methods() {
#ifndef DISABLE_DEPRECATED
ClassDB::bind_method(D_METHOD("push_unhandled_input", "event", "in_local_coords"), &Viewport::push_unhandled_input, DEFVAL(false));
#endif // DISABLE_DEPRECATED
+ ClassDB::bind_method(D_METHOD("notify_mouse_entered"), &Viewport::notify_mouse_entered);
+ ClassDB::bind_method(D_METHOD("notify_mouse_exited"), &Viewport::notify_mouse_exited);
ClassDB::bind_method(D_METHOD("get_mouse_position"), &Viewport::get_mouse_position);
ClassDB::bind_method(D_METHOD("warp_mouse", "position"), &Viewport::warp_mouse);
diff --git a/scene/main/viewport.h b/scene/main/viewport.h
index 3a5ad2d83cb..940b001f1f3 100644
--- a/scene/main/viewport.h
+++ b/scene/main/viewport.h
@@ -578,6 +578,8 @@ public:
#ifndef DISABLE_DEPRECATED
void push_unhandled_input(const Ref &p_event, bool p_local_coords = false);
#endif // DISABLE_DEPRECATED
+ void notify_mouse_entered();
+ void notify_mouse_exited();
void set_disable_input(bool p_disable);
bool is_input_disabled() const;