Implement TextMesh. #60507

bruvzg · 2022-04-25T11:18:07Z

Follow up to the #60386

Implement TextMesh resource.

Implements mesh generation from the shaped text contours. Works only with the OpenType compliant dynamic fonts (without contour self-intersections, so some fonts converted by services like Google Font might fail). Will not work with bitmap fonts (regardless of font container format), e.g., color emoji fonts.

TODO:

Optimize generated mesh.
Generate a reasonable texture coordinates for the mesh.
Implement fallbacks for missing and faulty glyphs.

Test project:
test_project.zip

fire · 2022-04-25T13:36:50Z

Can you send it through the lod system?

Aka. The Meshoptimizer system? I can look into this later.

It's not so good for the mesh to be recreated every frame, but it's good for the first implementation.

If you can't generate the uvs manually, you could use xatlas.

Calinou · 2022-04-25T21:09:37Z

I gave it a try 🙂

Testing project: test_textmesh.zip

Some comments:

Text is left-aligned by default, as alignment options aren't implemented yet.
Spaces aren't rendered yet – the text will look like as if there are no spaces.
The mesh fails to generate with an error message if you edit the text property to make it an empty string again. Due to this, the last character that was present in the text property will also remain visible.
Generating the mesh can take a lot of time, which can cause stuttering if the text changes during gameplay. The longer the text, the more noticeable this is. Increasing Curve Step in the TextMesh resource can improve mesh generation performance a lot (at the cost of worse curve quality).
- I'm not sure if we can fully resolve this issue (given that uploading new meshes to the GPU will always take some time). Caching individual glyph triangles for each font might help a little.
- For people looking to create 3D timers in the game world, we can probably document a way to do this with several MeshInstance3D nodes. This can be done by creating 10 MeshInstance3D nodes per digit (with all numbers in advance), and toggling the nodes' visibility at run-time. This should avoid performance caveats related to run-time mesh generation.
As an optimization, generating triangles on the side of the text can be skipped if depth is nearly equal to 0.
Property hints for curve_step and depth should be added.
- Setting curve_step to 0 causes the engine to freeze. Values below 0.1 take a very long time to generate the mesh (even with only a few characters), so I'd limit the value between 0.2 and 10.
- Negative depth values don't seem to behave correctly, so I'd prevent using them.

We should also look to compile some use cases for TextMesh (and where Label3D isn't a good fit). Label3D is a powerful node already, and we should be careful not to have feature creep in this aspect of the engine.

anderlli0053 · 2022-04-27T01:43:27Z

Can this be ported to 3.x?

bruvzg · 2022-04-27T07:16:17Z

Added glyph data caching (local only), it should be much faster (the slowest part is convex decomposition). Now mesh generation in the TextMesh should account only 10% of the mesh update time (Another 10% is taken by base Mesh update, and the rest by the RenderingServer).
Added alignment property.
Empty string and spaces should be fixed, and missing glyph replaced with quads.
Added property tags for curve step and depth.
Removed side and back faces generation when depth is zero.

Aka. The Meshoptimizer system? I can look into this later.

Not sure if it's necessary, with the reasonable curve step it should be good as is.

If you can't generate the uvs manually, you could use xatlas.

It's probably a bit of overkill to use full unwrap, something simple and applicable to any text without changing the texture probably is a more useful as a default and should cover most cases. So currently it's using a map like this to have a possibility to texture front back and sides of text independently (front and back and for the full text, and sides to loop each contour):

But I guess adding a separate option to do unwrap on any mesh would be useful.

bruvzg · 2022-04-27T07:20:16Z

Can this be ported to 3.x?

Probably not, at least not without backporting some other stuff to the 3.x, and it won't have any of the TextServer features available.

Calinou · 2022-04-27T18:54:09Z

I tested the latest revision of this PR and can confirm the timer in the testing project now performs much better (even when it shows 4 decimals). The rotating text animation remains smooth and I still get 300+ FPS.

In practice, I'd probably limit the timer in the example to 2 decimals, but this should now be suitable for real-time use.

golddotasksquestions · 2022-04-29T10:44:07Z

You are amazing!

I just spend at least week on painstakingly trying to get dynamic 3D text mesh (mesh created in Blender letter by letter) in one of my projects in Godot 3 to write 4 words. It's super tedious and limited process and I can't imagine doing this ever again and was about to write a feature request proposal of exactly this!

Question: Will I be able to generate CollisionShape Siblings from this like I can with MeshInstances (or alternatively make this TextMesh the Mesh of a MeshInstance so I can generate the CollisionShape Siblings)?

bruvzg · 2022-04-29T10:50:17Z

Question: Will I be able to generate CollisionShape Siblings from this like I can with MeshInstances (or alternatively make this TextMesh the Mesh of a MeshInstance so I can generate the CollisionShape Siblings)?

I have not tested collisions, but it's a derivative of generic PrimitiveMesh not a fully separate Node, so it can be used as mesh of the MeshInstance3D (that's what happening in the test project), and should support everything any other mesh do.

akien-mga

The feature looks great, and the code seems fine from a quick look. Might warrant a rebase to make sure it still builds after the HashMap rewrite.

timothyqiu · 2022-05-13T02:38:52Z

The "Pixel Size" property somehow updates its character spacing in the editor preview.

It works fine if I reopen the scene.

timothyqiu · 2022-05-13T03:06:30Z

scene/resources/primitive_meshes.cpp

+	ADD_PROPERTY(PropertyInfo(Variant::STRING, "text"), "set_text", "get_text");
+	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "font", PROPERTY_HINT_RESOURCE_TYPE, "Font"), "set_font", "get_font");
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "font_size", PROPERTY_HINT_RANGE, "1,127,1"), "set_font_size", "get_font_size");
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "horizontal_alignment", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_horizontal_alignment", "get_horizontal_alignment");


Since the documentation says only left, center, and right are supported, maybe we should remove the "Fill" option here?

Fixed pixel_size not cleaning cache, added width for Fill alignment and updated docs for this and Label3D (both support Fill alignment).

Apply simulated slant and embolden to the TextServer `gont_get_glyph_contours` results.

akien-mga · 2022-05-16T11:52:59Z

Thanks!

bruvzg added enhancement usability topic:gui topic:3d labels Apr 25, 2022

bruvzg added this to the 4.0 milestone Apr 25, 2022

bruvzg mentioned this pull request Apr 25, 2022

Implement Label3D node. #60386

Merged

bruvzg force-pushed the textmesh branch 2 times, most recently from 2936982 to d3a152a Compare April 25, 2022 14:48

bruvzg force-pushed the textmesh branch 5 times, most recently from 19b3014 to d8a8734 Compare April 26, 2022 20:26

bruvzg force-pushed the textmesh branch 2 times, most recently from 56baf7f to abeef06 Compare April 27, 2022 06:50

bruvzg changed the title ~~[WIP] Implement TextMesh.~~ Implement TextMesh. Apr 27, 2022

bruvzg marked this pull request as ready for review April 27, 2022 07:20

bruvzg requested review from a team as code owners April 27, 2022 07:20

bruvzg force-pushed the textmesh branch from abeef06 to 1905340 Compare April 27, 2022 12:47

bruvzg force-pushed the textmesh branch from 1905340 to 059df73 Compare May 2, 2022 19:13

Calinou mentioned this pull request May 4, 2022

Fix PrimitiveMesh surface being unavailable immediately after creation #48176

Open

akien-mga approved these changes May 12, 2022

View reviewed changes

timothyqiu reviewed May 13, 2022

View reviewed changes

Implement TextMesh resource.

0596367

Apply simulated slant and embolden to the TextServer `gont_get_glyph_contours` results.

bruvzg force-pushed the textmesh branch from 059df73 to 0596367 Compare May 13, 2022 05:24

akien-mga merged commit b154f44 into godotengine:master May 16, 2022

bruvzg deleted the textmesh branch May 17, 2022 14:40

bruvzg mentioned this pull request May 22, 2022

Backport TextMesh and expose dynamic font vector outlines #61281

Merged

Calinou mentioned this pull request Aug 2, 2022

Add a 3D labels and texts demo godotengine/godot-demo-projects#761

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement TextMesh. #60507

Implement TextMesh. #60507

bruvzg commented Apr 25, 2022 •

edited

Loading

fire commented Apr 25, 2022 •

edited

Loading

Calinou commented Apr 25, 2022 •

edited

Loading

anderlli0053 commented Apr 27, 2022

bruvzg commented Apr 27, 2022

bruvzg commented Apr 27, 2022

Calinou commented Apr 27, 2022 •

edited

Loading

golddotasksquestions commented Apr 29, 2022 •

edited

Loading

bruvzg commented Apr 29, 2022 •

edited

Loading

akien-mga left a comment

timothyqiu commented May 13, 2022

timothyqiu May 13, 2022

bruvzg May 13, 2022

akien-mga commented May 16, 2022

Implement TextMesh. #60507

Implement TextMesh. #60507

Conversation

bruvzg commented Apr 25, 2022 • edited Loading

fire commented Apr 25, 2022 • edited Loading

Calinou commented Apr 25, 2022 • edited Loading

anderlli0053 commented Apr 27, 2022

bruvzg commented Apr 27, 2022

bruvzg commented Apr 27, 2022

Calinou commented Apr 27, 2022 • edited Loading

golddotasksquestions commented Apr 29, 2022 • edited Loading

bruvzg commented Apr 29, 2022 • edited Loading

akien-mga left a comment

Choose a reason for hiding this comment

timothyqiu commented May 13, 2022

timothyqiu May 13, 2022

Choose a reason for hiding this comment

bruvzg May 13, 2022

Choose a reason for hiding this comment

akien-mga commented May 16, 2022

bruvzg commented Apr 25, 2022 •

edited

Loading

fire commented Apr 25, 2022 •

edited

Loading

Calinou commented Apr 25, 2022 •

edited

Loading

Calinou commented Apr 27, 2022 •

edited

Loading

golddotasksquestions commented Apr 29, 2022 •

edited

Loading

bruvzg commented Apr 29, 2022 •

edited

Loading