Update libGDX to 1.13.5. #499 #500

Update LibGDX to 1.13.5, add TextMapObject to shape extension and add new forEachCell extension (#500)

* update LibGDX from 1.13.1 to 1.13.5

* add TextMapObject to shape extension

* add forEachCell TiledMapTileLayer extension

* fix Box2D tests for LibGDX 1.13.5

* inc fault tolerance

* update snapshot version and changelog

Author: Quillraven

CHANGELOG.md

@@ -1,6 +1,9 @@
 _See also: [the official libGDX changelog](https://github.com/libgdx/libgdx/blob/master/CHANGES)._
 
-#### 1.13.1-SNAPSHOT
+#### 1.13.5-SNAPSHOT
+- **[UPDATE]** Updated to libGDX 1.13.5.
+- **[UPDATE]** Updated `shape` extension function for tiled to support the new `TextMapObject`.
+- **[FEATURE]** Add a new `forEachCell` extension function for `TiledMapTileLayer` objects.
 
 #### 1.13.1-rc1
 

README.md

@@ -305,7 +305,7 @@ repositories {
 
 ext {
   // Update this version to match the latest libGDX release:
-  ktxVersion = '1.13.1-SNAPSHOT'
+  ktxVersion = '1.13.5-SNAPSHOT'
 }
 ```
 
@@ -320,7 +320,7 @@ repositories {
 }
 
 // Update this version to match the latest libGDX release:
-val ktxVersion = "1.13.1-SNAPSHOT"
+val ktxVersion = "1.13.5-SNAPSHOT"
 ```
 
 </details>

app/src/test/kotlin/ktx/app/ProfilingTest.kt

@@ -28,7 +28,7 @@ class ProfilingTest {
     assertEquals(10, performanceCounter.time.mean.windowSize)
     assertEquals(10, performanceCounter.time.count)
     assertEquals(10, repeats)
-    assertEquals(0.01f, performanceCounter.time.mean.mean, 0.002f)
+    assertEquals(0.01f, performanceCounter.time.mean.mean, 0.01f)
   }
 
   @Test
@@ -44,7 +44,7 @@ class ProfilingTest {
     assertEquals("Thread.sleep", performanceCounter.name)
     assertEquals(10, performanceCounter.time.count)
     assertEquals(10, repeats)
-    assertEquals(0.01f, performanceCounter.time.mean.mean, 0.002f)
+    assertEquals(0.01f, performanceCounter.time.mean.mean, 0.01f)
   }
 
   @After

box2d/build.gradle.kts

@@ -1,6 +1,7 @@
-import ktx.*
+import ktx.gdxVersion
 
 dependencies {
   api("com.badlogicgames.gdx:gdx-box2d:$gdxVersion")
   testImplementation("com.badlogicgames.gdx:gdx-box2d-platform:$gdxVersion:natives-desktop")
+  testImplementation("com.badlogicgames.gdx:gdx-platform:$gdxVersion:natives-desktop")
 }

box2d/src/test/kotlin/ktx/box2d/Box2DTest.kt

@@ -5,6 +5,7 @@ import com.badlogic.gdx.physics.box2d.Box2D
 import com.badlogic.gdx.physics.box2d.ChainShape
 import com.badlogic.gdx.physics.box2d.EdgeShape
 import com.badlogic.gdx.physics.box2d.PolygonShape
+import com.badlogic.gdx.utils.GdxNativesLoader
 import org.junit.Assert.assertEquals
 import org.junit.BeforeClass
 
@@ -67,6 +68,7 @@ abstract class Box2DTest {
     @JvmStatic
     @BeforeClass
     fun `initiate Box2D`() {
+      GdxNativesLoader.load()
       Box2D.init()
     }
   }

buildSrc/src/main/kotlin/ktx/Versions.kt

@@ -1,6 +1,6 @@
 package ktx
 
-const val gdxVersion = "1.13.1"
+const val gdxVersion = "1.13.5"
 const val kotlinCoroutinesVersion = "1.10.1"
 
 const val artemisOdbVersion = "2.3.0"

tiled/README.md

@@ -81,7 +81,8 @@ a certain function on them.
 
 ### `MapLayers` and `MapObjects`
 
-`isEmpty` and `isNotEmpty` extension method to check if the specific collection is empty or not.
+- `isEmpty` and `isNotEmpty` extension method to check if the specific collection is empty or not.
+- `forEachCell` extension method iterates through all cells in a `TiledMapTileLayer`, executing the given action for each cell along with its coordinates. Non-null cells only are processed during iteration.
 
 ### `BatchTiledMapRenderer`
 
@@ -244,6 +245,22 @@ map.forEachLayer<MapLayer> { layer ->
 }
 ```
 
+Iterating over all non-null cells of a `TiledMapTileLayer`:
+
+```kotlin
+import com.badlogic.gdx.maps.tiled.TiledMap
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer.Cell
+import ktx.tiled.*
+
+val map: TiledMap = getTiledMap()
+map.forEachLayer<TiledMapTileLayer> { layer ->
+    layer.forEachCell { cell, cellX, cellY ->
+        println("Processing cell $cell. Coordinates($cellX/$cellY)")
+    }
+}
+```
+
 Checking if `MapLayers` and `MapObjects` collections are empty:
 
 ```kotlin

tiled/src/main/kotlin/ktx/tiled/mapLayers.kt

@@ -3,6 +3,8 @@ package ktx.tiled
 import com.badlogic.gdx.maps.MapLayer
 import com.badlogic.gdx.maps.MapLayers
 import com.badlogic.gdx.maps.MapProperties
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer.Cell
 
 /**
  * Extension method to directly access the [MapProperties] of a [MapLayer]. If the property
@@ -53,3 +55,15 @@ fun MapLayers.isEmpty() = this.count <= 0
  * Returns **true** if and only if the [MapLayers] collection is not empty.
  */
 fun MapLayers.isNotEmpty() = this.count > 0
+
+/**
+ * Iterates through all cells in the [TiledMapTileLayer], executing the given [action] for each cell.
+ * The action receives the cell and its coordinates within the layer.
+ */
+fun TiledMapTileLayer.forEachCell(action: (cell: Cell, cellX: Int, cellY: Int) -> (Unit)) {
+  for (y in 0 until this.height) {
+    for (x in 0 until this.width) {
+      this.getCell(x, y)?.let { action(it, x, y) }
+    }
+  }
+}

tiled/src/main/kotlin/ktx/tiled/mapObjects.kt

@@ -8,6 +8,7 @@ import com.badlogic.gdx.maps.objects.EllipseMapObject
 import com.badlogic.gdx.maps.objects.PolygonMapObject
 import com.badlogic.gdx.maps.objects.PolylineMapObject
 import com.badlogic.gdx.maps.objects.RectangleMapObject
+import com.badlogic.gdx.maps.objects.TextMapObject
 import com.badlogic.gdx.maps.objects.TextureMapObject
 import com.badlogic.gdx.math.Circle
 import com.badlogic.gdx.math.Ellipse
@@ -105,7 +106,7 @@ val MapObject.type: String?
 
 /**
  * Extension method to retrieve the [Shape2D] instance of a [MapObject].
- * Depending on the type of the object a different shape will be returned:
+ * Depending on the type of the object, a different shape will be returned:
  *
  * - [CircleMapObject] -> [Circle]
  * - [EllipseMapObject] -> [Ellipse]
@@ -124,6 +125,7 @@ val MapObject.shape: Shape2D
       is PolylineMapObject -> polyline
       is PolygonMapObject -> polygon
       is RectangleMapObject -> rectangle
+      is TextMapObject -> rectangle
       else -> throw MissingShapeException("MapObject of type ${this::class.java} does not have a shape.")
     }
 

tiled/src/test/kotlin/ktx/tiled/MapLayerTest.kt

@@ -2,6 +2,8 @@ package ktx.tiled
 
 import com.badlogic.gdx.maps.MapLayer
 import com.badlogic.gdx.maps.MapLayers
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer
+import com.badlogic.gdx.maps.tiled.TiledMapTileLayer.Cell
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertNull
@@ -85,4 +87,24 @@ class MapLayerTest {
 
     assertFalse(actual.isNotEmpty())
   }
+
+  @Test
+  fun `should iterate over each cell in the TiledMapTileLayer`() {
+    val layer = TiledMapTileLayer(2, 2, 32, 32).apply {
+      setCell(0, 0, Cell())
+      setCell(1, 0, null) // this cell is skipped during iteration
+      setCell(0, 1, Cell())
+      setCell(1, 1, Cell())
+    }
+
+    val collectedCells = mutableListOf<Triple<Int, Int, Cell>>()
+    layer.forEachCell { cell, cellX, cellY ->
+      collectedCells.add(Triple(cellX, cellY, cell))
+    }
+
+    assertEquals(3, collectedCells.size)
+    assertEquals(Triple(0, 0, layer.getCell(0, 0)), collectedCells[0])
+    assertEquals(Triple(0, 1, layer.getCell(0, 1)), collectedCells[1])
+    assertEquals(Triple(1, 1, layer.getCell(1, 1)), collectedCells[2])
+  }
 }