Add TruncateLabelWithTooltip helper function
* Move GetContrastColor helper to SpriteFont * Move WidgetUtils from OpenRA.Game.Widgets to OpenRA.Mods.Common.Widgets
This commit is contained in:
Ivaylo Draganov
committed by
abcdefg30
abcdefg30
parent
79d1899426
commit
1fee50be2e
319
OpenRA.Mods.Common/Widgets/WidgetUtils.cs
Normal file
319
OpenRA.Mods.Common/Widgets/WidgetUtils.cs
Normal file
@@ -0,0 +1,319 @@
|
||||
#region Copyright & License Information
|
||||
/*
|
||||
* Copyright 2007-2019 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, either version 3 of
|
||||
* the License, or (at your option) any later version. For more
|
||||
* information, see COPYING.
|
||||
*/
|
||||
#endregion
|
||||
|
||||
using System;
|
||||
using System.Linq;
|
||||
using OpenRA.Graphics;
|
||||
using OpenRA.Primitives;
|
||||
|
||||
namespace OpenRA.Mods.Common.Widgets
|
||||
{
|
||||
public static class WidgetUtils
|
||||
{
|
||||
public static Sprite GetChromeImage(World world, string name)
|
||||
{
|
||||
return ChromeProvider.GetImage("chrome-" + world.LocalPlayer.Faction.InternalName, name);
|
||||
}
|
||||
|
||||
public static void DrawRGBA(Sprite s, float2 pos)
|
||||
{
|
||||
Game.Renderer.RgbaSpriteRenderer.DrawSprite(s, pos);
|
||||
}
|
||||
|
||||
public static void DrawSHPCentered(Sprite s, float2 pos, PaletteReference p)
|
||||
{
|
||||
Game.Renderer.SpriteRenderer.DrawSprite(s, pos - 0.5f * s.Size, p);
|
||||
}
|
||||
|
||||
public static void DrawSHPCentered(Sprite s, float2 pos, PaletteReference p, float scale)
|
||||
{
|
||||
Game.Renderer.SpriteRenderer.DrawSprite(s, pos - 0.5f * scale * s.Size, p, scale * s.Size);
|
||||
}
|
||||
|
||||
public static void DrawPanel(string collection, Rectangle bounds)
|
||||
{
|
||||
DrawPanelPartial(collection, bounds, PanelSides.All);
|
||||
}
|
||||
|
||||
public static void FillRectWithSprite(Rectangle r, Sprite s)
|
||||
{
|
||||
for (var x = r.Left; x < r.Right; x += (int)s.Size.X)
|
||||
for (var y = r.Top; y < r.Bottom; y += (int)s.Size.Y)
|
||||
{
|
||||
var ss = s;
|
||||
var left = new int2(r.Right - x, r.Bottom - y);
|
||||
if (left.X < (int)s.Size.X || left.Y < (int)s.Size.Y)
|
||||
{
|
||||
var rr = new Rectangle(s.Bounds.Left,
|
||||
s.Bounds.Top,
|
||||
Math.Min(left.X, (int)s.Size.X),
|
||||
Math.Min(left.Y, (int)s.Size.Y));
|
||||
ss = new Sprite(s.Sheet, rr, s.Channel);
|
||||
}
|
||||
|
||||
DrawRGBA(ss, new float2(x, y));
|
||||
}
|
||||
}
|
||||
|
||||
public static void FillRectWithColor(Rectangle r, Color c)
|
||||
{
|
||||
// Offset to the edges of the pixels
|
||||
var tl = new float2(r.Left - 0.5f, r.Top - 0.5f);
|
||||
var br = new float2(r.Right - 0.5f, r.Bottom - 0.5f);
|
||||
Game.Renderer.RgbaColorRenderer.FillRect(tl, br, c);
|
||||
}
|
||||
|
||||
public static void FillRectWithColor(Rectangle r, Color topLeftColor, Color topRightColor, Color bottomRightColor, Color bottomLeftColor)
|
||||
{
|
||||
var tl = new float2(r.Left - 0.5f, r.Top - 0.5f);
|
||||
var br = new float2(r.Right - 0.5f, r.Bottom - 0.5f);
|
||||
|
||||
var tr = new float3(br.X, tl.Y, 0);
|
||||
var bl = new float3(tl.X, br.Y, 0);
|
||||
|
||||
Game.Renderer.RgbaColorRenderer.FillRect(tl, tr, br, bl, topLeftColor, topRightColor, bottomRightColor, bottomLeftColor);
|
||||
}
|
||||
|
||||
public static void FillEllipseWithColor(Rectangle r, Color c)
|
||||
{
|
||||
var tl = new float2(r.Left, r.Top);
|
||||
var br = new float2(r.Right, r.Bottom);
|
||||
Game.Renderer.RgbaColorRenderer.FillEllipse(tl, br, c);
|
||||
}
|
||||
|
||||
public static int[] GetBorderSizes(string collection)
|
||||
{
|
||||
var images = new[] { "border-t", "border-b", "border-l", "border-r" };
|
||||
var ss = images.Select(i => ChromeProvider.GetImage(collection, i)).ToList();
|
||||
return new[] { (int)ss[0].Size.Y, (int)ss[1].Size.Y, (int)ss[2].Size.X, (int)ss[3].Size.X };
|
||||
}
|
||||
|
||||
static bool HasFlags(this PanelSides a, PanelSides b)
|
||||
{
|
||||
// PERF: Enum.HasFlag is slower and requires allocations.
|
||||
return (a & b) == b;
|
||||
}
|
||||
|
||||
public static Rectangle InflateBy(this Rectangle rect, int l, int t, int r, int b)
|
||||
{
|
||||
return Rectangle.FromLTRB(rect.Left - l, rect.Top - t,
|
||||
rect.Right + r, rect.Bottom + b);
|
||||
}
|
||||
|
||||
public static void DrawPanelPartial(string collection, Rectangle bounds, PanelSides ps)
|
||||
{
|
||||
DrawPanelPartial(bounds, ps,
|
||||
ChromeProvider.GetImage(collection, "border-t"),
|
||||
ChromeProvider.GetImage(collection, "border-b"),
|
||||
ChromeProvider.GetImage(collection, "border-l"),
|
||||
ChromeProvider.GetImage(collection, "border-r"),
|
||||
ChromeProvider.GetImage(collection, "corner-tl"),
|
||||
ChromeProvider.GetImage(collection, "corner-tr"),
|
||||
ChromeProvider.GetImage(collection, "corner-bl"),
|
||||
ChromeProvider.GetImage(collection, "corner-br"),
|
||||
ChromeProvider.GetImage(collection, "background"));
|
||||
}
|
||||
|
||||
public static void DrawPanelPartial(Rectangle bounds, PanelSides ps,
|
||||
Sprite borderTop,
|
||||
Sprite borderBottom,
|
||||
Sprite borderLeft,
|
||||
Sprite borderRight,
|
||||
Sprite cornerTopLeft,
|
||||
Sprite cornerTopRight,
|
||||
Sprite cornerBottomLeft,
|
||||
Sprite cornerBottomRight,
|
||||
Sprite background)
|
||||
{
|
||||
var marginLeft = borderLeft == null ? 0 : (int)borderLeft.Size.X;
|
||||
var marginTop = borderTop == null ? 0 : (int)borderTop.Size.Y;
|
||||
var marginRight = borderRight == null ? 0 : (int)borderRight.Size.X;
|
||||
var marginBottom = borderBottom == null ? 0 : (int)borderBottom.Size.Y;
|
||||
var marginWidth = marginRight + marginLeft;
|
||||
var marginHeight = marginBottom + marginTop;
|
||||
|
||||
// Background
|
||||
if (ps.HasFlags(PanelSides.Center) && background != null)
|
||||
FillRectWithSprite(new Rectangle(bounds.Left + marginLeft, bounds.Top + marginTop,
|
||||
bounds.Width - marginWidth, bounds.Height - marginHeight),
|
||||
background);
|
||||
|
||||
// Left border
|
||||
if (ps.HasFlags(PanelSides.Left) && borderLeft != null)
|
||||
FillRectWithSprite(new Rectangle(bounds.Left, bounds.Top + marginTop,
|
||||
marginLeft, bounds.Height - marginHeight),
|
||||
borderLeft);
|
||||
|
||||
// Right border
|
||||
if (ps.HasFlags(PanelSides.Right) && borderRight != null)
|
||||
FillRectWithSprite(new Rectangle(bounds.Right - marginRight, bounds.Top + marginTop,
|
||||
marginLeft, bounds.Height - marginHeight),
|
||||
borderRight);
|
||||
|
||||
// Top border
|
||||
if (ps.HasFlags(PanelSides.Top) && borderTop != null)
|
||||
FillRectWithSprite(new Rectangle(bounds.Left + marginLeft, bounds.Top,
|
||||
bounds.Width - marginWidth, marginTop),
|
||||
borderTop);
|
||||
|
||||
// Bottom border
|
||||
if (ps.HasFlags(PanelSides.Bottom) && borderBottom != null)
|
||||
FillRectWithSprite(new Rectangle(bounds.Left + marginLeft, bounds.Bottom - marginBottom,
|
||||
bounds.Width - marginWidth, marginTop),
|
||||
borderBottom);
|
||||
|
||||
if (ps.HasFlags(PanelSides.Left | PanelSides.Top) && cornerTopLeft != null)
|
||||
DrawRGBA(cornerTopLeft, new float2(bounds.Left, bounds.Top));
|
||||
if (ps.HasFlags(PanelSides.Right | PanelSides.Top) && cornerTopRight != null)
|
||||
DrawRGBA(cornerTopRight, new float2(bounds.Right - cornerTopRight.Size.X, bounds.Top));
|
||||
if (ps.HasFlags(PanelSides.Left | PanelSides.Bottom) && cornerBottomLeft != null)
|
||||
DrawRGBA(cornerBottomLeft, new float2(bounds.Left, bounds.Bottom - cornerBottomLeft.Size.Y));
|
||||
if (ps.HasFlags(PanelSides.Right | PanelSides.Bottom) && cornerBottomRight != null)
|
||||
DrawRGBA(cornerBottomRight, new float2(bounds.Right - cornerBottomRight.Size.X, bounds.Bottom - cornerBottomRight.Size.Y));
|
||||
}
|
||||
|
||||
public static string FormatTime(int ticks, int timestep)
|
||||
{
|
||||
return FormatTime(ticks, true, timestep);
|
||||
}
|
||||
|
||||
public static string FormatTime(int ticks, bool leadingMinuteZero, int timestep)
|
||||
{
|
||||
var seconds = (int)Math.Ceiling(ticks * timestep / 1000f);
|
||||
return FormatTimeSeconds(seconds, leadingMinuteZero);
|
||||
}
|
||||
|
||||
public static string FormatTimeSeconds(int seconds)
|
||||
{
|
||||
return FormatTimeSeconds(seconds, true);
|
||||
}
|
||||
|
||||
public static string FormatTimeSeconds(int seconds, bool leadingMinuteZero)
|
||||
{
|
||||
var minutes = seconds / 60;
|
||||
|
||||
if (minutes >= 60)
|
||||
return "{0:D}:{1:D2}:{2:D2}".F(minutes / 60, minutes % 60, seconds % 60);
|
||||
if (leadingMinuteZero)
|
||||
return "{0:D2}:{1:D2}".F(minutes, seconds % 60);
|
||||
return "{0:D}:{1:D2}".F(minutes, seconds % 60);
|
||||
}
|
||||
|
||||
public static string WrapText(string text, int width, SpriteFont font)
|
||||
{
|
||||
var textSize = font.Measure(text);
|
||||
if (textSize.X > width)
|
||||
{
|
||||
var lines = text.Split('\n').ToList();
|
||||
|
||||
for (var i = 0; i < lines.Count; i++)
|
||||
{
|
||||
var line = lines[i];
|
||||
if (font.Measure(line).X <= width)
|
||||
continue;
|
||||
|
||||
// Scan forwards until we find the last word that fits
|
||||
// This guarantees a small bound on the amount of string we need to search before a linebreak
|
||||
var start = 0;
|
||||
while (true)
|
||||
{
|
||||
var spaceIndex = line.IndexOf(' ', start);
|
||||
if (spaceIndex == -1)
|
||||
break;
|
||||
|
||||
var fragmentWidth = font.Measure(line.Substring(0, spaceIndex)).X;
|
||||
if (fragmentWidth > width)
|
||||
break;
|
||||
|
||||
start = spaceIndex + 1;
|
||||
}
|
||||
|
||||
if (start > 0)
|
||||
{
|
||||
lines[i] = line.Substring(0, start - 1);
|
||||
lines.Insert(i + 1, line.Substring(start));
|
||||
}
|
||||
}
|
||||
|
||||
return string.Join("\n", lines);
|
||||
}
|
||||
|
||||
return text;
|
||||
}
|
||||
|
||||
public static string TruncateText(string text, int width, SpriteFont font)
|
||||
{
|
||||
var trimmedWidth = font.Measure(text).X;
|
||||
if (trimmedWidth <= width)
|
||||
return text;
|
||||
|
||||
var trimmed = text;
|
||||
while (trimmedWidth > width && trimmed.Length > 3)
|
||||
{
|
||||
trimmed = text.Substring(0, trimmed.Length - 4) + "...";
|
||||
trimmedWidth = font.Measure(trimmed).X;
|
||||
}
|
||||
|
||||
return trimmed;
|
||||
}
|
||||
|
||||
public static void TruncateLabelToTooltip(LabelWithTooltipWidget label, string text)
|
||||
{
|
||||
var truncatedText = TruncateText(text, label.Bounds.Width, Game.Renderer.Fonts[label.Font]);
|
||||
|
||||
label.GetText = () => truncatedText;
|
||||
|
||||
if (text != truncatedText)
|
||||
label.GetTooltipText = () => text;
|
||||
else
|
||||
label.GetTooltipText = null;
|
||||
}
|
||||
}
|
||||
|
||||
public class CachedTransform<T, U>
|
||||
{
|
||||
readonly Func<T, U> transform;
|
||||
|
||||
bool initialized;
|
||||
T lastInput;
|
||||
U lastOutput;
|
||||
|
||||
public CachedTransform(Func<T, U> transform)
|
||||
{
|
||||
this.transform = transform;
|
||||
}
|
||||
|
||||
public U Update(T input)
|
||||
{
|
||||
if (initialized && ((input == null && lastInput == null) || (input != null && input.Equals(lastInput))))
|
||||
return lastOutput;
|
||||
|
||||
lastInput = input;
|
||||
lastOutput = transform(input);
|
||||
initialized = true;
|
||||
|
||||
return lastOutput;
|
||||
}
|
||||
}
|
||||
|
||||
[Flags]
|
||||
public enum PanelSides
|
||||
{
|
||||
Left = 1,
|
||||
Top = 2,
|
||||
Right = 4,
|
||||
Bottom = 8,
|
||||
Center = 16,
|
||||
|
||||
Edges = Left | Top | Right | Bottom,
|
||||
All = Edges | Center,
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user