Merge branch 'development' into feature/avalonia

Code cleanup

src/Artemis.Core/Extensions/TypeExtensions.cs

@@ -50,7 +50,7 @@ namespace Artemis.Core
         /// <param name="type">The type to check</param>
         /// <param name="genericType">The generic type to match</param>
         /// <returns>True if the <paramref name="type" /> is generic and of generic type <paramref name="genericType" /></returns>
-        public static bool IsGenericType(this Type type, Type genericType)
+        public static bool IsGenericType(this Type? type, Type genericType)
         {
             if (type == null)
                 return false;
@@ -95,17 +95,7 @@ namespace Artemis.Core
         /// <returns><see langword="true" /> if the value is of a numeric type, otherwise <see langword="false" /></returns>
         public static bool IsNumber([NotNullWhenAttribute(true)] this object? value)
         {
-            return value is sbyte
-                   || value is byte
-                   || value is short
-                   || value is ushort
-                   || value is int
-                   || value is uint
-                   || value is long
-                   || value is ulong
-                   || value is float
-                   || value is double
-                   || value is decimal;
+            return value is sbyte or byte or short or ushort or int or uint or long or ulong or float or double or decimal;
         }
 
         // From https://stackoverflow.com/a/2224421/5015269 but inverted and renamed to match similar framework methods
@@ -199,10 +189,10 @@ namespace Artemis.Core
         /// <param name="genericType">The generic type it should be or implement</param>
         public static bool IsOfGenericType(this Type typeToCheck, Type genericType)
         {
-            return typeToCheck.IsOfGenericType(genericType, out Type _);
+            return typeToCheck.IsOfGenericType(genericType, out Type? _);
         }
 
-        private static bool IsOfGenericType(this Type typeToCheck, Type genericType, out Type concreteGenericType)
+        private static bool IsOfGenericType(this Type? typeToCheck, Type genericType, out Type? concreteGenericType)
         {
             while (true)
             {

src/Artemis.Core/Models/Profile/Colors/ColorGradient.cs

@@ -73,9 +73,8 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
         }
         else
         {
-            List<SKColor> colors = this.Select(c => c.Color).ToList();
             for (int i = 0; i <= timesToRepeat; i++)
-                result.AddRange(colors);
+                result.AddRange(this.Select(c => c.Color));
         }
 
         if (seamless && !IsSeamless())
@@ -87,9 +86,7 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
     /// <summary>
     ///     Gets all the positions in the color gradient
     /// </summary>
-    /// <param name="timesToRepeat">
-    ///     The amount of times to repeat the positions
-    /// </param>
+    /// <param name="timesToRepeat">The amount of times to repeat the positions</param>
     /// <param name="seamless">
     ///     A boolean indicating whether to make the gradient seamless by adding the first color behind the
     ///     last color
@@ -120,7 +117,7 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
             // Compress current points evenly
             float compression = 1f - 1f / result.Count;
             for (int index = 0; index < result.Count; index++)
-                result[index] = result[index] * compression;
+                result[index] *= compression;
             // Add one extra point at the end
             result.Add(1f);
         }
@@ -132,19 +129,30 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
     ///     Gets a color at any position between 0.0 and 1.0 using interpolation
     /// </summary>
     /// <param name="position">A position between 0.0 and 1.0</param>
-    public SKColor GetColor(float position)
+    /// <param name="timesToRepeat">The amount of times to repeat the positions</param>
+    /// <param name="seamless">
+    ///     A boolean indicating whether to make the gradient seamless by adding the first color behind the
+    ///     last color
+    /// </param>
+    public SKColor GetColor(float position, int timesToRepeat = 0, bool seamless = false)
     {
         if (!this.Any())
             return new SKColor(255, 255, 255);
 
-        ColorGradientStop[] stops = this.ToArray();
-        if (position <= 0) return stops[0].Color;
-        if (position >= 1) return stops[^1].Color;
-        ColorGradientStop left = stops[0];
-        ColorGradientStop? right = null;
-        foreach (ColorGradientStop stop in stops)
+        SKColor[] colors = GetColorsArray(timesToRepeat, seamless);
+        float[] stops = GetPositionsArray(timesToRepeat, seamless);
+
+        // If at or over the edges, return the corresponding edge
+        if (position <= 0) return colors[0];
+        if (position >= 1) return colors[^1];
+
+        // Walk through the stops until we find the one at or after the requested position, that becomes the right stop
+        // The left stop is the previous stop before the right one was found.
+        float left = stops[0];
+        float? right = null;
+        foreach (float stop in stops)
         {
-            if (stop.Position >= position)
+            if (stop >= position)
             {
                 right = stop;
                 break;
@@ -153,14 +161,22 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
             left = stop;
         }
 
-        if (right == null || left == right)
-            return left.Color;
+        // Get the left stop's color
+        SKColor leftColor = colors[Array.IndexOf(stops, left)];
 
-        position = (float) Math.Round((position - left.Position) / (right.Position - left.Position), 2);
-        byte a = (byte) ((right.Color.Alpha - left.Color.Alpha) * position + left.Color.Alpha);
-        byte r = (byte) ((right.Color.Red - left.Color.Red) * position + left.Color.Red);
-        byte g = (byte) ((right.Color.Green - left.Color.Green) * position + left.Color.Green);
-        byte b = (byte) ((right.Color.Blue - left.Color.Blue) * position + left.Color.Blue);
+        // If no right stop was found or the left and right stops are on the same spot, return the left stop's color
+        if (right == null || left == right)
+            return leftColor;
+
+        // Get the right stop's color
+        SKColor rightColor = colors[Array.IndexOf(stops, right)];
+
+        // Interpolate the position between the left and right color
+        position = MathF.Round((position - left) / (right.Value - left), 2);
+        byte a = (byte) ((rightColor.Alpha - leftColor.Alpha) * position + leftColor.Alpha);
+        byte r = (byte) ((rightColor.Red - leftColor.Red) * position + leftColor.Red);
+        byte g = (byte) ((rightColor.Green - leftColor.Green) * position + leftColor.Green);
+        byte b = (byte) ((rightColor.Blue - leftColor.Blue) * position + leftColor.Blue);
         return new SKColor(r, g, b, a);
     }
 
@@ -561,7 +577,8 @@ public class ColorGradient : IList<ColorGradientStop>, IList, INotifyCollectionC
         OnCollectionChanged(new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Remove, index));
     }
 
-    public bool IsFixedSize { get; }
+    /// <inheritdoc />
+    public bool IsFixedSize => false;
 
     /// <inheritdoc />
     public ColorGradientStop this[int index]

src/Artemis.Core/Models/Profile/Conditions/AlwaysOnCondition.cs

@@ -4,14 +4,26 @@ using Artemis.Storage.Entities.Profile.Conditions;
 
 namespace Artemis.Core
 {
+    /// <summary>
+    /// Represents a condition that is always true.
+    /// </summary>
     public class AlwaysOnCondition : ICondition
     {
+        /// <summary>
+        ///     Creates a new instance of the <see cref="AlwaysOnCondition" /> class.
+        /// </summary>
+        /// <param name="profileElement">The profile element this condition applies to.</param>
         public AlwaysOnCondition(RenderProfileElement profileElement)
         {
             ProfileElement = profileElement;
             Entity = new AlwaysOnConditionEntity();
         }
 
+        /// <summary>
+        ///     Creates a new instance of the <see cref="AlwaysOnCondition" /> class.
+        /// </summary>
+        /// <param name="alwaysOnConditionEntity">The entity used to store this condition.</param>
+        /// <param name="profileElement">The profile element this condition applies to.</param>
         public AlwaysOnCondition(AlwaysOnConditionEntity alwaysOnConditionEntity, RenderProfileElement profileElement)
         {
             ProfileElement = profileElement;

src/Artemis.Core/Models/Profile/Conditions/ICondition.cs

@@ -34,6 +34,9 @@ public interface ICondition : IDisposable, IStorageModel
     /// </summary>
     void UpdateTimeline(double deltaTime);
 
+    /// <summary>
+    /// Overrides the timeline to the provided <paramref name="position"/> as the display condition sees fit.
+    /// </summary>
     void OverrideTimeline(TimeSpan position);
 }
 

src/Artemis.Core/Models/Profile/Conditions/PlayOnceCondition.cs

@@ -4,14 +4,26 @@ using Artemis.Storage.Entities.Profile.Conditions;
 
 namespace Artemis.Core
 {
+    /// <summary>
+    /// Represents a condition that plays once when its script evaluates to <see langword="true"/>.
+    /// </summary>
     public class PlayOnceCondition : ICondition
     {
+        /// <summary>
+        ///     Creates a new instance of the <see cref="PlayOnceCondition" /> class.
+        /// </summary>
+        /// <param name="profileElement">The profile element this condition applies to.</param>
         public PlayOnceCondition(RenderProfileElement profileElement)
         {
             ProfileElement = profileElement;
             Entity = new PlayOnceConditionEntity();
         }
 
+        /// <summary>
+        ///     Creates a new instance of the <see cref="PlayOnceCondition" /> class.
+        /// </summary>
+        /// <param name="entity">The entity used to store this condition.</param>
+        /// <param name="profileElement">The profile element this condition applies to.</param>
         public PlayOnceCondition(PlayOnceConditionEntity entity, RenderProfileElement profileElement)
         {
             ProfileElement = profileElement;

src/Artemis.Core/Models/Profile/LayerPropertyGroup.cs

@@ -30,6 +30,7 @@ namespace Artemis.Core
         protected LayerPropertyGroup()
         {
             // These are set right after construction to keep the constructor (and inherited constructs) clean
+            ProfileElement = null!;
             GroupDescription = null!;
             Path = "";
 

src/Artemis.Core/Plugins/LayerEffects/Internal/BaseLayerEffect.cs

@@ -11,7 +11,6 @@ namespace Artemis.Core.LayerEffects
     {
         private ILayerEffectConfigurationDialog? _configurationDialog;
         private LayerEffectDescriptor _descriptor;
-        private bool _suspended;
         private bool _hasBeenRenamed;
         private string _name;
         private int _order;

src/Artemis.Core/Services/Interfaces/IGraphicsContextProvider.cs

@@ -3,8 +3,20 @@ using Artemis.Core.SkiaSharp;
 
 namespace Artemis.Core.Services;
 
+/// <summary>
+/// Represents a class that can provide one or more graphics <see cref="IManagedGraphicsContext"/> instances by name.
+/// </summary>
 public interface IGraphicsContextProvider
 {
+    /// <summary>
+    /// Gets a read only collection containing the names of all the graphics contexts supported by this provider.
+    /// </summary>
     IReadOnlyCollection<string> GraphicsContextNames { get; }
+
+    /// <summary>
+    /// Gets a managed graphics context by name.
+    /// </summary>
+    /// <param name="name">The name of the graphics context.</param>
+    /// <returns>If found, an instance of the managed graphics context with the given <paramref name="name"/>; otherwise <see langword="null"/>.</returns>
     IManagedGraphicsContext? GetGraphicsContext(string name);
 }

src/Artemis.Core/Services/ModuleService.cs

@@ -85,7 +85,7 @@ namespace Artemis.Core.Services
             }
         }
 
-        private void ActivationUpdateTimerOnElapsed(object sender, ElapsedEventArgs e)
+        private void ActivationUpdateTimerOnElapsed(object? sender, ElapsedEventArgs e)
         {
             UpdateModuleActivation();
         }

src/Artemis.Core/Services/Registration/Interfaces/ILayerBrushService.cs

@@ -24,10 +24,14 @@ namespace Artemis.Core.Services
         List<LayerBrushDescriptor> GetLayerBrushes();
 
         /// <summary>
-        /// Returns the descriptor of the default layer brush
+        ///     Returns the descriptor of the default layer brush
         /// </summary>
         LayerBrushDescriptor? GetDefaultLayerBrush();
 
+        /// <summary>
+        ///     Applies the configured default brush to the provided <paramref name="layer" />.
+        /// </summary>
+        /// <param name="layer">The layer to apply the default brush to.</param>
         void ApplyDefaultBrush(Layer layer);
     }
 }