Merge pull request #25510 from groud/tilemap_editor_enhancement

Move some tilemap options to the toolbar

editor/icons/icon_bucket.svg

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="16"
+   height="16"
+   version="1.1"
+   viewBox="0 0 16 16"
+   id="svg6"
+   sodipodi:docname="icon_bucket.svg"
+   inkscape:version="0.92.2 2405546, 2018-03-11">
+  <metadata
+     id="metadata12">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs10" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1876"
+     inkscape:window-height="1574"
+     id="namedview8"
+     showgrid="true"
+     inkscape:snap-bbox="true"
+     inkscape:bbox-paths="false"
+     inkscape:bbox-nodes="false"
+     inkscape:snap-bbox-edge-midpoints="false"
+     inkscape:snap-bbox-midpoints="true"
+     inkscape:snap-intersection-paths="true"
+     inkscape:snap-smooth-nodes="true"
+     inkscape:snap-object-midpoints="true"
+     inkscape:snap-nodes="false"
+     inkscape:snap-others="false"
+     inkscape:zoom="16"
+     inkscape:cx="-4.3713942"
+     inkscape:cy="-1.9091903"
+     inkscape:window-x="4"
+     inkscape:window-y="20"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="g4">
+    <inkscape:grid
+       type="xygrid"
+       id="grid4524" />
+  </sodipodi:namedview>
+  <g
+     transform="translate(0 -1036.4)"
+     id="g4">
+    <g
+       id="g4576"
+       transform="matrix(0.53348552,0.53348552,-0.53348552,0.53348552,561.06065,484.40406)"
+       style="stroke-width:1.32544696">
+      <path
+         id="path2"
+         transform="translate(0,1036.4)"
+         d="M 2,1 C 1.4477645,1.0001 1.0000523,1.4477 1,2 V 3.5 H 3.8847656 A 1.4999877,1.5 0 0 1 5,3 1.4999877,1.5 0 0 1 6.5,4.5 1.4999877,1.5 0 0 1 5,6 1.4999877,1.5 0 0 1 3.8847656,5.5 H 1 V 7 H -0.26953125 -2 c -0.5522769,0 -0.999989,-0.4477 -1,-1 1.1e-5,-0.5523 0.4477231,-1 1,-1 h 3 2.5878906 0.546875 A 1,1 0 0 0 5,5.5 1,1 0 0 0 6,4.5 1,1 0 0 0 5,3.5 1,1 0 0 0 4.1367188,4 H 3.5878906 1 -2 c -1.1045647,0 -1.9999933,0.8954285 -2,2 6.7e-6,1.1045715 0.8954353,2 2,2 h 3 v 6 c 7.35e-5,0.5523 0.4477232,0.9999 1,1 h 8 c 0.552235,-10e-5 0.999947,-0.4477 1,-1 V 1 Z"
+         style="color:#000000;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-feature-settings:normal;text-indent:0;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000000;text-transform:none;text-orientation:mixed;dominant-baseline:auto;white-space:normal;shape-padding:0;isolation:auto;mix-blend-mode:normal;solid-color:#000000;fill:#e0e0e0;stroke-width:1.32544696;color-rendering:auto;image-rendering:auto;shape-rendering:auto"
+         inkscape:connector-curvature="0" />
+      <path
+         sodipodi:nodetypes="cczcc"
+         inkscape:connector-curvature="0"
+         id="path4526"
+         d="m 12,1038.4 c 0.707107,3.5356 0.707107,3.5356 1.414213,4.2427 0.707107,0.7071 2.121321,0.7071 2.828428,0 0.707106,-0.7071 0.707106,-2.1213 0,-2.8284 C 15.535534,1039.1071 15.535534,1039.1071 12,1038.4 Z"
+         style="fill:#e0e0e0;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:1.32544696px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+    </g>
+  </g>
+</svg>

editor/plugins/tile_map_editor_plugin.cpp

@@ -66,6 +66,11 @@ void TileMapEditor::_notification(int p_what) {
 
 		case NOTIFICATION_ENTER_TREE: {
 
+			paint_button->set_icon(get_icon("Edit", "EditorIcons"));
+			bucket_fill_button->set_icon(get_icon("Bucket", "EditorIcons"));
+			picker_button->set_icon(get_icon("ColorPick", "EditorIcons"));
+			select_button->set_icon(get_icon("ActionCopy", "EditorIcons"));
+
 			rotate_left_button->set_icon(get_icon("Rotate270", "EditorIcons"));
 			rotate_right_button->set_icon(get_icon("Rotate90", "EditorIcons"));
 			flip_horizontal_button->set_icon(get_icon("MirrorX", "EditorIcons"));
@@ -76,9 +81,6 @@ void TileMapEditor::_notification(int p_what) {
 			search_box->set_clear_button_enabled(true);
 
 			PopupMenu *p = options->get_popup();
-			p->set_item_icon(p->get_item_index(OPTION_PAINTING), get_icon("Edit", "EditorIcons"));
-			p->set_item_icon(p->get_item_index(OPTION_PICK_TILE), get_icon("ColorPick", "EditorIcons"));
-			p->set_item_icon(p->get_item_index(OPTION_SELECT), get_icon("ActionCopy", "EditorIcons"));
 			p->set_item_icon(p->get_item_index(OPTION_CUT), get_icon("ActionCut", "EditorIcons"));
 			p->set_item_icon(p->get_item_index(OPTION_COPY), get_icon("Duplicate", "EditorIcons"));
 			p->set_item_icon(p->get_item_index(OPTION_ERASE_SELECTION), get_icon("Remove", "EditorIcons"));
@@ -87,37 +89,51 @@ void TileMapEditor::_notification(int p_what) {
 	}
 }
 
-void TileMapEditor::_menu_option(int p_option) {
+void TileMapEditor::_update_button_tool() {
 
-	switch (p_option) {
-
-		case OPTION_PAINTING: {
-			// NOTE: We do not set tool = TOOL_PAINTING as this begins painting
-			// immediately without pressing the left mouse button first
-			tool = TOOL_NONE;
-
-			CanvasItemEditor::get_singleton()->update_viewport();
+	ToolButton *tb[4] = { paint_button, bucket_fill_button, picker_button, select_button };
+	// Unpress all buttons
+	for (int i = 0; i < 4; i++) {
+		tb[i]->set_pressed(false);
+	}
 
+	// Press the good button
+	switch (tool) {
+		case TOOL_NONE:
+		case TOOL_PAINTING: {
+			paint_button->set_pressed(true);
 		} break;
-		case OPTION_BUCKET: {
-
-			tool = TOOL_BUCKET;
-
-			CanvasItemEditor::get_singleton()->update_viewport();
+		case TOOL_BUCKET: {
+			bucket_fill_button->set_pressed(true);
 		} break;
-		case OPTION_PICK_TILE: {
+		case TOOL_PICKING: {
+			picker_button->set_pressed(true);
+		} break;
+		case TOOL_SELECTING: {
+			select_button->set_pressed(true);
+		} break;
+		default:
+			break;
+	}
+}
 
-			tool = TOOL_PICKING;
+void TileMapEditor::_button_tool_select(int p_tool) {
+	tool = (Tool)p_tool;
+	_update_button_tool();
+	switch (tool) {
+		case TOOL_SELECTING: {
 
-			CanvasItemEditor::get_singleton()->update_viewport();
+			selection_active = false;
 		} break;
-		case OPTION_SELECT: {
+		default:
+			break;
+	}
+	CanvasItemEditor::get_singleton()->update_viewport();
+}
 
-			tool = TOOL_SELECTING;
-			selection_active = false;
+void TileMapEditor::_menu_option(int p_option) {
 
-			CanvasItemEditor::get_singleton()->update_viewport();
-		} break;
+	switch (p_option) {
 		case OPTION_COPY: {
 
 			_update_copydata();
@@ -168,6 +184,7 @@ void TileMapEditor::_menu_option(int p_option) {
 			}
 		} break;
 	}
+	_update_button_tool();
 }
 
 void TileMapEditor::_palette_selected(int index) {
@@ -944,6 +961,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 						selection_active = false;
 						rectangle_begin = over_tile;
 
+						_update_button_tool();
 						return true;
 					}
 #ifdef APPLE_STYLE_KEYS
@@ -953,11 +971,13 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 #endif
 						tool = TOOL_PICKING;
 						_pick_tile(over_tile);
+						_update_button_tool();
 
 						return true;
 					}
 
 					tool = TOOL_PAINTING;
+					_update_button_tool();
 				}
 
 				if (tool == TOOL_PAINTING) {
@@ -979,6 +999,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 					rectangle_begin = over_tile;
 				}
 
+				_update_button_tool();
 				return true;
 
 			} else {
@@ -1075,6 +1096,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 					}
 
 					tool = TOOL_NONE;
+					_update_button_tool();
 
 					return true;
 				}
@@ -1090,6 +1112,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 					CanvasItemEditor::get_singleton()->update_viewport();
 
+					_update_button_tool();
 					return true;
 				}
 
@@ -1100,6 +1123,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 					CanvasItemEditor::get_singleton()->update_viewport();
 
+					_update_button_tool();
 					return true;
 				}
 
@@ -1130,6 +1154,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 						_set_cell(local, invalid_cell);
 					}
 
+					_update_button_tool();
 					return true;
 				}
 
@@ -1144,6 +1169,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 					tool = TOOL_NONE;
 
+					_update_button_tool();
 					return true;
 
 				} else if (tool == TOOL_BUCKET) {
@@ -1329,6 +1355,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 			CanvasItemEditor::get_singleton()->update_viewport();
 
+			_update_button_tool();
 			return true;
 		}
 
@@ -1343,17 +1370,20 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 			tool = TOOL_NONE;
 			CanvasItemEditor::get_singleton()->update_viewport();
 
+			_update_button_tool();
 			return true;
 		}
 		if (ED_IS_SHORTCUT("tile_map_editor/bucket_fill", p_event)) {
 			tool = TOOL_BUCKET;
 			CanvasItemEditor::get_singleton()->update_viewport();
 
+			_update_button_tool();
 			return true;
 		}
 		if (ED_IS_SHORTCUT("tile_map_editor/erase_selection", p_event)) {
 			_menu_option(OPTION_ERASE_SELECTION);
 
+			_update_button_tool();
 			return true;
 		}
 		if (ED_IS_SHORTCUT("tile_map_editor/select", p_event)) {
@@ -1362,6 +1392,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 			CanvasItemEditor::get_singleton()->update_viewport();
 
+			_update_button_tool();
 			return true;
 		}
 		if (ED_IS_SHORTCUT("tile_map_editor/copy_selection", p_event)) {
@@ -1372,6 +1403,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 
 				CanvasItemEditor::get_singleton()->update_viewport();
 
+				_update_button_tool();
 				return true;
 			}
 		}
@@ -1388,6 +1420,7 @@ bool TileMapEditor::forward_gui_input(const Ref<InputEvent> &p_event) {
 				tool = TOOL_PASTING;
 
 				CanvasItemEditor::get_singleton()->update_viewport();
+				_update_button_tool();
 				return true;
 			}
 		}
@@ -1700,6 +1733,7 @@ void TileMapEditor::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("_text_entered"), &TileMapEditor::_text_entered);
 	ClassDB::bind_method(D_METHOD("_text_changed"), &TileMapEditor::_text_changed);
 	ClassDB::bind_method(D_METHOD("_sbox_input"), &TileMapEditor::_sbox_input);
+	ClassDB::bind_method(D_METHOD("_button_tool_select"), &TileMapEditor::_button_tool_select);
 	ClassDB::bind_method(D_METHOD("_menu_option"), &TileMapEditor::_menu_option);
 	ClassDB::bind_method(D_METHOD("_canvas_mouse_enter"), &TileMapEditor::_canvas_mouse_enter);
 	ClassDB::bind_method(D_METHOD("_canvas_mouse_exit"), &TileMapEditor::_canvas_mouse_exit);
@@ -1880,37 +1914,64 @@ TileMapEditor::TileMapEditor(EditorNode *p_editor) {
 
 	// Add menu items
 	toolbar = memnew(HBoxContainer);
-	toolbar->set_h_size_flags(SIZE_EXPAND_FILL);
-	toolbar->set_alignment(BoxContainer::ALIGN_END);
 	toolbar->hide();
 	CanvasItemEditor::get_singleton()->add_control_to_menu_panel(toolbar);
 
+	// Separator
+	toolbar->add_child(memnew(VSeparator));
+
+	// Tools
+	paint_button = memnew(ToolButton);
+	paint_button->set_shortcut(ED_SHORTCUT("tile_map_editor/paint_tile", TTR("Paint Tile"), KEY_P));
+	paint_button->connect("pressed", this, "_button_tool_select", make_binds(TOOL_NONE));
+	paint_button->set_toggle_mode(true);
+	toolbar->add_child(paint_button);
+
+	bucket_fill_button = memnew(ToolButton);
+	bucket_fill_button->set_shortcut(ED_SHORTCUT("tile_map_editor/bucket_fill", TTR("Bucket Fill"), KEY_G));
+	bucket_fill_button->connect("pressed", this, "_button_tool_select", make_binds(TOOL_BUCKET));
+	bucket_fill_button->set_toggle_mode(true);
+	toolbar->add_child(bucket_fill_button);
+
+	picker_button = memnew(ToolButton);
+	picker_button->set_shortcut(ED_SHORTCUT("tile_map_editor/pîck_tile", TTR("Pick Tile"), KEY_CONTROL));
+	picker_button->connect("pressed", this, "_button_tool_select", make_binds(TOOL_PICKING));
+	picker_button->set_toggle_mode(true);
+	toolbar->add_child(picker_button);
+
+	select_button = memnew(ToolButton);
+	select_button->set_shortcut(ED_SHORTCUT("tile_map_editor/pîck_tile", TTR("Select"), KEY_MASK_CMD + KEY_B));
+	select_button->connect("pressed", this, "_button_tool_select", make_binds(TOOL_SELECTING));
+	select_button->set_toggle_mode(true);
+	toolbar->add_child(select_button);
+
+	_update_button_tool();
+
+	// Container to the right of the toolbar
+	toolbar_right = memnew(HBoxContainer);
+	toolbar_right->set_h_size_flags(SIZE_EXPAND_FILL);
+	toolbar_right->set_alignment(BoxContainer::ALIGN_END);
+	CanvasItemEditor::get_singleton()->add_control_to_menu_panel(toolbar_right);
+
 	// Tile position
 	tile_info = memnew(Label);
-	toolbar->add_child(tile_info);
+	toolbar_right->add_child(tile_info);
 
+	// Menu
 	options = memnew(MenuButton);
 	options->set_text("TileMap");
 	options->set_icon(EditorNode::get_singleton()->get_gui_base()->get_icon("TileMap", "EditorIcons"));
 	options->set_process_unhandled_key_input(false);
+	toolbar_right->add_child(options);
 
 	PopupMenu *p = options->get_popup();
-
-	p->add_shortcut(ED_SHORTCUT("tile_map_editor/paint_tile", TTR("Paint Tile"), KEY_P), OPTION_PAINTING);
-	p->add_shortcut(ED_SHORTCUT("tile_map_editor/bucket_fill", TTR("Bucket Fill"), KEY_G), OPTION_BUCKET);
-	p->add_separator();
-	p->add_item(TTR("Pick Tile"), OPTION_PICK_TILE, KEY_CONTROL);
-	p->add_separator();
-	p->add_shortcut(ED_SHORTCUT("tile_map_editor/select", TTR("Select"), KEY_MASK_CMD + KEY_B), OPTION_SELECT);
 	p->add_shortcut(ED_SHORTCUT("tile_map_editor/cut_selection", TTR("Cut Selection"), KEY_MASK_CMD + KEY_X), OPTION_CUT);
 	p->add_shortcut(ED_SHORTCUT("tile_map_editor/copy_selection", TTR("Copy Selection"), KEY_MASK_CMD + KEY_C), OPTION_COPY);
 	p->add_shortcut(ED_GET_SHORTCUT("tile_map_editor/erase_selection"), OPTION_ERASE_SELECTION);
 	p->add_separator();
 	p->add_item(TTR("Fix Invalid Tiles"), OPTION_FIX_INVALID);
-
 	p->connect("id_pressed", this, "_menu_option");
 
-	toolbar->add_child(options);
 	rotate_left_button = memnew(ToolButton);
 	rotate_left_button->set_tooltip(TTR("Rotate left"));
 	rotate_left_button->set_focus_mode(FOCUS_NONE);

editor/plugins/tile_map_editor_plugin.h

@@ -66,12 +66,8 @@ class TileMapEditor : public VBoxContainer {
 
 	enum Options {
 
-		OPTION_BUCKET,
-		OPTION_PICK_TILE,
-		OPTION_SELECT,
 		OPTION_COPY,
 		OPTION_ERASE_SELECTION,
-		OPTION_PAINTING,
 		OPTION_FIX_INVALID,
 		OPTION_CUT
 	};
@@ -90,10 +86,16 @@ class TileMapEditor : public VBoxContainer {
 	ItemList *manual_palette;
 
 	HBoxContainer *toolbar;
+	HBoxContainer *toolbar_right;
 
 	Label *tile_info;
 	MenuButton *options;
 
+	ToolButton *paint_button;
+	ToolButton *bucket_fill_button;
+	ToolButton *picker_button;
+	ToolButton *select_button;
+
 	ToolButton *flip_horizontal_button;
 	ToolButton *flip_vertical_button;
 	ToolButton *rotate_left_button;
@@ -184,6 +186,8 @@ class TileMapEditor : public VBoxContainer {
 	void _text_changed(const String &p_text);
 	void _sbox_input(const Ref<InputEvent> &p_ie);
 	void _update_palette();
+	void _update_button_tool();
+	void _button_tool_select(int p_tool);
 	void _menu_option(int p_option);
 	void _palette_selected(int index);
 	void _palette_multi_selected(int index, bool selected);