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.

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

Conversation

singlecoder
Copy link
Member

@singlecoder singlecoder commented Jul 31, 2024

Summary by CodeRabbit

  • New Features

    • Introduced customizable letter spacing in the text rendering, allowing for improved visual layout of text.
    • Enhanced text layout calculations to account for letter spacing, leading to more aesthetically pleasing text displays.
  • Documentation

    • Updated documentation comments for clarity regarding letter spacing functionality.

Copy link

coderabbitai bot commented Jul 31, 2024

Walkthrough

The recent updates to the TextRenderer and TextUtils classes introduce enhanced letter spacing capabilities in text rendering. A new property for letter spacing allows developers to fine-tune the space between letters, improving the visual layout of rendered text. Adjustments in the rendering logic and layout calculations ensure that letter spacing is consistently applied, resulting in a more pleasing and customizable text appearance.

Changes

File Change Summary
.../TextRenderer.ts Added _letterSpacing property with getter and setter; adjusted rendering logic to incorporate letter spacing in character positioning calculations.
.../TextUtils.ts Introduced letterSpacing variable affecting layout calculations for line and word widths; ensured letter spacing is integrated into text wrapping.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant TextRenderer
    participant TextUtils

    Developer->>TextRenderer: Set letterSpacing(value)
    TextRenderer-->>TextRenderer: Update _letterSpacing
    TextRenderer->>TextUtils: Calculate text layout with letter spacing
    TextUtils-->>TextUtils: Adjust lineWidth and wordWidth
    TextUtils->>TextRenderer: Render text with updated spacing
Loading

🐰 In the meadow where I hop and play,
I found some changes bright as day!
Letter spacing, oh what a treat,
Makes words dance and look so neat!
With every letter, a space to breathe,
In my text garden, joy we weave! 🌼✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f6d954 and be1ba72.

Files selected for processing (2)
  • packages/core/src/2d/text/TextRenderer.ts (5 hunks)
  • packages/core/src/2d/text/TextUtils.ts (8 hunks)
Additional context used
Biome
packages/core/src/2d/text/TextUtils.ts

[error] 238-238: Using this in a static context can be confusing.

this refers to the class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

Additional comments not posted (21)
packages/core/src/2d/text/TextUtils.ts (16)

112-112: LGTM!

The introduction of the letterSpacing variable is consistent with the rest of the code.


159-159: LGTM!

The adjustment to subtract letterSpacing from lineWidth ensures that the rendered text respects the specified spacing between letters.


183-183: LGTM!

The integration of letterSpacing into the line width calculation is consistent with the logic of handling letter spacing uniformly.


192-192: LGTM!

Adding letterSpacing to charInfo.xAdvance ensures that the spacing is uniformly applied throughout the text rendering process.


198-198: LGTM!

Adding letterSpacing to charInfo.xAdvance in the else block ensures that the spacing is uniformly applied throughout the text rendering process.


205-205: LGTM!

The adjustment to subtract letterSpacing from lineWidth ensures that the rendered text respects the specified spacing between letters.


220-220: LGTM!

Adding letterSpacing to charInfo.xAdvance in the word handling logic ensures that the spacing is uniformly applied throughout the text rendering process.


225-225: LGTM!

Adding letterSpacing to charInfo.xAdvance in the else block of the word handling logic ensures that the spacing is uniformly applied throughout the text rendering process.


237-237: LGTM!

The adjustment to subtract letterSpacing from lineWidth ensures that the rendered text respects the specified spacing between letters.


245-245: LGTM!

The adjustment to subtract letterSpacing from wordWidth ensures that the rendered text respects the specified spacing between letters.


259-259: LGTM!

The adjustment to subtract letterSpacing from lineWidth ensures that the rendered text respects the specified spacing between letters.


291-291: LGTM!

The introduction of the letterSpacing variable is consistent with the rest of the code.


297-298: LGTM!

Adding letterSpacing to curWidth ensures that the spacing is uniformly applied throughout the text rendering process.


302-302: LGTM!

The integration of letterSpacing into the line width calculation is consistent with the logic of handling letter spacing uniformly.


Line range hint 573-577:
LGTM!

The integration of letterSpacing into the local data update logic ensures that the spacing is uniformly applied throughout the text rendering process.


Line range hint 639-639:
LGTM!

Adding letterSpacing to charInfo.xAdvance in the local data update logic ensures that the spacing is uniformly applied throughout the text rendering process.

packages/core/src/2d/text/TextRenderer.ts (5)

64-64: LGTM!

The introduction of the _letterSpacing variable is straightforward and consistent with the rest of the class properties.


176-176: LGTM!

The removal of the reference to "pixels" in the documentation comment for lineSpacing is appropriate and makes the comment more concise.


189-191: LGTM!

The new documentation comment for letterSpacing is clear and concise, effectively explaining its purpose.


192-201: LGTM!

The getter and setter methods for letterSpacing are implemented correctly. The setter's logic to mark the renderer as "dirty" ensures that any necessary updates are triggered in the rendering process.


573-577: LGTM!

The integration of letterSpacing into the local data update logic ensures that the spacing is uniformly applied throughout the text rendering process.

@singlecoder singlecoder linked an issue Aug 1, 2024 that may be closed by this pull request
@singlecoder singlecoder changed the base branch from dev/1.3 to main August 2, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support letter-spacing in TextRenderer
1 participant