Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add star rating to the beatmap metadata in player loading screen #12717

Merged
merged 29 commits into from
May 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
0f08c2a
Add star rating display underneath the beatmap metadata
frenzibyte May 8, 2021
7b7e7a8
Allow null logo facade
frenzibyte May 8, 2021
169a283
Add visual test scene
frenzibyte May 8, 2021
b4801fa
Pass ruleset info to constructor instead
frenzibyte May 8, 2021
0410ede
Refactor `StarRatingDisplay` to be mutable with a current bindable
frenzibyte May 8, 2021
4309006
Use `BeatmapDifficultyCache.GetBindableDifficulty(...)` instead
frenzibyte May 8, 2021
dca5efc
Remove no longer necessary ruleset info requirement
frenzibyte May 8, 2021
26c0010
Fix test not handling 0 beatmap sets
frenzibyte May 8, 2021
d9605e8
Remove test scene description
frenzibyte May 8, 2021
3575d98
Use regular test steps rather than one-time set up and scheduling
frenzibyte May 8, 2021
a75347c
Remove nullable facade logic
frenzibyte May 8, 2021
ca55287
Pass empty facade and replace random property with method instead
frenzibyte May 8, 2021
655e8d3
Remove pattern-matching on nullable with simple `.HasValue`/`.Value`
frenzibyte May 8, 2021
c52f173
Apply further refactoring to star rating display UX-wise
frenzibyte May 8, 2021
f701c33
Add initial fade in to the metadata display
frenzibyte May 8, 2021
8fba655
Allow changing ruleset during test
frenzibyte May 8, 2021
0c973fe
Tidy up test scene
peppy May 10, 2021
2b90bc4
Remove unnecessary ruleset switching steps
peppy May 10, 2021
b7acf9d
Make test work without manually clicking things
peppy May 10, 2021
9ba412d
Add the osu! logo to the test scene
peppy May 10, 2021
52ce16f
Merge branch 'master' into player-loader-star-rating
peppy May 10, 2021
004ce95
Merge branch 'current-star-rating' into player-loader-star-rating
frenzibyte May 11, 2021
e0728a6
Make `BeatmapDifficultyCache.GetDifficultyAsync` virtual
frenzibyte May 14, 2021
db361ef
Add test beatmap difficulty cache with calc. blocking support
frenzibyte May 14, 2021
0dc3bfd
Apply simple transforms to star rating display when ready if not
frenzibyte May 14, 2021
93007c1
Merge branch 'current-star-rating' into player-loader-star-rating
frenzibyte May 14, 2021
7c2fc9b
Update usage due to nullability removal
frenzibyte May 14, 2021
dc56250
Merge branch 'master' into player-loader-star-rating
peppy May 15, 2021
34d1490
Remove null conditional
frenzibyte May 15, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions osu.Game.Tests/Visual/SongSelect/TestSceneBeatmapMetadataDisplay.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
// 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.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using NUnit.Framework;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Utils;
using osu.Game.Beatmaps;
using osu.Game.Rulesets;
using osu.Game.Rulesets.Mods;
using osu.Game.Screens.Menu;
using osu.Game.Screens.Play;
using osuTK;

namespace osu.Game.Tests.Visual.SongSelect
{
public class TestSceneBeatmapMetadataDisplay : OsuTestScene
{
private BeatmapMetadataDisplay display;

[Resolved]
private BeatmapManager manager { get; set; }

[Cached(typeof(BeatmapDifficultyCache))]
private readonly TestBeatmapDifficultyCache testDifficultyCache = new TestBeatmapDifficultyCache();

[Test]
public void TestLocal([Values("Beatmap", "Some long title and stuff")]
string title,
[Values("Trial", "Some1's very hardest difficulty")]
string version)
{
showMetadataForBeatmap(() => CreateWorkingBeatmap(new Beatmap
{
BeatmapInfo =
{
Metadata = new BeatmapMetadata
{
Title = title,
},
Version = version,
StarDifficulty = RNG.NextDouble(0, 10),
}
}));
}

[Test]
public void TestDelayedStarRating()
{
AddStep("block calculation", () => testDifficultyCache.BlockCalculation = true);

showMetadataForBeatmap(() => CreateWorkingBeatmap(new Beatmap
{
BeatmapInfo =
{
Metadata = new BeatmapMetadata
{
Title = "Heavy beatmap",
},
Version = "10k objects",
StarDifficulty = 99.99f,
}
}));

AddStep("allow calculation", () => testDifficultyCache.BlockCalculation = false);
}

[Test]
public void TestRandomFromDatabase()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really not sure about adding more test scenes which depend on the local beatmaps to function correctly

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added it to check how metadata would look on real local beatmaps, and I imagined it to be useful for others (especially when it comes to tweaking the design).

unless you think it's better not to rely on local databases all the time and always go with the option of adding programmatically written beatmaps.

{
showMetadataForBeatmap(() =>
{
var allBeatmapSets = manager.GetAllUsableBeatmapSets(IncludedDetails.Minimal);
if (allBeatmapSets.Count == 0)
return manager.DefaultBeatmap;

var randomBeatmapSet = allBeatmapSets[RNG.Next(0, allBeatmapSets.Count - 1)];
var randomBeatmap = randomBeatmapSet.Beatmaps[RNG.Next(0, randomBeatmapSet.Beatmaps.Count - 1)];

return manager.GetWorkingBeatmap(randomBeatmap);
});
}

private void showMetadataForBeatmap(Func<WorkingBeatmap> getBeatmap)
{
AddStep("setup display", () =>
{
var randomMods = Ruleset.Value.CreateInstance().GetAllMods().OrderBy(_ => RNG.Next()).Take(5).ToList();

OsuLogo logo = new OsuLogo { Scale = new Vector2(0.15f) };

Remove(testDifficultyCache);

Children = new Drawable[]
{
testDifficultyCache,
display = new BeatmapMetadataDisplay(getBeatmap(), new Bindable<IReadOnlyList<Mod>>(randomMods), logo)
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
Alpha = 0f,
}
};

display.FadeIn(400, Easing.OutQuint);
});

AddWaitStep("wait a bit", 5);

AddStep("finish loading", () => display.Loading = false);
}

private class TestBeatmapDifficultyCache : BeatmapDifficultyCache
{
private TaskCompletionSource<bool> calculationBlocker;

private bool blockCalculation;

public bool BlockCalculation
{
get => blockCalculation;
set
{
if (value == blockCalculation)
return;

blockCalculation = value;

if (value)
calculationBlocker = new TaskCompletionSource<bool>();
else
calculationBlocker?.SetResult(false);
}
}

public override async Task<StarDifficulty> GetDifficultyAsync(BeatmapInfo beatmapInfo, RulesetInfo rulesetInfo = null, IEnumerable<Mod> mods = null, CancellationToken cancellationToken = default)
{
if (blockCalculation)
await calculationBlocker.Task;

return await base.GetDifficultyAsync(beatmapInfo, rulesetInfo, mods, cancellationToken);
}
}
}
}
4 changes: 2 additions & 2 deletions osu.Game/Beatmaps/BeatmapDifficultyCache.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ protected override void LoadComplete()
/// <param name="mods">The <see cref="Mod"/>s to get the difficulty with.</param>
/// <param name="cancellationToken">An optional <see cref="CancellationToken"/> which stops computing the star difficulty.</param>
/// <returns>The <see cref="StarDifficulty"/>.</returns>
public Task<StarDifficulty> GetDifficultyAsync([NotNull] BeatmapInfo beatmapInfo, [CanBeNull] RulesetInfo rulesetInfo = null, [CanBeNull] IEnumerable<Mod> mods = null,
CancellationToken cancellationToken = default)
public virtual Task<StarDifficulty> GetDifficultyAsync([NotNull] BeatmapInfo beatmapInfo, [CanBeNull] RulesetInfo rulesetInfo = null,
[CanBeNull] IEnumerable<Mod> mods = null, CancellationToken cancellationToken = default)
{
// In the case that the user hasn't given us a ruleset, use the beatmap's default ruleset.
rulesetInfo ??= beatmapInfo.Ruleset;
Expand Down
76 changes: 63 additions & 13 deletions osu.Game/Screens/Play/BeatmapMetadataDisplay.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// See the LICENCE file in the repository root for full licence text.

using System.Collections.Generic;
using System.Diagnostics;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
Expand All @@ -14,6 +15,7 @@
using osu.Game.Graphics.UserInterface;
using osu.Game.Rulesets.Mods;
using osu.Game.Screens.Play.HUD;
using osu.Game.Screens.Ranking.Expanded;
using osuTK;

namespace osu.Game.Screens.Play
Expand All @@ -25,7 +27,7 @@ public class BeatmapMetadataDisplay : Container
{
private readonly WorkingBeatmap beatmap;
private readonly Bindable<IReadOnlyList<Mod>> mods;
private readonly Drawable facade;
private readonly Drawable logoFacade;
private LoadingSpinner loading;

public IBindable<IReadOnlyList<Mod>> Mods => mods;
Expand All @@ -41,19 +43,24 @@ public bool Loading
}
}

public BeatmapMetadataDisplay(WorkingBeatmap beatmap, Bindable<IReadOnlyList<Mod>> mods, Drawable facade)
public BeatmapMetadataDisplay(WorkingBeatmap beatmap, Bindable<IReadOnlyList<Mod>> mods, Drawable logoFacade)
{
this.beatmap = beatmap;
this.facade = facade;
this.logoFacade = logoFacade;

this.mods = new Bindable<IReadOnlyList<Mod>>();
this.mods.BindTo(mods);
}

private IBindable<StarDifficulty?> starDifficulty;

private FillFlowContainer versionFlow;
private StarRatingDisplay starRatingDisplay;

[BackgroundDependencyLoader]
private void load()
private void load(BeatmapDifficultyCache difficultyCache)
{
var metadata = beatmap.BeatmapInfo?.Metadata ?? new BeatmapMetadata();
var metadata = beatmap.BeatmapInfo.Metadata;

AutoSizeAxes = Axes.Both;
Children = new Drawable[]
Expand All @@ -66,7 +73,7 @@ private void load()
Direction = FillDirection.Vertical,
Children = new[]
{
facade.With(d =>
logoFacade.With(d =>
{
d.Anchor = Anchor.TopCentre;
d.Origin = Anchor.TopCentre;
Expand Down Expand Up @@ -107,16 +114,30 @@ private void load()
loading = new LoadingLayer(true)
}
},
new OsuSpriteText
versionFlow = new FillFlowContainer
{
Text = beatmap?.BeatmapInfo?.Version,
Font = OsuFont.GetFont(size: 26, italics: true),
Origin = Anchor.TopCentre,
AutoSizeAxes = Axes.Both,
Anchor = Anchor.TopCentre,
Margin = new MarginPadding
Origin = Anchor.TopCentre,
Direction = FillDirection.Vertical,
Spacing = new Vector2(5f),
Margin = new MarginPadding { Bottom = 40 },
Children = new Drawable[]
{
Bottom = 40
},
new OsuSpriteText
{
Text = beatmap?.BeatmapInfo?.Version,
Font = OsuFont.GetFont(size: 26, italics: true),
Anchor = Anchor.TopCentre,
Origin = Anchor.TopCentre,
},
starRatingDisplay = new StarRatingDisplay(default)
{
Alpha = 0f,
Anchor = Anchor.TopCentre,
Origin = Anchor.TopCentre,
}
}
},
new GridContainer
{
Expand Down Expand Up @@ -159,9 +180,38 @@ private void load()
}
};

starDifficulty = difficultyCache.GetBindableDifficulty(beatmap.BeatmapInfo);

Loading = true;
}

protected override void LoadComplete()
{
base.LoadComplete();

if (starDifficulty.Value != null)
{
starRatingDisplay.Current.Value = starDifficulty.Value.Value;
starRatingDisplay.Show();
}
else
{
starRatingDisplay.Hide();

starDifficulty.ValueChanged += d =>
{
Debug.Assert(d.NewValue != null);

starRatingDisplay.Current.Value = d.NewValue.Value;

versionFlow.AutoSizeDuration = 300;
versionFlow.AutoSizeEasing = Easing.OutQuint;

starRatingDisplay.FadeIn(300, Easing.InQuint);
};
}
}

private class MetadataLineLabel : OsuSpriteText
{
public MetadataLineLabel(string text)
Expand Down