Add IconDisplayStyles and ButtonDisplayStyles for FactorioObjectIcons and Buttons.

Author: DaleStan

Yafc/Utils/ObjectDisplayStyles.cs

@@ -0,0 +1,62 @@
+namespace Yafc.UI;
+
+/// <summary>
+/// Contains the display parameters for FactorioObjectIcons.
+/// </summary>
+/// <param name="Size">The icon size. The production tables use size 3.</param>
+/// <param name="MilestoneDisplay">The <see cref="Yafc.MilestoneDisplay"/> option to use when drawing the icon.</param>
+/// <param name="UseScaleSetting">Whether or not to obey the <see cref="Model.ProjectPreferences.iconScale"/> setting.</param>
+public record IconDisplayStyle(float Size, MilestoneDisplay MilestoneDisplay, bool UseScaleSetting) {
+    /// <summary>
+    /// Gets the default icon style: Size 2, <see cref="MilestoneDisplay.Normal"/>, and not scaled.
+    /// </summary>
+    public static IconDisplayStyle Default { get; } = new(2, MilestoneDisplay.Normal, false);
+}
+
+/// <summary>
+/// Contains the display parameters for FactorioObjectButtons. Buttons with a background color draw a scaled icon
+/// (<c><see cref="IconDisplayStyle.UseScaleSetting"/> = <see langword="true"/></c>) by default.
+/// </summary>
+/// <param name="Size">The icon size. The production tables use size 3.</param>
+/// <param name="MilestoneDisplay">The <see cref="MilestoneDisplay"/> option to use when drawing the icon.</param>
+/// <param name="BackgroundColor">The background color to display behind the icon.</param>
+public record ButtonDisplayStyle(float Size, MilestoneDisplay MilestoneDisplay, SchemeColor BackgroundColor) : IconDisplayStyle(Size, MilestoneDisplay, true) {
+    /// <summary>
+    /// Creates a new <see cref="ButtonDisplayStyle"/> for buttons that do not have a background color. These buttons will not obey the <see cref="Model.ProjectPreferences.iconScale"/> setting.
+    /// </summary>
+    /// <param name="size">The icon size. The production tables use size 3.</param>
+    /// <param name="milestoneDisplay">The <see cref="MilestoneDisplay"/> option to use when drawing the icon.</param>
+    public ButtonDisplayStyle(float size, MilestoneDisplay milestoneDisplay) : this(size, milestoneDisplay, SchemeColor.None) => UseScaleSetting = false;
+
+    /// <summary>
+    /// Gets the default button style: Size 2, <see cref="MilestoneDisplay.Normal"/>, no background, and not scaled.
+    /// </summary>
+    public static new ButtonDisplayStyle Default { get; } = new(2, MilestoneDisplay.Normal);
+    /// <summary>
+    /// Gets the button style for the <see cref="SelectObjectPanel{T}"/>s: Size 2.5, <see cref="MilestoneDisplay.Contained"/>, and scaled.
+    /// </summary>
+    /// <param name="backgroundColor">The background color to use for this button.</param>
+    public static ButtonDisplayStyle SelectObjectPanel(SchemeColor backgroundColor) => new(2.5f, MilestoneDisplay.Contained, backgroundColor);
+    /// <summary>
+    /// Gets the button style for production table buttons with a background: Size 2.5, <see cref="MilestoneDisplay.Contained"/>, and scaled.
+    /// </summary>
+    /// <param name="backgroundColor">The background color to use for this button.</param>
+    public static ButtonDisplayStyle ProductionTableScaled(SchemeColor backgroundColor) => new(3, MilestoneDisplay.Contained, backgroundColor);
+    /// <summary>
+    /// Gets the button style for production table buttons with no background: Size 2.5, <see cref="MilestoneDisplay.Contained"/>, and not scaled.
+    /// </summary>
+    public static ButtonDisplayStyle ProductionTableUnscaled { get; } = new(3, MilestoneDisplay.Contained);
+    /// <summary>
+    /// Gets the button style for small buttons in the Never Enough Items Explorer: Size 3, <see cref="MilestoneDisplay.Contained"/>, and not scaled.
+    /// </summary>
+    public static ButtonDisplayStyle NeieSmall { get; } = new(3, MilestoneDisplay.Contained);
+    /// <summary>
+    /// Gets the button style for large buttons in the Never Enough Items Explorer: Size 4, <see cref="MilestoneDisplay.Contained"/>, and not scaled.
+    /// </summary>
+    public static ButtonDisplayStyle NeieLarge { get; } = new(4, MilestoneDisplay.Contained);
+    /// <summary>
+    /// Gets the button style for the Milestones display buttons: Size 3, <see cref="MilestoneDisplay.None"/>, and scaled.
+    /// </summary>
+    /// <param name="backgroundColor">The background color to use for this button.</param>
+    public static ButtonDisplayStyle Milestone(SchemeColor backgroundColor) => new(3, MilestoneDisplay.None, backgroundColor);
+}

Yafc/Widgets/ImmediateWidgets.cs

@@ -8,11 +8,40 @@
 using Yafc.UI;
 
 namespace Yafc {
+
+    // Contained draws the milestone like this
+    // +----+
+    // |    |
+    // |  +-+
+    // |  | |
+    // +--+-+
+    // Normal draws the milestone like this
+    // +----+
+    // |    |
+    // |    |
+    // |   +-+
+    // +---| |
+    //     +-+
     public enum MilestoneDisplay {
+        /// <summary>
+        /// Draw the highest locked milestone centered on the lower-right corner of the base icon.
+        /// </summary>
         Normal,
+        /// <summary>
+        /// Draw the highest locked milestone with its lower-right corner aligned with the lower-right corner of the base icon.
+        /// </summary>
         Contained,
-        All,
-        AllContained,
+        /// <summary>
+        /// Draw the highest milestone, regardless of (un)lock state, centered on the lower-right corner of the base icon.
+        /// </summary>
+        Always,
+        /// <summary>
+        /// Draw the highest milestone, regardless of (un)lock state, with its lower-right corner aligned with the lower-right corner of the base icon.
+        /// </summary>
+        ContainedAlways,
+        /// <summary>
+        /// Do not draw a milestone icon.
+        /// </summary>
         None
     }
 
@@ -32,26 +61,26 @@ public enum Click {
     public static class ImmediateWidgets {
         /// <summary>Draws the icon belonging to a <see cref="FactorioObject"/>, or an empty box as a placeholder if no object is available.</summary>
         /// <param name="obj">Draw the icon for this object, or an empty box if this is <see langword="null"/>.</param>
-        /// <param name="useScale">If <see langword="true"/>, this icon will be displayed at <see cref="ProjectPreferences.iconScale"/>, instead of at 100% scale.</param>
-        public static void BuildFactorioObjectIcon(this ImGui gui, FactorioObject? obj, MilestoneDisplay display = MilestoneDisplay.Normal, float size = 2f, bool useScale = false) {
+        public static void BuildFactorioObjectIcon(this ImGui gui, FactorioObject? obj, IconDisplayStyle? displayStyle = null) {
+            displayStyle ??= IconDisplayStyle.Default;
             if (obj == null) {
-                gui.BuildIcon(Icon.Empty, size, SchemeColor.BackgroundTextFaint);
+                gui.BuildIcon(Icon.Empty, displayStyle.Size, SchemeColor.BackgroundTextFaint);
                 return;
             }
 
             var color = obj.IsAccessible() ? SchemeColor.Source : SchemeColor.SourceFaint;
-            if (useScale) {
-                Rect rect = gui.AllocateRect(size, size, RectAlignment.Middle);
-                gui.DrawIcon(rect.Expand(size * (Project.current.preferences.iconScale - 1) / 2), obj.icon, color);
+            if (displayStyle.UseScaleSetting) {
+                Rect rect = gui.AllocateRect(displayStyle.Size, displayStyle.Size, RectAlignment.Middle);
+                gui.DrawIcon(rect.Expand(displayStyle.Size * (Project.current.preferences.iconScale - 1) / 2), obj.icon, color);
             }
             else {
-                gui.BuildIcon(obj.icon, size, color);
+                gui.BuildIcon(obj.icon, displayStyle.Size, color);
             }
-            if (gui.isBuilding && display != MilestoneDisplay.None) {
-                bool contain = (display & MilestoneDisplay.Contained) != 0;
-                var milestone = Milestones.Instance.GetHighest(obj, display >= MilestoneDisplay.All);
+            if (gui.isBuilding && displayStyle.MilestoneDisplay != MilestoneDisplay.None) {
+                bool contain = (displayStyle.MilestoneDisplay & MilestoneDisplay.Contained) != 0;
+                FactorioObject? milestone = Milestones.Instance.GetHighest(obj, displayStyle.MilestoneDisplay >= MilestoneDisplay.Always);
                 if (milestone != null) {
-                    Vector2 psize = new Vector2(size / 2f);
+                    Vector2 psize = new Vector2(displayStyle.Size / 2f);
                     var delta = contain ? psize : psize / 2f;
                     Rect milestoneIcon = new Rect(gui.lastRect.BottomRight - delta, psize);
                     var icon = milestone == Database.voidEnergy ? DataUtils.HandIcon : milestone.icon;
@@ -70,7 +99,7 @@ public static bool BuildFloatInput(this ImGui gui, DisplayAmount amount, TextBox
             return false;
         }
 
-        public static Click BuildFactorioObjectButton(this ImGui gui, Rect rect, FactorioObject? obj, SchemeColor bgColor = SchemeColor.None, ObjectTooltipOptions tooltipOptions = default) {
+        public static Click BuildFactorioObjectButtonBackground(this ImGui gui, Rect rect, FactorioObject? obj, SchemeColor bgColor = SchemeColor.None, ObjectTooltipOptions tooltipOptions = default) {
             SchemeColor overColor;
             if (bgColor == SchemeColor.None) {
                 overColor = SchemeColor.Grey;
@@ -109,15 +138,15 @@ public static Click BuildFactorioObjectButton(this ImGui gui, Rect rect, Factori
 
         /// <summary>Draws a button displaying the icon belonging to a <see cref="FactorioObject"/>, or an empty box as a placeholder if no object is available.</summary>
         /// <param name="obj">Draw the icon for this object, or an empty box if this is <see langword="null"/>.</param>
-        /// <param name="useScale">If <see langword="true"/>, this icon will be displayed at <see cref="ProjectPreferences.iconScale"/>, instead of at 100% scale.</param>
-        public static Click BuildFactorioObjectButton(this ImGui gui, FactorioObject? obj, float size = 2f, MilestoneDisplay display = MilestoneDisplay.Normal, SchemeColor bgColor = SchemeColor.None, bool useScale = false, ObjectTooltipOptions tooltipOptions = default) {
-            gui.BuildFactorioObjectIcon(obj, display, size, useScale);
-            return gui.BuildFactorioObjectButton(gui.lastRect, obj, bgColor, tooltipOptions);
+        public static Click BuildFactorioObjectButton(this ImGui gui, FactorioObject? obj, ButtonDisplayStyle displayStyle, ObjectTooltipOptions tooltipOptions = default) {
+            gui.BuildFactorioObjectIcon(obj, displayStyle);
+            return gui.BuildFactorioObjectButtonBackground(gui.lastRect, obj, displayStyle.BackgroundColor, tooltipOptions);
         }
 
-        public static Click BuildFactorioObjectButtonWithText(this ImGui gui, FactorioObject? obj, string? extraText = null, float size = 2f, MilestoneDisplay display = MilestoneDisplay.Normal) {
+        public static Click BuildFactorioObjectButtonWithText(this ImGui gui, FactorioObject? obj, string? extraText = null, IconDisplayStyle? iconDisplayStyle = null) {
+            iconDisplayStyle ??= IconDisplayStyle.Default;
             using (gui.EnterRow()) {
-                gui.BuildFactorioObjectIcon(obj, display, size);
+                gui.BuildFactorioObjectIcon(obj, iconDisplayStyle);
                 var color = gui.textColor;
                 if (obj != null && !obj.IsAccessible()) {
                     color += 1;
@@ -136,7 +165,7 @@ public static Click BuildFactorioObjectButtonWithText(this ImGui gui, FactorioOb
                 gui.BuildText(obj == null ? "None" : obj.locName, TextBlockDisplayStyle.WrappedText with { Color = color });
             }
 
-            return gui.BuildFactorioObjectButton(gui.lastRect, obj);
+            return gui.BuildFactorioObjectButtonBackground(gui.lastRect, obj);
         }
 
         public static bool BuildInlineObjectList<T>(this ImGui gui, IEnumerable<T> list, IComparer<T> ordering, string header, [NotNullWhen(true)] out T? selected, int maxCount = 10,
@@ -205,12 +234,12 @@ public static void BuildInlineObjectListAndButtonWithNone<T>(this ImGui gui, ICo
         /// <param name="goods">Draw the icon for this object, or an empty box if this is <see langword="null"/>.</param>
         /// <param name="amount">Display this value and unit.</param>
         /// <param name="useScale">If <see langword="true"/>, this icon will be displayed at <see cref="ProjectPreferences.iconScale"/>, instead of at 100% scale.</param>
-        public static Click BuildFactorioObjectWithAmount(this ImGui gui, FactorioObject? goods, DisplayAmount amount, SchemeColor bgColor = SchemeColor.None, TextBlockDisplayStyle? textDisplayStyle = null, bool useScale = true, ObjectTooltipOptions tooltipOptions = default) {
+        public static Click BuildFactorioObjectWithAmount(this ImGui gui, FactorioObject? goods, DisplayAmount amount, ButtonDisplayStyle buttonDisplayStyle, TextBlockDisplayStyle? textDisplayStyle = null, ObjectTooltipOptions tooltipOptions = default) {
             textDisplayStyle ??= new(Alignment: RectAlignment.Middle);
             using (gui.EnterFixedPositioning(3f, 3f, default)) {
                 gui.allocator = RectAllocator.Stretch;
                 gui.spacing = 0f;
-                Click clicked = gui.BuildFactorioObjectButton(goods, 3f, MilestoneDisplay.Contained, bgColor, useScale, tooltipOptions);
+                Click clicked = gui.BuildFactorioObjectButton(goods, buttonDisplayStyle, tooltipOptions);
                 if (goods != null) {
                     gui.BuildText(DataUtils.FormatAmount(amount.Value, amount.Unit), textDisplayStyle);
                     if (InputSystem.Instance.control && gui.BuildButton(gui.lastRect, SchemeColor.None, SchemeColor.Grey) == ButtonEvent.MouseOver) {
@@ -265,10 +294,10 @@ public static void BuildObjectSelectDropDownWithNone<T>(this ImGui gui, ICollect
         /// <param name="amount">Display this value and unit. If the user edits the value, the new value will be stored in <see cref="DisplayAmount.Value"/> before returning.</param>
         /// <param name="allowScroll">If <see langword="true"/>, the default, the user can adjust the value by using the scroll wheel while hovering over the editable text.
         /// If <see langword="false"/>, the scroll wheel will be ignored when hovering.</param>
-        public static GoodsWithAmountEvent BuildFactorioObjectWithEditableAmount(this ImGui gui, FactorioObject? obj, DisplayAmount amount, SchemeColor color = SchemeColor.None, bool useScale = true, bool allowScroll = true, ObjectTooltipOptions tooltipOptions = default) {
+        public static GoodsWithAmountEvent BuildFactorioObjectWithEditableAmount(this ImGui gui, FactorioObject? obj, DisplayAmount amount, ButtonDisplayStyle buttonDisplayStyle, bool allowScroll = true, ObjectTooltipOptions tooltipOptions = default) {
             using var group = gui.EnterGroup(default, RectAllocator.Stretch, spacing: 0f);
             group.SetWidth(3f);
-            GoodsWithAmountEvent evt = (GoodsWithAmountEvent)gui.BuildFactorioObjectButton(obj, 3f, MilestoneDisplay.Contained, color, useScale, tooltipOptions);
+            GoodsWithAmountEvent evt = (GoodsWithAmountEvent)gui.BuildFactorioObjectButton(obj, buttonDisplayStyle, tooltipOptions);
 
             if (gui.BuildFloatInput(amount, TextBoxDisplayStyle.FactorioObjectInput)) {
                 return GoodsWithAmountEvent.TextEditing;

Yafc/Widgets/ObjectTooltip.cs

@@ -520,7 +520,7 @@ private void BuildTechnology(Technology technology, ImGui gui) {
                     using var grid = gui.EnterInlineGrid(3f);
                     foreach (var pack in packs) {
                         grid.Next();
-                        _ = gui.BuildFactorioObjectWithAmount(pack.goods, pack.amount);
+                        _ = gui.BuildFactorioObjectWithAmount(pack.goods, pack.amount, ButtonDisplayStyle.ProductionTableUnscaled);
                     }
                 }
             }

Yafc/Windows/DependencyExplorer.cs

@@ -45,7 +45,7 @@ private void DrawFactorioObject(ImGui gui, FactorioId id) {
                 string text = fobj.locName + " (" + fobj.type + ")";
                 gui.RemainingRow(0.5f).BuildText(text, TextBlockDisplayStyle.WrappedText with { Color = fobj.IsAccessible() ? SchemeColor.BackgroundText : SchemeColor.BackgroundTextFaint });
             }
-            if (gui.BuildFactorioObjectButton(gui.lastRect, fobj, tooltipOptions: new() { ExtendHeader = true }) == Click.Left) {
+            if (gui.BuildFactorioObjectButtonBackground(gui.lastRect, fobj, tooltipOptions: new() { ExtendHeader = true }) == Click.Left) {
                 Change(fobj);
             }
         }

Yafc/Windows/MilestonesEditor.cs

@@ -26,7 +26,7 @@ protected override void Close(bool save = true) {
         private void MilestoneDrawer(ImGui gui, FactorioObject element, int index) {
             using (gui.EnterRow()) {
                 var settings = Project.current.settings;
-                gui.BuildFactorioObjectIcon(element, MilestoneDisplay.None, 3f);
+                gui.BuildFactorioObjectIcon(element, new IconDisplayStyle(3f, MilestoneDisplay.None, false));
                 gui.BuildText(element.locName, maxWidth: width - 16.6f); // Experimentally determined width of the non-text parts of the editor.
                 if (gui.BuildButton(Icon.Close, size: 1f)) {
                     _ = settings.RecordUndo().milestones.Remove(element);

Yafc/Windows/MilestonesPanel.cs

@@ -9,7 +9,7 @@ public class MilestonesWidget : VirtualScrollList<FactorioObject> {
         private static void MilestoneDrawer(ImGui gui, FactorioObject element, int index) {
             var settings = Project.current.settings;
             bool unlocked = settings.Flags(element).HasFlags(ProjectPerItemFlags.MilestoneUnlocked);
-            if (gui.BuildFactorioObjectButton(element, 3f, display: MilestoneDisplay.None, bgColor: unlocked ? SchemeColor.Primary : SchemeColor.None) == Click.Left) {
+            if (gui.BuildFactorioObjectButton(element, ButtonDisplayStyle.Milestone(unlocked ? SchemeColor.Primary : SchemeColor.None)) == Click.Left) {
                 if (!unlocked) {
                     var massUnlock = Milestones.Instance.GetMilestoneResult(element);
                     int subIndex = 0;