1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-16 17:02:55 +08:00
osu-lazer/osu.Game/Graphics/Containers/SectionsContainer.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

282 lines
9.3 KiB
C#
Raw Normal View History

// 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.
2018-04-13 17:19:50 +08:00
using System;
2021-01-21 13:07:02 +08:00
using System.Diagnostics;
using System.Linq;
using JetBrains.Annotations;
using osu.Framework.Allocation;
2019-02-21 18:04:31 +08:00
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
2020-02-26 14:06:30 +08:00
using osu.Framework.Layout;
using osu.Framework.Utils;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Graphics.Containers
{
/// <summary>
/// A container that can scroll to each section inside it.
/// </summary>
[Cached]
2017-06-09 16:24:19 +08:00
public class SectionsContainer<T> : Container<T>
where T : Drawable
{
public Bindable<T> SelectedSection { get; } = new Bindable<T>();
private T lastClickedSection;
2018-04-13 17:19:50 +08:00
public Drawable ExpandableHeader
{
get => expandableHeader;
set
{
if (value == expandableHeader) return;
2018-04-13 17:19:50 +08:00
2020-09-03 16:11:34 +08:00
if (expandableHeader != null)
RemoveInternal(expandableHeader);
expandableHeader = value;
2020-09-03 16:11:34 +08:00
2017-05-21 02:11:55 +08:00
if (value == null) return;
2018-04-13 17:19:50 +08:00
2017-06-09 16:24:19 +08:00
AddInternal(expandableHeader);
2021-01-21 13:31:31 +08:00
lastKnownScroll = null;
}
}
2018-04-13 17:19:50 +08:00
public Drawable FixedHeader
{
get => fixedHeader;
set
{
if (value == fixedHeader) return;
2018-04-13 17:19:50 +08:00
2017-06-09 16:24:19 +08:00
fixedHeader?.Expire();
fixedHeader = value;
2017-05-21 02:11:55 +08:00
if (value == null) return;
2018-04-13 17:19:50 +08:00
2017-06-09 16:24:19 +08:00
AddInternal(fixedHeader);
2021-01-21 13:31:31 +08:00
lastKnownScroll = null;
}
}
2018-04-13 17:19:50 +08:00
2017-05-21 03:44:03 +08:00
public Drawable Footer
{
get => footer;
2017-05-21 03:44:03 +08:00
set
{
if (value == footer) return;
2018-04-13 17:19:50 +08:00
2017-05-21 03:44:03 +08:00
if (footer != null)
2017-06-25 10:06:54 +08:00
scrollContainer.Remove(footer);
2017-05-21 03:44:03 +08:00
footer = value;
if (value == null) return;
2018-04-13 17:19:50 +08:00
2017-05-21 03:44:03 +08:00
footer.Anchor |= Anchor.y2;
footer.Origin |= Anchor.y2;
2017-06-25 10:06:54 +08:00
scrollContainer.Add(footer);
2021-01-21 13:31:31 +08:00
lastKnownScroll = null;
2017-05-21 03:44:03 +08:00
}
}
2018-04-13 17:19:50 +08:00
public Drawable HeaderBackground
{
get => headerBackground;
set
{
if (value == headerBackground) return;
2018-04-13 17:19:50 +08:00
headerBackgroundContainer.Clear();
headerBackground = value;
if (value == null) return;
2018-04-13 17:19:50 +08:00
headerBackgroundContainer.Add(headerBackground);
2018-04-13 17:19:50 +08:00
2021-01-21 13:31:31 +08:00
lastKnownScroll = null;
}
}
2018-04-13 17:19:50 +08:00
protected override Container<T> Content => scrollContentContainer;
2018-04-13 17:19:50 +08:00
private readonly UserTrackingScrollContainer scrollContainer;
private readonly Container headerBackgroundContainer;
2017-05-21 04:48:43 +08:00
private readonly MarginPadding originalSectionsMargin;
private Drawable expandableHeader, fixedHeader, footer, headerBackground;
private FlowContainer<T> scrollContentContainer;
2019-02-28 12:31:40 +08:00
2021-01-21 13:31:31 +08:00
private float? headerHeight, footerHeight;
2018-04-13 17:19:50 +08:00
2021-01-21 13:31:31 +08:00
private float? lastKnownScroll;
2018-04-13 17:19:50 +08:00
/// <summary>
/// The percentage of the container to consider the centre-point for deciding the active section (and scrolling to a requested section).
2021-01-22 15:53:31 +08:00
/// </summary>
2021-08-20 16:40:56 +08:00
private const float scroll_y_centre = 0.1f;
2021-01-21 13:30:22 +08:00
public SectionsContainer()
{
AddRangeInternal(new Drawable[]
{
scrollContainer = CreateScrollContainer().With(s =>
{
s.RelativeSizeAxes = Axes.Both;
s.Masking = true;
s.ScrollbarVisible = false;
s.Child = scrollContentContainer = CreateScrollContentContainer();
}),
headerBackgroundContainer = new Container
{
RelativeSizeAxes = Axes.X
}
});
2017-06-12 14:39:49 +08:00
originalSectionsMargin = scrollContentContainer.Margin;
}
2018-04-13 17:19:50 +08:00
public override void Add(T drawable)
{
base.Add(drawable);
2021-01-21 13:07:02 +08:00
Debug.Assert(drawable != null);
2021-01-21 13:31:31 +08:00
lastKnownScroll = null;
headerHeight = null;
footerHeight = null;
}
public void ScrollTo(Drawable target)
{
2021-08-20 16:40:56 +08:00
lastKnownScroll = null;
float fixedHeaderSize = FixedHeader?.BoundingBox.Height ?? 0;
// implementation similar to ScrollIntoView but a bit more nuanced.
float top = scrollContainer.GetChildPosInContent(target);
float bottomScrollExtent = scrollContainer.ScrollableExtent - fixedHeaderSize;
float scrollTarget = top - fixedHeaderSize - scrollContainer.DisplayableContent * scroll_y_centre;
2021-08-20 16:40:56 +08:00
if (scrollTarget > bottomScrollExtent)
2021-08-20 16:40:56 +08:00
scrollContainer.ScrollToEnd();
else
scrollContainer.ScrollTo(scrollTarget);
2021-08-20 16:40:56 +08:00
if (target is T section)
lastClickedSection = section;
}
2018-04-13 17:19:50 +08:00
public void ScrollToTop() => scrollContainer.ScrollTo(0);
2018-04-13 17:19:50 +08:00
[NotNull]
protected virtual UserTrackingScrollContainer CreateScrollContainer() => new UserTrackingScrollContainer();
[NotNull]
protected virtual FlowContainer<T> CreateScrollContentContainer() =>
new FillFlowContainer<T>
{
Direction = FillDirection.Vertical,
AutoSizeAxes = Axes.Y,
RelativeSizeAxes = Axes.X,
};
2020-02-26 14:06:30 +08:00
protected override bool OnInvalidate(Invalidation invalidation, InvalidationSource source)
2018-12-23 04:50:25 +08:00
{
bool result = base.OnInvalidate(invalidation, source);
2018-12-23 04:50:25 +08:00
2020-02-26 14:06:30 +08:00
if (source == InvalidationSource.Child && (invalidation & Invalidation.DrawSize) != 0)
2018-12-23 04:50:25 +08:00
{
InvalidateScrollPosition();
2020-02-26 14:06:30 +08:00
result = true;
2018-12-23 04:50:25 +08:00
}
2020-02-26 14:06:30 +08:00
return result;
2018-12-23 04:50:25 +08:00
}
protected void InvalidateScrollPosition()
{
Schedule(() =>
{
lastKnownScroll = null;
lastClickedSection = null;
});
}
protected override void UpdateAfterChildren()
{
base.UpdateAfterChildren();
2018-04-13 17:19:50 +08:00
2021-01-23 02:47:38 +08:00
float fixedHeaderSize = FixedHeader?.LayoutSize.Y ?? 0;
2021-01-21 13:52:41 +08:00
float expandableHeaderSize = ExpandableHeader?.LayoutSize.Y ?? 0;
float headerH = expandableHeaderSize + fixedHeaderSize;
2017-05-21 04:48:43 +08:00
float footerH = Footer?.LayoutSize.Y ?? 0;
2019-04-01 11:16:05 +08:00
2017-05-21 04:48:43 +08:00
if (headerH != headerHeight || footerH != footerHeight)
2017-05-21 02:11:55 +08:00
{
2017-05-21 04:48:43 +08:00
headerHeight = headerH;
footerHeight = footerH;
2017-05-21 03:44:03 +08:00
updateSectionsMargin();
2017-05-21 02:11:55 +08:00
}
2018-04-13 17:19:50 +08:00
float currentScroll = scrollContainer.Current;
2018-04-13 17:19:50 +08:00
if (currentScroll != lastKnownScroll)
{
lastKnownScroll = currentScroll;
2018-04-13 17:19:50 +08:00
// reset last clicked section because user started scrolling themselves
if (scrollContainer.UserScrolling)
lastClickedSection = null;
2017-06-25 10:07:54 +08:00
if (ExpandableHeader != null && FixedHeader != null)
2017-05-21 02:11:55 +08:00
{
2021-01-21 13:52:41 +08:00
float offset = Math.Min(expandableHeaderSize, currentScroll);
2018-04-13 17:19:50 +08:00
2017-06-25 10:07:54 +08:00
ExpandableHeader.Y = -offset;
2021-01-21 13:52:41 +08:00
FixedHeader.Y = -offset + expandableHeaderSize;
2017-05-21 02:11:55 +08:00
}
2018-04-13 17:19:50 +08:00
2021-01-21 13:52:41 +08:00
headerBackgroundContainer.Height = expandableHeaderSize + fixedHeaderSize;
headerBackgroundContainer.Y = ExpandableHeader?.Y ?? 0;
2018-04-13 17:19:50 +08:00
float smallestSectionHeight = Children.Count > 0 ? Children.Min(d => d.Height) : 0;
2021-01-23 02:48:33 +08:00
// scroll offset is our fixed header height if we have it plus 10% of content height
// plus 5% to fix floating point errors and to not have a section instantly unselect when scrolling upwards
// but the 5% can't be bigger than our smallest section height, otherwise it won't get selected correctly
float selectionLenienceAboveSection = Math.Min(smallestSectionHeight / 2.0f, scrollContainer.DisplayableContent * 0.05f);
2021-01-21 13:44:47 +08:00
float scrollCentre = fixedHeaderSize + scrollContainer.DisplayableContent * scroll_y_centre + selectionLenienceAboveSection;
2018-04-13 17:19:50 +08:00
var presentChildren = Children.Where(c => c.IsPresent);
if (lastClickedSection != null)
SelectedSection.Value = lastClickedSection;
else if (Precision.AlmostBigger(0, scrollContainer.Current))
SelectedSection.Value = presentChildren.FirstOrDefault();
2021-01-21 13:44:47 +08:00
else if (Precision.AlmostBigger(scrollContainer.Current, scrollContainer.ScrollableExtent))
SelectedSection.Value = presentChildren.LastOrDefault();
2021-01-21 13:44:47 +08:00
else
2021-01-21 13:46:35 +08:00
{
SelectedSection.Value = presentChildren
.TakeWhile(section => scrollContainer.GetChildPosInContent(section) - currentScroll - scrollCentre <= 0)
.LastOrDefault() ?? presentChildren.FirstOrDefault();
2021-01-21 13:46:35 +08:00
}
}
}
private void updateSectionsMargin()
{
if (!Children.Any()) return;
var newMargin = originalSectionsMargin;
2021-01-21 13:31:31 +08:00
newMargin.Top += (headerHeight ?? 0);
newMargin.Bottom += (footerHeight ?? 0);
scrollContentContainer.Margin = newMargin;
}
}
}