Merge pull request #258 from smasherprog/spell-filters-v2

Spell Filtering Setting Rework

Author: Delfofthebla

EQTool/Models/EQToolSettings.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Runtime.CompilerServices;
 using System.Windows;
@@ -138,12 +139,18 @@ public WindowState SettingsWindowState
 
         public List<PlayerInfo> Players { get; set; } = new List<PlayerInfo>();
         public List<Trigger> Triggers { get; set; } = new List<Trigger>();
+        
         public SpellsFilterType _SpellsFilter = SpellsFilterType.ByClass;
         public SpellsFilterType SpellsFilter
         {
             get => _SpellsFilter;
             set
             {
+                if ((int) value == 3) // Legacy setting. Lazy Migration. We should avoid adding a new 3 in the future, but if we do, we can just delete this block.
+                {
+                    value = SpellsFilterType.CastByYou;
+                }
+                
                 if (value == _SpellsFilter)
                 {
                     return;
@@ -153,7 +160,22 @@ public SpellsFilterType SpellsFilter
                 OnPropertyChanged();
             }
         }
+        
+        private bool _SpellsFilterAlwaysShowCastOnYou = true;
+        public bool SpellsFilterAlwaysShowCastOnYou
+        {
+            get => _SpellsFilterAlwaysShowCastOnYou;
+            set
+            {
+                if (value == _SpellsFilterAlwaysShowCastOnYou)
+                {
+                    return;
+                }
 
+                _SpellsFilterAlwaysShowCastOnYou = value;
+                OnPropertyChanged();
+            }
+        }
         private SpellGroupingType _PlayerSpellGroupingType = SpellGroupingType.ByTarget;
         public SpellGroupingType PlayerSpellGroupingType
         {
@@ -210,7 +232,6 @@ public bool? RaidModeDetection
         }
         public bool LoginMiddleMand { get; set; }
         public bool IsClickThroughMode { get; set; }
-
         public event PropertyChangedEventHandler PropertyChanged;
 
         protected void OnPropertyChanged([CallerMemberName] string name = null)

EQTool/Models/SpellsFilterType.cs

@@ -6,13 +6,11 @@ namespace EQTool.Models
     [TypeConverter(typeof(EnumDescriptionTypeConverter))]
     public enum SpellsFilterType
     {
-        [Description("By Class")]
-        ByClass,
-        [Description("Cast On You")]
-        CastOnYou,
+        [Description("Allowed Classes")]
+        ByClass = 0,
         [Description("Cast By You")]
-        CastByYou,
-        [Description("Cast By or On You")]
-        CastByOrOnYou
+        CastByYou = 1,
+        [Description("Cast By Your Class")]
+        CastByYourClass = 4,
     }
 }

EQTool/Services/SpellGroupingEngine.cs

@@ -9,8 +9,6 @@ namespace EQTool.Services
 {
     public class SpellGroupingEngine
     {
-        private readonly object _lock = new object();
-        
         private readonly PlayerInfo activePlayer;
         private readonly EQToolSettings settings;
 

EQTool/UI/SettingsComponents/SettingsGeneral.xaml

@@ -366,6 +366,10 @@
                         </ComboBox>
                     </StackPanel>
                     <StackPanel Orientation="Horizontal">
+                        <TextBlock Text="Always show spells cast on you?"  VerticalAlignment="Center"  FontWeight="Bold"  MinWidth="100"/>
+                        <CheckBox IsChecked="{Binding SpellsFilterAlwaysShowCastOnYou}" Click="Savesettings" MinWidth="75" Margin="7,0,0,0"/>
+                    </StackPanel>
+                    <StackPanel Orientation="Horizontal" Margin="0,8,0,0">
                         <TextBlock Text="Spell Filters" VerticalAlignment="Center"  FontWeight="Bold" MinWidth="100"/>
                         <ComboBox SelectedItem="{Binding SpellsFilter}" ItemsSource="{Binding Source={markupExtensions:EnumBindingSource {x:Type models:SpellsFilterType}}}" MinWidth="100"></ComboBox>
                     </StackPanel>

EQTool/ViewModels/SettingsWindowViewModel.cs

@@ -283,6 +283,7 @@ public SpellGroupingType NpcSpellGroupingType
             }
         }
 
+        public bool ShowClassFilters => toolSettings.SpellsFilter == SpellsFilterType.ByClass;
         public SpellsFilterType SpellsFilter
         {
             get => toolSettings.SpellsFilter;
@@ -294,7 +295,15 @@ public SpellsFilterType SpellsFilter
             }
         }
 
-        public bool ShowClassFilters => toolSettings.SpellsFilter == SpellsFilterType.ByClass;
+        public bool SpellsFilterAlwaysShowCastOnYou
+        {
+            get => toolSettings.SpellsFilterAlwaysShowCastOnYou;
+            set
+            {
+                toolSettings.SpellsFilterAlwaysShowCastOnYou = value;
+                OnPropertyChanged();
+            }
+        }
 
         private PetViewModel _PetViewModel;
         public PetViewModel PetViewModel
@@ -305,7 +314,6 @@ public PetViewModel PetViewModel
                 _PetViewModel = value;
                 OnPropertyChanged();
             }
-
         }
 
         private ActivePlayer _ActivePlayer;

EQTool/ViewModels/SpellWindowViewModel.cs

@@ -440,12 +440,14 @@ private bool ShouldFilterSpell(SpellViewModel s, PlayerInfo player)
 
                 return true;
             }
+
+            if (settings.SpellsFilterAlwaysShowCastOnYou && s.CastOnYou())
+                return false;
 
             switch (settings.SpellsFilter)
             {
-                case SpellsFilterType.CastOnYou when !s.CastOnYou():
                 case SpellsFilterType.CastByYou when !s.CastByYou():
-                case SpellsFilterType.CastByOrOnYou when !(s.CastOnYou() || s.CastByYou()):
+                case SpellsFilterType.CastByYourClass when !s.CastByYourClass(player):
                     return true;
                 case SpellsFilterType.ByClass:
                     return !IsClassSpellAllowed(s.Classes, player.ShowSpellsForClasses);
@@ -789,7 +791,6 @@ public void UpdateAPITimers()
                                 else
                                 {
                                     match.TotalRemainingDuration = TimeSpan.FromHours(24).Subtract(TimeSpan.FromMinutes(30 - match.TotalRemainingDuration.Minutes));
-
                                 }
                             }
                         }
@@ -827,6 +828,7 @@ private void Base_PropertyChanged(object sender, PropertyChangedEventArgs e)
                 OnPropertyChanged(nameof(GenericButtonVisibility));
             }
             else if (e.PropertyName == nameof(settings.PlayerSpellGroupingType)
+            || e.PropertyName == nameof(settings.SpellsFilterAlwaysShowCastOnYou)
             || e.PropertyName == nameof(settings.NpcSpellGroupingType)
             || e.PropertyName == nameof(settings.SpellsFilter))
             {

EQtoolsTests/SpellMatchingTests.cs

@@ -92,7 +92,7 @@ public void TestRangerBindSight()
         public void TestBurnoutIII_ForPet()
         {
             var settings = container.Resolve<EQToolSettings>();
-            settings.SpellsFilter = SpellsFilterType.CastOnYou;
+            settings.SpellsFilterAlwaysShowCastOnYou = true;
             var pet = container.Resolve<PetViewModel>();
             pet.PetName = "Xibab";
             var spellname = "Burnout III";