Back to UI Work

- UIAdapter -> UITools with cleaner API
- GUIOverlappingElementsBox (for core and modifier icons)
- Improved GUINode API
- Province building slots
- TypeHints for files in the GameSession folder
- Incorporate SIM strong colour types

1 files changed, 92 insertions, 81 deletions

diff --git a/extension/src/openvic-extension/classes/GUINode.cpp b/extension/src/openvic-extension/classes/GUINode.cpp
index 1d55c54..043f65d 100644
--- a/extension/src/openvic-extension/classes/GUINode.cpp
+++ b/extension/src/openvic-extension/classes/GUINode.cpp
@@ -3,10 +3,8 @@
 #include <godot_cpp/classes/style_box_texture.hpp>
 #include <godot_cpp/variant/utility_functions.hpp>
 
-#include "openvic-extension/UIAdapter.hpp"
-#include "openvic-extension/singletons/AssetManager.hpp"
-#include "openvic-extension/singletons/GameSingleton.hpp"
 #include "openvic-extension/utility/ClassBindings.hpp"
+#include "openvic-extension/utility/UITools.hpp"
 #include "openvic-extension/utility/Utilities.hpp"
 
 using namespace godot;
@@ -15,33 +13,58 @@ using namespace OpenVic;
 using OpenVic::Utilities::godot_to_std_string;
 using OpenVic::Utilities::std_view_to_godot_string;
 
+#define APPLY_TO_CHILD_TYPES(F) \
+	F(Button, button) \
+	F(CheckBox, check_box) \
+	F(Label, label) \
+	F(Panel, panel) \
+	F(TextureProgressBar, progress_bar) \
+	F(TextureRect, texture_rect) \
+	F(GUIOverlappingElementsBox, gui_overlapping_elements_box)
+
+#define APPLY_TO_TEXTURE_TYPES(F) \
+	F(GFXIconTexture, gfx_icon_texture) \
+	F(GFXMaskedFlagTexture, gfx_masked_flag_texture) \
+	F(GFXPieChartTexture, gfx_pie_chart_texture)
+
 void GUINode::_bind_methods() {
+	OV_BIND_SMETHOD(generate_gui_element, { "gui_file", "gui_element", "name" }, DEFVAL(String {}));
 	OV_BIND_METHOD(GUINode::add_gui_element, { "gui_file", "gui_element", "name" }, DEFVAL(String {}));
 
-	OV_BIND_METHOD(GUINode::get_button_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_check_box_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_label_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_panel_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_progress_bar_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_texture_rect_node, { "path" });
+#define GET_BINDINGS(type, name) \
+	OV_BIND_SMETHOD(get_##name##_from_node, { "node" }); \
+	OV_BIND_METHOD(GUINode::get_##name##_from_nodepath, { "path" });
+
+	APPLY_TO_CHILD_TYPES(GET_BINDINGS)
+
+	OV_BIND_SMETHOD(get_texture_from_node, { "node" });
+	OV_BIND_METHOD(GUINode::get_texture_from_nodepath, { "path" });
+
+	APPLY_TO_TEXTURE_TYPES(GET_BINDINGS)
 
-	OV_BIND_METHOD(GUINode::get_texture_from_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_gfx_icon_texture_from_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_gfx_masked_flag_texture_from_node, { "path" });
-	OV_BIND_METHOD(GUINode::get_gfx_pie_chart_texture_from_node, { "path" });
+#undef GET_BINDINGS
 
 	OV_BIND_METHOD(GUINode::hide_node, { "path" });
 	OV_BIND_METHOD(GUINode::hide_nodes, { "paths" });
 }
 
-Error GUINode::_add_gui_element(GUI::Element const* element, String const& name) {
-	ERR_FAIL_NULL_V(element, FAILED);
-	AssetManager* asset_manager = AssetManager::get_singleton();
-	ERR_FAIL_NULL_V(asset_manager, FAILED);
+GUINode::GUINode() {
+	set_mouse_filter(MOUSE_FILTER_IGNORE);
+}
+
+Control* GUINode::generate_gui_element(String const& gui_file, String const& gui_element, String const& name) {
+	Control* result = nullptr;
+	if (!UITools::generate_gui_element(gui_file, gui_element, name, result)) {
+		UtilityFunctions::push_error("Error generating GUI element ", gui_element, " from GUI file ", gui_file);
+	}
+	return result;
+}
+
+Error GUINode::add_gui_element(String const& gui_file, String const& gui_element, String const& name) {
 	Error err = OK;
 	Control* result = nullptr;
-	if (!GodotGUIBuilder::generate_element(element, name, *asset_manager, result)) {
-		UtilityFunctions::push_error("Failed to generate GUI element ", std_view_to_godot_string(element->get_name()));
+	if (!UITools::generate_gui_element(gui_file, gui_element, name, result)) {
+		UtilityFunctions::push_error("Error generating GUI element ", gui_element, " from GUI file ", gui_file);
 		err = FAILED;
 	}
 	if (result != nullptr) {
@@ -50,107 +73,95 @@ Error GUINode::_add_gui_element(GUI::Element const* element, String const& name)
 	return err;
 }
 
-Error GUINode::add_gui_element(String const& gui_file, String const& gui_element, String const& name) {
-	GameSingleton const* game_singleton = GameSingleton::get_singleton();
-	ERR_FAIL_NULL_V(game_singleton, FAILED);
-	GUI::Scene const* scene =
-		game_singleton->get_game_manager().get_ui_manager().get_scene_by_identifier(godot_to_std_string(gui_file));
-	ERR_FAIL_NULL_V_MSG(scene, FAILED, vformat("Failed to find GUI file %s", gui_file));
-	GUI::Element const* element = scene->get_scene_element_by_identifier(godot_to_std_string(gui_element));
-	ERR_FAIL_NULL_V_MSG(element, FAILED, vformat("Failed to find GUI element %s in GUI file %s", gui_element, gui_file));
-	return _add_gui_element(element, name);
-}
-
 template<std::derived_from<godot::Node> T>
-T* GUINode::_get_cast_node(NodePath const& path) const {
-	Node* node = get_node_or_null(path);
-	ERR_FAIL_NULL_V_MSG(node, nullptr, vformat("Failed to find node %s", path));
+static T* _cast_node(Node* node) {
+	ERR_FAIL_NULL_V(node, nullptr);
 	T* result = Object::cast_to<T>(node);
-	ERR_FAIL_NULL_V_MSG(result, nullptr, vformat("Failed to cast node %s to type %s", path, T::get_class_static()));
+	ERR_FAIL_NULL_V_MSG(
+		result, nullptr,
+		vformat("Failed to cast node %s from type %s to %s", node->get_name(), node->get_class(), T::get_class_static())
+	);
 	return result;
 }
 
-Button* GUINode::get_button_node(NodePath const& path) const {
-	return _get_cast_node<Button>(path);
-}
-
-CheckBox* GUINode::get_check_box_node(NodePath const& path) const {
-	return _get_cast_node<CheckBox>(path);
-}
-
-Label* GUINode::get_label_node(NodePath const& path) const {
-	return _get_cast_node<Label>(path);
-}
-
-Panel* GUINode::get_panel_node(NodePath const& path) const {
-	return _get_cast_node<Panel>(path);
-}
+#define CHILD_GET_FUNCTIONS(type, name) \
+	type* GUINode::get_##name##_from_node(Node* node) { \
+		return _cast_node<type>(node); \
+	} \
+	type* GUINode::get_##name##_from_nodepath(NodePath const& path) const { \
+		return _cast_node<type>(get_node_internal(path)); \
+	}
 
-TextureProgressBar* GUINode::get_progress_bar_node(NodePath const& path) const {
-	return _get_cast_node<TextureProgressBar>(path);
-}
+APPLY_TO_CHILD_TYPES(CHILD_GET_FUNCTIONS)
 
-TextureRect* GUINode::get_texture_rect_node(NodePath const& path) const {
-	return _get_cast_node<TextureRect>(path);
-}
+#undef CHILD_GET_FUNCTIONS
 
-Ref<Texture2D> GUINode::get_texture_from_node(NodePath const& path) const {
-	Node* node = get_node_or_null(path);
-	ERR_FAIL_NULL_V_MSG(node, nullptr, vformat("Failed to find node %s", path));
+Ref<Texture2D> GUINode::get_texture_from_node(Node* node) {
+	ERR_FAIL_NULL_V(node, nullptr);
 	if (TextureRect const* texture_rect = Object::cast_to<TextureRect>(node); texture_rect != nullptr) {
 		const Ref<Texture2D> texture = texture_rect->get_texture();
-		ERR_FAIL_NULL_V_MSG(texture, nullptr, vformat("Failed to get Texture2D from TextureRect %s", path));
+		ERR_FAIL_NULL_V_MSG(texture, nullptr, vformat("Failed to get Texture2D from TextureRect %s", node->get_name()));
 		return texture;
 	} else if (Button const* button = Object::cast_to<Button>(node); button != nullptr) {
 		static const StringName theme_name_normal = "normal";
 		const Ref<StyleBox> stylebox = button->get_theme_stylebox(theme_name_normal);
-		ERR_FAIL_NULL_V_MSG(stylebox, nullptr, vformat("Failed to get StyleBox %s from Button %s", theme_name_normal, path));
+		ERR_FAIL_NULL_V_MSG(
+			stylebox, nullptr, vformat("Failed to get StyleBox %s from Button %s", theme_name_normal, node->get_name())
+		);
 		const Ref<StyleBoxTexture> stylebox_texture = stylebox;
 		ERR_FAIL_NULL_V_MSG(
 			stylebox_texture, nullptr, vformat(
-				"Failed to cast StyleBox %s from Button %s to type StyleBoxTexture", theme_name_normal, path
+				"Failed to cast StyleBox %s from Button %s to type StyleBoxTexture", theme_name_normal, node->get_name()
 			)
 		);
 		const Ref<Texture2D> result = stylebox_texture->get_texture();
 		ERR_FAIL_NULL_V_MSG(
-			result, nullptr, vformat("Failed to get Texture2D from StyleBoxTexture %s from Button %s", theme_name_normal, path)
+			result, nullptr,
+			vformat("Failed to get Texture2D from StyleBoxTexture %s from Button %s", theme_name_normal, node->get_name())
 		);
 		return result;
 	}
-	ERR_FAIL_V_MSG(nullptr, vformat("Failed to cast node %s to type TextureRect or Button", path));
+	ERR_FAIL_V_MSG(
+		nullptr, vformat("Failed to cast node %s from type %s to TextureRect or Button", node->get_name(), node->get_class())
+	);
+}
+
+Ref<Texture2D> GUINode::get_texture_from_nodepath(NodePath const& path) const {
+	return get_texture_from_node(get_node_internal(path));
 }
 
-template<std::derived_from<godot::Texture2D> T>
-Ref<T> GUINode::_get_cast_texture_from_node(NodePath const& path) const {
-	const Ref<Texture2D> texture = get_texture_from_node(path);
+template<std::derived_from<Texture2D> T>
+static Ref<T> _cast_texture(Ref<Texture2D> const& texture) {
 	ERR_FAIL_NULL_V(texture, nullptr);
 	const Ref<T> result = texture;
-	ERR_FAIL_NULL_V_MSG(result, nullptr, vformat("Failed to cast Texture2D from %s to type %s", path, T::get_class_static()));
+	ERR_FAIL_NULL_V_MSG(
+		result, nullptr, vformat("Failed to cast Texture2D from type %s to %s", texture->get_class(), T::get_class_static())
+	);
 	return result;
 }
 
-Ref<GFXIconTexture> GUINode::get_gfx_icon_texture_from_node(NodePath const& path) const {
-	return _get_cast_texture_from_node<GFXIconTexture>(path);
-}
+#define TEXTURE_GET_FUNCTIONS(type, name) \
+	Ref<type> GUINode::get_##name##_from_node(Node* node) { \
+		return _cast_texture<type>(get_texture_from_node(node)); \
+	} \
+	Ref<type> GUINode::get_##name##_from_nodepath(NodePath const& path) const { \
+		return _cast_texture<type>(get_texture_from_nodepath(path)); \
+	}
 
-Ref<GFXMaskedFlagTexture> GUINode::get_gfx_masked_flag_texture_from_node(NodePath const& path) const {
-	return _get_cast_texture_from_node<GFXMaskedFlagTexture>(path);
-}
+APPLY_TO_TEXTURE_TYPES(TEXTURE_GET_FUNCTIONS)
 
-Ref<GFXPieChartTexture> GUINode::get_gfx_pie_chart_texture_from_node(NodePath const& path) const {
-	return _get_cast_texture_from_node<GFXPieChartTexture>(path);
-}
+#undef TEXTURE_GET_FUNCTIONS
+
+#undef APPLY_TO_CHILD_TYPES
 
 Error GUINode::hide_node(NodePath const& path) const {
-	CanvasItem* node = _get_cast_node<CanvasItem>(path);
-	if (node == nullptr) {
-		return FAILED;
-	}
+	CanvasItem* node = _cast_node<CanvasItem>(get_node_internal(path));
+	ERR_FAIL_NULL_V(node, FAILED);
 	node->hide();
 	return OK;
 }
 
-Error GUINode::hide_nodes(Array const& paths) const {
+Error GUINode::hide_nodes(TypedArray<NodePath> const& paths) const {
 	Error ret = OK;
 	for (int32_t i = 0; i < paths.size(); ++i) {
 		if (hide_node(paths[i]) != OK) {