From a56751511e34d67b1eaf4ebebb2566f6184d94fb Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Sat, 22 Jun 2024 01:36:30 +0900 Subject: [PATCH 01/60] Apply a ducking effect to the currently playing track when switching ruleset --- osu.Game/Overlays/MusicController.cs | 57 +++++++++++++++++++ .../Toolbar/ToolbarRulesetSelector.cs | 31 +++++++++- .../Toolbar/ToolbarRulesetTabButton.cs | 12 ---- 3 files changed, 87 insertions(+), 13 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 0986c0513c..678ae92d4b 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -16,6 +16,7 @@ using osu.Framework.Graphics.Audio; using osu.Framework.Graphics.Containers; using osu.Framework.Logging; using osu.Framework.Threading; +using osu.Game.Audio.Effects; using osu.Game.Beatmaps; using osu.Game.Database; using osu.Game.Rulesets.Mods; @@ -63,6 +64,16 @@ namespace osu.Game.Overlays [Resolved] private RealmAccess realm { get; set; } + private AudioFilter audioDuckFilter; + private readonly BindableDouble audioDuckVolume = new BindableDouble(1); + + [BackgroundDependencyLoader] + private void load(AudioManager audio) + { + AddInternal(audioDuckFilter = new AudioFilter(audio.TrackMixer)); + audio.Tracks.AddAdjustment(AdjustableProperty.Volume, audioDuckVolume); + } + protected override void LoadComplete() { base.LoadComplete(); @@ -243,6 +254,52 @@ namespace osu.Game.Overlays onSuccess?.Invoke(); }); + /// + /// Attenuates the volume and/or filters the currently playing track. + /// + /// Duration of the ducking transition, in ms. + /// Level to drop volume to (1.0 = 100%). + /// Cutoff frequency to drop `AudioFilter` to. Use `AudioFilter.MAX_LOWPASS_CUTOFF` to skip filter effect. + /// Easing for the ducking transition. + public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int duckCutoffTo = 300, Easing easing = Easing.InCubic) + { + Schedule(() => + { + audioDuckFilter?.CutoffTo(duckCutoffTo, duration, easing); + this.TransformBindableTo(audioDuckVolume, duckVolumeTo, duration, easing); + }); + } + + /// + /// Restores the volume to full and stops filtering the currently playing track after having used . + /// + /// Duration of the unducking transition, in ms. + /// Easing for the unducking transition. + public void Unduck(int duration = 500, Easing easing = Easing.InCubic) + { + Schedule(() => + { + audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, duration, easing); + this.TransformBindableTo(audioDuckVolume, 1, duration, easing); + }); + } + + /// + /// A convenience method that ducks the currently playing track, then after a delay, unducks it. + /// + /// Delay after audio is ducked before unducking begins, in ms. + /// Duration of the unducking transition, in ms. + /// Easing for the unducking transition. + /// Level to drop volume to (1.0 = 100%). + /// Cutoff frequency to drop `AudioFilter` to. Use `AudioFilter.MAX_LOWPASS_CUTOFF` to skip filter effect. + /// Duration of the ducking transition, in ms. + /// Easing for the ducking transition. + public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.InCubic) + { + Duck(duckDuration, duckVolumeTo, duckCutoffTo, duckEasing); + Scheduler.AddDelayed(() => Unduck(unduckDuration, unduckEasing), delay); + } + private bool next() { if (beatmap.Disabled || !AllowTrackControl.Value) diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs index d49c340ed4..93be108b71 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs @@ -3,8 +3,12 @@ #nullable disable +using System.Collections.Generic; using System.Linq; using osu.Framework.Allocation; +using osu.Framework.Audio; +using osu.Framework.Audio.Sample; +using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Shapes; @@ -21,6 +25,12 @@ namespace osu.Game.Overlays.Toolbar { protected Drawable ModeButtonLine { get; private set; } + [Resolved] + private MusicController musicController { get; set; } + + private readonly Dictionary rulesetSelectionSample = new Dictionary(); + private readonly Dictionary rulesetSelectionChannel = new Dictionary(); + public ToolbarRulesetSelector() { RelativeSizeAxes = Axes.Y; @@ -28,7 +38,7 @@ namespace osu.Game.Overlays.Toolbar } [BackgroundDependencyLoader] - private void load() + private void load(AudioManager audio) { AddRangeInternal(new[] { @@ -54,6 +64,11 @@ namespace osu.Game.Overlays.Toolbar } }, }); + + foreach (var r in Rulesets.AvailableRulesets) + rulesetSelectionSample[r] = audio.Samples.Get($@"UI/ruleset-select-{r.ShortName}"); + + Current.ValueChanged += playRulesetSelectionSample; } protected override void LoadComplete() @@ -84,6 +99,20 @@ namespace osu.Game.Overlays.Toolbar } } + private void playRulesetSelectionSample(ValueChangedEvent r) + { + if (r.OldValue == null) + return; + + if (rulesetSelectionChannel.TryGetValue(r.OldValue, out var sampleChannel)) + sampleChannel?.Stop(); + + rulesetSelectionChannel[r.NewValue] = rulesetSelectionSample[r.NewValue].GetChannel(); + rulesetSelectionChannel[r.NewValue]?.Play(); + + musicController?.TimedDuck(600); + } + public override bool HandleNonPositionalInput => !Current.Disabled && base.HandleNonPositionalInput; public override bool HandlePositionalInput => !Current.Disabled && base.HandlePositionalInput; diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetTabButton.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetTabButton.cs index 0315bede64..3287ac6eaa 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetTabButton.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetTabButton.cs @@ -2,8 +2,6 @@ // See the LICENCE file in the repository root for full licence text. using osu.Framework.Allocation; -using osu.Framework.Audio; -using osu.Framework.Audio.Sample; using osu.Framework.Extensions.Color4Extensions; using osu.Framework.Graphics; using osu.Framework.Graphics.UserInterface; @@ -19,8 +17,6 @@ namespace osu.Game.Overlays.Toolbar { private readonly RulesetButton ruleset; - private Sample? selectSample; - public ToolbarRulesetTabButton(RulesetInfo value) : base(value) { @@ -38,18 +34,10 @@ namespace osu.Game.Overlays.Toolbar ruleset.SetIcon(rInstance.CreateIcon()); } - [BackgroundDependencyLoader] - private void load(AudioManager audio) - { - selectSample = audio.Samples.Get($@"UI/ruleset-select-{Value.ShortName}"); - } - protected override void OnActivated() => ruleset.Active = true; protected override void OnDeactivated() => ruleset.Active = false; - protected override void OnActivatedByUser() => selectSample?.Play(); - private partial class RulesetButton : ToolbarButton { protected override HoverSounds CreateHoverSounds(HoverSampleSet sampleSet) => new HoverSounds(); From 0d11b2b91c8e8a53ffcca580b30679f6614a2bb8 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Sat, 22 Jun 2024 01:57:14 +0900 Subject: [PATCH 02/60] Replace manual usages of `AudioFilter` with new ducking methods --- .../Collections/ManageCollectionsDialog.cs | 20 ++++++++----------- .../Dialog/PopupDialogDangerousButton.cs | 13 +++++------- osu.Game/Overlays/DialogOverlay.cs | 20 +++++-------------- 3 files changed, 18 insertions(+), 35 deletions(-) diff --git a/osu.Game/Collections/ManageCollectionsDialog.cs b/osu.Game/Collections/ManageCollectionsDialog.cs index ea663f45fe..e777da05e5 100644 --- a/osu.Game/Collections/ManageCollectionsDialog.cs +++ b/osu.Game/Collections/ManageCollectionsDialog.cs @@ -7,11 +7,11 @@ using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Shapes; using osu.Framework.Graphics.Sprites; -using osu.Game.Audio.Effects; using osu.Game.Graphics; using osu.Game.Graphics.Containers; using osu.Game.Graphics.Sprites; using osu.Game.Graphics.UserInterface; +using osu.Game.Overlays; using osuTK; namespace osu.Game.Collections @@ -21,11 +21,12 @@ namespace osu.Game.Collections private const double enter_duration = 500; private const double exit_duration = 200; - private AudioFilter lowPassFilter = null!; - protected override string PopInSampleName => @"UI/overlay-big-pop-in"; protected override string PopOutSampleName => @"UI/overlay-big-pop-out"; + [Resolved] + private MusicController? musicController { get; set; } + public ManageCollectionsDialog() { Anchor = Anchor.Centre; @@ -110,19 +111,14 @@ namespace osu.Game.Collections }, } } - }, - lowPassFilter = new AudioFilter(audio.TrackMixer) + } }; } - public override bool IsPresent => base.IsPresent - // Safety for low pass filter potentially getting stuck in applied state due to - // transforms on `this` causing children to no longer be updated. - || lowPassFilter.IsAttached; - protected override void PopIn() { - lowPassFilter.CutoffTo(300, 100, Easing.OutCubic); + musicController?.Duck(100, 1f); + this.FadeIn(enter_duration, Easing.OutQuint); this.ScaleTo(0.9f).Then().ScaleTo(1f, enter_duration, Easing.OutQuint); } @@ -131,7 +127,7 @@ namespace osu.Game.Collections { base.PopOut(); - lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, 100, Easing.InCubic); + musicController?.Unduck(100); this.FadeOut(exit_duration, Easing.OutQuint); this.ScaleTo(0.9f, exit_duration); diff --git a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs index 19d7ea7a87..e01d4e2d66 100644 --- a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs +++ b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs @@ -10,7 +10,6 @@ using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Framework.Graphics.Shapes; using osu.Framework.Input.Events; -using osu.Game.Audio.Effects; using osu.Game.Graphics; using osu.Game.Graphics.Containers; @@ -48,6 +47,9 @@ namespace osu.Game.Overlays.Dialog private partial class DangerousConfirmContainer : HoldToConfirmContainer { + [Resolved] + private MusicController musicController { get; set; } + public DangerousConfirmContainer() : base(isDangerousAction: true) { @@ -56,7 +58,6 @@ namespace osu.Game.Overlays.Dialog private Sample tickSample; private Sample confirmSample; private double lastTickPlaybackTime; - private AudioFilter lowPassFilter = null!; private bool mouseDown; [BackgroundDependencyLoader] @@ -64,8 +65,6 @@ namespace osu.Game.Overlays.Dialog { tickSample = audio.Samples.Get(@"UI/dialog-dangerous-tick"); confirmSample = audio.Samples.Get(@"UI/dialog-dangerous-select"); - - AddInternal(lowPassFilter = new AudioFilter(audio.SampleMixer)); } protected override void LoadComplete() @@ -76,13 +75,13 @@ namespace osu.Game.Overlays.Dialog protected override void AbortConfirm() { - lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF); + musicController?.Unduck(); base.AbortConfirm(); } protected override void Confirm() { - lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF); + musicController?.Duck(); confirmSample?.Play(); base.Confirm(); } @@ -126,8 +125,6 @@ namespace osu.Game.Overlays.Dialog if (Clock.CurrentTime - lastTickPlaybackTime < 30) return; - lowPassFilter.CutoffTo((int)(progress.NewValue * AudioFilter.MAX_LOWPASS_CUTOFF * 0.5)); - var channel = tickSample.GetChannel(); channel.Frequency.Value = 1 + progress.NewValue * 0.5f; diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs index 9ad532ae50..aa9bb99e01 100644 --- a/osu.Game/Overlays/DialogOverlay.cs +++ b/osu.Game/Overlays/DialogOverlay.cs @@ -10,9 +10,7 @@ using osu.Game.Graphics.Containers; using osu.Game.Input.Bindings; using System.Linq; using osu.Framework.Allocation; -using osu.Framework.Audio; using osu.Framework.Input.Events; -using osu.Game.Audio.Effects; namespace osu.Game.Overlays { @@ -23,15 +21,13 @@ namespace osu.Game.Overlays protected override string PopInSampleName => "UI/dialog-pop-in"; protected override string PopOutSampleName => "UI/dialog-pop-out"; - private AudioFilter lowPassFilter; + [Resolved] + private MusicController musicController { get; set; } public PopupDialog CurrentDialog { get; private set; } public override bool IsPresent => Scheduler.HasPendingTasks - || dialogContainer.Children.Count > 0 - // Safety for low pass filter potentially getting stuck in applied state due to - // transforms on `this` causing children to no longer be updated. - || lowPassFilter.IsAttached; + || dialogContainer.Children.Count > 0; public DialogOverlay() { @@ -49,12 +45,6 @@ namespace osu.Game.Overlays Origin = Anchor.Centre; } - [BackgroundDependencyLoader] - private void load(AudioManager audio) - { - AddInternal(lowPassFilter = new AudioFilter(audio.TrackMixer)); - } - public void Push(PopupDialog dialog) { if (dialog == CurrentDialog || dialog.State.Value == Visibility.Hidden) return; @@ -105,13 +95,13 @@ namespace osu.Game.Overlays protected override void PopIn() { - lowPassFilter.CutoffTo(300, 100, Easing.OutCubic); + musicController.Duck(100, 1f); } protected override void PopOut() { base.PopOut(); - lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, 100, Easing.InCubic); + musicController.Unduck(100); // PopOut gets called initially, but we only want to hide dialog when we have been loaded and are present. if (IsLoaded && CurrentDialog?.State.Value == Visibility.Visible) From 2ffeb1b3618a7c3dffc08cef5862ea7cb575d20a Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Sun, 23 Jun 2024 02:20:51 +0900 Subject: [PATCH 03/60] Add fallback behaviour for custom rulesets --- .../Toolbar/ToolbarRulesetSelector.cs | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs index 93be108b71..7da6b76aaa 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs @@ -30,6 +30,7 @@ namespace osu.Game.Overlays.Toolbar private readonly Dictionary rulesetSelectionSample = new Dictionary(); private readonly Dictionary rulesetSelectionChannel = new Dictionary(); + private Sample defaultSelectSample; public ToolbarRulesetSelector() { @@ -68,6 +69,8 @@ namespace osu.Game.Overlays.Toolbar foreach (var r in Rulesets.AvailableRulesets) rulesetSelectionSample[r] = audio.Samples.Get($@"UI/ruleset-select-{r.ShortName}"); + defaultSelectSample = audio.Samples.Get(@"UI/default-select"); + Current.ValueChanged += playRulesetSelectionSample; } @@ -101,15 +104,24 @@ namespace osu.Game.Overlays.Toolbar private void playRulesetSelectionSample(ValueChangedEvent r) { + // Don't play sample on first setting of value if (r.OldValue == null) return; - if (rulesetSelectionChannel.TryGetValue(r.OldValue, out var sampleChannel)) - sampleChannel?.Stop(); + var channel = rulesetSelectionSample[r.NewValue]?.GetChannel(); - rulesetSelectionChannel[r.NewValue] = rulesetSelectionSample[r.NewValue].GetChannel(); - rulesetSelectionChannel[r.NewValue]?.Play(); + // Skip sample choking and ducking for the default/fallback sample + if (channel == null) + { + defaultSelectSample.Play(); + return; + } + foreach (var pair in rulesetSelectionChannel) + pair.Value?.Stop(); + + rulesetSelectionChannel[r.NewValue] = channel; + channel.Play(); musicController?.TimedDuck(600); } From 04efa61156517d2fe21ea4f4995a39670eca7ebb Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Sun, 23 Jun 2024 08:22:13 +0300 Subject: [PATCH 04/60] Add different display for mod customisation --- .../TestSceneModCustomisationPanel.cs | 47 +++++ .../Localisation/ModSelectOverlayStrings.cs | 5 + .../Overlays/Mods/ModCustomisationHeader.cs | 86 ++++++++++ .../Overlays/Mods/ModCustomisationPanel.cs | 161 ++++++++++++++++++ .../Overlays/Mods/ModCustomisationSection.cs | 82 +++++++++ 5 files changed, 381 insertions(+) create mode 100644 osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs create mode 100644 osu.Game/Overlays/Mods/ModCustomisationHeader.cs create mode 100644 osu.Game/Overlays/Mods/ModCustomisationPanel.cs create mode 100644 osu.Game/Overlays/Mods/ModCustomisationSection.cs diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs new file mode 100644 index 0000000000..0066ecd556 --- /dev/null +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs @@ -0,0 +1,47 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System; +using NUnit.Framework; +using osu.Framework.Allocation; +using osu.Framework.Graphics; +using osu.Framework.Graphics.Containers; +using osu.Game.Overlays; +using osu.Game.Overlays.Mods; +using osu.Game.Rulesets.Mods; +using osu.Game.Rulesets.Osu.Mods; + +namespace osu.Game.Tests.Visual.UserInterface +{ + public partial class TestSceneModCustomisationPanel : OsuManualInputManagerTestScene + { + [Cached] + private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Aquamarine); + + [SetUp] + public void SetUp() => Schedule(() => + { + Child = new Container + { + RelativeSizeAxes = Axes.Both, + Padding = new MarginPadding(20f), + Child = new ModCustomisationPanel + { + Anchor = Anchor.TopCentre, + Origin = Anchor.TopCentre, + Width = 400f, + SelectedMods = { BindTarget = SelectedMods }, + } + }; + }); + + [Test] + public void TestDisplay() + { + AddStep("set DT", () => SelectedMods.Value = new[] { new OsuModDoubleTime() }); + AddStep("set DA", () => SelectedMods.Value = new Mod[] { new OsuModDifficultyAdjust() }); + AddStep("set FL+WU+DA+AD", () => SelectedMods.Value = new Mod[] { new OsuModFlashlight(), new ModWindUp(), new OsuModDifficultyAdjust(), new OsuModApproachDifferent() }); + AddStep("set empty", () => SelectedMods.Value = Array.Empty()); + } + } +} diff --git a/osu.Game/Localisation/ModSelectOverlayStrings.cs b/osu.Game/Localisation/ModSelectOverlayStrings.cs index cf01081772..a2e1df42c6 100644 --- a/osu.Game/Localisation/ModSelectOverlayStrings.cs +++ b/osu.Game/Localisation/ModSelectOverlayStrings.cs @@ -75,6 +75,11 @@ namespace osu.Game.Localisation /// public static LocalisableString UnrankedExplanation => new TranslatableString(getKey(@"unranked_explanation"), @"Performance points will not be granted due to active mods."); + /// + /// "Customise" + /// + public static LocalisableString CustomisationPanelHeader => new TranslatableString(getKey(@"customisation_panel_header"), @"Customise"); + private static string getKey(string key) => $@"{prefix}:{key}"; } } diff --git a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs new file mode 100644 index 0000000000..e6534921f6 --- /dev/null +++ b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs @@ -0,0 +1,86 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System.Collections.Generic; +using osu.Framework.Allocation; +using osu.Framework.Bindables; +using osu.Framework.Graphics; +using osu.Framework.Graphics.Containers; +using osu.Framework.Graphics.Shapes; +using osu.Framework.Graphics.Sprites; +using osu.Game.Graphics; +using osu.Game.Graphics.Containers; +using osu.Game.Graphics.Sprites; +using osuTK; +using osu.Game.Localisation; + +namespace osu.Game.Overlays.Mods +{ + public partial class ModCustomisationHeader : OsuHoverContainer + { + public override bool HandlePositionalInput => true; + + private Box background = null!; + private SpriteIcon icon = null!; + + [Resolved] + private OverlayColourProvider colourProvider { get; set; } = null!; + + protected override IEnumerable EffectTargets => new[] { background }; + + public readonly BindableBool Expanded = new BindableBool(); + + [BackgroundDependencyLoader] + private void load() + { + CornerRadius = 10f; + Masking = true; + + Children = new Drawable[] + { + background = new Box + { + RelativeSizeAxes = Axes.Both, + }, + new OsuSpriteText + { + Anchor = Anchor.CentreLeft, + Origin = Anchor.CentreLeft, + Text = ModSelectOverlayStrings.CustomisationPanelHeader, + UseFullGlyphHeight = false, + Font = OsuFont.Torus.With(size: 20f, weight: FontWeight.SemiBold), + Margin = new MarginPadding { Left = 20f }, + }, + new Container + { + Anchor = Anchor.CentreRight, + Origin = Anchor.CentreRight, + Size = new Vector2(16f), + Margin = new MarginPadding { Right = 20f }, + Child = icon = new SpriteIcon + { + Anchor = Anchor.Centre, + Origin = Anchor.Centre, + Icon = FontAwesome.Solid.ChevronDown, + RelativeSizeAxes = Axes.Both, + } + } + }; + + IdleColour = colourProvider.Dark3; + HoverColour = colourProvider.Light4; + } + + protected override void LoadComplete() + { + base.LoadComplete(); + + Expanded.BindValueChanged(v => + { + icon.RotateTo(v.NewValue ? 180 : 0); + }, true); + + Action = Expanded.Toggle; + } + } +} diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs new file mode 100644 index 0000000000..3694fe2bde --- /dev/null +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -0,0 +1,161 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System; +using System.Collections.Generic; +using System.Linq; +using osu.Framework.Allocation; +using osu.Framework.Bindables; +using osu.Framework.Graphics; +using osu.Framework.Graphics.Containers; +using osu.Framework.Graphics.Effects; +using osu.Framework.Graphics.Shapes; +using osu.Framework.Input.Events; +using osu.Game.Configuration; +using osu.Game.Graphics; +using osu.Game.Graphics.Containers; +using osu.Game.Rulesets.Mods; +using osuTK; + +namespace osu.Game.Overlays.Mods +{ + public partial class ModCustomisationPanel : VisibilityContainer + { + private const float header_height = 42f; + private const float content_vertical_padding = 20f; + + private Container content = null!; + private OsuScrollContainer scrollContainer = null!; + private FillFlowContainer sectionsFlow = null!; + + [Resolved] + private OverlayColourProvider colourProvider { get; set; } = null!; + + public readonly BindableBool Expanded = new BindableBool(); + + public Bindable> SelectedMods { get; } = new Bindable>(Array.Empty()); + + [BackgroundDependencyLoader] + private void load() + { + RelativeSizeAxes = Axes.Y; + + InternalChildren = new Drawable[] + { + new ModCustomisationHeader + { + Depth = float.MinValue, + RelativeSizeAxes = Axes.X, + Height = header_height, + Expanded = { BindTarget = Expanded }, + }, + content = new InputBlockingContainer + { + RelativeSizeAxes = Axes.X, + BorderColour = colourProvider.Dark3, + BorderThickness = 2f, + CornerRadius = 10f, + Masking = true, + EdgeEffect = new EdgeEffectParameters + { + Type = EdgeEffectType.Shadow, + Offset = new Vector2(0f, 5f), + Radius = 20f, + Roundness = 5f, + }, + Children = new Drawable[] + { + new Box + { + RelativeSizeAxes = Axes.Both, + Colour = colourProvider.Dark4, + }, + scrollContainer = new OsuScrollContainer(Direction.Vertical) + { + RelativeSizeAxes = Axes.X, + ScrollbarOverlapsContent = false, + Margin = new MarginPadding { Top = header_height }, + Child = sectionsFlow = new FillFlowContainer + { + RelativeSizeAxes = Axes.X, + AutoSizeAxes = Axes.Y, + Spacing = new Vector2(0f, 40f), + Margin = new MarginPadding + { + Top = content_vertical_padding, + Bottom = 5f + content_vertical_padding + }, + } + } + } + } + }; + } + + protected override void LoadComplete() + { + base.LoadComplete(); + + Expanded.BindValueChanged(_ => updateDisplay(), true); + SelectedMods.BindValueChanged(_ => updateMods(), true); + + FinishTransforms(true); + } + + protected override void PopIn() => this.FadeIn(300, Easing.OutQuint); + + protected override void PopOut() => this.FadeOut(300, Easing.OutQuint); + + public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; + + protected override bool OnMouseDown(MouseDownEvent e) + { + if (Expanded.Value && !content.ReceivePositionalInputAt(e.ScreenSpaceMousePosition)) + Expanded.Value = false; + + return base.OnMouseDown(e); + } + + private void updateDisplay() + { + content.ClearTransforms(); + + if (Expanded.Value) + { + content.AutoSizeDuration = 400; + content.AutoSizeEasing = Easing.OutQuint; + content.AutoSizeAxes = Axes.Y; + content.FadeEdgeEffectTo(0.25f, 120, Easing.OutQuint); + } + else + { + content.AutoSizeAxes = Axes.None; + content.ResizeHeightTo(header_height, 400, Easing.OutQuint); + content.FadeEdgeEffectTo(0f, 400, Easing.OutQuint); + } + } + + private void updateMods() + { + Expanded.Value = false; + sectionsFlow.Clear(); + + // Importantly, the selected mods bindable is already ordered by the mod select overlay (following the order of mod columns and panels). + // Using AsOrdered produces a slightly different order (e.g. DT and NC no longer becoming adjacent), + // which breaks user expectations when interacting with the overlay. + foreach (var mod in SelectedMods.Value) + { + var settings = mod.CreateSettingsControls().ToList(); + + if (settings.Count > 0) + sectionsFlow.Add(new ModCustomisationSection(mod, settings)); + } + } + + protected override void Update() + { + base.Update(); + scrollContainer.Height = Math.Min(scrollContainer.AvailableContent, DrawHeight - header_height); + } + } +} diff --git a/osu.Game/Overlays/Mods/ModCustomisationSection.cs b/osu.Game/Overlays/Mods/ModCustomisationSection.cs new file mode 100644 index 0000000000..1dc97a8b0b --- /dev/null +++ b/osu.Game/Overlays/Mods/ModCustomisationSection.cs @@ -0,0 +1,82 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System.Collections.Generic; +using osu.Framework.Allocation; +using osu.Framework.Graphics; +using osu.Framework.Graphics.Containers; +using osu.Game.Graphics; +using osu.Game.Graphics.Sprites; +using osu.Game.Rulesets.Mods; +using osu.Game.Rulesets.UI; +using osuTK; + +namespace osu.Game.Overlays.Mods +{ + public partial class ModCustomisationSection : CompositeDrawable + { + public readonly Mod Mod; + + private readonly IReadOnlyList settings; + + public ModCustomisationSection(Mod mod, IReadOnlyList settings) + { + Mod = mod; + + this.settings = settings; + } + + [BackgroundDependencyLoader] + private void load() + { + RelativeSizeAxes = Axes.X; + AutoSizeAxes = Axes.Y; + + FillFlowContainer flow; + + InternalChild = flow = new FillFlowContainer + { + RelativeSizeAxes = Axes.X, + AutoSizeAxes = Axes.Y, + Direction = FillDirection.Vertical, + Spacing = new Vector2(0f, 8f), + Padding = new MarginPadding { Left = 7f }, + Children = new Drawable[] + { + new Container + { + RelativeSizeAxes = Axes.X, + AutoSizeAxes = Axes.Y, + Padding = new MarginPadding { Left = 20f, Right = 27f }, + Margin = new MarginPadding { Bottom = 4f }, + Children = new Drawable[] + { + new OsuSpriteText + { + Anchor = Anchor.CentreLeft, + Origin = Anchor.CentreLeft, + Text = Mod.Name, + Font = OsuFont.TorusAlternate.With(size: 20, weight: FontWeight.SemiBold), + }, + new ModSwitchTiny(Mod) + { + Anchor = Anchor.CentreRight, + Origin = Anchor.CentreRight, + Active = { Value = true }, + Scale = new Vector2(0.5f), + } + } + }, + } + }; + + flow.AddRange(settings); + } + + protected override void LoadComplete() + { + base.LoadComplete(); + FinishTransforms(true); + } + } +} From e23da93c0947b4692943bdf64ce897fbaac4db93 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Sun, 23 Jun 2024 08:22:50 +0300 Subject: [PATCH 05/60] Use new display on mod select overlay and remove old display --- osu.Game/Overlays/Mods/ModSelectOverlay.cs | 137 ++++----------- osu.Game/Overlays/Mods/ModSettingsArea.cs | 189 --------------------- 2 files changed, 35 insertions(+), 291 deletions(-) delete mode 100644 osu.Game/Overlays/Mods/ModSettingsArea.cs diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index 145f58fb55..5ee52f32f5 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -109,15 +109,6 @@ namespace osu.Game.Overlays.Mods protected virtual IEnumerable CreateFooterButtons() { - if (AllowCustomisation) - { - yield return CustomisationButton = new ShearedToggleButton(BUTTON_WIDTH) - { - Text = ModSelectOverlayStrings.ModCustomisation, - Active = { BindTarget = customisationVisible } - }; - } - yield return deselectAllModsButton = new DeselectAllModsButton(this); } @@ -125,10 +116,8 @@ namespace osu.Game.Overlays.Mods public IEnumerable AllAvailableMods => AvailableMods.Value.SelectMany(pair => pair.Value); - private readonly BindableBool customisationVisible = new BindableBool(); private Bindable textSearchStartsActive = null!; - private ModSettingsArea modSettingsArea = null!; private ColumnScrollContainer columnScroll = null!; private ColumnFlowContainer columnFlow = null!; private FillFlowContainer footerButtonFlow = null!; @@ -138,9 +127,9 @@ namespace osu.Game.Overlays.Mods private Container aboveColumnsContent = null!; private RankingInformationDisplay? rankingInformationDisplay; private BeatmapAttributesDisplay? beatmapAttributesDisplay; + private ModCustomisationPanel customisationPanel = null!; protected ShearedButton BackButton { get; private set; } = null!; - protected ShearedToggleButton? CustomisationButton { get; private set; } protected SelectAllModsButton? SelectAllModsButton { get; set; } private Sample? columnAppearSample; @@ -173,35 +162,8 @@ namespace osu.Game.Overlays.Mods columnAppearSample = audio.Samples.Get(@"SongSelect/mod-column-pop-in"); - AddRange(new Drawable[] - { - new ClickToReturnContainer - { - RelativeSizeAxes = Axes.Both, - HandleMouse = { BindTarget = customisationVisible }, - OnClicked = () => customisationVisible.Value = false - }, - modSettingsArea = new ModSettingsArea - { - Anchor = Anchor.BottomCentre, - Origin = Anchor.BottomCentre, - Height = 0 - }, - }); - MainAreaContent.AddRange(new Drawable[] { - aboveColumnsContent = new Container - { - RelativeSizeAxes = Axes.X, - Height = RankingInformationDisplay.HEIGHT, - Padding = new MarginPadding { Horizontal = 100 }, - Child = SearchTextBox = new ShearedSearchTextBox - { - HoldFocus = false, - Width = 300 - } - }, new OsuContextMenuContainer { RelativeSizeAxes = Axes.Both, @@ -237,7 +199,27 @@ namespace osu.Game.Overlays.Mods } } } - } + }, + aboveColumnsContent = new Container + { + RelativeSizeAxes = Axes.Both, + Padding = new MarginPadding { Horizontal = 100, Bottom = 15f }, + Children = new Drawable[] + { + SearchTextBox = new ShearedSearchTextBox + { + HoldFocus = false, + Width = 300, + }, + customisationPanel = new ModCustomisationPanel + { + Alpha = 0f, + Anchor = Anchor.TopRight, + Origin = Anchor.TopRight, + Width = 400, + } + } + }, }); FooterContent.Add(footerButtonFlow = new FillFlowContainer @@ -320,7 +302,7 @@ namespace osu.Game.Overlays.Mods // This is an optimisation to prevent refreshing the available settings controls when it can be // reasonably assumed that the settings panel is never to be displayed (e.g. FreeModSelectOverlay). if (AllowCustomisation) - ((IBindable>)modSettingsArea.SelectedMods).BindTo(SelectedMods); + ((IBindable>)customisationPanel.SelectedMods).BindTo(SelectedMods); SelectedMods.BindValueChanged(_ => { @@ -347,7 +329,7 @@ namespace osu.Game.Overlays.Mods } }, true); - customisationVisible.BindValueChanged(_ => updateCustomisationVisualState(), true); + customisationPanel.Expanded.BindValueChanged(_ => updateCustomisationVisualState(), true); SearchTextBox.Current.BindValueChanged(query => { @@ -491,7 +473,7 @@ namespace osu.Game.Overlays.Mods private void updateCustomisation() { - if (CustomisationButton == null) + if (!AllowCustomisation) return; bool anyCustomisableModActive = false; @@ -506,38 +488,21 @@ namespace osu.Game.Overlays.Mods if (anyCustomisableModActive) { - customisationVisible.Disabled = false; + customisationPanel.Show(); - if (anyModPendingConfiguration && !customisationVisible.Value) - customisationVisible.Value = true; + if (anyModPendingConfiguration) + customisationPanel.Expanded.Value = true; } else { - if (customisationVisible.Value) - customisationVisible.Value = false; - - customisationVisible.Disabled = true; + customisationPanel.Expanded.Value = false; + customisationPanel.Hide(); } } private void updateCustomisationVisualState() { - const double transition_duration = 300; - - MainAreaContent.FadeColour(customisationVisible.Value ? Colour4.Gray : Colour4.White, transition_duration, Easing.InOutCubic); - - foreach (var button in footerButtonFlow) - { - if (button != CustomisationButton) - button.Enabled.Value = !customisationVisible.Value; - } - - float modAreaHeight = customisationVisible.Value ? ModSettingsArea.HEIGHT : 0; - - modSettingsArea.ResizeHeightTo(modAreaHeight, transition_duration, Easing.InOutCubic); - TopLevelContent.MoveToY(-modAreaHeight, transition_duration, Easing.InOutCubic); - - if (customisationVisible.Value) + if (customisationPanel.Expanded.Value) SearchTextBox.KillFocus(); else setTextBoxFocus(textSearchStartsActive.Value); @@ -693,6 +658,8 @@ namespace osu.Game.Overlays.Mods if (!allFiltered) nonFilteredColumnCount += 1; } + + customisationPanel.Expanded.Value = false; } #endregion @@ -758,10 +725,9 @@ namespace osu.Game.Overlays.Mods void hideOverlay(bool immediate) { - if (customisationVisible.Value) + if (customisationPanel.Expanded.Value) { - Debug.Assert(CustomisationButton != null); - CustomisationButton.TriggerClick(); + customisationPanel.Expanded.Value = false; if (!immediate) return; @@ -967,38 +933,5 @@ namespace osu.Game.Overlays.Mods updateState(); } } - - /// - /// A container which blocks and handles input, managing the "return from customisation" state change. - /// - private partial class ClickToReturnContainer : Container - { - public BindableBool HandleMouse { get; } = new BindableBool(); - - public Action? OnClicked { get; set; } - - public override bool HandlePositionalInput => base.HandlePositionalInput && HandleMouse.Value; - - protected override bool Handle(UIEvent e) - { - if (!HandleMouse.Value) - return base.Handle(e); - - switch (e) - { - case ClickEvent: - OnClicked?.Invoke(); - return true; - - case HoverEvent: - return false; - - case MouseEvent: - return true; - } - - return base.Handle(e); - } - } } } diff --git a/osu.Game/Overlays/Mods/ModSettingsArea.cs b/osu.Game/Overlays/Mods/ModSettingsArea.cs deleted file mode 100644 index d0e0f7e648..0000000000 --- a/osu.Game/Overlays/Mods/ModSettingsArea.cs +++ /dev/null @@ -1,189 +0,0 @@ -// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. -// See the LICENCE file in the repository root for full licence text. - -using System; -using System.Collections.Generic; -using System.Linq; -using osu.Framework.Allocation; -using osu.Framework.Bindables; -using osu.Framework.Graphics; -using osu.Framework.Graphics.Containers; -using osu.Framework.Graphics.Shapes; -using osu.Framework.Input.Events; -using osu.Game.Configuration; -using osu.Game.Graphics; -using osu.Game.Graphics.Containers; -using osu.Game.Graphics.Sprites; -using osu.Game.Rulesets.Mods; -using osu.Game.Rulesets.UI; -using osuTK; - -namespace osu.Game.Overlays.Mods -{ - public partial class ModSettingsArea : CompositeDrawable - { - public Bindable> SelectedMods { get; } = new Bindable>(Array.Empty()); - - public const float HEIGHT = 250; - - private readonly Box background; - private readonly FillFlowContainer modSettingsFlow; - - [Resolved] - private OverlayColourProvider colourProvider { get; set; } = null!; - - public override bool AcceptsFocus => true; - - public ModSettingsArea() - { - RelativeSizeAxes = Axes.X; - Height = HEIGHT; - - Anchor = Anchor.BottomRight; - Origin = Anchor.BottomRight; - - InternalChild = new Container - { - RelativeSizeAxes = Axes.Both, - Masking = true, - Children = new Drawable[] - { - background = new Box - { - RelativeSizeAxes = Axes.Both - }, - new OsuScrollContainer(Direction.Horizontal) - { - RelativeSizeAxes = Axes.Both, - ScrollbarOverlapsContent = false, - ClampExtension = 100, - Child = modSettingsFlow = new FillFlowContainer - { - AutoSizeAxes = Axes.X, - RelativeSizeAxes = Axes.Y, - Padding = new MarginPadding { Vertical = 7, Horizontal = 70 }, - Spacing = new Vector2(7), - Direction = FillDirection.Horizontal - } - } - } - }; - } - - [BackgroundDependencyLoader] - private void load() - { - background.Colour = colourProvider.Dark3; - } - - protected override void LoadComplete() - { - base.LoadComplete(); - SelectedMods.BindValueChanged(_ => updateMods(), true); - } - - private void updateMods() - { - modSettingsFlow.Clear(); - - // Importantly, the selected mods bindable is already ordered by the mod select overlay (following the order of mod columns and panels). - // Using AsOrdered produces a slightly different order (e.g. DT and NC no longer becoming adjacent), - // which breaks user expectations when interacting with the overlay. - foreach (var mod in SelectedMods.Value) - { - var settings = mod.CreateSettingsControls().ToList(); - - if (settings.Count > 0) - { - if (modSettingsFlow.Any()) - { - modSettingsFlow.Add(new Box - { - RelativeSizeAxes = Axes.Y, - Width = 2, - Colour = colourProvider.Dark4, - }); - } - - modSettingsFlow.Add(new ModSettingsColumn(mod, settings)); - } - } - } - - protected override bool OnMouseDown(MouseDownEvent e) => true; - protected override bool OnHover(HoverEvent e) => true; - - public partial class ModSettingsColumn : CompositeDrawable - { - public readonly Mod Mod; - - public ModSettingsColumn(Mod mod, IEnumerable settingsControls) - { - Mod = mod; - - Width = 250; - RelativeSizeAxes = Axes.Y; - Padding = new MarginPadding { Bottom = 7 }; - - InternalChild = new GridContainer - { - RelativeSizeAxes = Axes.Both, - RowDimensions = new[] - { - new Dimension(GridSizeMode.AutoSize), - new Dimension(GridSizeMode.Absolute, 10), - new Dimension() - }, - Content = new[] - { - new Drawable[] - { - new FillFlowContainer - { - RelativeSizeAxes = Axes.X, - AutoSizeAxes = Axes.Y, - Direction = FillDirection.Horizontal, - Spacing = new Vector2(7), - Children = new Drawable[] - { - new ModSwitchTiny(mod) - { - Active = { Value = true }, - Scale = new Vector2(0.6f), - Origin = Anchor.CentreLeft, - Anchor = Anchor.CentreLeft - }, - new OsuSpriteText - { - Text = mod.Name, - Font = OsuFont.Default.With(size: 16, weight: FontWeight.SemiBold), - Origin = Anchor.CentreLeft, - Anchor = Anchor.CentreLeft, - Margin = new MarginPadding { Bottom = 2 } - } - } - } - }, - new[] { Empty() }, - new Drawable[] - { - new OsuScrollContainer(Direction.Vertical) - { - RelativeSizeAxes = Axes.Both, - ClampExtension = 100, - Child = new FillFlowContainer - { - RelativeSizeAxes = Axes.X, - AutoSizeAxes = Axes.Y, - Padding = new MarginPadding { Right = 7 }, - ChildrenEnumerable = settingsControls, - Spacing = new Vector2(0, 7) - } - } - } - } - }; - } - } - } -} From 1298b98534246c5dc325a2cb9aae3333f1f38eeb Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Sun, 23 Jun 2024 08:22:54 +0300 Subject: [PATCH 06/60] Update test coverage --- .../TestSceneFreeModSelectOverlay.cs | 2 +- .../TestSceneModSelectOverlay.cs | 63 +++++++++++-------- .../UserInterface/TestSceneModSettingsArea.cs | 42 ------------- 3 files changed, 38 insertions(+), 69 deletions(-) delete mode 100644 osu.Game.Tests/Visual/UserInterface/TestSceneModSettingsArea.cs diff --git a/osu.Game.Tests/Visual/Multiplayer/TestSceneFreeModSelectOverlay.cs b/osu.Game.Tests/Visual/Multiplayer/TestSceneFreeModSelectOverlay.cs index a4feffddfb..938ab1e9f4 100644 --- a/osu.Game.Tests/Visual/Multiplayer/TestSceneFreeModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/Multiplayer/TestSceneFreeModSelectOverlay.cs @@ -58,7 +58,7 @@ namespace osu.Game.Tests.Visual.Multiplayer AddStep("select difficulty adjust", () => freeModSelectOverlay.SelectedMods.Value = new[] { new OsuModDifficultyAdjust() }); AddWaitStep("wait some", 3); - AddAssert("customisation area not expanded", () => this.ChildrenOfType().Single().Height == 0); + AddAssert("customisation area not expanded", () => !this.ChildrenOfType().Single().Expanded.Value); } [Test] diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs index a1452ddb31..39017298ac 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs @@ -7,7 +7,6 @@ using System.Linq; using NUnit.Framework; using osu.Framework.Allocation; using osu.Framework.Bindables; -using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Input; @@ -26,7 +25,6 @@ using osu.Game.Rulesets.Osu; using osu.Game.Rulesets.Osu.Mods; using osu.Game.Rulesets.Taiko.Mods; using osu.Game.Tests.Mods; -using osuTK; using osuTK.Input; namespace osu.Game.Tests.Visual.UserInterface @@ -225,7 +223,7 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("dismiss mod customisation via toggle", () => { - InputManager.MoveMouseTo(modSelectOverlay.CustomisationButton.AsNonNull()); + InputManager.MoveMouseTo(modSelectOverlay.ChildrenOfType().Single()); InputManager.Click(MouseButton.Left); }); assertCustomisationToggleState(disabled: false, active: false); @@ -258,7 +256,7 @@ namespace osu.Game.Tests.Visual.UserInterface } [Test] - public void TestDismissCustomisationViaDimmedArea() + public void TestDismissCustomisationViaClickingAway() { createScreen(); assertCustomisationToggleState(disabled: true, active: false); @@ -266,18 +264,23 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("select difficulty adjust via panel", () => getPanelForMod(typeof(OsuModDifficultyAdjust)).TriggerClick()); assertCustomisationToggleState(disabled: false, active: true); - AddStep("move mouse to settings area", () => InputManager.MoveMouseTo(this.ChildrenOfType().Single())); - AddStep("move mouse to dimmed area", () => - { - InputManager.MoveMouseTo(new Vector2( - modSelectOverlay.ScreenSpaceDrawQuad.TopLeft.X, - (modSelectOverlay.ScreenSpaceDrawQuad.TopLeft.Y + modSelectOverlay.ScreenSpaceDrawQuad.BottomLeft.Y) / 2)); - }); + AddStep("move mouse to search bar", () => InputManager.MoveMouseTo(modSelectOverlay.ChildrenOfType().Single())); AddStep("click", () => InputManager.Click(MouseButton.Left)); assertCustomisationToggleState(disabled: false, active: false); + } - AddStep("move mouse to first mod panel", () => InputManager.MoveMouseTo(modSelectOverlay.ChildrenOfType().First())); - AddAssert("first mod panel is hovered", () => modSelectOverlay.ChildrenOfType().First().IsHovered); + [Test] + public void TestDismissCustomisationWhenHidingOverlay() + { + createScreen(); + assertCustomisationToggleState(disabled: true, active: false); + + AddStep("select difficulty adjust via panel", () => getPanelForMod(typeof(OsuModDifficultyAdjust)).TriggerClick()); + assertCustomisationToggleState(disabled: false, active: true); + + AddStep("hide overlay", () => modSelectOverlay.Hide()); + AddStep("show overlay again", () => modSelectOverlay.Show()); + assertCustomisationToggleState(disabled: false, active: false); } /// @@ -339,7 +342,7 @@ namespace osu.Game.Tests.Visual.UserInterface createScreen(); changeRuleset(0); - AddStep("Select all fun mods", () => + AddStep("Select all difficulty-increase mods", () => { modSelectOverlay.ChildrenOfType() .Single(c => c.ModType == ModType.DifficultyIncrease) @@ -641,13 +644,16 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("select DT", () => SelectedMods.Value = new Mod[] { new OsuModDoubleTime() }); AddAssert("DT selected", () => modSelectOverlay.ChildrenOfType().Count(panel => panel.Active.Value), () => Is.EqualTo(1)); - AddStep("open customisation area", () => modSelectOverlay.CustomisationButton!.TriggerClick()); - assertCustomisationToggleState(false, true); + // todo: rewrite + AddStep("open customisation area", () => modSelectOverlay.ChildrenOfType().Single().TriggerClick()); + assertCustomisationToggleState(disabled: false, active: true); + AddStep("hover over mod settings slider", () => { - var slider = modSelectOverlay.ChildrenOfType().Single().ChildrenOfType>().First(); + var slider = modSelectOverlay.ChildrenOfType().Single().ChildrenOfType>().First(); InputManager.MoveMouseTo(slider); }); + AddStep("press right arrow", () => InputManager.PressKey(Key.Right)); AddAssert("DT speed changed", () => !SelectedMods.Value.OfType().Single().SpeedChange.IsDefault); @@ -744,9 +750,10 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("select difficulty adjust via panel", () => getPanelForMod(typeof(OsuModDifficultyAdjust)).TriggerClick()); assertCustomisationToggleState(disabled: false, active: true); - AddAssert("back button disabled", () => !modSelectOverlay.BackButton.Enabled.Value); AddStep("dismiss customisation area", () => InputManager.Key(Key.Escape)); + AddAssert("mod select still visible", () => modSelectOverlay.State.Value == Visibility.Visible); + AddStep("click back button", () => { InputManager.MoveMouseTo(modSelectOverlay.BackButton); @@ -870,8 +877,8 @@ namespace osu.Game.Tests.Visual.UserInterface // it is instrumental in the reproduction of the failure scenario that this test is supposed to cover. AddStep("force collection", GC.Collect); - AddStep("open customisation area", () => modSelectOverlay.CustomisationButton!.TriggerClick()); - AddStep("reset half time speed to default", () => modSelectOverlay.ChildrenOfType().Single() + AddStep("open customisation area", () => modSelectOverlay.ChildrenOfType().Single().TriggerClick()); + AddStep("reset half time speed to default", () => modSelectOverlay.ChildrenOfType().Single() .ChildrenOfType>().Single().TriggerClick()); AddUntilStep("difficulty multiplier display shows correct value", () => modSelectOverlay.ChildrenOfType().Single().ModMultiplier.Value, () => Is.EqualTo(0.3).Within(Precision.DOUBLE_EPSILON)); @@ -883,18 +890,23 @@ namespace osu.Game.Tests.Visual.UserInterface createScreen(); AddStep("select DT + HD + DF", () => SelectedMods.Value = new Mod[] { new OsuModDoubleTime(), new OsuModHidden(), new OsuModDeflate() }); + AddStep("open customisation panel", () => this.ChildrenOfType().Single().TriggerClick()); AddAssert("mod settings order: DT, HD, DF", () => { - var columns = this.ChildrenOfType().Single().ChildrenOfType(); + var columns = this.ChildrenOfType(); return columns.ElementAt(0).Mod is OsuModDoubleTime && columns.ElementAt(1).Mod is OsuModHidden && columns.ElementAt(2).Mod is OsuModDeflate; }); - AddStep("replace DT with NC", () => SelectedMods.Value = SelectedMods.Value.Where(m => m is not ModDoubleTime).Append(new OsuModNightcore()).ToList()); + AddStep("replace DT with NC", () => + { + SelectedMods.Value = SelectedMods.Value.Where(m => m is not ModDoubleTime).Append(new OsuModNightcore()).ToList(); + this.ChildrenOfType().Single().TriggerClick(); + }); AddAssert("mod settings order: NC, HD, DF", () => { - var columns = this.ChildrenOfType().Single().ChildrenOfType(); + var columns = this.ChildrenOfType(); return columns.ElementAt(0).Mod is OsuModNightcore && columns.ElementAt(1).Mod is OsuModHidden && columns.ElementAt(2).Mod is OsuModDeflate; @@ -915,8 +927,8 @@ namespace osu.Game.Tests.Visual.UserInterface private void assertCustomisationToggleState(bool disabled, bool active) { - AddAssert($"customisation toggle is {(disabled ? "" : "not ")}disabled", () => modSelectOverlay.CustomisationButton.AsNonNull().Active.Disabled == disabled); - AddAssert($"customisation toggle is {(active ? "" : "not ")}active", () => modSelectOverlay.CustomisationButton.AsNonNull().Active.Value == active); + AddUntilStep($"customisation panel is {(disabled ? "" : "not ")}disabled", () => modSelectOverlay.ChildrenOfType().Single().State.Value == (disabled ? Visibility.Hidden : Visibility.Visible)); + AddAssert($"customisation panel is {(active ? "" : "not ")}active", () => modSelectOverlay.ChildrenOfType().Single().Expanded.Value == active); } private T getSelectedMod() where T : Mod => SelectedMods.Value.OfType().Single(); @@ -929,7 +941,6 @@ namespace osu.Game.Tests.Visual.UserInterface protected override bool ShowPresets => true; public new ShearedButton BackButton => base.BackButton; - public new ShearedToggleButton? CustomisationButton => base.CustomisationButton; } private class TestUnimplementedMod : Mod diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSettingsArea.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSettingsArea.cs deleted file mode 100644 index dac1f94c28..0000000000 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSettingsArea.cs +++ /dev/null @@ -1,42 +0,0 @@ -// 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 NUnit.Framework; -using osu.Framework.Allocation; -using osu.Framework.Graphics; -using osu.Framework.Graphics.Containers; -using osu.Game.Overlays; -using osu.Game.Overlays.Mods; -using osu.Game.Rulesets.Mods; -using osu.Game.Rulesets.Osu.Mods; - -namespace osu.Game.Tests.Visual.UserInterface -{ - [TestFixture] - public partial class TestSceneModSettingsArea : OsuTestScene - { - [Cached] - private OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Green); - - [Test] - public void TestModToggleArea() - { - ModSettingsArea modSettingsArea = null; - - AddStep("create content", () => Child = new Container - { - RelativeSizeAxes = Axes.Both, - Anchor = Anchor.Centre, - Origin = Anchor.Centre, - Child = modSettingsArea = new ModSettingsArea() - }); - AddStep("set DT", () => modSettingsArea.SelectedMods.Value = new[] { new OsuModDoubleTime() }); - AddStep("set DA", () => modSettingsArea.SelectedMods.Value = new Mod[] { new OsuModDifficultyAdjust() }); - AddStep("set FL+WU+DA+AD", () => modSettingsArea.SelectedMods.Value = new Mod[] { new OsuModFlashlight(), new ModWindUp(), new OsuModDifficultyAdjust(), new OsuModApproachDifferent() }); - AddStep("set empty", () => modSettingsArea.SelectedMods.Value = Array.Empty()); - } - } -} From 2efafcaf5b7ad4608d7c1305af691a693045444a Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Sun, 23 Jun 2024 08:46:55 +0300 Subject: [PATCH 07/60] Remove stale comment --- osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs | 1 - 1 file changed, 1 deletion(-) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs index 39017298ac..a9db957e12 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs @@ -644,7 +644,6 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("select DT", () => SelectedMods.Value = new Mod[] { new OsuModDoubleTime() }); AddAssert("DT selected", () => modSelectOverlay.ChildrenOfType().Count(panel => panel.Active.Value), () => Is.EqualTo(1)); - // todo: rewrite AddStep("open customisation area", () => modSelectOverlay.ChildrenOfType().Single().TriggerClick()); assertCustomisationToggleState(disabled: false, active: true); From 0a72394c8a037950365c0108a1180ee20e197412 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 25 Jun 2024 06:04:39 +0300 Subject: [PATCH 08/60] Fix customisation panel conflicting with beatmap attributes when collapsed --- osu.Game/Overlays/Mods/ModSelectOverlay.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index 5ee52f32f5..8c3c81f2e1 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -372,6 +372,7 @@ namespace osu.Game.Overlays.Mods footerContentFlow.LayoutDuration = 200; footerContentFlow.LayoutEasing = Easing.OutQuint; footerContentFlow.Direction = screenIsntWideEnough ? FillDirection.Vertical : FillDirection.Horizontal; + aboveColumnsContent.Padding = aboveColumnsContent.Padding with { Bottom = screenIsntWideEnough ? 70f : 15f }; } } From 57ee794398d70455280d66628497af762077789b Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 25 Jun 2024 06:08:13 +0300 Subject: [PATCH 09/60] Add extra margin to avoid 1px artifacts --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index 3694fe2bde..7f3a176356 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -74,7 +74,9 @@ namespace osu.Game.Overlays.Mods { RelativeSizeAxes = Axes.X, ScrollbarOverlapsContent = false, - Margin = new MarginPadding { Top = header_height }, + // The +2f is a workaround for masking issues (see https://github.com/ppy/osu-framework/issues/1675#issuecomment-910023157) + // Note that this actually causes the full scroll range to be reduced by 2px at the bottom, but it's not really noticeable. + Margin = new MarginPadding { Top = header_height + 2f }, Child = sectionsFlow = new FillFlowContainer { RelativeSizeAxes = Axes.X, From 3f06a0ef9e89221bd71b3895463c90d9acd5297b Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 25 Jun 2024 06:15:02 +0300 Subject: [PATCH 10/60] Block certain operations when customisation panel is open Normally I would just block keyboard input from going past `ModCustomisationPanel`, but it's a little complicated here since I'm dealing with global action key binding presses, and I also still want actions like `GlobalAction.Back` to get past the customisation panel even if it's expanded. --- osu.Game/Overlays/Mods/ModSelectOverlay.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index 8c3c81f2e1..56e0a88b5a 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -691,7 +691,7 @@ namespace osu.Game.Overlays.Mods // wherein activating the binding will both change the contents of the search text box and deselect all mods. case GlobalAction.DeselectAllMods: { - if (!SearchTextBox.HasFocus) + if (!SearchTextBox.HasFocus && !customisationPanel.Expanded.Value) { deselectAllModsButton.TriggerClick(); return true; @@ -762,6 +762,9 @@ namespace osu.Game.Overlays.Mods if (e.Repeat || e.Key != Key.Tab) return false; + if (customisationPanel.Expanded.Value) + return true; + // TODO: should probably eventually support typical platform search shortcuts (`Ctrl-F`, `/`) setTextBoxFocus(!SearchTextBox.HasFocus); return true; From 7ddb6cb7e7c342b45e1550d8669e05343e42b581 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 25 Jun 2024 06:56:39 +0300 Subject: [PATCH 11/60] Scroll mod setting dropdown into view when open --- .../Configuration/SettingSourceAttribute.cs | 35 +++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/osu.Game/Configuration/SettingSourceAttribute.cs b/osu.Game/Configuration/SettingSourceAttribute.cs index 1e425c88a6..f87c8de0cb 100644 --- a/osu.Game/Configuration/SettingSourceAttribute.cs +++ b/osu.Game/Configuration/SettingSourceAttribute.cs @@ -13,8 +13,10 @@ using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Extensions.TypeExtensions; using osu.Framework.Graphics; using osu.Framework.Localisation; +using osu.Game.Graphics.Containers; using osu.Game.Graphics.UserInterface; using osu.Game.Overlays.Settings; +using osuTK; namespace osu.Game.Configuration { @@ -274,8 +276,37 @@ namespace osu.Game.Configuration private partial class ModDropdownControl : DropdownControl { - // Set menu's max height low enough to workaround nested scroll issues (see https://github.com/ppy/osu-framework/issues/4536). - protected override DropdownMenu CreateMenu() => base.CreateMenu().With(m => m.MaxHeight = 100); + protected override DropdownMenu CreateMenu() => new ModDropdownMenu(); + + private partial class ModDropdownMenu : OsuDropdownMenu + { + public ModDropdownMenu() + { + // Set menu's max height low enough to workaround nested scroll issues (see https://github.com/ppy/osu-framework/issues/4536). + MaxHeight = 100; + } + + protected override void UpdateSize(Vector2 newSize) + { + base.UpdateSize(newSize); + + // todo: probably move this to OsuDropdown so that settings overlay can benefit from this as well. + if (newSize.Y > 0) + { + var scroll = this.FindClosestParent(); + + if (scroll != null) + { + const float padding = 15; + + float target = scroll.GetChildPosInContent(this, new Vector2(0, newSize.Y + padding)); + + if (target > scroll.Current + scroll.DisplayableContent) + scroll.ScrollTo(target - scroll.DisplayableContent); + } + } + } + } } } } From a277d9df13ba0257dee47c3b40adaa72ceb2f931 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 25 Jun 2024 07:13:34 +0300 Subject: [PATCH 12/60] Kill focus from components when clicking on an empty space in the panel --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index 7f3a176356..ec3499bc57 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -49,7 +49,7 @@ namespace osu.Game.Overlays.Mods Height = header_height, Expanded = { BindTarget = Expanded }, }, - content = new InputBlockingContainer + content = new FocusGrabbingContainer { RelativeSizeAxes = Axes.X, BorderColour = colourProvider.Dark3, @@ -159,5 +159,11 @@ namespace osu.Game.Overlays.Mods base.Update(); scrollContainer.Height = Math.Min(scrollContainer.AvailableContent, DrawHeight - header_height); } + + private partial class FocusGrabbingContainer : InputBlockingContainer + { + public override bool RequestsFocus => true; + public override bool AcceptsFocus => true; + } } } From 167ffac21890cf959f159ccd2a63c72d37453346 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Fri, 28 Jun 2024 06:35:12 +0300 Subject: [PATCH 13/60] Reorder container layout for popovers to recognize clicks on customisation panel Basically moves `PopoverContainer` to cover both the columns and the customisation panel, so that if the customisation panel is clicked on, the popover container will notice that and hide popovers like the mod preset popover. --- osu.Game/Overlays/Mods/ModSelectOverlay.cs | 100 +++++++++++---------- 1 file changed, 52 insertions(+), 48 deletions(-) diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index 56e0a88b5a..f447f6f722 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -162,64 +162,68 @@ namespace osu.Game.Overlays.Mods columnAppearSample = audio.Samples.Get(@"SongSelect/mod-column-pop-in"); - MainAreaContent.AddRange(new Drawable[] + MainAreaContent.Add(new OsuContextMenuContainer { - new OsuContextMenuContainer + RelativeSizeAxes = Axes.Both, + Child = new PopoverContainer { RelativeSizeAxes = Axes.Both, - Child = new PopoverContainer + Children = new Drawable[] { - Padding = new MarginPadding + new Container { - Top = RankingInformationDisplay.HEIGHT + PADDING, - Bottom = PADDING - }, - RelativeSizeAxes = Axes.Both, - RelativePositionAxes = Axes.Both, - Children = new Drawable[] - { - columnScroll = new ColumnScrollContainer + Padding = new MarginPadding { - RelativeSizeAxes = Axes.Both, - Masking = false, - ClampExtension = 100, - ScrollbarOverlapsContent = false, - Child = columnFlow = new ColumnFlowContainer + Top = RankingInformationDisplay.HEIGHT + PADDING, + Bottom = PADDING + }, + RelativeSizeAxes = Axes.Both, + RelativePositionAxes = Axes.Both, + Children = new Drawable[] + { + columnScroll = new ColumnScrollContainer { - Anchor = Anchor.BottomLeft, - Origin = Anchor.BottomLeft, - Direction = FillDirection.Horizontal, - Shear = new Vector2(OsuGame.SHEAR, 0), - RelativeSizeAxes = Axes.Y, - AutoSizeAxes = Axes.X, - Margin = new MarginPadding { Horizontal = 70 }, - Padding = new MarginPadding { Bottom = 10 }, - ChildrenEnumerable = createColumns() + RelativeSizeAxes = Axes.Both, + Masking = false, + ClampExtension = 100, + ScrollbarOverlapsContent = false, + Child = columnFlow = new ColumnFlowContainer + { + Anchor = Anchor.BottomLeft, + Origin = Anchor.BottomLeft, + Direction = FillDirection.Horizontal, + Shear = new Vector2(OsuGame.SHEAR, 0), + RelativeSizeAxes = Axes.Y, + AutoSizeAxes = Axes.X, + Margin = new MarginPadding { Horizontal = 70 }, + Padding = new MarginPadding { Bottom = 10 }, + ChildrenEnumerable = createColumns() + } + } + } + }, + aboveColumnsContent = new Container + { + RelativeSizeAxes = Axes.Both, + Padding = new MarginPadding { Horizontal = 100, Bottom = 15f }, + Children = new Drawable[] + { + SearchTextBox = new ShearedSearchTextBox + { + HoldFocus = false, + Width = 300, + }, + customisationPanel = new ModCustomisationPanel + { + Alpha = 0f, + Anchor = Anchor.TopRight, + Origin = Anchor.TopRight, + Width = 400, } } } - } - }, - aboveColumnsContent = new Container - { - RelativeSizeAxes = Axes.Both, - Padding = new MarginPadding { Horizontal = 100, Bottom = 15f }, - Children = new Drawable[] - { - SearchTextBox = new ShearedSearchTextBox - { - HoldFocus = false, - Width = 300, - }, - customisationPanel = new ModCustomisationPanel - { - Alpha = 0f, - Anchor = Anchor.TopRight, - Origin = Anchor.TopRight, - Width = 400, - } - } - }, + }, + } }); FooterContent.Add(footerButtonFlow = new FillFlowContainer From 86b8357b8b7fd39be80a7881103d289ba4342a12 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Fri, 28 Jun 2024 08:52:52 +0300 Subject: [PATCH 14/60] Improve UX & input handling when customisation panel is open --- .../TestSceneModCustomisationPanel.cs | 1 + .../Overlays/Mods/ModCustomisationPanel.cs | 43 ++++++++++++++++--- osu.Game/Overlays/Mods/ModSelectOverlay.cs | 33 ++++++-------- 3 files changed, 50 insertions(+), 27 deletions(-) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs index 0066ecd556..360c28acfa 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs @@ -30,6 +30,7 @@ namespace osu.Game.Tests.Visual.UserInterface Anchor = Anchor.TopCentre, Origin = Anchor.TopCentre, Width = 400f, + State = { Value = Visibility.Visible }, SelectedMods = { BindTarget = SelectedMods }, } }; diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index ec3499bc57..a5a524e109 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -10,16 +10,18 @@ using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Effects; using osu.Framework.Graphics.Shapes; +using osu.Framework.Input.Bindings; using osu.Framework.Input.Events; using osu.Game.Configuration; using osu.Game.Graphics; using osu.Game.Graphics.Containers; +using osu.Game.Input.Bindings; using osu.Game.Rulesets.Mods; using osuTK; namespace osu.Game.Overlays.Mods { - public partial class ModCustomisationPanel : VisibilityContainer + public partial class ModCustomisationPanel : OverlayContainer, IKeyBindingHandler { private const float header_height = 42f; private const float content_vertical_padding = 20f; @@ -35,6 +37,12 @@ namespace osu.Game.Overlays.Mods public Bindable> SelectedMods { get; } = new Bindable>(Array.Empty()); + public override bool HandlePositionalInput => Expanded.Value; + + public override bool HandleNonPositionalInput => Expanded.Value; + + protected override bool BlockPositionalInput => true; + [BackgroundDependencyLoader] private void load() { @@ -63,6 +71,7 @@ namespace osu.Game.Overlays.Mods Radius = 20f, Roundness = 5f, }, + Expanded = { BindTarget = Expanded }, Children = new Drawable[] { new Box @@ -110,12 +119,30 @@ namespace osu.Game.Overlays.Mods public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; - protected override bool OnMouseDown(MouseDownEvent e) + protected override bool OnClick(ClickEvent e) { - if (Expanded.Value && !content.ReceivePositionalInputAt(e.ScreenSpaceMousePosition)) - Expanded.Value = false; + Expanded.Value = false; + return base.OnClick(e); + } - return base.OnMouseDown(e); + protected override bool OnKeyDown(KeyDownEvent e) => true; + + protected override bool OnScroll(ScrollEvent e) => true; + + public bool OnPressed(KeyBindingPressEvent e) + { + switch (e.Action) + { + case GlobalAction.Back: + Expanded.Value = false; + return true; + } + + return false; + } + + public void OnReleased(KeyBindingReleaseEvent e) + { } private void updateDisplay() @@ -162,8 +189,10 @@ namespace osu.Game.Overlays.Mods private partial class FocusGrabbingContainer : InputBlockingContainer { - public override bool RequestsFocus => true; - public override bool AcceptsFocus => true; + public IBindable Expanded { get; } = new BindableBool(); + + public override bool RequestsFocus => Expanded.Value; + public override bool AcceptsFocus => Expanded.Value; } } } diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index f447f6f722..b0d58480db 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -29,6 +29,7 @@ using osu.Game.Localisation; using osu.Game.Rulesets.Mods; using osu.Game.Utils; using osuTK; +using osuTK.Graphics; using osuTK.Input; namespace osu.Game.Overlays.Mods @@ -215,7 +216,6 @@ namespace osu.Game.Overlays.Mods }, customisationPanel = new ModCustomisationPanel { - Alpha = 0f, Anchor = Anchor.TopRight, Origin = Anchor.TopRight, Width = 400, @@ -508,9 +508,17 @@ namespace osu.Game.Overlays.Mods private void updateCustomisationVisualState() { if (customisationPanel.Expanded.Value) + { + columnScroll.FadeColour(OsuColour.Gray(0.5f), 400, Easing.OutQuint); + SearchTextBox.FadeColour(OsuColour.Gray(0.5f), 400, Easing.OutQuint); SearchTextBox.KillFocus(); + } else + { + columnScroll.FadeColour(Color4.White, 400, Easing.OutQuint); + SearchTextBox.FadeColour(Color4.White, 400, Easing.OutQuint); setTextBoxFocus(textSearchStartsActive.Value); + } } /// @@ -678,16 +686,12 @@ namespace osu.Game.Overlays.Mods switch (e.Action) { + // If the customisation panel is expanded, the back action will be handled by it first. case GlobalAction.Back: - // Pressing the back binding should only go back one step at a time. - hideOverlay(false); - return true; - // This is handled locally here because this overlay is being registered at the game level // and therefore takes away keyboard focus from the screen stack. case GlobalAction.ToggleModSelection: - // Pressing toggle should completely hide the overlay in one shot. - hideOverlay(true); + hideOverlay(); return true; // This is handled locally here due to conflicts in input handling between the search text box and the deselect all mods button. @@ -710,7 +714,7 @@ namespace osu.Game.Overlays.Mods // If there is no search in progress, it should exit the dialog (a bit weird, but this is the expectation from stable). if (string.IsNullOrEmpty(SearchTerm)) { - hideOverlay(true); + hideOverlay(); return true; } @@ -728,18 +732,7 @@ namespace osu.Game.Overlays.Mods return base.OnPressed(e); - void hideOverlay(bool immediate) - { - if (customisationPanel.Expanded.Value) - { - customisationPanel.Expanded.Value = false; - - if (!immediate) - return; - } - - BackButton.TriggerClick(); - } + void hideOverlay() => BackButton.TriggerClick(); } /// From f462aa59df34508bd4d792dcc22d1f645ac2637c Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Fri, 28 Jun 2024 11:23:49 +0300 Subject: [PATCH 15/60] Add test coverage for the issues that were pointed out recently --- .../TestSceneModSelectOverlay.cs | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs index a9db957e12..dedad3a40a 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs @@ -25,6 +25,7 @@ using osu.Game.Rulesets.Osu; using osu.Game.Rulesets.Osu.Mods; using osu.Game.Rulesets.Taiko.Mods; using osu.Game.Tests.Mods; +using osuTK; using osuTK.Input; namespace osu.Game.Tests.Visual.UserInterface @@ -761,6 +762,19 @@ namespace osu.Game.Tests.Visual.UserInterface AddAssert("mod select hidden", () => modSelectOverlay.State.Value == Visibility.Hidden); } + [Test] + public void TestCloseViaToggleModSelectionBinding() + { + createScreen(); + changeRuleset(0); + + AddStep("select difficulty adjust via panel", () => getPanelForMod(typeof(OsuModDifficultyAdjust)).TriggerClick()); + assertCustomisationToggleState(disabled: false, active: true); + + AddStep("press F1", () => InputManager.Key(Key.F1)); + AddAssert("mod select hidden", () => modSelectOverlay.State.Value == Visibility.Hidden); + } + /// /// Covers columns hiding/unhiding on changes of . /// @@ -912,6 +926,68 @@ namespace osu.Game.Tests.Visual.UserInterface }); } + [Test] + public void TestOpeningCustomisationHidesPresetPopover() + { + createScreen(); + + AddStep("select DT", () => SelectedMods.Value = new Mod[] { new OsuModDoubleTime() }); + AddStep("click new preset", () => + { + InputManager.MoveMouseTo(this.ChildrenOfType().Single()); + InputManager.Click(MouseButton.Left); + }); + + AddAssert("preset popover shown", () => this.ChildrenOfType().SingleOrDefault()?.IsPresent, () => Is.True); + + AddStep("click customisation header", () => + { + InputManager.MoveMouseTo(this.ChildrenOfType().Single()); + InputManager.Click(MouseButton.Left); + }); + + AddUntilStep("preset popover hidden", () => this.ChildrenOfType().SingleOrDefault()?.IsPresent, () => Is.Not.True); + AddAssert("customisation panel shown", () => this.ChildrenOfType().Single().State.Value, () => Is.EqualTo(Visibility.Visible)); + } + + [Test] + public void TestCustomisationPanelAbsorbsInput([Values] bool textSearchStartsActive) + { + AddStep($"text search starts active = {textSearchStartsActive}", () => configManager.SetValue(OsuSetting.ModSelectTextSearchStartsActive, textSearchStartsActive)); + createScreen(); + + AddStep("select DT", () => SelectedMods.Value = new Mod[] { new OsuModDoubleTime() }); + AddStep("open customisation panel", () => this.ChildrenOfType().Single().TriggerClick()); + AddAssert("search lost focus", () => !this.ChildrenOfType().Single().HasFocus); + + AddStep("press tab", () => InputManager.Key(Key.Tab)); + AddAssert("search still not focused", () => !this.ChildrenOfType().Single().HasFocus); + + AddStep("press q", () => InputManager.Key(Key.Q)); + AddAssert("easy not selected", () => SelectedMods.Value.Single() is OsuModDoubleTime); + + // the "deselect all mods" action is intentionally disabled when customisation panel is open to not conflict with pressing backspace to delete characters in a textbox. + // this is supposed to be handled by the textbox itself especially since it's focused and thus prioritised in input queue, + // but it's not for some reason, and figuring out why is probably not going to be a pleasant experience (read TextBox.OnKeyDown for a head start). + AddStep("press backspace", () => InputManager.Key(Key.BackSpace)); + AddAssert("mods not deselected", () => SelectedMods.Value.Single() is OsuModDoubleTime); + + AddStep("move mouse to scroll bar", () => InputManager.MoveMouseTo(modSelectOverlay.ChildrenOfType().Single().ScreenSpaceDrawQuad.BottomLeft + new Vector2(10f, -5f))); + + AddStep("scroll down", () => InputManager.ScrollVerticalBy(-10f)); + AddAssert("column not scrolled", () => modSelectOverlay.ChildrenOfType().Single().IsScrolledToStart()); + + AddStep("press mouse", () => InputManager.PressButton(MouseButton.Left)); + AddAssert("search still not focused", () => !this.ChildrenOfType().Single().HasFocus); + AddStep("release mouse", () => InputManager.ReleaseButton(MouseButton.Left)); + AddAssert("customisation panel closed by click", () => !this.ChildrenOfType().Single().Expanded.Value); + + if (textSearchStartsActive) + AddAssert("search focused", () => this.ChildrenOfType().Single().HasFocus); + else + AddAssert("search still not focused", () => !this.ChildrenOfType().Single().HasFocus); + } + private void waitForColumnLoad() => AddUntilStep("all column content loaded", () => modSelectOverlay.ChildrenOfType().Any() && modSelectOverlay.ChildrenOfType().All(column => column.IsLoaded && column.ItemsLoaded) From 901663b3fff921f78afe4e0bfa2fce97ce378b90 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Sun, 30 Jun 2024 11:00:00 +0300 Subject: [PATCH 16/60] Fix test failure --- osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs index dedad3a40a..9f48b06bb6 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs @@ -55,6 +55,7 @@ namespace osu.Game.Tests.Visual.UserInterface AddStep("clear contents", Clear); AddStep("reset ruleset", () => Ruleset.Value = rulesetStore.GetRuleset(0)); AddStep("reset mods", () => SelectedMods.SetDefault()); + AddStep("reset config", () => configManager.SetValue(OsuSetting.ModSelectTextSearchStartsActive, true)); AddStep("set beatmap", () => Beatmap.Value = CreateWorkingBeatmap(new OsuRuleset().RulesetInfo)); AddStep("set up presets", () => { From 1d94c96a8efef24d5ae54aa7159f6e7a615a50a8 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Tue, 2 Jul 2024 14:40:00 +0300 Subject: [PATCH 17/60] Display customisation header in disabled state when no customisable mod selected --- .../UserInterface/TestSceneModSelectOverlay.cs | 2 +- osu.Game/Localisation/ModSelectOverlayStrings.cs | 5 +++++ osu.Game/Overlays/Mods/ModCustomisationHeader.cs | 15 +++++++++++++-- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 8 ++++++++ osu.Game/Overlays/Mods/ModSelectOverlay.cs | 5 +++-- 5 files changed, 30 insertions(+), 5 deletions(-) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs index 9f48b06bb6..21a5e3082b 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModSelectOverlay.cs @@ -1003,7 +1003,7 @@ namespace osu.Game.Tests.Visual.UserInterface private void assertCustomisationToggleState(bool disabled, bool active) { - AddUntilStep($"customisation panel is {(disabled ? "" : "not ")}disabled", () => modSelectOverlay.ChildrenOfType().Single().State.Value == (disabled ? Visibility.Hidden : Visibility.Visible)); + AddUntilStep($"customisation panel is {(disabled ? "" : "not ")}disabled", () => modSelectOverlay.ChildrenOfType().Single().Enabled.Value == !disabled); AddAssert($"customisation panel is {(active ? "" : "not ")}active", () => modSelectOverlay.ChildrenOfType().Single().Expanded.Value == active); } diff --git a/osu.Game/Localisation/ModSelectOverlayStrings.cs b/osu.Game/Localisation/ModSelectOverlayStrings.cs index a2e1df42c6..10037d30c3 100644 --- a/osu.Game/Localisation/ModSelectOverlayStrings.cs +++ b/osu.Game/Localisation/ModSelectOverlayStrings.cs @@ -80,6 +80,11 @@ namespace osu.Game.Localisation /// public static LocalisableString CustomisationPanelHeader => new TranslatableString(getKey(@"customisation_panel_header"), @"Customise"); + /// + /// "No mod selected which can be customised." + /// + public static LocalisableString CustomisationPanelDisabledReason => new TranslatableString(getKey(@"customisation_panel_disabled_reason"), @"No mod selected which can be customised."); + private static string getKey(string key) => $@"{prefix}:{key}"; } } diff --git a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs index e6534921f6..2887b53548 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs @@ -30,6 +30,12 @@ namespace osu.Game.Overlays.Mods public readonly BindableBool Expanded = new BindableBool(); + public ModCustomisationHeader() + { + Action = Expanded.Toggle; + Enabled.Value = false; + } + [BackgroundDependencyLoader] private void load() { @@ -75,12 +81,17 @@ namespace osu.Game.Overlays.Mods { base.LoadComplete(); + Enabled.BindValueChanged(e => + { + TooltipText = e.NewValue + ? string.Empty + : ModSelectOverlayStrings.CustomisationPanelDisabledReason; + }, true); + Expanded.BindValueChanged(v => { icon.RotateTo(v.NewValue ? 180 : 0); }, true); - - Action = Expanded.Toggle; } } } diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index a5a524e109..240569031c 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -33,6 +33,8 @@ namespace osu.Game.Overlays.Mods [Resolved] private OverlayColourProvider colourProvider { get; set; } = null!; + public readonly BindableBool Enabled = new BindableBool(); + public readonly BindableBool Expanded = new BindableBool(); public Bindable> SelectedMods { get; } = new Bindable>(Array.Empty()); @@ -55,6 +57,7 @@ namespace osu.Game.Overlays.Mods Depth = float.MinValue, RelativeSizeAxes = Axes.X, Height = header_height, + Enabled = { BindTarget = Enabled }, Expanded = { BindTarget = Expanded }, }, content = new FocusGrabbingContainer @@ -107,6 +110,11 @@ namespace osu.Game.Overlays.Mods { base.LoadComplete(); + Enabled.BindValueChanged(e => + { + this.FadeColour(OsuColour.Gray(e.NewValue ? 1f : 0.6f), 300, Easing.OutQuint); + }, true); + Expanded.BindValueChanged(_ => updateDisplay(), true); SelectedMods.BindValueChanged(_ => updateMods(), true); diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs index b0d58480db..d5a4d27237 100644 --- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs +++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs @@ -219,6 +219,7 @@ namespace osu.Game.Overlays.Mods Anchor = Anchor.TopRight, Origin = Anchor.TopRight, Width = 400, + State = { Value = Visibility.Visible }, } } } @@ -493,7 +494,7 @@ namespace osu.Game.Overlays.Mods if (anyCustomisableModActive) { - customisationPanel.Show(); + customisationPanel.Enabled.Value = true; if (anyModPendingConfiguration) customisationPanel.Expanded.Value = true; @@ -501,7 +502,7 @@ namespace osu.Game.Overlays.Mods else { customisationPanel.Expanded.Value = false; - customisationPanel.Hide(); + customisationPanel.Enabled.Value = false; } } From 153138cdac5707988a1b351e96b4019f5512b13f Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Wed, 3 Jul 2024 13:47:41 +0900 Subject: [PATCH 18/60] Use `null` to disable audio filter instead --- osu.Game/Overlays/MusicController.cs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 678ae92d4b..7fe9a3e33b 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -11,6 +11,7 @@ using osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Audio.Track; using osu.Framework.Bindables; +using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Audio; using osu.Framework.Graphics.Containers; @@ -259,13 +260,15 @@ namespace osu.Game.Overlays /// /// Duration of the ducking transition, in ms. /// Level to drop volume to (1.0 = 100%). - /// Cutoff frequency to drop `AudioFilter` to. Use `AudioFilter.MAX_LOWPASS_CUTOFF` to skip filter effect. + /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Easing for the ducking transition. - public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int duckCutoffTo = 300, Easing easing = Easing.InCubic) + public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.InCubic) { Schedule(() => { - audioDuckFilter?.CutoffTo(duckCutoffTo, duration, easing); + if (duckCutoffTo.IsNotNull()) + audioDuckFilter?.CutoffTo((int)duckCutoffTo, duration, easing); + this.TransformBindableTo(audioDuckVolume, duckVolumeTo, duration, easing); }); } @@ -291,10 +294,10 @@ namespace osu.Game.Overlays /// Duration of the unducking transition, in ms. /// Easing for the unducking transition. /// Level to drop volume to (1.0 = 100%). - /// Cutoff frequency to drop `AudioFilter` to. Use `AudioFilter.MAX_LOWPASS_CUTOFF` to skip filter effect. + /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Duration of the ducking transition, in ms. /// Easing for the ducking transition. - public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.InCubic) + public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.InCubic) { Duck(duckDuration, duckVolumeTo, duckCutoffTo, duckEasing); Scheduler.AddDelayed(() => Unduck(unduckDuration, unduckEasing), delay); From b972632e4fdcfd2a6bfb866b1ab06ade5ee16c27 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Wed, 3 Jul 2024 13:50:35 +0900 Subject: [PATCH 19/60] Change default easing to match prior behaviour --- osu.Game/Overlays/MusicController.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 7fe9a3e33b..b0e6994448 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -262,7 +262,7 @@ namespace osu.Game.Overlays /// Level to drop volume to (1.0 = 100%). /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Easing for the ducking transition. - public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.InCubic) + public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic) { Schedule(() => { @@ -297,7 +297,7 @@ namespace osu.Game.Overlays /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Duration of the ducking transition, in ms. /// Easing for the ducking transition. - public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.InCubic) + public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.OutCubic) { Duck(duckDuration, duckVolumeTo, duckCutoffTo, duckEasing); Scheduler.AddDelayed(() => Unduck(unduckDuration, unduckEasing), delay); From d29d114133e0ecd5426a15497234718edb6e0546 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Wed, 3 Jul 2024 13:52:20 +0900 Subject: [PATCH 20/60] Match prior ducking behaviour --- osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs index e01d4e2d66..cdde35c7d0 100644 --- a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs +++ b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs @@ -81,7 +81,7 @@ namespace osu.Game.Overlays.Dialog protected override void Confirm() { - musicController?.Duck(); + musicController?.Duck(100, 1f); confirmSample?.Play(); base.Confirm(); } From 6fda0db9bac3c30b7d5c2fcaf15a1a4bafac09aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Wed, 3 Jul 2024 11:03:52 +0200 Subject: [PATCH 21/60] Fix test --- .../TestSceneModCustomisationPanel.cs | 28 +++++++++++++++---- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs index 360c28acfa..9c0d185892 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneModCustomisationPanel.cs @@ -18,6 +18,8 @@ namespace osu.Game.Tests.Visual.UserInterface [Cached] private readonly OverlayColourProvider colourProvider = new OverlayColourProvider(OverlayColourScheme.Aquamarine); + private ModCustomisationPanel panel = null!; + [SetUp] public void SetUp() => Schedule(() => { @@ -25,7 +27,7 @@ namespace osu.Game.Tests.Visual.UserInterface { RelativeSizeAxes = Axes.Both, Padding = new MarginPadding(20f), - Child = new ModCustomisationPanel + Child = panel = new ModCustomisationPanel { Anchor = Anchor.TopCentre, Origin = Anchor.TopCentre, @@ -39,10 +41,26 @@ namespace osu.Game.Tests.Visual.UserInterface [Test] public void TestDisplay() { - AddStep("set DT", () => SelectedMods.Value = new[] { new OsuModDoubleTime() }); - AddStep("set DA", () => SelectedMods.Value = new Mod[] { new OsuModDifficultyAdjust() }); - AddStep("set FL+WU+DA+AD", () => SelectedMods.Value = new Mod[] { new OsuModFlashlight(), new ModWindUp(), new OsuModDifficultyAdjust(), new OsuModApproachDifferent() }); - AddStep("set empty", () => SelectedMods.Value = Array.Empty()); + AddStep("set DT", () => + { + SelectedMods.Value = new[] { new OsuModDoubleTime() }; + panel.Enabled.Value = panel.Expanded.Value = true; + }); + AddStep("set DA", () => + { + SelectedMods.Value = new Mod[] { new OsuModDifficultyAdjust() }; + panel.Enabled.Value = panel.Expanded.Value = true; + }); + AddStep("set FL+WU+DA+AD", () => + { + SelectedMods.Value = new Mod[] { new OsuModFlashlight(), new ModWindUp(), new OsuModDifficultyAdjust(), new OsuModApproachDifferent() }; + panel.Enabled.Value = panel.Expanded.Value = true; + }); + AddStep("set empty", () => + { + SelectedMods.Value = Array.Empty(); + panel.Enabled.Value = panel.Expanded.Value = false; + }); } } } From 86583898548c83e3211b6c10f653b88382ada954 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Thu, 4 Jul 2024 07:22:08 +0300 Subject: [PATCH 22/60] Clarify how the panel blocks input --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index 240569031c..ae162e1553 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -39,12 +39,14 @@ namespace osu.Game.Overlays.Mods public Bindable> SelectedMods { get; } = new Bindable>(Array.Empty()); + public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; + + // Handle{Non}PositionalInput controls whether the panel should act as a blocking layer on the screen. only block when the panel is expanded. + // These properties are used because they correctly handle blocking/unblocking hover when mouse is pointing at a drawable outside + // (returning Expanded.Value to OnHover or overriding Block{Non}PositionalInput doesn't work). public override bool HandlePositionalInput => Expanded.Value; - public override bool HandleNonPositionalInput => Expanded.Value; - protected override bool BlockPositionalInput => true; - [BackgroundDependencyLoader] private void load() { @@ -125,8 +127,6 @@ namespace osu.Game.Overlays.Mods protected override void PopOut() => this.FadeOut(300, Easing.OutQuint); - public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; - protected override bool OnClick(ClickEvent e) { Expanded.Value = false; From 33711ba6167f3e0bdb7e9c7aba2b6f1dbde239ea Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Thu, 4 Jul 2024 07:25:54 +0300 Subject: [PATCH 23/60] Remove scroll-dropdown-into-view logic --- .../Configuration/SettingSourceAttribute.cs | 35 ++----------------- 1 file changed, 2 insertions(+), 33 deletions(-) diff --git a/osu.Game/Configuration/SettingSourceAttribute.cs b/osu.Game/Configuration/SettingSourceAttribute.cs index f87c8de0cb..1e425c88a6 100644 --- a/osu.Game/Configuration/SettingSourceAttribute.cs +++ b/osu.Game/Configuration/SettingSourceAttribute.cs @@ -13,10 +13,8 @@ using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Extensions.TypeExtensions; using osu.Framework.Graphics; using osu.Framework.Localisation; -using osu.Game.Graphics.Containers; using osu.Game.Graphics.UserInterface; using osu.Game.Overlays.Settings; -using osuTK; namespace osu.Game.Configuration { @@ -276,37 +274,8 @@ namespace osu.Game.Configuration private partial class ModDropdownControl : DropdownControl { - protected override DropdownMenu CreateMenu() => new ModDropdownMenu(); - - private partial class ModDropdownMenu : OsuDropdownMenu - { - public ModDropdownMenu() - { - // Set menu's max height low enough to workaround nested scroll issues (see https://github.com/ppy/osu-framework/issues/4536). - MaxHeight = 100; - } - - protected override void UpdateSize(Vector2 newSize) - { - base.UpdateSize(newSize); - - // todo: probably move this to OsuDropdown so that settings overlay can benefit from this as well. - if (newSize.Y > 0) - { - var scroll = this.FindClosestParent(); - - if (scroll != null) - { - const float padding = 15; - - float target = scroll.GetChildPosInContent(this, new Vector2(0, newSize.Y + padding)); - - if (target > scroll.Current + scroll.DisplayableContent) - scroll.ScrollTo(target - scroll.DisplayableContent); - } - } - } - } + // Set menu's max height low enough to workaround nested scroll issues (see https://github.com/ppy/osu-framework/issues/4536). + protected override DropdownMenu CreateMenu() => base.CreateMenu().With(m => m.MaxHeight = 100); } } } From 585e09981fd655add5cd0465d5cf6debb3eef97d Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Thu, 4 Jul 2024 07:36:31 +0300 Subject: [PATCH 24/60] Allow scrollbar to overlap content The content is already padded enough to have the scrollbar sit on top. Having the content change padding when the scrollbar appears gives an unpleasent experience (especially when the scrollbar is hidden at first but the user increases the content's height by clicking on a dropdown or something) --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 1 - 1 file changed, 1 deletion(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index ae162e1553..f214bcb3a1 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -87,7 +87,6 @@ namespace osu.Game.Overlays.Mods scrollContainer = new OsuScrollContainer(Direction.Vertical) { RelativeSizeAxes = Axes.X, - ScrollbarOverlapsContent = false, // The +2f is a workaround for masking issues (see https://github.com/ppy/osu-framework/issues/1675#issuecomment-910023157) // Note that this actually causes the full scroll range to be reduced by 2px at the bottom, but it's not really noticeable. Margin = new MarginPadding { Top = header_height + 2f }, From d948193757530830d5488b531508fb96e0816362 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Thu, 4 Jul 2024 14:23:35 +0900 Subject: [PATCH 25/60] Change Duck() to be IDisposable and prevent overlapping usages --- .../Collections/ManageCollectionsDialog.cs | 16 ++++++-- .../Dialog/PopupDialogDangerousButton.cs | 10 ----- osu.Game/Overlays/DialogOverlay.cs | 13 +++++- osu.Game/Overlays/MusicController.cs | 41 ++++++++++++------- 4 files changed, 49 insertions(+), 31 deletions(-) diff --git a/osu.Game/Collections/ManageCollectionsDialog.cs b/osu.Game/Collections/ManageCollectionsDialog.cs index e777da05e5..0396fd531c 100644 --- a/osu.Game/Collections/ManageCollectionsDialog.cs +++ b/osu.Game/Collections/ManageCollectionsDialog.cs @@ -1,8 +1,8 @@ // Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. +using System; using osu.Framework.Allocation; -using osu.Framework.Audio; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Shapes; @@ -24,6 +24,8 @@ namespace osu.Game.Collections protected override string PopInSampleName => @"UI/overlay-big-pop-in"; protected override string PopOutSampleName => @"UI/overlay-big-pop-out"; + private IDisposable? audioDucker; + [Resolved] private MusicController? musicController { get; set; } @@ -40,7 +42,7 @@ namespace osu.Game.Collections } [BackgroundDependencyLoader] - private void load(OsuColour colours, AudioManager audio) + private void load(OsuColour colours) { Children = new Drawable[] { @@ -115,9 +117,15 @@ namespace osu.Game.Collections }; } + protected override void Dispose(bool isDisposing) + { + base.Dispose(isDisposing); + audioDucker?.Dispose(); + } + protected override void PopIn() { - musicController?.Duck(100, 1f); + audioDucker = musicController?.Duck(100, 1f, unduckDuration: 100); this.FadeIn(enter_duration, Easing.OutQuint); this.ScaleTo(0.9f).Then().ScaleTo(1f, enter_duration, Easing.OutQuint); @@ -127,7 +135,7 @@ namespace osu.Game.Collections { base.PopOut(); - musicController?.Unduck(100); + audioDucker?.Dispose(); this.FadeOut(exit_duration, Easing.OutQuint); this.ScaleTo(0.9f, exit_duration); diff --git a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs index cdde35c7d0..1878cfd131 100644 --- a/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs +++ b/osu.Game/Overlays/Dialog/PopupDialogDangerousButton.cs @@ -47,9 +47,6 @@ namespace osu.Game.Overlays.Dialog private partial class DangerousConfirmContainer : HoldToConfirmContainer { - [Resolved] - private MusicController musicController { get; set; } - public DangerousConfirmContainer() : base(isDangerousAction: true) { @@ -73,15 +70,8 @@ namespace osu.Game.Overlays.Dialog Progress.BindValueChanged(progressChanged); } - protected override void AbortConfirm() - { - musicController?.Unduck(); - base.AbortConfirm(); - } - protected override void Confirm() { - musicController?.Duck(100, 1f); confirmSample?.Play(); base.Confirm(); } diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs index aa9bb99e01..57cfa49746 100644 --- a/osu.Game/Overlays/DialogOverlay.cs +++ b/osu.Game/Overlays/DialogOverlay.cs @@ -3,6 +3,7 @@ #nullable disable +using System; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Game.Overlays.Dialog; @@ -29,6 +30,8 @@ namespace osu.Game.Overlays public override bool IsPresent => Scheduler.HasPendingTasks || dialogContainer.Children.Count > 0; + private IDisposable? audioDucker; + public DialogOverlay() { AutoSizeAxes = Axes.Y; @@ -45,6 +48,12 @@ namespace osu.Game.Overlays Origin = Anchor.Centre; } + protected override void Dispose(bool isDisposing) + { + base.Dispose(isDisposing); + audioDucker?.Dispose(); + } + public void Push(PopupDialog dialog) { if (dialog == CurrentDialog || dialog.State.Value == Visibility.Hidden) return; @@ -95,13 +104,13 @@ namespace osu.Game.Overlays protected override void PopIn() { - musicController.Duck(100, 1f); + audioDucker = musicController.Duck(100, 1f, unduckDuration: 100); } protected override void PopOut() { base.PopOut(); - musicController.Unduck(100); + audioDucker?.Dispose(); // PopOut gets called initially, but we only want to hide dialog when we have been loaded and are present. if (IsLoaded && CurrentDialog?.State.Value == Visibility.Visible) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index b0e6994448..2952d9d18e 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -67,6 +67,7 @@ namespace osu.Game.Overlays private AudioFilter audioDuckFilter; private readonly BindableDouble audioDuckVolume = new BindableDouble(1); + private bool audioDuckActive; [BackgroundDependencyLoader] private void load(AudioManager audio) @@ -262,8 +263,15 @@ namespace osu.Game.Overlays /// Level to drop volume to (1.0 = 100%). /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Easing for the ducking transition. - public void Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic) + /// Duration of the unducking transition, in ms. + /// Easing for the unducking transition. + public IDisposable Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic) { + if (audioDuckActive) + throw new InvalidOperationException("Cannot perform Duck() while another Duck() is in progress."); + + audioDuckActive = true; + Schedule(() => { if (duckCutoffTo.IsNotNull()) @@ -271,20 +279,8 @@ namespace osu.Game.Overlays this.TransformBindableTo(audioDuckVolume, duckVolumeTo, duration, easing); }); - } - /// - /// Restores the volume to full and stops filtering the currently playing track after having used . - /// - /// Duration of the unducking transition, in ms. - /// Easing for the unducking transition. - public void Unduck(int duration = 500, Easing easing = Easing.InCubic) - { - Schedule(() => - { - audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, duration, easing); - this.TransformBindableTo(audioDuckVolume, 1, duration, easing); - }); + return new InvokeOnDisposal(() => unduck(unduckDuration, unduckEasing)); } /// @@ -299,8 +295,23 @@ namespace osu.Game.Overlays /// Easing for the ducking transition. public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.OutCubic) { + if (audioDuckActive) return; + Duck(duckDuration, duckVolumeTo, duckCutoffTo, duckEasing); - Scheduler.AddDelayed(() => Unduck(unduckDuration, unduckEasing), delay); + Scheduler.AddDelayed(() => unduck(unduckDuration, unduckEasing), delay); + } + + private void unduck(int duration, Easing easing) + { + if (!audioDuckActive) return; + + audioDuckActive = false; + + Schedule(() => + { + audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, duration, easing); + this.TransformBindableTo(audioDuckVolume, 1, duration, easing); + }); } private bool next() From 753463fadbb8f50b78c7ad71abcb6a795d6c0aa5 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Thu, 4 Jul 2024 15:01:37 +0900 Subject: [PATCH 26/60] Fix code style --- osu.Game/Overlays/DialogOverlay.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs index 57cfa49746..7c52081053 100644 --- a/osu.Game/Overlays/DialogOverlay.cs +++ b/osu.Game/Overlays/DialogOverlay.cs @@ -10,6 +10,7 @@ using osu.Game.Overlays.Dialog; using osu.Game.Graphics.Containers; using osu.Game.Input.Bindings; using System.Linq; +using JetBrains.Annotations; using osu.Framework.Allocation; using osu.Framework.Input.Events; @@ -30,7 +31,8 @@ namespace osu.Game.Overlays public override bool IsPresent => Scheduler.HasPendingTasks || dialogContainer.Children.Count > 0; - private IDisposable? audioDucker; + [CanBeNull] + private IDisposable audioDucker; public DialogOverlay() { From 82e4e884d7a3c8ac81b52c0f16b93c5f06a81810 Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Thu, 4 Jul 2024 15:51:50 +0900 Subject: [PATCH 27/60] Change overlapping `Duck()` usages to be a noop instead of a throw --- osu.Game/Overlays/MusicController.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 2952d9d18e..8b52c59bae 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -267,8 +267,7 @@ namespace osu.Game.Overlays /// Easing for the unducking transition. public IDisposable Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic) { - if (audioDuckActive) - throw new InvalidOperationException("Cannot perform Duck() while another Duck() is in progress."); + if (audioDuckActive) return null; audioDuckActive = true; From a5077fcb3f3e43ce237e3aee5486acaddd20b5aa Mon Sep 17 00:00:00 2001 From: Jamie Taylor Date: Thu, 4 Jul 2024 17:22:33 +0900 Subject: [PATCH 28/60] Rename TimedDuck -> DuckMomentarily --- osu.Game/Overlays/MusicController.cs | 2 +- osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 8b52c59bae..4c563d8845 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -292,7 +292,7 @@ namespace osu.Game.Overlays /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Duration of the ducking transition, in ms. /// Easing for the ducking transition. - public void TimedDuck(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.OutCubic) + public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.OutCubic) { if (audioDuckActive) return; diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs index 7da6b76aaa..c39ff60b6b 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs @@ -122,7 +122,7 @@ namespace osu.Game.Overlays.Toolbar rulesetSelectionChannel[r.NewValue] = channel; channel.Play(); - musicController?.TimedDuck(600); + musicController?.DuckMomentarily(600); } public override bool HandleNonPositionalInput => !Current.Disabled && base.HandleNonPositionalInput; From 0696e2df32bd0629f0a1314d9f87fd364074954d Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 12:58:18 +0900 Subject: [PATCH 29/60] Apply nullability to ducking methods --- osu.Game/Overlays/MusicController.cs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 493acb183d..54a0436f2a 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -61,8 +61,9 @@ namespace osu.Game.Overlays [Resolved] private RealmAccess realm { get; set; } = null!; - private AudioFilter audioDuckFilter; private readonly BindableDouble audioDuckVolume = new BindableDouble(1); + + private AudioFilter? audioDuckFilter; private bool audioDuckActive; [BackgroundDependencyLoader] @@ -268,7 +269,7 @@ namespace osu.Game.Overlays /// Easing for the ducking transition. /// Duration of the unducking transition, in ms. /// Easing for the unducking transition. - public IDisposable Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic) + public IDisposable? Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic) { if (audioDuckActive) return null; @@ -295,7 +296,8 @@ namespace osu.Game.Overlays /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Duration of the ducking transition, in ms. /// Easing for the ducking transition. - public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, Easing duckEasing = Easing.OutCubic) + public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, + Easing duckEasing = Easing.OutCubic) { if (audioDuckActive) return; From 4528daf7fa5d663996bc4e9eac6368e7b0951e21 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 13:15:15 +0900 Subject: [PATCH 30/60] Update resources --- osu.Game/osu.Game.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/osu.Game.csproj b/osu.Game/osu.Game.csproj index 67c9f2e100..447c783b29 100644 --- a/osu.Game/osu.Game.csproj +++ b/osu.Game/osu.Game.csproj @@ -36,7 +36,7 @@ - + From ec4623d49f3efec2e06328616d1e2640cc18acc7 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 13:51:29 +0900 Subject: [PATCH 31/60] Reduce duck length slightly on toolbar ruleset selector --- osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs index c39ff60b6b..796477f9f6 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs @@ -122,7 +122,7 @@ namespace osu.Game.Overlays.Toolbar rulesetSelectionChannel[r.NewValue] = channel; channel.Play(); - musicController?.DuckMomentarily(600); + musicController?.DuckMomentarily(500); } public override bool HandleNonPositionalInput => !Current.Disabled && base.HandleNonPositionalInput; From 0d858ce8f8eea091b40214a2709d5862021aa33b Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 13:51:41 +0900 Subject: [PATCH 32/60] Change default easings to `In`/`Out` for all ducking operations --- osu.Game/Overlays/MusicController.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 54a0436f2a..94078a3dec 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -269,7 +269,7 @@ namespace osu.Game.Overlays /// Easing for the ducking transition. /// Duration of the unducking transition, in ms. /// Easing for the unducking transition. - public IDisposable? Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.OutCubic, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic) + public IDisposable? Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.Out, int unduckDuration = 500, Easing unduckEasing = Easing.In) { if (audioDuckActive) return null; @@ -296,8 +296,8 @@ namespace osu.Game.Overlays /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. /// Duration of the ducking transition, in ms. /// Easing for the ducking transition. - public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.InCubic, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, - Easing duckEasing = Easing.OutCubic) + public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.In, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, + Easing duckEasing = Easing.Out) { if (audioDuckActive) return; From 554740af1010855598b3f2c40e9dee369438b11b Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 14:41:50 +0900 Subject: [PATCH 33/60] Adjust ducking API to use a parameters `record` --- .../Collections/ManageCollectionsDialog.cs | 13 ++- osu.Game/Overlays/DialogOverlay.cs | 13 ++- osu.Game/Overlays/MusicController.cs | 104 ++++++++++++------ 3 files changed, 86 insertions(+), 44 deletions(-) diff --git a/osu.Game/Collections/ManageCollectionsDialog.cs b/osu.Game/Collections/ManageCollectionsDialog.cs index 0396fd531c..11d50f3ce4 100644 --- a/osu.Game/Collections/ManageCollectionsDialog.cs +++ b/osu.Game/Collections/ManageCollectionsDialog.cs @@ -24,7 +24,7 @@ namespace osu.Game.Collections protected override string PopInSampleName => @"UI/overlay-big-pop-in"; protected override string PopOutSampleName => @"UI/overlay-big-pop-out"; - private IDisposable? audioDucker; + private IDisposable? duckOperation; [Resolved] private MusicController? musicController { get; set; } @@ -120,12 +120,17 @@ namespace osu.Game.Collections protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); - audioDucker?.Dispose(); + duckOperation?.Dispose(); } protected override void PopIn() { - audioDucker = musicController?.Duck(100, 1f, unduckDuration: 100); + duckOperation = musicController?.Duck(new DuckParameters + { + DuckDuration = 100, + DuckVolumeTo = 1, + RestoreDuration = 100, + }); this.FadeIn(enter_duration, Easing.OutQuint); this.ScaleTo(0.9f).Then().ScaleTo(1f, enter_duration, Easing.OutQuint); @@ -135,7 +140,7 @@ namespace osu.Game.Collections { base.PopOut(); - audioDucker?.Dispose(); + duckOperation?.Dispose(); this.FadeOut(exit_duration, Easing.OutQuint); this.ScaleTo(0.9f, exit_duration); diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs index 7c52081053..97d77ae2d3 100644 --- a/osu.Game/Overlays/DialogOverlay.cs +++ b/osu.Game/Overlays/DialogOverlay.cs @@ -32,7 +32,7 @@ namespace osu.Game.Overlays || dialogContainer.Children.Count > 0; [CanBeNull] - private IDisposable audioDucker; + private IDisposable duckOperation; public DialogOverlay() { @@ -53,7 +53,7 @@ namespace osu.Game.Overlays protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); - audioDucker?.Dispose(); + duckOperation?.Dispose(); } public void Push(PopupDialog dialog) @@ -106,13 +106,18 @@ namespace osu.Game.Overlays protected override void PopIn() { - audioDucker = musicController.Duck(100, 1f, unduckDuration: 100); + duckOperation = musicController?.Duck(new DuckParameters + { + DuckDuration = 100, + DuckVolumeTo = 1, + RestoreDuration = 100, + }); } protected override void PopOut() { base.PopOut(); - audioDucker?.Dispose(); + duckOperation?.Dispose(); // PopOut gets called initially, but we only want to hide dialog when we have been loaded and are present. if (IsLoaded && CurrentDialog?.State.Value == Visibility.Visible) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 94078a3dec..cd770bef28 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -8,7 +8,6 @@ using osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Audio.Track; using osu.Framework.Bindables; -using osu.Framework.Extensions.ObjectExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Audio; using osu.Framework.Graphics.Containers; @@ -263,59 +262,53 @@ namespace osu.Game.Overlays /// /// Attenuates the volume and/or filters the currently playing track. /// - /// Duration of the ducking transition, in ms. - /// Level to drop volume to (1.0 = 100%). - /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. - /// Easing for the ducking transition. - /// Duration of the unducking transition, in ms. - /// Easing for the unducking transition. - public IDisposable? Duck(int duration = 0, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, Easing easing = Easing.Out, int unduckDuration = 500, Easing unduckEasing = Easing.In) + public IDisposable? Duck(DuckParameters? parameters = null) { + parameters ??= new DuckParameters(); + if (audioDuckActive) return null; audioDuckActive = true; Schedule(() => { - if (duckCutoffTo.IsNotNull()) - audioDuckFilter?.CutoffTo((int)duckCutoffTo, duration, easing); + if (parameters.DuckCutoffTo != null) + audioDuckFilter?.CutoffTo(parameters.DuckCutoffTo.Value, parameters.DuckDuration, parameters.DuckEasing); - this.TransformBindableTo(audioDuckVolume, duckVolumeTo, duration, easing); + this.TransformBindableTo(audioDuckVolume, parameters.DuckVolumeTo, parameters.DuckDuration, parameters.DuckEasing); }); - return new InvokeOnDisposal(() => unduck(unduckDuration, unduckEasing)); + return new InvokeOnDisposal(restoreDucking); + + void restoreDucking() + { + if (!audioDuckActive) return; + + audioDuckActive = false; + + Schedule(() => + { + audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, parameters.RestoreDuration, parameters.RestoreEasing); + this.TransformBindableTo(audioDuckVolume, 1, parameters.RestoreDuration, parameters.RestoreEasing); + }); + } } /// - /// A convenience method that ducks the currently playing track, then after a delay, unducks it. + /// A convenience method that ducks the currently playing track, then after a delay, restores automatically. /// - /// Delay after audio is ducked before unducking begins, in ms. - /// Duration of the unducking transition, in ms. - /// Easing for the unducking transition. - /// Level to drop volume to (1.0 = 100%). - /// Cutoff frequency to drop `AudioFilter` to. Use `null` to skip filter effect. - /// Duration of the ducking transition, in ms. - /// Easing for the ducking transition. - public void DuckMomentarily(int delay, int unduckDuration = 500, Easing unduckEasing = Easing.In, float duckVolumeTo = 0.25f, int? duckCutoffTo = 300, int duckDuration = 0, - Easing duckEasing = Easing.Out) + /// A delay in milliseconds which defines how long to delay restoration after ducking completes. + /// Parameters defining the ducking operation. + public void DuckMomentarily(double delayUntilRestore, DuckParameters? parameters = null) { - if (audioDuckActive) return; + parameters ??= new DuckParameters(); - Duck(duckDuration, duckVolumeTo, duckCutoffTo, duckEasing); - Scheduler.AddDelayed(() => unduck(unduckDuration, unduckEasing), delay); - } + IDisposable? duckOperation = Duck(parameters); - private void unduck(int duration, Easing easing) - { - if (!audioDuckActive) return; + if (duckOperation == null) + return; - audioDuckActive = false; - - Schedule(() => - { - audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, duration, easing); - this.TransformBindableTo(audioDuckVolume, 1, duration, easing); - }); + Scheduler.AddDelayed(() => duckOperation.Dispose(), delayUntilRestore); } private bool next() @@ -491,6 +484,45 @@ namespace osu.Game.Overlays } } + public record DuckParameters + { + /// + /// The duration of the ducking transition in milliseconds. + /// Defaults to no duration (immediate ducking). + /// + public double DuckDuration = 0; + + /// + /// The final volume which should be reached during ducking, when 0 is silent and 1 is original volume. + /// Defaults to 25%. + /// + public float DuckVolumeTo = 0.25f; + + /// + /// The low-pass cutoff frequency which should be reached during ducking. Use `null` to skip filter effect. + /// Defaults to 300 Hz. + /// + public int? DuckCutoffTo = 300; + + /// + /// The easing curve to be applied during ducking. + /// Defaults to . + /// + public Easing DuckEasing = Easing.Out; + + /// + /// The duration of the restoration transition in milliseconds. + /// Defaults to 500 ms. + /// + public double RestoreDuration = 500; + + /// + /// The easing curve to be applied during restoration. + /// Defaults to . + /// + public Easing RestoreEasing = Easing.In; + } + public enum TrackChangeDirection { None, From 20ba6ca867477ad45ab296013fdda94ea820ba3f Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 15:11:11 +0900 Subject: [PATCH 34/60] Add mention of return type for `Duck` method --- osu.Game/Overlays/MusicController.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index cd770bef28..fb8ba988a7 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -262,6 +262,7 @@ namespace osu.Game.Overlays /// /// Attenuates the volume and/or filters the currently playing track. /// + /// A which will restore the duck operation when disposed, or null if another duck operation was already in progress. public IDisposable? Duck(DuckParameters? parameters = null) { parameters ??= new DuckParameters(); From 717f7ba9f01d0f2ec8a78c71b86c8433c1f8b2c4 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 18:12:40 +0900 Subject: [PATCH 35/60] Better support multiple concurrent ducking operations --- osu.Game/Overlays/MusicController.cs | 56 ++++++++++++++-------------- 1 file changed, 27 insertions(+), 29 deletions(-) diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index fb8ba988a7..637fcb57e2 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -3,6 +3,7 @@ using System; using System.Collections.Generic; +using System.Diagnostics; using System.Linq; using osu.Framework.Allocation; using osu.Framework.Audio; @@ -62,8 +63,7 @@ namespace osu.Game.Overlays private readonly BindableDouble audioDuckVolume = new BindableDouble(1); - private AudioFilter? audioDuckFilter; - private bool audioDuckActive; + private AudioFilter audioDuckFilter = null!; [BackgroundDependencyLoader] private void load(AudioManager audio) @@ -259,40 +259,41 @@ namespace osu.Game.Overlays onSuccess?.Invoke(); }); + private readonly List duckOperations = new List(); + /// - /// Attenuates the volume and/or filters the currently playing track. + /// Applies ducking, attenuating the volume and/or low-pass cutoff of the currently playing track to make headroom for effects (or just to apply an effect). /// - /// A which will restore the duck operation when disposed, or null if another duck operation was already in progress. - public IDisposable? Duck(DuckParameters? parameters = null) + /// A which will restore the duck operation when disposed. + public IDisposable Duck(DuckParameters? parameters = null) { parameters ??= new DuckParameters(); - if (audioDuckActive) return null; + if (duckOperations.Contains(parameters)) + throw new ArgumentException("Ducking has already been applied for the provided parameters.", nameof(parameters)); - audioDuckActive = true; + duckOperations.Add(parameters); - Schedule(() => - { - if (parameters.DuckCutoffTo != null) - audioDuckFilter?.CutoffTo(parameters.DuckCutoffTo.Value, parameters.DuckDuration, parameters.DuckEasing); + DuckParameters volumeOperation = duckOperations.MinBy(p => p.DuckVolumeTo)!; + DuckParameters lowPassOperation = duckOperations.MinBy(p => p.DuckCutoffTo)!; - this.TransformBindableTo(audioDuckVolume, parameters.DuckVolumeTo, parameters.DuckDuration, parameters.DuckEasing); - }); + audioDuckFilter.CutoffTo(lowPassOperation.DuckCutoffTo, lowPassOperation.DuckDuration, lowPassOperation.DuckEasing); + this.TransformBindableTo(audioDuckVolume, volumeOperation.DuckVolumeTo, volumeOperation.DuckDuration, volumeOperation.DuckEasing); return new InvokeOnDisposal(restoreDucking); - void restoreDucking() + void restoreDucking() => Schedule(() => { - if (!audioDuckActive) return; + Debug.Assert(duckOperations.Contains(parameters)); + duckOperations.Remove(parameters); - audioDuckActive = false; + DuckParameters? restoreVolumeOperation = duckOperations.MinBy(p => p.DuckVolumeTo); + DuckParameters? restoreLowPassOperation = duckOperations.MinBy(p => p.DuckCutoffTo); - Schedule(() => - { - audioDuckFilter?.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, parameters.RestoreDuration, parameters.RestoreEasing); - this.TransformBindableTo(audioDuckVolume, 1, parameters.RestoreDuration, parameters.RestoreEasing); - }); - } + // If another duck operation is in the list, restore ducking to its level, else reset back to defaults. + audioDuckFilter.CutoffTo(restoreLowPassOperation?.DuckCutoffTo ?? AudioFilter.MAX_LOWPASS_CUTOFF, parameters.RestoreDuration, parameters.RestoreEasing); + this.TransformBindableTo(audioDuckVolume, restoreVolumeOperation?.DuckVolumeTo ?? 1, parameters.RestoreDuration, parameters.RestoreEasing); + }); } /// @@ -304,10 +305,7 @@ namespace osu.Game.Overlays { parameters ??= new DuckParameters(); - IDisposable? duckOperation = Duck(parameters); - - if (duckOperation == null) - return; + IDisposable duckOperation = Duck(parameters); Scheduler.AddDelayed(() => duckOperation.Dispose(), delayUntilRestore); } @@ -485,7 +483,7 @@ namespace osu.Game.Overlays } } - public record DuckParameters + public class DuckParameters { /// /// The duration of the ducking transition in milliseconds. @@ -500,10 +498,10 @@ namespace osu.Game.Overlays public float DuckVolumeTo = 0.25f; /// - /// The low-pass cutoff frequency which should be reached during ducking. Use `null` to skip filter effect. + /// The low-pass cutoff frequency which should be reached during ducking. If not required, set to . /// Defaults to 300 Hz. /// - public int? DuckCutoffTo = 300; + public int DuckCutoffTo = 300; /// /// The easing curve to be applied during ducking. From 65418aca1adf4ec167bb0ea3f27cad016daa4ac5 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 18:27:46 +0900 Subject: [PATCH 36/60] Add basic test coverage --- .../Visual/Menus/TestAudioDucking.cs | 134 ++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 osu.Game.Tests/Visual/Menus/TestAudioDucking.cs diff --git a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs new file mode 100644 index 0000000000..1639912d29 --- /dev/null +++ b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs @@ -0,0 +1,134 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System; +using NUnit.Framework; +using osu.Game.Audio.Effects; +using osu.Game.Overlays; + +namespace osu.Game.Tests.Visual.Menus +{ + public partial class TestSceneAudioDucking : OsuGameTestScene + { + [Test] + public void TestMomentaryDuck() + { + AddStep("duck momentarily", () => Game.MusicController.DuckMomentarily(1000, new DuckParameters + { + DuckDuration = 300, + })); + } + + [Test] + public void TestMultipleDucks() + { + IDisposable duckOp1 = null!; + IDisposable duckOp2 = null!; + + double normalVolume = 1; + + AddStep("get initial volume", () => + { + normalVolume = Game.Audio.Tracks.AggregateVolume.Value; + }); + + AddStep("duck one", () => + { + duckOp1 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 0.5f, + }); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + + AddStep("duck two", () => + { + duckOp2 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 0.2f, + }); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + + AddStep("restore two", () => duckOp2.Dispose()); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + + AddStep("restore one", () => duckOp1.Dispose()); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(float.Epsilon)); + } + + [Test] + public void TestMultipleDucksReverseOrder() + { + IDisposable duckOp1 = null!; + IDisposable duckOp2 = null!; + + double normalVolume = 1; + + AddStep("get initial volume", () => + { + normalVolume = Game.Audio.Tracks.AggregateVolume.Value; + }); + + AddStep("duck one", () => + { + duckOp1 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 0.5f, + }); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + + AddStep("duck two", () => + { + duckOp2 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 0.2f, + }); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + + AddStep("restore one", () => duckOp1.Dispose()); + + // reverse order, less extreme duck removed so won't change + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + + AddStep("restore two", () => duckOp2.Dispose()); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(float.Epsilon)); + } + + [Test] + public void TestMultipleDucksDifferentPieces() + { + IDisposable duckOp1 = null!; + IDisposable duckOp2 = null!; + + AddStep("duck volume", () => + { + duckOp1 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 0.2f, + DuckCutoffTo = AudioFilter.MAX_LOWPASS_CUTOFF, + DuckDuration = 500, + }); + }); + + AddStep("duck lowpass", () => + { + duckOp2 = Game.MusicController.Duck(new DuckParameters + { + DuckVolumeTo = 1, + DuckCutoffTo = 300, + DuckDuration = 500, + }); + }); + + AddStep("restore lowpass", () => duckOp2.Dispose()); + AddStep("restore volume", () => duckOp1.Dispose()); + } + } +} From 7efb4ce30a0d50a16503ce0a75d24db5a961be75 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 18:36:40 +0900 Subject: [PATCH 37/60] Fix multiple disposals resulting in assert being hit --- osu.Game.Tests/Visual/Menus/TestAudioDucking.cs | 10 ++++++++++ osu.Game/Overlays/MusicController.cs | 5 ++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs index 1639912d29..e704fc0e83 100644 --- a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs +++ b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs @@ -101,6 +101,16 @@ namespace osu.Game.Tests.Visual.Menus AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(float.Epsilon)); } + [Test] + public void TestMultipleDisposalIsNoop() + { + IDisposable duckOp1 = null!; + + AddStep("duck", () => duckOp1 = Game.MusicController.Duck()); + AddStep("restore", () => duckOp1.Dispose()); + AddStep("restore", () => duckOp1.Dispose()); + } + [Test] public void TestMultipleDucksDifferentPieces() { diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 637fcb57e2..8fa77b6153 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -3,7 +3,6 @@ using System; using System.Collections.Generic; -using System.Diagnostics; using System.Linq; using osu.Framework.Allocation; using osu.Framework.Audio; @@ -284,8 +283,8 @@ namespace osu.Game.Overlays void restoreDucking() => Schedule(() => { - Debug.Assert(duckOperations.Contains(parameters)); - duckOperations.Remove(parameters); + if (!duckOperations.Remove(parameters)) + return; DuckParameters? restoreVolumeOperation = duckOperations.MinBy(p => p.DuckVolumeTo); DuckParameters? restoreLowPassOperation = duckOperations.MinBy(p => p.DuckCutoffTo); From 5907e0d1eb590dfbd55f79843dd31a041d78f3c0 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Fri, 5 Jul 2024 18:38:24 +0900 Subject: [PATCH 38/60] Make `DuckDuration` non-zero by default --- osu.Game.Tests/Visual/Menus/TestAudioDucking.cs | 5 +---- osu.Game/Collections/ManageCollectionsDialog.cs | 2 +- osu.Game/Overlays/DialogOverlay.cs | 2 +- osu.Game/Overlays/MusicController.cs | 4 ++-- osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs | 2 +- 5 files changed, 6 insertions(+), 9 deletions(-) diff --git a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs index e704fc0e83..459bdd3e2e 100644 --- a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs +++ b/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs @@ -13,10 +13,7 @@ namespace osu.Game.Tests.Visual.Menus [Test] public void TestMomentaryDuck() { - AddStep("duck momentarily", () => Game.MusicController.DuckMomentarily(1000, new DuckParameters - { - DuckDuration = 300, - })); + AddStep("duck momentarily", () => Game.MusicController.DuckMomentarily(1000)); } [Test] diff --git a/osu.Game/Collections/ManageCollectionsDialog.cs b/osu.Game/Collections/ManageCollectionsDialog.cs index 11d50f3ce4..9f8158af53 100644 --- a/osu.Game/Collections/ManageCollectionsDialog.cs +++ b/osu.Game/Collections/ManageCollectionsDialog.cs @@ -127,8 +127,8 @@ namespace osu.Game.Collections { duckOperation = musicController?.Duck(new DuckParameters { - DuckDuration = 100, DuckVolumeTo = 1, + DuckDuration = 100, RestoreDuration = 100, }); diff --git a/osu.Game/Overlays/DialogOverlay.cs b/osu.Game/Overlays/DialogOverlay.cs index 97d77ae2d3..4e7aff84bc 100644 --- a/osu.Game/Overlays/DialogOverlay.cs +++ b/osu.Game/Overlays/DialogOverlay.cs @@ -108,8 +108,8 @@ namespace osu.Game.Overlays { duckOperation = musicController?.Duck(new DuckParameters { - DuckDuration = 100, DuckVolumeTo = 1, + DuckDuration = 100, RestoreDuration = 100, }); } diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index 8fa77b6153..c4817a8f26 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -486,9 +486,9 @@ namespace osu.Game.Overlays { /// /// The duration of the ducking transition in milliseconds. - /// Defaults to no duration (immediate ducking). + /// Defaults to 100 ms. /// - public double DuckDuration = 0; + public double DuckDuration = 100; /// /// The final volume which should be reached during ducking, when 0 is silent and 1 is original volume. diff --git a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs index 796477f9f6..05ab505417 100644 --- a/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs +++ b/osu.Game/Overlays/Toolbar/ToolbarRulesetSelector.cs @@ -122,7 +122,7 @@ namespace osu.Game.Overlays.Toolbar rulesetSelectionChannel[r.NewValue] = channel; channel.Play(); - musicController?.DuckMomentarily(500); + musicController?.DuckMomentarily(500, new DuckParameters { DuckDuration = 0 }); } public override bool HandleNonPositionalInput => !Current.Disabled && base.HandleNonPositionalInput; From 2bfa03c6d83b321bedcb6a2b659b692548f0490a Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 07:37:42 +0300 Subject: [PATCH 39/60] Rename test scene file --- .../Menus/{TestAudioDucking.cs => TestSceneAudioDucking.cs} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename osu.Game.Tests/Visual/Menus/{TestAudioDucking.cs => TestSceneAudioDucking.cs} (100%) diff --git a/osu.Game.Tests/Visual/Menus/TestAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs similarity index 100% rename from osu.Game.Tests/Visual/Menus/TestAudioDucking.cs rename to osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs From 0067450b226d06d5812e4d836a64e017ba049727 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Mon, 8 Jul 2024 13:47:04 +0900 Subject: [PATCH 40/60] Change volume parameter to `double` --- osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs | 10 +++++----- osu.Game/Overlays/MusicController.cs | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs index 459bdd3e2e..20549018e0 100644 --- a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs +++ b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs @@ -33,7 +33,7 @@ namespace osu.Game.Tests.Visual.Menus { duckOp1 = Game.MusicController.Duck(new DuckParameters { - DuckVolumeTo = 0.5f, + DuckVolumeTo = 0.5, }); }); @@ -43,7 +43,7 @@ namespace osu.Game.Tests.Visual.Menus { duckOp2 = Game.MusicController.Duck(new DuckParameters { - DuckVolumeTo = 0.2f, + DuckVolumeTo = 0.2, }); }); @@ -73,7 +73,7 @@ namespace osu.Game.Tests.Visual.Menus { duckOp1 = Game.MusicController.Duck(new DuckParameters { - DuckVolumeTo = 0.5f, + DuckVolumeTo = 0.5, }); }); @@ -83,7 +83,7 @@ namespace osu.Game.Tests.Visual.Menus { duckOp2 = Game.MusicController.Duck(new DuckParameters { - DuckVolumeTo = 0.2f, + DuckVolumeTo = 0.2, }); }); @@ -118,7 +118,7 @@ namespace osu.Game.Tests.Visual.Menus { duckOp1 = Game.MusicController.Duck(new DuckParameters { - DuckVolumeTo = 0.2f, + DuckVolumeTo = 0.2, DuckCutoffTo = AudioFilter.MAX_LOWPASS_CUTOFF, DuckDuration = 500, }); diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index c4817a8f26..a01f3bfa5f 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -494,7 +494,7 @@ namespace osu.Game.Overlays /// The final volume which should be reached during ducking, when 0 is silent and 1 is original volume. /// Defaults to 25%. /// - public float DuckVolumeTo = 0.25f; + public double DuckVolumeTo = 0.25; /// /// The low-pass cutoff frequency which should be reached during ducking. If not required, set to . From aa36a844be987d50ff1fe4a79645fc65e3eb3441 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Mon, 8 Jul 2024 13:49:25 +0900 Subject: [PATCH 41/60] Reduce precision requirement for tests --- .../Visual/Menus/TestSceneAudioDucking.cs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs index 20549018e0..a7ec7f5bdc 100644 --- a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs +++ b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs @@ -37,7 +37,7 @@ namespace osu.Game.Tests.Visual.Menus }); }); - AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); AddStep("duck two", () => { @@ -47,13 +47,13 @@ namespace osu.Game.Tests.Visual.Menus }); }); - AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(0.01)); AddStep("restore two", () => duckOp2.Dispose()); - AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); AddStep("restore one", () => duckOp1.Dispose()); - AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(float.Epsilon)); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(0.01)); } [Test] @@ -77,7 +77,7 @@ namespace osu.Game.Tests.Visual.Menus }); }); - AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(float.Epsilon)); + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); AddStep("duck two", () => { @@ -87,15 +87,15 @@ namespace osu.Game.Tests.Visual.Menus }); }); - AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(0.01)); AddStep("restore one", () => duckOp1.Dispose()); // reverse order, less extreme duck removed so won't change - AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(float.Epsilon)); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.2f).Within(0.01)); AddStep("restore two", () => duckOp2.Dispose()); - AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(float.Epsilon)); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(0.01)); } [Test] From 3650f3c47978244befd871e7ae705ae033d50288 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Mon, 8 Jul 2024 13:52:40 +0900 Subject: [PATCH 42/60] Allow multiple ducks with same parameters --- .../Visual/Menus/TestSceneAudioDucking.cs | 39 +++++++++++++++++++ osu.Game/Overlays/MusicController.cs | 3 -- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs index a7ec7f5bdc..8d20d8e0d5 100644 --- a/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs +++ b/osu.Game.Tests/Visual/Menus/TestSceneAudioDucking.cs @@ -56,6 +56,45 @@ namespace osu.Game.Tests.Visual.Menus AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(0.01)); } + [Test] + public void TestMultipleDucksSameParameters() + { + var duckParameters = new DuckParameters + { + DuckVolumeTo = 0.5, + }; + + IDisposable duckOp1 = null!; + IDisposable duckOp2 = null!; + + double normalVolume = 1; + + AddStep("get initial volume", () => + { + normalVolume = Game.Audio.Tracks.AggregateVolume.Value; + }); + + AddStep("duck one", () => + { + duckOp1 = Game.MusicController.Duck(duckParameters); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); + + AddStep("duck two", () => + { + duckOp2 = Game.MusicController.Duck(duckParameters); + }); + + AddUntilStep("wait for duck to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); + + AddStep("restore two", () => duckOp2.Dispose()); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume * 0.5f).Within(0.01)); + + AddStep("restore one", () => duckOp1.Dispose()); + AddUntilStep("wait for restore to complete", () => Game.Audio.Tracks.AggregateVolume.Value, () => Is.EqualTo(normalVolume).Within(0.01)); + } + [Test] public void TestMultipleDucksReverseOrder() { diff --git a/osu.Game/Overlays/MusicController.cs b/osu.Game/Overlays/MusicController.cs index a01f3bfa5f..116e60a014 100644 --- a/osu.Game/Overlays/MusicController.cs +++ b/osu.Game/Overlays/MusicController.cs @@ -268,9 +268,6 @@ namespace osu.Game.Overlays { parameters ??= new DuckParameters(); - if (duckOperations.Contains(parameters)) - throw new ArgumentException("Ducking has already been applied for the provided parameters.", nameof(parameters)); - duckOperations.Add(parameters); DuckParameters volumeOperation = duckOperations.MinBy(p => p.DuckVolumeTo)!; From 0c5a1410d3395cb712c3f1b05c2f42296c6d7bdb Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 07:51:17 +0300 Subject: [PATCH 43/60] Add fade transition to content during open/close --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index f214bcb3a1..1553f37878 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -6,6 +6,7 @@ using System.Collections.Generic; using System.Linq; using osu.Framework.Allocation; using osu.Framework.Bindables; +using osu.Framework.Extensions.Color4Extensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Effects; @@ -18,6 +19,7 @@ using osu.Game.Graphics.Containers; using osu.Game.Input.Bindings; using osu.Game.Rulesets.Mods; using osuTK; +using osuTK.Graphics; namespace osu.Game.Overlays.Mods { @@ -75,6 +77,7 @@ namespace osu.Game.Overlays.Mods Offset = new Vector2(0f, 5f), Radius = 20f, Roundness = 5f, + Colour = Color4.Black.Opacity(0.25f), }, Expanded = { BindTarget = Expanded }, Children = new Drawable[] @@ -161,13 +164,13 @@ namespace osu.Game.Overlays.Mods content.AutoSizeDuration = 400; content.AutoSizeEasing = Easing.OutQuint; content.AutoSizeAxes = Axes.Y; - content.FadeEdgeEffectTo(0.25f, 120, Easing.OutQuint); + content.FadeIn(120, Easing.OutQuint); } else { content.AutoSizeAxes = Axes.None; content.ResizeHeightTo(header_height, 400, Easing.OutQuint); - content.FadeEdgeEffectTo(0f, 400, Easing.OutQuint); + content.FadeOut(400, Easing.OutSine); } } From a0ffe9bcbc014940f579ef4ff81aa24b5eb57878 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 07:58:40 +0300 Subject: [PATCH 44/60] Remove unnecessary `HandlePositionalInput` override --- osu.Game/Overlays/Mods/ModCustomisationHeader.cs | 2 -- 1 file changed, 2 deletions(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs index 2887b53548..42bc9f16b1 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs @@ -18,8 +18,6 @@ namespace osu.Game.Overlays.Mods { public partial class ModCustomisationHeader : OsuHoverContainer { - public override bool HandlePositionalInput => true; - private Box background = null!; private SpriteIcon icon = null!; From 22f2f8369521abf943db38387ed173d884f6b0ea Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:07:45 +0300 Subject: [PATCH 45/60] Rescale chevron up and down instead --- osu.Game/Overlays/Mods/ModCustomisationHeader.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs index 42bc9f16b1..bf10e13515 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationHeader.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationHeader.cs @@ -88,7 +88,7 @@ namespace osu.Game.Overlays.Mods Expanded.BindValueChanged(v => { - icon.RotateTo(v.NewValue ? 180 : 0); + icon.ScaleTo(v.NewValue ? new Vector2(1, -1) : Vector2.One, 300, Easing.OutQuint); }, true); } } From 5223e0aeaef1ac2d05fbca542f5efa5527d9fb39 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:31:33 +0300 Subject: [PATCH 46/60] Use scale instead of rotation for overlay scroll button --- osu.Game/Overlays/OverlayScrollContainer.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/OverlayScrollContainer.cs b/osu.Game/Overlays/OverlayScrollContainer.cs index 9ff0a65652..a99cf08abb 100644 --- a/osu.Game/Overlays/OverlayScrollContainer.cs +++ b/osu.Game/Overlays/OverlayScrollContainer.cs @@ -163,7 +163,7 @@ namespace osu.Game.Overlays LastScrollTarget.BindValueChanged(target => { - spriteIcon.RotateTo(target.NewValue != null ? 180 : 0, fade_duration, Easing.OutQuint); + spriteIcon.ScaleTo(target.NewValue != null ? new Vector2(1f, -1f) : Vector2.One, fade_duration, Easing.OutQuint); TooltipText = target.NewValue != null ? CommonStrings.ButtonsBackToPrevious : CommonStrings.ButtonsBackToTop; }, true); } From be039b85adef209ec7020b1e7c767fce10f55374 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:32:29 +0300 Subject: [PATCH 47/60] Use scale instead of rotation in profile cover toggle button --- .../Overlays/Profile/Header/Components/ToggleCoverButton.cs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/osu.Game/Overlays/Profile/Header/Components/ToggleCoverButton.cs b/osu.Game/Overlays/Profile/Header/Components/ToggleCoverButton.cs index 9171d5de7d..b2d024c1d7 100644 --- a/osu.Game/Overlays/Profile/Header/Components/ToggleCoverButton.cs +++ b/osu.Game/Overlays/Profile/Header/Components/ToggleCoverButton.cs @@ -50,12 +50,13 @@ namespace osu.Game.Overlays.Profile.Header.Components { Anchor = Anchor.Centre, Origin = Anchor.Centre, - Size = new Vector2(10.5f, 12) + Size = new Vector2(10.5f, 12), + Icon = FontAwesome.Solid.ChevronDown, }; CoverExpanded.BindValueChanged(visible => updateState(visible.NewValue), true); } - private void updateState(bool detailsVisible) => icon.Icon = detailsVisible ? FontAwesome.Solid.ChevronUp : FontAwesome.Solid.ChevronDown; + private void updateState(bool detailsVisible) => icon.ScaleTo(detailsVisible ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); } } From dc630ddc9d7ebcc9c338894a42579dff0321cbd8 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:45:44 +0300 Subject: [PATCH 48/60] Use scale instead of rotation in news month sidebar --- osu.Game/Overlays/News/Sidebar/MonthSection.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/News/Sidebar/MonthSection.cs b/osu.Game/Overlays/News/Sidebar/MonthSection.cs index 9a748b2001..26490c36c8 100644 --- a/osu.Game/Overlays/News/Sidebar/MonthSection.cs +++ b/osu.Game/Overlays/News/Sidebar/MonthSection.cs @@ -118,7 +118,7 @@ namespace osu.Game.Overlays.News.Sidebar Expanded.BindValueChanged(open => { - icon.Scale = new Vector2(1, open.NewValue ? -1 : 1); + icon.ScaleTo(open.NewValue ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); }, true); } } From 4c2ae07eba8f66aec496ddec1a9c148f90bb124b Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:48:07 +0300 Subject: [PATCH 49/60] Use scale instead of rotation in `ChevronButton` (used in top-right of comments section) --- osu.Game/Overlays/Comments/Buttons/ChevronButton.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Comments/Buttons/ChevronButton.cs b/osu.Game/Overlays/Comments/Buttons/ChevronButton.cs index 45024f25db..3902f89688 100644 --- a/osu.Game/Overlays/Comments/Buttons/ChevronButton.cs +++ b/osu.Game/Overlays/Comments/Buttons/ChevronButton.cs @@ -24,6 +24,7 @@ namespace osu.Game.Overlays.Comments.Buttons Anchor = Anchor.Centre, Origin = Anchor.Centre, Size = new Vector2(12), + Icon = FontAwesome.Solid.ChevronDown }; } @@ -38,11 +39,12 @@ namespace osu.Game.Overlays.Comments.Buttons base.LoadComplete(); Action = Expanded.Toggle; Expanded.BindValueChanged(onExpandedChanged, true); + FinishTransforms(true); } private void onExpandedChanged(ValueChangedEvent expanded) { - icon.Icon = expanded.NewValue ? FontAwesome.Solid.ChevronUp : FontAwesome.Solid.ChevronDown; + icon.ScaleTo(expanded.NewValue ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); } } } From 58e236a2471f2f815f947fe5141d3feaa5046de8 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:48:52 +0300 Subject: [PATCH 50/60] Add transition to dropdown chevrons --- osu.Game/Collections/CollectionDropdown.cs | 2 +- .../Graphics/UserInterface/OsuDropdown.cs | 25 ++++++++++++++++--- .../Music/NowPlayingCollectionDropdown.cs | 4 +-- .../Overlays/Rankings/SpotlightSelector.cs | 2 +- 4 files changed, 25 insertions(+), 8 deletions(-) diff --git a/osu.Game/Collections/CollectionDropdown.cs b/osu.Game/Collections/CollectionDropdown.cs index c04689b097..6d8f65c257 100644 --- a/osu.Game/Collections/CollectionDropdown.cs +++ b/osu.Game/Collections/CollectionDropdown.cs @@ -163,7 +163,7 @@ namespace osu.Game.Collections public CollectionDropdownHeader() { Height = 25; - Icon.Size = new Vector2(16); + Chevron.Size = new Vector2(16); Foreground.Padding = new MarginPadding { Top = 4, Bottom = 4, Left = 8, Right = 4 }; } } diff --git a/osu.Game/Graphics/UserInterface/OsuDropdown.cs b/osu.Game/Graphics/UserInterface/OsuDropdown.cs index c8bb45b59d..562258f5b2 100644 --- a/osu.Game/Graphics/UserInterface/OsuDropdown.cs +++ b/osu.Game/Graphics/UserInterface/OsuDropdown.cs @@ -30,6 +30,12 @@ namespace osu.Game.Graphics.UserInterface protected override DropdownMenu CreateMenu() => new OsuDropdownMenu(); + public OsuDropdown() + { + if (Header is OsuDropdownHeader osuHeader) + osuHeader.Dropdown = this; + } + public bool OnPressed(KeyBindingPressEvent e) { if (e.Repeat) return false; @@ -307,7 +313,9 @@ namespace osu.Game.Graphics.UserInterface set => Text.Text = value; } - protected readonly SpriteIcon Icon; + protected readonly SpriteIcon Chevron; + + public OsuDropdown? Dropdown { get; set; } public OsuDropdownHeader() { @@ -341,7 +349,7 @@ namespace osu.Game.Graphics.UserInterface Origin = Anchor.CentreLeft, RelativeSizeAxes = Axes.X, }, - Icon = new SpriteIcon + Chevron = new SpriteIcon { Icon = FontAwesome.Solid.ChevronDown, Anchor = Anchor.CentreRight, @@ -365,6 +373,9 @@ namespace osu.Game.Graphics.UserInterface { base.LoadComplete(); + if (Dropdown != null) + Dropdown.Menu.StateChanged += _ => updateChevron(); + SearchBar.State.ValueChanged += _ => updateColour(); Enabled.BindValueChanged(_ => updateColour()); updateColour(); @@ -392,16 +403,22 @@ namespace osu.Game.Graphics.UserInterface if (SearchBar.State.Value == Visibility.Visible) { - Icon.Colour = hovered ? hoveredColour.Lighten(0.5f) : Colour4.White; + Chevron.Colour = hovered ? hoveredColour.Lighten(0.5f) : Colour4.White; Background.Colour = unhoveredColour; } else { - Icon.Colour = Color4.White; + Chevron.Colour = Color4.White; Background.Colour = hovered ? hoveredColour : unhoveredColour; } } + private void updateChevron() + { + bool open = Dropdown?.Menu.State == MenuState.Open; + Chevron.ScaleTo(open ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); + } + protected override DropdownSearchBar CreateSearchBar() => new OsuDropdownSearchBar { Padding = new MarginPadding { Right = 26 }, diff --git a/osu.Game/Overlays/Music/NowPlayingCollectionDropdown.cs b/osu.Game/Overlays/Music/NowPlayingCollectionDropdown.cs index fa9a2e3972..0f2e9400d9 100644 --- a/osu.Game/Overlays/Music/NowPlayingCollectionDropdown.cs +++ b/osu.Game/Overlays/Music/NowPlayingCollectionDropdown.cs @@ -53,8 +53,8 @@ namespace osu.Game.Overlays.Music { CornerRadius = 5; Height = 30; - Icon.Size = new Vector2(14); - Icon.Margin = new MarginPadding(0); + Chevron.Size = new Vector2(14); + Chevron.Margin = new MarginPadding(0); Foreground.Padding = new MarginPadding { Top = 4, Bottom = 4, Left = 10, Right = 10 }; EdgeEffect = new EdgeEffectParameters { diff --git a/osu.Game/Overlays/Rankings/SpotlightSelector.cs b/osu.Game/Overlays/Rankings/SpotlightSelector.cs index 190da04a5d..69dc8aba85 100644 --- a/osu.Game/Overlays/Rankings/SpotlightSelector.cs +++ b/osu.Game/Overlays/Rankings/SpotlightSelector.cs @@ -200,7 +200,7 @@ namespace osu.Game.Overlays.Rankings Text.Font = OsuFont.GetFont(size: 15); Text.Padding = new MarginPadding { Vertical = 1.5f }; // osu-web line-height difference compensation Foreground.Padding = new MarginPadding { Horizontal = 10, Vertical = 15 }; - Margin = Icon.Margin = new MarginPadding(0); + Margin = Chevron.Margin = new MarginPadding(0); } [BackgroundDependencyLoader] From 7dc901df11ec893cb45f19ad1a006d1a89cbc0d3 Mon Sep 17 00:00:00 2001 From: Salman Ahmed Date: Mon, 8 Jul 2024 08:54:05 +0300 Subject: [PATCH 51/60] Do not be lenient on nullability of dropdown --- osu.Game/Graphics/UserInterface/OsuDropdown.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/osu.Game/Graphics/UserInterface/OsuDropdown.cs b/osu.Game/Graphics/UserInterface/OsuDropdown.cs index 562258f5b2..71ae149cf6 100644 --- a/osu.Game/Graphics/UserInterface/OsuDropdown.cs +++ b/osu.Game/Graphics/UserInterface/OsuDropdown.cs @@ -1,6 +1,7 @@ // Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. +using System.Diagnostics; using System.Linq; using osu.Framework.Allocation; using osu.Framework.Audio; @@ -415,7 +416,8 @@ namespace osu.Game.Graphics.UserInterface private void updateChevron() { - bool open = Dropdown?.Menu.State == MenuState.Open; + Debug.Assert(Dropdown != null); + bool open = Dropdown.Menu.State == MenuState.Open; Chevron.ScaleTo(open ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); } From 95321469783c2e359c4d8efa8cead7b2e94c6b46 Mon Sep 17 00:00:00 2001 From: Joseph Madamba Date: Sun, 7 Jul 2024 23:12:20 -0700 Subject: [PATCH 52/60] Fix content overflowing to border The +2 for the top isn't really needed for the original purpose as content fades out now, but visually, having the header and content spacing looks more correct. --- osu.Game/Overlays/Mods/ModCustomisationPanel.cs | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs index 1553f37878..a1e64e8c49 100644 --- a/osu.Game/Overlays/Mods/ModCustomisationPanel.cs +++ b/osu.Game/Overlays/Mods/ModCustomisationPanel.cs @@ -27,6 +27,7 @@ namespace osu.Game.Overlays.Mods { private const float header_height = 42f; private const float content_vertical_padding = 20f; + private const float content_border_thickness = 2f; private Container content = null!; private OsuScrollContainer scrollContainer = null!; @@ -68,7 +69,7 @@ namespace osu.Game.Overlays.Mods { RelativeSizeAxes = Axes.X, BorderColour = colourProvider.Dark3, - BorderThickness = 2f, + BorderThickness = content_border_thickness, CornerRadius = 10f, Masking = true, EdgeEffect = new EdgeEffectParameters @@ -90,9 +91,11 @@ namespace osu.Game.Overlays.Mods scrollContainer = new OsuScrollContainer(Direction.Vertical) { RelativeSizeAxes = Axes.X, - // The +2f is a workaround for masking issues (see https://github.com/ppy/osu-framework/issues/1675#issuecomment-910023157) - // Note that this actually causes the full scroll range to be reduced by 2px at the bottom, but it's not really noticeable. - Margin = new MarginPadding { Top = header_height + 2f }, + Margin = new MarginPadding + { + Top = header_height + content_border_thickness, + Bottom = content_border_thickness + }, Child = sectionsFlow = new FillFlowContainer { RelativeSizeAxes = Axes.X, From 73d164e0d0d7861d6d81c361e271ea09116ba9a2 Mon Sep 17 00:00:00 2001 From: Joseph Madamba Date: Mon, 8 Jul 2024 00:30:16 -0700 Subject: [PATCH 53/60] Add chevron transition to `CommentRepliesButton` --- osu.Game/Overlays/Comments/Buttons/CommentRepliesButton.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Overlays/Comments/Buttons/CommentRepliesButton.cs b/osu.Game/Overlays/Comments/Buttons/CommentRepliesButton.cs index 400820ddd9..543ed7e722 100644 --- a/osu.Game/Overlays/Comments/Buttons/CommentRepliesButton.cs +++ b/osu.Game/Overlays/Comments/Buttons/CommentRepliesButton.cs @@ -89,7 +89,7 @@ namespace osu.Game.Overlays.Comments.Buttons background.Colour = colourProvider.Background2; } - protected void SetIconDirection(bool upwards) => icon.ScaleTo(new Vector2(1, upwards ? -1 : 1)); + protected void SetIconDirection(bool upwards) => icon.ScaleTo(upwards ? new Vector2(1f, -1f) : Vector2.One, 300, Easing.OutQuint); public void ToggleTextVisibility(bool visible) => text.FadeTo(visible ? 1 : 0, 200, Easing.OutQuint); From 257de9d08b01dbd56e3caa9a158d78c896c7cae8 Mon Sep 17 00:00:00 2001 From: Joseph Madamba Date: Mon, 8 Jul 2024 01:00:36 -0700 Subject: [PATCH 54/60] Fix arrow direction test --- .../Visual/UserInterface/TestSceneCommentRepliesButton.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneCommentRepliesButton.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneCommentRepliesButton.cs index eaaf40fb36..0aef56bc2e 100644 --- a/osu.Game.Tests/Visual/UserInterface/TestSceneCommentRepliesButton.cs +++ b/osu.Game.Tests/Visual/UserInterface/TestSceneCommentRepliesButton.cs @@ -47,9 +47,9 @@ namespace osu.Game.Tests.Visual.UserInterface public void TestArrowDirection() { AddStep("Set upwards", () => button.SetIconDirection(true)); - AddAssert("Icon facing upwards", () => button.Icon.Scale.Y == -1); + AddUntilStep("Icon facing upwards", () => button.Icon.Scale.Y == -1); AddStep("Set downwards", () => button.SetIconDirection(false)); - AddAssert("Icon facing downwards", () => button.Icon.Scale.Y == 1); + AddUntilStep("Icon facing downwards", () => button.Icon.Scale.Y == 1); } private partial class TestButton : CommentRepliesButton From 2ceedb0f93cfa2e263372113668c0d307cc34dd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Mon, 8 Jul 2024 11:04:15 +0200 Subject: [PATCH 55/60] Fix editor menus overflowing off screen Closes https://github.com/ppy/osu/issues/28750. Yes this is not the perfect change to fix this (which would probably be some framework change to take bounds of the parenting input manager into account). I really do not want to go there and would like to just fix this locally and move on. Due to the game-wide scaling container this sorta works for any resolution anyhow. --- .../Screens/Edit/Components/Menus/EditorMenuBar.cs | 10 ++++++++-- osu.Game/Screens/Edit/Editor.cs | 1 + 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs b/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs index 0e125d0ec0..ee954a7ea0 100644 --- a/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs +++ b/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs @@ -71,7 +71,10 @@ namespace osu.Game.Screens.Edit.Components.Menus }); } - protected override Framework.Graphics.UserInterface.Menu CreateSubMenu() => new SubMenu(); + protected override Framework.Graphics.UserInterface.Menu CreateSubMenu() => new SubMenu + { + MaxHeight = MaxHeight, + }; protected override DrawableMenuItem CreateDrawableMenuItem(MenuItem item) => new DrawableEditorBarMenuItem(item); @@ -143,7 +146,10 @@ namespace osu.Game.Screens.Edit.Components.Menus BackgroundColour = colourProvider.Background2; } - protected override Framework.Graphics.UserInterface.Menu CreateSubMenu() => new SubMenu(); + protected override Framework.Graphics.UserInterface.Menu CreateSubMenu() => new SubMenu + { + MaxHeight = MaxHeight, + }; protected override DrawableMenuItem CreateDrawableMenuItem(MenuItem item) { diff --git a/osu.Game/Screens/Edit/Editor.cs b/osu.Game/Screens/Edit/Editor.cs index c00b7ac4f2..2278af040f 100644 --- a/osu.Game/Screens/Edit/Editor.cs +++ b/osu.Game/Screens/Edit/Editor.cs @@ -343,6 +343,7 @@ namespace osu.Game.Screens.Edit Anchor = Anchor.CentreLeft, Origin = Anchor.CentreLeft, RelativeSizeAxes = Axes.Both, + MaxHeight = 600, Items = new[] { new MenuItem(CommonStrings.MenuBarFile) From db7774485a94c6c38914093d2a3fde7318c406f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Mon, 8 Jul 2024 11:14:32 +0200 Subject: [PATCH 56/60] Fix editor player crashing with UR counter present in skin Closes https://github.com/ppy/osu/issues/28764. --- osu.Game/Screens/Edit/GameplayTest/EditorPlayer.cs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/osu.Game/Screens/Edit/GameplayTest/EditorPlayer.cs b/osu.Game/Screens/Edit/GameplayTest/EditorPlayer.cs index 616d7a09b2..4377cc6219 100644 --- a/osu.Game/Screens/Edit/GameplayTest/EditorPlayer.cs +++ b/osu.Game/Screens/Edit/GameplayTest/EditorPlayer.cs @@ -72,7 +72,11 @@ namespace osu.Game.Screens.Edit.GameplayTest foreach (var hitObject in enumerateHitObjects(DrawableRuleset.Objects, editorState.Time)) { var judgement = hitObject.Judgement; - var result = new JudgementResult(hitObject, judgement) { Type = judgement.MaxResult }; + var result = new JudgementResult(hitObject, judgement) + { + Type = judgement.MaxResult, + GameplayRate = GameplayClockContainer.GetTrueGameplayRate(), + }; HealthProcessor.ApplyResult(result); ScoreProcessor.ApplyResult(result); From 910153c2e06c267819f78d225baae7720c0e17f1 Mon Sep 17 00:00:00 2001 From: Dean Herbert Date: Mon, 8 Jul 2024 19:32:28 +0900 Subject: [PATCH 57/60] Fix sizing / padding of collection dropdown header --- osu.Game/Collections/CollectionDropdown.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/osu.Game/Collections/CollectionDropdown.cs b/osu.Game/Collections/CollectionDropdown.cs index 6d8f65c257..1e47aff3ec 100644 --- a/osu.Game/Collections/CollectionDropdown.cs +++ b/osu.Game/Collections/CollectionDropdown.cs @@ -163,8 +163,8 @@ namespace osu.Game.Collections public CollectionDropdownHeader() { Height = 25; - Chevron.Size = new Vector2(16); - Foreground.Padding = new MarginPadding { Top = 4, Bottom = 4, Left = 8, Right = 4 }; + Chevron.Size = new Vector2(12); + Foreground.Padding = new MarginPadding { Top = 4, Bottom = 4, Left = 8, Right = 8 }; } } From 6433f29651855fe8a5379d8b8e8f9635b256a568 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Mon, 8 Jul 2024 13:15:24 +0200 Subject: [PATCH 58/60] Add failing test case --- .../Visual/Editing/TestSceneEditorClock.cs | 38 +++++++++++++------ 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs b/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs index ed58c59ff0..54cc86bc6b 100644 --- a/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs +++ b/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs @@ -1,10 +1,13 @@ // Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. +using System.Linq; using NUnit.Framework; using osu.Framework.Allocation; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; +using osu.Framework.Testing; +using osu.Game.Graphics.UserInterface; using osu.Game.Rulesets.Osu; using osu.Game.Screens.Edit; using osu.Game.Screens.Edit.Components; @@ -19,9 +22,10 @@ namespace osu.Game.Tests.Visual.Editing [Cached] private EditorBeatmap editorBeatmap = new EditorBeatmap(new TestBeatmap(new OsuRuleset().RulesetInfo)); - public TestSceneEditorClock() + [SetUpSteps] + public void SetUpSteps() { - Add(new FillFlowContainer + AddStep("create content", () => Add(new FillFlowContainer { RelativeSizeAxes = Axes.Both, Children = new Drawable[] @@ -39,19 +43,17 @@ namespace osu.Game.Tests.Visual.Editing Size = new Vector2(200, 100) } } + })); + AddStep("set working beatmap", () => + { + Beatmap.Disabled = false; + Beatmap.Value = CreateWorkingBeatmap(new OsuRuleset().RulesetInfo); + // ensure that music controller does not change this beatmap due to it + // completing naturally as part of the test. + Beatmap.Disabled = true; }); } - protected override void LoadComplete() - { - base.LoadComplete(); - - Beatmap.Value = CreateWorkingBeatmap(new OsuRuleset().RulesetInfo); - // ensure that music controller does not change this beatmap due to it - // completing naturally as part of the test. - Beatmap.Disabled = true; - } - [Test] public void TestStopAtTrackEnd() { @@ -102,6 +104,18 @@ namespace osu.Game.Tests.Visual.Editing AddUntilStep("time is clamped to track length", () => EditorClock.CurrentTime, () => Is.EqualTo(EditorClock.TrackLength)); } + [Test] + public void TestAdjustmentsRemovedOnDisposal() + { + AddStep("reset clock", () => EditorClock.Seek(0)); + + AddStep("set 0.25x speed", () => this.ChildrenOfType>().First().Current.Value = 0.25); + AddAssert("track has 0.25x tempo", () => Beatmap.Value.Track.AggregateTempo.Value, () => Is.EqualTo(0.25)); + + AddStep("dispose playback control", () => Clear(disposeChildren: true)); + AddAssert("track has 1x tempo", () => Beatmap.Value.Track.AggregateTempo.Value, () => Is.EqualTo(1)); + } + protected override void Dispose(bool isDisposing) { Beatmap.Disabled = false; From 0fe2c45e1d61fd18aadcfa52762a4600b9f952ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Mon, 8 Jul 2024 13:15:50 +0200 Subject: [PATCH 59/60] Fix editor playback control not removing correct adjustment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes https://github.com/ppy/osu/issues/28768. great job past me 🤦🤦🤦🤦🤦🤦🤦🤦🤦🤦🤦 --- osu.Game/Screens/Edit/Components/PlaybackControl.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/osu.Game/Screens/Edit/Components/PlaybackControl.cs b/osu.Game/Screens/Edit/Components/PlaybackControl.cs index 0546878788..6319dc892e 100644 --- a/osu.Game/Screens/Edit/Components/PlaybackControl.cs +++ b/osu.Game/Screens/Edit/Components/PlaybackControl.cs @@ -105,7 +105,7 @@ namespace osu.Game.Screens.Edit.Components protected override void Dispose(bool isDisposing) { - Track.Value?.RemoveAdjustment(AdjustableProperty.Frequency, tempoAdjustment); + Track.Value?.RemoveAdjustment(AdjustableProperty.Tempo, tempoAdjustment); base.Dispose(isDisposing); } From 2822ba23770e42d34f46425caeef6c2a061467a1 Mon Sep 17 00:00:00 2001 From: OliBomby Date: Mon, 8 Jul 2024 13:30:11 +0200 Subject: [PATCH 60/60] Fix CurrentTimeAccurate being inaccurate if seeking smoothly in the same frame and a transform is already active --- osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs | 11 +++++++++++ osu.Game/Screens/Edit/EditorClock.cs | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs b/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs index ed58c59ff0..b38c9abfb6 100644 --- a/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs +++ b/osu.Game.Tests/Visual/Editing/TestSceneEditorClock.cs @@ -102,6 +102,17 @@ namespace osu.Game.Tests.Visual.Editing AddUntilStep("time is clamped to track length", () => EditorClock.CurrentTime, () => Is.EqualTo(EditorClock.TrackLength)); } + [Test] + public void TestCurrentTimeDoubleTransform() + { + AddAssert("seek smoothly twice and current time is accurate", () => + { + EditorClock.SeekSmoothlyTo(1000); + EditorClock.SeekSmoothlyTo(2000); + return 2000 == EditorClock.CurrentTimeAccurate; + }); + } + protected override void Dispose(bool isDisposing) { Beatmap.Disabled = false; diff --git a/osu.Game/Screens/Edit/EditorClock.cs b/osu.Game/Screens/Edit/EditorClock.cs index d5ca6fc35e..773abaa737 100644 --- a/osu.Game/Screens/Edit/EditorClock.cs +++ b/osu.Game/Screens/Edit/EditorClock.cs @@ -154,7 +154,7 @@ namespace osu.Game.Screens.Edit /// The current time of this clock, include any active transform seeks performed via . /// public double CurrentTimeAccurate => - Transforms.OfType().FirstOrDefault()?.EndValue ?? CurrentTime; + Transforms.OfType().LastOrDefault()?.EndValue ?? CurrentTime; public double CurrentTime => underlyingClock.CurrentTime;