New spawn selector tooltip for C&C.

OpenRA.Game/Widgets/MapPreviewWidget.cs

@@ -15,27 +15,39 @@ using System.Linq;
 using System.Threading;
 using OpenRA.FileFormats;
 using OpenRA.Graphics;
+using OpenRA.Network;
 
 namespace OpenRA.Widgets
 {
 	public class MapPreviewWidget : Widget
 	{
 		public Func<Map> Map = () => null;
-		public Func<Dictionary<int2, Color>> SpawnColors = () => new Dictionary<int2, Color>();
+		public Func<Dictionary<int2, Session.Client>> SpawnClients = () => new Dictionary<int2, Session.Client>();
 		public Action<MouseInput> OnMouseDown = _ => {};
 		public Action<int, int2> OnTooltip = (_, __) => { };
 		public bool IgnoreMouseInput = false;
 		public bool ShowSpawnPoints = true;
 
-		public MapPreviewWidget() : base() { }
+		public readonly string TooltipContainer;
+		public readonly string TooltipTemplate = "SPAWN_TOOLTIP";
+		Lazy<TooltipContainerWidget> tooltipContainer;
+		public int TooltipSpawnIndex = -1;
+
+		public MapPreviewWidget() : base()
+		{
+			tooltipContainer = Lazy.New(() => Ui.Root.Get<TooltipContainerWidget>(TooltipContainer));
+		}
 
 		protected MapPreviewWidget(MapPreviewWidget other)
 			: base(other)
 		{
 			lastMap = other.lastMap;
 			Map = other.Map;
-			SpawnColors = other.SpawnColors;
+			SpawnClients = other.SpawnClients;
 			ShowSpawnPoints = other.ShowSpawnPoints;
+			TooltipTemplate = other.TooltipTemplate;
+			TooltipContainer = other.TooltipContainer;
+			tooltipContainer = Lazy.New(() => Ui.Root.Get<TooltipContainerWidget>(TooltipContainer));
 		}
 
 		public override Widget Clone() { return new MapPreviewWidget(this); }
@@ -52,6 +64,18 @@ namespace OpenRA.Widgets
 			return true;
 		}
 
+		public override void MouseEntered()
+		{
+			if (TooltipContainer == null) return;
+			tooltipContainer.Value.SetTooltip(TooltipTemplate, new WidgetArgs() {{ "preview", this }});
+		}
+
+		public override void MouseExited()
+		{
+			if (TooltipContainer == null) return;
+			tooltipContainer.Value.RemoveTooltip();
+		}
+
 		public int2 ConvertToPreview(int2 point)
 		{
 			var map = Map();
@@ -104,9 +128,10 @@ namespace OpenRA.Widgets
 				new float2(MapRect.Location),
 				new float2(MapRect.Size));
 
+			TooltipSpawnIndex = -1;
 			if (ShowSpawnPoints)
 			{
-				var colors = SpawnColors();
+				var colors = SpawnClients().ToDictionary(c => c.Key, c => c.Value.ColorRamp.GetColor(0));
 
 				var spawnPoints = map.GetSpawnPoints().ToList();
 				foreach (var p in spawnPoints)
@@ -123,7 +148,11 @@ namespace OpenRA.Widgets
 
 					if ((pos - Viewport.LastMousePos).LengthSquared < 64)
 					{
-						OnTooltip(spawnPoints.IndexOf(p) + 1, pos);
+						TooltipSpawnIndex = spawnPoints.IndexOf(p) + 1;
+
+						// Legacy tooltip behavior
+						if (TooltipContainer == null)
+							OnTooltip(TooltipSpawnIndex, pos);
 					}
 				}
 			}

OpenRA.Game/Widgets/TooltipContainerWidget.cs

@@ -0,0 +1,67 @@
+#region Copyright & License Information
+/*
+ * Copyright 2007-2011 The OpenRA Developers (see AUTHORS)
+ * This file is part of OpenRA, which is free software. It is made
+ * available to you under the terms of the GNU General Public License
+ * as published by the Free Software Foundation. For more information,
+ * see COPYING.
+ */
+#endregion
+
+using System.Collections.Generic;
+using System.Drawing;
+using System.Linq;
+using OpenRA.FileFormats;
+using OpenRA.Graphics;
+using OpenRA.Widgets;
+using System;
+
+namespace OpenRA.Widgets
+{
+	public class TooltipContainerWidget : Widget
+	{
+		static readonly Action Nothing = () => {};
+		public int2 CursorOffset = new int2(0, 20);
+		public Action BeforeRender = Nothing;
+		public int TooltipDelay = 2;
+		Widget tooltip;
+
+		public TooltipContainerWidget()
+		{
+			IsVisible = () => Viewport.TicksSinceLastMove >= TooltipDelay;
+		}
+
+		public void SetTooltip(string id, WidgetArgs args)
+		{
+			RemoveTooltip();
+			tooltip = Ui.LoadWidget(id, this, new WidgetArgs(args) {{ "tooltipContainer", this }});
+		}
+
+		public void RemoveTooltip()
+		{
+			RemoveChildren();
+			BeforeRender = Nothing;
+		}
+
+		public override void Draw() { BeforeRender(); }
+
+		public override Rectangle GetEventBounds() { return Rectangle.Empty; }
+
+		public override int2 ChildOrigin
+		{
+			get
+			{
+				var pos = Viewport.LastMousePos + CursorOffset;
+				if (tooltip != null)
+				{
+					if (pos.X + tooltip.Bounds.Right > Game.viewport.Width)
+						pos.X = Game.viewport.Width - tooltip.Bounds.Right;
+				}
+
+				return pos;
+			}
+		}
+
+		public override string GetCursor(int2 pos) { return null; }
+	}
+}