2019-01-24 16:43:03 +08: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.
2018-04-13 17:19:50 +08:00
using System.Linq ;
2022-06-16 16:28:08 +08:00
using osu.Framework.Allocation ;
using osu.Framework.Audio ;
using osu.Framework.Bindables ;
2018-04-13 17:19:50 +08:00
using osu.Framework.Extensions.IEnumerableExtensions ;
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
using osu.Framework.Graphics.Shapes ;
2021-04-21 13:37:11 +08:00
using osu.Framework.Localisation ;
2022-01-25 22:38:46 +08:00
using osu.Framework.Logging ;
2018-04-13 17:19:50 +08:00
using osu.Framework.Threading ;
2022-06-16 16:28:08 +08:00
using osu.Game.Graphics.Containers ;
using osu.Game.Overlays.Notifications ;
2022-01-28 12:53:48 +08:00
using osu.Game.Resources.Localisation.Web ;
2022-08-30 19:57:12 +08:00
using osuTK ;
2022-01-28 12:53:48 +08:00
using NotificationsStrings = osu . Game . Localisation . NotificationsStrings ;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Overlays
{
2022-04-18 18:59:57 +08:00
public class NotificationOverlay : OsuFocusedOverlayContainer , INamedOverlayComponent , INotificationOverlay
2018-04-13 17:19:50 +08:00
{
2020-09-03 16:05:45 +08:00
public string IconTexture = > "Icons/Hexacons/notification" ;
2021-04-21 13:37:11 +08:00
public LocalisableString Title = > NotificationsStrings . HeaderTitle ;
public LocalisableString Description = > NotificationsStrings . HeaderDescription ;
2020-09-03 14:46:56 +08:00
2021-08-07 03:36:40 +08:00
public const float WIDTH = 320 ;
2018-04-13 17:19:50 +08:00
public const float TRANSITION_LENGTH = 600 ;
2022-06-16 16:28:08 +08:00
private FlowContainer < NotificationSection > sections = null ! ;
2018-04-13 17:19:50 +08:00
2021-09-05 12:22:37 +08:00
[Resolved]
2022-06-16 16:28:08 +08:00
private AudioManager audio { get ; set ; } = null ! ;
2021-09-05 12:22:37 +08:00
2022-08-30 16:33:08 +08:00
[Cached]
private OverlayColourProvider colourProvider = new OverlayColourProvider ( OverlayColourScheme . Purple ) ;
2022-08-30 19:57:12 +08:00
public override bool ReceivePositionalInputAt ( Vector2 screenSpacePos )
{
if ( State . Value = = Visibility . Visible )
return base . ReceivePositionalInputAt ( screenSpacePos ) ;
if ( toastTray . IsDisplayingToasts )
return toastTray . ReceivePositionalInputAt ( screenSpacePos ) ;
return false ;
}
public override bool PropagatePositionalInputSubTree = > base . PropagatePositionalInputSubTree | | toastTray . IsDisplayingToasts ;
private NotificationOverlayToastTray toastTray = null ! ;
private Container mainContent = null ! ;
2022-06-16 16:28:08 +08:00
[BackgroundDependencyLoader]
2022-08-30 23:57:18 +08:00
private void load ( )
2018-04-13 17:19:50 +08:00
{
2021-08-07 06:27:54 +08:00
X = WIDTH ;
2021-08-07 03:36:40 +08:00
Width = WIDTH ;
2018-04-13 17:19:50 +08:00
RelativeSizeAxes = Axes . Y ;
Children = new Drawable [ ]
{
2022-08-30 19:57:12 +08:00
toastTray = new NotificationOverlayToastTray
2018-04-13 17:19:50 +08:00
{
2022-08-30 20:31:06 +08:00
ForwardNotificationToPermanentStore = addPermanently ,
2022-08-30 19:57:12 +08:00
Origin = Anchor . TopRight ,
2018-04-13 17:19:50 +08:00
} ,
2022-08-30 19:57:12 +08:00
mainContent = new Container
2018-04-13 17:19:50 +08:00
{
RelativeSizeAxes = Axes . Both ,
2022-08-30 19:57:12 +08:00
Children = new Drawable [ ]
2018-04-13 17:19:50 +08:00
{
2022-08-30 19:57:12 +08:00
new Box
2018-04-13 17:19:50 +08:00
{
2022-08-30 19:57:12 +08:00
RelativeSizeAxes = Axes . Both ,
Colour = colourProvider . Background4 ,
} ,
new OsuScrollContainer
{
Masking = true ,
RelativeSizeAxes = Axes . Both ,
2018-04-13 17:19:50 +08:00
Children = new [ ]
{
2022-08-30 19:57:12 +08:00
sections = new FillFlowContainer < NotificationSection >
{
Direction = FillDirection . Vertical ,
AutoSizeAxes = Axes . Y ,
RelativeSizeAxes = Axes . X ,
Children = new [ ]
{
new NotificationSection ( AccountsStrings . NotificationsTitle , new [ ] { typeof ( SimpleNotification ) } , "Clear All" ) ,
new NotificationSection ( @"Running Tasks" , new [ ] { typeof ( ProgressNotification ) } , @"Cancel All" ) ,
}
}
2018-04-13 17:19:50 +08:00
}
}
}
2022-08-30 19:57:12 +08:00
} ,
2018-04-13 17:19:50 +08:00
} ;
}
2022-06-16 16:28:08 +08:00
private ScheduledDelegate ? notificationsEnabler ;
2019-02-28 12:31:40 +08:00
2018-06-06 14:49:58 +08:00
private void updateProcessingMode ( )
{
2022-08-30 23:57:18 +08:00
bool enabled = OverlayActivationMode . Value = = OverlayActivation . All | | State . Value = = Visibility . Visible ;
2018-06-06 14:49:58 +08:00
notificationsEnabler ? . Cancel ( ) ;
if ( enabled )
// we want a slight delay before toggling notifications on to avoid the user becoming overwhelmed.
2022-09-27 16:32:30 +08:00
notificationsEnabler = Scheduler . AddDelayed ( ( ) = > processingPosts = true , State . Value = = Visibility . Visible ? 0 : 250 ) ;
2018-06-06 14:49:58 +08:00
else
2022-09-27 16:32:53 +08:00
{
2018-06-06 14:49:58 +08:00
processingPosts = false ;
2022-09-27 16:32:53 +08:00
toastTray . FlushAllToasts ( ) ;
}
2018-06-06 14:49:58 +08:00
}
protected override void LoadComplete ( )
{
base . LoadComplete ( ) ;
2022-06-16 16:26:43 +08:00
State . BindValueChanged ( _ = > updateProcessingMode ( ) ) ;
2018-08-23 10:20:20 +08:00
OverlayActivationMode . BindValueChanged ( _ = > updateProcessingMode ( ) , true ) ;
2018-06-06 14:49:58 +08:00
}
2022-04-19 10:10:11 +08:00
public IBindable < int > UnreadCount = > unreadCount ;
2022-08-30 23:57:30 +08:00
public int ToastCount = > toastTray . UnreadCount ;
2022-04-19 10:10:11 +08:00
private readonly BindableInt unreadCount = new BindableInt ( ) ;
2018-04-13 17:19:50 +08:00
private int runningDepth ;
private readonly Scheduler postScheduler = new Scheduler ( ) ;
2022-09-05 17:57:33 +08:00
public override bool IsPresent = >
// Delegate presence as we need to consider the toast tray in addition to the main overlay.
State . Value = = Visibility . Visible | | mainContent . IsPresent | | toastTray . IsPresent | | postScheduler . HasPendingTasks ;
2019-06-20 18:06:21 +08:00
2018-04-13 17:19:50 +08:00
private bool processingPosts = true ;
2021-09-05 12:22:37 +08:00
private double? lastSamplePlayback ;
2018-04-13 17:19:50 +08:00
public void Post ( Notification notification ) = > postScheduler . Add ( ( ) = >
{
+ + runningDepth ;
2022-01-25 22:38:46 +08:00
Logger . Log ( $"⚠️ {notification.Text}" ) ;
2018-04-13 17:19:50 +08:00
notification . Closed + = notificationClosed ;
2019-02-28 13:35:00 +08:00
if ( notification is IHasCompletionTarget hasCompletionTarget )
2018-04-13 17:19:50 +08:00
hasCompletionTarget . CompletionTarget = Post ;
2022-08-30 20:13:27 +08:00
playDebouncedSample ( notification . PopInSampleName ) ;
2022-08-30 19:57:12 +08:00
if ( State . Value = = Visibility . Hidden )
2022-09-11 20:34:35 +08:00
{
2022-09-11 20:52:19 +08:00
notification . IsInToastTray = true ;
2022-08-30 20:31:06 +08:00
toastTray . Post ( notification ) ;
2022-09-11 20:34:35 +08:00
}
2022-08-30 19:57:12 +08:00
else
2022-08-30 20:31:06 +08:00
addPermanently ( notification ) ;
2022-08-31 00:40:27 +08:00
updateCounts ( ) ;
2022-08-30 20:31:06 +08:00
} ) ;
2018-04-13 17:19:50 +08:00
2022-08-30 20:31:06 +08:00
private void addPermanently ( Notification notification )
{
2022-09-11 20:52:19 +08:00
notification . IsInToastTray = false ;
2022-09-11 20:34:35 +08:00
2022-08-30 20:31:06 +08:00
var ourType = notification . GetType ( ) ;
int depth = notification . DisplayOnTop ? - runningDepth : runningDepth ;
2022-08-30 19:57:12 +08:00
2022-08-30 20:31:06 +08:00
var section = sections . Children . First ( s = > s . AcceptedNotificationTypes . Any ( accept = > accept . IsAssignableFrom ( ourType ) ) ) ;
2022-08-30 19:57:12 +08:00
2022-08-30 20:31:06 +08:00
section . Add ( notification , depth ) ;
updateCounts ( ) ;
}
2018-04-13 17:19:50 +08:00
protected override void Update ( )
{
base . Update ( ) ;
2021-09-05 11:54:21 +08:00
2018-04-13 17:19:50 +08:00
if ( processingPosts )
postScheduler . Update ( ) ;
}
protected override void PopIn ( )
{
base . PopIn ( ) ;
this . MoveToX ( 0 , TRANSITION_LENGTH , Easing . OutQuint ) ;
2022-08-30 19:57:12 +08:00
mainContent . FadeTo ( 1 , TRANSITION_LENGTH , Easing . OutQuint ) ;
toastTray . FlushAllToasts ( ) ;
2018-04-13 17:19:50 +08:00
}
protected override void PopOut ( )
{
base . PopOut ( ) ;
markAllRead ( ) ;
2021-08-07 03:36:40 +08:00
this . MoveToX ( WIDTH , TRANSITION_LENGTH , Easing . OutQuint ) ;
2022-08-30 19:57:12 +08:00
mainContent . FadeTo ( 0 , TRANSITION_LENGTH , Easing . OutQuint ) ;
2018-04-13 17:19:50 +08:00
}
2022-09-16 15:36:56 +08:00
private void notificationClosed ( ) = > Schedule ( ( ) = >
2021-09-05 12:22:37 +08:00
{
updateCounts ( ) ;
// this debounce is currently shared between popin/popout sounds, which means one could potentially not play when the user is expecting it.
// popout is constant across all notification types, and should therefore be handled using playback concurrency instead, but seems broken at the moment.
playDebouncedSample ( "UI/overlay-pop-out" ) ;
2022-09-16 15:36:56 +08:00
} ) ;
2021-09-05 12:22:37 +08:00
private void playDebouncedSample ( string sampleName )
{
2021-09-05 12:25:10 +08:00
if ( lastSamplePlayback = = null | | Time . Current - lastSamplePlayback > OsuGameBase . SAMPLE_DEBOUNCE_TIME )
2021-09-05 12:22:37 +08:00
{
audio . Samples . Get ( sampleName ) ? . Play ( ) ;
lastSamplePlayback = Time . Current ;
}
}
2021-09-05 11:54:21 +08:00
2018-04-13 17:19:50 +08:00
private void markAllRead ( )
{
sections . Children . ForEach ( s = > s . MarkAllRead ( ) ) ;
2022-08-31 11:46:03 +08:00
toastTray . MarkAllRead ( ) ;
2018-04-13 17:19:50 +08:00
updateCounts ( ) ;
}
2022-08-31 11:46:43 +08:00
private void updateCounts ( )
{
unreadCount . Value = sections . Select ( c = > c . UnreadCount ) . Sum ( ) + toastTray . UnreadCount ;
}
2018-04-13 17:19:50 +08:00
}
}