index.js•8.2 kB
import Path from "path";
import bMFont from "load-bmfont";
import { isNodePattern, throwError } from "@jimp/utils";
import { measureText, measureTextHeight, splitLines } from "./measure-text";
function xOffsetBasedOnAlignment(constants, font, line, maxWidth, alignment) {
if (alignment === constants.HORIZONTAL_ALIGN_LEFT) {
return 0;
}
if (alignment === constants.HORIZONTAL_ALIGN_CENTER) {
return (maxWidth - measureText(font, line)) / 2;
}
return maxWidth - measureText(font, line);
}
function drawCharacter(image, font, x, y, char) {
if (char.width > 0 && char.height > 0) {
const characterPage = font.pages[char.page];
image.blit(
characterPage,
x + char.xoffset,
y + char.yoffset,
char.x,
char.y,
char.width,
char.height
);
}
return image;
}
function printText(font, x, y, text, defaultCharWidth) {
for (let i = 0; i < text.length; i++) {
let char;
if (font.chars[text[i]]) {
char = text[i];
} else if (/\s/.test(text[i])) {
char = "";
} else {
char = "?";
}
const fontChar = font.chars[char] || {};
const fontKerning = font.kernings[char];
drawCharacter(this, font, x, y, fontChar || {});
const kerning =
fontKerning && fontKerning[text[i + 1]] ? fontKerning[text[i + 1]] : 0;
x += kerning + (fontChar.xadvance || defaultCharWidth);
}
}
function loadPages(Jimp, dir, pages) {
const newPages = pages.map((page) => {
return Jimp.read(dir + "/" + page);
});
return Promise.all(newPages);
}
const dir = process.env.DIRNAME || `${__dirname}/../`;
export default () => ({
constants: {
measureText,
measureTextHeight,
FONT_SANS_8_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-8-black/open-sans-8-black.fnt"
),
FONT_SANS_10_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-10-black/open-sans-10-black.fnt"
),
FONT_SANS_12_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-12-black/open-sans-12-black.fnt"
),
FONT_SANS_14_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-14-black/open-sans-14-black.fnt"
),
FONT_SANS_16_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-16-black/open-sans-16-black.fnt"
),
FONT_SANS_32_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-32-black/open-sans-32-black.fnt"
),
FONT_SANS_64_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-64-black/open-sans-64-black.fnt"
),
FONT_SANS_128_BLACK: Path.join(
dir,
"fonts/open-sans/open-sans-128-black/open-sans-128-black.fnt"
),
FONT_SANS_8_WHITE: Path.join(
dir,
"fonts/open-sans/open-sans-8-white/open-sans-8-white.fnt"
),
FONT_SANS_16_WHITE: Path.join(
dir,
"fonts/open-sans/open-sans-16-white/open-sans-16-white.fnt"
),
FONT_SANS_32_WHITE: Path.join(
dir,
"fonts/open-sans/open-sans-32-white/open-sans-32-white.fnt"
),
FONT_SANS_64_WHITE: Path.join(
dir,
"fonts/open-sans/open-sans-64-white/open-sans-64-white.fnt"
),
FONT_SANS_128_WHITE: Path.join(
dir,
"fonts/open-sans/open-sans-128-white/open-sans-128-white.fnt"
),
/**
* Loads a bitmap font from a file
* @param {string} file the file path of a .fnt file
* @param {function(Error, Jimp)} cb (optional) a function to call when the font is loaded
* @returns {Promise} a promise
*/
loadFont(file, cb) {
if (typeof file !== "string")
return throwError.call(this, "file must be a string", cb);
return new Promise((resolve, reject) => {
cb =
cb ||
function (err, font) {
if (err) reject(err);
else resolve(font);
};
bMFont(file, (err, font) => {
const chars = {};
const kernings = {};
if (err) {
return throwError.call(this, err, cb);
}
for (let i = 0; i < font.chars.length; i++) {
chars[String.fromCharCode(font.chars[i].id)] = font.chars[i];
}
for (let i = 0; i < font.kernings.length; i++) {
const firstString = String.fromCharCode(font.kernings[i].first);
kernings[firstString] = kernings[firstString] || {};
kernings[firstString][
String.fromCharCode(font.kernings[i].second)
] = font.kernings[i].amount;
}
loadPages(this, Path.dirname(file), font.pages).then((pages) => {
cb(null, {
chars,
kernings,
pages,
common: font.common,
info: font.info,
});
});
});
});
},
},
class: {
/**
* Draws a text on a image on a given boundary
* @param {Jimp} font a bitmap font loaded from `Jimp.loadFont` command
* @param {number} x the x position to start drawing the text
* @param {number} y the y position to start drawing the text
* @param {any} text the text to draw (string or object with `text`, `alignmentX`, and/or `alignmentY`)
* @param {number} maxWidth (optional) the boundary width to draw in
* @param {number} maxHeight (optional) the boundary height to draw in
* @param {function(Error, Jimp)} cb (optional) a function to call when the text is written
* @returns {Jimp} this for chaining of methods
*/
print(font, x, y, text, maxWidth, maxHeight, cb) {
if (typeof maxWidth === "function" && typeof cb === "undefined") {
cb = maxWidth;
maxWidth = Infinity;
}
if (typeof maxWidth === "undefined") {
maxWidth = Infinity;
}
if (typeof maxHeight === "function" && typeof cb === "undefined") {
cb = maxHeight;
maxHeight = Infinity;
}
if (typeof maxHeight === "undefined") {
maxHeight = Infinity;
}
if (typeof font !== "object") {
return throwError.call(this, "font must be a Jimp loadFont", cb);
}
if (
typeof x !== "number" ||
typeof y !== "number" ||
typeof maxWidth !== "number"
) {
return throwError.call(this, "x, y and maxWidth must be numbers", cb);
}
if (typeof maxWidth !== "number") {
return throwError.call(this, "maxWidth must be a number", cb);
}
if (typeof maxHeight !== "number") {
return throwError.call(this, "maxHeight must be a number", cb);
}
let alignmentX;
let alignmentY;
if (
typeof text === "object" &&
text.text !== null &&
text.text !== undefined
) {
alignmentX = text.alignmentX || this.constructor.HORIZONTAL_ALIGN_LEFT;
alignmentY = text.alignmentY || this.constructor.VERTICAL_ALIGN_TOP;
({ text } = text);
} else {
alignmentX = this.constructor.HORIZONTAL_ALIGN_LEFT;
alignmentY = this.constructor.VERTICAL_ALIGN_TOP;
text = text.toString();
}
if (
maxHeight !== Infinity &&
alignmentY === this.constructor.VERTICAL_ALIGN_BOTTOM
) {
y += maxHeight - measureTextHeight(font, text, maxWidth);
} else if (
maxHeight !== Infinity &&
alignmentY === this.constructor.VERTICAL_ALIGN_MIDDLE
) {
y += maxHeight / 2 - measureTextHeight(font, text, maxWidth) / 2;
}
const defaultCharWidth = Object.entries(font.chars)[0][1].xadvance;
const { lines, longestLine } = splitLines(font, text, maxWidth);
lines.forEach((line) => {
const lineString = line.join(" ");
const alignmentWidth = xOffsetBasedOnAlignment(
this.constructor,
font,
lineString,
maxWidth,
alignmentX
);
printText.call(
this,
font,
x + alignmentWidth,
y,
lineString,
defaultCharWidth
);
y += font.common.lineHeight;
});
if (isNodePattern(cb)) {
cb.call(this, null, this, { x: x + longestLine, y });
}
return this;
},
},
});