feat: basic hex support for Tiled .tmx, closes #702

AlmasB · AlmasB · commit 5de072796fb9 · 2023-04-03T23:42:35.000+01:00
diff --git a/fxgl-entity/src/main/kotlin/com/almasb/fxgl/entity/level/tiled/TilesetLoader.kt b/fxgl-entity/src/main/kotlin/com/almasb/fxgl/entity/level/tiled/TilesetLoader.kt
@@ -179,15 +179,14 @@ class TilesetLoader(private val map: TiledMap, private val mapURL: URL) {
         return ImageView(buffer)
     }
 
-    // NOT FULLY IMPLEMENTED, see https://github.com/AlmasB/FXGL/issues/702
     fun loadViewHex(layerName: String): Node {
         log.debug("Loading view for layer $layerName")
 
         val layer = map.getLayerByName(layerName)
 
         val bufferBottom = WritableImage(
-                layer.width * map.tilewidth + 100,
-                layer.height * map.tileheight + 100
+                layer.width * map.tilewidth + map.tilewidth,
+                layer.height * map.tileheight + map.tileheight
         )
 
         log.debug("Created buffer with size ${bufferBottom.width}x${bufferBottom.height}")
@@ -214,6 +213,7 @@ class TilesetLoader(private val map: TiledMap, private val mapURL: URL) {
             val y = i / layer.width
 
             val isColumnEven = x % 2 == 0
+            val isRowEven = y % 2 == 0
 
             val w = tileset.tilewidth
             val h = tileset.tileheight
@@ -243,20 +243,31 @@ class TilesetLoader(private val map: TiledMap, private val mapURL: URL) {
                 srcy = 0
             }
 
-            log.debug("Writing to buffer: dst=${x * map.tilewidth},${y * map.tileheight}, w=$w,h=$h, src=$srcx,$srcy")
+            // map.tilew/h * 0.25 based on https://www.redblobgames.com/grids/hexagons/
+            var offsetX: Int = if (map.staggeraxis == "x" && x > 0) (map.tilewidth  * 0.25).toInt() * -x else 0
+            var offsetY: Int = if (map.staggeraxis == "y" && y > 0) (map.tileheight * 0.25).toInt() * -y else 0
 
-            val offsetX = -(map.hexsidelength + 6) * x
-
-            val offsetY = if (map.staggerindex == "even" && isColumnEven
-                    || map.staggerindex == "odd" && !isColumnEven)
-                map.tileheight / 2
-            else
-                0
-
-//            buffer.pixelWriter.setPixels(x * map.tilewidth + offsetX, y * map.tileheight + offsetY,
-//                    w, h, sourceImage.pixelReader,
-//                    srcx,
-//                    srcy)
+            if (map.staggeraxis == "y") {
+                if (map.staggerindex == "odd") {
+                    if (!isRowEven) {
+                        offsetX = map.tilewidth / 2
+                    }
+                } else {
+                    if (isRowEven) {
+                        offsetX = map.tilewidth / 2
+                    }
+                }
+            } else {
+                if (map.staggerindex == "odd") {
+                    if (!isColumnEven) {
+                        offsetY += map.tileheight / 2
+                    }
+                } else {
+                    if (isColumnEven) {
+                        offsetY += map.tileheight / 2
+                    }
+                }
+            }
 
             if (y > oldY) {
                 delayedDrawings.forEach { it.run() }
@@ -265,9 +276,7 @@ class TilesetLoader(private val map: TiledMap, private val mapURL: URL) {
                 oldY = y
             }
 
-            if (map.staggerindex == "odd" && isColumnEven
-                    || map.staggerindex == "even" && !isColumnEven) {
-
+            val drawToBuffer = Runnable {
                 for (dy in 0 until h) {
                     for (dx in 0 until w) {
                         val c = sourceImage.pixelReader.getColor(srcx + dx, srcy + dy)
@@ -281,27 +290,22 @@ class TilesetLoader(private val map: TiledMap, private val mapURL: URL) {
                         }
                     }
                 }
+            }
+
+            if (map.staggerindex == "odd" && isColumnEven
+                    || map.staggerindex == "even" && !isColumnEven) {
+
+                drawToBuffer.run()
             } else {
 
                 // we need delayed drawings to correctly draw shadows
-                delayedDrawings += Runnable {
-                    for (dy in 0 until h) {
-                        for (dx in 0 until w) {
-                            val c = sourceImage.pixelReader.getColor(srcx + dx, srcy + dy)
-
-                            if (c != Color.TRANSPARENT) {
-                                bufferBottom.pixelWriter.setColor(
-                                        x * map.tilewidth + offsetX + dx,
-                                        y * map.tileheight + offsetY + dy,
-                                        c
-                                )
-                            }
-                        }
-                    }
-                }
+                delayedDrawings += drawToBuffer
             }
         }
 
+        delayedDrawings.forEach { it.run() }
+        delayedDrawings.clear()
+
         return ImageView(bufferBottom)
     }
 
diff --git a/fxgl-entity/src/test/kotlin/com/almasb/fxgl/entity/level/tiled/TMXLevelLoaderTest.kt b/fxgl-entity/src/test/kotlin/com/almasb/fxgl/entity/level/tiled/TMXLevelLoaderTest.kt
@@ -198,6 +198,15 @@ class TMXLevelLoaderTest {
         assertThat(level.entities.size, `is`(2))
     }
 
+    @Test
+    fun `Load hexagonal tmx level`() {
+        val world = GameWorld()
+
+        val level = TMXLevelLoader().load(javaClass.getResource("hex/simple.tmx"), world)
+
+        assertThat(level.entities.size, `is`(2))
+    }
+
     @ParameterizedTest
     @CsvSource("sewers_v1_1_2.tmx", "sewers_v1_2_3.tmx", "sewers_v1_9_0.tmx")
     fun parse(mapName: String) {
diff --git a/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/hex/hexmini.png b/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/hex/hexmini.png
diff --git a/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/hex/simple.tmx b/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/hex/simple.tmx
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<map version="1.9" tiledversion="1.9.0" orientation="hexagonal" renderorder="right-down" width="20" height="20" tilewidth="14" tileheight="12" infinite="0" hexsidelength="6" staggeraxis="y" staggerindex="odd" nextlayerid="3" nextobjectid="2">
+ <tileset firstgid="1" name="hex mini" tilewidth="18" tileheight="18" tilecount="20" columns="5">
+  <image source="hexmini.png" width="106" height="72"/>
+ </tileset>
+ <layer id="1" name="Ground" width="20" height="20">
+  <data encoding="csv">
+15,15,15,5,16,17,17,13,8,14,14,14,14,5,13,13,13,13,14,14,
+15,8,5,14,16,17,13,8,14,14,14,14,14,5,5,5,13,14,14,14,
+15,9,5,2,2,2,2,13,14,14,14,14,14,5,5,5,13,13,14,14,
+5,5,2,15,5,7,5,14,14,14,14,14,2,2,5,13,5,13,14,14,
+10,5,2,14,14,7,7,14,14,14,13,5,5,2,2,2,2,13,14,14,
+10,10,2,2,14,0,0,14,0,10,13,5,2,2,2,2,13,13,14,14,
+5,10,10,13,0,0,0,0,0,0,13,5,2,2,2,2,2,13,14,14,
+5,13,13,14,14,0,0,0,0,0,0,0,11,2,2,2,2,13,14,10,
+5,5,5,14,0,0,0,0,0,0,0,0,11,11,0,0,2,2,10,10,
+14,14,14,14,0,0,0,0,0,0,0,0,0,0,0,2,2,10,9,9,
+14,14,14,14,14,0,0,0,0,0,0,0,0,0,0,2,2,10,10,9,
+14,14,13,13,14,0,0,0,0,0,0,0,0,0,2,12,13,10,10,9,
+14,14,13,13,14,14,0,0,0,0,0,0,0,0,0,7,7,13,13,10,
+14,13,13,13,14,0,0,0,0,0,0,0,0,0,7,7,13,17,16,10,
+14,10,13,13,14,14,0,0,0,0,0,2,2,2,7,7,13,17,17,16,
+10,10,13,13,14,14,5,2,2,2,2,4,2,2,2,2,13,16,16,16,
+10,10,10,10,13,14,2,2,2,2,4,4,2,7,7,2,13,13,3,16,
+10,10,10,14,14,14,5,5,2,4,4,2,12,7,2,3,3,3,3,3,
+10,10,14,14,8,14,8,13,5,2,4,4,2,2,2,3,3,3,3,3,
+10,14,8,8,8,14,8,13,5,2,2,2,2,3,3,3,3,3,3,3
+</data>
+ </layer>
+ <layer id="2" name="Layer2" width="20" height="20">
+  <data encoding="csv">
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,15,0,0,0,0,0,
+0,0,0,0,0,0,0,0,15,15,15,0,0,15,15,0,0,0,0,0,
+0,0,0,0,0,0,0,15,15,15,15,15,15,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,15,15,15,15,15,15,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,15,15,15,15,15,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,15,15,15,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+</data>
+ </layer>
+</map>
