Improve API usage of BitmapFont.from

[bigtimebuddy]

Overview

This change is mostly about improving and streamlining ergonomics using the new BitmapFont.from API (#6600).

Also, did some minor code organization and documentation fixes.

Before
Previously you optionally defined the font name and no chars were set by default.

const font = BitmapFont.from({ chars: BitmapFont.ALPHANUMERIC }, {
    fill: "#808080",
    fontFamily: "Roboto-Black",
    fontSize: 33,
});
BitmapFont.available.TitleFont = font;

After
Now, font is installed, name is required, and chars are optional (defaults to ALPHANUMERIC).

BitmapFont.from("TitleFont", {
    fill: "#808080",
    fontFamily: "Roboto-Black",
    fontSize: 33,
});

Now, if you want to change something on the fly, regenerating the font is as easy as calling BitmapFont.from again with some new style options.

const style = new TextStyle({
    fill: "#808080",
    fontFamily: "Roboto-Black",
    fontSize: 33,
});
BitmapFont.from("TitleFont", style);
style.fontSize = 14;
BitmapFont.from("TitleFont", style); // rerenders font!

Demo

https://jsfiddle.net/bigtimebuddy/wt9szqp6/

Changed

• Both these signatures are now supported BitmapFont.from(name, style) and BitmapFont.from(options, style) Changed API signature to be BitmapFont.from(name, style, options)
• Destroying a BitmapFont now also destroys the page textures, not just the glyph textures
• Field name is required for BitmapFont.from for ease of use.
• When calling BitmapFont.from, it will override any existing font by default with the same name, making it easier to regenerate the font.
• Exposed default options via BitmapFont.defaultOptions in case users want to change this globally.
• Moved utilities drawGlyph and processCharData to their own utilities. Still need a cleanup on generateFillStyle and drawGlyph with Text. Probably better for a follow-up PR.

[codecov-commenter]

Codecov Report

Merging #6640 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #6640   +/-   ##
=======================================
  Coverage   82.34%   82.34%           
=======================================
  Files          37       37           
  Lines        1897     1897           
=======================================
  Hits         1562     1562           
  Misses        335      335           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ef8f397...653b392. Read the comment docs.

[ShukantPal]

Looks much better than before!

[ShukantPal]

🥇 🥇

[bigtimebuddy]

One other thing I discovered was the use of Array.prototype.find which is not supported in IE will need to replace that with something more compatible.

[GoodBoyDigital]

nice tidy up @bigtimebuddy ! 👍

[GoodBoyDigital]

oh yes! this is great idea!
we could create a cache that is mapped by style :D
love the idea of storing standard fonts as B/W and then tinting them! 👍

[themoonrat]

"
Both these signatures are now supported BitmapFont.from(name, style) and BitmapFont.from(options, style)
"

Like the changes! But this signature style doesn't make sense to me. Surely you just have

BitmapFont.from(name, style, options) 

And then you've one signature to rule them all?

[bigtimebuddy]

Good shout @themoonrat. Fixed.