[feat] Save color palette as resources to reuse later

godotengine/godot-proposals#7946

The lack of a palette library slows down development time because swatches contain many colors that may not match the mood an artist is trying to achieve. This can hinder their workflow as they search for the right color within a large set of mostly irrelevant options.

scene/gui/color_picker.cpp

@@ -31,11 +31,13 @@
 #include "color_picker.h"
 
 #include "core/input/input.h"
+#include "core/io/config_file.h"
 #include "core/io/image.h"
 #include "core/math/color.h"
 #include "core/os/keyboard.h"
 #include "core/os/os.h"
 #include "scene/gui/color_mode.h"
+#include "scene/gui/file_dialog.h"
 #include "scene/gui/margin_container.h"
 #include "scene/resources/image_texture.h"
 #include "scene/resources/style_box_flat.h"
@@ -75,6 +77,8 @@ void ColorPicker::_notification(int p_what) {
 			_update_drop_down_arrow(btn_preset->is_pressed(), btn_preset);
 			_update_drop_down_arrow(btn_recent_preset->is_pressed(), btn_recent_preset);
 			btn_add_preset->set_icon(theme_cache.add_preset);
+			load_palette->set_icon(get_theme_icon(SNAME("load"), SNAME("FileDialog")));
+			save_palette->set_icon(get_theme_icon(SNAME("save"), SNAME("FileDialog")));
 
 			btn_pick->set_custom_minimum_size(Size2(28 * theme_cache.base_scale, 0));
 			btn_shape->set_custom_minimum_size(Size2(28 * theme_cache.base_scale, 0));
@@ -774,10 +778,78 @@ void ColorPicker::_add_recent_preset_button(int p_size, const Color &p_color) {
 	btn_preset_new->connect("toggled", callable_mp(this, &ColorPicker::_recent_preset_pressed).bind(btn_preset_new));
 }
 
+void ColorPicker::_load_palette() {
+	file_dialog->set_title(RTR("Load Palette"));
+	file_dialog->clear_filters();
+	file_dialog->add_filter("*.cpl");
+
+	file_dialog->set_file_mode(FileDialog::FILE_MODE_OPEN_FILE);
+	file_dialog->set_access(FileDialog::ACCESS_USERDATA);
+	file_dialog->set_current_file("");
+	file_dialog->popup_centered_ratio();
+}
+
+void ColorPicker::_save_palette() {
+	file_dialog->set_title(RTR("Save Palette"));
+	file_dialog->set_current_file("new_palette.cpl");
+	file_dialog->clear_filters();
+	file_dialog->add_filter("*.cpl");
+
+	file_dialog->set_file_mode(FileDialog::FILE_MODE_SAVE_FILE);
+	file_dialog->set_access(FileDialog::ACCESS_USERDATA);
+	file_dialog->popup_centered_ratio();
+}
+
+void ColorPicker::_palette_file_selected(const String &p_path) {
+	switch (file_dialog->get_file_mode()) {
+		case FileDialog::FileMode::FILE_MODE_OPEN_FILE: {
+			Ref<ConfigFile> cf;
+			cf.instantiate();
+			if (cf->load(p_path) == OK) {
+				palette_name->set_text(p_path.get_file().get_basename());
+				palette_name->set_tooltip_text("");
+				preset_cache.clear();
+				presets.clear();
+				PackedColorArray saved_presets = cf->get_value("", "palette", PackedColorArray());
+				for (const Color &saved_preset : saved_presets) {
+					preset_cache.push_back(saved_preset);
+					presets.push_back(saved_preset);
+				}
+			} else {
+				ERR_FAIL_MSG(vformat("Cannot open file to Read."));
+			}
+
+			_update_presets();
+		} break;
+		case FileDialog::FileMode::FILE_MODE_SAVE_FILE: {
+			Ref<ConfigFile> cf;
+			cf.instantiate();
+			cf->set_value("", "palette", get_presets());
+			if (cf->save(p_path) == OK) {
+				palette_name->set_text(p_path.get_file().get_basename());
+				palette_name->set_tooltip_text("");
+			} else {
+				ERR_FAIL_MSG(vformat("Cannot open file to write."));
+			}
+		} break;
+		default:
+			break;
+	}
+
+	if (btn_preset->is_pressed()) {
+		palette_name->show();
+	}
+}
+
 void ColorPicker::_show_hide_preset(const bool &p_is_btn_pressed, Button *p_btn_preset, Container *p_preset_container) {
 	if (p_is_btn_pressed) {
+		palette_name->hide();
+		if (!palette_name->get_text().is_empty()) {
+			palette_name->show();
+		}
 		p_preset_container->show();
 	} else {
+		palette_name->hide();
 		p_preset_container->hide();
 	}
 	_update_drop_down_arrow(p_is_btn_pressed, p_btn_preset);
@@ -857,6 +929,9 @@ void ColorPicker::add_preset(const Color &p_color) {
 		_add_preset_button(_get_preset_size(), p_color);
 	}
 
+	palette_name->set_text(vformat(ETR("%s*"), palette_name->get_text().replace("*", "")));
+	palette_name->set_tooltip_text(ETR("The changes to this palette have not been saved to a file"));
+
 #ifdef TOOLS_ENABLED
 	if (editor_settings) {
 		PackedColorArray arr_to_save = get_presets();
@@ -901,6 +976,9 @@ void ColorPicker::erase_preset(const Color &p_color) {
 			}
 		}
 
+		palette_name->set_text(vformat(ETR("%s*"), palette_name->get_text().replace("*", "")));
+		palette_name->set_tooltip_text(ETR("The changes to this palette have not been saved to a file"));
+
 #ifdef TOOLS_ENABLED
 		if (editor_settings) {
 			PackedColorArray arr_to_save = get_presets();
@@ -1809,6 +1887,10 @@ void ColorPicker::_bind_methods() {
 }
 
 ColorPicker::ColorPicker() {
+	file_dialog = memnew(FileDialog);
+	add_child(file_dialog, false, INTERNAL_MODE_FRONT);
+	file_dialog->connect("file_selected", callable_mp(this, &ColorPicker::_palette_file_selected));
+
 	internal_margin = memnew(MarginContainer);
 	add_child(internal_margin, false, INTERNAL_MODE_FRONT);
 
@@ -1991,14 +2073,42 @@ ColorPicker::ColorPicker() {
 
 	preset_group.instantiate();
 
+	HBoxContainer *swatch_box = memnew(HBoxContainer);
+	swatch_box->set_h_size_flags(SIZE_EXPAND_FILL);
+	real_vbox->add_child(swatch_box);
+
 	btn_preset = memnew(Button);
 	btn_preset->set_text("Swatches");
 	btn_preset->set_flat(true);
 	btn_preset->set_toggle_mode(true);
 	btn_preset->set_focus_mode(FOCUS_NONE);
 	btn_preset->set_text_alignment(HORIZONTAL_ALIGNMENT_LEFT);
 	btn_preset->connect("toggled", callable_mp(this, &ColorPicker::_show_hide_preset).bind(btn_preset, preset_container));
-	real_vbox->add_child(btn_preset);
+	swatch_box->add_child(btn_preset);
+
+	HBoxContainer *padding_box = memnew(HBoxContainer);
+	padding_box->set_h_size_flags(SIZE_EXPAND_FILL);
+	swatch_box->add_child(padding_box);
+
+	load_palette = memnew(Button);
+	load_palette->set_flat(true);
+	load_palette->set_tooltip_text(ETR("Load existing color palette."));
+	load_palette->set_toggle_mode(true);
+	load_palette->set_focus_mode(FOCUS_NONE);
+	load_palette->connect("pressed", callable_mp(this, &ColorPicker::_load_palette));
+	swatch_box->add_child(load_palette);
+
+	save_palette = memnew(Button);
+	save_palette->set_flat(true);
+	save_palette->set_tooltip_text(ETR("Save the current color palette to reuse later."));
+	save_palette->set_toggle_mode(true);
+	save_palette->set_focus_mode(FOCUS_NONE);
+	save_palette->connect("pressed", callable_mp(this, &ColorPicker::_save_palette));
+	swatch_box->add_child(save_palette);
+
+	palette_name = memnew(Label);
+	palette_name->hide();
+	real_vbox->add_child(palette_name);
 
 	real_vbox->add_child(preset_container);
 

scene/gui/color_picker.h

@@ -53,6 +53,7 @@ class ColorModeRGB;
 class ColorModeHSV;
 class ColorModeRAW;
 class ColorModeOKHSL;
+class FileDialog;
 
 class ColorPresetButton : public BaseButton {
 	GDCLASS(ColorPresetButton, BaseButton);
@@ -134,6 +135,9 @@ class ColorPicker : public VBoxContainer {
 	Label *picker_preview_label = nullptr;
 	Ref<StyleBoxFlat> picker_preview_style_box;
 	Color picker_color;
+	FileDialog *file_dialog = nullptr;
+	Button *load_palette = nullptr;
+	Button *save_palette = nullptr;
 
 	MarginContainer *internal_margin = nullptr;
 	Control *uv_edit = nullptr;
@@ -149,6 +153,7 @@ class ColorPicker : public VBoxContainer {
 	HBoxContainer *recent_preset_hbc = nullptr;
 	Button *btn_add_preset = nullptr;
 	Button *btn_pick = nullptr;
+	Label *palette_name = nullptr;
 	Button *btn_preset = nullptr;
 	Button *btn_recent_preset = nullptr;
 	PopupMenu *shape_popup = nullptr;
@@ -286,6 +291,9 @@ class ColorPicker : public VBoxContainer {
 	inline int _get_preset_size();
 	void _add_preset_button(int p_size, const Color &p_color);
 	void _add_recent_preset_button(int p_size, const Color &p_color);
+	void _save_palette();
+	void _load_palette();
+	void _palette_file_selected(const String &p_path);
 
 	void _show_hide_preset(const bool &p_is_btn_pressed, Button *p_btn_preset, Container *p_preset_container);
 	void _update_drop_down_arrow(const bool &p_is_btn_pressed, Button *p_btn_preset);

scene/theme/default_theme.cpp

@@ -644,6 +644,8 @@ void fill_default_theme(Ref<Theme> &theme, const Ref<Font> &default_font, const
 
 	// File Dialog
 
+	theme->set_icon("load", "FileDialog", icons["load"]);
+	theme->set_icon("save", "FileDialog", icons["save"]);
 	theme->set_icon("parent_folder", "FileDialog", icons["folder_up"]);
 	theme->set_icon("back_folder", "FileDialog", icons["arrow_left"]);
 	theme->set_icon("forward_folder", "FileDialog", icons["arrow_right"]);