Made Matrix 4x4 & 3x2 immutable

technologists-team · Oct 26, 2024 · 6b57032 · 6b57032
1 parent d4a143c
commit 6b57032
Show file tree

Hide file tree

Showing 18 changed files with 212 additions and 218 deletions.
diff --git a/Hypercube.Client/Graphics/Drawing/Batch.cs b/Hypercube.Client/Graphics/Drawing/Batch.cs
@@ -3,11 +3,11 @@
 
 namespace Hypercube.Client.Graphics.Drawing;
 
-public readonly struct Batch(int start, int size, int? textureHandle, PrimitiveType primitiveType, Matrix4X4 model)
+public readonly struct Batch(int start, int size, int? textureHandle, PrimitiveType primitiveType, Matrix4x4 model)
 {
     public readonly int Start = start;
     public readonly int Size = size;
     public readonly int? TextureHandle = textureHandle;
     public readonly PrimitiveType PrimitiveType = primitiveType;
-    public readonly Matrix4X4 Model = model;
+    public readonly Matrix4x4 Model = model;
 }
diff --git a/Hypercube.Client/Graphics/Realisation/OpenGL/Rendering/Renderer.Drawing.cs b/Hypercube.Client/Graphics/Realisation/OpenGL/Rendering/Renderer.Drawing.cs
@@ -11,15 +11,15 @@ public sealed partial class Renderer
 {
     public void DrawPoint(Vector2 vector, Color color)
     {
-        DrawPoint(vector, color, Matrix4X4.Identity);
+        DrawPoint(vector, color, Matrix4x4.Identity);
     }
 
     public void DrawPoint(Vector2 vector, Color color, Matrix3x3 model)
     {
-        DrawPoint(vector, color, Matrix4X4.CreateIdentity(model));
+        DrawPoint(vector, color, Matrix4x4.CreateIdentity(model));
     }
 
-    public void DrawPoint(Vector2 vector, Color color, Matrix4X4 model)
+    public void DrawPoint(Vector2 vector, Color color, Matrix4x4 model)
     {
         BreakCurrentBatch();
         EnsureBatch(PrimitiveType.Points, null, _primitiveShaderProgram.Handle);
@@ -28,78 +28,78 @@ public void DrawPoint(Vector2 vector, Color color, Matrix4X4 model)
 
     public void DrawLine(Vector2 pointA, Vector2 pointB, Color color)
     {
-        DrawLine(pointA, pointB, color, Matrix4X4.Identity);
+        DrawLine(pointA, pointB, color, Matrix4x4.Identity);
     }
 
     public void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix3x3 model)
     {
-        DrawLine(pointA, pointB, color, Matrix4X4.CreateIdentity(model));
+        DrawLine(pointA, pointB, color, Matrix4x4.CreateIdentity(model));
     }
 
-    public void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix4X4 model)
+    public void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix4x4 model)
     {
         DrawLine(new Box2(pointA, pointB), color, model);
     }
 
     public void DrawLine(Box2 box, Color color)
     {
-        DrawLine(box, color, Matrix4X4.Identity);
+        DrawLine(box, color, Matrix4x4.Identity);
     }
 
     public void DrawLine(Box2 box, Color color, Matrix3x3 model)
     {
-        DrawLine(box, color, Matrix4X4.CreateIdentity(model));
+        DrawLine(box, color, Matrix4x4.CreateIdentity(model));
     }
 
-    public void DrawLine(Box2 box, Color color, Matrix4X4 model)
+    public void DrawLine(Box2 box, Color color, Matrix4x4 model)
     {
         EnsureBatch(PrimitiveType.Lines, null, _primitiveShaderProgram.Handle);
         AddLineBatch((uint)_batchVertexIndex, model.Transform(box), color);
     }
 
     public void DrawCircle(Circle circle, Color color)
     {
-        DrawCircle(circle, color, Matrix4X4.Identity);
+        DrawCircle(circle, color, Matrix4x4.Identity);
     }
 
     public void DrawCircle(Circle circle, Color color, Matrix3x3 model)
     {
-        DrawCircle(circle, color, Matrix4X4.CreateIdentity(model));
+        DrawCircle(circle, color, Matrix4x4.CreateIdentity(model));
     }
 
-    public void DrawCircle(Circle circle, Color color, Matrix4X4 model)
+    public void DrawCircle(Circle circle, Color color, Matrix4x4 model)
     {
         EnsureBatch(PrimitiveType.Lines, null, _primitiveShaderProgram.Handle);
         AddCircleBatch(_batchVertexIndex, circle, color, 20);
     }
 
     public void DrawRectangle(Box2 box, Color color, bool outline = false)
     {
-        DrawRectangle(box, color, Matrix4X4.Identity, outline);
+        DrawRectangle(box, color, Matrix4x4.Identity, outline);
     }
 
     public void DrawRectangle(Box2 box, Color color, Matrix3x3 model, bool outline = false)
     {
-        DrawRectangle(box, color, Matrix4X4.CreateIdentity(model), outline);
+        DrawRectangle(box, color, Matrix4x4.CreateIdentity(model), outline);
     }
 
-    public void DrawRectangle(Box2 box, Color color, Matrix4X4 model, bool outline = false)
+    public void DrawRectangle(Box2 box, Color color, Matrix4x4 model, bool outline = false)
     {
         EnsureBatch(outline ? PrimitiveType.Lines : PrimitiveType.Triangles, null, _primitiveShaderProgram.Handle);
         AddQuadTriangleBatch((uint)_batchVertexIndex, model.Transform(box), Box2.UV, color);
     }
 
     public void DrawPolygon(Vector2[] vertices, Color color, bool outline = false)
     {
-        DrawPolygon(vertices, color, Matrix4X4.Identity, outline);
+        DrawPolygon(vertices, color, Matrix4x4.Identity, outline);
     }
 
     public void DrawPolygon(Vector2[] vertices, Color color, Matrix3x3 model, bool outline = false)
     {
-        DrawPolygon(vertices, color, Matrix4X4.CreateIdentity(model), outline);
+        DrawPolygon(vertices, color, Matrix4x4.CreateIdentity(model), outline);
     }
 
-    public void DrawPolygon(Vector2[] vertices, Color color, Matrix4X4 model, bool outline = false)
+    public void DrawPolygon(Vector2[] vertices, Color color, Matrix4x4 model, bool outline = false)
     {
         if (outline)
         {
@@ -120,7 +120,7 @@ public void DrawPolygon(Vector2[] vertices, Color color, Matrix4X4 model, bool o
         }
     }
 
-    private void DrawPolygonOutline(Vector2[] vertices, Color color, Matrix4X4 model)
+    private void DrawPolygonOutline(Vector2[] vertices, Color color, Matrix4x4 model)
     {
         EnsureBatch(PrimitiveType.Lines, null, _primitiveShaderProgram.Handle);
         var startIndex = (uint)_batchVertexIndex;
@@ -146,15 +146,15 @@ private void DrawPolygonOutline(Vector2[] vertices, Color color, Matrix4X4 model
 
     public void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color)
     {
-        DrawTexture(texture, quad, uv, color, Matrix4X4.Identity);
+        DrawTexture(texture, quad, uv, color, Matrix4x4.Identity);
     }
 
     public void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color, Matrix3x3 model)
     {
-        DrawTexture(texture, quad, uv, color, Matrix4X4.CreateIdentity(model));
+        DrawTexture(texture, quad, uv, color, Matrix4x4.CreateIdentity(model));
     }
 
-    public void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color, Matrix4X4 model)
+    public void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color, Matrix4x4 model)
     {
         EnsureBatch(PrimitiveType.Triangles, texture.Handle, _texturingShaderProgram.Handle);
         AddQuadTriangleBatch(_batchVertexIndex, model.Transform(quad), uv, color);

diff --git a/Hypercube.Client/Graphics/Realisation/OpenGL/Rendering/Renderer.Render.cs b/Hypercube.Client/Graphics/Realisation/OpenGL/Rendering/Renderer.Render.cs
@@ -211,7 +211,7 @@ private void GenerateBatch()
         var currentIndex = _batchIndexIndex;
 
         var batch = new Batch(data.StartIndex, currentIndex - data.StartIndex, data.TextureHandle, data.PrimitiveType,
-            Matrix4X4.Identity);
+            Matrix4x4.Identity);
 
         _batches.Add(batch);
     }

diff --git a/Hypercube.Client/Graphics/Rendering/IRenderer.cs b/Hypercube.Client/Graphics/Rendering/IRenderer.cs
@@ -27,22 +27,22 @@ public interface IRenderer
     // Drawing
     void DrawPoint(Vector2 vector, Color color);
     void DrawPoint(Vector2 vector, Color color, Matrix3x3 model);
-    void DrawPoint(Vector2 vector, Color color, Matrix4X4 model);
+    void DrawPoint(Vector2 vector, Color color, Matrix4x4 model);
     void DrawLine(Vector2 pointA, Vector2 pointB, Color color);
     void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix3x3 model);
-    void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix4X4 model);
+    void DrawLine(Vector2 pointA, Vector2 pointB, Color color, Matrix4x4 model);
     void DrawLine(Box2 box, Color color);
     void DrawLine(Box2 box, Color color, Matrix3x3 model);
-    void DrawLine(Box2 box, Color color, Matrix4X4 model);
+    void DrawLine(Box2 box, Color color, Matrix4x4 model);
     void DrawCircle(Circle circle, Color color);
     void DrawCircle(Circle circle, Color color, Matrix3x3 model);
-    void DrawCircle(Circle circle, Color color, Matrix4X4 model);
+    void DrawCircle(Circle circle, Color color, Matrix4x4 model);
     void DrawRectangle(Box2 box, Color color, bool outline = false);
     void DrawRectangle(Box2 box, Color color, Matrix3x3 model, bool outline = false);
-    void DrawRectangle(Box2 box, Color color, Matrix4X4 model, bool outline = false);
+    void DrawRectangle(Box2 box, Color color, Matrix4x4 model, bool outline = false);
     void DrawPolygon(Vector2[] vertices, Color color, bool outline = false);
     void DrawPolygon(Vector2[] vertices, Color color, Matrix3x3 model, bool outline = false);
-    void DrawPolygon(Vector2[] vertices, Color color, Matrix4X4 model, bool outline = false);
+    void DrawPolygon(Vector2[] vertices, Color color, Matrix4x4 model, bool outline = false);
     void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color);
-    void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color, Matrix4X4 model);
+    void DrawTexture(ITextureHandle texture, Box2 quad, Box2 uv, Color color, Matrix4x4 model);
 }
diff --git a/Hypercube.Client/Graphics/Viewports/Camera2D.cs b/Hypercube.Client/Graphics/Viewports/Camera2D.cs
@@ -8,8 +8,8 @@ namespace Hypercube.Client.Graphics.Viewports;
 
 public sealed class Camera2D : ICamera
 {
-    public Matrix4X4 Projection { get; private set; }
-    public Matrix4X4 View { get; private set; }
+    public Matrix4x4 Projection { get; private set; }
+    public Matrix4x4 View { get; private set; }
 
     public Vector3 Position => _transform.Position;
     public Vector3 Rotation => _transform.Rotation.ToEuler();
@@ -53,7 +53,7 @@ public void SetScale(Vector3 scale)
 
     private void UpdateProjection()
     {
-        Projection = Matrix4X4.CreateOrthographic(Size, _zNear, _zFar);
+        Projection = Matrix4x4.CreateOrthographic(Size, _zNear, _zFar);
         View = _transform.Matrix;
     }
 }
diff --git a/Hypercube.Client/Graphics/Viewports/CameraManager.cs b/Hypercube.Client/Graphics/Viewports/CameraManager.cs
@@ -12,8 +12,8 @@ public class CameraManager : ICameraManager
 
     public ICamera? MainCamera { get; private set; }
 
-    public Matrix4X4 Projection => MainCamera?.Projection ?? Matrix4X4.Identity;
-    public Matrix4X4 View => MainCamera?.View ?? Matrix4X4.Identity;
+    public Matrix4x4 Projection => MainCamera?.Projection ?? Matrix4x4.Identity;
+    public Matrix4x4 View => MainCamera?.View ?? Matrix4x4.Identity;
 
     public void UpdateInput(ICamera? camera, float delta)
     {

diff --git a/Hypercube.Client/Graphics/Viewports/ICamera.cs b/Hypercube.Client/Graphics/Viewports/ICamera.cs
@@ -5,8 +5,8 @@ namespace Hypercube.Client.Graphics.Viewports;
 
 public interface ICamera
 {
-    Matrix4X4 Projection { get; }
-    Matrix4X4 View { get; }
+    Matrix4x4 Projection { get; }
+    Matrix4x4 View { get; }
 
     Vector3 Position { get; }
     Vector3 Rotation { get; }

diff --git a/Hypercube.Client/Graphics/Viewports/ICameraManager.cs b/Hypercube.Client/Graphics/Viewports/ICameraManager.cs
@@ -7,8 +7,8 @@ public interface ICameraManager
 {
     ICamera? MainCamera { get; }
 
-    Matrix4X4 Projection { get; }
-    Matrix4X4 View { get; }
+    Matrix4x4 Projection { get; }
+    Matrix4x4 View { get; }
 
 
     void SetMainCamera(ICamera camera);

diff --git a/Hypercube.Graphics/Shaders/IShaderProgram.cs b/Hypercube.Graphics/Shaders/IShaderProgram.cs
@@ -31,7 +31,7 @@ public interface IShaderProgram : IDisposable
     void SetUniform(string name, Vector3 value);
 
     void SetUniform(string name, Matrix3x3 value, bool transpose = false);
-    void SetUniform(string name, Matrix4X4 value, bool transpose = false);
+    void SetUniform(string name, Matrix4x4 value, bool transpose = false);
 
     void Label(string name);
 }
diff --git a/Hypercube.ImGui/Implementations/OpenGLImGuiController.Render.cs b/Hypercube.ImGui/Implementations/OpenGLImGuiController.Render.cs
@@ -66,7 +66,7 @@ private void Render(ImDrawDataPtr data)
             CheckErrors("Setup data");
         }
 
-        var project = Matrix4X4.CreateOrthographicOffCenter(0f, _io.DisplaySize.X, _io.DisplaySize.Y, 0f, -1f, 1f);
+        var project = Matrix4x4.CreateOrthographicOffCenter(0f, _io.DisplaySize.X, _io.DisplaySize.Y, 0f, -1f, 1f);
 
         _shader.Use();
         _shader.SetUniform("projection", project);

diff --git a/Hypercube.Mathematics/Matrices/Matrix3x2.cs b/Hypercube.Mathematics/Matrices/Matrix3x2.cs
@@ -13,9 +13,9 @@ public partial struct Matrix3x2
     public static Matrix3x2 One => new(Vector2.One);
     public static Matrix3x2 Identity => new(Vector2.UnitX, Vector2.UnitY, Vector2.Zero);
 
-    public Vector2 Row0;
-    public Vector2 Row1;
-    public Vector2 Row2;
+    public readonly Vector2 Row0;
+    public readonly Vector2 Row1;
+    public readonly Vector2 Row2;
 
     public Vector3 Column0 => new(M00, M10, M20);
     public Vector3 Column1 => new(M01, M11, M21);
@@ -27,8 +27,6 @@ public float M00
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row0.X;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row0 = Row0.WithX(value);
     }
 
     /// <summary>
@@ -38,20 +36,15 @@ public float M01
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row0.Y;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row0 = Row0.WithY(value);
     }
 
-
     /// <summary>
     /// Matrix x: 0, y: 1 element.
     /// </summary>
     public float M10
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row1.X;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row1 = Row1.WithX(value);
     }
 
     /// <summary>
@@ -61,8 +54,6 @@ public float M11
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row1.Y;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row1 = Row1.WithY(value);
     }
 
     /// <summary>
@@ -72,8 +63,6 @@ public float M20
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row2.X;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row2 = Row2.WithX(value);
     }
 
     /// <summary>
@@ -83,8 +72,6 @@ public float M21
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get => Row2.Y;
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        set => Row2 = Row2.WithY(value);
     }
 
     public Matrix3x2(float m00, float m01, float m10, float m11, float m20, float m21)
@@ -135,7 +122,6 @@ public static Matrix3x2 CreateRotation(double angle)
     {
         var cos = (float)Math.Cos(angle);
         var sin = (float)Math.Sin(angle);
-
         return new Matrix3x2(cos, sin, -sin, cos, 0, 0);
     }
 

diff --git a/...atics/Matrices/Matrix4X4.Compatibility.cs → ...atics/Matrices/Matrix4x4.Compatibility.cs b/...atics/Matrices/Matrix4X4.Compatibility.cs → ...atics/Matrices/Matrix4x4.Compatibility.cs
@@ -1,15 +1,17 @@
-using System.Runtime.CompilerServices;
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
 
 namespace Hypercube.Mathematics.Matrices;
 
-public partial struct Matrix4X4
+[SuppressMessage("ReSharper", "InconsistentNaming")]
+public partial struct Matrix4x4
 {
     /*
      * System.Numerics Compatibility
      */
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public static implicit operator System.Numerics.Matrix4x4(Matrix4X4 matrix4X4)
+    public static implicit operator System.Numerics.Matrix4x4(Matrix4x4 matrix4X4)
     {
         return new System.Numerics.Matrix4x4(
             matrix4X4.M00, matrix4X4.M01, matrix4X4.M02, matrix4X4.M03,
@@ -19,9 +21,9 @@ public static implicit operator System.Numerics.Matrix4x4(Matrix4X4 matrix4X4)
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public static implicit operator Matrix4X4(System.Numerics.Matrix4x4 matrix4X4)
+    public static implicit operator Matrix4x4(System.Numerics.Matrix4x4 matrix4X4)
     {
-        return new Matrix4X4(
+        return new Matrix4x4(
             matrix4X4.M11, matrix4X4.M12, matrix4X4.M13, matrix4X4.M14,
             matrix4X4.M21, matrix4X4.M22, matrix4X4.M23, matrix4X4.M24,
             matrix4X4.M31, matrix4X4.M32, matrix4X4.M33, matrix4X4.M34,