Refactor vector editor properties

1 files changed, 258 insertions, 0 deletions

diff --git a/editor/editor_properties_vector.cpp b/editor/editor_properties_vector.cpp
new file mode 100644
index 0000000000..28ea0dc36d
--- /dev/null
+++ b/editor/editor_properties_vector.cpp
@@ -0,0 +1,258 @@
+/**************************************************************************/
+/*  editor_properties_vector.cpp                                          */
+/**************************************************************************/
+/*                         This file is part of:                          */
+/*                             GODOT ENGINE                               */
+/*                        https://godotengine.org                         */
+/**************************************************************************/
+/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
+/*                                                                        */
+/* Permission is hereby granted, free of charge, to any person obtaining  */
+/* a copy of this software and associated documentation files (the        */
+/* "Software"), to deal in the Software without restriction, including    */
+/* without limitation the rights to use, copy, modify, merge, publish,    */
+/* distribute, sublicense, and/or sell copies of the Software, and to     */
+/* permit persons to whom the Software is furnished to do so, subject to  */
+/* the following conditions:                                              */
+/*                                                                        */
+/* The above copyright notice and this permission notice shall be         */
+/* included in all copies or substantial portions of the Software.        */
+/*                                                                        */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
+/**************************************************************************/
+
+#include "editor_properties_vector.h"
+
+#include "editor/editor_settings.h"
+#include "editor/gui/editor_spin_slider.h"
+#include "scene/gui/box_container.h"
+#include "scene/gui/texture_button.h"
+
+const String EditorPropertyVectorN::COMPONENT_LABELS[4] = { "x", "y", "z", "w" };
+
+int EditorPropertyVectorN::_get_ratio_component(int p_idx, int p_component) const {
+	int i = p_idx / (component_count - 1);
+	if (p_component == 1) {
+		return i;
+	} else {
+		return (i + p_idx % (component_count - 1) + 1) % component_count;
+	}
+}
+
+void EditorPropertyVectorN::_set_read_only(bool p_read_only) {
+	for (EditorSpinSlider *spin : spin_sliders) {
+		spin->set_read_only(p_read_only);
+	}
+}
+
+void EditorPropertyVectorN::_value_changed(double val, const String &p_name) {
+	if (linked->is_pressed()) {
+		// TODO: The logic here can be simplified. _get_ratio_component() only exists,
+		// because the exact code was difficult to figure out.
+		for (int i = 0; i < component_count; i++) {
+			if (p_name == COMPONENT_LABELS[i]) {
+				for (int j = 0; j < ratio.size(); j++) {
+					if (_get_ratio_component(j, 1) == i) {
+						for (int k = 0; k < component_count - 1; k++) {
+							spin_sliders[_get_ratio_component(j + k, 0)]->set_value_no_signal(spin_sliders[_get_ratio_component(j + k, 1)]->get_value() * ratio[j + k]);
+						}
+						break;
+					}
+				}
+				break;
+			}
+		}
+	}
+
+	Variant v;
+	Callable::CallError cerror;
+	Variant::construct(vector_type, v, nullptr, 0, cerror);
+
+	for (int i = 0; i < component_count; i++) {
+		if (angle_in_radians) {
+			v.set(i, Math::deg_to_rad(spin_sliders[i]->get_value()));
+		} else {
+			v.set(i, spin_sliders[i]->get_value());
+		}
+	}
+	emit_changed(get_edited_property(), v, linked->is_pressed() ? "" : p_name);
+}
+
+void EditorPropertyVectorN::update_property() {
+	Variant val = get_edited_property_value();
+	for (int i = 0; i < component_count; i++) {
+		if (angle_in_radians) {
+			spin_sliders[i]->set_value_no_signal(Math::rad_to_deg((real_t)val.get(i)));
+		} else {
+			spin_sliders[i]->set_value_no_signal(val.get(i));
+		}
+	}
+	_update_ratio();
+}
+
+void EditorPropertyVectorN::_update_ratio() {
+	linked->set_modulate(Color(1, 1, 1, linked->is_pressed() ? 1.0 : 0.5));
+
+	bool non_zero = true;
+	for (int i = 0; i < component_count; i++) {
+		if (spin_sliders[i]->get_value() == 0) {
+			non_zero = false;
+			break;
+		}
+	}
+
+	double *ratio_write = ratio.ptrw();
+	for (int i = 0; i < ratio.size(); i++) {
+		if (non_zero) {
+			ratio_write[i] = spin_sliders[_get_ratio_component(i, 0)]->get_value() / spin_sliders[_get_ratio_component(i, 1)]->get_value();
+		} else {
+			ratio_write[i] = 1.0;
+		}
+	}
+}
+
+void EditorPropertyVectorN::_store_link(bool p_linked) {
+	if (!get_edited_object()) {
+		return;
+	}
+	const String key = vformat("%s:%s", get_edited_object()->get_class(), get_edited_property());
+	EditorSettings::get_singleton()->set_project_metadata("linked_properties", key, p_linked);
+}
+
+void EditorPropertyVectorN::_notification(int p_what) {
+	switch (p_what) {
+		case NOTIFICATION_READY: {
+			if (linked->is_visible()) {
+				const String key = vformat("%s:%s", get_edited_object()->get_class(), get_edited_property());
+				linked->set_pressed(EditorSettings::get_singleton()->get_project_metadata("linked_properties", key, true));
+			}
+		} break;
+
+		case NOTIFICATION_THEME_CHANGED: {
+			linked->set_texture_normal(get_theme_icon(SNAME("Unlinked"), SNAME("EditorIcons")));
+			linked->set_texture_pressed(get_theme_icon(SNAME("Instance"), SNAME("EditorIcons")));
+
+			const Color *colors = _get_property_colors();
+			for (int i = 0; i < component_count; i++) {
+				spin_sliders[i]->add_theme_color_override("label_color", colors[i]);
+			}
+		} break;
+	}
+}
+
+void EditorPropertyVectorN::setup(double p_min, double p_max, double p_step, bool p_hide_slider, bool p_link, const String &p_suffix, bool p_angle_in_radians) {
+	angle_in_radians = p_angle_in_radians;
+
+	for (EditorSpinSlider *spin : spin_sliders) {
+		spin->set_min(p_min);
+		spin->set_max(p_max);
+		spin->set_step(p_step);
+		spin->set_hide_slider(p_hide_slider);
+		spin->set_allow_greater(true);
+		spin->set_allow_lesser(true);
+		spin->set_suffix(p_suffix);
+	}
+
+	if (!p_link) {
+		linked->hide();
+	}
+}
+
+EditorPropertyVectorN::EditorPropertyVectorN(Variant::Type p_type, bool p_force_wide, bool p_horizontal) {
+	vector_type = p_type;
+	switch (vector_type) {
+		case Variant::VECTOR2:
+		case Variant::VECTOR2I:
+			component_count = 2;
+			break;
+
+		case Variant::VECTOR3:
+		case Variant::VECTOR3I:
+			component_count = 3;
+			break;
+
+		case Variant::VECTOR4:
+		case Variant::VECTOR4I:
+			component_count = 4;
+			break;
+
+		default: // Needed to silence a warning.
+			ERR_PRINT("Not a Vector type.");
+			break;
+	}
+	bool horizontal = p_force_wide || p_horizontal;
+
+	HBoxContainer *hb = memnew(HBoxContainer);
+	hb->set_h_size_flags(SIZE_EXPAND_FILL);
+
+	BoxContainer *bc;
+
+	if (p_force_wide) {
+		bc = memnew(HBoxContainer);
+		hb->add_child(bc);
+	} else if (horizontal) {
+		bc = memnew(HBoxContainer);
+		hb->add_child(bc);
+		set_bottom_editor(hb);
+	} else {
+		bc = memnew(VBoxContainer);
+		hb->add_child(bc);
+	}
+	bc->set_h_size_flags(SIZE_EXPAND_FILL);
+
+	spin_sliders.resize(component_count);
+	EditorSpinSlider **spin = spin_sliders.ptrw();
+
+	for (int i = 0; i < component_count; i++) {
+		spin[i] = memnew(EditorSpinSlider);
+		spin[i]->set_flat(true);
+		spin[i]->set_label(String(COMPONENT_LABELS[i]));
+		bc->add_child(spin[i]);
+		add_focusable(spin[i]);
+		spin[i]->connect("value_changed", callable_mp(this, &EditorPropertyVectorN::_value_changed).bind(String(COMPONENT_LABELS[i])));
+		if (horizontal) {
+			spin[i]->set_h_size_flags(SIZE_EXPAND_FILL);
+		}
+	}
+
+	ratio.resize(component_count * (component_count - 1));
+	ratio.fill(1.0);
+
+	linked = memnew(TextureButton);
+	linked->set_toggle_mode(true);
+	linked->set_stretch_mode(TextureButton::STRETCH_KEEP_CENTERED);
+	linked->set_tooltip_text(TTR("Lock/Unlock Component Ratio"));
+	linked->connect(SNAME("pressed"), callable_mp(this, &EditorPropertyVectorN::_update_ratio));
+	linked->connect(SNAME("toggled"), callable_mp(this, &EditorPropertyVectorN::_store_link));
+	hb->add_child(linked);
+
+	add_child(hb);
+	if (!horizontal) {
+		set_label_reference(spin_sliders[0]); // Show text and buttons around this.
+	}
+}
+
+EditorPropertyVector2::EditorPropertyVector2(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR2, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector2_editing")) {}
+
+EditorPropertyVector2i::EditorPropertyVector2i(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR2I, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector2_editing")) {}
+
+EditorPropertyVector3::EditorPropertyVector3(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR3, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector_types_editing")) {}
+
+EditorPropertyVector3i::EditorPropertyVector3i(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR3I, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector_types_editing")) {}
+
+EditorPropertyVector4::EditorPropertyVector4(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR4, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector_types_editing")) {}
+
+EditorPropertyVector4i::EditorPropertyVector4i(bool p_force_wide) :
+		EditorPropertyVectorN(Variant::VECTOR4I, p_force_wide, EDITOR_GET("interface/inspector/horizontal_vector_types_editing")) {}