Fix getting wrong focus neighbor when the control is in `ScrollContai…

…ner` Exclude controls inside a `ScrollContainer` that are outside the visible area of the `ScrollContainer` when looking for focus neighbors.
Rindbee · Dec 31, 2024 · da54ca9 · da54ca9
1 parent 2582793
commit da54ca9
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/scene/gui/control.cpp b/scene/gui/control.cpp
@@ -2327,7 +2327,9 @@ Control *Control::_get_focus_neighbor(Side p_side, int p_count) {
 		return nullptr;
 	}
 
-	_window_find_focus_neighbor(vdir, base, points, maxd, dist, &result);
+	Rect2 clamp = Rect2(Point2(-1e7, -1e7), Size2(2e7, 2e7));
+
+	_window_find_focus_neighbor(vdir, base, points, clamp, maxd, dist, &result);
 
 	return result;
 }
@@ -2336,14 +2338,14 @@ Control *Control::find_valid_focus_neighbor(Side p_side) const {
 	return const_cast<Control *>(this)->_get_focus_neighbor(p_side);
 }
 
-void Control::_window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, real_t p_min, real_t &r_closest_dist, Control **r_closest) {
+void Control::_window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, Rect2 &p_clamp, real_t p_min, real_t &r_closest_dist, Control **r_closest) {
 	if (Object::cast_to<Viewport>(p_at)) {
 		return; //bye
 	}
 
 	Control *c = Object::cast_to<Control>(p_at);
 
-	if (c && c != this && c->get_focus_mode() == FOCUS_ALL && c->is_visible_in_tree()) {
+	if (c && c != this && c->get_focus_mode() == FOCUS_ALL && c->is_visible_in_tree() && p_clamp.encloses(c->get_global_rect())) {
 		Point2 points[4];
 
 		Transform2D xform = c->get_global_transform();
@@ -2406,13 +2408,22 @@ void Control::_window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, cons
 		}
 	}
 
+	ScrollContainer *sc = Object::cast_to<ScrollContainer>(c);
+	Rect2 intersection = p_clamp;
+	if (sc && !sc->is_following_focus()) {
+		intersection = p_clamp.intersection(sc->get_global_rect());
+		if (!intersection.has_area()) {
+			return;
+		}
+	}
+
 	for (int i = 0; i < p_at->get_child_count(); i++) {
 		Node *child = p_at->get_child(i);
 		Control *childc = Object::cast_to<Control>(child);
 		if (childc && childc->data.RI) {
 			continue; //subwindow, ignore
 		}
-		_window_find_focus_neighbor(p_dir, p_at->get_child(i), p_points, p_min, r_closest_dist, r_closest);
+		_window_find_focus_neighbor(p_dir, p_at->get_child(i), p_points, intersection, p_min, r_closest_dist, r_closest);
 	}
 }
 

diff --git a/scene/gui/control.h b/scene/gui/control.h
@@ -314,7 +314,7 @@ class Control : public CanvasItem {
 
 	// Focus.
 
-	void _window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, real_t p_min, real_t &r_closest_dist, Control **r_closest);
+	void _window_find_focus_neighbor(const Vector2 &p_dir, Node *p_at, const Point2 *p_points, Rect2 &p_clamp, real_t p_min, real_t &r_closest_dist, Control **r_closest);
 	Control *_get_focus_neighbor(Side p_side, int p_count = 0);
 
 	// Theming.