Profiles - Added profile adaption based on configurable hints

Layers - Added hints UI accesible from profile tree
Surface - Added device categories used by profile adaption

src/Artemis.Core/Models/Profile/AdaptionHints/CategoryAdaptionHint.cs

@@ -0,0 +1,75 @@
+using System.Collections.Generic;
+using System.Linq;
+using Artemis.Storage.Entities.Profile.AdaptionHints;
+
+namespace Artemis.Core
+{
+    /// <summary>
+    ///     Represents a hint that adapts layers to a certain category of devices
+    /// </summary>
+    public class CategoryAdaptionHint : IAdaptionHint
+    {
+        public CategoryAdaptionHint()
+        {
+        }
+
+        internal CategoryAdaptionHint(CategoryAdaptionHintEntity entity)
+        {
+            Category = (DeviceCategory) entity.Category;
+            Skip = entity.Skip;
+            LimitAmount = entity.LimitAmount;
+            Amount = entity.Amount;
+        }
+
+        /// <summary>
+        ///     Gets or sets the category of devices LEDs will be applied to
+        /// </summary>
+        public DeviceCategory Category { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the amount of devices to skip
+        /// </summary>
+        public int Skip { get; set; }
+
+        /// <summary>
+        ///     Gets or sets a boolean indicating whether a limited amount of devices should be used
+        /// </summary>
+        public bool LimitAmount { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the amount of devices to limit to if <see cref="LimitAmount" /> is <see langword="true" />
+        /// </summary>
+        public int Amount { get; set; }
+
+        #region Implementation of IAdaptionHint
+
+        /// <inheritdoc />
+        public void Apply(Layer layer, List<ArtemisDevice> devices)
+        {
+            IEnumerable<ArtemisDevice> matches = devices
+                .Where(d => d.Categories.Contains(Category))
+                .OrderBy(d => d.Rectangle.Top)
+                .ThenBy(d => d.Rectangle.Left)
+                .Skip(Skip);
+            if (LimitAmount)
+                matches = matches.Take(Amount);
+
+            foreach (ArtemisDevice artemisDevice in matches)
+                layer.AddLeds(artemisDevice.Leds);
+        }
+
+        /// <inheritdoc />
+        public IAdaptionHintEntity GetEntry()
+        {
+            return new CategoryAdaptionHintEntity {Amount = Amount, LimitAmount = LimitAmount, Category = (int) Category, Skip = Skip};
+        }
+
+        #endregion
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"Category adaption - {nameof(Category)}: {Category}, {nameof(Skip)}: {Skip}, {nameof(LimitAmount)}: {LimitAmount}, {nameof(Amount)}: {Amount}";
+        }
+    }
+}

src/Artemis.Core/Models/Profile/AdaptionHints/DeviceAdaptionHint.cs

@@ -0,0 +1,76 @@
+using System.Collections.Generic;
+using System.Linq;
+using Artemis.Storage.Entities.Profile.AdaptionHints;
+using RGB.NET.Core;
+
+namespace Artemis.Core
+{
+    /// <summary>
+    ///     Represents a hint that adapts layers to a certain type of devices
+    /// </summary>
+    public class DeviceAdaptionHint : IAdaptionHint
+    {
+        public DeviceAdaptionHint()
+        {
+        }
+
+        internal DeviceAdaptionHint(DeviceAdaptionHintEntity entity)
+        {
+            DeviceType = (RGBDeviceType) entity.DeviceType;
+            Skip = entity.Skip;
+            LimitAmount = entity.LimitAmount;
+            Amount = entity.Amount;
+        }
+
+        /// <summary>
+        ///     Gets or sets the type of devices LEDs will be applied to
+        /// </summary>
+        public RGBDeviceType DeviceType { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the amount of devices to skip
+        /// </summary>
+        public int Skip { get; set; }
+
+        /// <summary>
+        ///     Gets or sets a boolean indicating whether a limited amount of devices should be used
+        /// </summary>
+        public bool LimitAmount { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the amount of devices to limit to if <see cref="LimitAmount" /> is <see langword="true" />
+        /// </summary>
+        public int Amount { get; set; }
+
+        #region Implementation of IAdaptionHint
+
+        /// <inheritdoc />
+        public void Apply(Layer layer, List<ArtemisDevice> devices)
+        {
+            IEnumerable<ArtemisDevice> matches = devices
+                .Where(d => d.RgbDevice.DeviceInfo.DeviceType == DeviceType)
+                .OrderBy(d => d.Rectangle.Top)
+                .ThenBy(d => d.Rectangle.Left)
+                .Skip(Skip);
+            if (LimitAmount)
+                matches = matches.Take(Amount);
+
+            foreach (ArtemisDevice artemisDevice in matches)
+                layer.AddLeds(artemisDevice.Leds);
+        }
+
+        /// <inheritdoc />
+        public IAdaptionHintEntity GetEntry()
+        {
+            return new DeviceAdaptionHintEntity {Amount = Amount, LimitAmount = LimitAmount, DeviceType = (int) DeviceType, Skip = Skip};
+        }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"Device adaption - {nameof(DeviceType)}: {DeviceType}, {nameof(Skip)}: {Skip}, {nameof(LimitAmount)}: {LimitAmount}, {nameof(Amount)}: {Amount}";
+        }
+
+        #endregion
+    }
+}

src/Artemis.Core/Models/Profile/AdaptionHints/IAdaptionHint.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using Artemis.Storage.Entities.Profile.AdaptionHints;
+
+namespace Artemis.Core
+{
+    /// <summary>
+    ///     Represents an adaption hint that's used to adapt a layer to a set of devices
+    /// </summary>
+    public interface IAdaptionHint
+    {
+        /// <summary>
+        ///     Applies the adaptive action to the provided layer
+        /// </summary>
+        /// <param name="layer">The layer to adapt</param>
+        /// <param name="devices">The devices to adapt the layer for</param>
+        void Apply(Layer layer, List<ArtemisDevice> devices);
+
+        /// <summary>
+        ///     Returns an adaption hint entry for this adaption hint used for persistent storage
+        /// </summary>
+        IAdaptionHintEntity GetEntry();
+    }
+}

src/Artemis.Core/Models/Profile/AdaptionHints/KeyboardSectionAdaptionHint.cs

@@ -0,0 +1,83 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Artemis.Storage.Entities.Profile.AdaptionHints;
+using RGB.NET.Core;
+
+namespace Artemis.Core
+{
+    /// <summary>
+    ///     Represents a hint that adapts layers to a certain region of keyboards
+    /// </summary>
+    public class KeyboardSectionAdaptionHint : IAdaptionHint
+    {
+        private static readonly Dictionary<KeyboardSection, List<LedId>> RegionLedIds = new()
+        {
+            {KeyboardSection.MacroKeys, Enum.GetValues<LedId>().Where(l => l >= LedId.Keyboard_Programmable1 && l <= LedId.Keyboard_Programmable32).ToList()},
+            {KeyboardSection.LedStrips, Enum.GetValues<LedId>().Where(l => l >= LedId.LedStripe1 && l <= LedId.LedStripe128).ToList()},
+            {KeyboardSection.Extra, Enum.GetValues<LedId>().Where(l => l >= LedId.Keyboard_Custom1 && l <= LedId.Keyboard_Custom64).ToList()}
+        };
+
+        public KeyboardSectionAdaptionHint()
+        {
+        }
+
+        internal KeyboardSectionAdaptionHint(KeyboardSectionAdaptionHintEntity entity)
+        {
+            Section = (KeyboardSection) entity.Section;
+        }
+
+        /// <summary>
+        ///     Gets or sets the section this hint will apply LEDs to
+        /// </summary>
+        public KeyboardSection Section { get; set; }
+
+        #region Implementation of IAdaptionHint
+
+        /// <inheritdoc />
+        public void Apply(Layer layer, List<ArtemisDevice> devices)
+        {
+            // Only keyboards should have the LEDs we care about
+            foreach (ArtemisDevice keyboard in devices.Where(d => d.RgbDevice.DeviceInfo.DeviceType == RGBDeviceType.Keyboard))
+            {
+                List<LedId> ledIds = RegionLedIds[Section];
+                layer.AddLeds(keyboard.Leds.Where(l => ledIds.Contains(l.RgbLed.Id)));
+            }
+        }
+
+        /// <inheritdoc />
+        public IAdaptionHintEntity GetEntry()
+        {
+            return new KeyboardSectionAdaptionHintEntity {Section = (int) Section};
+        }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"Keyboard section adaption - {nameof(Section)}: {Section}";
+        }
+
+        #endregion
+    }
+
+    /// <summary>
+    ///     Represents a section of LEDs on a keyboard
+    /// </summary>
+    public enum KeyboardSection
+    {
+        /// <summary>
+        ///     A region containing the macro keys of a keyboard
+        /// </summary>
+        MacroKeys,
+
+        /// <summary>
+        ///     A region containing the LED strips of a keyboard
+        /// </summary>
+        LedStrips,
+
+        /// <summary>
+        ///     A region containing extra non-standard LEDs of a keyboard
+        /// </summary>
+        Extra
+    }
+}