UI: Enable tooltips with description for shaders #119705

Bartosz Kosiorek · 2024-03-20T17:03:42+01:00

Bartosz Kosiorek commented

2024-03-20 17:03:42 +01:00

Generic tooltips for all shaders are defined in file:
https://projects.blender.org/blender/blender/src/branch/main//source/blender/nodes/NOD_static_types.h#L22

It is displayed during Adding new Shader.

Unfortunately when we are opening existing project, is it hard to analyse (for beginners), as there is no tooltips with describtion of the Shader.
This commit adds tooltips with shader description display for a shaders.

Generic tooltips for all shaders are defined in file: https://projects.blender.org/blender/blender/src/branch/main//source/blender/nodes/NOD_static_types.h#L22 It is displayed during Adding new Shader. Unfortunately when we are opening existing project, is it hard to analyse (for beginners), as there is no tooltips with describtion of the Shader. This commit adds tooltips with shader description display for a shaders.

shader-description.png

127 KiB

❤️ 2

Bartosz Kosiorek requested review from Brecht Van Lommel 2024-03-20 17:05:30 +01:00

Bartosz Kosiorek requested review from Hans Goudey 2024-03-20 17:05:42 +01:00

Bartosz Kosiorek changed title from ~~UI: Enable tooltips for shaders~~ to WIP: UI: Enable tooltips for shaders

2024-03-20 17:06:05 +01:00

Bartosz Kosiorek requested review from Lukas Tönne 2024-03-20 17:06:57 +01:00

Bartosz Kosiorek requested review from Weizhen Huang 2024-03-21 11:50:33 +01:00

Bartosz Kosiorek force-pushed tooltip from dfcd8a0d2a to 54e6a13e6d

2024-03-22 19:40:52 +01:00

Compare

Brecht Van Lommel commented

2024-04-22 12:21:28 +02:00

I suggest to look at how sockets implement tooltips, see node_socket_add_tooltip_in_node_editor calling uiLayoutSetTooltipFunc

I suggest to look at how sockets implement tooltips, see `node_socket_add_tooltip_in_node_editor` calling `uiLayoutSetTooltipFunc`

Bartosz Kosiorek force-pushed tooltip from 54e6a13e6d to b90978166b

2024-04-22 22:24:09 +02:00

Compare

Bartosz Kosiorek changed title from ~~WIP: UI: Enable tooltips for shaders~~ to WIP: UI: Enable tooltips with description for shaders

2024-04-22 22:25:00 +02:00

Bartosz Kosiorek changed title from ~~WIP: UI: Enable tooltips with description for shaders~~ to UI: Enable tooltips with description for shaders

2024-04-22 22:26:27 +02:00

Bartosz Kosiorek commented

2024-04-22 22:27:54 +02:00

I was able to display tooltips by using UI_BTYPE_TAB instead of UI_BTYPE_LABEL.
It is working as I intended (see screenshot), including resizing and shade dragging.

Unfortunately the text is aligned at center.

The tooltips are created in function: UI_tooltip_create_from_button_or_extra_icon

I was able to display tooltips by using `UI_BTYPE_TAB` instead of `UI_BTYPE_LABEL`. It is working as I intended (see screenshot), including resizing and shade dragging. Unfortunately the text is aligned at center. The tooltips are created in function: `UI_tooltip_create_from_button_or_extra_icon`

Brecht Van Lommel commented

2024-04-23 17:49:06 +02:00

Ok, but using the same mechanism as sockets is probably still the correct solution.

Bartosz Kosiorek commented

2024-04-23 19:09:49 +02:00

Ok, but using the same mechanism as sockets is probably still the correct solution.

Unfortunately for Shader's socket, the tips are only displayed if mouse is over Socket button (like Color picker or variable picker).
If the Socket is without possible to customization (without button), the tip is not displayed.

See attached screenhot: The tooltip are displayed over Fac button. The tooltip over Shader Socket is not displayed at all.

> Ok, but using the same mechanism as sockets is probably still the correct solution. Unfortunately for Shader's socket, the tips are only displayed if mouse is over Socket button (like `Color picker` or `variable picker`). If the Socket is without possible to customization (without button), the tip is not displayed. See attached screenhot: The tooltip are displayed over `Fac` button. The tooltip over `Shader` Socket is not displayed at all.

Iliya Katushenock commented

2024-04-23 19:24:31 +02:00

Try latest main.

Bartosz Kosiorek force-pushed tooltip from b90978166b to da43a39721

2024-04-24 09:04:19 +02:00

Compare

Bartosz Kosiorek force-pushed tooltip from da43a39721 to 70a049ac2b

2024-04-24 09:43:57 +02:00

Compare

Bartosz Kosiorek commented

2024-04-24 09:50:44 +02:00

I managed to implement it with UI_BTYPE_LABEL, and it is working perfectly fine. Thanks @brecht @mod_moder

Unfortunately, not all nodes have descriptions (Composite. Texture Nodes, etc.).
In next PR-s I would like to add descriptions to such nodes, and add warning/assertion if any node have empty description. I think it will improve quality of User Interface.

I managed to implement it with `UI_BTYPE_LABEL`, and it is working perfectly fine. Thanks @brecht @mod_moder Unfortunately, not all nodes have descriptions (Composite. Texture Nodes, etc.). In next PR-s I would like to add descriptions to such nodes, and add warning/assertion if any node have empty description. I think it will improve quality of User Interface.

node-tooltips.png

19 KiB

Iliya Katushenock added this to the Nodes & Physics project 2024-04-24 11:25:38 +02:00

Iliya Katushenock added the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

UI: Enable tooltips with description for shaders #119705