← All ideas

Improve Node-Editor Tooltips!

Image

The Problem

If you have been using the Blender node editors for a while, you might have encountered this before: Image Image In fact, you might have seen it all over the place. That is because it's the go-to tooltip for (almost) every single value input field in the node editor.

In my point of view, this tooltip has pretty much no informational value whatsoever. It might aswell not be there.

Goals

  • Make the tooltips unique for all input fields and sockets.
  • Make the Tooltips more valuable and easier to understand

Current Example

Let's look at a node with a lot of potentially helpful tooltips and how it looks today. The Principled BSDF node comes with 25 "lines" of information. 1 output socket, 2 list dropdowns and 23 input sockets. Image As we can see there is one helpful unique tooltip, 19 generic tooltips about input values and 5 "lines" have no tooltip at all.

Proposal

Make the tooltips unique for all node input fields and sockets and add a description that is truly valuable for the user.

image This is just a quick example, the exact nature and content of those tooltips would need to be edited and designed with care.

My main proposal is this:

  • Unique tooltips for input fields
  • Unique tooltips for all sockets

I understand that this proposal probably won't work with how Blenders nodes are coded at the moment. However I want to start a discussion if there would be any viable way of getting more use out of those tooltips.

Additional ideas

  • Node group input tooltips editable via node properties
  • Node group input types with easier data type changing (integers, booleans, ranged sliders etc.)
  • Bigger node tooltip-trigger areas, tooltips for non-input-field areas (see below)

Image

Screenshot 2020-12-23 193920.png

98.7%

Development Status: Done

Upvote 75 Downvote 1
M.Luellau
24 Dec 2020

9 Comments

I would also be willing to help filling out the blanks! Maybe we could set up a google doc or similar to collect and revise all of the descriptions?

17
Blender_Defender

* @Alexander Mitzkus * Here it is! I've made the basic structure for making a complete collection of tooltip suggestions.

Greetings,

Blender Defender

6
Blender_Defender

* @Alexander Mitzkus * Update: Everyone can collaborate, but please edit this doc in the "Request Changes"-Mode. Thank you!

6
filipkratky

I created a patch containing all the tooltips. I mainly went off of the manual and my own gutt so if you guys would like to go in and suggest changes, that would be fantastic. D14866

lukas.stockner

I've created a patch for socket tooltip support - this doesn't contain any actual tooltip text yet, just the underlying framework for being able to show them at all.

You can find it at developer.blender.org/D9967

One relevant feature is that the tooltips support having different text depending on current settings in the node, which might be important for some of the more complex nodes.

6
Blender_Defender

* @Lukas Stockner * Cool! Two questions:

  1. How can I download and Merge the patch to try it out?
  2. Where will the Tooltips be defined? (e. g. Would the tooltips of the ambient occlusion node be defined in "\source\blender\nodes\shader\nodes\node_shader_ambient_occlusion.c\line25-27" ?) I'm very new to Blenders Source Code and I'd like to understand it to help with Blender Development someday.

Greetings,

Blender Defender

3
pablovazquez

Feels so good marking this one as done! <3

1
sebbosebbo267

In general sounds good ..Maybe links to a local offline and online Manual explaining this the deeper I would love...But blender manual is often again a on setence solution but this is other topic...thx