Improve image viewer (#202)

* rework imagetableviewmodel, create imageviewmodel

* imageviewmodel now working

* image model improvements

Author: LeftofZen

Definitions/ObjectModels/Types/GraphicsElement.cs

@@ -13,7 +13,7 @@ public enum GraphicsElementFlags : uint16_t
 	DuplicatePrevious = 1 << 6, // Duplicates the previous element but with adjusted x/y offsets
 }
 
-public class GraphicsElement // follows G1Element32
+public class GraphicsElement // follows G1Element32, except XOffset and YOffset = are inverted - in loco they're negative but here they're positive
 {
 	public short Width { get; set; }
 	public short Height { get; set; }

Gui/App.axaml

@@ -6,7 +6,7 @@
 	xmlns:vm="using:Gui.ViewModels"
 	xmlns:vi="using:Gui.Views"
 	xmlns:oldt="using:Dat.Types"
-	xmlns:pgc="clr-namespace:Avalonia.PropertyGrid.Controls;assembly=Avalonia.PropertyGrid"
+	xmlns:pgc="clr-namespace:Avalonia.PropertyGrid.Controls;assembly=Avalonia.PropertyGrid"		
 	x:Class="Gui.App"
 	RequestedThemeVariant="Default">
 	<!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->
@@ -28,6 +28,9 @@
 		<DataTemplate DataType="vm:SCV5ViewModel">
 			<vi:SCV5View />
 		</DataTemplate>
+		<DataTemplate DataType="vm:ImageViewModel">
+			<vi:ImageView />
+		</DataTemplate>
 		<DataTemplate DataType="vm:ImageTableViewModel">
 			<vi:ImageTableView />
 		</DataTemplate>
@@ -40,9 +43,6 @@
 		<DataTemplate DataType="vm:FolderTreeViewModel">
 			<vi:FolderTreeView />
 		</DataTemplate>
-		<DataTemplate DataType="vm:UIG1Element32">
-			<pgc:PropertyGrid DataContext="{Binding}" IsCategoryVisible="False"></pgc:PropertyGrid>
-		</DataTemplate>
 	</Application.DataTemplates>
 
 	<Application.Styles>

Gui/EditorSettings.cs

@@ -13,22 +13,21 @@ public class EditorSettings
 {
 	public string ObjDataDirectory
 	{
-		get => objectDirectory;
+		get;
 		set
 		{
-			objectDirectory = value;
+			field = value;
 			ObjDataDirectories ??= [];
-			_ = ObjDataDirectories.Add(objectDirectory);
+			_ = ObjDataDirectories.Add(field);
 		}
 	}
-	string objectDirectory;
 
 	public HashSet<string> ObjDataDirectories
 	{
-		get => objDataDirectories ??= [];
-		set => objDataDirectories = value;
-	}
-	HashSet<string> objDataDirectories = [];
+		get => field ??= [];
+		set;
+	} = [];
+
 	public bool AllowSavingAsVanillaObject { get; set; }
 	public bool AutoObjectDiscoveryAndUpload { get; set; }
 

Gui/Models/Converters/EnumDescriptionConverter.cs

@@ -10,7 +10,7 @@ public class EnumDescriptionConverter : MarkupExtension, IValueConverter
 	public override object ProvideValue(IServiceProvider serviceProvider)
 		=> this;
 
-	public object? Convert(object? value, Type targetType, object parameter, CultureInfo culture)
+	public object? Convert(object? value, Type targetType, object? parameter, CultureInfo culture)
 	{
 		var type = value?.GetType();
 		var text = value?.ToString();

Gui/Models/Converters/EnumToBooleanConverter.cs

@@ -6,7 +6,7 @@ namespace Gui.Models.Converters;
 
 public class EnumToBooleanConverter : IValueConverter
 {
-	public object? Convert(object? value, Type targetType, object parameter, CultureInfo culture)
+	public object? Convert(object? value, Type targetType, object? parameter, CultureInfo culture)
 	{
 		if (value is Enum enumValue && parameter is Enum enumParameter)
 		{
@@ -16,7 +16,7 @@ public class EnumToBooleanConverter : IValueConverter
 		return false;
 	}
 
-	public object? ConvertBack(object? value, Type targetType, object parameter, CultureInfo culture)
+	public object? ConvertBack(object? value, Type targetType, object? parameter, CultureInfo culture)
 	{
 		if (value is bool boolValue && boolValue && parameter is Enum enumParameter)
 		{

Gui/Models/Converters/NegativeValueConverter.cs

@@ -0,0 +1,40 @@
+using Avalonia.Data.Converters;
+using System;
+
+namespace Gui.Models.Converters;
+
+public class NegativeValueConverter : IValueConverter
+{
+	public object Convert(object? value, Type targetType, object? parameter, System.Globalization.CultureInfo culture)
+	{
+		if (value is int intValue)
+		{
+			return -intValue;
+		}
+		else if (value is uint uintValue)
+		{
+			return -uintValue;
+		}
+		else if (value is short shortValue)
+		{
+			return -shortValue;
+		}
+		else if (value is ushort ushortValue)
+		{
+			return -ushortValue;
+		}
+		else if (value is sbyte byteValue)
+		{
+			return -byteValue;
+		}
+		else if (value is byte sbyteValue)
+		{
+			return -sbyteValue;
+		}
+
+		return Avalonia.Data.BindingNotification.UnsetValue;
+	}
+
+	public object ConvertBack(object? value, Type targetType, object? parameter, System.Globalization.CultureInfo culture)
+		=> Convert(value, targetType, parameter, culture);
+}

Gui/PlatformSpecific.cs

@@ -59,7 +59,7 @@ static void FolderOpenInDesktopCore(string directory, string? filename = null)
 	{
 		if (!Directory.Exists(directory))
 		{
-			throw new ArgumentException("The specified folder does not exist.", nameof(directory));
+			throw new ArgumentException("The specified folder does not exist. Folder=\"{directory}\"", nameof(directory));
 		}
 
 		// Platform-specific command construction

Gui/ViewModels/SubObjectTypes/ImageTableViewModel.cs

@@ -1,5 +1,5 @@
+using Avalonia.Controls.PanAndZoom;
 using Avalonia.Controls.Selection;
-using Avalonia.Media.Imaging;
 using Avalonia.Threading;
 using Definitions.ObjectModels;
 using DynamicData;
@@ -30,20 +30,6 @@ public class ImageTableViewModel : ReactiveObject, IExtraContentViewModel
 	[Reactive]
 	public ColourRemapSwatch SelectedSecondarySwatch { get; set; } = ColourRemapSwatch.SecondaryRemap;
 
-	readonly DispatcherTimer animationTimer;
-	int currentFrameIndex;
-
-	public IList<Bitmap> SelectedBitmaps { get; set; }
-
-	[Reactive] public Bitmap SelectedBitmapPreview { get; set; }
-	public Avalonia.Size SelectedBitmapPreviewBorder
-		=> SelectedBitmapPreview == null
-			? new Avalonia.Size()
-			: new Avalonia.Size(SelectedBitmapPreview.Size.Width + 2, SelectedBitmapPreview.Size.Height + 2);
-
-	[Reactive]
-	public int AnimationSpeed { get; set; } = 40;
-
 	[Reactive]
 	public ICommand ReplaceImageCommand { get; set; }
 
@@ -56,29 +42,33 @@ public Avalonia.Size SelectedBitmapPreviewBorder
 	[Reactive]
 	public ICommand CropAllImagesCommand { get; set; }
 
+	[Reactive]
+	public ICommand ZeroOffsetAllImagesCommand { get; set; }
+
+	[Reactive]
+	public ICommand CenterOffsetAllImagesCommand { get; set; }
+
 	// what is displaying on the ui
 	[Reactive]
-	public ObservableCollection<Bitmap?> Bitmaps { get; set; }
+	public ObservableCollection<ImageViewModel> ImageViewModels { get; set; } = [];
 
 	[Reactive]
 	public int SelectedImageIndex { get; set; } = -1;
 
 	[Reactive]
-	public SelectionModel<Bitmap> SelectionModel { get; set; }
-
-	public UIG1Element32? SelectedG1Element
-		=> SelectedImageIndex == -1 || Model.G1Provider.GraphicsElements.Count == 0 || SelectedImageIndex >= Model.G1Provider.GraphicsElements.Count
-		? null
-		: new UIG1Element32(SelectedImageIndex, Model.GetImageName(SelectedImageIndex), Model.G1Provider.GraphicsElements[SelectedImageIndex]);
-
-	public Avalonia.Point SelectedG1ElementOffset
-		=> SelectedG1Element == null
-			? new Avalonia.Point()
-			: new Avalonia.Point(-SelectedG1Element?.XOffset ?? 0, -SelectedG1Element?.YOffset ?? 0);
-	public Avalonia.Size SelectedG1ElementSize
-		=> SelectedG1Element == null
-			? new Avalonia.Size()
-			: new Avalonia.Size(SelectedG1Element?.Width ?? 0, SelectedG1Element?.Height ?? 0);
+	public SelectionModel<ImageViewModel> SelectionModel { get; set; }
+
+	[Reactive]
+	public ImageViewModel? SelectedImage { get; set; }
+
+	readonly DispatcherTimer animationTimer;
+	int currentFrameIndex;
+
+	[Reactive]
+	public IList<ImageViewModel> SelectedBitmaps { get; set; }
+
+	[Reactive]
+	public int AnimationSpeed { get; set; } = 40;
 
 	ImageTableModel Model { get; init; }
 
@@ -95,17 +85,12 @@ public ImageTableViewModel(ImageTableModel model)
 			.Subscribe(_ => UpdateBitmaps());
 
 		_ = this.WhenAnyValue(o => o.SelectedImageIndex)
-			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedG1Element))); // disabling this line stops mem leak
-		_ = this.WhenAnyValue(o => o.SelectedG1Element)
-			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedG1ElementOffset)));
-		_ = this.WhenAnyValue(o => o.SelectedG1Element)
-			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedG1ElementSize)));
-		_ = this.WhenAnyValue(o => o.SelectedG1Element)
-			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedBitmapPreview)));
-		_ = this.WhenAnyValue(o => o.SelectedBitmapPreview)
-			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedBitmapPreviewBorder)));
+			.Where(index => index >= 0 && index < ImageViewModels?.Count)
+			.Subscribe(_ => SelectedImage = ImageViewModels[SelectedImageIndex]);
+
 		_ = this.WhenAnyValue(o => o.AnimationSpeed)
-			.Subscribe(_ => UpdateAnimationSpeed());
+			.Where(_ => animationTimer != null)
+			.Subscribe(_ => animationTimer!.Interval = TimeSpan.FromMilliseconds(1000 / AnimationSpeed));
 
 		ImportImagesCommand = ReactiveCommand.CreateFromTask(ImportImages);
 		ExportImagesCommand = ReactiveCommand.CreateFromTask(ExportImages);
@@ -116,6 +101,24 @@ public ImageTableViewModel(ImageTableModel model)
 			UpdateBitmaps();
 		});
 
+		ZeroOffsetAllImagesCommand = ReactiveCommand.Create(() =>
+		{
+			foreach (var ivm in ImageViewModels)
+			{
+				ivm.XOffset = 0;
+				ivm.YOffset = 0;
+			}
+		});
+
+		CenterOffsetAllImagesCommand = ReactiveCommand.Create(() =>
+		{
+			foreach (var ivm in ImageViewModels)
+			{
+				ivm.XOffset = (short)(-ivm.Width / 2);
+				ivm.YOffset = (short)(-ivm.Height / 2);
+			}
+		});
+
 		UpdateBitmaps();
 
 		// Set up the animation timer
@@ -129,7 +132,7 @@ public ImageTableViewModel(ImageTableModel model)
 
 	void SelectionChanged(object sender, SelectionModelSelectionChangedEventArgs e)
 	{
-		var sm = (SelectionModel<Bitmap>)sender;
+		var sm = (SelectionModel<ImageViewModel>)sender;
 
 		if (sm.SelectedIndexes.Count > 0)
 		{
@@ -142,17 +145,7 @@ void SelectionChanged(object sender, SelectionModelSelectionChangedEventArgs e)
 		}
 
 		// ... handle selection changed
-		SelectedBitmaps = [.. sm.SelectedItems.Cast<Bitmap>()];
-	}
-
-	void UpdateAnimationSpeed()
-	{
-		if (animationTimer == null)
-		{
-			return;
-		}
-
-		animationTimer.Interval = TimeSpan.FromMilliseconds(1000 / AnimationSpeed);
+		SelectedBitmaps = [.. sm.SelectedItems.Cast<ImageViewModel>()];
 	}
 
 	void AnimationTimer_Tick(object? sender, EventArgs e)
@@ -167,8 +160,7 @@ void AnimationTimer_Tick(object? sender, EventArgs e)
 			currentFrameIndex = 0;
 		}
 
-		// Update the displayed image
-		SelectedBitmapPreview = SelectedBitmaps[currentFrameIndex];
+		// Update the displayed image viewmodel
 		SelectedImageIndex = SelectionModel.SelectedIndexes[currentFrameIndex]; // disabling this also makes the memory leaks stop
 
 		// Move to the next frame, looping back to the beginning if necessary
@@ -177,7 +169,7 @@ void AnimationTimer_Tick(object? sender, EventArgs e)
 
 	void CreateSelectionModel()
 	{
-		SelectionModel = new SelectionModel<Bitmap>
+		SelectionModel = new SelectionModel<ImageViewModel>
 		{
 			SingleSelect = false
 		};
@@ -213,7 +205,15 @@ public async Task ImportImages()
 	public void UpdateBitmaps()
 	{
 		Model.RecalcImages(SelectedPrimarySwatch, SelectedSecondarySwatch);
-		Bitmaps = [.. G1ImageConversion.CreateAvaloniaImages(Model.Images)];
+		var newImages = G1ImageConversion.CreateAvaloniaImages(Model.Images);
+
+		ImageViewModels.Clear();
+		var i = 0;
+		foreach (var image in newImages)
+		{
+			ImageViewModels.Add(new ImageViewModel(i, Model.GetImageName(i), Model.G1Provider.GraphicsElements[i], image));
+			i++;
+		}
 	}
 
 	public async Task ExportImages()

Gui/ViewModels/SubObjectTypes/ImageViewModel.cs

@@ -0,0 +1,50 @@
+using Avalonia.Media.Imaging;
+using Definitions.ObjectModels.Types;
+using ReactiveUI;
+using ReactiveUI.Fody.Helpers;
+using System.ComponentModel;
+using System;
+
+namespace Gui.ViewModels;
+
+public class ImageViewModel : ReactiveObject
+{
+	[ReadOnly(true)] public int ImageIndex { get; init; }
+	[ReadOnly(true)] public string ImageName { get; init; }
+	[ReadOnly(true)] public short Width { get; init; }
+	[ReadOnly(true)] public short Height { get; init; }
+
+	[Reactive] public short XOffset { get; set; }
+	[Reactive] public short YOffset { get; set; }
+
+	public GraphicsElementFlags Flags { get; set; }
+	public short ZoomOffset { get; set; }
+
+	[Reactive, Browsable(false)]
+	public Bitmap Image { get; set; }
+
+	[Browsable(false)]
+	public Avalonia.Size SelectedBitmapPreviewBorder
+		=> Image == null
+			? new Avalonia.Size()
+			: new Avalonia.Size(Image.Size.Width + 2, Image.Size.Height + 2);
+
+	ImageViewModel() { }
+
+	public ImageViewModel(int imageIndex, string imageName, GraphicsElement graphicsElement, Bitmap image)
+		: this()
+	{
+		ImageIndex = imageIndex;
+		ImageName = imageName;
+		Width = graphicsElement.Width;
+		Height = graphicsElement.Height;
+		XOffset = graphicsElement.XOffset;
+		YOffset = graphicsElement.YOffset;
+		Flags = graphicsElement.Flags;
+		ZoomOffset = graphicsElement.ZoomOffset;
+		Image = image;
+
+		_ = this.WhenAnyValue(o => o.Image)
+			.Subscribe(_ => this.RaisePropertyChanged(nameof(SelectedBitmapPreviewBorder)));
+	}
+}