renamed Color to ColorData to make conversion easier in flame_tiled // added tests for hex decoding in ColorData

Author: benni-tec

packages/tiled/lib/src/common/color.dart

@@ -1,27 +1,21 @@
 part of tiled;
 
-const _mask = 0xff;
+class ColorData {
+  static int _sub(int hex, int index) => (hex >> index * 8) & 0x000000ff;
 
-int _sub(int hex, int index) {
-  final value = (hex & (_mask << index * 8)) >> index * 8;
-  assert(value >= 0 && value < 256);
-  return value;
-}
-
-class Color {
   final int red;
   final int green;
   final int blue;
   final int alpha;
 
   /// Format: aarrggbb
-  Color.hex(int hex)
+  ColorData.hex(int hex)
       : alpha = _sub(hex, 3),
         red = _sub(hex, 2),
         green = _sub(hex, 1),
         blue = _sub(hex, 0);
 
-  const Color.rgb(this.red, this.green, this.blue, [this.alpha = 255])
+  const ColorData.rgb(this.red, this.green, this.blue, [this.alpha = 255])
       : assert(red >= 0 && red <= 255),
         assert(green >= 0 && green <= 255),
         assert(blue >= 0 && blue <= 255),

packages/tiled/lib/src/common/property.dart

@@ -37,7 +37,7 @@ class Property<T> {
       case PropertyType.color:
         return ColorProperty(
           name: name,
-          value: parser.getColor('value', defaults: Color.hex(0x00000000)),
+          value: parser.getColor('value', defaults: ColorData.hex(0x00000000)),
           hexValue: parser.getString('value', defaults: '#00000000'),
         );
 
@@ -156,7 +156,7 @@ class ObjectProperty extends Property<int> {
 }
 
 /// [value] is the color
-class ColorProperty extends Property<Color> {
+class ColorProperty extends Property<ColorData> {
   final String hexValue;
 
   ColorProperty({

packages/tiled/lib/src/layer.dart

@@ -77,11 +77,11 @@ abstract class Layer {
   /// any graphics drawn by this layer or any child layers (optional).
   String? tintColorHex;
 
-  /// [Color] that is multiplied with any graphics drawn by this layer or any
+  /// [ColorData] that is multiplied with any graphics drawn by this layer or any
   /// child layers (optional).
   ///
   /// Parsed from [tintColorHex], will be null if parsing fails for any reason.
-  Color? tintColor;
+  ColorData? tintColor;
 
   /// The opacity of the layer as a value from 0 to 1. Defaults to 1.
   double opacity;
@@ -420,7 +420,7 @@ class TileLayer extends Layer {
 }
 
 class ObjectGroup extends Layer {
-  static const defaultColor = Color.rgb(160, 160, 164, 255);
+  static const defaultColor = ColorData.rgb(160, 160, 164, 255);
   static const defaultColorHex = '%a0a0a4';
 
   /// topdown (default) or index (indexOrder).
@@ -433,12 +433,12 @@ class ObjectGroup extends Layer {
   /// this group. (defaults to gray (“#a0a0a4”))
   String colorHex;
 
-  /// [Color] used to display the objects in this group.
+  /// [ColorData] used to display the objects in this group.
   /// (defaults to gray (“#a0a0a4”))
   ///
   /// Parsed from [colorHex], will be fallback to [defaultColor] if parsing
   /// fails for any reason.
-  Color color;
+  ColorData color;
 
   ObjectGroup({
     super.id,
@@ -474,11 +474,11 @@ class ImageLayer extends Layer {
   /// (optional).
   String? transparentColorHex;
 
-  /// [Color] to be rendered as transparent (optional).
+  /// [ColorData] to be rendered as transparent (optional).
   ///
   /// Parsed from [transparentColorHex], will be null if parsing fails for any
   /// reason.
-  Color? transparentColor;
+  ColorData? transparentColor;
 
   /// Whether or not to repeat the image on the X-axis
   bool repeatX;

packages/tiled/lib/src/parser.dart

@@ -197,7 +197,7 @@ abstract class Parser {
     return result;
   }
 
-  Color? getColorOrNull(String name, {Color? defaults}) {
+  ColorData? getColorOrNull(String name, {ColorData? defaults}) {
     final tiledColor = getStringOrNull(name);
 
     // Tiled colors are stored as either ARGB or RGB hex values, so we can
@@ -212,13 +212,13 @@ abstract class Parser {
     }
 
     if (colorValue != null) {
-      return Color.hex(colorValue);
+      return ColorData.hex(colorValue);
     } else {
       return defaults;
     }
   }
 
-  Color getColor(String name, {Color? defaults}) {
+  ColorData getColor(String name, {ColorData? defaults}) {
     final result = getColorOrNull(name, defaults: defaults);
     if (result == null) {
       throw ParsingException(name, null, 'Missing required color field');

packages/tiled/lib/src/tiled_map.dart

@@ -74,12 +74,12 @@ class TiledMap {
   /// behind all other layers (optional).
   String? backgroundColorHex;
 
-  /// [Color] to be rendered as a solid color behind all other layers
+  /// [ColorData] to be rendered as a solid color behind all other layers
   /// (optional).
   ///
   /// Parsed from [backgroundColorHex], will be null if parsing fails for any
   /// reason.
-  Color? backgroundColor;
+  ColorData? backgroundColor;
 
   int compressionLevel;
 

packages/tiled/test/color.dart

@@ -0,0 +1,25 @@
+import 'dart:math';
+
+import 'package:test/expect.dart';
+import 'package:test/scaffolding.dart';
+import 'package:tiled/tiled.dart';
+
+void main() {
+  group("ColorData.hex", () {
+    test("parse", () {
+      final random = Random();
+      final red = random.nextInt(256);
+      final green = random.nextInt(256);
+      final blue = random.nextInt(256);
+      final alpha = random.nextInt(256);
+
+      final hex = alpha << 24 | red << 16 | green << 8 | blue << 0;
+      final data = ColorData.hex(hex);
+
+      expect(data.alpha, equals(alpha));
+      expect(data.red, equals(red));
+      expect(data.green, equals(green));
+      expect(data.blue, equals(blue));
+    });
+  });
+}

packages/tiled/test/layer_test.dart

@@ -74,7 +74,7 @@ void main() {
       expect(layer.tintColorHex, equals('#ffaabb'));
       expect(
         layer.tintColor,
-        equals(Color.hex(int.parse('0xffffaabb'))),
+        equals(ColorData.hex(int.parse('0xffffaabb'))),
       );
     });
   });

packages/tiled/test/object_group_test.dart

@@ -30,7 +30,7 @@ void main() {
       expect(objectGroup.colorHex, equals('#555500'));
       expect(
         objectGroup.color,
-        equals(Color.hex(int.parse('0xff555500'))),
+        equals(ColorData.hex(int.parse('0xff555500'))),
       );
     });
 

packages/tiled/test/parser_test.dart

@@ -43,7 +43,7 @@ void main() {
       expect(map.backgroundColorHex, equals('#ccddaaff'));
       expect(
         map.backgroundColor,
-        equals(Color.hex(int.parse('0xccddaaff'))),
+        equals(ColorData.hex(int.parse('0xccddaaff'))),
       );
     });
 
@@ -99,8 +99,8 @@ void main() {
             equals('#00112233'),
           );
           expect(
-            properties.getValue<Color>('color property'),
-            equals(Color.hex(0x00112233)),
+            properties.getValue<ColorData>('color property'),
+            equals(ColorData.hex(0x00112233)),
           );
           expect(
             properties.getValue<double>('float property'),