From bafcb2620a4ccfdf5c4e50c004ea3ce6e15a5930 Mon Sep 17 00:00:00 2001 From: Manolis Papadeas <35376950+OverloadedOrama@users.noreply.github.com> Date: Fri, 18 Feb 2022 01:03:08 +0200 Subject: [PATCH] Tidy up preferences code Use a Preference class instead of a nested array. Lines of code reduced from 461 to 330. Also fixed a minor bug in the Web version where, when the user changed language, "Interface" was being selected instead. --- src/Preferences/PreferencesDialog.gd | 372 ++++++++----------------- src/Preferences/PreferencesDialog.tscn | 4 +- 2 files changed, 122 insertions(+), 254 deletions(-) diff --git a/src/Preferences/PreferencesDialog.gd b/src/Preferences/PreferencesDialog.gd index b9382b9e7..20b067d38 100644 --- a/src/Preferences/PreferencesDialog.gd +++ b/src/Preferences/PreferencesDialog.gd @@ -1,224 +1,145 @@ extends AcceptDialog -# Preferences table: [Prop name in Global, relative node path, value type, default value] -var preferences = [ - [ - "open_last_project", - "Startup/StartupContainer/OpenLastProject", - "pressed", - Global.open_last_project - ], - [ - "quit_confirmation", - "Startup/StartupContainer/QuitConfirmation", - "pressed", - Global.quit_confirmation - ], - ["shrink", "Interface/ShrinkContainer/ShrinkHSlider", "value", Global.shrink], - ["dim_on_popup", "Interface/DimPopup/CheckBox", "pressed", Global.dim_on_popup], - [ - "icon_color_from", - "Interface/IconColorFrom/IconColorOptionButton", - "selected", - Global.icon_color_from - ], - [ - "custom_icon_color", - "Interface/IconColorFrom/IconColorButton", - "color", - Global.custom_icon_color - ], - [ - "tool_button_size", - "Interface/ToolButtonSize/ToolButtonSizeOptionButton", - "selected", - Global.tool_button_size - ], - [ +# Array of Preference(s) +var preferences := [ + Preference.new("open_last_project", "Startup/StartupContainer/OpenLastProject", "pressed"), + Preference.new("quit_confirmation", "Startup/StartupContainer/QuitConfirmation", "pressed"), + Preference.new("shrink", "Interface/ShrinkContainer/ShrinkHSlider", "value"), + Preference.new("dim_on_popup", "Interface/DimPopup/CheckBox", "pressed"), + Preference.new("icon_color_from", "Interface/IconColorFrom/IconColorOptionButton", "selected"), + Preference.new("custom_icon_color", "Interface/IconColorFrom/IconColorButton", "color"), + Preference.new( + "tool_button_size", "Interface/ToolButtonSize/ToolButtonSizeOptionButton", "selected" + ), + Preference.new( "pressure_sensitivity_mode", "Startup/PressureSentivity/PressureSensitivityOptionButton", - "selected", - Global.pressure_sensitivity_mode - ], - [ - "show_left_tool_icon", - "Cursors/CursorsContainer/LeftToolIconCheckbox", - "pressed", - Global.show_left_tool_icon - ], - [ - "show_right_tool_icon", - "Cursors/CursorsContainer/RightToolIconCheckbox", - "pressed", - Global.show_right_tool_icon - ], - [ - "left_square_indicator_visible", - "Cursors/CursorsContainer/LeftIndicatorCheckbox", - "pressed", - Global.left_square_indicator_visible - ], - [ + "selected" + ), + Preference.new( + "show_left_tool_icon", "Cursors/CursorsContainer/LeftToolIconCheckbox", "pressed" + ), + Preference.new( + "show_right_tool_icon", "Cursors/CursorsContainer/RightToolIconCheckbox", "pressed" + ), + Preference.new( + "left_square_indicator_visible", "Cursors/CursorsContainer/LeftIndicatorCheckbox", "pressed" + ), + Preference.new( "right_square_indicator_visible", "Cursors/CursorsContainer/RightIndicatorCheckbox", - "pressed", - Global.right_square_indicator_visible - ], - [ - "native_cursors", - "Cursors/CursorsContainer/NativeCursorsCheckbox", - "pressed", - Global.native_cursors - ], - [ - "cross_cursor", - "Cursors/CursorsContainer/CrossCursorCheckbox", - "pressed", - Global.cross_cursor - ], - [ - "autosave_interval", - "Backup/AutosaveContainer/AutosaveInterval", - "value", - Global.autosave_interval - ], - [ - "enable_autosave", - "Backup/AutosaveContainer/EnableAutosave", - "pressed", - Global.enable_autosave - ], - ["default_width", "Image/ImageOptions/ImageDefaultWidth", "value", Global.default_width], - ["default_height", "Image/ImageOptions/ImageDefaultHeight", "value", Global.default_height], - [ - "default_fill_color", - "Image/ImageOptions/DefaultFillColor", - "color", - Global.default_fill_color - ], - ["smooth_zoom", "Canvas/ZoomOptions/SmoothZoom", "pressed", Global.smooth_zoom], - ["grid_type", "Canvas/GridOptions/GridType", "selected", Global.grid_type], - ["grid_width", "Canvas/GridOptions/GridWidthValue", "value", Global.grid_width], - ["grid_height", "Canvas/GridOptions/GridHeightValue", "value", Global.grid_height], - [ + "pressed" + ), + Preference.new("native_cursors", "Cursors/CursorsContainer/NativeCursorsCheckbox", "pressed"), + Preference.new("cross_cursor", "Cursors/CursorsContainer/CrossCursorCheckbox", "pressed"), + Preference.new("autosave_interval", "Backup/AutosaveContainer/AutosaveInterval", "value"), + Preference.new("enable_autosave", "Backup/AutosaveContainer/EnableAutosave", "pressed"), + Preference.new("default_width", "Image/ImageOptions/ImageDefaultWidth", "value"), + Preference.new("default_height", "Image/ImageOptions/ImageDefaultHeight", "value"), + Preference.new("default_fill_color", "Image/ImageOptions/DefaultFillColor", "color"), + Preference.new("smooth_zoom", "Canvas/ZoomOptions/SmoothZoom", "pressed"), + Preference.new("grid_type", "Canvas/GridOptions/GridType", "selected"), + Preference.new("grid_width", "Canvas/GridOptions/GridWidthValue", "value"), + Preference.new("grid_height", "Canvas/GridOptions/GridHeightValue", "value"), + Preference.new( "grid_isometric_cell_bounds_width", "Canvas/GridOptions/IsometricCellBoundsWidthValue", - "value", - Global.grid_isometric_cell_bounds_width - ], - [ + "value" + ), + Preference.new( "grid_isometric_cell_bounds_height", "Canvas/GridOptions/IsometricCellBoundsHeightValue", - "value", - Global.grid_isometric_cell_bounds_height - ], - ["grid_offset_x", "Canvas/GridOptions/GridOffsetXValue", "value", Global.grid_offset_x], - ["grid_offset_y", "Canvas/GridOptions/GridOffsetYValue", "value", Global.grid_offset_y], - [ - "grid_draw_over_tile_mode", - "Canvas/GridOptions/GridDrawOverTileMode", - "pressed", - Global.grid_draw_over_tile_mode - ], - ["grid_color", "Canvas/GridOptions/GridColor", "color", Global.grid_color], - [ - "pixel_grid_show_at_zoom", - "Canvas/PixelGridOptions/ShowAtZoom", - "value", - Global.pixel_grid_show_at_zoom - ], - ["pixel_grid_color", "Canvas/PixelGridOptions/GridColor", "color", Global.pixel_grid_color], - ["guide_color", "Canvas/GuideOptions/GuideColor", "color", Global.guide_color], - ["checker_size", "Canvas/CheckerOptions/CheckerSizeValue", "value", Global.checker_size], - ["checker_color_1", "Canvas/CheckerOptions/CheckerColor1", "color", Global.checker_color_1], - ["checker_color_2", "Canvas/CheckerOptions/CheckerColor2", "color", Global.checker_color_2], - [ - "checker_follow_movement", - "Canvas/CheckerOptions/CheckerFollowMovement", - "pressed", - Global.checker_follow_movement - ], - [ - "checker_follow_scale", - "Canvas/CheckerOptions/CheckerFollowScale", - "pressed", - Global.checker_follow_scale - ], - ["tilemode_opacity", "Canvas/CheckerOptions/TileModeOpacity", "value", Global.tilemode_opacity], - [ - "selection_animated_borders", - "Selection/SelectionOptions/Animate", - "pressed", - Global.selection_animated_borders - ], - [ - "selection_border_color_1", - "Selection/SelectionOptions/BorderColor1", - "color", - Global.selection_border_color_1 - ], - [ - "selection_border_color_2", - "Selection/SelectionOptions/BorderColor2", - "color", - Global.selection_border_color_2 - ], - ["fps_limit", "Performance/PerformanceContainer/SetFPSLimit", "value", Global.fps_limit], - [ - "pause_when_unfocused", - "Performance/PerformanceContainer/PauseAppFocus", - "pressed", - Global.pause_when_unfocused - ], + "value" + ), + Preference.new("grid_offset_x", "Canvas/GridOptions/GridOffsetXValue", "value"), + Preference.new("grid_offset_y", "Canvas/GridOptions/GridOffsetYValue", "value"), + Preference.new( + "grid_draw_over_tile_mode", "Canvas/GridOptions/GridDrawOverTileMode", "pressed" + ), + Preference.new("grid_color", "Canvas/GridOptions/GridColor", "color"), + Preference.new("pixel_grid_show_at_zoom", "Canvas/PixelGridOptions/ShowAtZoom", "value"), + Preference.new("pixel_grid_color", "Canvas/PixelGridOptions/GridColor", "color"), + Preference.new("guide_color", "Canvas/GuideOptions/GuideColor", "color"), + Preference.new("checker_size", "Canvas/CheckerOptions/CheckerSizeValue", "value"), + Preference.new("checker_color_1", "Canvas/CheckerOptions/CheckerColor1", "color"), + Preference.new("checker_color_2", "Canvas/CheckerOptions/CheckerColor2", "color"), + Preference.new( + "checker_follow_movement", "Canvas/CheckerOptions/CheckerFollowMovement", "pressed" + ), + Preference.new("checker_follow_scale", "Canvas/CheckerOptions/CheckerFollowScale", "pressed"), + Preference.new("tilemode_opacity", "Canvas/CheckerOptions/TileModeOpacity", "value"), + Preference.new("selection_animated_borders", "Selection/SelectionOptions/Animate", "pressed"), + Preference.new("selection_border_color_1", "Selection/SelectionOptions/BorderColor1", "color"), + Preference.new("selection_border_color_2", "Selection/SelectionOptions/BorderColor2", "color"), + Preference.new("fps_limit", "Performance/PerformanceContainer/SetFPSLimit", "value"), + Preference.new( + "pause_when_unfocused", "Performance/PerformanceContainer/PauseAppFocus", "pressed" + ), ] +var content_list := [] var selected_item := 0 var restore_default_button_tcsn = preload("res://src/Preferences/RestoreDefaultButton.tscn") onready var list: ItemList = $HSplitContainer/List onready var right_side: VBoxContainer = $HSplitContainer/ScrollContainer/VBoxContainer -onready var autosave_interval: SpinBox = right_side.get_node( - "Backup/AutosaveContainer/AutosaveInterval" -) +onready var autosave_container: Container = right_side.get_node("Backup/AutosaveContainer") +onready var autosave_interval: SpinBox = autosave_container.get_node("AutosaveInterval") onready var shrink_label: Label = right_side.get_node("Interface/ShrinkContainer/ShrinkLabel") onready var themes: BoxContainer = right_side.get_node("Interface/Themes") +class Preference: + var prop_name: String + var node_path: String + var value_type: String + var default_value + + func _init(_prop_name: String, _node_path: String, _value_type: String) -> void: + prop_name = _prop_name + node_path = _node_path + value_type = _value_type + default_value = Global.get(prop_name) + + func _ready() -> void: # Replace OK since preference changes are being applied immediately, not after OK confirmation get_ok().text = tr("Close") + for child in right_side.get_children(): + content_list.append(child.name) if OS.get_name() == "HTML5": + content_list.erase("Startup") right_side.get_node("Startup").queue_free() - right_side.get_node("Languages").visible = true + right_side.get_node("Language").visible = true Global.open_last_project = false for pref in preferences: - var node = right_side.get_node(pref[1]) - var node_position = node.get_index() + var node: Node = right_side.get_node(pref.node_path) + var node_position := node.get_index() var restore_default_button: BaseButton = restore_default_button_tcsn.instance() - restore_default_button.setting_name = pref[0] - restore_default_button.value_type = pref[2] - restore_default_button.default_value = pref[3] + restore_default_button.setting_name = pref.prop_name + restore_default_button.value_type = pref.value_type + restore_default_button.default_value = pref.default_value restore_default_button.node = node node.get_parent().add_child(restore_default_button) node.get_parent().move_child(restore_default_button, node_position) - match pref[2]: + match pref.value_type: "pressed": node.connect( "toggled", self, "_on_Preference_toggled", - [pref[0], pref[3], restore_default_button] + [pref.prop_name, pref.default_value, restore_default_button] ) "value": node.connect( "value_changed", self, "_on_Preference_value_changed", - [pref[0], pref[3], restore_default_button] + [pref.prop_name, pref.default_value, restore_default_button] ) "color": node.get_picker().presets_visible = false @@ -226,31 +147,32 @@ func _ready() -> void: "color_changed", self, "_on_Preference_color_changed", - [pref[0], pref[3], restore_default_button] + [pref.prop_name, pref.default_value, restore_default_button] ) "selected": node.connect( "item_selected", self, "_on_Preference_item_selected", - [pref[0], pref[3], restore_default_button] + [pref.prop_name, pref.default_value, restore_default_button] ) - if Global.config_cache.has_section_key("preferences", pref[0]): - var value = Global.config_cache.get_value("preferences", pref[0]) - Global.set(pref[0], value) - node.set(pref[2], value) + if Global.config_cache.has_section_key("preferences", pref.prop_name): + var value = Global.config_cache.get_value("preferences", pref.prop_name) + Global.set(pref.prop_name, value) + node.set(pref.value_type, value) + var global_value = Global.get(pref.prop_name) # This is needed because color_changed doesn't fire if the color changes in code - if pref[2] == "color": - preference_update(pref[0]) + if pref.value_type == "color": + preference_update(pref.prop_name) disable_restore_default_button( - restore_default_button, Global.get(pref[0]).is_equal_approx(pref[3]) + restore_default_button, global_value.is_equal_approx(pref.default_value) ) - elif pref[2] == "selected": - preference_update(pref[0]) + elif pref.value_type == "selected": + preference_update(pref.prop_name) disable_restore_default_button( - restore_default_button, Global.get(pref[0]) == pref[3] + restore_default_button, global_value == pref.default_value ) @@ -301,63 +223,31 @@ func preference_update(prop: String) -> void: else: autosave_interval.mouse_default_cursor_shape = Control.CURSOR_FORBIDDEN - if ( - prop - in [ - "grid_type", - "grid_width", - "grid_height", - "grid_isometric_cell_bounds_width", - "grid_isometric_cell_bounds_height", - "grid_offset_x", - "grid_offset_y", - "grid_draw_over_tile_mode", - "grid_color" - ] - ): + if "grid" in prop: Global.canvas.grid.update() if prop in ["pixel_grid_show_at_zoom", "pixel_grid_color"]: Global.canvas.pixel_grid.update() - if ( - prop - in [ - "checker_size", - "checker_color_1", - "checker_color_2", - "checker_follow_movement", - "checker_follow_scale" - ] - ): + if "checker" in prop: Global.transparent_checker.update_rect() if prop in ["guide_color"]: for guide in Global.canvas.get_children(): if guide is SymmetryGuide: # Add a subtle difference to the normal guide color by mixing in some blue - guide.default_color = Global.guide_color.linear_interpolate( - Color(0.2, 0.2, .65), .6 - ) + guide.default_color = Global.guide_color.linear_interpolate(Color(.2, .2, .65), .6) elif guide is Guide: guide.default_color = Global.guide_color if prop in ["fps_limit"]: Engine.set_target_fps(Global.fps_limit) - if ( - prop - in ["selection_animated_borders", "selection_border_color_1", "selection_border_color_2"] - ): - Global.canvas.selection.marching_ants_outline.material.set_shader_param( - "animated", Global.selection_animated_borders - ) - Global.canvas.selection.marching_ants_outline.material.set_shader_param( - "first_color", Global.selection_border_color_1 - ) - Global.canvas.selection.marching_ants_outline.material.set_shader_param( - "second_color", Global.selection_border_color_2 - ) + if "selection" in prop: + var marching_ants: Sprite = Global.canvas.selection.marching_ants_outline + marching_ants.material.set_shader_param("animated", Global.selection_animated_borders) + marching_ants.material.set_shader_param("first_color", Global.selection_border_color_1) + marching_ants.material.set_shader_param("second_color", Global.selection_border_color_2) Global.canvas.selection.update() if prop in ["icon_color_from", "custom_icon_color"]: @@ -403,19 +293,11 @@ func _on_PreferencesDialog_about_to_show() -> void: func add_tabs(changed_language := false) -> void: - if OS.get_name() != "HTML5": - list.add_item(" " + tr("Startup")) - list.add_item(" " + tr("Language")) - list.add_item(" " + tr("Interface")) - list.add_item(" " + tr("Canvas")) - list.add_item(" " + tr("Selection")) - list.add_item(" " + tr("Image")) - list.add_item(" " + tr("Shortcuts")) - list.add_item(" " + tr("Backup")) - list.add_item(" " + tr("Performance")) - list.add_item(" " + tr("Cursors")) + for item in content_list: + list.add_item(" " + tr(item)) - list.select(1 if changed_language else selected_item) + var language_index := content_list.find("Language") + list.select(language_index if changed_language else selected_item) autosave_interval.suffix = tr("minute(s)") @@ -426,20 +308,6 @@ func _on_PreferencesDialog_popup_hide() -> void: func _on_List_item_selected(index: int) -> void: selected_item = index for child in right_side.get_children(): - var content_list = [ - "Startup", - "Languages", - "Interface", - "Canvas", - "Selection", - "Image", - "Shortcuts", - "Backup", - "Performance", - "Cursors" - ] - if OS.get_name() == "HTML5": - content_list.erase("Startup") child.visible = child.name == content_list[index] diff --git a/src/Preferences/PreferencesDialog.tscn b/src/Preferences/PreferencesDialog.tscn index df2cb80e1..564fa4ffe 100644 --- a/src/Preferences/PreferencesDialog.tscn +++ b/src/Preferences/PreferencesDialog.tscn @@ -111,14 +111,14 @@ text = "Affect Brush's Alpha" items = [ "None", null, false, 0, null, "Affect Brush's Alpha", null, false, 1, null ] selected = 1 -[node name="Languages" type="VBoxContainer" parent="HSplitContainer/ScrollContainer/VBoxContainer"] +[node name="Language" type="VBoxContainer" parent="HSplitContainer/ScrollContainer/VBoxContainer"] visible = false margin_top = 184.0 margin_right = 506.0 margin_bottom = 632.0 script = ExtResource( 4 ) -[node name="System Language" type="CheckBox" parent="HSplitContainer/ScrollContainer/VBoxContainer/Languages"] +[node name="System Language" type="CheckBox" parent="HSplitContainer/ScrollContainer/VBoxContainer/Language"] margin_right = 506.0 margin_bottom = 24.0 mouse_default_cursor_shape = 2