Device dialog - Added input remapping for keyboards

Device dialog - Display layout author, if I missed anyone let me know!
2026-11-12 11:56:30 +00:00 · 2021-04-10 12:53:08 +02:00
1 parent 8066586328
commit c66c21152f
@@ -21,6 +21,9 @@
                    d:DesignHeight="800" d:DesignWidth="800"
                    d:DataContext="{d:DesignInstance device:DeviceDialogViewModel}"
                    Icon="/Resources/Images/Logo/logo-512.png">
+    <mde:MaterialWindow.Resources>
+        <shared:NullToVisibilityConverter x:Key="NullToVisibilityConverter"/>
+    </mde:MaterialWindow.Resources>
    <mde:MaterialWindow.InputBindings>
        <KeyBinding Command="{s:Action ClearSelection}" Key="Escape" />
    </mde:MaterialWindow.InputBindings>
@@ -111,6 +114,14 @@
                                             VerticalAlignment="Center"
                                             ShowColors="True"
                                             LedClicked="{s:Action OnLedClicked}"/>
+
+                    <TextBlock Style="{StaticResource MaterialDesignSubtitle1TextBlock}" 
+                               Visibility="{Binding Device.Layout.RgbLayout.Author, Converter={StaticResource NullToVisibilityConverter}}"
+                               VerticalAlignment="Bottom" 
+                               HorizontalAlignment="Left" 
+                               Margin="15">
+                        Device layout by <Run FontWeight="Bold" Text="{Binding Device.Layout.RgbLayout.Author}"/>
+                    </TextBlock>
                </Grid>

                <GridSplitter Grid.Column="1" Width="15" Margin="-15 0 0 0" Background="Transparent" HorizontalAlignment="Stretch" Panel.ZIndex="3" />
@@ -12,6 +12,7 @@ using Artemis.UI.Shared;
 using Artemis.UI.Shared.Services;
 using MaterialDesignThemes.Wpf;
 using Ookii.Dialogs.Wpf;
+using RGB.NET.Core;
 using RGB.NET.Layout;
 using SkiaSharp;
 using Stylet;
@@ -42,14 +43,16 @@ namespace Artemis.UI.Screens.Settings.Device

            Device = device;
            PanZoomViewModel = new PanZoomViewModel();
+            SelectedLeds = new BindableCollection<ArtemisLed>();

            Items.Add(factory.DevicePropertiesTabViewModel(device));
+            if (device.RgbDevice.DeviceInfo.DeviceType == RGBDeviceType.Keyboard)
+                Items.Add(factory.InputMappingsTabViewModel(device));
            Items.Add(factory.DeviceInfoTabViewModel(device));
            Items.Add(factory.DeviceLedsTabViewModel(device));
+
            ActiveItem = Items.First();
            DisplayName = $"{device.RgbDevice.DeviceInfo.Model} | Artemis";
-
-            SelectedLeds = new BindableCollection<ArtemisLed>();
        }

        public ArtemisDevice Device { get; }
@@ -0,0 +1,83 @@
+<UserControl
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+    xmlns:local="clr-namespace:Artemis.UI.Screens.Settings.Device.Tabs"
+    xmlns:materialDesign="http://materialdesigninxaml.net/winfx/xaml/themes"
+    xmlns:s="https://github.com/canton7/Stylet"
+    xmlns:Shared="clr-namespace:Artemis.UI.Shared;assembly=Artemis.UI.Shared" x:Class="Artemis.UI.Screens.Settings.Device.Tabs.InputMappingsTabView"
+    mc:Ignorable="d"
+    d:DesignHeight="450" d:DesignWidth="800"
+    d:DataContext="{d:DesignInstance {x:Type local:InputMappingsTabViewModel}}">
+    <UserControl.Resources>
+        <ResourceDictionary>
+            <Shared:NullToVisibilityConverter x:Key="NullToVisibilityConverter" />
+            <Style x:Key="CenteredTextColumn" TargetType="TextBlock">
+                <Setter Property="VerticalAlignment" Value="Center" />
+            </Style>
+        </ResourceDictionary>
+    </UserControl.Resources>
+    <Grid Margin="15">
+        <Grid.RowDefinitions>
+            <RowDefinition Height="Auto" />
+            <RowDefinition Height="Auto" />
+            <RowDefinition Height="*" />
+        </Grid.RowDefinitions>
+        <StackPanel Grid.Row="0">
+            <TextBlock Style="{StaticResource MaterialDesignHeadline6TextBlock}">
+                <Run Text="Introduction" />
+            </TextBlock>
+            <TextBlock Style="{StaticResource MaterialDesignTextBlock}" TextWrapping="Wrap">
+                In some cases you may want Artemis to map key presses to different LEDs.
+                This is useful when your logical layout swaps keys around (like Hungarian layouts where the Z and Y keys are swapped).<LineBreak /><LineBreak />
+                In this tab you can set up these custom input mappings, simply click on a LED and press a key, Artemis will from then on consider that LED pressed whenever you press the same key again.
+            </TextBlock>
+        </StackPanel>
+
+        <StackPanel Grid.Row="1" Margin="0 20" Visibility="{Binding SelectedLed, Converter={StaticResource NullToVisibilityConverter}, ConverterParameter=Inverted}">
+            <TextBlock Style="{StaticResource MaterialDesignHeadline6TextBlock}" TextAlignment="Center">Select a LED in the preview on the left side to get started...</TextBlock>
+        </StackPanel>
+
+        <StackPanel Grid.Row="1" Margin="0 20" Visibility="{Binding SelectedLed, Converter={StaticResource NullToVisibilityConverter}}">
+            <TextBlock Style="{StaticResource MaterialDesignHeadline6TextBlock}" TextAlignment="Center">
+                <Run Text="Current target LED: " /><Run Text="{Binding SelectedLed.RgbLed.Id, Mode=OneWay}" />
+            </TextBlock>
+            <TextBlock Style="{StaticResource MaterialDesignTextBlock}" TextAlignment="Center">
+                <Run Text="Press the key you want to remap" /><Run Text=" " /><Run FontWeight="Bold" Text="{Binding SelectedLed.RgbLed.Id, Mode=OneWay}" /><Run Text=" " /><Run Text="to..." />
+            </TextBlock>
+        </StackPanel>
+
+        <DataGrid Grid.Row="2"
+                  ItemsSource="{Binding InputMappings}"
+                  CanUserSortColumns="True"
+                  IsReadOnly="True"
+                  CanUserAddRows="False"
+                  AutoGenerateColumns="False"
+                  CanUserResizeRows="False"
+                  materialDesign:DataGridAssist.CellPadding="8"
+                  materialDesign:DataGridAssist.ColumnHeaderPadding="8"
+                  VirtualizingPanel.VirtualizationMode="Standard"
+                  Margin="10">
+            <DataGrid.Columns>
+                <materialDesign:DataGridTextColumn Binding="{Binding Item1.RgbLed.Id}" ElementStyle="{StaticResource CenteredTextColumn}" Header="Original LED ID" Width="*" />
+                <materialDesign:DataGridTextColumn Binding="{Binding Item2.RgbLed.Id}" ElementStyle="{StaticResource CenteredTextColumn}" Header="Remapped LED ID" Width="*" />
+
+                <DataGridTemplateColumn Width="45" IsReadOnly="True">
+                    <DataGridTemplateColumn.CellTemplate>
+                        <DataTemplate>
+                            <Button Command="{s:Action DeleteMapping}"
+                                    CommandParameter="{Binding}"
+                                    Style="{StaticResource MaterialDesignIconForegroundButton}"
+                                    ToolTip="Delete mapping"
+                                    Width="25"
+                                    Height="25">
+                                <materialDesign:PackIcon Kind="Delete" Width="18" Height="18" />
+                            </Button>
+                        </DataTemplate>
+                    </DataGridTemplateColumn.CellTemplate>
+                </DataGridTemplateColumn>
+            </DataGrid.Columns>
+        </DataGrid>
+    </Grid>
+</UserControl>
@@ -0,0 +1,103 @@
+using System;
+using System.Collections.Specialized;
+using System.Linq;
+using Artemis.Core;
+using Artemis.Core.Services;
+using Artemis.UI.Exceptions;
+using RGB.NET.Core;
+using Stylet;
+
+namespace Artemis.UI.Screens.Settings.Device.Tabs
+{
+    public class InputMappingsTabViewModel : Screen
+    {
+        private readonly IRgbService _rgbService;
+        private readonly IInputService _inputService;
+        private ArtemisLed _selectedLed;
+
+        public InputMappingsTabViewModel(ArtemisDevice device, IRgbService rgbService, IInputService inputService)
+        {
+            if (device.RgbDevice.DeviceInfo.DeviceType != RGBDeviceType.Keyboard)
+                throw new ArtemisUIException("The input mappings tab only supports keyboards");
+            _rgbService = rgbService;
+            _inputService = inputService;
+
+            Device = device;
+            DisplayName = "INPUT MAPPINGS";
+            InputMappings = new BindableCollection<Tuple<ArtemisLed, ArtemisLed>>();
+        }
+
+        public ArtemisDevice Device { get; }
+
+        public ArtemisLed SelectedLed
+        {
+            get => _selectedLed;
+            set => SetAndNotify(ref _selectedLed, value);
+        }
+
+        public BindableCollection<Tuple<ArtemisLed, ArtemisLed>> InputMappings { get; }
+
+        public void DeleteMapping(Tuple<ArtemisLed, ArtemisLed> inputMapping)
+        {
+            Device.InputMappings.Remove(inputMapping.Item1);
+            UpdateInputMappings();
+        }
+
+        private void InputServiceOnKeyboardKeyUp(object sender, ArtemisKeyboardKeyEventArgs e)
+        {
+            if (SelectedLed == null || e.Led == null)
+                return;
+
+            // Locate the original LED the same way the InputService did it, but supply false to Device.GetLed
+            bool foundLedId = InputKeyUtilities.KeyboardKeyLedIdMap.TryGetValue(e.Key, out LedId ledId);
+            if (!foundLedId)
+                return;
+            ArtemisLed artemisLed = Device.GetLed(ledId, false);
+            if (artemisLed == null)
+                return;
+
+            // Apply the new LED mapping
+            Device.InputMappings[SelectedLed] = artemisLed;
+            _rgbService.SaveDevice(Device);
+            ((DeviceDialogViewModel) Parent).SelectedLeds.Clear();
+
+            UpdateInputMappings();
+        }
+
+        private void UpdateInputMappings()
+        {
+            if (InputMappings.Any())
+                InputMappings.Clear();
+
+            InputMappings.AddRange(Device.InputMappings.Select(m => new Tuple<ArtemisLed, ArtemisLed>(m.Key, m.Value)));
+        }
+
+        private void SelectedLedsOnCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
+        {
+            SelectedLed = ((DeviceDialogViewModel) Parent).SelectedLeds.FirstOrDefault();
+        }
+
+        #region Overrides of Screen
+
+        /// <inheritdoc />
+        protected override void OnActivate()
+        {
+            UpdateInputMappings();
+            _inputService.KeyboardKeyUp += InputServiceOnKeyboardKeyUp;
+            ((DeviceDialogViewModel) Parent).SelectedLeds.CollectionChanged += SelectedLedsOnCollectionChanged;
+
+            base.OnActivate();
+        }
+
+        /// <inheritdoc />
+        protected override void OnDeactivate()
+        {
+            InputMappings.Clear();
+            _inputService.KeyboardKeyUp -= InputServiceOnKeyboardKeyUp;
+            ((DeviceDialogViewModel) Parent).SelectedLeds.CollectionChanged -= SelectedLedsOnCollectionChanged;
+            base.OnDeactivate();
+        }
+
+        #endregion
+    }
+}