From 9367114cff0fa79fcd50ccd8ac6cd12bdafd3d03 Mon Sep 17 00:00:00 2001
From: F K <54195004+fredjk-gh@users.noreply.github.com>
Date: Sun, 23 Jan 2022 09:34:52 -0500
Subject: [PATCH] Show notification with genetic sampling status while in
 progress (#51)

* Show notification with genetic sampling status while in progress

When first sample is taken, the notification is displayed showing what was sampled and number of samples taken. Number of samples taken is updated on the second sample. Notification is removed when the final sample is taken.

* Add setting and additional notification cleanup conditions

As requested:
- Added a setting to control the genetic sampler overlay.
- Added a few  more conditions (FSDJump, LeaveBody, Shutdown) to clean up the notification.
---
 ObservatoryBotanist/Botanist.cs         | 47 +++++++++++++++++++++++--
 ObservatoryBotanist/BotanistSettings.cs | 15 ++++++++
 2 files changed, 59 insertions(+), 3 deletions(-)
 create mode 100644 ObservatoryBotanist/BotanistSettings.cs

diff --git a/ObservatoryBotanist/Botanist.cs b/ObservatoryBotanist/Botanist.cs
index 0540a72..339e66d 100644
--- a/ObservatoryBotanist/Botanist.cs
+++ b/ObservatoryBotanist/Botanist.cs
@@ -30,7 +30,11 @@ namespace Observatory.Botanist
         ObservableCollection<object> GridCollection;
         private PluginUI pluginUI;
         private bool readAllInProgress = false;
-
+        private Guid? samplerStatusNotification = null;
+        private BotanistSettings botanistSettings = new()
+        {
+            OverlayEnabled = true,
+        };
         public string Name => "Observatory Botanist";
 
         public string ShortName => "Botanist";
@@ -39,7 +43,7 @@ namespace Observatory.Botanist
 
         public PluginUI PluginUI => pluginUI;
 
-        public object Settings { get => null; set { } }
+        public object Settings { get => botanistSettings; set { botanistSettings = (BotanistSettings)value;  } }
 
         public void JournalEvent<TJournal>(TJournal journal) where TJournal : JournalBase
         {
@@ -82,7 +86,7 @@ namespace Observatory.Botanist
                         var systemBodyId = (scanOrganic.SystemAddress, scanOrganic.Body);
                         if (!BioPlanets.ContainsKey(systemBodyId))
                         {
-                            //Unlikely to ever end up in here, but just in case create a new planet entry.
+                            // Unlikely to ever end up in here, but just in case create a new planet entry.
                             List<string> genus = new();
                             List<string> species = new();
                             genus.Add(scanOrganic.Genus_Localised);
@@ -98,6 +102,25 @@ namespace Observatory.Botanist
                             {
                                 case ScanOrganicType.Log:
                                 case ScanOrganicType.Sample:
+                                    if (!readAllInProgress && botanistSettings.OverlayEnabled)
+                                    {
+                                        NotificationArgs args = new()
+                                        {
+                                            Title = scanOrganic.Species_Localised,
+                                            Detail = string.Format("Sample {0} of 3", scanOrganic.ScanType == ScanOrganicType.Log ? 1 : 2),
+                                            Rendering = NotificationRendering.NativeVisual,
+                                            Timeout = 0,
+                                        };
+                                        if (samplerStatusNotification == null)
+                                        {
+                                            samplerStatusNotification = Core.SendNotification(args);
+                                        }
+                                        else
+                                        {
+                                            Core.UpdateNotification(samplerStatusNotification.Value, args);
+                                        }
+                                    }
+
                                     if (!bioPlanet.speciesFound.Contains(scanOrganic.Species_Localised))
                                     {
                                         bioPlanet.speciesFound.Add(scanOrganic.Species_Localised);
@@ -108,12 +131,30 @@ namespace Observatory.Botanist
                                     {
                                         bioPlanet.speciesAnalysed.Add(scanOrganic.Species_Localised);
                                     }
+                                    MaybeCloseSamplerStatusNotification();
                                     break;
                             }
                         }
                         UpdateUIGrid();
                     }
                     break;
+                case LeaveBody:
+                case FSDJump:
+                case Shutdown:
+                    // These are all good reasons to kill any open notification. Note that SupercruiseEntry is NOT a
+                    // suitable reason to close the notification as the player hopping out only to double check the
+                    // DSS map for another location. Note that a game client crash will not close the status notification.
+                    MaybeCloseSamplerStatusNotification();
+                    break;
+            }
+        }
+
+        private void MaybeCloseSamplerStatusNotification()
+        {
+            if (samplerStatusNotification != null)
+            {
+                Core.CancelNotification(samplerStatusNotification.Value);
+                samplerStatusNotification = null;
             }
         }
 
diff --git a/ObservatoryBotanist/BotanistSettings.cs b/ObservatoryBotanist/BotanistSettings.cs
new file mode 100644
index 0000000..edf6018
--- /dev/null
+++ b/ObservatoryBotanist/BotanistSettings.cs
@@ -0,0 +1,15 @@
+using Observatory.Framework;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Observatory.Botanist
+{
+    class BotanistSettings
+    {
+        [SettingDisplayName("Enable Sampler Status Overlay")]
+        public bool OverlayEnabled { get; set; }
+    }
+}