[Diagram Editor] Display text for operations

[mxgrey]

Currently nodes display the name of the builder, but I think it would be better to show a "display text" which may be more user-friendly. Alongside id and Builder we would have a Display Text editable field into which users can type any string they want.

Whatever users put into Display Text is what we would display prominently on the node widget in the diagram. The node builder registry has a default_display_text field that we can use to populate Display Text as soon as the user selects a builder. Perhaps we can also display the name of the builder as smaller subtext on the node if custom display text is being used.

For other operations like Fork Result, Fork Clone, etc, we might not need to display any text. The symbol alone may be enough. But we could still provide an editable Display Text field for users to put in a display name if they want one. Perhaps they would want to put some custom text on the operation to make its purpose clear or to distinguish it from other instances of the same operation.

[koonpeng]

Display text is now used when possible, for operations other than nodes and sections, bevy_impulse needs to support display text for them first.

[mxgrey]

Thanks for adding in the display of the default display text, but there still isn't a way to customize the display text on each node instance. Here's an example:

Rather than just calling every node gRPC Request it would be helpful if I can customize the display text on each one to say what it's doing, e.g. "Move to Place", "Open Door", "Localize". Those might all be gRPC requests, but I want them each to be labeled differently in the visual editor.

If ReactFlow allows it, it might be nice to edit this text directly on the diagram block instead of in the pop-up window that the rest of the node configuration is edited in. But if that's not feasible, then editing it in the pop-up is also okay.

[koonpeng]

If ReactFlow allows it, it might be nice to edit this text directly on the diagram block instead of in the pop-up window that the rest of the node configuration is edited in. But if that's not feasible, then editing it in the pop-up is also okay.

It is possible but I am against doing "inline" edits because the component for a label is different from a form. Using a text field will also cause it to eat mouse inputs which will interfere with dragging of nodes. Support for editing it from the popup form shouldn't be an issue.

[koonpeng]

Rather than just calling every node gRPC Request it would be helpful if I can customize the display text on each one to say what it's doing, e.g. "Move to Place", "Open Door", "Localize". Those might all be gRPC requests, but I want them each to be labeled differently in the visual editor.

Can you share the diagram? The label should use the first available of

1. display_text on the operation.
2. default_display_text from the node metadata
3. "Select Builder"

The caption should use the builder id/name.

[mxgrey]

Can you share the diagram?

I've enabled gh-pages for the repo, so we can look at the web-hosted editor.

The problem is we don't have a way for the user to edit the display text:

[koonpeng]

Added form to edit display text in #113. Also fixed the share link, it should now be able to share the diagram with a link https://open-rmf.github.io/bevy_impulse/?diagram=jZBdjoMwDITvYu1jSVigaMNlqgAGsiI%2Fik23CHH3ddsL9M0ez9iffMAXDQt6Cx0szIk6rbP9U7PjZes3wjzEwBhYDdHrmDAU2U%2B6x%2Ft%2Bcz5tK6HOOJFe0I6kvXVBj87O2Xr1Xqx%2BKQa4wB0zOak6KNW3KkVh9Gm1jATdcV6A2GaWMRrbNrUxRYmNKZprXRem7ZtiaK%2BmrEpEY34kHdMz95lbfLwnlOUhjijhfnPriFkEv63SB3zI6eOls3tCMmbvgtCBoI2OhHS%2F8csGj0oi8pfJzdBV53n%2BAw%3D%3D.

[mxgrey]

I think we can almost close this ticket, except I just noticed that the display text feature was not provided to buffers. Custom display text is also a high value feature for buffers so users can clearly label what the purpose of each buffer is.

Could we add this to #114 or would you rather it be done in a separate PR?

[koonpeng]

I think we can almost close this ticket, except I just noticed that the display text feature was not provided to buffers. Custom display text is also a high value feature for buffers so users can clearly label what the purpose of each buffer is.

Could we add this to #114 or would you rather it be done in a separate PR?

I would rather a separate PR, I think these 2 features are not related. Adding display text to buffers would also need changes on the backend side.

[mxgrey]

I would rather a separate PR, I think these 2 features are not related.

I figured they both touch on the buffer configuration widget so the code impacted would probably be side-by-side, but I don't mind separating the two if you prefer.

Adding display text to buffers would also need changes on the backend side.

I'm not sure what backend changes are needed. display_text is part of TraceSettings which is already present in BufferSchema. In fact I believe all diagram operation types should have trace_settings and could support display text, but nodes and buffers are probably the only ones that really matter.

[koonpeng]

I'm not sure what backend changes are needed. display_text is part of TraceSettings which is already present in BufferSchema. In fact I believe all diagram operation types should have trace_settings and could support display text, but nodes and buffers are probably the only ones that really matter.

Forgot about the display text in trace settings. There is a difference with nodes and sections in that they have a default_display_text. So I guess I will just omit it if it is not present.