2019-01-24 08:43:03 +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.
2018-04-13 09:19:50 +00:00
2023-06-25 12:36:21 +00:00
using System ;
2023-06-23 05:58:19 +00:00
using System.Collections.Generic ;
2017-02-10 07:26:43 +00:00
using System.Linq ;
2022-06-16 08:28:08 +00:00
using osu.Framework.Allocation ;
using osu.Framework.Audio ;
using osu.Framework.Bindables ;
2023-05-23 09:47:56 +00:00
using osu.Framework.Extensions.Color4Extensions ;
2017-02-10 07:26:43 +00:00
using osu.Framework.Extensions.IEnumerableExtensions ;
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
2023-05-23 09:47:56 +00:00
using osu.Framework.Graphics.Effects ;
2017-06-20 05:54:23 +00:00
using osu.Framework.Graphics.Shapes ;
2021-04-21 05:37:11 +00:00
using osu.Framework.Localisation ;
2022-01-25 14:38:46 +00:00
using osu.Framework.Logging ;
2017-12-25 09:52:09 +00:00
using osu.Framework.Threading ;
2022-06-16 08:28:08 +00:00
using osu.Game.Graphics.Containers ;
using osu.Game.Overlays.Notifications ;
2022-01-28 04:53:48 +00:00
using osu.Game.Resources.Localisation.Web ;
2022-08-30 11:57:12 +00:00
using osuTK ;
2023-05-23 09:47:56 +00:00
using osuTK.Graphics ;
2022-01-28 04:53:48 +00:00
using NotificationsStrings = osu . Game . Localisation . NotificationsStrings ;
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
namespace osu.Game.Overlays
{
2022-04-18 10:59:57 +00:00
public partial class NotificationOverlay : OsuFocusedOverlayContainer , INamedOverlayComponent , INotificationOverlay
2017-02-10 07:26:43 +00:00
{
2020-09-03 08:05:45 +00:00
public string IconTexture = > "Icons/Hexacons/notification" ;
2021-04-21 05:37:11 +00:00
public LocalisableString Title = > NotificationsStrings . HeaderTitle ;
public LocalisableString Description = > NotificationsStrings . HeaderDescription ;
2020-09-03 06:46:56 +00:00
2023-08-17 02:37:07 +00:00
protected override double PopInOutSampleBalance = > OsuGameBase . SFX_STEREO_STRENGTH ;
2021-08-06 19:36:40 +00:00
public const float WIDTH = 320 ;
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
public const float TRANSITION_LENGTH = 600 ;
2018-04-13 09:19:50 +00:00
2023-06-23 05:58:19 +00:00
public IEnumerable < Notification > AllNotifications = >
2023-06-25 12:25:07 +00:00
IsLoaded ? toastTray . Notifications . Concat ( sections . SelectMany ( s = > s . Notifications ) ) : Array . Empty < Notification > ( ) ;
2023-06-21 09:27:29 +00:00
2022-06-16 08:28:08 +00:00
private FlowContainer < NotificationSection > sections = null ! ;
2018-04-13 09:19:50 +00:00
2021-09-05 04:22:37 +00:00
[Resolved]
2022-06-16 08:28:08 +00:00
private AudioManager audio { get ; set ; } = null ! ;
2021-09-05 04:22:37 +00:00
2023-08-21 21:36:54 +00:00
[Resolved]
2023-08-22 06:54:41 +00:00
private OsuGame ? game { get ; set ; }
2023-08-21 21:36:54 +00:00
2022-08-30 08:33:08 +00:00
[Cached]
private OverlayColourProvider colourProvider = new OverlayColourProvider ( OverlayColourScheme . Purple ) ;
2022-08-30 11:57:12 +00: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 08:28:08 +00:00
[BackgroundDependencyLoader]
2022-08-30 15:57:18 +00:00
private void load ( )
2017-02-10 07:26:43 +00:00
{
2021-08-06 22:27:54 +00:00
X = WIDTH ;
2021-08-06 19:36:40 +00:00
Width = WIDTH ;
2017-02-10 07:26:43 +00:00
RelativeSizeAxes = Axes . Y ;
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
Children = new Drawable [ ]
{
2022-08-30 11:57:12 +00:00
toastTray = new NotificationOverlayToastTray
2017-02-10 07:26:43 +00:00
{
2022-08-30 12:31:06 +00:00
ForwardNotificationToPermanentStore = addPermanently ,
2022-08-30 11:57:12 +00:00
Origin = Anchor . TopRight ,
2017-02-10 07:26:43 +00:00
} ,
2022-08-30 11:57:12 +00:00
mainContent = new Container
2017-02-10 07:26:43 +00:00
{
2017-02-17 19:08:28 +00:00
RelativeSizeAxes = Axes . Both ,
2023-05-23 09:47:56 +00:00
Masking = true ,
EdgeEffect = new EdgeEffectParameters
{
Colour = Color4 . Black . Opacity ( 0 ) ,
Type = EdgeEffectType . Shadow ,
Radius = 10 ,
Hollow = true ,
} ,
2022-08-30 11:57:12 +00:00
Children = new Drawable [ ]
2017-02-10 07:26:43 +00:00
{
2022-08-30 11:57:12 +00:00
new Box
2017-02-10 07:26:43 +00:00
{
2022-08-30 11:57:12 +00:00
RelativeSizeAxes = Axes . Both ,
Colour = colourProvider . Background4 ,
} ,
new OsuScrollContainer
{
Masking = true ,
RelativeSizeAxes = Axes . Both ,
2017-06-08 07:27:35 +00:00
Children = new [ ]
2017-02-10 07:26:43 +00:00
{
2022-08-30 11:57:12 +00:00
sections = new FillFlowContainer < NotificationSection >
{
Direction = FillDirection . Vertical ,
AutoSizeAxes = Axes . Y ,
RelativeSizeAxes = Axes . X ,
Children = new [ ]
{
2023-07-07 04:10:49 +00:00
new NotificationSection ( AccountsStrings . NotificationsTitle , new [ ] { typeof ( SimpleNotification ) } ) ,
new NotificationSection ( NotificationsStrings . RunningTasks , new [ ] { typeof ( ProgressNotification ) } ) ,
2022-08-30 11:57:12 +00:00
}
}
2017-02-10 07:26:43 +00:00
}
}
}
2022-08-30 11:57:12 +00:00
} ,
2017-02-10 07:26:43 +00:00
} ;
}
2018-04-13 09:19:50 +00:00
2022-06-16 08:28:08 +00:00
private ScheduledDelegate ? notificationsEnabler ;
2019-02-28 04:31:40 +00:00
2018-06-06 06:49:58 +00:00
private void updateProcessingMode ( )
{
2023-06-20 07:56:41 +00:00
bool enabled = OverlayActivationMode . Value ! = OverlayActivation . Disabled | | State . Value = = Visibility . Visible ;
2018-06-06 06:49:58 +00:00
notificationsEnabler ? . Cancel ( ) ;
if ( enabled )
// we want a slight delay before toggling notifications on to avoid the user becoming overwhelmed.
2022-09-27 08:32:30 +00:00
notificationsEnabler = Scheduler . AddDelayed ( ( ) = > processingPosts = true , State . Value = = Visibility . Visible ? 0 : 250 ) ;
2018-06-06 06:49:58 +00:00
else
2022-09-27 08:32:53 +00:00
{
2018-06-06 06:49:58 +00:00
processingPosts = false ;
2022-09-27 08:32:53 +00:00
toastTray . FlushAllToasts ( ) ;
}
2018-06-06 06:49:58 +00:00
}
protected override void LoadComplete ( )
{
base . LoadComplete ( ) ;
2022-06-16 08:26:43 +00:00
State . BindValueChanged ( _ = > updateProcessingMode ( ) ) ;
2018-08-23 02:20:20 +00:00
OverlayActivationMode . BindValueChanged ( _ = > updateProcessingMode ( ) , true ) ;
2018-06-06 06:49:58 +00:00
}
2022-04-19 02:10:11 +00:00
public IBindable < int > UnreadCount = > unreadCount ;
2022-08-30 15:57:30 +00:00
public int ToastCount = > toastTray . UnreadCount ;
2022-04-19 02:10:11 +00:00
private readonly BindableInt unreadCount = new BindableInt ( ) ;
2018-04-13 09:19:50 +00:00
2017-03-07 01:59:19 +00:00
private int runningDepth ;
2018-04-13 09:19:50 +00:00
2017-12-25 09:52:09 +00:00
private readonly Scheduler postScheduler = new Scheduler ( ) ;
2018-04-13 09:19:50 +00:00
2022-09-05 09:57:33 +00: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 10:06:21 +00:00
2017-12-25 09:52:09 +00:00
private bool processingPosts = true ;
2018-04-13 09:19:50 +00:00
2021-09-05 04:22:37 +00:00
private double? lastSamplePlayback ;
2017-12-26 07:10:57 +00:00
public void Post ( Notification notification ) = > postScheduler . Add ( ( ) = >
2017-02-10 07:26:43 +00:00
{
2017-12-25 16:50:05 +00:00
+ + runningDepth ;
2018-04-13 09:19:50 +00:00
2022-01-25 14:38:46 +00:00
Logger . Log ( $"⚠️ {notification.Text}" ) ;
2023-07-06 16:50:15 +00:00
notification . Closed + = ( ) = > notificationClosed ( notification ) ;
2018-04-13 09:19:50 +00:00
2019-02-28 05:35:00 +00:00
if ( notification is IHasCompletionTarget hasCompletionTarget )
2017-12-25 16:50:05 +00:00
hasCompletionTarget . CompletionTarget = Post ;
2018-04-13 09:19:50 +00:00
2022-08-30 12:13:27 +00:00
playDebouncedSample ( notification . PopInSampleName ) ;
2023-08-22 06:58:10 +00:00
if ( notification . IsImportant )
2023-08-21 21:36:54 +00:00
{
2023-08-22 06:58:10 +00:00
game ? . Window ? . Flash ( ) ;
2023-08-22 06:54:41 +00:00
notification . Closed + = ( ) = > game ? . Window ? . CancelFlash ( ) ;
2023-08-21 21:36:54 +00:00
}
2022-08-30 11:57:12 +00:00
if ( State . Value = = Visibility . Hidden )
2022-09-11 12:34:35 +00:00
{
2022-09-11 12:52:19 +00:00
notification . IsInToastTray = true ;
2022-08-30 12:31:06 +00:00
toastTray . Post ( notification ) ;
2022-09-11 12:34:35 +00:00
}
2022-08-30 11:57:12 +00:00
else
2022-08-30 12:31:06 +00:00
addPermanently ( notification ) ;
2022-08-30 16:40:27 +00:00
updateCounts ( ) ;
2022-08-30 12:31:06 +00:00
} ) ;
2018-04-13 09:19:50 +00:00
2022-08-30 12:31:06 +00:00
private void addPermanently ( Notification notification )
{
2022-09-11 12:52:19 +00:00
notification . IsInToastTray = false ;
2022-09-11 12:34:35 +00:00
2022-08-30 12:31:06 +00:00
var ourType = notification . GetType ( ) ;
int depth = notification . DisplayOnTop ? - runningDepth : runningDepth ;
2022-08-30 11:57:12 +00:00
2022-08-30 12:31:06 +00:00
var section = sections . Children . First ( s = > s . AcceptedNotificationTypes . Any ( accept = > accept . IsAssignableFrom ( ourType ) ) ) ;
2022-08-30 11:57:12 +00:00
2022-08-30 12:31:06 +00:00
section . Add ( notification , depth ) ;
updateCounts ( ) ;
}
2018-04-13 09:19:50 +00:00
2017-12-25 09:52:09 +00:00
protected override void Update ( )
{
base . Update ( ) ;
2021-09-05 03:54:21 +00:00
2017-12-25 09:52:09 +00:00
if ( processingPosts )
postScheduler . Update ( ) ;
}
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
protected override void PopIn ( )
{
2017-07-22 18:50:25 +00:00
this . MoveToX ( 0 , TRANSITION_LENGTH , Easing . OutQuint ) ;
2022-08-30 11:57:12 +00:00
mainContent . FadeTo ( 1 , TRANSITION_LENGTH , Easing . OutQuint ) ;
2023-05-24 03:38:27 +00:00
mainContent . FadeEdgeEffectTo ( WaveContainer . SHADOW_OPACITY , WaveContainer . APPEAR_DURATION , Easing . Out ) ;
2022-08-30 11:57:12 +00:00
toastTray . FlushAllToasts ( ) ;
2017-02-10 07:26:43 +00:00
}
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
protected override void PopOut ( )
{
base . PopOut ( ) ;
2018-04-13 09:19:50 +00:00
2017-02-10 07:26:43 +00:00
markAllRead ( ) ;
2018-04-13 09:19:50 +00:00
2021-08-06 19:36:40 +00:00
this . MoveToX ( WIDTH , TRANSITION_LENGTH , Easing . OutQuint ) ;
2022-08-30 11:57:12 +00:00
mainContent . FadeTo ( 0 , TRANSITION_LENGTH , Easing . OutQuint ) ;
2023-05-23 09:47:56 +00:00
mainContent . FadeEdgeEffectTo ( 0 , WaveContainer . DISAPPEAR_DURATION , Easing . In ) ;
2017-12-23 13:33:43 +00:00
}
2018-04-13 09:19:50 +00:00
2023-07-06 16:50:15 +00:00
private void notificationClosed ( Notification notification ) = > Schedule ( ( ) = >
2021-09-05 04:22:37 +00: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.
2023-07-06 16:50:15 +00:00
playDebouncedSample ( notification . PopOutSampleName ) ;
2022-09-16 07:36:56 +00:00
} ) ;
2021-09-05 04:22:37 +00:00
private void playDebouncedSample ( string sampleName )
{
2023-07-06 16:50:15 +00:00
if ( string . IsNullOrEmpty ( sampleName ) )
return ;
2021-09-05 04:25:10 +00:00
if ( lastSamplePlayback = = null | | Time . Current - lastSamplePlayback > OsuGameBase . SAMPLE_DEBOUNCE_TIME )
2021-09-05 04:22:37 +00:00
{
audio . Samples . Get ( sampleName ) ? . Play ( ) ;
lastSamplePlayback = Time . Current ;
}
}
2021-09-05 03:54:21 +00:00
2017-12-23 13:33:43 +00:00
private void markAllRead ( )
{
sections . Children . ForEach ( s = > s . MarkAllRead ( ) ) ;
2022-08-31 03:46:03 +00:00
toastTray . MarkAllRead ( ) ;
2017-12-25 16:50:05 +00:00
updateCounts ( ) ;
2017-12-23 13:33:43 +00:00
}
2022-08-31 03:46:43 +00:00
private void updateCounts ( )
{
unreadCount . Value = sections . Select ( c = > c . UnreadCount ) . Sum ( ) + toastTray . UnreadCount ;
}
2017-02-10 07:26:43 +00:00
}
2017-07-28 05:51:49 +00:00
}