Selected log entry is preserved after filtering the logs if the entry is in the list of filtered logs (closed #91)

Author: yasirkula

Plugins/IngameDebugConsole/README.txt

@@ -1,4 +1,4 @@
-= In-game Debug Console (v1.6.9) =
+= In-game Debug Console (v1.7.0) =
 
 Documentation: https://github.com/yasirkula/UnityIngameDebugConsole
 FAQ: https://github.com/yasirkula/UnityIngameDebugConsole#faq

Plugins/IngameDebugConsole/Scripts/DebugLogManager.cs

@@ -1442,7 +1442,6 @@ private void CollapseButtonPressed()
 			// Swap the value of collapse mode
 			isCollapseOn = !isCollapseOn;
 
-			SnapToBottom = true;
 			collapseButton.color = isCollapseOn ? collapseButtonSelectedColor : collapseButtonNormalColor;
 			recycledListView.SetCollapseMode( isCollapseOn );
 
@@ -1684,6 +1683,7 @@ internal void Resize( PointerEventData eventData )
 		// Determine the filtered list of debug entries to show on screen
 		private void FilterLogs()
 		{
+			recycledListView.OnBeforeFilterLogs();
 			logEntriesToShow.Clear();
 
 			if( timestampsOfLogEntriesToShow != null )
@@ -1757,7 +1757,7 @@ private void FilterLogs()
 			}
 
 			// Update the recycled list view
-			recycledListView.DeselectSelectedLogItem();
+			recycledListView.OnAfterFilterLogs();
 			OnLogEntriesUpdated( true, true );
 		}
 

Plugins/IngameDebugConsole/Scripts/DebugLogRecycledListView.cs

@@ -36,6 +36,10 @@ public class DebugLogRecycledListView : MonoBehaviour
 		private float heightOfSelectedLogEntry;
 		private float DeltaHeightOfSelectedLogEntry { get { return heightOfSelectedLogEntry - logItemHeight; } }
 
+		/// These properties are used by <see cref="OnBeforeFilterLogs"/> and <see cref="OnAfterFilterLogs"/>.
+		private int collapsedOrderOfSelectedLogEntry;
+		private float scrollDistanceToSelectedLogEntry;
+
 		// Log items used to visualize the visible debug entries
 		private readonly DynamicCircularBuffer<DebugLogItem> visibleLogItems = new DynamicCircularBuffer<DebugLogItem>( 32 );
 
@@ -128,6 +132,57 @@ public void DeselectSelectedLogItem()
 			heightOfSelectedLogEntry = 0f;
 		}
 
+		/// <summary>
+		/// Cache the currently selected log item's properties so that its position can be restored after <see cref="OnAfterFilterLogs"/> is called.
+		/// </summary>
+		public void OnBeforeFilterLogs()
+		{
+			collapsedOrderOfSelectedLogEntry = 0;
+			scrollDistanceToSelectedLogEntry = 0f;
+
+			if( selectedLogEntry != null )
+			{
+				if( !isCollapseOn )
+				{
+					for( int i = 0; i < indexOfSelectedLogEntry; i++ )
+					{
+						if( entriesToShow[i] == selectedLogEntry )
+							collapsedOrderOfSelectedLogEntry++;
+					}
+				}
+
+				scrollDistanceToSelectedLogEntry = indexOfSelectedLogEntry * ItemHeight - transformComponent.anchoredPosition.y;
+			}
+		}
+
+		/// <summary>
+		/// See <see cref="OnBeforeFilterLogs"/>.
+		/// </summary>
+		public void OnAfterFilterLogs()
+		{
+			// Refresh selected log entry's index
+			int newIndexOfSelectedLogEntry = -1;
+			if( selectedLogEntry != null )
+			{
+				for( int i = 0; i < entriesToShow.Count; i++ )
+				{
+					if( entriesToShow[i] == selectedLogEntry && collapsedOrderOfSelectedLogEntry-- == 0 )
+					{
+						newIndexOfSelectedLogEntry = i;
+						break;
+					}
+				}
+			}
+
+			if( newIndexOfSelectedLogEntry < 0 )
+				DeselectSelectedLogItem();
+			else
+			{
+				indexOfSelectedLogEntry = newIndexOfSelectedLogEntry;
+				transformComponent.anchoredPosition = new Vector2( 0f, newIndexOfSelectedLogEntry * ItemHeight - scrollDistanceToSelectedLogEntry );
+			}
+		}
+
 		// Number of debug entries may have changed, update the list
 		public void OnLogEntriesUpdated( bool updateAllVisibleItemContents )
 		{

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.yasirkula.ingamedebugconsole",
   "displayName": "In-game Debug Console",
-  "version": "1.6.9",
+  "version": "1.7.0",
   "documentationUrl": "https://github.com/yasirkula/UnityIngameDebugConsole",
   "changelogUrl": "https://github.com/yasirkula/UnityIngameDebugConsole/releases",
   "licensesUrl": "https://github.com/yasirkula/UnityIngameDebugConsole/blob/master/LICENSE.txt",