Image groups

.editorconfig

@@ -394,7 +394,7 @@ dotnet_diagnostic.IDE0078.severity = suggestion
 dotnet_diagnostic.IDE0080.severity = suggestion
 dotnet_diagnostic.IDE0082.severity = suggestion
 dotnet_diagnostic.IDE0083.severity = suggestion
-dotnet_diagnostic.IDE0090.severity = suggestion
+dotnet_diagnostic.IDE0090.severity = error
 dotnet_diagnostic.IDE0100.severity = suggestion
 dotnet_diagnostic.IDE0110.severity = suggestion
 dotnet_diagnostic.IDE0120.severity = suggestion

Dat/FileParsing/LocoBinaryReader.cs

@@ -1,6 +1,6 @@
 using Dat.Converters;
 using Dat.Types;
-using Definitions.ObjectModels.Objects.Building;
+using Definitions.ObjectModels.Objects.Common;
 using Definitions.ObjectModels.Objects.Shared;
 using Definitions.ObjectModels.Objects.Sound;
 using Definitions.ObjectModels.Objects.Vehicle;
@@ -331,7 +331,6 @@ public GearboxMotorSound ReadGearboxMotorSound()
 			SpeedFrequencyFactor = ReadByte(),
 		};
 
-
 	public CargoOffset[][][] ReadCargoOffsets()
 	{
 		const int rotationSize = 4;

Dat/FileParsing/LocoBinaryWriter.cs

@@ -1,8 +1,8 @@
 using Common;
 using Dat.Converters;
 using Dat.Types;
-using Definitions.ObjectModels.Objects.Building;
 using Definitions.ObjectModels.Objects.Shared;
+using Definitions.ObjectModels.Objects.Common;
 using Definitions.ObjectModels.Objects.Sound;
 using Definitions.ObjectModels.Objects.Vehicle;
 using Definitions.ObjectModels.Types;

Dat/FileParsing/SawyerStreamReader.cs

@@ -7,6 +7,7 @@
 using Definitions.ObjectModels;
 using Definitions.ObjectModels.Objects.Sound;
 using Definitions.ObjectModels.Types;
+using System.ComponentModel.DataAnnotations;
 using System.Text;
 
 namespace Dat.FileParsing;
@@ -137,9 +138,9 @@ static void ValidateLocoStruct(S5Header s5Header, ILocoStruct locoStruct, ILogge
 				}
 			}
 
-			if (!locoStruct.Validate())
+			foreach (var failedValidation in locoStruct.Validate(new ValidationContext(locoStruct)))
 			{
-				warnings.Add($"\"{s5Header.Name}\" failed validation");
+				warnings.Add($"\"{s5Header.Name}\" failed validation: {failedValidation}");
 			}
 
 			if (warnings.Count != 0)
@@ -252,6 +253,8 @@ public static (G1Header Header, List<GraphicsElement> Table) ReadImageTable(Loco
 		var imageData = br.ReadToEnd();
 		g1Header.ImageData = [.. imageData];
 
+		var graphicsElements = new List<GraphicsElement>();
+
 		// set image data
 		for (var i = 0; i < g1Header.NumEntries; ++i)
 		{
@@ -272,15 +275,19 @@ public static (G1Header Header, List<GraphicsElement> Table) ReadImageTable(Loco
 				currElement.ImageData = [.. imageData[(int)currElement.Offset..(int)nextOffset]];
 			}
 
-			// if rleCompressed, uncompress it, except if the duplicate-previous flag is also set - by the current code here, the previous
-			// image (which was also compressed) is now uncompressed, so we don't need do double-uncompress it.
+			// if rleCompressed, decompress it, except if the duplicate-previous flag is also set - by the current code here, the previous
+			// image (which was also compressed) is now decompressed, so we don't need do double-decompress it.
 			if (currElement.Flags.HasFlag(DatG1ElementFlags.IsRLECompressed) && !currElement.Flags.HasFlag(DatG1ElementFlags.DuplicatePrevious))
 			{
 				currElement.ImageData = DecodeRLEImageData(currElement);
 			}
+
+			var ge = currElement.Convert();
+			ge.Name = DefaultImageTableNameProvider.GetImageName(i);
+			graphicsElements.Add(ge);
 		}
 
-		return (g1Header, g1Element32s.Select(x => x.Convert()).ToList());
+		return (g1Header, graphicsElements);
 	}
 
 	static uint GetNextNonDuplicateOffset(List<DatG1Element32> g1Element32s, int i, uint imageDateLength)

Dat/FileParsing/SawyerStreamWriter.cs

@@ -7,6 +7,7 @@
 using Definitions.ObjectModels;
 using Definitions.ObjectModels.Objects.Sound;
 using Definitions.ObjectModels.Types;
+using System.ComponentModel.DataAnnotations;
 using System.Text;
 
 namespace Dat.FileParsing;
@@ -490,9 +491,10 @@ public static void WriteLocoObject(Stream stream, LocoObject obj)
 
 	public static MemoryStream WriteLocoObject(string objName, ObjectType objectType, ObjectSource objectSource, SawyerEncoding encoding, ILogger logger, LocoObject obj, bool allowWritingAsVanilla)
 	{
-		if (!obj.Object.Validate())
+		var validationResults = new List<ValidationResult>();
+		if (!Validator.TryValidateObject(obj.Object, new ValidationContext(obj.Object), validationResults))
 		{
-			throw new ArgumentException($"{objName} was invalid", nameof(obj));
+			throw new ArgumentException($"{objName} was invalid: {string.Join(", ", validationResults.Select(r => r.ErrorMessage))}", nameof(obj));
 		}
 
 		using var rawObjStream = new MemoryStream();
@@ -615,7 +617,7 @@ public static void SaveG1(string filename, G1Dat g1)
 	{
 		using (var fs = File.OpenWrite(filename))
 		{
-			WriteImageTable(fs, g1.GraphicsElements);
+			WriteImageTable(fs, g1.ImageTable.GraphicsElements);
 		}
 	}
 }

Dat/Loaders/AirportObjectLoader.cs

@@ -18,22 +18,22 @@ public static class Constants
 
 	internal static class StructSizes
 	{
-		public const int Dat = 0xBA;
 		public const int BuildingPartAnimation = 0x02;
 		public const int AirportBuilding = 0x04;
 		public const int MovementNode = 0x08;
 		public const int MovementEdge = 0x0C;
 	}
 
+	public static ObjectType ObjectType => ObjectType.Airport;
+	public static DatObjectType DatObjectType => DatObjectType.Airport;
+
 	public static LocoObject Load(Stream stream)
 	{
 		var initialStreamPosition = stream.Position;
 
 		using (var br = new LocoBinaryReader(stream))
 		{
 			var model = new AirportObject();
-			var stringTable = new StringTable();
-			var imageTable = new List<GraphicsElement>();
 
 			// fixed
 			br.SkipStringId(); // Name offset, not part of object definition
@@ -64,26 +64,29 @@ public static LocoObject Load(Stream stream)
 			model.var_B6 = br.ReadBytes(0xBA - 0xB6);
 
 			// sanity check
-			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + StructSizes.Dat, nameof(stream.Position));
+			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + ObjectAttributes.StructSize(DatObjectType), nameof(stream.Position));
 
 			// string table
-			stringTable = SawyerStreamReader.ReadStringTableStream(stream, ObjectAttributes.StringTable(DatObjectType.Airport), null);
+			var stringTable = SawyerStreamReader.ReadStringTableStream(stream, ObjectAttributes.StringTable(DatObjectType), null);
 
 			// variable
 			LoadVariable(br, model, numBuildingParts, numBuildingVariations, numMovementNodes, numMovementEdges);
 
 			// image table
-			imageTable = SawyerStreamReader.ReadImageTable(br).Table;
+			var imageList = SawyerStreamReader.ReadImageTable(br).Table;
+
+			// define groups
+			var imageTable = ImageTableGrouper.CreateImageTable(model, ObjectType, imageList);
 
-			return new LocoObject(ObjectType.Airport, model, stringTable, imageTable);
+			return new LocoObject(ObjectType, model, stringTable, imageTable);
 		}
 	}
 
 	private static void LoadVariable(LocoBinaryReader br, AirportObject model, int numBuildingParts, int numBuildingVariations, byte numMovementNodes, byte numMovementEdges)
 	{
-		model.BuildingHeights = br.ReadBuildingHeights(numBuildingParts);
-		model.BuildingAnimations = br.ReadBuildingAnimations(numBuildingParts);
-		model.BuildingVariations = br.ReadBuildingVariations(numBuildingVariations);
+		model.BuildingComponents.BuildingHeights = br.ReadBuildingHeights(numBuildingParts);
+		model.BuildingComponents.BuildingAnimations = br.ReadBuildingAnimations(numBuildingParts);
+		model.BuildingComponents.BuildingVariations = br.ReadBuildingVariations(numBuildingVariations);
 
 		// building positions
 		while (br.PeekByte() != LocoConstants.Terminator)
@@ -97,6 +100,7 @@ private static void LoadVariable(LocoBinaryReader br, AirportObject model, int n
 			};
 			model.BuildingPositions.Add(ab);
 		}
+
 		br.SkipTerminator();
 
 		// movement nodes
@@ -146,8 +150,8 @@ public static void Save(Stream stream, LocoObject obj)
 			bw.WriteEmptyImageId(); // Image, not part of object definition
 			bw.WriteEmptyImageId(); // Image offset, not part of object definition
 			bw.Write(model.AllowedPlaneTypes);
-			bw.Write((uint8_t)model.BuildingHeights.Count);
-			bw.Write((uint8_t)model.BuildingVariations.Count);
+			bw.Write((uint8_t)model.BuildingComponents.BuildingHeights.Count);
+			bw.Write((uint8_t)model.BuildingComponents.BuildingVariations.Count);
 			bw.WriteEmptyPointer(); // BuildingHeights
 			bw.WriteEmptyPointer(); // BuildingAnimations
 			bw.WriteEmptyPointer(Constants.BuildingVariationCount); // BuildingVariations
@@ -166,7 +170,7 @@ public static void Save(Stream stream, LocoObject obj)
 			bw.Write(model.var_B6);
 
 			// sanity check
-			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + StructSizes.Dat, nameof(stream.Position));
+			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + ObjectAttributes.StructSize(DatObjectType), nameof(stream.Position));
 
 			// string table
 			SawyerStreamWriter.WriteStringTable(stream, obj.StringTable);
@@ -175,15 +179,15 @@ public static void Save(Stream stream, LocoObject obj)
 			SaveVariable(bw, model);
 
 			// image table
-			SawyerStreamWriter.WriteImageTable(stream, obj.GraphicsElements);
+			SawyerStreamWriter.WriteImageTable(stream, obj.ImageTable.GraphicsElements);
 		}
 	}
 
 	private static void SaveVariable(LocoBinaryWriter bw, AirportObject model)
 	{
-		bw.Write(model.BuildingHeights);
-		bw.Write(model.BuildingAnimations);
-		bw.Write(model.BuildingVariations);
+		bw.Write(model.BuildingComponents.BuildingHeights);
+		bw.Write(model.BuildingComponents.BuildingAnimations);
+		bw.Write(model.BuildingComponents.BuildingVariations);
 
 		// positions
 		foreach (var x in model.BuildingPositions)
@@ -193,6 +197,7 @@ private static void SaveVariable(LocoBinaryWriter bw, AirportObject model)
 			bw.Write(x.X);
 			bw.Write(x.Y);
 		}
+
 		bw.WriteTerminator();
 
 		// movement nodes

Dat/Loaders/BridgeObjectLoader.cs

@@ -16,10 +16,8 @@ public static class Constants
 		public const int MaxNumRoadMods = 7;
 	}
 
-	public static class StructSizes
-	{
-		public const int Dat = 0x2C;
-	}
+	public static ObjectType ObjectType => ObjectType.Bridge;
+	public static DatObjectType DatObjectType => DatObjectType.Bridge;
 
 	public static LocoObject Load(Stream stream)
 	{
@@ -28,8 +26,6 @@ public static LocoObject Load(Stream stream)
 		using (var br = new LocoBinaryReader(stream))
 		{
 			var model = new BridgeObject();
-			var stringTable = new StringTable();
-			var imageTable = new List<GraphicsElement>();
 
 			// fixed
 			br.SkipStringId(); // Name offset, not part of object definition
@@ -54,19 +50,22 @@ public static LocoObject Load(Stream stream)
 			model.DesignedYear = br.ReadUInt16();
 
 			// sanity check
-			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + StructSizes.Dat, nameof(stream.Position));
+			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + ObjectAttributes.StructSize(DatObjectType), nameof(stream.Position));
 
 			// string table
-			stringTable = SawyerStreamReader.ReadStringTableStream(stream, ObjectAttributes.StringTable(DatObjectType.Bridge), null);
+			var stringTable = SawyerStreamReader.ReadStringTableStream(stream, ObjectAttributes.StringTable(DatObjectType), null);
 
 			// variable
 			model.CompatibleTrackObjects = br.ReadS5HeaderList(compatibleTrackCount);
 			model.CompatibleRoadObjects = br.ReadS5HeaderList(compatibleRoadCount);
 
 			// image table
-			imageTable = SawyerStreamReader.ReadImageTable(br).Table;
+			var imageList = SawyerStreamReader.ReadImageTable(br).Table;
 
-			return new LocoObject(ObjectType.Bridge, model, stringTable, imageTable);
+			// define groups
+			var imageTable = ImageTableGrouper.CreateImageTable(model, ObjectType, imageList);
+
+			return new LocoObject(ObjectType, model, stringTable, imageTable);
 		}
 	}
 
@@ -99,7 +98,7 @@ public static void Save(Stream stream, LocoObject obj)
 			bw.Write(model.DesignedYear);
 
 			// sanity check
-			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + StructSizes.Dat, nameof(stream.Position));
+			ArgumentOutOfRangeException.ThrowIfNotEqual(stream.Position, initialStreamPosition + ObjectAttributes.StructSize(DatObjectType), nameof(stream.Position));
 
 			// string table
 			SawyerStreamWriter.WriteStringTable(stream, obj.StringTable);
@@ -109,7 +108,7 @@ public static void Save(Stream stream, LocoObject obj)
 			bw.WriteS5HeaderList(model.CompatibleRoadObjects);
 
 			// image table
-			SawyerStreamWriter.WriteImageTable(stream, obj.GraphicsElements);
+			SawyerStreamWriter.WriteImageTable(stream, obj.ImageTable.GraphicsElements);
 		}
 	}
 
@@ -150,7 +149,6 @@ internal enum DatBridgeObjectFlags : uint8_t
 		None = 0,
 		HasRoof = 1 << 0,
 	}
-
 }
 
 static class BridgeFlagsConverter