blender/blender
147
471
Fork 688
Code Issues 6.7k Pull Requests 883 Projects 18 Wiki Activity

Anim: Add option to show modified property on slider #119920

Merged
Christoph Lendenfeld merged 9 commits from ChrisLend/blender:slider_show_modified_property into main 2024-04-25 15:48:32 +02:00
Conversation 5 Commits 9 Files Changed 3 +54 -12
Christoph Lendenfeld commented 2024-03-26 15:09:17 +01:00
Member
Copy Link

This PR adds the feature of displaying which property is modified
to the slider GUI.

This is useful in cases like #117287: Anim: Add Sharpness to Ease operator
where the slider can modify different properties during the modal operation.

The string is optional and will be empty by default.

This label is placed to the left of the slider where the percentage was usually located.
The percentage has now been moved to the right.

In use on the Ease operator
image
image

This PR adds the feature of displaying which property is modified to the slider GUI. This is useful in cases like [#117287: Anim: Add Sharpness to Ease operator](https://projects.blender.org/blender/blender/pulls/117287) where the slider can modify different properties during the modal operation. The string is optional and will be empty by default. This label is placed to the left of the slider where the percentage was usually located. The percentage has now been moved to the right. ------ In use on the Ease operator ![image](/attachments/e62cab78-0dc3-4a7c-8778-254ca1f3144e) ![image](/attachments/9ef20f48-2942-4f33-ab44-6edf2c00b86e)
image.png
2.2 KiB
image.png
2.0 KiB
👍 1 ❤️ 8 🎉 1 🚀 1
Christoph Lendenfeld added this to the 4.2 LTS milestone 2024-03-26 15:09:17 +01:00
Christoph Lendenfeld added the
Interest
User Interface
Module
Animation & Rigging
 labels 2024-03-26 15:09:17 +01:00
Christoph Lendenfeld added 1 commit 2024-03-26 15:09:28 +01:00
Sybren A. Stüvel requested changes 2024-04-09 12:01:55 +02:00
Sybren A. Stüvel left a comment
Member
Copy Link

Nice!

"Property name" is a bit ambiguous, as it could mean different things (could be the RNA name). I think it would be better to use either label or ui_name instead of name, so that it's clear it's a for-humans UI thing.

I decided to put it to the right of the slider because on the left, the factor is constantly changing its size, making the text jump around.

Good to have this documented. I do feel that this ordering (label to the right of the value) makes this part of the UI feel a bit inconsistent with the rest of Blender's UI. Would it be much work to move the factor to the right, and the label to the left of the slider? I also wonder what @pablovazquez thinks about this.

Nice! "Property name" is a bit ambiguous, as it could mean different things (could be the RNA name). I think it would be better to use either `label` or `ui_name` instead of `name`, so that it's clear it's a for-humans UI thing. > I decided to put it to the right of the slider because on the left, the factor is constantly changing its size, making the text jump around. Good to have this documented. I do feel that this ordering (label to the right of the value) makes this part of the UI feel a bit inconsistent with the rest of Blender's UI. Would it be much work to move the factor to the right, and the label to the left of the slider? I also wonder what @pablovazquez thinks about this.
source/blender/editors/util/ed_draw.cc
@ -83,1 +84,4 @@
/* Optional string that will display next to the slider to indicate which property is modified
* right now. */
char property_name[SLIDER_PROPERTY_STRING_SIZE];
Sybren A. Stüvel commented 2024-04-09 12:00:49 +02:00
Member
Copy Link

Given that this is runtime data that's owned by tSlider anyway, do we need a fixed-size char[]? Or could we just use std::string instead? That could get rid of the fixed array size. Passing references around could then be via a StringRef instead of const char *.

Given that this is runtime data that's owned by `tSlider` anyway, do we need a fixed-size `char[]`? Or could we just use `std::string` instead? That could get rid of the fixed array size. Passing references around could then be via a `StringRef` instead of `const char *`.
source/blender/editors/util/ed_draw.cc
@ -363,1 +382,4 @@
fontid, factor_string_pos_x, (region->winy / 2) - factor_string_pixel_size[1] / 2, 0.0f);
BLF_draw(fontid, factor_string, sizeof(factor_string));
if (slider->property_name) {
Sybren A. Stüvel commented 2024-04-09 11:54:22 +02:00
Member
Copy Link

warning: address of array 'slider->property_name' will always evaluate to 'true'

I think you want if (slider->property_name[0])

`warning: address of array 'slider->property_name' will always evaluate to 'true'` I think you want `if (slider->property_name[0])`
dr.sybren marked this conversation as resolved
Christoph Lendenfeld commented 2024-04-09 13:01:52 +02:00
Author
Member
Copy Link

Would it be much work to move the factor to the right, and the label to the left of the slider?

Not at all. The reason why it was on the left in the first place is because it means the % will be less prone to jumping around. But I think we can mitigate that. I agree it would make more sense to have the unit name on the left

> Would it be much work to move the factor to the right, and the label to the left of the slider? Not at all. The reason why it was on the left in the first place is because it means the % will be less prone to jumping around. But I think we can mitigate that. I agree it would make more sense to have the unit name on the left
👍 1
Christoph Lendenfeld added 1 commit 2024-04-09 13:05:46 +02:00
Christoph Lendenfeld added 1 commit 2024-04-09 15:36:35 +02:00
Pablo Vazquez commented 2024-04-09 16:49:02 +02:00
Member
Copy Link

Would it be much work to move the factor to the right, and the label to the left of the slider? I also wonder what @pablovazquez thinks about this.

Thanks for bringing this up!

Yes. Since the UI is meant to be read left-to-right, it would be more consistent to have the label on the left and values on the right.

mockup

> Would it be much work to move the factor to the right, and the label to the left of the slider? I also wonder what @pablovazquez thinks about this. Thanks for bringing this up! Yes. Since the UI is meant to be read left-to-right, it would be more consistent to have the label on the left and values on the right. ![mockup](/attachments/ba67038e-ec02-47ea-80c6-8aa83b4fcf6a)
image.png
11 KiB
👍 2
Christoph Lendenfeld added 2 commits 2024-04-11 14:48:16 +02:00
Christoph Lendenfeld requested review from Sybren A. Stüvel 2024-04-11 14:53:22 +02:00
Christoph Lendenfeld commented 2024-04-11 14:54:55 +02:00
Author
Member
Copy Link

@dr.sybren @pablovazquez I changed the order of the slider to read left to right.
The percentage number on the right does jump around a bit now, but I don't feel it is too distracting.
Example images in the PR description have been updated.

@dr.sybren @pablovazquez I changed the order of the slider to read left to right. The percentage number on the right does jump around a bit now, but I don't feel it is too distracting. Example images in the PR description have been updated.
Pablo Vazquez commented 2024-04-11 15:42:02 +02:00
Member
Copy Link

Thanks! Haven't compiled this patch yet but by looking at the screenshots it seems the label is overflowing the background?

Made the image brighter so it's easier to spot:
label

It's also rounded on the left but not the right, might have to do with that? Some kind of offset.

Thanks! Haven't compiled this patch yet but by looking at the screenshots it seems the label is overflowing the background? Made the image brighter so it's easier to spot: ![label](/attachments/d875a7ba-a559-4475-b7d3-c31d63b972bf) It's also rounded on the left but not the right, might have to do with that? Some kind of offset.
image.png
6.7 KiB
Christoph Lendenfeld added 1 commit 2024-04-11 15:57:11 +02:00
Christoph Lendenfeld commented 2024-04-11 15:57:47 +02:00
Author
Member
Copy Link

@pablovazquez well spotted. Didn't see that on my screen but I forgot to change the backdrop padding with the text

@pablovazquez well spotted. Didn't see that on my screen but I forgot to change the backdrop padding with the text
Christoph Lendenfeld added 1 commit 2024-04-19 14:34:46 +02:00
Sybren A. Stüvel approved these changes 2024-04-22 12:22:46 +02:00
Sybren A. Stüvel left a comment
Member
Copy Link

Just a small (but important) note, can be handled when landing.

Just a small (but important) note, can be handled when landing.
source/blender/editors/util/ed_draw.cc Outdated
@ -364,0 +384,4 @@
float property_name_pixel_size[2];
BLF_width_and_height(fontid,
slider->property_label.c_str(),
sizeof(slider->property_label),
Sybren A. Stüvel commented 2024-04-22 12:11:54 +02:00
Member
Copy Link

sizeof is incorrect here, I think you need slider->property_label.length()

`sizeof` is incorrect here, I think you need `slider->property_label.length()`
source/blender/editors/util/ed_draw.cc Outdated
@ -364,0 +391,4 @@
main_line_rect.xmin - text_padding - property_name_pixel_size[0],
(region->winy / 2) - property_name_pixel_size[1] / 2,
0.0f);
BLF_draw(fontid, slider->property_label.c_str(), sizeof(slider->property_label));
Sybren A. Stüvel commented 2024-04-22 12:12:06 +02:00
Member
Copy Link

same sizeof here

same `sizeof` here
Christoph Lendenfeld added 2 commits 2024-04-23 10:41:00 +02:00
Christoph Lendenfeld merged commit 78583bf22e into main 2024-04-25 15:48:32 +02:00
Christoph Lendenfeld deleted branch slider_show_modified_property 2024-04-25 15:48:35 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Sybren A. Stüvel
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Asset System
Asset datablocks, libraries, browser and shelf

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Collada

  
Interest
Compatibility
Backward and forward compatibility

  
Interest
Compositing

  
Interest
Core

  
Interest
Cycles

  
Interest
Dependency Graph

  
Interest
Development Management

  
Interest
EEVEE

  
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
Viewport & EEVEE

  
Interest
Virtual Reality

  
Interest
Vulkan

  
Interest
Wayland
Wayland windowing on Unix

  
Interest
Workbench

  
Interest: X11

Xorg/X11 windowing

  
Legacy
Asset Browser Project

Archived

  
Legacy
Blender 2.8 Project

Archived

  
Legacy
Milestone 1: Basic, Local Asset Browser

Archived

  
Legacy
OpenGL Error

Archived

  
Meta
Good First Issue

  
Meta
Papercut

  
Meta
Retrospective

  
Meta
Security
Related to security, https://wiki.blender.org/wiki/Process/Vulnerability_Reports

  
Module
Animation & Rigging

  
Module
Core

  
Module
Development Management

  
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

  
Module
Viewport & EEVEE

  
Platform
FreeBSD

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Severity
High

  
Severity
Low

  
Severity
Normal

  
Severity
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

Archived

  
Type
Report

Archived

  
Type
To Do

No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
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
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
Viewport & EEVEE
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
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
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
Module
Viewport & EEVEE
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Severity
High
Severity
Low
Severity
Normal
Severity
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
4.2 LTS
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
3 Participants
Notifications
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#119920
No description provided.
Delete Branch "ChrisLend/blender:slider_show_modified_property"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?