mirror of
https://github.com/ppy/osu.git
synced 2024-12-21 10:32:55 +08:00
457 lines
20 KiB
C#
457 lines
20 KiB
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
#nullable disable
|
|
|
|
using System.Threading;
|
|
using NUnit.Framework;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Audio;
|
|
using osu.Framework.Bindables;
|
|
using osu.Framework.Extensions;
|
|
using osu.Framework.Graphics;
|
|
using osu.Framework.Graphics.Sprites;
|
|
using osu.Framework.Input.Events;
|
|
using osu.Framework.Input.States;
|
|
using osu.Framework.Platform;
|
|
using osu.Framework.Screens;
|
|
using osu.Framework.Utils;
|
|
using osu.Game.Beatmaps;
|
|
using osu.Game.Configuration;
|
|
using osu.Game.Graphics;
|
|
using osu.Game.Graphics.Containers;
|
|
using osu.Game.Graphics.Sprites;
|
|
using osu.Game.Rulesets;
|
|
using osu.Game.Rulesets.Osu.Mods;
|
|
using osu.Game.Scoring;
|
|
using osu.Game.Screens;
|
|
using osu.Game.Screens.Backgrounds;
|
|
using osu.Game.Screens.Play;
|
|
using osu.Game.Screens.Play.PlayerSettings;
|
|
using osu.Game.Screens.Ranking;
|
|
using osu.Game.Screens.Select;
|
|
using osu.Game.Tests.Resources;
|
|
using osuTK;
|
|
using osuTK.Graphics;
|
|
|
|
namespace osu.Game.Tests.Visual.Background
|
|
{
|
|
[TestFixture]
|
|
public partial class TestSceneUserDimBackgrounds : ScreenTestScene
|
|
{
|
|
private DummySongSelect songSelect;
|
|
private TestPlayerLoader playerLoader;
|
|
private LoadBlockingTestPlayer player;
|
|
private BeatmapManager manager;
|
|
private RulesetStore rulesets;
|
|
|
|
[BackgroundDependencyLoader]
|
|
private void load(GameHost host, AudioManager audio)
|
|
{
|
|
Dependencies.Cache(rulesets = new RealmRulesetStore(Realm));
|
|
Dependencies.Cache(manager = new BeatmapManager(LocalStorage, Realm, null, audio, Resources, host, Beatmap.Default));
|
|
Dependencies.Cache(new OsuConfigManager(LocalStorage));
|
|
Dependencies.Cache(Realm);
|
|
|
|
manager.Import(TestResources.GetQuickTestBeatmapForImport()).WaitSafely();
|
|
|
|
Beatmap.SetDefault();
|
|
}
|
|
|
|
public override void SetUpSteps()
|
|
{
|
|
base.SetUpSteps();
|
|
|
|
AddStep("push song select", () => Stack.Push(songSelect = new DummySongSelect()));
|
|
}
|
|
|
|
/// <summary>
|
|
/// User settings should always be ignored on song select screen.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestUserSettingsIgnoredOnSongSelect()
|
|
{
|
|
setupUserSettings();
|
|
AddUntilStep("Screen is undimmed", () => songSelect.IsBackgroundUndimmed());
|
|
AddUntilStep("Screen using background blur", () => songSelect.IsBackgroundBlur());
|
|
performFullSetup();
|
|
AddStep("Exit to song select", () => player.Exit());
|
|
AddUntilStep("Screen is undimmed", () => songSelect.IsBackgroundUndimmed());
|
|
AddUntilStep("Screen using background blur", () => songSelect.IsBackgroundBlur());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if <see cref="PlayerLoader"/> properly triggers the visual settings preview when a user hovers over the visual settings panel.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestPlayerLoaderSettingsHover()
|
|
{
|
|
setupUserSettings();
|
|
AddStep("Start player loader", () => songSelect.Push(playerLoader = new TestPlayerLoader(player = new LoadBlockingTestPlayer { BlockLoad = true })));
|
|
AddUntilStep("Wait for Player Loader to load", () => playerLoader?.IsLoaded ?? false);
|
|
AddAssert("Background retained from song select", () =>
|
|
{
|
|
InputManager.MoveMouseTo(playerLoader);
|
|
return songSelect.IsBackgroundCurrent();
|
|
});
|
|
|
|
AddUntilStep("Screen is dimmed and blur applied", () =>
|
|
{
|
|
InputManager.MoveMouseTo(playerLoader.VisualSettingsPos);
|
|
return songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied();
|
|
});
|
|
|
|
AddStep("Stop background preview", () => InputManager.MoveMouseTo(playerLoader.ScreenPos));
|
|
AddUntilStep("Screen is undimmed and user blur removed", () => songSelect.IsBackgroundUndimmed() && songSelect.CheckBackgroundBlur(playerLoader.ExpectedBackgroundBlur));
|
|
}
|
|
|
|
/// <summary>
|
|
/// In the case of a user triggering the dim preview the instant player gets loaded, then moving the cursor off of the visual settings:
|
|
/// The OnHover of PlayerLoader will trigger, which could potentially cause visual settings to be unapplied unless checked for in PlayerLoader.
|
|
/// We need to check that in this scenario, the dim and blur is still properly applied after entering player.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestPlayerLoaderTransition()
|
|
{
|
|
performFullSetup();
|
|
AddStep("Trigger hover event", () => playerLoader.TriggerOnHover());
|
|
AddAssert("Background retained from song select", () => songSelect.IsBackgroundCurrent());
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Make sure the background is fully invisible (Alpha == 0) when the background should be disabled by the storyboard.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestStoryboardBackgroundVisibility()
|
|
{
|
|
performFullSetup();
|
|
AddAssert("Background retained from song select", () => songSelect.IsBackgroundCurrent());
|
|
createFakeStoryboard();
|
|
AddStep("Enable Storyboard", () =>
|
|
{
|
|
player.StoryboardReplacesBackground.Value = true;
|
|
player.StoryboardEnabled.Value = true;
|
|
});
|
|
AddUntilStep("Background is black, storyboard is visible", () => songSelect.IsBackgroundVisible() && songSelect.IsBackgroundBlack() && player.IsStoryboardVisible);
|
|
AddStep("Disable Storyboard", () =>
|
|
{
|
|
player.StoryboardReplacesBackground.Value = false;
|
|
player.StoryboardEnabled.Value = false;
|
|
});
|
|
AddUntilStep("Background is visible, storyboard is invisible", () => songSelect.IsBackgroundVisible() && !player.IsStoryboardVisible);
|
|
}
|
|
|
|
/// <summary>
|
|
/// When exiting player, the screen that it suspends/exits to needs to have a fully visible (Alpha == 1) background.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestStoryboardTransition()
|
|
{
|
|
performFullSetup();
|
|
createFakeStoryboard();
|
|
AddStep("Exit to song select", () => player.Exit());
|
|
AddUntilStep("Background is visible", () => songSelect.IsBackgroundVisible());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Ensure <see cref="UserDimContainer"/> is properly accepting user-defined visual changes for a background.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestDisableUserDimBackground()
|
|
{
|
|
performFullSetup();
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
AddStep("Disable user dim", () => songSelect.IgnoreUserSettings.Value = true);
|
|
AddUntilStep("Screen is undimmed and user blur removed", () => songSelect.IsBackgroundUndimmed() && songSelect.IsUserBlurDisabled());
|
|
AddStep("Enable user dim", () => songSelect.IgnoreUserSettings.Value = false);
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Ensure <see cref="UserDimContainer"/> is properly accepting user-defined visual changes for a storyboard.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestDisableUserDimStoryboard()
|
|
{
|
|
performFullSetup();
|
|
createFakeStoryboard();
|
|
AddStep("Enable Storyboard", () =>
|
|
{
|
|
player.StoryboardReplacesBackground.Value = true;
|
|
player.StoryboardEnabled.Value = true;
|
|
});
|
|
AddStep("Enable user dim", () => player.DimmableStoryboard.IgnoreUserSettings.Value = false);
|
|
AddStep("Set dim level to 1", () => songSelect.DimLevel.Value = 1f);
|
|
AddUntilStep("Storyboard is invisible", () => !player.IsStoryboardVisible);
|
|
AddStep("Disable user dim", () => player.DimmableStoryboard.IgnoreUserSettings.Value = true);
|
|
AddUntilStep("Storyboard is visible", () => player.IsStoryboardVisible);
|
|
}
|
|
|
|
[Test]
|
|
public void TestStoryboardIgnoreUserSettings()
|
|
{
|
|
performFullSetup();
|
|
createFakeStoryboard();
|
|
AddStep("Enable replacing background", () => player.StoryboardReplacesBackground.Value = true);
|
|
|
|
AddUntilStep("Storyboard is invisible", () => !player.IsStoryboardVisible);
|
|
AddUntilStep("Background is visible", () => songSelect.IsBackgroundVisible());
|
|
|
|
AddStep("Ignore user settings", () =>
|
|
{
|
|
player.ApplyToBackground(b => b.IgnoreUserSettings.Value = true);
|
|
player.DimmableStoryboard.IgnoreUserSettings.Value = true;
|
|
});
|
|
AddUntilStep("Storyboard is visible", () => player.IsStoryboardVisible);
|
|
AddUntilStep("Background is dimmed", () => songSelect.IsBackgroundVisible() && songSelect.IsBackgroundBlack());
|
|
|
|
AddStep("Disable background replacement", () => player.StoryboardReplacesBackground.Value = false);
|
|
AddUntilStep("Storyboard is visible", () => player.IsStoryboardVisible);
|
|
AddUntilStep("Background is visible", () => songSelect.IsBackgroundVisible() && !songSelect.IsBackgroundBlack());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if the visual settings container retains dim and blur when pausing
|
|
/// </summary>
|
|
[Test]
|
|
public void TestPause()
|
|
{
|
|
performFullSetup(true);
|
|
AddStep("Pause", () => player.Pause());
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
AddStep("Unpause", () => player.Resume());
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if the visual settings container removes user dim when suspending <see cref="Player"/> for <see cref="ResultsScreen"/>
|
|
/// </summary>
|
|
[Test]
|
|
public void TestTransition()
|
|
{
|
|
performFullSetup();
|
|
|
|
FadeAccessibleResults results = null;
|
|
|
|
AddStep("Transition to Results", () => player.Push(results = new FadeAccessibleResults(TestResources.CreateTestScoreInfo())));
|
|
|
|
AddUntilStep("Wait for results is current", () => results.IsCurrentScreen());
|
|
|
|
AddUntilStep("Screen is undimmed, original background retained", () =>
|
|
songSelect.IsBackgroundUndimmed() && songSelect.IsBackgroundCurrent() && songSelect.CheckBackgroundBlur(results.ExpectedBackgroundBlur));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Check if hovering on the visual settings dialogue after resuming from player still previews the background dim.
|
|
/// </summary>
|
|
[Test]
|
|
public void TestResumeFromPlayer()
|
|
{
|
|
performFullSetup();
|
|
AddStep("Move mouse to Visual Settings location", () => InputManager.MoveMouseTo(playerLoader.ScreenSpaceDrawQuad.TopRight
|
|
+ new Vector2(-playerLoader.VisualSettingsPos.ScreenSpaceDrawQuad.Width,
|
|
playerLoader.VisualSettingsPos.ScreenSpaceDrawQuad.Height / 2
|
|
)));
|
|
AddStep("Resume PlayerLoader", () => player.Restart());
|
|
AddUntilStep("Screen is dimmed and blur applied", () => songSelect.IsBackgroundDimmed() && songSelect.IsUserBlurApplied());
|
|
AddStep("Move mouse to center of screen", () => InputManager.MoveMouseTo(playerLoader.ScreenPos));
|
|
AddUntilStep("Screen is undimmed and user blur removed", () => songSelect.IsBackgroundUndimmed() && songSelect.CheckBackgroundBlur(playerLoader.ExpectedBackgroundBlur));
|
|
}
|
|
|
|
private void createFakeStoryboard() => AddStep("Create storyboard", () =>
|
|
{
|
|
player.StoryboardEnabled.Value = false;
|
|
player.StoryboardReplacesBackground.Value = false;
|
|
player.DimmableStoryboard.Add(new OsuSpriteText
|
|
{
|
|
Size = new Vector2(500, 50),
|
|
Alpha = 1,
|
|
Colour = Color4.White,
|
|
Anchor = Anchor.Centre,
|
|
Origin = Anchor.Centre,
|
|
Text = "THIS IS A STORYBOARD",
|
|
Font = new FontUsage(size: 50)
|
|
});
|
|
});
|
|
|
|
private void performFullSetup(bool allowPause = false)
|
|
{
|
|
setupUserSettings();
|
|
|
|
AddStep("Start player loader", () => songSelect.Push(playerLoader = new TestPlayerLoader(player = new LoadBlockingTestPlayer(allowPause))));
|
|
|
|
AddUntilStep("Wait for Player Loader to load", () => playerLoader.IsLoaded);
|
|
AddStep("Move mouse to center of screen", () => InputManager.MoveMouseTo(playerLoader.ScreenPos));
|
|
AddUntilStep("Wait for player to load", () => player.IsLoaded);
|
|
}
|
|
|
|
private void setupUserSettings()
|
|
{
|
|
AddUntilStep("Song select is current", () => songSelect.IsCurrentScreen());
|
|
AddUntilStep("Song select has selection", () => songSelect.Carousel?.SelectedBeatmapInfo != null);
|
|
AddStep("Set default user settings", () =>
|
|
{
|
|
SelectedMods.Value = new[] { new OsuModNoFail() };
|
|
songSelect.DimLevel.Value = 0.7f;
|
|
songSelect.BlurLevel.Value = 0.4f;
|
|
});
|
|
}
|
|
|
|
protected override void Dispose(bool isDisposing)
|
|
{
|
|
base.Dispose(isDisposing);
|
|
rulesets?.Dispose();
|
|
}
|
|
|
|
private partial class DummySongSelect : PlaySongSelect
|
|
{
|
|
private FadeAccessibleBackground background;
|
|
|
|
protected override BackgroundScreen CreateBackground()
|
|
{
|
|
background = new FadeAccessibleBackground(Beatmap.Value);
|
|
IgnoreUserSettings.BindTo(background.IgnoreUserSettings);
|
|
return background;
|
|
}
|
|
|
|
public readonly Bindable<bool> IgnoreUserSettings = new Bindable<bool>();
|
|
public readonly Bindable<double> DimLevel = new BindableDouble();
|
|
public readonly Bindable<double> BlurLevel = new BindableDouble();
|
|
|
|
public new BeatmapCarousel Carousel => base.Carousel;
|
|
|
|
[BackgroundDependencyLoader]
|
|
private void load(OsuConfigManager config)
|
|
{
|
|
config.BindWith(OsuSetting.DimLevel, DimLevel);
|
|
config.BindWith(OsuSetting.BlurLevel, BlurLevel);
|
|
}
|
|
|
|
public bool IsBackgroundBlack() => background.CurrentColour == OsuColour.Gray(0);
|
|
|
|
public bool IsBackgroundDimmed() => background.CurrentColour == OsuColour.Gray(1f - background.CurrentDim);
|
|
|
|
public bool IsBackgroundUndimmed() => background.CurrentColour == Color4.White;
|
|
|
|
public bool IsUserBlurApplied() => Precision.AlmostEquals(background.CurrentBlur, new Vector2((float)BlurLevel.Value * BackgroundScreenBeatmap.USER_BLUR_FACTOR), 0.1f);
|
|
|
|
public bool IsUserBlurDisabled() => background.CurrentBlur == new Vector2(0);
|
|
|
|
public bool IsBackgroundVisible() => background.CurrentAlpha == 1;
|
|
|
|
public bool IsBackgroundBlur() => Precision.AlmostEquals(background.CurrentBlur, new Vector2(BACKGROUND_BLUR), 0.1f);
|
|
|
|
public bool CheckBackgroundBlur(Vector2 expected) => Precision.AlmostEquals(background.CurrentBlur, expected, 0.1f);
|
|
|
|
/// <summary>
|
|
/// Make sure every time a screen gets pushed, the background doesn't get replaced
|
|
/// </summary>
|
|
/// <returns>Whether or not the original background (The one created in DummySongSelect) is still the current background</returns>
|
|
public bool IsBackgroundCurrent() => background?.IsCurrentScreen() == true;
|
|
}
|
|
|
|
private partial class FadeAccessibleResults : ResultsScreen
|
|
{
|
|
public FadeAccessibleResults(ScoreInfo score)
|
|
: base(score)
|
|
{
|
|
AllowRetry = true;
|
|
}
|
|
|
|
protected override BackgroundScreen CreateBackground() => new FadeAccessibleBackground(Beatmap.Value);
|
|
|
|
public Vector2 ExpectedBackgroundBlur => new Vector2(BACKGROUND_BLUR);
|
|
}
|
|
|
|
private partial class LoadBlockingTestPlayer : TestPlayer
|
|
{
|
|
protected override BackgroundScreen CreateBackground() =>
|
|
new FadeAccessibleBackground(Beatmap.Value);
|
|
|
|
public override void OnEntering(ScreenTransitionEvent e)
|
|
{
|
|
base.OnEntering(e);
|
|
|
|
ApplyToBackground(b => StoryboardReplacesBackground.BindTo(b.StoryboardReplacesBackground));
|
|
}
|
|
|
|
public new DimmableStoryboard DimmableStoryboard => base.DimmableStoryboard;
|
|
|
|
// Whether or not the player should be allowed to load.
|
|
public bool BlockLoad;
|
|
|
|
public Bindable<bool> StoryboardEnabled;
|
|
public readonly Bindable<bool> StoryboardReplacesBackground = new Bindable<bool>();
|
|
public readonly Bindable<bool> IsPaused = new Bindable<bool>();
|
|
|
|
public LoadBlockingTestPlayer(bool allowPause = true)
|
|
: base(allowPause)
|
|
{
|
|
}
|
|
|
|
public bool IsStoryboardVisible => DimmableStoryboard.ContentDisplayed;
|
|
|
|
[BackgroundDependencyLoader]
|
|
private void load(OsuConfigManager config, CancellationToken token)
|
|
{
|
|
while (BlockLoad && !token.IsCancellationRequested)
|
|
Thread.Sleep(1);
|
|
|
|
if (!LoadedBeatmapSuccessfully)
|
|
return;
|
|
|
|
StoryboardEnabled = config.GetBindable<bool>(OsuSetting.ShowStoryboard);
|
|
DrawableRuleset.IsPaused.BindTo(IsPaused);
|
|
}
|
|
}
|
|
|
|
private partial class TestPlayerLoader : PlayerLoader
|
|
{
|
|
private FadeAccessibleBackground background;
|
|
|
|
public VisualSettings VisualSettingsPos => VisualSettings;
|
|
public BackgroundScreen ScreenPos => background;
|
|
|
|
public TestPlayerLoader(Player player)
|
|
: base(() => player)
|
|
{
|
|
}
|
|
|
|
public void TriggerOnHover() => OnHover(new HoverEvent(new InputState()));
|
|
|
|
public Vector2 ExpectedBackgroundBlur => new Vector2(BACKGROUND_BLUR);
|
|
|
|
protected override BackgroundScreen CreateBackground() => background = new FadeAccessibleBackground(Beatmap.Value);
|
|
}
|
|
|
|
private partial class FadeAccessibleBackground : BackgroundScreenBeatmap
|
|
{
|
|
protected override DimmableBackground CreateFadeContainer() => dimmable = new TestDimmableBackground { RelativeSizeAxes = Axes.Both };
|
|
|
|
public Color4 CurrentColour => dimmable.CurrentColour;
|
|
|
|
public float CurrentAlpha => dimmable.CurrentAlpha;
|
|
|
|
public float CurrentDim => dimmable.DimLevel;
|
|
|
|
public Vector2 CurrentBlur => Background?.BlurSigma ?? Vector2.Zero;
|
|
|
|
private TestDimmableBackground dimmable;
|
|
|
|
public FadeAccessibleBackground(WorkingBeatmap beatmap)
|
|
: base(beatmap)
|
|
{
|
|
}
|
|
}
|
|
|
|
private partial class TestDimmableBackground : BackgroundScreenBeatmap.DimmableBackground
|
|
{
|
|
public Color4 CurrentColour => Content.Colour;
|
|
public float CurrentAlpha => Content.Alpha;
|
|
|
|
public new float DimLevel => base.DimLevel;
|
|
}
|
|
}
|
|
}
|