UI: Unit completion hint when text editing #116103

Open

Falk David wants to merge 9 commits from filedescriptor/blender:ui-unit-text-completion into main

pull from: filedescriptor/blender:ui-unit-text-completion

merge into: blender:main

blender:main

blender:universal-scene-description

blender:brush-assets-project

blender:fix-121021

blender:blender-v4.1-release

blender:blender-v3.3-release

blender:blender-v3.6-release

blender:blender-v3.6-temp_wmoss_animrig_public

blender:temp-sculpt-dyntopo

blender:gpencil-next

blender:anim/animation-id-113594

blender:blender-v4.0-release

blender:blender-projects-basics

blender:bridge-curves

blender:sculpt-blender

blender:asset-browser-frontend-split

blender:asset-shelf

blender:tmp-usd-python-mtl

blender:tmp-usd-3.6

blender:blender-v3.5-release

blender:blender-v2.93-release

blender:realtime-clock

blender:sculpt-dev

blender:bevelv2

blender:xr-dev

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.

Conversation 17 Commits 9 Files Changed 18 +249 -47

Falk David commented 2023-12-12 18:33:47 +01:00

Member

Copy Link

Summary

This PR adds a useful little hint when typing into number fields with units.

Works for different scene unit defaults:

And also deals with pixel values and percentages seperately (they are not "units"):

This is especially useful when the unit is set to "Adaptive":

Notice that the previous value is in centimeters, but typing into the field actually defaults to meters (using adaptive units).
Previously, the user would not have a visual indication of what units will be used when entering a value.

Details

This PR does 2 things:

1. Adds a completion string on a uiBut that gets displayed during text editing after whatever is currently being typed. This is drawn with the same faded color as the placeholder text.
2. Sets the completion string for text buttons that use a unit to the unit set in the scene settings (or the default).

## Summary This PR adds a useful little hint when typing into number fields with units.   Works for different scene unit defaults:  And also deals with pixel values and percentages seperately (they are not "units"):  This is especially useful when the unit is set to "Adaptive": <video muted controls src="/attachments/b94db13c-10b7-4af4-b4b1-079ac88c600f" type="video/mp4"/> Notice that the previous value is in centimeters, but typing into the field actually defaults to meters (using adaptive units). Previously, the user would not have a visual indication of what units will be used when entering a value. ## Details This PR does 2 things: 1) Adds a `completion` string on a `uiBut` that gets displayed during text editing after whatever is currently being typed. This is drawn with the same faded color as the `placeholder` text. 2) Sets the `completion` string for text buttons that use a unit to the unit set in the scene settings (or the default).

image.png

6.5 KiB

image.png

4.4 KiB

unit_hint.mp4

178 KiB

image.png

5.1 KiB

image.png

5.8 KiB

👍 5 ❤️ 4 🎉 2

Falk David added 1 commit 2023-12-12 18:33:57 +01:00

d327384779 UI: Default base unit completion when text editing

Brecht Van Lommel requested review from Harley Acheson 2023-12-12 20:56:42 +01:00

Harley Acheson commented 2023-12-13 00:22:51 +01:00

Member

Copy Link

That's pretty neat!

It feels so good though that it does feel incomplete in areas when you don't see it. Like Output / Format Resolution not showing "px" or percentages not showing "%"

That's pretty neat! It feels so good though that it does feel incomplete in areas when you don't see it. Like Output / Format Resolution not showing "px" or percentages not showing "%"

❤️ 1

Falk David added 2 commits 2023-12-13 12:47:17 +01:00

f84f2c85ff Support non-base units

8a6918b5cc Add completion for pixel and percentage values

Falk David changed title from UI: Default base unit completion when text editing to UI: Unit completion hint when text editing 2023-12-13 12:47:31 +01:00

Iliya Katushenock added this to the User Interface project 2023-12-13 12:48:50 +01:00

Falk David commented 2023-12-13 13:03:30 +01:00

Author

Member

Copy Link

@blender-bot build

@blender-bot build

Harley Acheson commented 2023-12-13 18:18:19 +01:00

Member

Copy Link

First, I need to say I love this idea. For me its only "problem" is that it is so cool that it becomes an expected thing so any time it doesn't appear or work as expected it causes a dissonance. Basically it has to work almost flawlessly, but we have some existing behavior (not introduced here) that might hinder that.

A very small example that is probably an easy thing to fix. It is so nice that it now works with "px" and percentages, but it doesn't show these hints at all the times I would expect. I click on a "90%" value and I just see "90" selected without the %. I insert my text cursor, use arrows to move it left and right, still no percentage. It only shows up if I start changing the value by deleting a character.

If I do so with a meter length value it is a little different. I click on a field that says "12 m" and I am now editing the string "12 m". I remove the "m" it now shows your "m" afterward. I still have another space to remove. Now I am editing "12" and it shows your "m" afterward. Select those two numbers and that "m" disappears while the mouse pointer is down but reappears when you release.

This current behavior of including the units in the editable string gets a bit weirder when the short and long descriptions of the unit differs.

You have a rotation field currently set to "12 °". As above, just click on the field and it shows "12d". Insert your mouse text cursor to the right of that and you are now editing the string "12d". Backspace to remove the "d" and now it shows you are editing "22" and it shows a degree symbol. But if you instead remove the "1" and/or "2" and you just have a "d".

This existing behavior of having the units being part of the edited string is a little in conflict with your new behavior. I understand why it is there, as it helps lead the user to realize they can type things like "12 cm" into an input that shows meters. But when I do so I then have something showing "0.12 m", so it only ever displays the actual base units. So maybe with your change we could not show the units as part of the editable string, but only show your hint?

First, I need to say I love this idea. For me its only "problem" is that it is so cool that it becomes an expected thing so any time it doesn't appear or work as expected it causes a dissonance. Basically it has to work almost flawlessly, but we have some existing behavior (not introduced here) that might hinder that. A very small example that is probably an easy thing to fix. It is so nice that it now works with "px" and percentages, but it doesn't show these hints at all the times I would expect. I click on a "90%" value and I just see "90" selected without the %. I insert my text cursor, use arrows to move it left and right, still no percentage. It only shows up if I start changing the value by deleting a character.  If I do so with a meter length value it is a little different. I click on a field that says "12 m" and I am now editing the string "12 m". I remove the "m" it now shows your "m" afterward. I still have another space to remove. Now I am editing "12" and it shows your "m" afterward. Select those two numbers and that "m" disappears while the mouse pointer is down but reappears when you release.  This _current behavior_ of including the units in the editable string gets a bit weirder when the short and long descriptions of the unit differs. You have a rotation field currently set to "12 °". As above, just click on the field and it shows "12d". Insert your mouse text cursor to the right of that and you are now editing the string "12d". Backspace to remove the "d" and now it shows you are editing "22" and it shows a degree symbol. But if you instead remove the "1" and/or "2" and you just have a "d".  This existing behavior of having the units being part of the edited string is a little in conflict with your new behavior. I understand why it is there, as it helps lead the user to realize they can type things like "12 cm" into an input that shows meters. But when I do so I then have something showing "0.12 m", so it only ever displays the actual base units. So maybe with your change we could not show the units as part of the editable string, but only show your hint?

rem.gif

52 KiB

respx.gif

29 KiB

redeg.gif

26 KiB

Falk David commented 2023-12-13 18:30:04 +01:00

Author

Member

Copy Link

@Harley Thanks for the feedback!
Yes, I noticed 1) too when playing with the patch. Seems like that should be an easy fix.

I agree with your other remarks as well. It seems like with this "completion", we shouldn't need the default unit in the string anymore when editing. It's almost trying to do the same thing in a way.

So maybe an approach would be:

• When editing a (unit/pixel/percentage) value, only the numerical part is in the edit string (selected)
• The unit is automatically shown in the completion
• If the user enters a different unit, the completion disapears (like it does now).

@Harley Thanks for the feedback! Yes, I noticed 1) too when playing with the patch. Seems like that should be an easy fix. I agree with your other remarks as well. It seems like with this "completion", we shouldn't need the default unit in the string anymore when editing. It's almost trying to do the same thing in a way. So maybe an approach would be: * When editing a (unit/pixel/percentage) value, only the numerical part is in the edit string (selected) * The unit is automatically shown in the completion * If the user enters a different unit, the completion disapears (like it does now).

Harley Acheson commented 2023-12-13 19:02:28 +01:00

Member

Copy Link

It seems like with this "completion", we shouldn't need the default unit in the string anymore when editing. It's almost trying to do the same thing in a way.

Yes, my gut feeling is that this unit hint could replace the unit in the editable string and would feel much better. Maybe.

I can imagine the more technical-minded of us liking that rotation entry shows that "d" in that it might be a hint you could enter "r". And maybe showing "m" might make you try "cm".

But entering values in our inputs is a modal operation. Maybe the status bar could show the user all the things that can be entered. Like different units, or math. Or how to add characters by Unicode value, etc. I think we have a bunch of hidden features we could show.

Another thing to consider is what strings are actually shown for this hint. The short versions you have selected might be best, but you don't necessarily have to show the same things while editing. You could show "meters" while editing even though it shows "m" afterward. That example is weird but consider rotation if the scene units are Radians. We currently show no symbol for radians, although we could use something like superscript R, like ᴿ. But while editing it could show "rad" or even "radians".

> It seems like with this "completion", we shouldn't need the default unit in the string anymore when editing. It's almost trying to do the same thing in a way. Yes, my gut feeling is that this unit hint could replace the unit in the editable string and would feel much better. Maybe. I can imagine the more technical-minded of us liking that rotation entry shows that "d" in that it might be a hint you could enter "r". And maybe showing "m" might make you try "cm". But entering values in our inputs is a modal operation. Maybe the status bar could show the user all the things that can be entered. Like different units, or math. Or how to add characters by Unicode value, etc. I think we have a bunch of hidden features we could show. Another thing to consider is what strings are actually shown for this hint. The short versions you have selected might be best, but you don't necessarily have to show the same things while editing. You could show "meters" while editing even though it shows "m" afterward. That example is weird but consider rotation if the scene units are Radians. We currently show no symbol for radians, although we could use something like superscript R, like ᴿ. But while editing it could show "rad" or even "radians".

Falk David added 2 commits 2023-12-13 19:18:12 +01:00

217ab7318d Fix initialization of text completion

219b3c4468 Don't append unit when entering text editing

Falk David commented 2023-12-13 19:18:57 +01:00

Author

Member

Copy Link

@Harley I pushed the fix for the first issue and an experimental commit to try out removing the unit in the text string and replacing it with the hint

@Harley I pushed the fix for the first issue and an experimental commit to try out removing the unit in the text string and replacing it with the hint 

Peek 2023-12-13 19-22.gif

96 KiB

Falk David commented 2023-12-13 19:27:29 +01:00

Author

Member

Copy Link

@blender-bot build

@blender-bot build

Harley Acheson commented 2023-12-13 23:43:15 +01:00

Member

Copy Link

That is so nice. It feels so natural and seems to fit in a way with the placeholders, both guiding in similar ways.

It is also a bit less disruptive when transitioning to/from editing. The entirety of what is shown is there when you start editing, with the unit looking disabled. And that is a good thing, it looks way better.

Of course this effect erases my earlier idea of showing something more detailed while editing.

That is so nice. It feels so natural and seems to fit in a way with the placeholders, both guiding in similar ways. It is also a bit less disruptive when transitioning to/from editing. The entirety of what is shown is there when you start editing, with the unit looking disabled. And that is a good thing, it looks way better.  Of course this effect erases my earlier idea of showing something more detailed while editing.

FocalLength.gif

30 KiB

Harley Acheson commented 2023-12-13 23:52:39 +01:00

Member

Copy Link

So far the only place I'm not seeing it work is in 3DView Sidebar, Item, Dimensions.

So far the only place I'm not seeing it work is in 3DView Sidebar, Item, Dimensions.

Falk David commented 2023-12-14 11:05:06 +01:00

Author

Member

Copy Link

Hm seems like the dimensions are some special property. Have to investigate this further.
I also noticed that multi-field editing is not working with the completion:

Hm seems like the dimensions are some special property. Have to investigate this further. I also noticed that multi-field editing is not working with the completion: 

image.png

7.7 KiB

Falk David added 1 commit 2023-12-14 11:29:03 +01:00

d063dc3974 Show hint for unit buttons that don't have an rnaprop

Falk David commented 2023-12-14 11:52:31 +01:00

Author

Member

Copy Link

So far the only place I'm not seeing it work is in 3DView Sidebar, Item, Dimensions.

Fixed! :)

> So far the only place I'm not seeing it work is in 3DView Sidebar, Item, Dimensions. Fixed! :)

Falk David added 1 commit 2023-12-14 12:01:21 +01:00

272784252f Merge branch 'main' into ui-unit-text-completion

Falk David added 1 commit 2023-12-14 12:25:21 +01:00

5fb4003dff Show completion when editing text across multiple buttons

Falk David commented 2023-12-14 13:27:37 +01:00

Author

Member

Copy Link

@blender-bot build

@blender-bot build

Falk David added 1 commit 2023-12-14 13:36:36 +01:00

3e5729c5cf Formatting

Falk David commented 2023-12-14 13:38:29 +01:00

Author

Member

Copy Link

@blender-bot build

@blender-bot build

Falk David commented 2023-12-14 16:01:38 +01:00

Author

Member

Copy Link

@blender-bot package

@blender-bot package

Blender Bot commented 2023-12-14 16:01:42 +01:00

Member

Copy Link

Package build started. Download here when ready.

Package build started. [Download here](https://builder.blender.org/download/patch/PR116103) when ready.

Damien Picard commented 2023-12-14 17:29:28 +01:00

Member

Copy Link

I love this feature, I’ve just noticed a quirk with the lights’ power in watts. This unit appears to be adaptive, without the user being able to choose so. 0.001 W is displayed as 1 mW, 1E6 W as 1 MW, etc. (1000 is still displayed as 1000 W for some reason).
When the value is e.g. 1 MW and you click to edit, the field goes back to 1 W, probably because the sub-unit is not detected.

I love this feature, I’ve just noticed a quirk with the lights’ power in watts. This unit appears to be adaptive, without the user being able to choose so. 0.001 W is displayed as 1 mW, 1E6 W as 1 MW, etc. (1000 is still displayed as 1000 W for some reason). When the value is e.g. 1 MW and you click to edit, the field goes back to 1 W, probably because the sub-unit is not detected. <video src="/attachments/e29970d2-128d-44f7-b22e-56dbc6c1c9e2" title="light_power.mp4" controls></video>

light_power.mp4

304 KiB

Falk David commented 2023-12-14 18:05:00 +01:00

Author

Member

Copy Link

@pioverfour Indeed that is a bug I will have to fix :) Thanks for testing.

@pioverfour Indeed that is a bug I will have to fix :) Thanks for testing.

👍 3

Some checks failed

buildbot/vexp-code-patch-lint Build done.

Details

buildbot/vexp-code-patch-darwin-x86_64 Build done.

Details

buildbot/vexp-code-patch-darwin-arm64 Build done.

Details

buildbot/vexp-code-patch-linux-x86_64 Build done.

Details

buildbot/vexp-code-patch-windows-amd64 Build done.

Details

buildbot/vexp-code-patch-coordinator Build done.

Details

This pull request has changes conflicting with the target branch.

• source/blender/blenkernel/intern/unit.cc
• source/blender/editors/interface/interface.cc
• source/blender/editors/interface/interface_intern.hh
• source/blender/editors/transform/transform_mode_shrink_fatten.cc

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u ui-unit-text-completion:filedescriptor-ui-unit-text-completion

git checkout filedescriptor-ui-unit-text-completion

Sign in to join this conversation.

Reviewers

No reviewers

Harley Acheson

Labels

Clear labels   

Interest

Alembic

  

Interest

Animation & Rigging

  

Interest

Asset Browser

  

Interest

Asset Browser Project Overview

  

Interest

Audio

  

Interest

Automated Testing

  

Interest

Blender Asset Bundle

  

Interest

BlendFile

  

Interest

Collada

  

Interest

Compatibility

This issue affects/is about backward or forward compatibility

  

Interest

Compositing

  

Interest

Core

  

Interest

Cycles

  

Interest

Dependency Graph

  

Interest

Development Management

  

Interest

EEVEE

  

Interest

EEVEE & Viewport

  

Interest

Freestyle

  

Interest

Geometry Nodes

  

Interest

Grease Pencil

  

Interest

ID Management

  

Interest

Images & Movies

  

Interest

Import Export

  

Interest

Line Art

  

Interest

Masking

  

Interest

Metal

  

Interest

Modeling

  

Interest

Modifiers

  

Interest

Motion Tracking

  

Interest

Nodes & Physics

  

Interest

OpenGL

  

Interest

Overlay

  

Interest

Overrides

  

Interest

Performance

  

Interest

Physics

  

Interest

Pipeline, Assets & IO

  

Interest

Platforms, Builds & Tests

  

Interest

Python API

  

Interest

Render & Cycles

  

Interest

Render Pipeline

  

Interest

Sculpt, Paint & Texture

  

Interest

Text Editor

  

Interest

Translations

  

Interest

Triaging

  

Interest

Undo

  

Interest

USD

  

Interest

User Interface

  

Interest

UV Editing

  

Interest

VFX & Video

  

Interest

Video Sequencer

  

Interest

Virtual Reality

  

Interest

Vulkan

  

Interest

Wayland

Issues relating to Wayland windowing support.

  

Interest

Workbench

  

Interest: X11

Issues relating to Xorg/X11 support.

  

Legacy

Blender 2.8 Project

  

Legacy

Milestone 1: Basic, Local Asset Browser

  

Legacy

OpenGL Error

  

Meta

Good First Issue

  

Meta

Papercut

  

Meta

Retrospective

  

Meta

Security

Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports

  

Module

Animation & Rigging

  

Module

Core

  

Module

Development Management

  

Module

EEVEE & Viewport

  

Module

Grease Pencil

  

Module

Modeling

  

Module

Nodes & Physics

  

Module

Pipeline, Assets & IO

  

Module

Platforms, Builds & Tests

  

Module

Python API

  

Module

Render & Cycles

  

Module

Sculpt, Paint & Texture

  

Module

Triaging

  

Module

User Interface

  

Module

VFX & Video

  

Platform

FreeBSD

  

Platform

Linux

  

Platform

macOS

  

Platform

Windows

  

Priority

High

  

Priority

Low

  

Priority

Normal

  

Priority

Unbreak Now!

  

Status

Archived

  

Status

Confirmed

  

Status

Duplicate

  

Status

Needs Info from Developers

  

Status

Needs Information from User

  

Status

Needs Triage

  

Status

Resolved

  

Type

Bug

  

Type

Design

  

Type

Known Issue

  

Type

Patch

  

Type

Report

  

Type

To Do

No Label

Interest

Alembic

Interest

Animation & Rigging

Interest

Asset Browser

Interest

Asset Browser Project Overview

Interest

Audio

Interest

Automated Testing

Interest

Blender Asset Bundle

Interest

BlendFile

Interest

Collada

Interest

Compatibility

Interest

Compositing

Interest

Core

Interest

Cycles

Interest

Dependency Graph

Interest

Development Management

Interest

EEVEE

Interest

EEVEE & Viewport

Interest

Freestyle

Interest

Geometry Nodes

Interest

Grease Pencil

Interest

ID Management

Interest

Images & Movies

Interest

Import Export

Interest

Line Art

Interest

Masking

Interest

Metal

Interest

Modeling

Interest

Modifiers

Interest

Motion Tracking

Interest

Nodes & Physics

Interest

OpenGL

Interest

Overlay

Interest

Overrides

Interest

Performance

Interest

Physics

Interest

Pipeline, Assets & IO

Interest

Platforms, Builds & Tests

Interest

Python API

Interest

Render & Cycles

Interest

Render Pipeline

Interest

Sculpt, Paint & Texture

Interest

Text Editor

Interest

Translations

Interest

Triaging

Interest

Undo

Interest

USD

Interest

User Interface

Interest

UV Editing

Interest

VFX & Video

Interest

Video Sequencer

Interest

Virtual Reality

Interest

Vulkan

Interest

Wayland

Interest

Workbench

Interest: X11

Legacy

Blender 2.8 Project

Legacy

Milestone 1: Basic, Local Asset Browser

Legacy

OpenGL Error

Meta

Good First Issue

Meta

Papercut

Meta

Retrospective

Meta

Security

Module

Animation & Rigging

Module

Core

Module

Development Management

Module

EEVEE & Viewport

Module

Grease Pencil

Module

Modeling

Module

Nodes & Physics

Module

Pipeline, Assets & IO

Module

Platforms, Builds & Tests

Module

Python API

Module

Render & Cycles

Module

Sculpt, Paint & Texture

Module

Triaging

Module

User Interface

Module

VFX & Video

Platform

FreeBSD

Platform

Linux

Platform

macOS

Platform

Windows

Priority

High

Priority

Low

Priority

Normal

Priority

Unbreak Now!

Status

Archived

Status

Confirmed

Status

Duplicate

Status

Needs Info from Developers

Status

Needs Information from User

Status

Needs Triage

Status

Resolved

Type

Bug

Type

Design

Type

Known Issue

Type

Patch

Type

Report

Type

To Do

Milestone

Clear milestone

No items

No Milestone

Projects

Clear projects

No project

User Interface

Assignees

Clear assignees

No Assignees

4 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#116103

No description provided.