h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-13 16:32:54 +08:00
Code Issues Releases Wiki Activity

Further refactor and simplify ChannelScrollContainer

Browse Source
This commit is contained in:
Salman Ahmed 2022-03-06 23:34:12 +03:00
parent 634821e49f
commit 9bc1f3f014
3 changed files with 79 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
osu.Game.Tests/Visual/Online/TestSceneStandAloneChatDisplay.cs
View File

@ -9,7 +9,6 @@ using System;
using System.Linq;
using NUnit.Framework;
using osu.Framework.Graphics.Containers;
using osu.Game.Graphics.Containers;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Overlays.Chat;
using osuTK.Input;
@ -337,7 +336,7 @@ namespace osu.Game.Tests.Visual.Online
public DrawableChannel DrawableChannel => InternalChildren.OfType<DrawableChannel>().First();
public UserTrackingScrollContainer ScrollContainer => (UserTrackingScrollContainer)((Container)DrawableChannel.Child).Child;
public ChannelScrollContainer ScrollContainer => (ChannelScrollContainer)((Container)DrawableChannel.Child).Child;
public FillFlowContainer FillFlow => (FillFlowContainer)ScrollContainer.Child;

78
osu.Game/Overlays/Chat/ChannelScrollContainer.cs Normal file
View File

@ -0,0 +1,78 @@
// 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 osu.Framework.Graphics;
using osu.Framework.Utils;
using osu.Game.Graphics.Containers;
namespace osu.Game.Overlays.Chat
{
/// <summary>
/// An <see cref="OsuScrollContainer"/> with functionality to automatically scroll whenever the maximum scrollable distance increases.
/// </summary>
public class ChannelScrollContainer : OsuScrollContainer
{
/// <summary>
/// The chat will be automatically scrolled to end if and only if
/// the distance between the current scroll position and the end of the scroll
/// is less than this value.
/// </summary>
private const float auto_scroll_leniency = 10f;
private bool trackNewContent = true;
protected override void Update()
{
base.Update();
// If our behaviour hasn't been overriden and there has been new content added to the container, we should update our scroll position to track it.
bool requiresScrollUpdate = trackNewContent && !IsScrolledToEnd();
if (requiresScrollUpdate)
{
// Schedule required to allow FillFlow to be the correct size.
Schedule(() =>
{
if (trackNewContent)
{
if (Current < ScrollableExtent)
ScrollToEnd();
}
});
}
}
private void updateTrackState() => trackNewContent = IsScrolledToEnd(auto_scroll_leniency);
// todo: we may eventually want this encapsulated in a "OnScrollChange" event handler method provided by ScrollContainer.
// important to note that this intentionally doesn't consider OffsetScrollPosition, but could make it do so with side changes.
#region Scroll handling
protected override void OnUserScroll(float value, bool animated = true, double? distanceDecay = null)
{
base.OnUserScroll(value, animated, distanceDecay);
updateTrackState();
}
public new void ScrollIntoView(Drawable d, bool animated = true)
{
base.ScrollIntoView(d, animated);
updateTrackState();
}
public new void ScrollToStart(bool animated = true, bool allowDuringDrag = false)
{
base.ScrollToStart(animated, allowDuringDrag);
updateTrackState();
}
public new void ScrollToEnd(bool animated = true, bool allowDuringDrag = false)
{
base.ScrollToEnd(animated, allowDuringDrag);
updateTrackState();
}
#endregion
}
}

50
osu.Game/Overlays/Chat/DrawableChannel.cs
View File

@ -11,9 +11,7 @@ using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Shapes;
using osu.Framework.Graphics.Sprites;
using osu.Framework.Utils;
using osu.Game.Graphics;
using osu.Game.Graphics.Containers;
using osu.Game.Graphics.Cursor;
using osu.Game.Graphics.Sprites;
using osu.Game.Online.Chat;
@ -236,53 +234,5 @@ namespace osu.Game.Overlays.Chat
};
}
}
/// <summary>
/// An <see cref="OsuScrollContainer"/> with functionality to automatically scroll whenever the maximum scrollable distance increases.
/// </summary>
private class ChannelScrollContainer : UserTrackingScrollContainer
{
/// <summary>
/// The chat will be automatically scrolled to end if and only if
/// the distance between the current scroll position and the end of the scroll
/// is less than this value.
/// </summary>
private const float auto_scroll_leniency = 10f;
private bool trackNewContent = true;
private float? lastExtent;
protected override void OnScrollChange(bool byUser)
{
base.OnScrollChange(byUser);
if (byUser)
lastExtent = null;
trackNewContent = IsScrolledToEnd(auto_scroll_leniency);
}
protected override void Update()
{
base.Update();
// If the user hasn't overridden our behaviour and there has been new content added to the container, we should update our scroll position to track it.
bool requiresScrollUpdate = trackNewContent && (lastExtent == null || Precision.AlmostBigger(ScrollableExtent, lastExtent.Value));
if (requiresScrollUpdate)
{
// Schedule required to allow FillFlow to be the correct size.
Schedule(() =>
{
if (trackNewContent)
{
if (Current < ScrollableExtent)
ScrollToEnd();
lastExtent = ScrollableExtent;
}
});
}
}
}
}
}