add index to graphics element, fix gog g1 groups, hide none value for graphicselementflag

Author: LeftofZen

Dat/Converters/GraphicsElementConverter.cs

@@ -19,7 +19,7 @@ public static DatG1Element32 Convert(this GraphicsElement graphicsElement)
 			ImageData = graphicsElement.ImageData,
 		};
 
-	public static GraphicsElement Convert(this DatG1Element32 graphicsElement)
+	public static GraphicsElement Convert(this DatG1Element32 graphicsElement, string name, int index)
 		=> new()
 		{
 			Width = graphicsElement.Width,
@@ -29,5 +29,7 @@ public static GraphicsElement Convert(this DatG1Element32 graphicsElement)
 			Flags = (GraphicsElementFlags)graphicsElement.Flags,
 			ZoomOffset = graphicsElement.ZoomOffset,
 			ImageData = graphicsElement.ImageData,
+			Name = name,
+			ImageTableIndex = index,
 		};
 }

Dat/FileParsing/SawyerStreamReader.cs

@@ -219,9 +219,7 @@ public static StringTable ReadStringTableStream(Stream stream, string[] stringNa
 
 	public static G1Dat? LoadG1(string filename, ILogger logger)
 	{
-		ReadOnlySpan<byte> fullData = File.ReadAllBytes(filename);
-
-		using (var ms = new MemoryStream(fullData.ToArray()))
+		using (var ms = new FileStream(filename, FileMode.Open))
 		using (var br = new LocoBinaryReader(ms))
 		{
 			var (g1Header, imageTable) = ReadImageTable(br);
@@ -282,9 +280,7 @@ public static (G1Header Header, List<GraphicsElement> Table) ReadImageTable(Loco
 				currElement.ImageData = DecodeRLEImageData(currElement);
 			}
 
-			var ge = currElement.Convert();
-			ge.Name = DefaultImageTableNameProvider.GetImageName(i);
-			graphicsElements.Add(ge);
+			graphicsElements.Add(currElement.Convert(DefaultImageTableNameProvider.GetImageName(i), i));
 		}
 
 		return (g1Header, graphicsElements);

Dat/Types/G1Dat.cs

@@ -1,6 +1,7 @@
 using Definitions.ObjectModels;
 using Definitions.ObjectModels.Types;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 
 namespace Dat.Types;
@@ -12,33 +13,67 @@ public class G1Dat
 	public G1Header G1Header { get; set; }
 	public ImageTable ImageTable { get; set; }
 
+	public const int SteamImageCount = 3896;
+	public const int GoGImageCount = 4122;
+
 	public bool IsSteamG1
-		=> ImageTable.GraphicsElements.Count == 3896;
+		=> ImageTable.GraphicsElements.Count == SteamImageCount;
 
 	public G1Dat(G1Header g1Header, List<GraphicsElement> graphicsElements)
 	{
 		G1Header = g1Header;
-		ImageTable = new ImageTable
+		if (graphicsElements.Count == SteamImageCount)
+		{
+			ImageTable = new ImageTable
+			{
+				// Note: The grouping below is good but its for steam only, and because elements are out of order, saving is not possible unless each element stores its index
+				Groups =
+				[
+					("terrain-masks", [.. graphicsElements[0..417], .. graphicsElements[3629..3896]]),
+					("palettes", [.. graphicsElements[417..428], .. graphicsElements[2170..2305]]),
+					("arrows", [.. graphicsElements[428..444], .. graphicsElements[449..457], .. graphicsElements[3492..3504]]),
+					("unk", graphicsElements[444..449]),
+					("supports", graphicsElements[457..1117]),
+					("glyphs", graphicsElements[1117..2170]),
+					("loading-bar", graphicsElements[2326..2335]),
+					("interface", [.. graphicsElements[2335..2470], .. graphicsElements[3477..3479], .. graphicsElements[2305..2326], .. graphicsElements[3539..3547]]),
+					("height-markers", graphicsElements[2470..3238]),
+					("numerical-markers", graphicsElements[3238..3302]),
+					("unk", graphicsElements[3302..3362]),
+					("particles", graphicsElements[3362..3477]),
+					("masks", [.. graphicsElements[3479..3492], graphicsElements[3504]]),
+					("object-types", graphicsElements[3505..3539]),
+					("title", graphicsElements[3547..3629]),
+				]
+			};
+		}
+		else
 		{
-			Groups =
-			[
-				("terrain-masks", [.. graphicsElements[0..417], .. graphicsElements[3629..3896]]),
-				("palettes", [.. graphicsElements[417..428], .. graphicsElements[2170..2304]]),
-				("arrows", [.. graphicsElements[428..444], .. graphicsElements[449..457], .. graphicsElements[3492..3504]]),
-				("unk", graphicsElements[444..449]),
-				("supports", graphicsElements[457..1117]),
-				("glyphs", graphicsElements[1117..2169]),
-				("loading-bar", graphicsElements[2326..2335]),
-				("interface", [.. graphicsElements[2335..2470], .. graphicsElements[3477..3479], .. graphicsElements[2305..2326], .. graphicsElements[3539..3547]]),
-				("height-markers", graphicsElements[2470..3238]),
-				("numerical-markers", graphicsElements[3238..3302]),
-				("unk", graphicsElements[3302..3362]),
-				("particles", graphicsElements[3362..3477]),
-				("masks", [.. graphicsElements[3479..3492], graphicsElements[3504]]),
-				("object-types", graphicsElements[3505..3539]),
-				("title", graphicsElements[3547..3629]),
-			]
-		};
+			ImageTable = new ImageTable()
+			{
+				Groups =
+				[
+					("terrain-masks", [.. graphicsElements[0..417], .. graphicsElements[3631..3898]]),
+					("palettes", [.. graphicsElements[417..428], .. graphicsElements[2170..2305]]),
+					("arrows", [.. graphicsElements[428..444], .. graphicsElements[449..457], .. graphicsElements[3492..3504]]),
+					("unk", graphicsElements[444..449]),
+					("supports", graphicsElements[457..1117]),
+					("glyphs", [.. graphicsElements[1117..2170], .. graphicsElements[3898..4122]]),
+					("loading-bar", graphicsElements[2326..2335]),
+					("interface", [.. graphicsElements[2335..2470], .. graphicsElements[3477..3479], .. graphicsElements[2305..2326], .. graphicsElements[3539..3547]]),
+					("height-markers", graphicsElements[2470..3238]),
+					("numerical-markers", graphicsElements[3238..3302]),
+					("unk", graphicsElements[3302..3362]),
+					("particles", graphicsElements[3362..3477]),
+					("masks", [.. graphicsElements[3479..3492], graphicsElements[3504]]),
+					("object-types", graphicsElements[3505..3539]),
+					("title", graphicsElements[3547..3631]),
+				]
+			};
+		}
+
+		Debug.Assert(G1Header.NumEntries == ImageTable.GraphicsElements.Count);
+		Debug.Assert(ImageTable.GraphicsElements.Count == graphicsElements.Count);
 	}
 
 	public bool TryGetImageName(int id, [MaybeNullWhen(false)] out string value)

Definitions/ObjectModels/ImageTable.cs

@@ -29,7 +29,9 @@ public PaletteMap PaletteMap
 	// public/old interface
 	public List<GraphicsElement> GraphicsElements
 	{
-		get => [.. Groups.SelectMany(x => x.GraphicsElements)];
+		get => [.. Groups
+			.SelectMany(x => x.GraphicsElements)
+			.OrderBy(x => x.ImageTableIndex)];
 		set => Groups.Add(("All", value));
 	}
 

Definitions/ObjectModels/Types/GraphicsElement.cs

@@ -36,4 +36,6 @@ public class GraphicsElement // follows G1Element32, except XOffset and YOffset
 
 	[JsonIgnore] // this is calculated based on object type, its not really a part of the object definition itself
 	public string Name { get; set; } // taken from IImageNameProvider
+
+	public int ImageTableIndex { get; init; }
 }

Gui/ViewModels/Graphics/ImageViewModel.cs

@@ -2,6 +2,7 @@
 using Definitions.ObjectModels;
 using Definitions.ObjectModels.Types;
 using Gui.Models;
+using PropertyModels.ComponentModel.DataAnnotations;
 using ReactiveUI;
 using ReactiveUI.Fody.Helpers;
 using SixLabors.ImageSharp;
@@ -15,15 +16,16 @@ namespace Gui.ViewModels.Graphics;
 
 public class ImageViewModel : ReactiveObject
 {
+	public string Name { get; set; }
+	public int ImageTableIndex { get; init; }
 	public int Width => UnderlyingImage.Width;
 	public int Height => UnderlyingImage.Height;
-	public string Name { get; set; }
-
 	[Reactive] public int XOffset { get; set; }
 	[Reactive] public int YOffset { get; set; }
+	public short ZoomOffset { get; set; }
 
+	[EnumProhibitValues<GraphicsElementFlags>(GraphicsElementFlags.None)]
 	public GraphicsElementFlags Flags { get; set; }
-	public short ZoomOffset { get; set; }
 
 	[Reactive, Browsable(false)]
 	public Bitmap DisplayedImage { get; private set; }
@@ -50,6 +52,7 @@ public ImageViewModel(GraphicsElement graphicsElement, PaletteMap paletteMap)
 		YOffset = graphicsElement.YOffset;
 		Flags = graphicsElement.Flags;
 		ZoomOffset = graphicsElement.ZoomOffset;
+		ImageTableIndex = graphicsElement.ImageTableIndex;
 		PaletteMap = paletteMap;
 
 		_ = this.WhenAnyValue(o => o.UnderlyingImage)
@@ -69,13 +72,15 @@ public void RecolourImage(ColourRemapSwatch primary, ColourRemapSwatch secondary
 
 		var dummyElement = new GraphicsElement
 		{
+			Name = Name, // not necessary for palette
 			Width = (short)UnderlyingImage.Width,
 			Height = (short)UnderlyingImage.Height,
 			XOffset = (short)XOffset,
 			YOffset = (short)YOffset,
 			Flags = Flags,
 			ZoomOffset = ZoomOffset,
-			ImageData = rawData
+			ImageData = rawData,
+			ImageTableIndex = ImageTableIndex, // not necessary for palette
 		};
 
 		if (!PaletteMap.TryConvertG1ToRgba32Bitmap(dummyElement, primary, secondary, out var image))

Tests/G1Tests.cs

@@ -1,9 +1,9 @@
-using NUnit.Framework;
 using Common.Logging;
 using Dat.FileParsing;
 using Dat.Types;
-using SixLabors.ImageSharp;
 using Definitions.ObjectModels.Types;
+using NUnit.Framework;
+using SixLabors.ImageSharp;
 
 namespace Dat.Tests;
 
@@ -55,8 +55,8 @@ public void LoadSaveLoadG1(string g1File)
 	[TestCase(GoG_G1, 3540)]
 	[TestCase(GoG_G1, 3541)]
 	[TestCase(GoG_G1, 3542)]
-	[TestCase(GoG_G1, 3618)]
-	[TestCase(GoG_G1, 3619)]
+	[TestCase(GoG_G1, 3620)]
+	[TestCase(GoG_G1, 3621)]
 	public void LoadSaveLoadG1_RLERunsGreaterThan127(string g1File, int element)
 	{
 		var g1 = SawyerStreamReader.LoadG1(g1File, Logger);

Tests/IdempotenceTests.cs

@@ -13,6 +13,8 @@ namespace Dat.Tests;
 [TestFixture]
 public class IdempotenceTests
 {
+	static PaletteMap PaletteMap { get; } = new PaletteMap("C:\\Users\\bigba\\source\\repos\\OpenLoco\\ObjectEditor\\Gui\\Assets\\palette.png");
+
 	static string[] VanillaFiles => [
 		.. Directory.GetFiles(TestConstants.BaseSteamObjDataPath, "*.dat"),
 		.. Directory.GetFiles(TestConstants.BaseGoGObjDataPath, "*.dat")
@@ -62,12 +64,11 @@ public void LoadSaveLoad(string filename)
 
 		using (Assert.EnterMultipleScope())
 		{
-			Assert.That(JsonSerializer.Serialize((object)actual.Object), Is.EqualTo(JsonSerializer.Serialize((object)expected.Object)));
-			Assert.That(JsonSerializer.Serialize(actual.StringTable), Is.EqualTo(JsonSerializer.Serialize(expected.StringTable)));
+			Assert.That(JsonSerializer.Serialize((object)actual.Object), Is.EqualTo(JsonSerializer.Serialize((object)expected.Object)), "Object");
+			Assert.That(JsonSerializer.Serialize(actual.StringTable), Is.EqualTo(JsonSerializer.Serialize(expected.StringTable)), "String Table");
 
 			if (actual.ImageTable != null && expected.ImageTable != null)
 			{
-				var pm = new PaletteMap("C:\\Users\\bigba\\source\\repos\\OpenLoco\\ObjectEditor\\Gui\\Assets\\palette.png");
 				var i = 0;
 				foreach (var ae in actual.ImageTable.GraphicsElements.Zip(expected.ImageTable.GraphicsElements))
 				{
@@ -76,13 +77,13 @@ public void LoadSaveLoad(string filename)
 
 					if (ac != ex)
 					{
-						_ = pm.TryConvertG1ToRgba32Bitmap(ae.First, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var img1);
-						_ = pm.TryConvertG1ToRgba32Bitmap(ae.Second, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var img2);
+						_ = PaletteMap.TryConvertG1ToRgba32Bitmap(ae.First, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var img1);
+						_ = PaletteMap.TryConvertG1ToRgba32Bitmap(ae.Second, ColourRemapSwatch.PrimaryRemap, ColourRemapSwatch.SecondaryRemap, out var img2);
 						img1.SaveAsBmp($"{Path.GetFileName(filename)}-{i}-actual.bmp");
 						img2.SaveAsBmp($"{Path.GetFileName(filename)}-{i}-expected.bmp");
 					}
 
-					Assert.That(ac, Is.EqualTo(ex));
+					Assert.That(ac, Is.EqualTo(ex), $"GraphicsTable[{i}]");
 					i++;
 				}
 			}