feat: Add imageRect for Tile (#64)

Author: ufrshubham

packages/tiled/lib/src/tileset/tile.dart

@@ -27,6 +27,7 @@ class Tile {
   List<int?> terrain;
 
   TiledImage? image;
+  Rect? imageRect;
   Layer? objectGroup;
   List<Frame> animation;
   CustomProperties properties;
@@ -37,6 +38,7 @@ class Tile {
     this.probability = 0,
     this.terrain = const [],
     this.image,
+    this.imageRect,
     this.objectGroup,
     this.animation = const [],
     this.properties = CustomProperties.empty,
@@ -64,6 +66,12 @@ class Tile {
                   .toList() ??
               [],
           image: parser.getSingleChildOrNullAs('image', TiledImage.parse),
+          imageRect: Rect.fromLTWH(
+            parser.getDoubleOrNull('x') ?? 0,
+            parser.getDoubleOrNull('y') ?? 0,
+            parser.getDoubleOrNull('width') ?? 0,
+            parser.getDoubleOrNull('height') ?? 0,
+          ),
           objectGroup:
               parser.getSingleChildOrNullAs('objectgroup', Layer.parse),
           animation: parser.formatSpecificParsing(

packages/tiled/lib/src/tileset/tileset.dart

@@ -93,7 +93,13 @@ class Tileset {
     this.backgroundColor,
     this.transparentColor,
     this.type = TilesetType.tileset,
-  }) : tiles = _generateTiles(tiles, tileCount ?? 0) {
+  }) : tiles = _generateTiles(
+          tiles,
+          tileCount ?? 0,
+          columns,
+          tileWidth,
+          tileHeight,
+        ) {
     tileCount = this.tiles.length;
   }
 
@@ -214,10 +220,36 @@ class Tileset {
     );
   }
 
-  static List<Tile> _generateTiles(List<Tile> explicitTiles, int tileCount) {
+  static List<Tile> _generateTiles(
+    List<Tile> explicitTiles,
+    int tileCount,
+    int? columns,
+    int? tileWidth,
+    int? tileHeight,
+  ) {
     final tiles = <Tile>[];
-    for (var i = 0; i < tileCount; i += 1) {
-      tiles.add(Tile(localId: i));
+
+    for (var i = 0; i < tileCount; ++i) {
+      Rect? imageRect;
+
+      if (columns != null &&
+          columns != 0 &&
+          tileWidth != null &&
+          tileHeight != null) {
+        final x = (i % columns) * tileWidth;
+        final y = i ~/ columns * tileHeight;
+
+        imageRect = Rect.fromLTWH(
+          x.toDouble(),
+          y.toDouble(),
+          tileWidth.toDouble(),
+          tileHeight.toDouble(),
+        );
+      }
+
+      tiles.add(
+        Tile(localId: i, imageRect: imageRect),
+      );
     }
 
     for (final tile in explicitTiles) {

packages/tiled/test/fixtures/multi_image_tileset.tsx

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<tileset version="1.9" tiledversion="1.9.2" name="multi_image_tileset" tilewidth="32" tileheight="32" tilecount="2" columns="0">
+ <grid orientation="orthogonal" width="1" height="1"/>
+ <tile id="0" x="64" y="96" width="32" height="32">
+  <image width="256" height="256" source="floortileset.png"/>
+ </tile>
+ <tile id="1" x="0" y="0" width="20" height="20">
+  <image width="160" height="20" source="coins.png"/>
+ </tile>
+</tileset>

packages/tiled/test/tile_test.dart

@@ -1,5 +1,9 @@
+import 'dart:io';
+import 'dart:ui';
+
 import 'package:test/test.dart';
 import 'package:tiled/tiled.dart';
+import 'package:xml/xml.dart';
 
 void main() {
   group('Tile.emptyTile()', () {
@@ -25,4 +29,53 @@ void main() {
     final tile = Tile(localId: -1);
     expect(tile.properties, isA<CustomProperties>());
   });
+
+  group(
+    'Tile.imageRect',
+    () {
+      late Tileset tileset1;
+      late Tileset tileset2;
+
+      setUp(() {
+        final f1 = File('./test/fixtures/multi_image_tileset.tsx')
+            .readAsString()
+            .then((xml) {
+          final tilesetXml = XmlDocument.parse(xml).rootElement;
+          tileset1 = Tileset.parse(XmlParser(tilesetXml));
+        });
+
+        final f2 = File('./test/fixtures/tileid_over_tilecount.tsx')
+            .readAsString()
+            .then((xml) {
+          final tilesetXml = XmlDocument.parse(xml).rootElement;
+          tileset2 = Tileset.parse(XmlParser(tilesetXml));
+        });
+
+        return Future.wait([f1, f2]);
+      });
+
+      test('with image collections', () {
+        final tile1 = tileset1.tiles.firstWhere((t) => t.localId == 0);
+        final tile2 = tileset1.tiles.firstWhere((t) => t.localId == 1);
+
+        expect(tile1.imageRect, const Rect.fromLTWH(64, 96, 32, 32));
+        expect(tile2.imageRect, const Rect.fromLTWH(0, 0, 20, 20));
+      });
+
+      test(
+        'with single image',
+        () {
+          final tile1 = tileset2.tiles.firstWhere((t) => t.localId == 58);
+          final tile2 = tileset2.tiles.firstWhere((t) => t.localId == 106);
+          final tile3 = tileset2.tiles.firstWhere((t) => t.localId == 129);
+          final tile4 = tileset2.tiles.firstWhere((t) => t.localId == 11);
+
+          expect(tile1.imageRect, const Rect.fromLTWH(112, 48, 16, 16));
+          expect(tile2.imageRect, const Rect.fromLTWH(64, 96, 16, 16));
+          expect(tile3.imageRect, const Rect.fromLTWH(160, 112, 16, 16));
+          expect(tile4.imageRect, const Rect.fromLTWH(176, 0, 16, 16));
+        },
+      );
+    },
+  );
 }