Ellpeck/MLEM
1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-12-24 17:29:23 +01:00
Code Issues Projects Releases Wiki Activity

use a heuristic for GenericStashFont line height calculations and allow specifying a custom line height

Browse source
This commit is contained in:
Ell 2021-07-20 01:23:44 +02:00
parent 527c4af3e4
commit ebc6ec872b
2 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -32,7 +32,7 @@ Fixes
### MLEM.Extended
Improvements
- Adjusted GenericStashFont line height calculations to result in the same values as GenericSpriteFont
- Adjusted GenericStashFont line height calculations to result in values closer to GenericSpriteFont and added a constructor parameter to set a custom line height
### MLEM.Data
Additions

22
MLEM.Extended/Font/GenericStashFont.cs
View file

@ -1,3 +1,4 @@
using System.Linq;
using System.Text;
using FontStashSharp;
using Microsoft.Xna.Framework;
@ -24,12 +25,19 @@ namespace MLEM.Extended.Font {
/// Creates a new generic font using <see cref="SpriteFontBase"/>.
/// Optionally, a bold and italic version of the font can be supplied.
/// </summary>
/// <remarks>
/// <see cref="DynamicSpriteFont"/> doesn't expose a text-independent line height (https://github.com/rds1983/FontStashSharp/blob/main/src/FontStashSharp/DynamicSpriteFont.cs#L130).
/// Since <see cref="GenericFont"/> exposes <see cref="LineHeight"/>, there is somewhat of an incompatibility between the two.
/// Because of this, <see cref="GenericStashFont"/> uses a heuristic to determine a text-independent line height based on the tallest character out of a set of predetermined characters (spaces, numbers and uppercase and lowercase A through Z).
/// Because this heuristic is just that, and because it excludes non-latin characters, the desired line height can be specified using <paramref name="lineHeight"/>, overriding the default heuristic.
/// </remarks>
/// <param name="font">The font to wrap</param>
/// <param name="bold">A bold version of the font</param>
/// <param name="italic">An italic version of the font</param>
public GenericStashFont(SpriteFontBase font, SpriteFontBase bold = null, SpriteFontBase italic = null) {
/// <param name="lineHeight">The line height that should be used for <see cref="LineHeight"/> instead of the heuristic described in the remarks</param>
public GenericStashFont(SpriteFontBase font, SpriteFontBase bold = null, SpriteFontBase italic = null, float? lineHeight = null) {
this.Font = font;
this.LineHeight = CalculateLineHeight(font);
this.LineHeight = lineHeight ?? CalculateLineHeight(font);
this.Bold = bold != null ? new GenericStashFont(bold) : this;
this.Italic = italic != null ? new GenericStashFont(italic) : this;
}
@ -54,11 +62,11 @@ namespace MLEM.Extended.Font {
// this is the same calculation used internally by StaticSpriteFont
return s.FontSize + s.LineSpacing;
} else {
// Y (min y) just stores the glyph's Y offset, whereas Y2 (max y) stores the glyph's height
// since we technically want line spacing rather than line height, we calculate it like this
var bounds = new Bounds();
font.TextBounds(" ", Vector2.Zero, ref bounds);
return bounds.Y2 + (bounds.Y2 - bounds.Y);
// use a heuristic to determine the text-independent line heights as described in the constructor remarks
return new[] {' ', '\n', OneEmSpace, Zwsp, Nbsp}
.Concat(Enumerable.Range('a', 'z' - 'a' + 1).SelectMany(c => new[] {(char) c, char.ToUpper((char) c)}))
.Concat(Enumerable.Range('0', '9' - '0' + 1).Select(c => (char) c))
.Select(c => font.MeasureString(c.ToString()).Y).Max();
}
}