Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support text letter spacing #2280

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Support text letter spacing #2280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3fdaa68
feat(text): support word split
singlecoder Sep 21, 2022
f278680
feat(text): fix conflicts
singlecoder Jan 29, 2023
00d0faf
feat(text): opt code
singlecoder Jan 29, 2023
3eabec6
feat(text): add letter spacing api
singlecoder Feb 13, 2023
16bafbf
fix(text): fix position error from measureTextWithWrap
singlecoder Feb 13, 2023
17710be
fix conflicts
singlecoder Feb 13, 2023
6728fdf
fix conflicts
singlecoder Feb 13, 2023
1af2127
feat(text): opt handle for space letter
singlecoder Feb 13, 2023
fc7d0c7
feat(text): fix space error
singlecoder Feb 14, 2023
cce1690
feat(text):merge code
singlecoder Feb 15, 2023
e17817c
feat(text): support letter spacing
singlecoder Feb 15, 2023
728cec1
feat(text): merge dev/1.3
singlecoder Jul 31, 2024
be1ba72
feat(text): support text letter spacing
singlecoder Jul 31, 2024
5931de9
feat: merge code from main
singlecoder Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions packages/core/src/2d/text/TextRenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ export class TextRenderer extends Renderer {
@assignmentClone
private _lineSpacing: number = 0;
@assignmentClone
private _letterSpacing: number = 0;
@assignmentClone
private _horizontalAlignment: TextHorizontalAlignment = TextHorizontalAlignment.Center;
@assignmentClone
private _verticalAlignment: TextVerticalAlignment = TextVerticalAlignment.Center;
Expand Down Expand Up @@ -171,7 +173,7 @@ export class TextRenderer extends Renderer {
}

/**
* The space between two lines (in pixels).
* The space between two lines.
*/
get lineSpacing(): number {
return this._lineSpacing;
Expand All @@ -184,6 +186,20 @@ export class TextRenderer extends Renderer {
}
}

/**
* The space between two letters.
*/
get letterSpacing(): number {
return this._letterSpacing;
}

set letterSpacing(value: number) {
if (this._letterSpacing !== value) {
this._letterSpacing = value;
this._setDirtyFlagTrue(DirtyFlag.Position);
}
}

/**
* The horizontal alignment.
*/
Expand Down Expand Up @@ -554,10 +570,11 @@ export class TextRenderer extends Renderer {
const { _pixelsPerUnit } = Engine;
const { horizontalAlignment } = this;
const pixelsPerUnitReciprocal = 1.0 / _pixelsPerUnit;
const rendererWidth = this.width * _pixelsPerUnit;
const rendererWidth = this._width * _pixelsPerUnit;
const halfRendererWidth = rendererWidth * 0.5;
const rendererHeight = this.height * _pixelsPerUnit;
const rendererHeight = this._height * _pixelsPerUnit;
const halfLineHeight = lineHeight * 0.5;
const letterSpacing = this._letterSpacing * _pixelsPerUnit;

let startY = 0;
const topDiff = lineHeight * 0.5 - lineMaxSizes[0].ascent;
Expand Down Expand Up @@ -619,7 +636,7 @@ export class TextRenderer extends Renderer {
j === firstRow && (minX = Math.min(minX, left));
maxX = Math.max(maxX, right);
}
startX += charInfo.xAdvance + charInfo.offsetX;
startX += charInfo.xAdvance + charInfo.offsetX + letterSpacing;
}
}
startY -= lineHeight;
Expand Down
21 changes: 15 additions & 6 deletions packages/core/src/2d/text/TextUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ export class TextUtils {
const pixelsPerUnit = Engine._pixelsPerUnit;
const lineHeight = fontSizeInfo.size + renderer.lineSpacing * pixelsPerUnit;
const wrapWidth = renderer.width * pixelsPerUnit;
const letterSpacing = renderer.letterSpacing * pixelsPerUnit;
let textWidth = 0;

subFont.nativeFontString = fontString;
Expand Down Expand Up @@ -155,6 +156,7 @@ export class TextUtils {
if (lineWidth + wordWidth > wrapWidth) {
// Push if before line is not empty
if (lineWidth > 0) {
lineWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, line, lineWidth, lineMaxAscent, lineMaxDescent);
}

Expand All @@ -178,6 +180,7 @@ export class TextUtils {
// Handle char
// At least one char in a line
if (lineWidth + w > wrapWidth && lineWidth > 0) {
lineWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, line, lineWidth, lineMaxAscent, lineMaxDescent);
textWidth = Math.max(textWidth, lineWidth);
notFirstLine = true;
Expand All @@ -186,19 +189,20 @@ export class TextUtils {
lineWidth = lineMaxAscent = lineMaxDescent = 0;
} else {
line = char;
lineWidth = charInfo.xAdvance;
lineWidth = charInfo.xAdvance + letterSpacing;
lineMaxAscent = ascent;
lineMaxDescent = descent;
}
} else {
line += char;
lineWidth += charInfo.xAdvance;
lineWidth += charInfo.xAdvance + letterSpacing;
lineMaxAscent = Math.max(lineMaxAscent, ascent);
lineMaxDescent = Math.max(lineMaxDescent, descent);
}
} else {
if (wordWidth + charInfo.w > wrapWidth) {
if (lineWidth > 0) {
lineWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, line, lineWidth, lineMaxAscent, lineMaxDescent);
textWidth = Math.max(textWidth, lineWidth);
line = "";
Expand All @@ -213,12 +217,12 @@ export class TextUtils {
textWidth = Math.max(textWidth, wordWidth);
notFirstLine = true;
word = char;
wordWidth = charInfo.xAdvance;
wordWidth = charInfo.xAdvance + letterSpacing;
wordMaxAscent = ascent;
wordMaxDescent = descent;
} else {
word += char;
wordWidth += charInfo.xAdvance;
wordWidth += charInfo.xAdvance + letterSpacing;
wordMaxAscent = Math.max(wordMaxAscent, ascent);
wordMaxDescent = Math.max(wordMaxDescent, descent);
}
Expand All @@ -230,13 +234,15 @@ export class TextUtils {
if (lineWidth + wordWidth > wrapWidth) {
// Push chars to a single line
if (lineWidth > 0) {
lineWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, line, lineWidth, lineMaxAscent, lineMaxDescent);
}
textWidth = Math.max(textWidth, lineWidth);

lineWidth = 0;
// Push word to a single line
if (wordWidth > 0) {
wordWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, word, wordWidth, wordMaxAscent, wordMaxDescent);
}
textWidth = Math.max(textWidth, wordWidth);
Expand All @@ -250,6 +256,7 @@ export class TextUtils {
}

if (lineWidth > 0) {
lineWidth -= letterSpacing;
this._pushLine(lines, lineWidths, lineMaxSizes, line, lineWidth, lineMaxAscent, lineMaxDescent);
textWidth = Math.max(textWidth, lineWidth);
}
Expand Down Expand Up @@ -281,16 +288,18 @@ export class TextUtils {
const lineMaxSizes = new Array<FontSizeInfo>();
const { _pixelsPerUnit } = Engine;
const lineHeight = fontSizeInfo.size + renderer.lineSpacing * _pixelsPerUnit;
const letterSpacing = renderer.letterSpacing * _pixelsPerUnit;

let width = 0;
subFont.nativeFontString = fontString;
for (let i = 0; i < textCount; ++i) {
const line = subTexts[i];
let curWidth = 0;
const lineLength = line.length;
let curWidth = lineLength > 1 ? letterSpacing * (lineLength - 1) : 0;
let maxAscent = 0;
let maxDescent = 0;

for (let j = 0, m = line.length; j < m; ++j) {
for (let j = 0; j < lineLength; ++j) {
const charInfo = TextUtils._getCharInfo(line[j], fontString, subFont);
curWidth += charInfo.xAdvance;
const { offsetY } = charInfo;
Expand Down
Loading