Extend convenience initializer coverage for Packed*Array (#650)

* Implement convenience initializers for PackedVector2Array, PackedVector3Array, and PackedVector4Array. * Fix comment typos for PackedFloat32Array, PackedFloat64Array, PackedInt32Array, and PackedInt64Array. * Added unit tests for convenience initializers for PackedVector2Array, PackedVector3Array, and PackedVector4Array. * Implement convenience initializer and unit test for PackedColorArray.
migueldeicaza · Jan 24, 2025 · b9c098a · b9c098a
1 parent 21e3eb6
commit b9c098a
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 4 deletions.
diff --git a/Sources/SwiftGodot/Core/Packed.swift b/Sources/SwiftGodot/Core/Packed.swift
@@ -134,6 +134,21 @@ extension PackedColorArray {
     public func append(value: Color) {
         append(value)
     }
+
+    /// Initializes a PackedColorArray from an array of Color values.
+    public convenience init (_ data: [Color]) {
+        self.init ()
+        _ = resize(newSize: Int64(data.count))
+        if let ptr = gi.packed_color_array_operator_index(&content, 0) {
+            ptr.withMemoryRebound(to: Color.self, capacity: data.count) { typed in
+                var idx = 0
+                for value in data {
+                    typed [idx] = value
+                    idx += 1
+                }
+            }
+        }
+    }
 }
 
 extension PackedFloat32Array {
@@ -148,7 +163,7 @@ extension PackedFloat32Array {
         }
     }
 
-    /// Initializes a PackedByteArray from an array of Float values.
+    /// Initializes a PackedFloat32Array from an array of Float values.
     public convenience init (_ data: [Float]) {
         self.init ()
         _ = resize(newSize: Int64(data.count))
@@ -181,7 +196,7 @@ extension PackedFloat64Array {
         }
     }
 
-    /// Initializes a PackedByteArray from an array of Double values.
+    /// Initializes a PackedFloat64Array from an array of Double values.
     public convenience init (_ data: [Double]) {
         self.init ()
         _ = resize(newSize: Int64(data.count))
@@ -214,7 +229,7 @@ extension PackedInt32Array {
         }
     }
 
-    /// Initializes a PackedByteArray from an array of Int32 values values.
+    /// Initializes a PackedInt32Array from an array of Int32 values values.
     public convenience init (_ data: [Int32]) {
         self.init ()
         _ = resize(newSize: Int64(data.count))
@@ -247,7 +262,7 @@ extension PackedInt64Array {
         }
     }
 
-    /// Initializes a PackedByteArray from an array of Int32 values values.
+    /// Initializes a PackedInt64Array from an array of Int64 values values.
     public convenience init (_ data: [Int64]) {
         self.init ()
         _ = resize(newSize: Int64(data.count))
@@ -283,6 +298,21 @@ extension PackedVector2Array {
     public func append(value: Vector2) {
         append(value)
     }
+
+    /// Initializes a PackedVector2Array from an array of Vector2 values.
+    public convenience init (_ data: [Vector2]) {
+        self.init ()
+        _ = resize(newSize: Int64(data.count))
+        if let ptr = gi.packed_vector2_array_operator_index(&content, 0) {
+            ptr.withMemoryRebound(to: Vector2.self, capacity: data.count) { typed in
+                var idx = 0
+                for value in data {
+                    typed [idx] = value
+                    idx += 1
+                }
+            }
+        }
+    }
 }
 
 extension PackedVector3Array {
@@ -300,6 +330,21 @@ extension PackedVector3Array {
     public func append(value: Vector3) {
         append(value)
     }
+
+    /// Initializes a PackedVector3Array from an array of Vector3 values.
+    public convenience init (_ data: [Vector3]) {
+        self.init ()
+        _ = resize(newSize: Int64(data.count))
+        if let ptr = gi.packed_vector3_array_operator_index(&content, 0) {
+            ptr.withMemoryRebound(to: Vector3.self, capacity: data.count) { typed in
+                var idx = 0
+                for value in data {
+                    typed [idx] = value
+                    idx += 1
+                }
+            }
+        }
+    }
 }
 
 extension PackedVector4Array {
@@ -313,4 +358,19 @@ extension PackedVector4Array {
             set (index: Int64 (index), value: newValue)
         }
     }
+
+    /// Initializes a PackedVector4Array from an array of Vector4 values.
+    public convenience init (_ data: [Vector4]) {
+        self.init ()
+        _ = resize(newSize: Int64(data.count))
+        if let ptr = gi.packed_vector4_array_operator_index(&content, 0) {
+            ptr.withMemoryRebound(to: Vector4.self, capacity: data.count) { typed in
+                var idx = 0
+                for value in data {
+                    typed [idx] = value
+                    idx += 1
+                }
+            }
+        }
+    }
 }
diff --git a/Tests/SwiftGodotTests/BuiltIn/PackedArrayTests.swift b/Tests/SwiftGodotTests/BuiltIn/PackedArrayTests.swift
@@ -42,6 +42,45 @@ final class PackedArrayTests: GodotTestCase {
         for (idx, v) in doubles.enumerated() {
             XCTAssertEqual (v, e [idx])
         }
+
+        let vec2s: [Vector2] = [
+            Vector2(),
+            Vector2(x: 0.3, y: .pi),
+            Vector2(x: .greatestFiniteMagnitude, y: -.greatestFiniteMagnitude),
+            Vector2(x: Float32.infinity, y: -.infinity),
+        ]
+        let f = PackedVector2Array(vec2s)
+        for (idx, v) in vec2s.enumerated() {
+            XCTAssertEqual (v, f [idx])
+        }
+
+        let vec3s: [Vector3] = [
+            Vector3(),
+            Vector3(x: 0.3, y: .pi, z: 2.0 * .pi),
+            Vector3(x: .greatestFiniteMagnitude, y: -.greatestFiniteMagnitude, z: 0),
+            Vector3(x: Float32.infinity, y: -.infinity, z: 0),
+        ]
+        let g = PackedVector3Array(vec3s)
+        for (idx, v) in vec3s.enumerated() {
+            XCTAssertEqual (v, g [idx])
+        }
+
+        let vec4s: [Vector4] = [
+            Vector4(),
+            Vector4(x: 0.3, y: .pi, z: 2.0 * .pi, w: 1.0 / .pi),
+            Vector4(x: .greatestFiniteMagnitude, y: -.greatestFiniteMagnitude, z: 0, w: -0),
+            Vector4(x: Float32.infinity, y: -.infinity, z: 0, w: -0),
+        ]
+        let h = PackedVector4Array(vec4s)
+        for (idx, v) in vec4s.enumerated() {
+            XCTAssertEqual (v, h [idx])
+        }
+
+        let colors: [Color] = [ Color(), .red, .green, .blue, Color(r: 0.1, g: 0.2, b: 0.3, a: 0.4)]
+        let i = PackedColorArray(colors)
+        for (idx, v) in colors.enumerated() {
+            XCTAssertEqual (v, i [idx])
+        }
     }
 
     func testPackedByteArrayExtract () {