#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.ObjectModel; using System.Globalization; using System.Linq; using OpenRA.Graphics; using OpenRA.Mods.Common.Traits; using OpenRA.Primitives; using OpenRA.Widgets; namespace OpenRA.Mods.Common.Widgets.Logic { public class DisplaySettingsLogic : ChromeLogic { [FluentReference] const string Close = "options-camera.close"; [FluentReference] const string Medium = "options-camera.medium"; [FluentReference] const string Far = "options-camera.far"; [FluentReference] const string Furthest = "options-camera.furthest"; [FluentReference] const string Windowed = "options-display-mode.windowed"; [FluentReference] const string LegacyFullscreen = "options-display-mode.legacy-fullscreen"; [FluentReference] const string Fullscreen = "options-display-mode.fullscreen"; [FluentReference("number")] const string Display = "label-video-display-index"; [FluentReference] const string Standard = "options-status-bars.standard"; [FluentReference] const string ShowOnDamage = "options-status-bars.show-on-damage"; [FluentReference] const string AlwaysShow = "options-status-bars.always-show"; [FluentReference] const string Automatic = "options-target-lines.automatic"; [FluentReference] const string Manual = "options-target-lines.manual"; [FluentReference] const string Disabled = "options-target-lines.disabled"; [FluentReference("fps")] const string FrameLimiter = "checkbox-frame-limiter"; static readonly int OriginalVideoDisplay; static readonly WindowMode OriginalGraphicsMode; static readonly int2 OriginalGraphicsWindowedSize; static readonly int2 OriginalGraphicsFullscreenSize; static readonly GLProfile OriginalGLProfile; readonly ModData modData; readonly WorldRenderer worldRenderer; readonly WorldViewportSizes viewportSizes; readonly string showOnDamage; readonly string alwaysShow; readonly string automatic; readonly string manual; readonly string disabled; readonly string legacyFullscreen; readonly string fullscreen; static DisplaySettingsLogic() { var original = Game.Settings; OriginalGraphicsMode = original.Graphics.Mode; OriginalVideoDisplay = original.Graphics.VideoDisplay; OriginalGraphicsWindowedSize = original.Graphics.WindowedSize; OriginalGraphicsFullscreenSize = original.Graphics.FullscreenSize; OriginalGLProfile = original.Graphics.GLProfile; } [ObjectCreator.UseCtor] public DisplaySettingsLogic( Action>, Func> registerPanel, string panelID, string label, ModData modData, WorldRenderer worldRenderer) { this.worldRenderer = worldRenderer; this.modData = modData; viewportSizes = modData.Manifest.Get(); legacyFullscreen = FluentProvider.GetMessage(LegacyFullscreen); fullscreen = FluentProvider.GetMessage(Fullscreen); registerPanel(panelID, label, InitPanel, ResetPanel); showOnDamage = FluentProvider.GetMessage(ShowOnDamage); alwaysShow = FluentProvider.GetMessage(AlwaysShow); automatic = FluentProvider.GetMessage(Automatic); manual = FluentProvider.GetMessage(Manual); disabled = FluentProvider.GetMessage(Disabled); } public static string GetViewportSizeName(ModData modData, WorldViewport worldViewport) { switch (worldViewport) { case WorldViewport.Close: return FluentProvider.GetMessage(Close); case WorldViewport.Medium: return FluentProvider.GetMessage(Medium); case WorldViewport.Far: return FluentProvider.GetMessage(Far); case WorldViewport.Native: return FluentProvider.GetMessage(Furthest); default: return ""; } } Func InitPanel(Widget panel) { var ds = Game.Settings.Graphics; var gs = Game.Settings.Game; var world = worldRenderer.World; var scrollPanel = panel.Get("SETTINGS_SCROLLPANEL"); SettingsUtils.BindCheckboxPref(panel, "CURSORDOUBLE_CHECKBOX", ds, "CursorDouble"); SettingsUtils.BindCheckboxPref(panel, "VSYNC_CHECKBOX", ds, "VSync"); SettingsUtils.BindCheckboxPref(panel, "FRAME_LIMIT_CHECKBOX", ds, "CapFramerate"); SettingsUtils.BindCheckboxPref(panel, "FRAME_LIMIT_GAMESPEED_CHECKBOX", ds, "CapFramerateToGameFps"); SettingsUtils.BindIntSliderPref(panel, "FRAME_LIMIT_SLIDER", ds, "MaxFramerate"); SettingsUtils.BindCheckboxPref(panel, "PLAYER_STANCE_COLORS_CHECKBOX", gs, "UsePlayerStanceColors"); var cb = panel.Get("PLAYER_STANCE_COLORS_CHECKBOX"); cb.IsChecked = () => gs.UsePlayerStanceColors; cb.OnClick = () => { gs.UsePlayerStanceColors = cb.IsChecked() ^ true; Player.SetupRelationshipColors(world.Players, world.LocalPlayer, worldRenderer, false); }; if (panel.GetOrNull("PAUSE_SHELLMAP_CHECKBOX") != null) SettingsUtils.BindCheckboxPref(panel, "PAUSE_SHELLMAP_CHECKBOX", gs, "PauseShellmap"); SettingsUtils.BindCheckboxPref(panel, "HIDE_REPLAY_CHAT_CHECKBOX", gs, "HideReplayChat"); var windowModeDropdown = panel.Get("MODE_DROPDOWN"); windowModeDropdown.OnMouseDown = _ => ShowWindowModeDropdown(windowModeDropdown, ds, scrollPanel); windowModeDropdown.GetText = () => ds.Mode == WindowMode.Windowed ? FluentProvider.GetMessage(Windowed) : ds.Mode == WindowMode.Fullscreen ? legacyFullscreen : fullscreen; var displaySelectionDropDown = panel.Get("DISPLAY_SELECTION_DROPDOWN"); displaySelectionDropDown.OnMouseDown = _ => ShowDisplaySelectionDropdown(displaySelectionDropDown, ds); var displaySelectionLabel = new CachedTransform(i => FluentProvider.GetMessage(Display, "number", i + 1)); displaySelectionDropDown.GetText = () => displaySelectionLabel.Update(ds.VideoDisplay); displaySelectionDropDown.IsDisabled = () => Game.Renderer.DisplayCount < 2; var glProfileLabel = new CachedTransform(p => p.ToString()); var glProfileDropdown = panel.Get("GL_PROFILE_DROPDOWN"); var disableProfile = Game.Renderer.SupportedGLProfiles.Length < 2 && ds.GLProfile == GLProfile.Automatic; glProfileDropdown.OnMouseDown = _ => ShowGLProfileDropdown(glProfileDropdown, ds); glProfileDropdown.GetText = () => glProfileLabel.Update(ds.GLProfile); glProfileDropdown.IsDisabled = () => disableProfile; var statusBarsDropDown = panel.Get("STATUS_BAR_DROPDOWN"); statusBarsDropDown.OnMouseDown = _ => ShowStatusBarsDropdown(statusBarsDropDown, gs); statusBarsDropDown.GetText = () => gs.StatusBars == StatusBarsType.Standard ? FluentProvider.GetMessage(Standard) : gs.StatusBars == StatusBarsType.DamageShow ? showOnDamage : alwaysShow; var targetLinesDropDown = panel.Get("TARGET_LINES_DROPDOWN"); targetLinesDropDown.OnMouseDown = _ => ShowTargetLinesDropdown(targetLinesDropDown, gs); targetLinesDropDown.GetText = () => gs.TargetLines == TargetLinesType.Automatic ? automatic : gs.TargetLines == TargetLinesType.Manual ? manual : disabled; var battlefieldCameraDropDown = panel.Get("BATTLEFIELD_CAMERA_DROPDOWN"); var battlefieldCameraLabel = new CachedTransform(vs => GetViewportSizeName(modData, vs)); battlefieldCameraDropDown.OnMouseDown = _ => ShowBattlefieldCameraDropdown(modData, battlefieldCameraDropDown, viewportSizes, ds); battlefieldCameraDropDown.GetText = () => battlefieldCameraLabel.Update(ds.ViewportDistance); BindTextNotificationPoolFilterSettings(panel, gs); // Update vsync immediately var vsyncCheckbox = panel.Get("VSYNC_CHECKBOX"); var vsyncOnClick = vsyncCheckbox.OnClick; vsyncCheckbox.OnClick = () => { vsyncOnClick(); Game.Renderer.SetVSyncEnabled(ds.VSync); }; var uiScaleDropdown = panel.Get("UI_SCALE_DROPDOWN"); var uiScaleLabel = new CachedTransform(s => $"{(int)(100 * s)}%"); uiScaleDropdown.OnMouseDown = _ => ShowUIScaleDropdown(uiScaleDropdown, ds); uiScaleDropdown.GetText = () => uiScaleLabel.Update(ds.UIScale); var minResolution = viewportSizes.MinEffectiveResolution; var resolution = Game.Renderer.Resolution; var disableUIScale = world.Type != WorldType.Shellmap || resolution.Width * ds.UIScale < 1.25f * minResolution.Width || resolution.Height * ds.UIScale < 1.25f * minResolution.Height; uiScaleDropdown.IsDisabled = () => disableUIScale; panel.Get("DISPLAY_SELECTION_CONTAINER").IsVisible = () => ds.Mode != WindowMode.Windowed; panel.Get("WINDOW_RESOLUTION_CONTAINER").IsVisible = () => ds.Mode == WindowMode.Windowed; var windowWidth = panel.Get("WINDOW_WIDTH"); var origWidthText = windowWidth.Text = ds.WindowedSize.X.ToString(NumberFormatInfo.CurrentInfo); var windowHeight = panel.Get("WINDOW_HEIGHT"); var origHeightText = windowHeight.Text = ds.WindowedSize.Y.ToString(NumberFormatInfo.CurrentInfo); windowHeight.Text = ds.WindowedSize.Y.ToString(NumberFormatInfo.CurrentInfo); var restartDesc = panel.Get("VIDEO_RESTART_REQUIRED_DESC"); restartDesc.IsVisible = () => ds.Mode != OriginalGraphicsMode || ds.VideoDisplay != OriginalVideoDisplay || ds.GLProfile != OriginalGLProfile || (ds.Mode == WindowMode.Windowed && (origWidthText != windowWidth.Text || origHeightText != windowHeight.Text)); var frameLimitGamespeedCheckbox = panel.Get("FRAME_LIMIT_GAMESPEED_CHECKBOX"); var frameLimitCheckbox = panel.Get("FRAME_LIMIT_CHECKBOX"); var frameLimitLabel = new CachedTransform(fps => FluentProvider.GetMessage(FrameLimiter, "fps", fps)); frameLimitCheckbox.GetText = () => frameLimitLabel.Update(ds.MaxFramerate); frameLimitCheckbox.IsDisabled = () => ds.CapFramerateToGameFps; panel.Get("FRAME_LIMIT_SLIDER").IsDisabled = () => !frameLimitCheckbox.IsChecked() || frameLimitGamespeedCheckbox.IsChecked(); // Player profile var ps = Game.Settings.Player; var escPressed = false; var nameTextfield = panel.Get("PLAYERNAME"); nameTextfield.IsDisabled = () => world.Type != WorldType.Shellmap; nameTextfield.Text = Settings.SanitizedPlayerName(ps.Name); nameTextfield.OnLoseFocus = () => { if (escPressed) { escPressed = false; return; } nameTextfield.Text = nameTextfield.Text.Trim(); if (nameTextfield.Text.Length == 0) nameTextfield.Text = Settings.SanitizedPlayerName(ps.Name); else { nameTextfield.Text = Settings.SanitizedPlayerName(nameTextfield.Text); ps.Name = nameTextfield.Text; } }; nameTextfield.OnEnterKey = _ => { nameTextfield.YieldKeyboardFocus(); return true; }; nameTextfield.OnEscKey = _ => { nameTextfield.Text = Settings.SanitizedPlayerName(ps.Name); escPressed = true; nameTextfield.YieldKeyboardFocus(); return true; }; var colorManager = modData.DefaultRules.Actors[SystemActors.World].TraitInfo(); var colorDropdown = panel.Get("PLAYERCOLOR"); colorDropdown.IsDisabled = () => world.Type != WorldType.Shellmap; colorDropdown.OnMouseDown = _ => colorManager.ShowColorDropDown(colorDropdown, ps.Color, null, worldRenderer, color => { ps.Color = color; Game.Settings.Save(); }); colorDropdown.Get("COLORBLOCK").GetColor = () => ps.Color; SettingsUtils.AdjustSettingsScrollPanelLayout(scrollPanel); return () => { int.TryParse(windowWidth.Text, NumberStyles.Integer, NumberFormatInfo.CurrentInfo, out var x); int.TryParse(windowHeight.Text, NumberStyles.Integer, NumberFormatInfo.CurrentInfo, out var y); ds.WindowedSize = new int2(x, y); nameTextfield.YieldKeyboardFocus(); return ds.Mode != OriginalGraphicsMode || ds.VideoDisplay != OriginalVideoDisplay || ds.WindowedSize != OriginalGraphicsWindowedSize || ds.FullscreenSize != OriginalGraphicsFullscreenSize || ds.GLProfile != OriginalGLProfile; }; } Action ResetPanel(Widget panel) { var ds = Game.Settings.Graphics; var ps = Game.Settings.Player; var gs = Game.Settings.Game; var dds = new GraphicSettings(); var dps = new PlayerSettings(); var dgs = new GameSettings(); return () => { ds.CapFramerate = dds.CapFramerate; ds.MaxFramerate = dds.MaxFramerate; ds.CapFramerateToGameFps = dds.CapFramerateToGameFps; ds.GLProfile = dds.GLProfile; ds.Mode = dds.Mode; ds.VideoDisplay = dds.VideoDisplay; ds.WindowedSize = dds.WindowedSize; ds.CursorDouble = dds.CursorDouble; ds.ViewportDistance = dds.ViewportDistance; if (ds.UIScale != dds.UIScale) { var oldScale = ds.UIScale; ds.UIScale = dds.UIScale; Game.Renderer.SetUIScale(dds.UIScale); RecalculateWidgetLayout(Ui.Root); Viewport.LastMousePos = (Viewport.LastMousePos.ToFloat2() * oldScale / ds.UIScale).ToInt2(); } ps.Color = dps.Color; ps.Name = dps.Name; gs.TextNotificationPoolFilters = dgs.TextNotificationPoolFilters; }; } static void ShowWindowModeDropdown(DropDownButtonWidget dropdown, GraphicSettings s, ScrollPanelWidget scrollPanel) { var options = new Dictionary() { { FluentProvider.GetMessage(Fullscreen), WindowMode.PseudoFullscreen }, { FluentProvider.GetMessage(LegacyFullscreen), WindowMode.Fullscreen }, { FluentProvider.GetMessage(Windowed), WindowMode.Windowed }, }; ScrollItemWidget SetupItem(string o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => s.Mode == options[o], () => { s.Mode = options[o]; SettingsUtils.AdjustSettingsScrollPanelLayout(scrollPanel); }); item.Get("LABEL").GetText = () => o; return item; } dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, options.Keys, SetupItem); } public static void BindTextNotificationPoolFilterSettings(Widget panel, GameSettings gs) { void ToggleFilterFlag(TextNotificationPoolFilters f) { gs.TextNotificationPoolFilters ^= f; Game.Settings.Save(); } var feedbackCheckbox = panel.GetOrNull("UI_FEEDBACK_CHECKBOX"); if (feedbackCheckbox != null) { feedbackCheckbox.IsChecked = () => gs.TextNotificationPoolFilters.HasFlag(TextNotificationPoolFilters.Feedback); feedbackCheckbox.OnClick = () => ToggleFilterFlag(TextNotificationPoolFilters.Feedback); } var transientsCheckbox = panel.GetOrNull("TRANSIENTS_CHECKBOX"); if (transientsCheckbox != null) { transientsCheckbox.IsChecked = () => gs.TextNotificationPoolFilters.HasFlag(TextNotificationPoolFilters.Transients); transientsCheckbox.OnClick = () => ToggleFilterFlag(TextNotificationPoolFilters.Transients); } } static void ShowStatusBarsDropdown(DropDownButtonWidget dropdown, GameSettings s) { var options = new Dictionary() { { FluentProvider.GetMessage(Standard), StatusBarsType.Standard }, { FluentProvider.GetMessage(ShowOnDamage), StatusBarsType.DamageShow }, { FluentProvider.GetMessage(AlwaysShow), StatusBarsType.AlwaysShow }, }; ScrollItemWidget SetupItem(string o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => s.StatusBars == options[o], () => s.StatusBars = options[o]); item.Get("LABEL").GetText = () => o; return item; } dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, options.Keys, SetupItem); } static void ShowDisplaySelectionDropdown(DropDownButtonWidget dropdown, GraphicSettings s) { ScrollItemWidget SetupItem(int o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => s.VideoDisplay == o, () => s.VideoDisplay = o); var label = $"Display {o + 1}"; item.Get("LABEL").GetText = () => label; return item; } dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, Enumerable.Range(0, Game.Renderer.DisplayCount), SetupItem); } static void ShowGLProfileDropdown(DropDownButtonWidget dropdown, GraphicSettings s) { ScrollItemWidget SetupItem(GLProfile o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => s.GLProfile == o, () => s.GLProfile = o); var label = o.ToString(); item.Get("LABEL").GetText = () => label; return item; } var profiles = new[] { GLProfile.Automatic }.Concat(Game.Renderer.SupportedGLProfiles); dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, profiles, SetupItem); } static void ShowTargetLinesDropdown(DropDownButtonWidget dropdown, GameSettings s) { var options = new Dictionary() { { FluentProvider.GetMessage(Automatic), TargetLinesType.Automatic }, { FluentProvider.GetMessage(Manual), TargetLinesType.Manual }, { FluentProvider.GetMessage(Disabled), TargetLinesType.Disabled }, }; ScrollItemWidget SetupItem(string o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => s.TargetLines == options[o], () => s.TargetLines = options[o]); item.Get("LABEL").GetText = () => o; return item; } dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, options.Keys, SetupItem); } public static void ShowBattlefieldCameraDropdown(ModData modData, DropDownButtonWidget dropdown, WorldViewportSizes viewportSizes, GraphicSettings gs) { ScrollItemWidget SetupItem(WorldViewport o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => gs.ViewportDistance == o, () => gs.ViewportDistance = o); var label = GetViewportSizeName(modData, o); item.Get("LABEL").GetText = () => label; return item; } var windowHeight = Game.Renderer.NativeResolution.Height; var validSizes = new List() { WorldViewport.Close }; if (viewportSizes.GetSizeRange(WorldViewport.Medium).X < windowHeight) validSizes.Add(WorldViewport.Medium); var farRange = viewportSizes.GetSizeRange(WorldViewport.Far); if (farRange.X < windowHeight) validSizes.Add(WorldViewport.Far); if (viewportSizes.AllowNativeZoom && farRange.Y < windowHeight) validSizes.Add(WorldViewport.Native); dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, validSizes, SetupItem); } static void RecalculateWidgetLayout(Widget w, bool insideScrollPanel = false) { // HACK: Recalculate the widget bounds to fit within the new effective window bounds // This is fragile, and only works when called when Settings is opened via the main menu. // HACK: Skip children badges container on the main menu and settings tab container // These have a fixed size, with calculated size and children positions that break if we adjust them here if (w.Id == "BADGES_CONTAINER" || w.Id == "SETTINGS_TAB_CONTAINER") return; var parentBounds = w.Parent == null ? new WidgetBounds(0, 0, Game.Renderer.Resolution.Width, Game.Renderer.Resolution.Height) : w.Parent.Bounds; var substitutions = new Dictionary { { "WINDOW_WIDTH", Game.Renderer.Resolution.Width }, { "WINDOW_HEIGHT", Game.Renderer.Resolution.Height }, { "PARENT_WIDTH", parentBounds.Width }, { "PARENT_HEIGHT", parentBounds.Height } }; var readOnlySubstitutions = new ReadOnlyDictionary(substitutions); var width = w.Width?.Evaluate(readOnlySubstitutions) ?? 0; var height = w.Height?.Evaluate(readOnlySubstitutions) ?? 0; substitutions.Add("WIDTH", width); substitutions.Add("HEIGHT", height); if (insideScrollPanel) w.Bounds = new WidgetBounds(w.Bounds.X, w.Bounds.Y, width, w.Bounds.Height); else w.Bounds = new WidgetBounds( w.X?.Evaluate(readOnlySubstitutions) ?? 0, w.Y?.Evaluate(readOnlySubstitutions) ?? 0, width, height); foreach (var c in w.Children) RecalculateWidgetLayout(c, insideScrollPanel || w is ScrollPanelWidget); } public static void ShowUIScaleDropdown(DropDownButtonWidget dropdown, GraphicSettings gs) { ScrollItemWidget SetupItem(float o, ScrollItemWidget itemTemplate) { var item = ScrollItemWidget.Setup(itemTemplate, () => gs.UIScale == o, () => { Game.RunAfterTick(() => { var oldScale = gs.UIScale; gs.UIScale = o; Game.Renderer.SetUIScale(o); RecalculateWidgetLayout(Ui.Root); Viewport.LastMousePos = (Viewport.LastMousePos.ToFloat2() * oldScale / gs.UIScale).ToInt2(); }); }); var label = $"{(int)(100 * o)}%"; item.Get("LABEL").GetText = () => label; return item; } var viewportSizes = Game.ModData.Manifest.Get(); var maxScales = new float2(Game.Renderer.NativeResolution) / new float2(viewportSizes.MinEffectiveResolution); var maxScale = Math.Min(maxScales.X, maxScales.Y); var validScales = new[] { 1f, 1.25f, 1.5f, 1.75f, 2f }.Where(x => x <= maxScale); dropdown.ShowDropDown("LABEL_DROPDOWN_TEMPLATE", 500, validScales, SetupItem); } } }