1
0
mirror of https://github.com/ppy/osu.git synced 2025-03-11 07:17:18 +08:00

Implement beatmap "standalone" panel design

This commit is contained in:
Salman Alshamrani 2025-02-05 07:17:13 -05:00
parent 04d8bafdce
commit 696366f8cb
2 changed files with 561 additions and 0 deletions

View File

@ -0,0 +1,101 @@
// 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.Linq;
using NUnit.Framework;
using osu.Framework.Allocation;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Utils;
using osu.Game.Beatmaps;
using osu.Game.Overlays;
using osu.Game.Rulesets.Mania;
using osu.Game.Rulesets.Osu;
using osu.Game.Screens.SelectV2;
using osu.Game.Tests.Resources;
using osu.Game.Tests.Visual.UserInterface;
using osuTK;
namespace osu.Game.Tests.Visual.SongSelectV2
{
public partial class TestSceneBeatmapCarouselStandalonePanel : ThemeComparisonTestScene
{
[Resolved]
private BeatmapManager beatmaps { get; set; } = null!;
private BeatmapInfo beatmap = null!;
public TestSceneBeatmapCarouselStandalonePanel()
: base(false)
{
}
[Test]
public void TestDisplay()
{
AddStep("set beatmap", () =>
{
var beatmapSet = beatmaps.GetAllUsableBeatmapSets().FirstOrDefault(b => b.OnlineID == 241526)
?? beatmaps.GetAllUsableBeatmapSets().FirstOrDefault(b => !b.Protected)
?? TestResources.CreateTestBeatmapSetInfo();
beatmap = beatmapSet.Beatmaps.First();
CreateThemedContent(OverlayColourScheme.Aquamarine);
});
}
[Test]
public void TestRandomBeatmap()
{
AddStep("random beatmap", () =>
{
beatmap = beatmaps.GetAllUsableBeatmapSets().OrderBy(_ => RNG.Next())
.First().Beatmaps.OrderBy(_ => RNG.Next()).First();
CreateThemedContent(OverlayColourScheme.Aquamarine);
});
}
[Test]
public void TestManiaRuleset()
{
AddToggleStep("mania ruleset", v => Ruleset.Value = v ? new ManiaRuleset().RulesetInfo : new OsuRuleset().RulesetInfo);
}
protected override Drawable CreateContent()
{
return new FillFlowContainer
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
Width = 0.5f,
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
Direction = FillDirection.Vertical,
Spacing = new Vector2(0f, 5f),
Children = new Drawable[]
{
new BeatmapStandalonePanel
{
Item = new CarouselItem(beatmap)
},
new BeatmapStandalonePanel
{
Item = new CarouselItem(beatmap),
KeyboardSelected = { Value = true }
},
new BeatmapStandalonePanel
{
Item = new CarouselItem(beatmap),
Selected = { Value = true }
},
new BeatmapStandalonePanel
{
Item = new CarouselItem(beatmap),
KeyboardSelected = { Value = true },
Selected = { Value = true }
},
}
};
}
}
}

View File

@ -0,0 +1,460 @@
// 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.Diagnostics;
using System.Linq;
using System.Threading;
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;
using osu.Framework.Graphics.Pooling;
using osu.Framework.Graphics.Shapes;
using osu.Framework.Input.Events;
using osu.Framework.Localisation;
using osu.Game.Beatmaps;
using osu.Game.Beatmaps.Drawables;
using osu.Game.Graphics;
using osu.Game.Graphics.Containers;
using osu.Game.Graphics.Sprites;
using osu.Game.Graphics.UserInterface;
using osu.Game.Overlays;
using osu.Game.Resources.Localisation.Web;
using osu.Game.Rulesets;
using osu.Game.Rulesets.Mods;
using osuTK;
using osuTK.Graphics;
namespace osu.Game.Screens.SelectV2
{
public partial class BeatmapStandalonePanel : PoolableDrawable, ICarouselPanel
{
public const float HEIGHT = CarouselItem.DEFAULT_HEIGHT * 1.6f;
private const float difficulty_icon_container_width = 30;
private const float corner_radius = 10;
private const float glow_offset = 10f; // extra space for the edge effect to not be cutoff by the right edge of the carousel.
private const float preselected_x_offset = 25f;
private const float selected_x_offset = 50f;
private const float duration = 500;
[Resolved]
private BeatmapCarousel? carousel { get; set; }
[Resolved]
private IBindable<RulesetInfo> ruleset { get; set; } = null!;
[Resolved]
private IBindable<IReadOnlyList<Mod>> mods { get; set; } = null!;
[Resolved]
private OverlayColourProvider colourProvider { get; set; } = null!;
[Resolved]
private BeatmapManager beatmaps { get; set; } = null!;
[Resolved]
private OsuColour colours { get; set; } = null!;
[Resolved]
private BeatmapDifficultyCache difficultyCache { get; set; } = null!;
private IBindable<StarDifficulty?>? starDifficultyBindable;
private CancellationTokenSource? starDifficultyCancellationSource;
private Container panel = null!;
private Box backgroundBorder = null!;
private BeatmapSetPanelBackground background = null!;
private Container backgroundContainer = null!;
private FillFlowContainer mainFlowContainer = null!;
private Box hoverLayer = null!;
private OsuSpriteText titleText = null!;
private OsuSpriteText artistText = null!;
private UpdateBeatmapSetButtonV2 updateButton = null!;
private BeatmapSetOnlineStatusPill statusPill = null!;
private ConstrainedIconContainer difficultyIcon = null!;
private FillFlowContainer difficultyLine = null!;
private StarRatingDisplay difficultyStarRating = null!;
private TopLocalRankV2 difficultyRank = null!;
private OsuSpriteText difficultyKeyCountText = null!;
private OsuSpriteText difficultyName = null!;
private OsuSpriteText difficultyAuthor = null!;
[BackgroundDependencyLoader]
private void load()
{
Anchor = Anchor.TopRight;
Origin = Anchor.TopRight;
RelativeSizeAxes = Axes.X;
Width = 1f;
Height = HEIGHT;
InternalChild = panel = new Container
{
Masking = true,
CornerRadius = corner_radius,
RelativeSizeAxes = Axes.Both,
EdgeEffect = new EdgeEffectParameters
{
Type = EdgeEffectType.Shadow,
Radius = 10,
},
Children = new Drawable[]
{
new BufferedContainer
{
RelativeSizeAxes = Axes.Both,
Children = new Drawable[]
{
backgroundBorder = new Box
{
RelativeSizeAxes = Axes.Y,
Alpha = 0,
EdgeSmoothness = new Vector2(2, 0),
},
backgroundContainer = new Container
{
Masking = true,
CornerRadius = corner_radius,
RelativeSizeAxes = Axes.X,
MaskingSmoothness = 2,
Anchor = Anchor.CentreLeft,
Origin = Anchor.CentreLeft,
Children = new Drawable[]
{
background = new BeatmapSetPanelBackground
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
RelativeSizeAxes = Axes.Both,
},
},
},
}
},
difficultyIcon = new ConstrainedIconContainer
{
X = difficulty_icon_container_width / 2,
Origin = Anchor.Centre,
Anchor = Anchor.CentreLeft,
Size = new Vector2(20),
},
mainFlowContainer = new FillFlowContainer
{
AutoSizeAxes = Axes.Both,
Direction = FillDirection.Vertical,
Padding = new MarginPadding { Top = 7.5f, Left = 15, Bottom = 5 },
Children = new Drawable[]
{
titleText = new OsuSpriteText
{
Font = OsuFont.GetFont(weight: FontWeight.Bold, size: 22, italics: true),
Shadow = true,
},
artistText = new OsuSpriteText
{
Font = OsuFont.GetFont(weight: FontWeight.SemiBold, size: 17, italics: true),
Shadow = true,
},
new FillFlowContainer
{
Direction = FillDirection.Horizontal,
AutoSizeAxes = Axes.Both,
Margin = new MarginPadding { Top = 5f },
Children = new Drawable[]
{
updateButton = new UpdateBeatmapSetButtonV2
{
Anchor = Anchor.CentreLeft,
Origin = Anchor.CentreLeft,
Margin = new MarginPadding { Right = 5f, Top = -2f },
},
statusPill = new BeatmapSetOnlineStatusPill
{
AutoSizeAxes = Axes.Both,
Origin = Anchor.CentreLeft,
Anchor = Anchor.CentreLeft,
TextSize = 11,
TextPadding = new MarginPadding { Horizontal = 8, Vertical = 2 },
Margin = new MarginPadding { Right = 5f },
},
difficultyLine = new FillFlowContainer
{
Direction = FillDirection.Horizontal,
AutoSizeAxes = Axes.Both,
Children = new Drawable[]
{
difficultyStarRating = new StarRatingDisplay(default, StarRatingDisplaySize.Small)
{
Origin = Anchor.CentreLeft,
Anchor = Anchor.CentreLeft,
Scale = new Vector2(8f / 9f),
Margin = new MarginPadding { Right = 5f },
},
difficultyRank = new TopLocalRankV2
{
Scale = new Vector2(8f / 11),
Origin = Anchor.CentreLeft,
Anchor = Anchor.CentreLeft,
Margin = new MarginPadding { Right = 5f },
},
difficultyKeyCountText = new OsuSpriteText
{
Font = OsuFont.GetFont(size: 18, weight: FontWeight.SemiBold),
Anchor = Anchor.BottomLeft,
Origin = Anchor.BottomLeft,
Alpha = 0,
Margin = new MarginPadding { Bottom = 2f },
},
difficultyName = new OsuSpriteText
{
Font = OsuFont.GetFont(size: 18, weight: FontWeight.SemiBold),
Origin = Anchor.BottomLeft,
Anchor = Anchor.BottomLeft,
Margin = new MarginPadding { Right = 5f, Bottom = 2f },
},
difficultyAuthor = new OsuSpriteText
{
Colour = colourProvider.Content2,
Font = OsuFont.GetFont(weight: FontWeight.SemiBold),
Origin = Anchor.BottomLeft,
Anchor = Anchor.BottomLeft,
Margin = new MarginPadding { Right = 5f, Bottom = 2f },
}
}
},
},
}
}
},
hoverLayer = new Box
{
Colour = colours.Blue.Opacity(0.1f),
Alpha = 0,
Blending = BlendingParameters.Additive,
RelativeSizeAxes = Axes.Both,
},
new HoverSounds(),
}
};
}
public override bool ReceivePositionalInputAt(Vector2 screenSpacePos)
{
var inputRectangle = panel.DrawRectangle;
// Cover a gap introduced by the spacing between a BeatmapSetPanel and a BeatmapPanel either above it or below it.
inputRectangle = inputRectangle.Inflate(new MarginPadding { Vertical = BeatmapCarousel.SPACING / 2f });
return inputRectangle.Contains(panel.ToLocalSpace(screenSpacePos));
}
protected override void LoadComplete()
{
base.LoadComplete();
ruleset.BindValueChanged(_ =>
{
computeStarRating();
updateKeyCount();
});
mods.BindValueChanged(_ =>
{
computeStarRating();
updateKeyCount();
}, true);
Selected.BindValueChanged(_ => updateSelectedDisplay(), true);
KeyboardSelected.BindValueChanged(_ => updateKeyboardSelectedDisplay(), true);
}
protected override void PrepareForUse()
{
base.PrepareForUse();
Debug.Assert(Item != null);
var beatmap = (BeatmapInfo)Item.Model;
var beatmapSet = beatmap.BeatmapSet!;
// Choice of background image matches BSS implementation (always uses the lowest `beatmap_id` from the set).
background.Beatmap = beatmaps.GetWorkingBeatmap(beatmapSet.Beatmaps.MinBy(b => b.OnlineID));
titleText.Text = new RomanisableString(beatmapSet.Metadata.TitleUnicode, beatmapSet.Metadata.Title);
artistText.Text = new RomanisableString(beatmapSet.Metadata.ArtistUnicode, beatmapSet.Metadata.Artist);
updateButton.BeatmapSet = beatmapSet;
statusPill.Status = beatmapSet.Status;
difficultyIcon.Icon = beatmap.Ruleset.CreateInstance().CreateIcon();
difficultyIcon.Show();
difficultyRank.Beatmap = beatmap;
difficultyName.Text = beatmap.DifficultyName;
difficultyAuthor.Text = BeatmapsetsStrings.ShowDetailsMappedBy(beatmap.Metadata.Author.Username);
difficultyLine.Show();
computeStarRating();
updateSelectedDisplay();
FinishTransforms(true);
this.FadeInFromZero(duration, Easing.OutQuint);
}
protected override void FreeAfterUse()
{
base.FreeAfterUse();
background.Beatmap = null;
updateButton.BeatmapSet = null;
difficultyRank.Beatmap = null;
starDifficultyBindable = null;
}
private void updateSelectedDisplay()
{
if (Item == null)
return;
updatePanelPosition();
backgroundBorder.RelativeSizeAxes = Selected.Value ? Axes.Both : Axes.Y;
backgroundBorder.Width = Selected.Value ? 1 : difficulty_icon_container_width + corner_radius;
backgroundBorder.FadeTo(Selected.Value ? 1 : 0, duration, Easing.OutQuint);
difficultyIcon.FadeTo(Selected.Value ? 1 : 0, duration, Easing.OutQuint);
backgroundContainer.ResizeHeightTo(Selected.Value ? HEIGHT - 4 : HEIGHT, duration, Easing.OutQuint);
backgroundContainer.MoveToX(Selected.Value ? difficulty_icon_container_width : 0, duration, Easing.OutQuint);
mainFlowContainer.MoveToX(Selected.Value ? difficulty_icon_container_width : 0, duration, Easing.OutQuint);
panel.EdgeEffect = panel.EdgeEffect with { Radius = Selected.Value ? 15 : 10 };
updateEdgeEffectColour();
}
private void updateKeyboardSelectedDisplay()
{
updatePanelPosition();
updateHover();
}
private void updatePanelPosition()
{
float x = glow_offset + selected_x_offset + preselected_x_offset;
if (Selected.Value)
x -= selected_x_offset;
if (KeyboardSelected.Value)
x -= preselected_x_offset;
this.TransformTo(nameof(Padding), new MarginPadding { Left = x }, duration, Easing.OutQuint);
}
private void updateHover()
{
bool hovered = IsHovered || KeyboardSelected.Value;
if (hovered)
hoverLayer.FadeIn(100, Easing.OutQuint);
else
hoverLayer.FadeOut(1000, Easing.OutQuint);
}
private void computeStarRating()
{
starDifficultyCancellationSource?.Cancel();
starDifficultyCancellationSource = new CancellationTokenSource();
if (Item == null)
return;
var beatmap = (BeatmapInfo)Item.Model;
starDifficultyBindable = difficultyCache.GetBindableDifficulty(beatmap, starDifficultyCancellationSource.Token);
starDifficultyBindable.BindValueChanged(d =>
{
var value = d.NewValue ?? default;
backgroundBorder.FadeColour(colours.ForStarDifficulty(value.Stars), duration, Easing.OutQuint);
difficultyIcon.FadeColour(value.Stars > 6.5f ? colours.Orange1 : colourProvider.Background5, duration, Easing.OutQuint);
difficultyStarRating.Current.Value = value;
updateEdgeEffectColour();
}, true);
}
private void updateEdgeEffectColour()
{
panel.FadeEdgeEffectTo(Selected.Value
? colours.ForStarDifficulty(starDifficultyBindable?.Value?.Stars ?? 0f).Opacity(0.5f)
: Color4.Black.Opacity(0.4f), duration, Easing.OutQuint);
}
private void updateKeyCount()
{
if (Item == null)
return;
var beatmap = (BeatmapInfo)Item.Model;
if (ruleset.Value.OnlineID == 3)
{
// Account for mania differences locally for now.
// Eventually this should be handled in a more modular way, allowing rulesets to add more information to the panel.
ILegacyRuleset legacyRuleset = (ILegacyRuleset)ruleset.Value.CreateInstance();
int keyCount = legacyRuleset.GetKeyCount(beatmap, mods.Value);
difficultyKeyCountText.Alpha = 1;
difficultyKeyCountText.Text = $"[{keyCount}K] ";
}
else
difficultyKeyCountText.Alpha = 0;
}
protected override bool OnHover(HoverEvent e)
{
updateHover();
return true;
}
protected override void OnHoverLost(HoverLostEvent e)
{
updateHover();
base.OnHoverLost(e);
}
protected override bool OnClick(ClickEvent e)
{
if (carousel != null)
carousel.CurrentSelection = Item!.Model;
return true;
}
#region ICarouselPanel
public CarouselItem? Item { get; set; }
public BindableBool Selected { get; } = new BindableBool();
public BindableBool Expanded { get; } = new BindableBool();
public BindableBool KeyboardSelected { get; } = new BindableBool();
public double DrawYPosition { get; set; }
public void Activated()
{
// sets should never be activated.
throw new InvalidOperationException();
}
#endregion
}
}