Add uniform random scale to ParticleVector2Parameter (#1130)

* Add uniform random scale to ParticleVector2Parameter

* Bump version to 5.5.0

Author: AristurtleDev

Directory.Build.props

@@ -8,7 +8,7 @@
 
     <!-- Version Configuration -->
     <PropertyGroup>
-        <Version>5.4.1</Version>
+        <Version>5.5.0</Version>
         <MonoGameVersion>3.8.4.1</MonoGameVersion>
         <KNIVersion>4.0.9001</KNIVersion>
     </PropertyGroup>

source/MonoGame.Extended/Particles/Data/ParticleVector2Parameter.cs

@@ -37,13 +37,25 @@ public struct ParticleVector2Parameter : IEquatable<ParticleVector2Parameter>
     /// </summary>
     public Vector2 RandomMax;
 
+    /// <summary>
+    /// When <see langword="true"/> and <see cref="Kind"/> is <see cref="ParticleValueKind.Random"/>, a single random
+    /// value is sampled and applied to both X and Y, preserving the aspect ratio of each particle.
+    /// </summary>
+    /// <remarks>
+    /// The X components of <see cref="RandomMin"/> and <see cref="RandomMax"/> define the uniform range.
+    /// When <see langword="false"/>, X and Y are sampled independently.
+    /// </remarks>
+    public bool Uniform;
+
     /// <summary>
     /// Gets the current value of this parameter based on its <see cref="Kind"/>
     /// </summary>
     /// <remarks>
     /// If <see cref="Kind"/> is <see cref="ParticleValueKind.Constant"/>, returns <see cref="Constant"/>.
-    /// If <see cref="Kind"/> is <see cref="ParticleValueKind.Random"/>, returns a random value between
-    /// <see cref="RandomMin"/> and <see cref="RandomMax"/>.
+    /// If <see cref="Kind"/> is <see cref="ParticleValueKind.Random"/> and <see cref="Uniform"/> is
+    /// <see langword="false"/>, returns a random value with X and Y sampled independently from their respective ranges.
+    /// If <see cref="Kind"/> is <see cref="ParticleValueKind.Random"/> and <see cref="Uniform"/> is
+    /// <see langword="true"/>, returns a random value with a single sample applied to both X and Y using the X range.
     /// </remarks>
     public Vector2 Value
     {
@@ -55,6 +67,12 @@ public Vector2 Value
                 return Constant;
             }
 
+            if (Uniform)
+            {
+                float s = FastRandom.Shared.NextSingle(RandomMin.X, RandomMax.X);
+                return new Vector2(s, s);
+            }
+
             Vector2 v;
             v.X = FastRandom.Shared.NextSingle(RandomMin.X, RandomMax.X);
             v.Y = FastRandom.Shared.NextSingle(RandomMin.Y, RandomMax.Y);

source/MonoGame.Extended/Particles/ParticleEffectReader.cs

@@ -363,7 +363,8 @@ private ParticleVector2Parameter ReadParticleVector2Parameter(XmlReader reader)
         {
             Vector2 min = reader.GetAttributeVector2(nameof(ParticleVector2Parameter.RandomMin));
             Vector2 max = reader.GetAttributeVector2(nameof(ParticleVector2Parameter.RandomMax));
-            return new ParticleVector2Parameter(min, max);
+            bool uniform = reader.GetAttributeBool(nameof(ParticleVector2Parameter.Uniform), false);
+            return new ParticleVector2Parameter(min, max) { Uniform = uniform };
         }
 
         return new ParticleVector2Parameter(Vector2.Zero);

source/MonoGame.Extended/Particles/ParticleEffectSerializer.cs

@@ -302,7 +302,8 @@ private static ParticleVector2Parameter ReadParticleVector2Parameter(XmlReader r
         {
             Vector2 min = reader.GetAttributeVector2(nameof(ParticleVector2Parameter.RandomMin), default);
             Vector2 max = reader.GetAttributeVector2(nameof(ParticleVector2Parameter.RandomMax), default);
-            return new ParticleVector2Parameter(min, max);
+            bool uniform = reader.GetAttributeBool(nameof(ParticleVector2Parameter.Uniform), false);
+            return new ParticleVector2Parameter(min, max) { Uniform = uniform };
         }
 
         return new ParticleVector2Parameter(Vector2.Zero);
@@ -847,6 +848,11 @@ private static void WriteParticleVector2Parameter(XmlWriter writer, string name,
         {
             writer.WriteAttributeVector2(nameof(ParticleVector2Parameter.RandomMin), parameter.RandomMin);
             writer.WriteAttributeVector2(nameof(ParticleVector2Parameter.RandomMax), parameter.RandomMax);
+
+            if (parameter.Uniform)
+            {
+                writer.WriteAttributeString(nameof(ParticleVector2Parameter.Uniform), "true");
+            }
         }
 
         writer.WriteEndElement();

source/MonoGame.Extended/Particles/ParticleEffectWriter.cs

@@ -206,6 +206,11 @@ private void WriteParticleVector2Parameter(string name, ParticleVector2Parameter
         {
             _writer.WriteAttributeVector2(nameof(ParticleVector2Parameter.RandomMin), parameter.RandomMin);
             _writer.WriteAttributeVector2(nameof(ParticleVector2Parameter.RandomMax), parameter.RandomMax);
+
+            if (parameter.Uniform)
+            {
+                _writer.WriteAttributeString(nameof(ParticleVector2Parameter.Uniform), "true");
+            }
         }
 
         _writer.WriteEndElement();