Add path auto-tiling tool to map editor

Exposes the TilingPath code used by the map generator as a map editor tool to help automate the process of tiling sequences of templates together. No additional template stitching definitions are added as part of this commit. As such, the tool currently only supports the same auto tiling as the map generator does. This includes: - RA and CnC support. - Beaches, land cliffs, and roads. Support for additional mods and templates can be added in follow-ups by adding the necessary MultiBrush definitions. Related changes included in this commit to support this work include: - Add support for sparse EditorBlits. - Add support for MultiBrush to EditorBlitSource conversion. - Add support for EditorBlitSource previewing. - Adjust the "Road" types used in segmented MultiBrush definitions.
2025-05-11 00:45:48 +01:00
parent d3d949176d
commit ad08045e5f
28 changed files with 2460 additions and 919 deletions
--- a/OpenRA.Mods.Common/Widgets/Logic/Editor/TilingPathToolLogic.cs
+++ b/OpenRA.Mods.Common/Widgets/Logic/Editor/TilingPathToolLogic.cs
@@ -0,0 +1,111 @@
+#region Copyright & License Information
+/*
+ * Copyright (c) The OpenRA Developers and Contributors
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version. For more
+ * information, see COPYING.
+ */
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using OpenRA.Graphics;
+using OpenRA.Mods.Common.Traits;
+using OpenRA.Widgets;
+
+namespace OpenRA.Mods.Common.Widgets.Logic
+{
+	[IncludeStaticFluentReferences(
+		typeof(UpdateTilingPathPlanEditorAction),
+		typeof(PaintTilingPathEditorAction),
+		typeof(TilingPathToolInfo))]
+	public sealed class TilingPathToolLogic : ChromeLogic
+	{
+		[ObjectCreator.UseCtor]
+		public TilingPathToolLogic(
+			Widget widget,
+			World world,
+			ModData modData,
+			WorldRenderer worldRenderer,
+			Dictionary<string, MiniYaml> logicArgs)
+		{
+			var tool = world.WorldActor.Trait<TilingPathTool>();
+			var editorActionManager = world.WorldActor.Trait<EditorActionManager>();
+
+			var editorWidget = widget.Parent.Parent.Parent.Parent.Get<EditorViewportControllerWidget>("MAP_EDITOR");
+
+			((ScrollPanelWidget)widget).Layout.AdjustChildren();
+
+			var editCheckbox = widget.Get<CheckboxWidget>("EDIT");
+			editCheckbox.Disabled = !tool.Available;
+			if (!tool.Available)
+				return;
+
+			editCheckbox.IsChecked = () => editorWidget.CurrentBrush is EditorTilingPathBrush;
+			editCheckbox.OnClick = () =>
+				editorWidget.SetBrush(
+					editCheckbox.IsChecked()
+						? null
+						: new EditorTilingPathBrush(tool));
+
+			void SetupDropDown(
+				string name,
+				ImmutableArray<string> choices,
+				Func<string> read,
+				Action<string> write)
+			{
+				var dropDown = widget
+					.Get<ContainerWidget>(name)
+					.Get<DropDownButtonWidget>("DROPDOWN");
+				dropDown.GetText = read;
+				dropDown.OnMouseDown = _ =>
+				{
+					ScrollItemWidget SetupItem(string choice, ScrollItemWidget template)
+					{
+						bool IsSelected() => choice == read();
+						void OnClick() => write(choice);
+						var item = ScrollItemWidget.Setup(template, IsSelected, OnClick);
+						item.Get<LabelWidget>("LABEL").GetText = () => choice;
+						return item;
+					}
+
+					dropDown.ShowDropDown("LABEL_DROPDOWN_WITH_TOOLTIP_TEMPLATE", choices.Length * 30, choices, SetupItem);
+				};
+			}
+
+			SetupDropDown("START_TYPE", tool.StartTypes, () => tool.StartType, tool.SetStartType);
+			SetupDropDown("INNER_TYPE", tool.InnerTypes, () => tool.InnerType, tool.SetInnerType);
+			SetupDropDown("END_TYPE", tool.EndTypes, () => tool.EndType, tool.SetEndType);
+
+			var deviationSlider = widget.Get<ContainerWidget>("DEVIATION").Get<SliderWidget>("SLIDER");
+			deviationSlider.GetValue = () => tool.MaxDeviation;
+			deviationSlider.OnChange += (value) => tool.SetMaxDeviation((int)value);
+
+			var closedLoopsCheckbox = widget.Get<CheckboxWidget>("CLOSED_LOOPS");
+			closedLoopsCheckbox.IsChecked = () => tool.ClosedLoops;
+			closedLoopsCheckbox.OnClick = () => tool.SetClosedLoops(!tool.ClosedLoops);
+
+			var resetButton = widget.Get<ButtonWidget>("RESET");
+			resetButton.IsDisabled = () => tool.Plan == null;
+			resetButton.OnClick = () => editorActionManager.Add(
+				new UpdateTilingPathPlanEditorAction(tool, null));
+
+			var reverseButton = widget.Get<ButtonWidget>("REVERSE");
+			reverseButton.IsDisabled = () => tool.Plan == null;
+			reverseButton.OnClick = () => editorActionManager.Add(
+				new UpdateTilingPathPlanEditorAction(tool, tool.Plan.Reversed()));
+
+			var randomizeButton = widget.Get<ButtonWidget>("RANDOMIZE");
+			randomizeButton.IsDisabled = () => tool.Plan == null;
+			randomizeButton.OnClick = () => tool.SetRandomSeed(Environment.TickCount);
+
+			var paintButton = widget.Get<ButtonWidget>("PAINT");
+			paintButton.IsDisabled = () => tool.EditorBlitSource == null;
+			paintButton.OnClick = () => editorActionManager.Add(
+				new PaintTilingPathEditorAction(tool));
+		}
+	}
+}