Surface - Removed the ArtemisSurface and reworked device loading

src/Artemis.Core/Services/Interfaces/IRgbService.cs

@@ -9,6 +9,22 @@ namespace Artemis.Core.Services
     /// </summary>
     public interface IRgbService : IArtemisService, IDisposable
     {
+        /// <summary>
+        ///     Gets a read-only collection containing all enabled devices
+        /// </summary>
+        IReadOnlyCollection<ArtemisDevice> EnabledDevices { get; }
+
+        /// <summary>
+        ///     Gets a read-only collection containing all registered devices
+        /// </summary>
+        IReadOnlyCollection<ArtemisDevice> Devices { get; }
+
+        /// <summary>
+        ///     Gets a dictionary containing all <see cref="ArtemisLed" />s on the surface with their corresponding RGB.NET
+        ///     <see cref="Led" /> as key
+        /// </summary>
+        IReadOnlyDictionary<Led, ArtemisLed> LedMap { get; }
+
         /// <summary>
         ///     Gets or sets the RGB surface rendering is performed on
         /// </summary>
@@ -19,16 +35,6 @@ namespace Artemis.Core.Services
         /// </summary>
         BitmapBrush? BitmapBrush { get; }
 
-        /// <summary>
-        ///     Gets the scale the frames are rendered on, a scale of 1.0 means 1 pixel = 1mm
-        /// </summary>
-        double RenderScale { get; }
-
-        /// <summary>
-        ///     Gets all loaded RGB devices
-        /// </summary>
-        IReadOnlyCollection<IRGBDevice> LoadedDevices { get; }
-
         /// <summary>
         ///     Gets the update trigger that drives the render loop
         /// </summary>
@@ -46,14 +52,66 @@ namespace Artemis.Core.Services
         void AddDeviceProvider(IRGBDeviceProvider deviceProvider);
 
         /// <summary>
-        ///     Occurs when a single device has loaded
+        ///     Removes the given device provider from the <see cref="Surface" />
         /// </summary>
-        event EventHandler<DeviceEventArgs> DeviceLoaded;
+        /// <param name="deviceProvider"></param>
+        void RemoveDeviceProvider(IRGBDeviceProvider deviceProvider);
 
         /// <summary>
-        ///     Occurs when a single device has reloaded
+        ///     Applies auto-arranging logic to the surface
         /// </summary>
-        event EventHandler<DeviceEventArgs> DeviceReloaded;
+        void AutoArrangeDevices();
+
+        /// <summary>
+        ///     Applies the best available layout for the given <see cref="ArtemisDevice" />
+        /// </summary>
+        /// <param name="device">The device to apply the best available layout to</param>
+        /// <returns>The layout that was applied to the device</returns>
+        ArtemisLayout ApplyBestDeviceLayout(ArtemisDevice device);
+
+        /// <summary>
+        ///     Apples the provided <see cref="ArtemisLayout" /> to the provided <see cref="ArtemisDevice" />
+        /// </summary>
+        /// <param name="device"></param>
+        /// <param name="layout"></param>
+        void ApplyDeviceLayout(ArtemisDevice device, ArtemisLayout layout);
+
+        /// <summary>
+        ///     Attempts to retrieve the <see cref="ArtemisDevice" /> that corresponds the provided RGB.NET
+        ///     <see cref="IRGBDevice" />
+        /// </summary>
+        /// <param name="rgbDevice">
+        ///     The RGB.NET <see cref="IRGBDevice" /> to find the corresponding <see cref="ArtemisDevice" />
+        ///     for
+        /// </param>
+        /// <returns>If found, the corresponding <see cref="ArtemisDevice" />; otherwise <see langword="null" />.</returns>
+        ArtemisDevice? GetDevice(IRGBDevice rgbDevice);
+
+        /// <summary>
+        ///     Attempts to retrieve the <see cref="ArtemisLed" /> that corresponds the provided RGB.NET <see cref="Led" />
+        /// </summary>
+        /// <param name="led">The RGB.NET <see cref="Led" /> to find the corresponding <see cref="ArtemisLed" /> for </param>
+        /// <returns>If found, the corresponding <see cref="ArtemisLed" />; otherwise <see langword="null" />.</returns>
+        ArtemisLed? GetLed(Led led);
+
+        /// <summary>
+        ///     Saves the configuration of the provided device to persistent storage
+        /// </summary>
+        /// <param name="artemisDevice"></param>
+        void SaveDevice(ArtemisDevice artemisDevice);
+
+        /// <summary>
+        ///     Saves the configuration of all current devices to persistent storage
+        /// </summary>
+        void SaveDevices();
+
+        void EnableDevice(ArtemisDevice device);
+        void DisableDevice(ArtemisDevice device);
+
+        /// <summary>
+        ///     Occurs when a single device was added
+        /// </summary>
+        event EventHandler<DeviceEventArgs> DeviceAdded;
 
         /// <summary>
         ///     Occurs when a single device was removed
@@ -61,9 +119,8 @@ namespace Artemis.Core.Services
         event EventHandler<DeviceEventArgs> DeviceRemoved;
 
         /// <summary>
-        ///     Recalculates the LED group used by the <see cref="BitmapBrush" />
+        /// Occurs when the surface has had modifications to its LED collection
         /// </summary>
-        /// <param name="artemisSurface"></param>
-        void UpdateSurfaceLedGroup(ArtemisSurface artemisSurface);
+        event EventHandler LedsChanged;
     }
 }