Make it possible to pin TileSets to the top of the TileSet list

Author: Rampastring

src/TSMapEditor/Content/star.png

@@ -458,6 +458,9 @@
     <None Update="Content\SpriteFont1.xnb">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="Content\star.png">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="Content\tileborder.png">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

src/TSMapEditor/TSMapEditor.csproj

@@ -0,0 +1,42 @@
+using Microsoft.Xna.Framework;
+using Microsoft.Xna.Framework.Graphics;
+using Rampastring.XNAUI;
+using Rampastring.XNAUI.XNAControls;
+using TSMapEditor.CCEngine;
+
+namespace TSMapEditor.UI.Controls
+{
+    public class TileSetListBox : XNAListBox
+    {
+        public TileSetListBox(WindowManager windowManager, int tileSetCount) : base(windowManager)
+        {
+            tileSetIsFavourite = new bool[tileSetCount];
+            favouriteTileSetTexture = AssetLoader.LoadTexture("star.png");
+        }
+
+        private readonly bool[] tileSetIsFavourite;
+
+        private Texture2D favouriteTileSetTexture;
+
+        public bool IsTileSetFavourite(int tileSetIndex) => tileSetIsFavourite[tileSetIndex];
+
+        public void SetTileSetAsFavourite(int tileSetIndex) => tileSetIsFavourite[tileSetIndex] = true;
+
+        public void ClearFavouriteStatus(int tileSetIndex) => tileSetIsFavourite[tileSetIndex] = false;
+
+        protected override void DrawListBoxItem(int index, int y)
+        {
+            base.DrawListBoxItem(index, y);
+            var tileSet = (TileSet)Items[index].Tag;
+
+            if (!IsTileSetFavourite(tileSet.Index))
+                return;
+
+            int lineWidth = Width - 2 - (EnableScrollbar && ScrollBar.IsDrawn() ? ScrollBar.Width : 0);
+
+            int textureYOffset = (LineHeight - favouriteTileSetTexture.Height) / 2;
+
+            DrawTexture(favouriteTileSetTexture, new Point(lineWidth - 1 - favouriteTileSetTexture.Width, y + textureYOffset), Color.White);
+        }
+    }
+}

src/TSMapEditor/UI/Controls/TileSetListBox.cs

@@ -54,7 +54,8 @@ protected override void OnClientRectangleUpdated()
 
         private SortButton btnSort;
         private EditorSuggestionTextBox tbSearch;
-        private XNAListBox lbTileSetList;
+        private TileSetListBox lbTileSetList;
+        private XNAContextMenu tileSetContextMenu;
 
         private TileSetSortMode _tileSetSortMode;
         private TileSetSortMode TileSetSortMode
@@ -87,11 +88,12 @@ public override void Initialize()
             UIHelpers.AddSearchTipsBoxToControl(tbSearch);
             tbSearch.TextChanged += TbSearch_TextChanged;
 
-            lbTileSetList = new XNAListBox(WindowManager);
+            lbTileSetList = new TileSetListBox(WindowManager, theaterGraphics.Theater.TileSets.Count);
             lbTileSetList.Name = nameof(lbTileSetList);
             lbTileSetList.Y = tbSearch.Bottom;
             lbTileSetList.Height = Height - tbSearch.Bottom;
             lbTileSetList.Width = TileSetListWidth;
+            lbTileSetList.AllowRightClickUnselect = false;
             lbTileSetList.SelectedIndexChanged += LbTileSetList_SelectedIndexChanged;
             AddChild(lbTileSetList);
 
@@ -114,6 +116,22 @@ public override void Initialize()
 
             btnSort.LeftClick += (s, e) => sortContextMenu.Open(GetCursorPoint());
 
+            tileSetContextMenu = new EditorContextMenu(WindowManager);
+            tileSetContextMenu.Name = nameof(tileSetContextMenu);
+            tileSetContextMenu.Width = 200;
+            tileSetContextMenu.AddItem("Pin",
+                () => { lbTileSetList.SetTileSetAsFavourite(((TileSet)lbTileSetList.SelectedItem.Tag).Index); RefreshTileSets(); },
+                null,
+                () => lbTileSetList.SelectedItem != null && !lbTileSetList.IsTileSetFavourite(((TileSet)lbTileSetList.SelectedItem.Tag).Index));
+            tileSetContextMenu.AddItem("Unpin",
+                () => { lbTileSetList.ClearFavouriteStatus(((TileSet)lbTileSetList.SelectedItem.Tag).Index); RefreshTileSets(); },
+                null,
+                () => lbTileSetList.SelectedItem != null && lbTileSetList.IsTileSetFavourite(((TileSet)lbTileSetList.SelectedItem.Tag).Index));
+            tileSetContextMenu.AddItem("Unselect", () => lbTileSetList.SelectedIndex = -1);
+            AddChild(tileSetContextMenu);
+
+            lbTileSetList.RightClick += LbTileSetList_RightClick;
+
             base.Initialize();
 
             RefreshTileSets();
@@ -123,6 +141,14 @@ public override void Initialize()
             WindowManager.RenderResolutionChanged += WindowManager_RenderResolutionChanged;
         }
 
+        private void LbTileSetList_RightClick(object sender, EventArgs e)
+        {
+            lbTileSetList.SelectedIndex = lbTileSetList.HoveredIndex;
+
+            if (lbTileSetList.SelectedItem != null)
+                tileSetContextMenu.Open(GetCursorPoint());
+        }
+
         private void WindowManager_RenderResolutionChanged(object sender, EventArgs e)
         {
             Width = WindowManager.RenderResolutionX - X;
@@ -261,14 +287,15 @@ private void LbTileSetList_SelectedIndexChanged(object sender, EventArgs e)
         private void RefreshTileSets()
         {
             lbTileSetList.Clear();
-            IEnumerable<TileSet> sortedTileSets = theaterGraphics.Theater.TileSets; // TODO sort tilesets
+            IOrderedEnumerable<TileSet> sortedTileSets = theaterGraphics.Theater.TileSets.OrderBy(ts => !lbTileSetList.IsTileSetFavourite(ts.Index));
 
             switch (TileSetSortMode)
             {
                 case TileSetSortMode.ID:
+                    sortedTileSets = sortedTileSets.ThenBy(ts => ts.Index);
                     break;
                 case TileSetSortMode.Name:
-                    sortedTileSets = sortedTileSets.OrderBy(ts => ts.SetName);
+                    sortedTileSets = sortedTileSets.ThenBy(ts => ts.SetName);
                     break;
             }