feat: .tmx level loader now supports polyline objects, closes #1133

AlmasB · AlmasB · commit 9268b4add85f · 2022-01-02T11:10:52.000Z
diff --git a/fxgl-entity/src/main/kotlin/com/almasb/fxgl/entity/level/tiled/TMXLevelLoader.kt b/fxgl-entity/src/main/kotlin/com/almasb/fxgl/entity/level/tiled/TMXLevelLoader.kt
@@ -16,6 +16,7 @@ import com.almasb.fxgl.entity.level.LevelLoadingException
 import com.almasb.fxgl.logging.Logger
 import javafx.scene.paint.Color
 import javafx.scene.shape.Polygon
+import javafx.scene.shape.Polyline
 import java.io.InputStream
 import java.net.URL
 import java.util.*
@@ -247,7 +248,11 @@ class TMXLevelLoader
                     }
 
                     "polygon" -> {
-                        parseObjectPolygon(currentObject, start)
+                        parseObjectPolyline(currentObject, start, isClosed = true)
+                    }
+
+                    "polyline" -> {
+                        parseObjectPolyline(currentObject, start, isClosed = false)
                     }
                 }
             }
@@ -502,18 +507,23 @@ class TMXLevelLoader
         }
     }
 
-    private fun parseObjectPolygon(obj: TiledObject, start: StartElement) {
+    private fun parseObjectPolyline(obj: TiledObject, start: StartElement, isClosed: Boolean) {
         val data = start.getString("points")
 
         val points = data.split(" +".toRegex())
                 .flatMap { it.split(",") }
                 .map { it.toDouble() }
                 .toDoubleArray()
 
-        // https://github.com/AlmasB/FXGL/issues/575
-        val polygon = Polygon(*points)
+        if (isClosed) {
+            val polygon = Polygon(*points)
 
-        (obj.properties as MutableMap)["polygon"] = polygon
+            (obj.properties as MutableMap)["polygon"] = polygon
+        } else {
+            val polyline = Polyline(*points)
+
+            (obj.properties as MutableMap)["polyline"] = polyline
+        }
     }
 }
 
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
@@ -13,6 +13,7 @@ import javafx.geometry.Point2D
 import javafx.scene.image.ImageView
 import javafx.scene.paint.Color
 import javafx.scene.shape.Polygon
+import javafx.scene.shape.Polyline
 import org.hamcrest.CoreMatchers.`is`
 import org.hamcrest.CoreMatchers.not
 import org.hamcrest.MatcherAssert.assertThat
@@ -43,8 +44,8 @@ class TMXLevelLoaderTest {
         assertThat(level.width, `is`(24*64))
         assertThat(level.height, `is`(24*64))
 
-        // 4 object entities + 2 background tile layers
-        assertThat(level.entities.size, `is`(4 + 2))
+        // 5 object entities + 2 background tile layers
+        assertThat(level.entities.size, `is`(5 + 2))
     }
 
     @ParameterizedTest
@@ -200,7 +201,7 @@ class TMXLevelLoaderTest {
         assertThat(map.height, `is`(64))
         assertThat(map.tilewidth, `is`(24))
         assertThat(map.tileheight, `is`(24))
-        assertThat(map.nextobjectid, `is`(5))
+        assertThat(map.nextobjectid, `is`(7))
         assertThat(map.orientation, `is`("orthogonal"))
         assertThat(map.renderorder, `is`("right-down"))
         assertFalse(map.infinite)
@@ -281,6 +282,11 @@ class TMXLevelLoaderTest {
         assertThat(obj4.id, `is`(4))
         assertThat((obj4.properties["polygon"] as Polygon).points, `is`(Polygon(0.0, 0.0, 120.0, -72.0, 192.0, 48.0, 24.0, 48.0).points))
 
+        val obj6 = layer3.objects[3]
+
+        assertThat(obj6.id, `is`(6))
+        assertThat((obj6.properties["polyline"] as Polyline).points, `is`(Polyline(0.0,0.0, 96.0,0.0, 96.0,-96.0, 192.0,-96.0, 192.0,96.0, 24.0,96.0).points))
+
         val layer4 = map.layers[3]
 
         assertThat(layer4.name, `is`("Group2"))
diff --git a/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/sewers_v1_1_2.tmx b/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/sewers_v1_1_2.tmx
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<map version="1.0" tiledversion="1.1.2" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="24" tileheight="24" infinite="0" nextobjectid="5">
+<map version="1.0" tiledversion="1.1.2" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="24" tileheight="24" infinite="0" nextobjectid="7">
  <tileset firstgid="1" name="sewer_tileset" tilewidth="24" tileheight="24" tilecount="72" columns="8">
   <image source="sewer_tileset.png" trans="ff00ff" width="192" height="217"/>
  </tileset>
@@ -26,6 +26,9 @@
   <object id="4" name="polygon_name" type="no_type" x="696" y="504">
    <polygon points="0,0 120,-72 192,48 24,48"/>
   </object>
+  <object id="6" name="polyline_name" type="no_type" x="936" y="432">
+   <polyline points="0,0 96,0 96,-96 192,-96 192,96 24,96"/>
+  </object>
  </objectgroup>
  <objectgroup name="Group2">
   <object id="3" name="no name" x="240" y="504" width="120" height="120"/>
diff --git a/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/sewers_v1_2_3.tmx b/fxgl-entity/src/test/resources/com/almasb/fxgl/entity/level/tiled/sewers_v1_2_3.tmx
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<map version="1.2" tiledversion="1.2.3" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="24" tileheight="24" infinite="0" nextlayerid="5" nextobjectid="5">
+<map version="1.2" tiledversion="1.2.3" orientation="orthogonal" renderorder="right-down" width="64" height="64" tilewidth="24" tileheight="24" infinite="0" nextlayerid="5" nextobjectid="7">
  <tileset firstgid="1" name="sewer_tileset" tilewidth="24" tileheight="24" tilecount="72" columns="8">
   <image source="sewer_tileset.png" trans="ff00ff" width="192" height="217"/>
  </tileset>
@@ -26,6 +26,9 @@
   <object id="4" name="polygon_name" type="no_type" x="696" y="504">
    <polygon points="0,0 120,-72 192,48 24,48"/>
   </object>
+  <object id="6" name="polyline_name" type="no_type" x="936" y="432">
+   <polyline points="0,0 96,0 96,-96 192,-96 192,96 24,96"/>
+  </object>
  </objectgroup>
  <objectgroup id="4" name="Group2">
   <object id="3" name="no name" x="240" y="504" width="120" height="120"/>

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ import com.almasb.fxgl.entity.level.LevelLoadingException`
`16`	`16`	`import com.almasb.fxgl.logging.Logger`
`17`	`17`	`import javafx.scene.paint.Color`
`18`	`18`	`import javafx.scene.shape.Polygon`
	`19`	`+import javafx.scene.shape.Polyline`
`19`	`20`	`import java.io.InputStream`
`20`	`21`	`import java.net.URL`
`21`	`22`	`import java.util.*`
`@@ -247,7 +248,11 @@ class TMXLevelLoader`
`247`	`248`	`}`
`248`	`249`
`249`	`250`	`"polygon" -> {`
`250`		`- parseObjectPolygon(currentObject, start)`
	`251`	`+ parseObjectPolyline(currentObject, start, isClosed = true)`
	`252`	`+ }`
	`253`	`+`
	`254`	`+ "polyline" -> {`
	`255`	`+ parseObjectPolyline(currentObject, start, isClosed = false)`
`251`	`256`	`}`
`252`	`257`	`}`
`253`	`258`	`}`
`@@ -502,18 +507,23 @@ class TMXLevelLoader`
`502`	`507`	`}`
`503`	`508`	`}`
`504`	`509`
`505`		`- private fun parseObjectPolygon(obj: TiledObject, start: StartElement) {`
	`510`	`+ private fun parseObjectPolyline(obj: TiledObject, start: StartElement, isClosed: Boolean) {`
`506`	`511`	`val data = start.getString("points")`
`507`	`512`
`508`	`513`	`val points = data.split(" +".toRegex())`
`509`	`514`	`.flatMap { it.split(",") }`
`510`	`515`	`.map { it.toDouble() }`
`511`	`516`	`.toDoubleArray()`
`512`	`517`
`513`		`- // https://github.com/AlmasB/FXGL/issues/575`
`514`		`- val polygon = Polygon(*points)`
	`518`	`+ if (isClosed) {`
	`519`	`+ val polygon = Polygon(*points)`
`515`	`520`
`516`		`- (obj.properties as MutableMap)["polygon"] = polygon`
	`521`	`+ (obj.properties as MutableMap)["polygon"] = polygon`
	`522`	`+ } else {`
	`523`	`+ val polyline = Polyline(*points)`
	`524`	`+`
	`525`	`+ (obj.properties as MutableMap)["polyline"] = polyline`
	`526`	`+ }`
`517`	`527`	`}`
`518`	`528`	`}`
`519`	`529`