Separate all light effects from whole keyboard effects

LenovoLegionToolkit.Lib/Controllers/SpectrumKeyboardBacklightController.cs

@@ -695,15 +695,18 @@ private unsafe void GetFeature(SafeFileHandle handle, out byte[] bytes, int size
 
     private static SpectrumKeyboardBacklightEffect[] Compress(SpectrumKeyboardBacklightEffect[] effects)
     {
-        if (effects.Any(e => e.Keys.All))
-            return new[] { effects.Last(e => e.Keys.All) };
+        if (effects.Any(e => e.Type.IsAllLightsEffect()))
+            return new[] { effects.Last(e => e.Type.IsAllLightsEffect()) };
 
         var usedKeyCodes = new HashSet<ushort>();
         var newEffects = new List<SpectrumKeyboardBacklightEffect>();
 
         foreach (var effect in effects.Reverse())
         {
-            var newKeyCodes = effect.Keys.KeyCodes.Except(usedKeyCodes).ToArray();
+            if (effect.Type.IsWholeKeyboardEffect() && usedKeyCodes.Intersect(effect.Keys).Any())
+                continue;
+
+            var newKeyCodes = effect.Keys.Except(usedKeyCodes).ToArray();
 
             foreach (var keyCode in newKeyCodes)
                 usedKeyCodes.Add(keyCode);
@@ -716,11 +719,12 @@ private static SpectrumKeyboardBacklightEffect[] Compress(SpectrumKeyboardBackli
                 effect.Direction,
                 effect.ClockwiseDirection,
                 effect.Colors,
-                SpectrumKeyboardBacklightKeys.SomeKeys(newKeyCodes));
+                newKeyCodes);
 
             newEffects.Add(newEffect);
         }
 
+        newEffects.Reverse();
         return newEffects.ToArray();
     }
 
@@ -777,11 +781,9 @@ private static SpectrumKeyboardBacklightEffect Convert(LENOVO_SPECTRUM_EFFECT ef
 
         var colors = effect.Colors.Select(c => new RGBColor(c.R, c.G, c.B)).ToArray();
 
-        SpectrumKeyboardBacklightKeys keys;
+        var keys = effect.KeyCodes;
         if (effect.KeyCodes.Length == 1 && effect.KeyCodes[0] == 0x65)
-            keys = SpectrumKeyboardBacklightKeys.AllKeys();
-        else
-            keys = SpectrumKeyboardBacklightKeys.SomeKeys(effect.KeyCodes);
+            keys = Array.Empty<ushort>();
 
         return new(effectType, speed, direction, clockwiseDirection, colors, keys);
     }
@@ -860,7 +862,7 @@ private static LENOVO_SPECTRUM_EFFECT Convert(int index, SpectrumKeyboardBacklig
 
         var header = new LENOVO_SPECTRUM_EFFECT_HEADER(effectType, speed, direction, clockwiseDirection, colorMode);
         var colors = effect.Colors.Select(c => new LENOVO_SPECTRUM_COLOR(c.R, c.G, c.B)).ToArray();
-        var keys = effect.Keys.All ? new ushort[] { 0x65 } : effect.Keys.KeyCodes;
+        var keys = effect.Type.IsAllLightsEffect() ? new ushort[] { 0x65 } : effect.Keys;
         var result = new LENOVO_SPECTRUM_EFFECT(header, index + 1, colors, keys);
         return result;
     }

LenovoLegionToolkit.Lib/Extensions/SpectrumKeyboardBacklightEffectTypeExtensions.cs

@@ -0,0 +1,20 @@
+namespace LenovoLegionToolkit.Lib.Extensions;
+
+public static class SpectrumKeyboardBacklightEffectTypeExtensions
+{
+
+    public static bool IsAllLightsEffect(this SpectrumKeyboardBacklightEffectType type) => type switch
+    {
+        SpectrumKeyboardBacklightEffectType.AudioBounce => true,
+        SpectrumKeyboardBacklightEffectType.AudioRipple => true,
+        SpectrumKeyboardBacklightEffectType.AuroraSync => true,
+        _ => false
+    };
+
+    public static bool IsWholeKeyboardEffect(this SpectrumKeyboardBacklightEffectType type) => type switch
+    {
+        SpectrumKeyboardBacklightEffectType.Type => true,
+        SpectrumKeyboardBacklightEffectType.Ripple => true,
+        _ => false
+    };
+}

LenovoLegionToolkit.Lib/Structs.cs

@@ -663,44 +663,31 @@ public int CompareTo(Resolution other)
 
 }
 
-public readonly struct SpectrumKeyboardBacklightKeys
-{
-    public bool All { get; }
-    public ushort[] KeyCodes { get; }
-
-    [JsonConstructor]
-    private SpectrumKeyboardBacklightKeys(bool all, ushort[] keyCodes)
-    {
-        All = all;
-        KeyCodes = keyCodes;
-    }
-
-    public static SpectrumKeyboardBacklightKeys AllKeys() => new(true, Array.Empty<ushort>());
-    public static SpectrumKeyboardBacklightKeys SomeKeys(ushort[] keyCodes) => new(false, keyCodes);
-}
-
 public readonly struct SpectrumKeyboardBacklightEffect
 {
     public SpectrumKeyboardBacklightEffectType Type { get; }
     public SpectrumKeyboardBacklightSpeed Speed { get; }
     public SpectrumKeyboardBacklightDirection Direction { get; }
     public SpectrumKeyboardBacklightClockwiseDirection ClockwiseDirection { get; }
     public RGBColor[] Colors { get; }
-    public SpectrumKeyboardBacklightKeys Keys { get; }
+    public ushort[] Keys { get; }
 
     public SpectrumKeyboardBacklightEffect(SpectrumKeyboardBacklightEffectType type,
         SpectrumKeyboardBacklightSpeed speed,
         SpectrumKeyboardBacklightDirection direction,
         SpectrumKeyboardBacklightClockwiseDirection clockwiseDirection,
         RGBColor[] colors,
-        SpectrumKeyboardBacklightKeys keys)
+        ushort[] keys)
     {
         Type = type;
         Speed = speed;
         Direction = direction;
         ClockwiseDirection = clockwiseDirection;
         Colors = colors;
         Keys = keys;
+
+        if (Type.IsAllLightsEffect())
+            Keys = Array.Empty<ushort>();
     }
 }
 

LenovoLegionToolkit.WPF/Controls/KeyboardBacklight/Spectrum/Device/SpectrumDeviceControl.cs

@@ -52,5 +52,13 @@ public void SetLayout(SpectrumLayout spectrumLayout, KeyboardLayout keyboardLayo
         GetButtons().Where(b => b.Visibility == Visibility.Visible);
 
     private IEnumerable<SpectrumZoneControl> GetButtons() =>
-        this.GetVisibleChildrenOfType<SpectrumZoneControl>().Where(b => b.KeyCode > 0);
+        this.GetVisibleChildrenOfType<SpectrumZoneControl>()
+            .Where(b => b.KeyCode > 0);
+
+    public IEnumerable<SpectrumZoneControl> GetVisibleKeyboardButtons() =>
+        GetKeyboardButtons().Where(b => b.Visibility == Visibility.Visible);
+
+    private IEnumerable<SpectrumZoneControl> GetKeyboardButtons() =>
+        this.GetVisibleChildrenOfType<SpectrumZoneControl>()
+            .Where(b => b.KeyCode is > 0 and < 0x100);
 }

LenovoLegionToolkit.WPF/Controls/KeyboardBacklight/Spectrum/SpectrumKeyboardBacklightControl.xaml.cs

@@ -247,7 +247,11 @@ private void AddEffectButton_Click(object sender, RoutedEventArgs e)
 
         var keyCodes = checkedButtons.Select(b => b.KeyCode).ToArray();
 
-        CreateEffect(keyCodes);
+        var allKeyboardKeyCodes = _device.GetVisibleKeyboardButtons()
+            .Select(b => b.KeyCode)
+            .ToArray();
+
+        CreateEffect(keyCodes, allKeyboardKeyCodes);
     }
 
     private async void ResetToDefaultButton_Click(object sender, RoutedEventArgs e) => await ResetToDefaultAsync();
@@ -292,9 +296,9 @@ protected override async Task OnRefreshAsync()
 
     protected override void OnFinishedLoading() { }
 
-    private void SelectButtons(SpectrumKeyboardBacklightKeys keys)
+    private void SelectButtons(SpectrumKeyboardBacklightEffect effect)
     {
-        if (keys.All)
+        if (effect.Type.IsAllLightsEffect())
         {
             SelectAllButtons();
             return;
@@ -304,7 +308,7 @@ private void SelectButtons(SpectrumKeyboardBacklightKeys keys)
 
         foreach (var button in _device.GetVisibleButtons())
         {
-            if (!keys.KeyCodes.Contains(button.KeyCode))
+            if (!effect.Keys.Contains(button.KeyCode))
                 continue;
 
             button.IsChecked = true;
@@ -455,17 +459,17 @@ private async Task ResetToDefaultAsync()
         await RefreshProfileDescriptionAsync();
     }
 
-    private void CreateEffect(ushort[] keyCodes)
+    private void CreateEffect(ushort[] keyCodes, ushort[] allKeyboardKeyCodes)
     {
-        var window = new SpectrumKeyboardBacklightEditEffectWindow(keyCodes) { Owner = Window.GetWindow(this) };
+        var window = new SpectrumKeyboardBacklightEditEffectWindow(keyCodes, allKeyboardKeyCodes) { Owner = Window.GetWindow(this) };
         window.Apply += async (_, e) => await AddEffect(e);
         window.ShowDialog();
     }
 
     private SpectrumKeyboardEffectControl CreateEffectControl(SpectrumKeyboardBacklightEffect effect)
     {
         var control = new SpectrumKeyboardEffectControl(effect);
-        control.Click += (_, _) => SelectButtons(effect.Keys);
+        control.Click += (_, _) => SelectButtons(effect);
         control.Edit += (_, _) => EditEffect(control);
         control.Delete += async (_, _) => await DeleteEffectAsync(control);
         return control;
@@ -475,11 +479,6 @@ private async Task AddEffect(SpectrumKeyboardBacklightEffect effect)
     {
         DeselectAllButtons();
 
-        if (effect.Keys.All)
-            DeleteAllEffects();
-        else if (_effects.Children.OfType<SpectrumKeyboardEffectControl>().Any(c => c.Effect.Keys.All))
-            DeleteAllEffects();
-
         var control = CreateEffectControl(effect);
         _effects.Children.Add(control);
 
@@ -488,8 +487,14 @@ private async Task AddEffect(SpectrumKeyboardBacklightEffect effect)
 
     private void EditEffect(SpectrumKeyboardEffectControl effectControl)
     {
-        var keyCodes = _device.GetVisibleButtons().Select(b => b.KeyCode).ToArray();
-        var window = new SpectrumKeyboardBacklightEditEffectWindow(effectControl.Effect, keyCodes) { Owner = Window.GetWindow(this) };
+        var keyCodes = _device.GetVisibleButtons()
+            .Select(b => b.KeyCode)
+            .ToArray();
+        var allKeyboardKeyCodes = _device.GetVisibleKeyboardButtons()
+            .Select(b => b.KeyCode)
+            .ToArray();
+
+        var window = new SpectrumKeyboardBacklightEditEffectWindow(effectControl.Effect, keyCodes, allKeyboardKeyCodes) { Owner = Window.GetWindow(this) };
         window.Apply += async (_, e) => await ReplaceEffectAsync(effectControl, e);
         window.ShowDialog();
     }
@@ -499,7 +504,7 @@ private async Task ReplaceEffectAsync(SpectrumKeyboardEffectControl effectContro
         DeselectAllButtons();
 
         var control = new SpectrumKeyboardEffectControl(effect);
-        control.Click += (_, _) => SelectButtons(effect.Keys);
+        control.Click += (_, _) => SelectButtons(effect);
         control.Edit += (_, _) => EditEffect(control);
         control.Delete += async (_, _) => await DeleteEffectAsync(control);
 

LenovoLegionToolkit.WPF/Controls/KeyboardBacklight/Spectrum/SpectrumKeyboardEffectControl.xaml.cs

@@ -23,10 +23,10 @@ public SpectrumKeyboardEffectControl(SpectrumKeyboardBacklightEffect effect)
         _cardHeaderControl.Title = effect.Type.GetDisplayName();
 
         var subtitle = string.Empty;
-        if (effect.Keys.All)
+        if (effect.Type.IsAllLightsEffect())
             subtitle += Resource.SpectrumKeyboardEffectControl_Description_AllZones;
         else
-            subtitle += string.Format(Resource.SpectrumKeyboardEffectControl_Description_Zones, effect.Keys.KeyCodes.Length);
+            subtitle += string.Format(Resource.SpectrumKeyboardEffectControl_Description_Zones, effect.Keys.Length);
         _cardHeaderControl.Subtitle = subtitle;
     }
 

LenovoLegionToolkit.WPF/Windows/KeyboardBacklight/Spectrum/SpectrumKeyboardBacklightEditEffectWindow.xaml.cs

@@ -13,12 +13,14 @@ namespace LenovoLegionToolkit.WPF.Windows.KeyboardBacklight.Spectrum;
 public partial class SpectrumKeyboardBacklightEditEffectWindow
 {
     private readonly ushort[] _keyCodes;
+    private readonly ushort[] _allKeyboardKeyCodes;
 
     public event EventHandler<SpectrumKeyboardBacklightEffect>? Apply;
 
-    public SpectrumKeyboardBacklightEditEffectWindow(ushort[] keyCodes)
+    public SpectrumKeyboardBacklightEditEffectWindow(ushort[] keyCodes, ushort[] allKeyboardKeyCodes)
     {
         _keyCodes = keyCodes;
+        _allKeyboardKeyCodes = allKeyboardKeyCodes;
 
         InitializeComponent();
 
@@ -28,9 +30,10 @@ public SpectrumKeyboardBacklightEditEffectWindow(ushort[] keyCodes)
         RefreshVisibility();
     }
 
-    public SpectrumKeyboardBacklightEditEffectWindow(SpectrumKeyboardBacklightEffect effect, ushort[] keyCodes)
+    public SpectrumKeyboardBacklightEditEffectWindow(SpectrumKeyboardBacklightEffect effect, ushort[] keyCodes, ushort[] allKeyboardKeyCodes)
     {
-        _keyCodes = effect.Keys.All ? keyCodes : effect.Keys.KeyCodes;
+        _keyCodes = effect.Type.IsAllLightsEffect() ? keyCodes : effect.Keys;
+        _allKeyboardKeyCodes = allKeyboardKeyCodes;
 
         InitializeComponent();
 
@@ -78,9 +81,12 @@ private void Apply_Click(object sender, RoutedEventArgs e)
         if (_multiColors.Visibility == Visibility.Visible)
             colors = _multiColorPicker.SelectedColors.Select(c => c.ToRGBColor()).ToArray();
 
-        var keys = IsWholeKeyboardEffect(effectType)
-            ? SpectrumKeyboardBacklightKeys.AllKeys()
-            : SpectrumKeyboardBacklightKeys.SomeKeys(_keyCodes);
+        var keys = _keyCodes;
+
+        if (effectType.IsAllLightsEffect())
+            keys = Array.Empty<ushort>();
+        if (effectType.IsWholeKeyboardEffect())
+            keys = _allKeyboardKeyCodes;
 
         var effect = new SpectrumKeyboardBacklightEffect(effectType,
             speed,
@@ -172,7 +178,7 @@ private void RefreshVisibility()
         if (!_effectTypeComboBox.TryGetSelectedItem(out SpectrumKeyboardBacklightEffectType effect))
             return;
 
-        _effectTypeCardHeader.Warning = IsWholeKeyboardEffect(effect)
+        _effectTypeCardHeader.Warning = effect.IsAllLightsEffect() || effect.IsWholeKeyboardEffect()
             ? Resource.SpectrumKeyboardBacklightEditEffectWindow_Effect_Warning
             : string.Empty;
 
@@ -221,13 +227,4 @@ private void RefreshVisibility()
             _ => Visibility.Collapsed
         };
     }
-
-    private static bool IsWholeKeyboardEffect(SpectrumKeyboardBacklightEffectType effectType) => effectType switch
-    {
-        SpectrumKeyboardBacklightEffectType.AudioBounce => true,
-        SpectrumKeyboardBacklightEffectType.AudioRipple => true,
-        SpectrumKeyboardBacklightEffectType.Ripple => true,
-        SpectrumKeyboardBacklightEffectType.AuroraSync => true,
-        _ => false
-    };
 }