// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using osuTK; using osu.Framework.Allocation; using osu.Framework.Bindables; using osu.Framework.Extensions.Color4Extensions; using osu.Framework.Extensions.IEnumerableExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Cursor; using osu.Framework.Graphics.Effects; using osu.Framework.Graphics.Primitives; using osu.Framework.Graphics.Shapes; using osu.Framework.Input.Events; using osu.Game.Graphics.Containers; using osu.Game.Graphics.UserInterface; using osu.Game.Overlays.Settings; using osuTK.Graphics; namespace osu.Game.Overlays { [Cached] public abstract partial class SettingsPanel : OsuFocusedOverlayContainer { public const float CONTENT_MARGINS = 20; public const float TRANSITION_LENGTH = 600; private const float sidebar_width = SettingsSidebar.EXPANDED_WIDTH; /// /// The width of the settings panel content, excluding the sidebar. /// public const float PANEL_WIDTH = 400; /// /// The full width of the settings panel, including the sidebar. /// public const float WIDTH = sidebar_width + PANEL_WIDTH; protected Container ContentContainer; protected override Container Content => ContentContainer; protected SettingsSidebar Sidebar; private SidebarIconButton selectedSidebarButton; public SettingsSectionsContainer SectionsContainer { get; private set; } private SeekLimitedSearchTextBox searchTextBox; protected override string PopInSampleName => "UI/settings-pop-in"; protected override double PopInOutSampleBalance => -OsuGameBase.SFX_STEREO_STRENGTH; private readonly bool showBackButton; private LoadingLayer loading; private readonly List loadableSections = new List(); private Task sectionsLoadingTask; public IBindable CurrentSection = new Bindable(); [Cached] private OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Purple); protected SettingsPanel(bool showBackButton) { this.showBackButton = showBackButton; RelativeSizeAxes = Axes.Y; AutoSizeAxes = Axes.X; } protected virtual IEnumerable CreateSections() => null; [BackgroundDependencyLoader] private void load() { InternalChild = ContentContainer = new NonMaskedContent { X = -WIDTH + ExpandedPosition, Width = PANEL_WIDTH, RelativeSizeAxes = Axes.Y, Children = new Drawable[] { new Box { Anchor = Anchor.TopRight, Origin = Anchor.TopRight, Scale = new Vector2(2, 1), // over-extend to the left for transitions RelativeSizeAxes = Axes.Both, Colour = colourProvider.Background4, Alpha = 1, }, loading = new LoadingLayer { State = { Value = Visibility.Visible } } } }; Add(new PopoverContainer { RelativeSizeAxes = Axes.Both, Child = SectionsContainer = new SettingsSectionsContainer { Masking = true, EdgeEffect = new EdgeEffectParameters { Colour = Color4.Black.Opacity(0), Type = EdgeEffectType.Shadow, Hollow = true, Radius = 10 }, MaskingSmoothness = 0, RelativeSizeAxes = Axes.Both, ExpandableHeader = CreateHeader(), SelectedSection = { BindTarget = CurrentSection }, FixedHeader = new Container { RelativeSizeAxes = Axes.X, AutoSizeAxes = Axes.Y, Padding = new MarginPadding { Vertical = 20, Horizontal = CONTENT_MARGINS }, Anchor = Anchor.TopCentre, Origin = Anchor.TopCentre, Child = searchTextBox = new SettingsSearchTextBox { RelativeSizeAxes = Axes.X, Origin = Anchor.TopCentre, Anchor = Anchor.TopCentre, } }, Footer = CreateFooter().With(f => f.Alpha = 0) } }); AddInternal(Sidebar = new SettingsSidebar(showBackButton) { BackButtonAction = Hide, Width = sidebar_width }); CreateSections()?.ForEach(AddSection); } protected void AddSection(SettingsSection section) { if (IsLoaded) // just to keep things simple. can be accommodated for if we ever need it. throw new InvalidOperationException("All sections must be added before the panel is loaded."); loadableSections.Add(section); } protected virtual Drawable CreateHeader() => new Container(); protected virtual Drawable CreateFooter() => new Container(); protected override void PopIn() { ContentContainer.MoveToX(ExpandedPosition, TRANSITION_LENGTH, Easing.OutQuint); SectionsContainer.FadeEdgeEffectTo(WaveContainer.SHADOW_OPACITY, WaveContainer.APPEAR_DURATION, Easing.Out); // delay load enough to ensure it doesn't overlap with the initial animation. // this is done as there is still a brief stutter during load completion which is more visible if the transition is in progress. // the eventual goal would be to remove the need for this by splitting up load into smaller work pieces, or fixing the remaining // load complete overheads. Scheduler.AddDelayed(loadSections, TRANSITION_LENGTH / 3); Sidebar?.MoveToX(0, TRANSITION_LENGTH, Easing.OutQuint); this.FadeTo(1, TRANSITION_LENGTH / 2, Easing.OutQuint); searchTextBox.TakeFocus(); searchTextBox.HoldFocus = true; } protected virtual float ExpandedPosition => 0; protected override void PopOut() { base.PopOut(); SectionsContainer.FadeEdgeEffectTo(0, WaveContainer.DISAPPEAR_DURATION, Easing.In); ContentContainer.MoveToX(-WIDTH + ExpandedPosition, TRANSITION_LENGTH, Easing.OutQuint); Sidebar?.MoveToX(-sidebar_width, TRANSITION_LENGTH, Easing.OutQuint); this.FadeTo(0, TRANSITION_LENGTH / 2, Easing.OutQuint); searchTextBox.HoldFocus = false; if (searchTextBox.HasFocus) GetContainingFocusManager().ChangeFocus(null); } public override bool AcceptsFocus => true; protected override void OnFocus(FocusEvent e) { searchTextBox.TakeFocus(); base.OnFocus(e); } protected override void UpdateAfterChildren() { base.UpdateAfterChildren(); ContentContainer.Margin = new MarginPadding { Left = Sidebar?.DrawWidth ?? 0 }; } private const double fade_in_duration = 500; private void loadSections() { if (sectionsLoadingTask != null) return; sectionsLoadingTask = LoadComponentsAsync(loadableSections, sections => { SectionsContainer.AddRange(sections); SectionsContainer.Footer.FadeInFromZero(fade_in_duration, Easing.OutQuint); SectionsContainer.SearchContainer.FadeInFromZero(fade_in_duration, Easing.OutQuint); loading.Hide(); searchTextBox.Current.BindValueChanged(term => SectionsContainer.SearchTerm = term.NewValue, true); loadSidebarButtons(); }); } private void loadSidebarButtons() { if (Sidebar == null) return; LoadComponentsAsync(createSidebarButtons(), buttons => { float delay = 0; foreach (var button in buttons) { Sidebar.Add(button); button.FadeOut() .Delay(delay) .FadeInFromZero(fade_in_duration, Easing.OutQuint); delay += 40; } SectionsContainer.SelectedSection.BindValueChanged(section => { if (selectedSidebarButton != null) selectedSidebarButton.Selected = false; selectedSidebarButton = Sidebar.Children.OfType().FirstOrDefault(b => b.Section == section.NewValue); if (selectedSidebarButton != null) selectedSidebarButton.Selected = true; }, true); }); } private IEnumerable createSidebarButtons() { foreach (var section in SectionsContainer) { yield return new SidebarIconButton { Section = section, Action = () => { if (!SectionsContainer.IsLoaded) return; SectionsContainer.ScrollTo(section); }, }; } } private partial class NonMaskedContent : Container { // masking breaks the pan-out transform with nested sub-settings panels. protected override bool ComputeIsMaskedAway(RectangleF maskingBounds) => false; } public partial class SettingsSectionsContainer : SectionsContainer { public SearchContainer SearchContainer; public string SearchTerm { get => SearchContainer.SearchTerm; set => SearchContainer.SearchTerm = value; } protected override FlowContainer CreateScrollContentContainer() => SearchContainer = new SearchContainer { AutoSizeAxes = Axes.Y, RelativeSizeAxes = Axes.X, Direction = FillDirection.Vertical, }; [BackgroundDependencyLoader] private void load(OverlayColourProvider colourProvider) { HeaderBackground = new Box { Colour = colourProvider.Background4, RelativeSizeAxes = Axes.Both }; SearchContainer.FilterCompleted += InvalidateScrollPosition; } protected override void UpdateAfterChildren() { base.UpdateAfterChildren(); // no null check because the usage of this class is strict HeaderBackground!.Alpha = -ExpandableHeader!.Y / ExpandableHeader.LayoutSize.Y; } } } }