14804036802

Committed 02 May 2025 09:58PM UTC coverage: 5.927% (-83.4%) from 89.28%

Build # 14804036802

Build Type

Pull #3404

github

Committed by

web-flow

Commit Message

Merge 5c103d7f8 into 0f2ccaeb2

Pull Request Pull Request #3404: feat: added Graph module to Math

Run Details

234 of 8383 branches covered (2.79%)

229 of 246 new or added lines in 1 file covered. (93.09%)

13145 existing lines in 208 files now uncovered.

934 of 15759 relevant lines covered (5.93%)

4.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/engine/Graphics/SpriteFont.ts

import { Vector } from '../Math/vector';
import { Logger } from '../Util/Log';
import { ExcaliburGraphicsContext } from './Context/ExcaliburGraphicsContext';
import { FontRenderer } from './FontCommon';
import { Graphic, GraphicOptions } from './Graphic';
import { Sprite } from './Sprite';
import { SpriteSheet } from './SpriteSheet';
import { BoundingBox } from '../Collision/BoundingBox';

export interface SpriteFontOptions {
  /**
   * Alphabet string in spritesheet order (default is row column order)
   * example: 'abcdefghijklmnopqrstuvwxyz'
   */
  alphabet: string;
  /**
   * {@apilink SpriteSheet} to source character sprites from
   */
  spriteSheet: SpriteSheet;
  /**
   * Optionally ignore case in the supplied text;
   */
  caseInsensitive?: boolean;
  /**
   * Optionally override the text line height, useful for multiline text. If unset will use default.
   */
  lineHeight?: number | undefined;
  /**
   * Optionally adjust the spacing between character sprites
   */
  spacing?: number;
  /**
   * Optionally specify a "shadow"
   */
  shadow?: { offset: Vector };
}

export class SpriteFont extends Graphic implements FontRenderer {
  private _text: string = '';
  public alphabet: string = '';
  public spriteSheet: SpriteSheet;

  public shadow?: { offset: Vector } = undefined;
  public caseInsensitive = false;
  public spacing: number = 0;
  public lineHeight: number | undefined = undefined;

  private _logger = Logger.getInstance();

  constructor(options: SpriteFontOptions & GraphicOptions) {
    super(options);
    const { alphabet, spriteSheet, caseInsensitive, spacing, shadow, lineHeight } = options;
    this.alphabet = alphabet;
    this.spriteSheet = spriteSheet;
    this.caseInsensitive = caseInsensitive ?? this.caseInsensitive;
    this.spacing = spacing ?? this.spacing;
    this.shadow = shadow ?? this.shadow;
    this.lineHeight = lineHeight ?? this.lineHeight;
  }

  private _getCharacterSprites(text: string): Sprite[] {
    const results: Sprite[] = [];
    // handle case insensitive
    const textToRender = this.caseInsensitive ? text.toLocaleLowerCase() : text;
    const alphabet = this.caseInsensitive ? this.alphabet.toLocaleLowerCase() : this.alphabet;

    // for each letter in text
    for (let letterIndex = 0; letterIndex < textToRender.length; letterIndex++) {
      // find the sprite index in alphabet , if there is an error pick the first
      const letter = textToRender[letterIndex];
      let spriteIndex = alphabet.indexOf(letter);
      if (spriteIndex === -1) {
        spriteIndex = 0;
        this._logger.warnOnce(`SpriteFont - Cannot find letter '${letter}' in configured alphabet '${alphabet}'.`);
        this._logger.warnOnce('There maybe be more issues in the SpriteFont configuration. No additional warnings will be logged.');
      }

      const letterSprite = this.spriteSheet.sprites[spriteIndex];
      if (letterSprite) {
        results.push(letterSprite);
      } else {
        this._logger.warnOnce(`SpriteFont - Cannot find sprite for '${letter}' at index '${spriteIndex}' in configured SpriteSheet`);
        this._logger.warnOnce('There maybe be more issues in the SpriteFont configuration. No additional warnings will be logged.');
      }
    }
    return results;
  }

  public measureText(text: string, maxWidth?: number): BoundingBox {
    const lines = this._getLinesFromText(text, maxWidth);
    const maxWidthLine = lines.reduce((a, b) => {
      return a.length > b.length ? a : b;
    });
    const sprites = this._getCharacterSprites(maxWidthLine);
    let width = 0;
    let height = 0;
    for (const sprite of sprites) {
      width += sprite.width + this.spacing;
      height = Math.max(height, sprite.height);
    }
    return BoundingBox.fromDimension(width * this.scale.x, height * lines.length * this.scale.y, Vector.Zero);
  }

  protected _drawImage(ex: ExcaliburGraphicsContext, x: number, y: number, maxWidth?: number): void {
    let xCursor = 0;
    let yCursor = 0;
    let height = 0;
    const lines = this._getLinesFromText(this._text, maxWidth);
    for (const line of lines) {
      for (const sprite of this._getCharacterSprites(line)) {
        // draw it in the right spot and increase the cursor by sprite width
        sprite.draw(ex, x + xCursor, y + yCursor);
        xCursor += sprite.width + this.spacing;
        height = Math.max(height, sprite.height);
      }
      xCursor = 0;
      yCursor += this.lineHeight ?? height;
    }
  }

  render(ex: ExcaliburGraphicsContext, text: string, _color: any, x: number, y: number, maxWidth?: number) {
    // SpriteFont doesn't support _color, yet...
    this._text = text;
    const bounds = this.measureText(text, maxWidth);
    this.width = bounds.width;
    this.height = bounds.height;
    if (this.shadow) {
      ex.save();
      ex.translate(this.shadow.offset.x, this.shadow.offset.y);
      this._preDraw(ex, x, y);
      this._drawImage(ex, 0, 0, maxWidth);
      this._postDraw(ex);
      ex.restore();
    }

    this._preDraw(ex, x, y);
    this._drawImage(ex, 0, 0, maxWidth);
    this._postDraw(ex);
  }

  clone(): SpriteFont {
    return new SpriteFont({
      alphabet: this.alphabet,
      spriteSheet: this.spriteSheet,
      spacing: this.spacing
    });
  }

  /**
   * Return array of lines split based on the \n character, and the maxWidth? constraint
   * @param text
   * @param maxWidth
   */
  private _cachedText?: string;
  private _cachedLines?: string[];
  private _cachedRenderWidth?: number;
  private _getLinesFromText(text: string, maxWidth?: number) {
    if (this._cachedText === text && this._cachedRenderWidth === maxWidth && this._cachedLines?.length) {
      return this._cachedLines;
    }

    const lines = text.split('\n');

    if (maxWidth == null) {
      return lines;
    }

    // If the current line goes past the maxWidth, append a new line without modifying the underlying text.
    for (let i = 0; i < lines.length; i++) {
      let line = lines[i];
      let newLine = '';
      // Note: we subtract the spacing to counter the initial padding on the left side.
      if (this.measureText(line).width > maxWidth) {
        while (this.measureText(line).width > maxWidth) {
          newLine = line[line.length - 1] + newLine;
          line = line.slice(0, -1); // Remove last character from line
        }

        // Update the array with our new values
        lines[i] = line;
        lines[i + 1] = newLine;
      }
    }

    this._cachedText = text;
    this._cachedLines = lines;
    this._cachedRenderWidth = maxWidth;

    return lines;
  }
}

1	import { Vector } from '../Math/vector';
2	import { Logger } from '../Util/Log';
3	import { ExcaliburGraphicsContext } from './Context/ExcaliburGraphicsContext';
4	import { FontRenderer } from './FontCommon';
5	import { Graphic, GraphicOptions } from './Graphic';
6	import { Sprite } from './Sprite';
7	import { SpriteSheet } from './SpriteSheet';
8	import { BoundingBox } from '../Collision/BoundingBox';
9
10	export interface SpriteFontOptions {
11	/**
12	* Alphabet string in spritesheet order (default is row column order)
13	* example: 'abcdefghijklmnopqrstuvwxyz'
14	*/
15	alphabet: string;
16	/**
17	* {@apilink SpriteSheet} to source character sprites from
18	*/
19	spriteSheet: SpriteSheet;
20	/**
21	* Optionally ignore case in the supplied text;
22	*/
23	caseInsensitive?: boolean;
24	/**
25	* Optionally override the text line height, useful for multiline text. If unset will use default.
26	*/
27	lineHeight?: number \| undefined;
28	/**
29	* Optionally adjust the spacing between character sprites
30	*/
31	spacing?: number;
32	/**
33	* Optionally specify a "shadow"
34	*/
35	shadow?: { offset: Vector };
36	}
37
38	export class SpriteFont extends Graphic implements FontRenderer {
UNCOV 39	private _text: string = '';	×
UNCOV 40	public alphabet: string = '';	×
41	public spriteSheet: SpriteSheet;
42
UNCOV 43	public shadow?: { offset: Vector } = undefined;	×
UNCOV 44	public caseInsensitive = false;	×
UNCOV 45	public spacing: number = 0;	×
UNCOV 46	public lineHeight: number \| undefined = undefined;	×
47
UNCOV 48	private _logger = Logger.getInstance();	×
49
50	constructor(options: SpriteFontOptions & GraphicOptions) {
UNCOV 51	super(options);	×
UNCOV 52	const { alphabet, spriteSheet, caseInsensitive, spacing, shadow, lineHeight } = options;	×
UNCOV 53	this.alphabet = alphabet;	×
UNCOV 54	this.spriteSheet = spriteSheet;	×
UNCOV 55	this.caseInsensitive = caseInsensitive ?? this.caseInsensitive;	×
UNCOV 56	this.spacing = spacing ?? this.spacing;	×
UNCOV 57	this.shadow = shadow ?? this.shadow;	×
UNCOV 58	this.lineHeight = lineHeight ?? this.lineHeight;	×
59	}
60
61	private _getCharacterSprites(text: string): Sprite[] {
UNCOV 62	const results: Sprite[] = [];	×
63	// handle case insensitive
UNCOV 64	const textToRender = this.caseInsensitive ? text.toLocaleLowerCase() : text;	×
UNCOV 65	const alphabet = this.caseInsensitive ? this.alphabet.toLocaleLowerCase() : this.alphabet;	×
66
67	// for each letter in text
UNCOV 68	for (let letterIndex = 0; letterIndex < textToRender.length; letterIndex++) {	×
69	// find the sprite index in alphabet , if there is an error pick the first
UNCOV 70	const letter = textToRender[letterIndex];	×
UNCOV 71	let spriteIndex = alphabet.indexOf(letter);	×
UNCOV 72	if (spriteIndex === -1) {	×
UNCOV 73	spriteIndex = 0;	×
UNCOV 74	this._logger.warnOnce(`SpriteFont - Cannot find letter '${letter}' in configured alphabet '${alphabet}'.`);	×
UNCOV 75	this._logger.warnOnce('There maybe be more issues in the SpriteFont configuration. No additional warnings will be logged.');	×
76	}
77
UNCOV 78	const letterSprite = this.spriteSheet.sprites[spriteIndex];	×
UNCOV 79	if (letterSprite) {	×
UNCOV 80	results.push(letterSprite);	×
81	} else {
UNCOV 82	this._logger.warnOnce(`SpriteFont - Cannot find sprite for '${letter}' at index '${spriteIndex}' in configured SpriteSheet`);	×
UNCOV 83	this._logger.warnOnce('There maybe be more issues in the SpriteFont configuration. No additional warnings will be logged.');	×
84	}
85	}
UNCOV 86	return results;	×
87	}
88
89	public measureText(text: string, maxWidth?: number): BoundingBox {
UNCOV 90	const lines = this._getLinesFromText(text, maxWidth);	×
UNCOV 91	const maxWidthLine = lines.reduce((a, b) => {	×
UNCOV 92	return a.length > b.length ? a : b;	×
93	});
UNCOV 94	const sprites = this._getCharacterSprites(maxWidthLine);	×
UNCOV 95	let width = 0;	×
UNCOV 96	let height = 0;	×
UNCOV 97	for (const sprite of sprites) {	×
UNCOV 98	width += sprite.width + this.spacing;	×
UNCOV 99	height = Math.max(height, sprite.height);	×
100	}
UNCOV 101	return BoundingBox.fromDimension(width * this.scale.x, height * lines.length * this.scale.y, Vector.Zero);	×
102	}
103
104	protected _drawImage(ex: ExcaliburGraphicsContext, x: number, y: number, maxWidth?: number): void {
UNCOV 105	let xCursor = 0;	×
UNCOV 106	let yCursor = 0;	×
UNCOV 107	let height = 0;	×
UNCOV 108	const lines = this._getLinesFromText(this._text, maxWidth);	×
UNCOV 109	for (const line of lines) {	×
UNCOV 110	for (const sprite of this._getCharacterSprites(line)) {	×
111	// draw it in the right spot and increase the cursor by sprite width
UNCOV 112	sprite.draw(ex, x + xCursor, y + yCursor);	×
UNCOV 113	xCursor += sprite.width + this.spacing;	×
UNCOV 114	height = Math.max(height, sprite.height);	×
115	}
UNCOV 116	xCursor = 0;	×
UNCOV 117	yCursor += this.lineHeight ?? height;	×
118	}
119	}
120
121	render(ex: ExcaliburGraphicsContext, text: string, _color: any, x: number, y: number, maxWidth?: number) {
122	// SpriteFont doesn't support _color, yet...
UNCOV 123	this._text = text;	×
UNCOV 124	const bounds = this.measureText(text, maxWidth);	×
UNCOV 125	this.width = bounds.width;	×
UNCOV 126	this.height = bounds.height;	×
UNCOV 127	if (this.shadow) {	×
UNCOV 128	ex.save();	×
UNCOV 129	ex.translate(this.shadow.offset.x, this.shadow.offset.y);	×
UNCOV 130	this._preDraw(ex, x, y);	×
UNCOV 131	this._drawImage(ex, 0, 0, maxWidth);	×
UNCOV 132	this._postDraw(ex);	×
UNCOV 133	ex.restore();	×
134	}
135
UNCOV 136	this._preDraw(ex, x, y);	×
UNCOV 137	this._drawImage(ex, 0, 0, maxWidth);	×
UNCOV 138	this._postDraw(ex);	×
139	}
140
141	clone(): SpriteFont {
UNCOV 142	return new SpriteFont({	×
143	alphabet: this.alphabet,
144	spriteSheet: this.spriteSheet,
145	spacing: this.spacing
146	});
147	}
148
149	/**
150	* Return array of lines split based on the \n character, and the maxWidth? constraint
151	* @param text
152	* @param maxWidth
153	*/
154	private _cachedText?: string;
155	private _cachedLines?: string[];
156	private _cachedRenderWidth?: number;
157	private _getLinesFromText(text: string, maxWidth?: number) {
UNCOV 158	if (this._cachedText === text && this._cachedRenderWidth === maxWidth && this._cachedLines?.length) {	×
UNCOV 159	return this._cachedLines;	×
160	}
161
UNCOV 162	const lines = text.split('\n');	×
163
UNCOV 164	if (maxWidth == null) {	×
UNCOV 165	return lines;	×
166	}
167
168	// If the current line goes past the maxWidth, append a new line without modifying the underlying text.
UNCOV 169	for (let i = 0; i < lines.length; i++) {	×
UNCOV 170	let line = lines[i];	×
UNCOV 171	let newLine = '';	×
172	// Note: we subtract the spacing to counter the initial padding on the left side.
UNCOV 173	if (this.measureText(line).width > maxWidth) {	×
UNCOV 174	while (this.measureText(line).width > maxWidth) {	×
UNCOV 175	newLine = line[line.length - 1] + newLine;	×
UNCOV 176	line = line.slice(0, -1); // Remove last character from line	×
177	}
178
179	// Update the array with our new values
UNCOV 180	lines[i] = line;	×
UNCOV 181	lines[i + 1] = newLine;	×
182	}
183	}
184
UNCOV 185	this._cachedText = text;	×
UNCOV 186	this._cachedLines = lines;	×
UNCOV 187	this._cachedRenderWidth = maxWidth;	×
188
UNCOV 189	return lines;	×
190	}
191	}

excaliburjs / Excalibur / 14804036802

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous