[GraphEdit] Improve UI control scheme by separating scroll_offset from scroll bars

Geometror · Geometror · commit 245fa3bcd0a0 · 2025-04-29T13:30:44.000+02:00
diff --git a/editor/plugins/visual_shader_editor_plugin.cpp b/editor/plugins/visual_shader_editor_plugin.cpp
@@ -32,7 +32,6 @@
 
 #include "core/config/project_settings.h"
 #include "core/io/resource_loader.h"
-#include "core/io/resource_uid.h"
 #include "core/math/math_defs.h"
 #include "core/os/keyboard.h"
 #include "core/version_generated.gen.h"
@@ -1550,7 +1549,7 @@ void VisualShaderEditor::edit_shader(const Ref<Shader> &p_shader) {
 			_update_options_menu();
 			_update_preview();
 			_update_graph();
-			call_deferred("_restore_editor_state");
+			callable_mp(this, &VisualShaderEditor::_restore_editor_state).call_deferred();
 		}
 	}
 }
@@ -1577,17 +1576,13 @@ void VisualShaderEditor::validate_script() {
 void VisualShaderEditor::set_current_shader_type(VisualShader::Type p_type) {
 	current_type = p_type;
 
-	String id_string = visual_shader->get_path();
-	const ResourceUID::ID uid = ResourceLoader::get_resource_uid(id_string);
-	if (uid != ResourceUID::INVALID_ID) {
-		id_string = ResourceUID::get_singleton()->id_to_text(uid);
-	}
+	const String id_string = _get_vs_editor_cache_id_string();
 
-	vs_editor_cache->set_value("visual_shader", id_string + ":edited_type", p_type);
+	vs_editor_cache->set_value(id_string, "edited_type", p_type);
 	vs_editor_cache->save(EditorPaths::get_singleton()->get_project_settings_dir().path_join("vs_editor_cache.cfg"));
 
-	const Vector2 saved_scroll_offset = vs_editor_cache->get_value("visual_shader", id_string + ":type" + itos(p_type) + ":offset", Vector2());
-	const real_t saved_zoom = vs_editor_cache->get_value("visual_shader", id_string + ":type" + itos(p_type) + ":zoom", 1.0);
+	const Vector2 saved_scroll_offset = vs_editor_cache->get_value(id_string, "type" + itos(p_type) + ":offset", Vector2());
+	const real_t saved_zoom = vs_editor_cache->get_value(id_string, "type" + itos(p_type) + ":zoom", 1.0);
 
 	graph->set_zoom(saved_zoom);
 	graph->set_scroll_offset(saved_scroll_offset);
@@ -2485,13 +2480,9 @@ void VisualShaderEditor::_set_mode(int p_which) {
 		mode = MODE_FLAGS_SPATIAL_CANVASITEM;
 	}
 
-	String id_string = visual_shader->get_path();
-	const ResourceUID::ID uid = ResourceLoader::get_resource_uid(id_string);
-	if (uid != ResourceUID::INVALID_ID) {
-		id_string = ResourceUID::get_singleton()->id_to_text(uid);
-	}
+	const String id_string = _get_vs_editor_cache_id_string();
 
-	int saved_type = vs_editor_cache->get_value("visual_shader", id_string + ":edited_type", 0);
+	int saved_type = vs_editor_cache->get_value(id_string, "edited_type", 0);
 	edit_type->select(saved_type);
 	set_current_shader_type((VisualShader::Type)saved_type);
 }
@@ -2652,25 +2643,28 @@ void VisualShaderEditor::_update_graph() {
 }
 
 void VisualShaderEditor::_restore_editor_state() {
-	String id_string = visual_shader->get_path();
-	const ResourceUID::ID uid = ResourceLoader::get_resource_uid(id_string);
-	if (uid != ResourceUID::INVALID_ID) {
-		id_string = ResourceUID::get_singleton()->id_to_text(uid);
-	}
+	const String id_string = _get_vs_editor_cache_id_string();
 
 	const int type = get_current_shader_type();
-	// const Vector2 saved_scroll_offset = EditorSettings::get_singleton()->get_project_metadata("visual_shader", uid_text + ":type" + itos(type) + ":offset", Vector2());
-	const Vector2 saved_scroll_offset = vs_editor_cache->get_value("visual_shader", id_string + ":type" + itos(type) + ":offset", Vector2());
-	// const real_t saved_zoom = EditorSettings::get_singleton()->get_project_metadata("visual_shader", uid_text + ":type" + itos(type) + ":zoom", 1.0);
-	const real_t saved_zoom = vs_editor_cache->get_value("visual_shader", id_string + ":type" + itos(type) + ":zoom", 1.0);
+	const Vector2 saved_scroll_offset = vs_editor_cache->get_value(id_string, "type" + itos(type) + ":offset", Vector2());
+	const real_t saved_zoom = vs_editor_cache->get_value(id_string, "type" + itos(type) + ":zoom", 1.0);
 
 	// Setting the scroll offset needs to be double-deferred because it requires min/max scroll offset to be final (as it gets clamped).
-	graph->call_deferred("set_zoom", saved_zoom);
-	graph->call_deferred("set_scroll_offset", saved_scroll_offset);
+	callable_mp(graph, &GraphEdit::set_zoom).call_deferred(saved_zoom);
+	callable_mp(graph, &GraphEdit::set_scroll_offset).call_deferred(saved_scroll_offset);
 
 	shader_fully_loaded = true;
 }
 
+String VisualShaderEditor::_get_vs_editor_cache_id_string() const {
+	String id_string = visual_shader->get_path();
+	const ResourceUID::ID uid = EditorFileSystem::get_singleton()->get_file_uid(id_string);
+	if (uid != ResourceUID::INVALID_ID) {
+		id_string = ResourceUID::get_singleton()->id_to_text(uid);
+	}
+	return id_string;
+}
+
 void VisualShaderEditor::_add_input_port(int p_node, int p_port, int p_port_type, const String &p_name) {
 	VisualShader::Type type = get_current_shader_type();
 	Ref<VisualShaderNodeExpression> node = visual_shader->get_node(type, p_node);
@@ -5192,15 +5186,11 @@ void VisualShaderEditor::_param_unselected() {
 }
 
 void VisualShaderEditor::_panning_debounce_timer_timeout() {
-	String id_string = visual_shader->get_path();
-	const ResourceUID::ID uid = ResourceLoader::get_resource_uid(id_string);
-	if (uid != ResourceUID::INVALID_ID) {
-		id_string = ResourceUID::get_singleton()->id_to_text(uid);
-	}
+	const String id_string = _get_vs_editor_cache_id_string();
 
 	const int type = get_current_shader_type();
-	vs_editor_cache->set_value("visual_shader", id_string + ":type" + itos(type) + ":offset", graph->get_scroll_offset() / EDSCALE);
-	vs_editor_cache->set_value("visual_shader", id_string + ":type" + itos(type) + ":zoom", graph->get_zoom());
+	vs_editor_cache->set_value(id_string, "type" + itos(type) + ":offset", graph->get_scroll_offset() / EDSCALE);
+	vs_editor_cache->set_value(id_string, "type" + itos(type) + ":zoom", graph->get_zoom());
 	vs_editor_cache->save(EditorPaths::get_singleton()->get_project_settings_dir().path_join("vs_editor_cache.cfg"));
 }
 
@@ -6453,7 +6443,6 @@ void VisualShaderEditor::_bind_methods() {
 	ClassDB::bind_method("_update_parameter", &VisualShaderEditor::_update_parameter);
 	ClassDB::bind_method("_update_next_previews", &VisualShaderEditor::_update_next_previews);
 	ClassDB::bind_method("_update_current_param", &VisualShaderEditor::_update_current_param);
-	ClassDB::bind_method("_restore_editor_state", &VisualShaderEditor::_restore_editor_state);
 }
 
 VisualShaderEditor::VisualShaderEditor() {
@@ -7724,7 +7713,7 @@ VisualShaderEditor::VisualShaderEditor() {
 
 	panning_debounce_timer = memnew(Timer);
 	panning_debounce_timer->set_one_shot(true);
-	panning_debounce_timer->set_wait_time(0.25);
+	panning_debounce_timer->set_wait_time(1.0);
 	panning_debounce_timer->connect("timeout", callable_mp(this, &VisualShaderEditor::_panning_debounce_timer_timeout));
 	add_child(panning_debounce_timer);
 }
diff --git a/editor/plugins/visual_shader_editor_plugin.h b/editor/plugins/visual_shader_editor_plugin.h
@@ -389,6 +389,8 @@ class VisualShaderEditor : public ShaderEditor {
 
 	void _restore_editor_state();
 
+	String _get_vs_editor_cache_id_string() const;
+
 	struct AddOption {
 		String name;
 		String category;
diff --git a/misc/extension_api_validation/4.4-stable.expected b/misc/extension_api_validation/4.4-stable.expected
@@ -89,4 +89,4 @@ GH-98566
 Validate extension JSON: API was removed: classes/VisualShader/methods/set_graph_offset
 Validate extension JSON: API was removed: classes/VisualShader/methods/get_graph_offset
 
-The graph_offset property was removed from the resource. This information is now stored as project metadata.
+The graph_offset property was removed from the resource. This information is now stored in `vs_editor_cache.cfg`.
diff --git a/scene/gui/graph_edit.cpp b/scene/gui/graph_edit.cpp
@@ -115,11 +115,11 @@ Vector2 GraphEditMinimap::_get_render_size() {
 }
 
 Vector2 GraphEditMinimap::_get_graph_offset() {
-	return Vector2(ge->h_scrollbar->get_min(), ge->v_scrollbar->get_min());
+	return ge->min_scroll_offset;
 }
 
 Vector2 GraphEditMinimap::_get_graph_size() {
-	Vector2 graph_size = Vector2(ge->h_scrollbar->get_max(), ge->v_scrollbar->get_max()) - Vector2(ge->h_scrollbar->get_min(), ge->v_scrollbar->get_min());
+	Vector2 graph_size = ge->max_scroll_offset - ge->min_scroll_offset;
 
 	if (graph_size.width == 0) {
 		graph_size.width = 1;
@@ -411,17 +411,25 @@ String GraphEdit::get_connections_description(const StringName &p_node, int p_po
 
 void GraphEdit::set_scroll_offset(const Vector2 &p_offset) {
 	setting_scroll_offset = true;
-	h_scrollbar->set_value(p_offset.x);
-	v_scrollbar->set_value(p_offset.y);
-	_update_scroll();
+	scroll_offset = p_offset.clamp(min_scroll_offset, max_scroll_offset - get_size());
+	if (!awaiting_scroll_offset_update) {
+		callable_mp(this, &GraphEdit::_update_scroll_offset).call_deferred();
+		awaiting_scroll_offset_update = true;
+	}
+	minimap->queue_redraw();
+	queue_redraw();
+	_update_scrollbars();
+	callable_mp(this, &GraphEdit::_update_top_connection_layer).call_deferred();
 	setting_scroll_offset = false;
 }
 
 Vector2 GraphEdit::get_scroll_offset() const {
-	return Vector2(h_scrollbar->get_value(), v_scrollbar->get_value());
+	return scroll_offset;
 }
 
-void GraphEdit::_scroll_moved(double) {
+void GraphEdit::_scrollbar_moved(double) {
+	scroll_offset.x = h_scrollbar->get_value();
+	scroll_offset.y = v_scrollbar->get_value();
 	if (!awaiting_scroll_offset_update) {
 		callable_mp(this, &GraphEdit::_update_scroll_offset).call_deferred();
 		awaiting_scroll_offset_update = true;
@@ -443,14 +451,14 @@ void GraphEdit::_update_scroll_offset() {
 		}
 
 		Point2 pos = graph_element->get_position_offset() * zoom;
-		pos -= Point2(h_scrollbar->get_value(), v_scrollbar->get_value());
+		pos -= scroll_offset;
 		graph_element->set_position(pos);
 		if (graph_element->get_scale() != Vector2(zoom, zoom)) {
 			graph_element->set_scale(Vector2(zoom, zoom));
 		}
 	}
 
-	connections_layer->set_position(-Point2(h_scrollbar->get_value(), v_scrollbar->get_value()));
+	connections_layer->set_position(-scroll_offset);
 	set_block_minimum_size_adjust(false);
 	awaiting_scroll_offset_update = false;
 
@@ -460,14 +468,18 @@ void GraphEdit::_update_scroll_offset() {
 	}
 }
 
-void GraphEdit::_update_scroll() {
+void GraphEdit::_update_scrollbars() {
 	if (updating) {
 		return;
 	}
 	updating = true;
 
+	h_scrollbar->set_value_no_signal(scroll_offset.x);
+	v_scrollbar->set_value_no_signal(scroll_offset.y);
+
 	set_block_minimum_size_adjust(true);
 
+	// Determine the graph "canvas" size in screen space.
 	Rect2 screen_rect;
 	for (int i = 0; i < get_child_count(); i++) {
 		GraphElement *graph_element = Object::cast_to<GraphElement>(get_child(i));
@@ -484,6 +496,9 @@ void GraphEdit::_update_scroll() {
 	screen_rect.position -= get_size();
 	screen_rect.size += get_size() * 2.0;
 
+	min_scroll_offset = screen_rect.position;
+	max_scroll_offset = screen_rect.position + screen_rect.size;
+
 	h_scrollbar->set_min(screen_rect.position.x);
 	h_scrollbar->set_max(screen_rect.position.x + screen_rect.size.width);
 	h_scrollbar->set_page(get_size().x);
@@ -847,7 +862,7 @@ void GraphEdit::_notification(int p_what) {
 		} break;
 
 		case NOTIFICATION_RESIZED: {
-			_update_scroll();
+			_update_scrollbars();
 			minimap->queue_redraw();
 			callable_mp(this, &GraphEdit::_update_top_connection_layer).call_deferred();
 		} break;
@@ -1712,7 +1727,7 @@ void GraphEdit::_top_layer_draw() {
 }
 
 void GraphEdit::_update_top_connection_layer() {
-	_update_scroll();
+	_update_scrollbars();
 
 	if (!connecting) {
 		dragged_connection_line->clear_points();
@@ -2296,9 +2311,15 @@ void GraphEdit::gui_input(const Ref<InputEvent> &p_ev) {
 void GraphEdit::_pan_callback(Vector2 p_scroll_vec, Ref<InputEvent> p_event) {
 	ERR_FAIL_NULL_MSG(connections_layer, "connections_layer is missing.");
 
-	h_scrollbar->set_value(h_scrollbar->get_value() - p_scroll_vec.x);
-	v_scrollbar->set_value(v_scrollbar->get_value() - p_scroll_vec.y);
+	scroll_offset = (scroll_offset - p_scroll_vec).clamp(min_scroll_offset, max_scroll_offset - get_size());
 
+	if (!awaiting_scroll_offset_update) {
+		callable_mp(this, &GraphEdit::_update_scroll_offset).call_deferred();
+		awaiting_scroll_offset_update = true;
+	}
+	minimap->queue_redraw();
+	queue_redraw();
+	callable_mp(this, &GraphEdit::_update_top_connection_layer).call_deferred();
 	connections_layer->queue_redraw();
 }
 
@@ -2400,7 +2421,7 @@ void GraphEdit::set_zoom_custom(float p_zoom, const Vector2 &p_center) {
 		return;
 	}
 
-	Vector2 scrollbar_offset = (Vector2(h_scrollbar->get_value(), v_scrollbar->get_value()) + p_center) / zoom;
+	Point2 zoom_anchor = (scroll_offset + p_center) / zoom;
 
 	zoom = p_zoom;
 
@@ -2409,14 +2430,12 @@ void GraphEdit::set_zoom_custom(float p_zoom, const Vector2 &p_center) {
 	zoom_minus_button->set_disabled(zoom == zoom_min);
 	zoom_plus_button->set_disabled(zoom == zoom_max);
 
-	_update_scroll();
+	_update_scrollbars();
 	minimap->queue_redraw();
 	connections_layer->queue_redraw();
 
 	if (is_visible_in_tree()) {
-		Vector2 offset = scrollbar_offset * zoom - p_center;
-		h_scrollbar->set_value(offset.x);
-		v_scrollbar->set_value(offset.y);
+		scroll_offset = zoom_anchor * zoom - p_center;
 	}
 
 	_update_zoom_label();
@@ -3180,8 +3199,8 @@ GraphEdit::GraphEdit() {
 	v_scrollbar->set_min(-10000);
 	v_scrollbar->set_max(10000);
 
-	h_scrollbar->connect(SceneStringName(value_changed), callable_mp(this, &GraphEdit::_scroll_moved));
-	v_scrollbar->connect(SceneStringName(value_changed), callable_mp(this, &GraphEdit::_scroll_moved));
+	h_scrollbar->connect(SceneStringName(value_changed), callable_mp(this, &GraphEdit::_scrollbar_moved));
+	v_scrollbar->connect(SceneStringName(value_changed), callable_mp(this, &GraphEdit::_scrollbar_moved));
 
 	// Toolbar menu.
 
diff --git a/scene/gui/graph_edit.h b/scene/gui/graph_edit.h
@@ -228,6 +228,10 @@ class GraphEdit : public Control {
 	float zoom_min = 0.0;
 	float zoom_max = 0.0;
 
+	Vector2 min_scroll_offset;
+	Vector2 max_scroll_offset;
+	Vector2 scroll_offset;
+
 	bool box_selecting = false;
 	bool box_selection_mode_additive = false;
 	Point2 box_selecting_from;
@@ -327,9 +331,9 @@ class GraphEdit : public Control {
 	void _ensure_node_order_from_root(const StringName &p_node);
 	void _ensure_node_order_from(Node *p_node);
 
-	void _update_scroll();
+	void _update_scrollbars();
 	void _update_scroll_offset();
-	void _scroll_moved(double);
+	void _scrollbar_moved(double);
 	virtual void gui_input(const Ref<InputEvent> &p_ev) override;
 	void _top_connection_layer_input(const Ref<InputEvent> &p_ev);
 
