osu/osu.Game/Graphics/Containers/SectionsContainer.cs

250 lines
8.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 09:19:50 +00:00
using System;
2021-01-21 05:07:02 +00:00
using System.Diagnostics;
2018-04-13 09:19:50 +00:00
using System.Linq;
using JetBrains.Annotations;
using osu.Framework.Allocation;
2019-02-21 10:04:31 +00:00
using osu.Framework.Bindables;
2018-04-13 09:19:50 +00:00
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
2020-02-26 06:06:30 +00:00
using osu.Framework.Layout;
using osu.Framework.Utils;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Graphics.Containers
{
/// <summary>
/// A container that can scroll to each section inside it.
/// </summary>
[Cached]
2018-04-13 09:19:50 +00:00
public class SectionsContainer<T> : Container<T>
where T : Drawable
{
public Bindable<T> SelectedSection { get; } = new Bindable<T>();
private Drawable lastClickedSection;
2018-04-13 09:19:50 +00:00
public Drawable ExpandableHeader
{
get => expandableHeader;
2018-04-13 09:19:50 +00:00
set
{
if (value == expandableHeader) return;
2020-09-03 08:11:34 +00:00
if (expandableHeader != null)
RemoveInternal(expandableHeader);
2018-04-13 09:19:50 +00:00
expandableHeader = value;
2020-09-03 08:11:34 +00:00
2018-04-13 09:19:50 +00:00
if (value == null) return;
AddInternal(expandableHeader);
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
2018-04-13 09:19:50 +00:00
}
}
public Drawable FixedHeader
{
get => fixedHeader;
2018-04-13 09:19:50 +00:00
set
{
if (value == fixedHeader) return;
fixedHeader?.Expire();
fixedHeader = value;
if (value == null) return;
AddInternal(fixedHeader);
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
2018-04-13 09:19:50 +00:00
}
}
public Drawable Footer
{
get => footer;
2018-04-13 09:19:50 +00:00
set
{
if (value == footer) return;
if (footer != null)
scrollContainer.Remove(footer);
footer = value;
if (value == null) return;
footer.Anchor |= Anchor.y2;
footer.Origin |= Anchor.y2;
scrollContainer.Add(footer);
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
2018-04-13 09:19:50 +00:00
}
}
public Drawable HeaderBackground
{
get => headerBackground;
2018-04-13 09:19:50 +00:00
set
{
if (value == headerBackground) return;
headerBackgroundContainer.Clear();
headerBackground = value;
2018-04-13 09:19:50 +00:00
if (value == null) return;
headerBackgroundContainer.Add(headerBackground);
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
2018-04-13 09:19:50 +00:00
}
}
protected override Container<T> Content => scrollContentContainer;
2018-04-13 09:19:50 +00:00
private readonly UserTrackingScrollContainer scrollContainer;
private readonly Container headerBackgroundContainer;
2018-04-13 09:19:50 +00:00
private readonly MarginPadding originalSectionsMargin;
private Drawable expandableHeader, fixedHeader, footer, headerBackground;
private FlowContainer<T> scrollContentContainer;
2019-02-28 04:31:40 +00:00
2021-01-21 05:31:31 +00:00
private float? headerHeight, footerHeight;
2018-04-13 09:19:50 +00:00
2021-01-21 05:31:31 +00:00
private float? lastKnownScroll;
2018-04-13 09:19:50 +00:00
2021-01-21 05:30:22 +00:00
private const float scroll_target_multiplier = 0.2f;
2018-04-13 09:19:50 +00:00
public SectionsContainer()
{
AddRangeInternal(new Drawable[]
2018-04-13 09:19:50 +00:00
{
scrollContainer = CreateScrollContainer().With(s =>
{
s.RelativeSizeAxes = Axes.Both;
s.Masking = true;
s.ScrollbarVisible = false;
s.Child = scrollContentContainer = CreateScrollContentContainer();
}),
headerBackgroundContainer = new Container
{
RelativeSizeAxes = Axes.X
}
2018-04-13 09:19:50 +00:00
});
2018-04-13 09:19:50 +00:00
originalSectionsMargin = scrollContentContainer.Margin;
}
public override void Add(T drawable)
{
base.Add(drawable);
2021-01-21 05:07:02 +00:00
Debug.Assert(drawable != null);
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
headerHeight = null;
footerHeight = null;
}
public void ScrollTo(Drawable section)
{
lastClickedSection = section;
scrollContainer.ScrollTo(scrollContainer.GetChildPosInContent(section) - scrollContainer.DisplayableContent * scroll_target_multiplier - (FixedHeader?.BoundingBox.Height ?? 0));
}
2018-04-13 09:19:50 +00:00
public void ScrollToTop() => scrollContainer.ScrollTo(0);
[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 06:06:30 +00:00
protected override bool OnInvalidate(Invalidation invalidation, InvalidationSource source)
2018-12-22 20:50:25 +00:00
{
2020-02-26 06:06:30 +00:00
var result = base.OnInvalidate(invalidation, source);
2018-12-22 20:50:25 +00:00
2020-02-26 06:06:30 +00:00
if (source == InvalidationSource.Child && (invalidation & Invalidation.DrawSize) != 0)
2018-12-22 20:50:25 +00:00
{
2021-01-21 05:31:31 +00:00
lastKnownScroll = null;
2020-02-26 06:06:30 +00:00
result = true;
2018-12-22 20:50:25 +00:00
}
2020-02-26 06:06:30 +00:00
return result;
2018-12-22 20:50:25 +00:00
}
2018-04-13 09:19:50 +00:00
protected override void UpdateAfterChildren()
{
base.UpdateAfterChildren();
2021-01-21 05:52:41 +00:00
float fixedHeaderSize = (FixedHeader?.LayoutSize.Y ?? 0);
float expandableHeaderSize = ExpandableHeader?.LayoutSize.Y ?? 0;
float headerH = expandableHeaderSize + fixedHeaderSize;
2018-04-13 09:19:50 +00:00
float footerH = Footer?.LayoutSize.Y ?? 0;
2019-04-01 03:16:05 +00:00
2018-04-13 09:19:50 +00:00
if (headerH != headerHeight || footerH != footerHeight)
{
headerHeight = headerH;
footerHeight = footerH;
updateSectionsMargin();
}
float currentScroll = scrollContainer.Current;
if (currentScroll != lastKnownScroll)
{
lastKnownScroll = currentScroll;
// reset last clicked section because user started scrolling themselves
if (scrollContainer.UserScrolling)
lastClickedSection = null;
2018-04-13 09:19:50 +00:00
if (ExpandableHeader != null && FixedHeader != null)
{
2021-01-21 05:52:41 +00:00
float offset = Math.Min(expandableHeaderSize, currentScroll);
2018-04-13 09:19:50 +00:00
ExpandableHeader.Y = -offset;
2021-01-21 05:52:41 +00:00
FixedHeader.Y = -offset + expandableHeaderSize;
2018-04-13 09:19:50 +00:00
}
2021-01-21 05:52:41 +00:00
headerBackgroundContainer.Height = expandableHeaderSize + fixedHeaderSize;
2018-04-13 09:19:50 +00:00
headerBackgroundContainer.Y = ExpandableHeader?.Y ?? 0;
var smallestSectionHeight = Children.Count > 0 ? Children.Min(d => d.Height) : 0;
// scroll offset is our fixed header height if we have it plus 20% 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 scrollIntoSectionAmount = Math.Min(smallestSectionHeight / 2.0f, scrollContainer.DisplayableContent * 0.05f);
2021-01-21 05:44:47 +00:00
float scrollOffset = fixedHeaderSize + scrollContainer.DisplayableContent * scroll_target_multiplier + scrollIntoSectionAmount;
2018-04-13 09:19:50 +00:00
if (Precision.AlmostBigger(0, scrollContainer.Current))
SelectedSection.Value = lastClickedSection as T ?? Children.FirstOrDefault();
2021-01-21 05:44:47 +00:00
else if (Precision.AlmostBigger(scrollContainer.Current, scrollContainer.ScrollableExtent))
SelectedSection.Value = lastClickedSection as T ?? Children.LastOrDefault();
2021-01-21 05:44:47 +00:00
else
2021-01-21 05:46:35 +00:00
{
SelectedSection.Value = Children
.TakeWhile(section => scrollContainer.GetChildPosInContent(section) - currentScroll - scrollOffset <= 0)
.LastOrDefault() ?? Children.FirstOrDefault();
}
2018-04-13 09:19:50 +00:00
}
}
private void updateSectionsMargin()
{
if (!Children.Any()) return;
var newMargin = originalSectionsMargin;
2021-01-21 05:31:31 +00:00
newMargin.Top += (headerHeight ?? 0);
newMargin.Bottom += (footerHeight ?? 0);
scrollContentContainer.Margin = newMargin;
}
2018-04-13 09:19:50 +00:00
}
}