Make IVirtualGridView implement IDisposable

Delsin-Yu · Oct 14, 2024 · 8615d14 · 8615d14
1 parent 174f8d0
commit 8615d14
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/GDViews.VirtualGridView/Core/IVirtualGridView.cs b/GDViews.VirtualGridView/Core/IVirtualGridView.cs
@@ -10,7 +10,7 @@ namespace GodotViews.VirtualGrid;
 /// to navigate through and customise the virtualized grid view.   
 /// </summary>
 /// <typeparam name="TDataType">The type for the data this controller focuses on.</typeparam>
-public interface IVirtualGridView<TDataType>
+public interface IVirtualGridView<TDataType> : IDisposable
 {
     /// <summary>
     /// Accessor for the currently active ElementPositioner,

diff --git a/GDViews.VirtualGridView/Core/VirtualGridViewImpl.cs b/GDViews.VirtualGridView/Core/VirtualGridViewImpl.cs
@@ -1183,4 +1183,10 @@ private class DataView
         public NullableData<TDataType> Data;
         public override string ToString() => $"Button: {AssignedButton?.Name ?? "Null"}, Data: {Data}";
     }
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        while (_buttonPool.TryPop(out var instance)) instance.QueueFree();       
+    }
 }
diff --git a/GDViews.VirtualGridView/GDViews.VirtualGridView.csproj b/GDViews.VirtualGridView/GDViews.VirtualGridView.csproj
@@ -14,15 +14,15 @@
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
         <PackageId>GDViews.VirtualGridView</PackageId>
-        <PackageVersion>0.0.2</PackageVersion>
+        <PackageVersion>0.0.3</PackageVersion>
         <Authors>DE-YU</Authors>
         <Description>Based on DotNet, GDViews.VirtualGridView provides classes that are useful for creating highly customizable virtualized grid views.</Description>
         <PackageProjectUrl>https://www.nuget.org/packages/GDViews.VirtualGridView</PackageProjectUrl>
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <RepositoryUrl>https://github.com/Delsin-Yu/GDViews.VirtualGridView</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <PackageTags>Godot TabView</PackageTags>
-        <PackageReleaseNotes>Fix Mouse Wheel Scroll Event doubles, and fix scroll Bar is not accurately reflecting the virtual viewport position.</PackageReleaseNotes>
+        <PackageReleaseNotes>Make IVirtualGridView implement IDisposable, which allows for cleaning cached button instances that are out of the scene tree.</PackageReleaseNotes>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
 
         <IncludeSymbols>true</IncludeSymbols>