Tooltips from component classes #327

Spiderguy-F · 2025-03-24T13:08:36Z

What?

Adds tooltips to the add hubs component operator

Why?

Feature request

Examples

Any hubs component on scene, objects or bones.

How to test

Hover with your mouse over an Add Component button and then over one of the components that can be added from the menu.

Open questions

I'm not a native speaker and am not sure if I described all components accurately. Feedback / corrections are appreciated.

DougReeder

LGTM, but does class Networked(HubsComponent) or class VideoTextureTarget(HubsComponent) need a tooltip?

addons/io_hubs_addon/components/definitions/audio_source.py

addons/io_hubs_addon/components/definitions/frustrum.py

addons/io_hubs_addon/components/definitions/media_frame.py

DougReeder · 2025-03-27T15:44:13Z

Some of the tooltips are written in terms of adding something to the scene and some aren't. I am fine with merging this as-is, but it might be nice to write all the tooltips one way or the other.

Exairnous

@Spiderguy-F
Thank you! This will really help a lot. I've added comments/suggestions/corrections.
These suggestions/corrections hopefully bring the tooltips in line with https://developer.blender.org/docs/features/interface/human_interface_guidelines/tooltips/ correct some inaccuracies, and make sure everything is consistent.

Also, the tooltip for the Video Texture Target component is missing.

Note: some of my suggestions could probably be further improved. If you or anyone has better wording, please suggest it.

@DougReeder
The Networked component won't need a tooltip because it can't be manually added, but the Video Texture Target should have one.

Some of the tooltips are written in terms of adding something to the scene and some aren't. I am fine with merging this as-is, but it might be nice to write all the tooltips one way or the other.

I agree that the tooltips should be kept as consistent as possible and I'm thinking that it mostly shouldn't reference adding again since we are already in the process of adding a Hubs component.

@Heather-Elizabeth-Dodds
Can you also take a look at this pull request, please?

Finally:
Since there are a couple files missing from the pull request at this time, I'll leave my suggestions for their tooltips here:
Audio:
'tooltip': 'Display an audio player that plays a file from a URL'

Video Texture Target:
'tooltip': 'Display video from the corresponding video texture source. A virtual screen'

addons/io_hubs_addon/components/definitions/ammo_shape.py

addons/io_hubs_addon/components/definitions/audio_settings.py

Exairnous · 2025-04-01T08:33:12Z

addons/io_hubs_addon/components/definitions/link.py

        'deps': ['networked'],
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Create an interactable hyperlink'


Suggested change

'tooltip': 'Create an interactable hyperlink'

'tooltip': 'Display a preview of a website or Hubs asset that can be interacted with (behavior depends on the type of link). This can be combined with other components to override the auto-generated preview'

'Display a preview of interactive website or Hubs asset. If combined with other components, overrides auto-generated preview.'

Exairnous · 2025-04-01T08:45:52Z

addons/io_hubs_addon/components/definitions/directional_light.py

        'icon': 'LIGHT_SUN',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'A light that emits parallel light in a specific direction, like the sun',


Suggested change

'tooltip': 'A light that emits parallel light in a specific direction, like the sun',

'tooltip': 'Emit parallel light in a specific direction, like the sun',

I'm really torn on this clause, "like the sun", because I think of that as object in space emitting light in all directions. I realize THIS is comparing to what the sun feels like on Earth though. What about adding a bit more?

'Emit parallel light in a specific direction, like how the sun's rays appear on Earth'

Exairnous · 2025-04-02T05:16:35Z

addons/io_hubs_addon/components/definitions/morph_audio_feedback.py

        'icon': 'MOD_SMOOTH',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Control a shapekey for an avatar based on mic volume'


Suggested change

'tooltip': 'Control a shapekey for an avatar based on mic volume'

'tooltip': 'Use the user's transmitted audio to animate a shape key on the avatar'

'User transmitted audio animates an avatar shape key'

Since an avatar can have many shape keys and this only modifies one, I'd suggest:
"Use the user's transmitted audio to animate a shape key of the avatar"

Blender notes said to avoid the word "Use" (and enable, active, and is) because they could be confused with Boolean operators.

I say, "pah"! Let's go with use. I think it fits in this case. :)

addons/io_hubs_addon/components/definitions/loop_animation.py

Exairnous · 2025-04-04T09:48:08Z

addons/io_hubs_addon/components/definitions/mirror.py

        'icon': 'MOD_MIRROR',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Add a mirror plane to the room'


Suggested change

'tooltip': 'Add a mirror plane to the room'

'tooltip': 'Display a virtual, planar, mirror that will give a live reflection of avatars, in-room objects, and the environment'

Probably don't need that second comma.

Clarification: I meant the comma after "planar". Sorry! Can we remove that one and add back in the Oxford comma after objects? @Spiderguy-F

Exairnous · 2025-04-04T09:50:20Z

addons/io_hubs_addon/components/definitions/model.py

        'deps': ['networked'],
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Load a 3D model (glb) from a URL'


Suggested change

'tooltip': 'Load a 3D model (glb) from a URL'

'tooltip': 'Display a 3D model (glb) from a URL'

Nice. Short. Sweet. To the point.

Exairnous · 2025-04-04T09:50:59Z

addons/io_hubs_addon/components/definitions/nav_mesh.py

        'version': (1, 0, 1),
-        'deps': ['visible']
+        'deps': ['visible'],
+        'tooltip': 'Define the area where avatars can walk'


Suggested change

'tooltip': 'Define the area where avatars can walk'

'tooltip': 'Designate this as the mesh that determines where avatars can walk'

A little wordy but I don't think it can be trimmed without losing some meaning.

I think "Area" is more user friendly, the concept of marking an area by creating a mesh is a bit abstract, if you're not familiar with the concept.

@Spiderguy-F Potentially, but the component has to be added to a mesh, so if they aren't familiar with the concept already they're going to need to learn it 🙂

Exairnous · 2025-04-04T09:52:21Z

addons/io_hubs_addon/components/definitions/point_light.py

        'icon': 'LIGHT_POINT',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'A punctual light source that emits light in all directions',


Suggested change

'tooltip': 'A punctual light source that emits light in all directions',

'tooltip': 'Emit light in all directions from a single point'

hobbs-Hobbler · 2025-04-06T15:50:35Z

I'm not done reviewing but I keep making comments about using plural forms of verbs. I'll go check that before I finish. [EDIT] I find two examples on the Blender Developer Tooltips using singular verb forms:

Do: "Show in Viewport"

and
Don't: "Enables snapping during transform"
Do: "Snap during transform"

Therefore, I'll go back and edit my comments to the singular tense.

[EDIT 2] Done.
Most comments are very minor. Often the same thing can be said with just as few words as the first way. So any suggested changes are MOSTLY cosmetic. However, did strive for brevity and elimnated use of 'you' and 'your'.

Bonus points: I didn't really know what some of these buttons did, so it was great to learn.

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

Co-authored-by: Exairnous <[email protected]>

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

Exairnous

@Heather-Elizabeth-Dodds I left a few comments on your comments. Aside from the few things I pointed out, I'm okay with your suggestions for my suggestions. Although you do seem to have cut out a number of my articles (a, the, etc.) in what looks like an attempt to make the tooltips as short as possible?

Exairnous · 2025-04-08T09:50:44Z

addons/io_hubs_addon/components/definitions/link.py

        'deps': ['networked'],
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Display a preview of interactive website or Hubs asset. If combined with other components, overrides auto-generated preview.'


@Heather-Elizabeth-Dodds This is slightly incorrect now. It's not the website or asset that's interactive (they may or may not be), but the link itself, e.g. if you click on the link it will open a website in a new tab, change your avatar, change the scene, etc. Also, the link doesn't override the auto-generated preview, it's the other components that will override the link's auto-generated preview.

Exairnous · 2025-04-08T10:01:03Z

addons/io_hubs_addon/components/definitions/reflection_probe.py

        'icon': 'MATERIAL',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'A reflection probe is a type of light probe that captures the environment around it and uses that information to create reflections on objects in the scene',


This isn't quite right. The first sentence is okay (though it feels a bit weird not to be mentioning reflections directly). But for the second sentence, it's actually the other way around; the environment is baked into an image to use in the reflection probe, and the probe just facilitates baking this image.

Exairnous · 2025-04-08T10:04:24Z

addons/io_hubs_addon/components/definitions/scale_audio_feedback.py

        'icon': 'GRAPH',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Control the scale of an object or bone based on mic volume'


This component is almost identical to the Morph Audio Feedback component (which is why I phrased it similarly), except it scales the bone between two values instead of morphing a shape key between two values. I'm not against adding in an additional comment, but if we do, I'd add it to the Morph Audio Feedback tooltip as well.

Exairnous · 2025-04-08T10:13:27Z

addons/io_hubs_addon/components/definitions/spawner.py

        'icon': 'MOD_PARTICLE_INSTANCE',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Spawn objects (glb) loaded from a URL by dragging'


Can we add "by dragging on it" to the end? As it is, it doesn't inform the user how the object is duplicated, so to me, it sounds like I'd duplicate a copy by hovering over it, pressing spacebar, and cloning it (which doesn't work).

Exairnous · 2025-04-08T11:54:09Z

addons/io_hubs_addon/components/definitions/visible.py

        'icon': 'HIDE_OFF',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Hide this object from the camera'


It's arguable whether "force" is necessary, but since you can use it to show the bounds of things like audio zones which are normally invisible (while most other things in Hubs are defaulted to visible) I went with saying you're forcing the state. As to Blender's instructions, most of the time I'd agree with them, but in this case I feel this better describes things because the component contains the toggle and so this isn't describing the toggle directly (I could be wrong though).

Exairnous · 2025-04-08T11:58:43Z

addons/io_hubs_addon/components/definitions/frustrum.py

        'icon': 'IMAGE_PLANE',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Define mesh culling settings for this object',


True. Okay, but how about '...passes outside of the user's field of view'? This way it's a little clearer which field of view is being talked about.

Exairnous · 2025-04-08T12:01:08Z

addons/io_hubs_addon/components/definitions/mirror.py

        'icon': 'MOD_MIRROR',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Display a virtual, planar, mirror that will give a live reflection of avatars, in-room objects and the environment'


@Heather-Elizabeth-Dodds Which second comma? The one after planar? It looks like @Spiderguy-F removed the one after objects (which is fine, but it was a perfectly valid Oxford comma 😛)

In German there is no comma before and, unless it's followed by a complete sentence. No Oxford in Germany. But the comma after planar would also not be there, not even between virtual and planar, unless they were closely related, like big, strong guy as opposed to small German guy. As weird as that is.

Exairnous

@Spiderguy-F

@Heather-Elizabeth-Dodds and I discussed the tooltips at the latest Hubs Documentation Session and have come up with some new wording which I've added to the relevant spots. I think we've now communicated all of our suggested wording changes for now and we'll see how things are after you've finished updating things. Thank you again for your work to add these, this will be a very helpful improvement.

Exairnous · 2025-04-10T05:23:13Z

addons/io_hubs_addon/components/definitions/spawner.py

        'icon': 'MOD_PARTICLE_INSTANCE',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Spawn objects (glb) loaded from a URL by dragging'


Revised wording that @Heather-Elizabeth-Dodds and I came up with:

Suggested change

'tooltip': 'Spawn objects (glb) loaded from a URL by dragging'

'tooltip': 'Using an existing URL, generate an object (glb) that a user can optionally duplicate by dragging'

Exairnous · 2025-04-10T05:24:50Z

addons/io_hubs_addon/components/definitions/morph_audio_feedback.py

        'icon': 'MOD_SMOOTH',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': "Use the user's transmitted audio to animate a shape key of the avatar"


Revised wording that @Heather-Elizabeth-Dodds and I came up with:

Suggested change

'tooltip': "Use the user's transmitted audio to animate a shape key of the avatar"

'tooltip': "Use the user's transmitted audio to animate a shape key on the avatar. Larger numbers cause more movement

"

isn't 'can optionally' a tautology?

Almost! But that phrasing is often used.

Exairnous · 2025-04-10T05:25:37Z

addons/io_hubs_addon/components/definitions/scale_audio_feedback.py

        'icon': 'GRAPH',
-        'version': (1, 0, 0)
+        'version': (1, 0, 0),
+        'tooltip': 'Control the scale of an object or bone based on mic volume'


Revised wording that @Heather-Elizabeth-Dodds and I came up with:

Suggested change

'tooltip': 'Control the scale of an object or bone based on mic volume'

'tooltip': 'Use the user's transmitted audio to animate the scale of an object or bone in the avatar. Larger numbers cause more movement'

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

GottfriedHofmann

Tested and all tooltips work fine. I did not find a technical inaccuracy in the tooltips.

Exairnous · 2025-11-20T13:43:38Z

@Spiderguy-F Thank you for the update. The documentation team has this on our radar again. It looks like there are still some unresolved comments/suggestions that haven't been integrated yet. Unless you disagree with them (in which case let us know), could you please add the changes from them to the PR?

Spiderguy-F added 4 commits March 24, 2025 11:55

Tooltip pulled from HubsComponent derive classes

d6df801

Tooltips are now grabbed from the HubsComponent's get_tooltip()

87427dc

Removed printouts

dccdc6e

Fixed whitespaces

6db2c59

DougReeder approved these changes Mar 24, 2025

View reviewed changes

Switched visible back to true

d3357d4

DougReeder reviewed Mar 27, 2025

View reviewed changes

addons/io_hubs_addon/components/definitions/audio_source.py Outdated Show resolved Hide resolved

DougReeder reviewed Mar 27, 2025

View reviewed changes

addons/io_hubs_addon/components/definitions/frustrum.py Outdated Show resolved Hide resolved

DougReeder reviewed Mar 27, 2025

View reviewed changes

addons/io_hubs_addon/components/definitions/media_frame.py Outdated Show resolved Hide resolved

Temporary changes

194c1a8

Exairnous requested changes Apr 4, 2025

View reviewed changes

Spiderguy-F and others added 8 commits April 7, 2025 09:52

Material tab tooltip

c8c583c

Merge branch 'TooltipsFromClasses' of https://github.com/BlenderDiplo…

a572d5a

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

Material Tab Tooltip Restored

45deeaf

Update addons/io_hubs_addon/components/definitions/audio_settings.py

4d1e835

Co-authored-by: Exairnous <[email protected]>

Update addons/io_hubs_addon/components/definitions/ammo_shape.py

44cab03

Co-authored-by: Exairnous <[email protected]>

Update addons/io_hubs_addon/components/definitions/loop_animation.py

bb84fdf

Co-authored-by: Exairnous <[email protected]>

Implemented Suggestions

e1856a5

Merge branch 'TooltipsFromClasses' of https://github.com/BlenderDiplo…

422f151

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

Exairnous reviewed Apr 8, 2025

View reviewed changes

Exairnous reviewed Apr 10, 2025

View reviewed changes

Spiderguy-F added 4 commits November 7, 2025 09:13

Changed Tooltips based on suggestions

c416b52

Merge branch 'TooltipsFromClasses' of https://github.com/BlenderDiplo…

1702ac7

…m/hubs-blender-exporter-tooltips into TooltipsFromClasses

Added Tolltip for audio.py

3b52540

Fixed minor style issues

16c8c64

GottfriedHofmann approved these changes Nov 11, 2025

View reviewed changes

Spiderguy-F requested a review from Exairnous November 11, 2025 14:12

	'tooltip': 'Create an interactable hyperlink'
	'tooltip': 'Display a preview of a website or Hubs asset that can be interacted with (behavior depends on the type of link). This can be combined with other components to override the auto-generated preview'

	'tooltip': 'A light that emits parallel light in a specific direction, like the sun',
	'tooltip': 'Emit parallel light in a specific direction, like the sun',

	'tooltip': 'Control a shapekey for an avatar based on mic volume'
	'tooltip': 'Use the user's transmitted audio to animate a shape key on the avatar'

	'tooltip': 'Add a mirror plane to the room'
	'tooltip': 'Display a virtual, planar, mirror that will give a live reflection of avatars, in-room objects, and the environment'

	'tooltip': 'Load a 3D model (glb) from a URL'
	'tooltip': 'Display a 3D model (glb) from a URL'

	'tooltip': 'Define the area where avatars can walk'
	'tooltip': 'Designate this as the mesh that determines where avatars can walk'

	'tooltip': 'A punctual light source that emits light in all directions',
	'tooltip': 'Emit light in all directions from a single point'

	'tooltip': 'Spawn objects (glb) loaded from a URL by dragging'
	'tooltip': 'Using an existing URL, generate an object (glb) that a user can optionally duplicate by dragging'

	'tooltip': "Use the user's transmitted audio to animate a shape key of the avatar"
	'tooltip': "Use the user's transmitted audio to animate a shape key on the avatar. Larger numbers cause more movement
	"

	'tooltip': 'Control the scale of an object or bone based on mic volume'
	'tooltip': 'Use the user's transmitted audio to animate the scale of an object or bone in the avatar. Larger numbers cause more movement'

Tooltips from component classes #327

Are you sure you want to change the base?

Tooltips from component classes #327

Uh oh!

Conversation

Spiderguy-F commented Mar 24, 2025

What?

Why?

Examples

How to test

Open questions

Uh oh!

DougReeder left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DougReeder commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Exairnous left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hobbs-Hobbler Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hobbs-Hobbler Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hobbs-Hobbler commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Exairnous left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

DougReeder commented Mar 27, 2025 •

edited

Loading

hobbs-Hobbler Apr 6, 2025 •

edited

Loading

hobbs-Hobbler Apr 6, 2025 •

edited

Loading

hobbs-Hobbler commented Apr 6, 2025 •

edited

Loading

Exairnous left a comment •

edited

Loading