Polish text bitecs #5933

takahirox · 2023-02-07T22:31:03Z

This commit pilishes text bitecs. The changes are

Rename Text component to TextTag to avoid the confliction with the WebAPI Text
Rewrite inflators/text from JavaScript to TypeScript
Explicitly declare text inflator params
Add Text system that calls sync() and remove sync() calls from other systems
Update type/troika-three-text.d.ts to match the troika-three-text API
Fix some bugs

johnshaughnessy

Nice work! Thanks for adding all of the type infos

johnshaughnessy · 2023-02-07T22:33:25Z

src/inflators/text.ts

+  lineHeight?: number | "normal";
+  maxWidth?: number;
+  opacity?: number;
+  outlineBlur?: number | `${number}%`;


I've never seen this type definition before. What does ${number}% mean?

It might be similar to regex. (If I understand correctly) ${number}% means number string that ends with "%", like "25%" or "0.5%".

https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html#handbook-content
https://stackoverflow.com/questions/51445767/how-to-define-a-regex-matched-string-type-in-typescript

I didn't know about this before. Thanks!

Didn't know that was supported either. Neat!

johnshaughnessy · 2023-02-08T19:22:02Z

src/inflators/text.ts

+  text.strokeWidth = params.strokeWidth!;
+  text.textAlign = params.textAlign!;
+  text.textIndent = params.textIndent!;
+  text.whiteSpace = params.whiteSpace!;


As we discussed, we might be able to get rid of the !s by defining two types:

OptionalTextParams where each of the properties is optional and TextParams where each property is required.

The function signature becomes:

export function inflateText(world: HubsWorld, eid: number, params: OptionalTextParams) {

The defaults become

const DEFAULTS: TextParams = {

And in the body of the inflator we write:

const finalParams : TextParams = Object.assign({}, DEFAULTS, params)

I experimented. It works (type check passes).

But some disadvantages.

Many duplicated type declaration

We need to carefully manage that type declarations are synched. Even if types are different between them (ex: string / number) type check didn't catch.

So, I would like to suggest to experiment more to improve the idea, and make another PR for it.

Typescript has a generic utility type to make all the fields of a type optional (or required) https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype - Worth looking through the other types in that doc too just to know what tools are available.

So we could either do:

export function inflateText(world: HubsWorld, eid: number, params: Partial<TextParams>) {

or

const finalParams = Object.assign({}, DEFAULTS, params) as Required<TextParams>;

(I think the Partial one is more natural)

netpro2k

LGTM. Thanks for cleaning that up!

netpro2k · 2023-02-14T02:44:30Z

src/bit-systems/text.ts

+    // sync() checks whether to invoke costly processing
+    // inside.
+    //
+    // sync() call can happen one frame after that text


We choose when to run this system, I think we should just enforce this guarantee.

netpro2k · 2023-02-14T02:47:29Z

src/bit-systems/text.ts

+    // a big deal because what sync() invokes is async
+    // processing.
+    //
+    // Question: Is it safe even if text object is


This query won't match on removed entities, and the text wont be disposed of until the removeObejct3dSystem runs (or in this system once we refactor where we do cleanup). So it should always be safe to call this. I assume TriokaText takes care of disposing of any in flight rendering when you dispose of a text.

netpro2k · 2023-02-14T02:48:23Z

src/inflators/text.ts

+  value: string;
+  anchorX?: "left" | "center" | "right";
+  anchorY?: "top" | "top-baseline" | "top-cap" | "top-ex" | "middle" | "bottom-baseline" | "bottom";
+  clipRect?: [number, number, number, number] | null;


does this need to support both null and undefined?

Doesn't "?" imply that accepts undeinfed?

netpro2k · 2023-02-14T02:50:16Z

src/inflators/text.ts

+
+// Defaults values must be set for all the optional properties
+// to safely use foo! operator in the inflator.
+const DEFAULTS: TextParams = {


What I like about using Partial/Required as discussed below is this would be type checked for us so we couldn't accidentally miss a default value.

netpro2k · 2023-02-14T02:52:40Z

src/systems/hubs-systems.ts

@@ -245,7 +246,8 @@ export function mainTick(xrFrame: XRFrame, renderer: WebGLRenderer, scene: Scene
  hubsSystems.gainSystem.tick();
  hubsSystems.nameTagSystem.tick();
  simpleWaterSystem(world);
-
+  textSystem(world);


Its very crude but we may want to add a blank line above this system to make it clear its a bit "special". Or maybe better to just add a comment like // all systems that update text properties should run before this

This commit polishes text bitecs. The changes are * Rename Text component to TextTag to avoid the confliction with the WebAPI Text * Rewrite inflators/text from JavaScript to TypeScript * Explicitly declare text inflator params * Add Text system that calls sync() and remove sync() calls from other systems * Update type/troika-three-text.d.ts to match the troika-three-text API * Fix some bugs

takahirox requested review from netpro2k and johnshaughnessy February 7, 2023 22:31

takahirox mentioned this pull request Feb 7, 2023

BitECS Component Burndown #5899

Open

50 tasks

johnshaughnessy approved these changes Feb 7, 2023

View reviewed changes

takahirox had a problem deploying to hc-bio February 7, 2023 22:36 — with GitHub Actions Failure

takahirox force-pushed the BitECSText branch 2 times, most recently from 5baf4e2 to 01658cd Compare February 7, 2023 22:43

takahirox had a problem deploying to hc-bio February 7, 2023 22:48 — with GitHub Actions Failure

takahirox force-pushed the BitECSText branch from 01658cd to 68f0ed9 Compare February 7, 2023 23:59

takahirox had a problem deploying to hc-bio February 8, 2023 00:05 — with GitHub Actions Failure

takahirox force-pushed the BitECSText branch from 68f0ed9 to 8f599e5 Compare February 8, 2023 18:32

takahirox had a problem deploying to hc-bio February 8, 2023 18:39 — with GitHub Actions Failure

johnshaughnessy approved these changes Feb 8, 2023

View reviewed changes

takahirox force-pushed the BitECSText branch from 8f599e5 to df0addd Compare February 8, 2023 18:47

takahirox had a problem deploying to hc-bio February 8, 2023 18:53 — with GitHub Actions Failure

johnshaughnessy reviewed Feb 8, 2023

View reviewed changes

takahirox force-pushed the BitECSText branch from df0addd to e602f0e Compare February 8, 2023 21:30

takahirox had a problem deploying to hc-bio February 8, 2023 21:38 — with GitHub Actions Failure

takahirox force-pushed the BitECSText branch from e602f0e to ca371b5 Compare February 9, 2023 01:09

takahirox had a problem deploying to hc-bio February 9, 2023 01:15 — with GitHub Actions Failure

takahirox force-pushed the BitECSText branch from ca371b5 to 11a020f Compare February 13, 2023 19:22

takahirox had a problem deploying to hc-bio February 13, 2023 19:28 — with GitHub Actions Failure

netpro2k reviewed Feb 14, 2023

View reviewed changes

johnshaughnessy mentioned this pull request Feb 16, 2023

bitecs audio-zone-system & audio-debug-system #5944

Merged

takahirox force-pushed the BitECSText branch from 11a020f to cdd0a87 Compare March 15, 2023 00:02

takahirox had a problem deploying to smoke March 15, 2023 00:08 — with GitHub Actions Failure

takahirox had a problem deploying to hc-bio March 15, 2023 00:08 — with GitHub Actions Failure

takahirox added 2 commits March 14, 2023 19:54

Reflect the review comments

00bbdb4

takahirox force-pushed the BitECSText branch from cdd0a87 to 00bbdb4 Compare March 15, 2023 02:56

takahirox had a problem deploying to smoke March 15, 2023 03:03 — with GitHub Actions Failure

takahirox had a problem deploying to hc-bio March 15, 2023 03:03 — with GitHub Actions Failure

takahirox merged commit 5398021 into master Mar 15, 2023

takahirox deleted the BitECSText branch March 15, 2023 05:15

takahirox mentioned this pull request Apr 6, 2023

Add text inflator to glTF #6023

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Polish text bitecs #5933

Polish text bitecs #5933

takahirox commented Feb 7, 2023

johnshaughnessy left a comment

johnshaughnessy Feb 7, 2023

takahirox Feb 7, 2023

johnshaughnessy Feb 8, 2023 •

edited

Loading

netpro2k Feb 14, 2023

johnshaughnessy Feb 8, 2023

takahirox Feb 9, 2023 •

edited

Loading

netpro2k Feb 14, 2023

netpro2k left a comment

netpro2k Feb 14, 2023

netpro2k Feb 14, 2023

netpro2k Feb 14, 2023

takahirox Mar 14, 2023

netpro2k Feb 14, 2023

netpro2k Feb 14, 2023

Polish text bitecs #5933

Polish text bitecs #5933

Conversation

takahirox commented Feb 7, 2023

johnshaughnessy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnshaughnessy Feb 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirox Feb 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netpro2k left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnshaughnessy Feb 8, 2023 •

edited

Loading

takahirox Feb 9, 2023 •

edited

Loading