Core - Split up RGBService into RenderService and DeviceService

Core - Removed rendering from CoreService
Core - Store and restore original device LEDs when applying/clearing layouts

src/Artemis.Core/Models/Surface/ArtemisDevice.cs

@@ -15,11 +15,17 @@ namespace Artemis.Core;
 /// </summary>
 public class ArtemisDevice : CorePropertyChanged
 {
+    private readonly List<OriginalLed> _originalLeds;
+    private readonly Size _originalSize;
     private SKPath? _path;
     private SKRect _rectangle;
 
     internal ArtemisDevice(IRGBDevice rgbDevice, DeviceProvider deviceProvider)
     {
+        _originalLeds = new List<OriginalLed>(rgbDevice.Select(l => new OriginalLed(l)));
+        Rectangle ledRectangle = new(rgbDevice.Select(x => x.Boundary));
+        _originalSize = ledRectangle.Size + new Size(ledRectangle.Location.X, ledRectangle.Location.Y);
+
         Identifier = rgbDevice.GetDeviceIdentifier();
         DeviceEntity = new DeviceEntity();
         RgbDevice = rgbDevice;
@@ -48,6 +54,10 @@ public class ArtemisDevice : CorePropertyChanged
 
     internal ArtemisDevice(IRGBDevice rgbDevice, DeviceProvider deviceProvider, DeviceEntity deviceEntity)
     {
+        _originalLeds = new List<OriginalLed>(rgbDevice.Select(l => new OriginalLed(l)));
+        Rectangle ledRectangle = new(rgbDevice.Select(x => x.Boundary));
+        _originalSize = ledRectangle.Size + new Size(ledRectangle.Location.X, ledRectangle.Location.Y);
+
         Identifier = rgbDevice.GetDeviceIdentifier();
         DeviceEntity = deviceEntity;
         RgbDevice = rgbDevice;
@@ -350,6 +360,40 @@ public class ArtemisDevice : CorePropertyChanged
         return artemisLed;
     }
 
+    /// <summary>
+    /// Returns the most preferred device layout for this device.
+    /// </summary>
+    /// <returns>The most preferred device layout for this device.</returns>
+    public ArtemisLayout? GetBestDeviceLayout()
+    {
+        ArtemisLayout? layout;
+
+        // Configured layout path takes precedence over all other options
+        if (CustomLayoutPath != null)
+        {
+            layout = new ArtemisLayout(CustomLayoutPath, LayoutSource.Configured);
+            if (layout.IsValid)
+                return layout;
+        }
+
+        // Look for a layout provided by the user
+        layout = DeviceProvider.LoadUserLayout(this);
+        if (layout.IsValid)
+            return layout;
+
+        if (DisableDefaultLayout)
+            return null;
+
+        // Look for a layout provided by the plugin
+        layout = DeviceProvider.LoadLayout(this);
+        if (layout.IsValid)
+            return layout;
+
+        // Finally fall back to a default layout
+        layout = ArtemisLayout.GetDefaultLayout(this);
+        return layout;
+    }
+
     /// <summary>
     ///     Occurs when the underlying RGB.NET device was updated
     /// </summary>
@@ -415,8 +459,18 @@ public class ArtemisDevice : CorePropertyChanged
     ///     A boolean indicating whether to remove excess LEDs present in the device but missing
     ///     in the layout
     /// </param>
-    internal void ApplyLayout(ArtemisLayout layout, bool createMissingLeds, bool removeExcessiveLeds)
+    internal void ApplyLayout(ArtemisLayout? layout, bool createMissingLeds, bool removeExcessiveLeds)
     {
+        if (layout == null)
+        {
+            ClearLayout();
+            UpdateLeds();
+            
+            CalculateRenderProperties();
+            OnDeviceUpdated();
+            return;
+        }
+
         if (createMissingLeds && !DeviceProvider.CreateMissingLedsSupported)
             throw new ArtemisCoreException($"Cannot apply layout with {nameof(createMissingLeds)} " +
                                            "set to true because the device provider does not support it");
@@ -424,18 +478,33 @@ public class ArtemisDevice : CorePropertyChanged
             throw new ArtemisCoreException($"Cannot apply layout with {nameof(removeExcessiveLeds)} " +
                                            "set to true because the device provider does not support it");
 
+        ClearLayout();
         if (layout.IsValid)
             layout.ApplyTo(RgbDevice, createMissingLeds, removeExcessiveLeds);
-
-
         UpdateLeds();
-
+        
         Layout = layout;
         Layout.ApplyDevice(this);
+        
         CalculateRenderProperties();
         OnDeviceUpdated();
     }
 
+    private void ClearLayout()
+    {
+        if (Layout == null)
+            return;
+        
+        RgbDevice.DeviceInfo.LayoutMetadata = null;
+        RgbDevice.Size = _originalSize;
+        Layout = null;
+
+        while (RgbDevice.Any())
+            RgbDevice.RemoveLed(RgbDevice.First().Id);
+        foreach (OriginalLed originalLed in _originalLeds)
+            RgbDevice.AddLed(originalLed.Id, originalLed.Location, originalLed.Size, originalLed.CustomData);
+    }
+
     internal void ApplyToEntity()
     {
         // Other properties are computed

src/Artemis.Core/Models/Surface/ArtemisLed.cs

@@ -59,13 +59,13 @@ public class ArtemisLed : CorePropertyChanged
 
     internal void CalculateRectangles()
     {
-        Rectangle = Utilities.CreateScaleCompatibleRect(
+        Rectangle = RenderScale.CreateScaleCompatibleRect(
             RgbLed.Boundary.Location.X,
             RgbLed.Boundary.Location.Y,
             RgbLed.Boundary.Size.Width,
             RgbLed.Boundary.Size.Height
         );
-        AbsoluteRectangle = Utilities.CreateScaleCompatibleRect(
+        AbsoluteRectangle = RenderScale.CreateScaleCompatibleRect(
             RgbLed.AbsoluteBoundary.Location.X,
             RgbLed.AbsoluteBoundary.Location.Y,
             RgbLed.AbsoluteBoundary.Size.Width,

src/Artemis.Core/Models/Surface/OriginalLed.cs

@@ -0,0 +1,19 @@
+using RGB.NET.Core;
+
+namespace Artemis.Core;
+
+internal class OriginalLed
+{
+    public OriginalLed(Led source)
+    {
+        Id = source.Id;
+        Location = source.Location;
+        Size = source.Size;
+        CustomData = source.CustomData;
+    }
+
+    public LedId Id { get; set; }
+    public Point Location { get; set; }
+    public Size Size { get; set; }
+    public object? CustomData { get; set; }
+}