osu/osu.Game/Overlays/OverlayView.cs

80 lines
2.2 KiB
C#
Raw Normal View History

2020-04-16 08:42:21 +00:00
// 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.Allocation;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Game.Online.API;
namespace osu.Game.Overlays
{
/// <summary>
2020-04-20 06:25:58 +00:00
/// A subview containing online content, to be displayed inside a <see cref="FullscreenOverlay"/>.
2020-04-16 08:42:21 +00:00
/// </summary>
/// <remarks>
/// Automatically performs a data fetch on load.
/// </remarks>
/// <typeparam name="T">The type of the API response.</typeparam>
2020-04-20 06:25:58 +00:00
public abstract class OverlayView<T> : CompositeDrawable, IOnlineComponent
2020-04-16 08:42:21 +00:00
where T : class
{
[Resolved]
protected IAPIProvider API { get; private set; }
private APIRequest<T> request;
2020-04-16 08:42:21 +00:00
protected OverlayView()
{
RelativeSizeAxes = Axes.X;
AutoSizeAxes = Axes.Y;
}
protected override void LoadComplete()
{
base.LoadComplete();
API.Register(this);
}
/// <summary>
/// Create the API request for fetching data.
/// </summary>
2020-04-16 08:42:21 +00:00
protected abstract APIRequest<T> CreateRequest();
/// <summary>
/// Fired when results arrive from the main API request.
/// </summary>
/// <param name="response"></param>
2020-04-16 08:42:21 +00:00
protected abstract void OnSuccess(T response);
/// <summary>
/// Force a re-request for data from the API.
/// </summary>
protected void PerformFetch()
{
request?.Cancel();
request = CreateRequest();
request.Success += response => Schedule(() => OnSuccess(response));
API.Queue(request);
}
2020-04-16 08:42:21 +00:00
public virtual void APIStateChanged(IAPIProvider api, APIState state)
{
switch (state)
{
case APIState.Online:
PerformFetch();
2020-04-16 08:42:21 +00:00
break;
}
}
protected override void Dispose(bool isDisposing)
{
request?.Cancel();
API?.Unregister(this);
base.Dispose(isDisposing);
}
}
}