blender/blender
165
519
Fork 792
Code Issues 6.8k Pull Requests 951 Projects 21 Wiki Activity

UI: Rename Bright/Contrast to Brightness/Contrast #104998

Merged
Daniel Salazar merged 12 commits from zanqdo/blender:brightness-contrast-node-rename into main 2023-04-11 21:32:40 +02:00
Conversation 11 Commits 12 Files Changed 6 +10 -10
Daniel Salazar commented 2023-02-21 01:05:33 +01:00
Member
Copy Link

Rename Bright/Contrast to Brightness/Contrast in order to avoid the use of shortened names and improve consistency within Blender and with industry conventions.

Reasoning:

The modified color characteristic is called brightness, not bright. You don't modify the bright of an image.

This also interferes with search in case someone searches for brightness, producing no results.
image

Note: This patch should only touch UI names which do not need versioning. It leaves the actual property name in nodes for a future patch, probably made by someone with more knowledge than me.

image

Rename *Bright/Contrast* to *Brightness/Contrast* in order to avoid the use of shortened names and improve consistency within Blender and with industry conventions. Reasoning: The modified color characteristic is called *brightness*, not *bright*. You don't modify the *bright* of an image. This also interferes with search in case someone searches for brightness, producing no results. ![image](/attachments/89db04c7-3fb3-44bd-88db-8054dcb9ffea) *Note: This patch should only touch UI names which do not need versioning. It leaves the actual property name in nodes for a future patch, probably made by someone with more knowledge than me.* ![image](/attachments/2ecdd066-e311-432d-8e7c-e6fbeaac9b43)
image.png
3.9 KiB
image.png
11 KiB
Daniel Salazar added 1 commit 2023-02-21 01:05:45 +01:00 
In order to avoid the use of shortened names and improve consistency
within Blender and with industry conventions
Daniel Salazar added 1 commit 2023-02-24 22:42:11 +01:00
Daniel Salazar added 1 commit 2023-02-25 02:51:39 +01:00
Hans Goudey requested changes 2023-03-23 15:35:25 +01:00
Hans Goudey left a comment
Member
Copy Link

Nice! You should be able to change the socket names (not identifiers) in the node declarations pretty simply. You can specify the name and identifier separately like this:

  b.add_input<decl::Float>(N_("Brightness"), "Bright")
      .default_value(0.0f)
      .min(-100.0f)
      .max(100.0f);

Still worth double checking that old files work fine with that, bit it should be fine.

Nice! You should be able to change the socket names (not identifiers) in the node declarations pretty simply. You can specify the name and identifier separately like this: ``` b.add_input<decl::Float>(N_("Brightness"), "Bright") .default_value(0.0f) .min(-100.0f) .max(100.0f); ``` Still worth double checking that old files work fine with that, bit it should be fine.
source/blender/editors/sculpt_paint/paint_vertex_color_ops.cc Outdated
@ -343,2 +342,3 @@
ot->name = "Vertex Paint Brightness Contrast";
ot->idname = "PAINT_OT_vertex_color_brightness_contrast";
ot->description = "Adjust vertex color brightness/contrast";
ot->description = "Adjust vertex color brightness contrast";
Hans Goudey commented 2023-03-23 15:34:25 +01:00
Member
Copy Link

I think the slash is correct here, and in some other places. Or at least it should be replaced with an "and". Otherwise it sounds wrong.

I think the slash is correct here, and in some other places. Or at least it should be replaced with an "and". Otherwise it sounds wrong.
Daniel Salazar added 2 commits 2023-03-24 05:33:37 +01:00
Daniel Salazar reviewed 2023-03-24 05:38:15 +01:00
source/blender/editors/sculpt_paint/paint_vertex_color_ops.cc Outdated
@ -343,2 +342,3 @@
ot->name = "Vertex Paint Brightness Contrast";
ot->idname = "PAINT_OT_vertex_color_brightness_contrast";
ot->description = "Adjust vertex color brightness/contrast";
ot->description = "Adjust vertex color brightness contrast";
Daniel Salazar commented 2023-03-24 05:36:07 +01:00
Author
Member
Copy Link

I see what you mean. But then what do we do with Hue Saturation Value? I'm looking for consistency between similar nodes.

I see what you mean. But then what do we do with Hue Saturation Value? I'm looking for consistency between similar nodes.
Daniel Salazar commented 2023-03-24 05:44:52 +01:00
Author
Member
Copy Link

Nice! You should be able to change the socket names (not identifiers) in the node declarations pretty simply. You can specify the name and identifier separately like this:

  b.add_input<decl::Float>(N_("Brightness"), "Bright")
      .default_value(0.0f)
      .min(-100.0f)
      .max(100.0f);

Still worth double checking that old files work fine with that, bit it should be fine.

I've pushed this change but it does change the API from this:

node.inputs['Bright']

to:

node.inputs['Brightness']

Which can break scripts

> Nice! You should be able to change the socket names (not identifiers) in the node declarations pretty simply. You can specify the name and identifier separately like this: > > ``` > b.add_input<decl::Float>(N_("Brightness"), "Bright") > .default_value(0.0f) > .min(-100.0f) > .max(100.0f); > ``` > Still worth double checking that old files work fine with that, bit it should be fine. I've pushed this change but it does change the API from this: `node.inputs['Bright']` to: `node.inputs['Brightness']` Which can break scripts
Brecht Van Lommel commented 2023-03-24 14:49:21 +01:00
Owner
Copy Link

Please don't change the socket names until 4.0, the API does not distinguish between them properly so it's a breaking change.

Please don't change the socket names until 4.0, the API does not distinguish between them properly so it's a breaking change.
👍 1
Hans Goudey commented 2023-03-25 17:02:04 +01:00
Member
Copy Link

Ah right, I forgot about that, thanks. Maybe we should change that in 4.0 actually, it really shouldn't work that way...

Ah right, I forgot about that, thanks. Maybe we should change that in 4.0 actually, it really shouldn't work that way...
Daniel Salazar added 2 commits 2023-03-25 20:34:21 +01:00
Daniel Salazar commented 2023-03-25 20:36:36 +01:00
Author
Member
Copy Link

Alright reverted the socket name changes. Now all it's left is to decide a standard for this type of combo nodes's naming. Example:

Hue Saturation Value
Brightness Contrast

Hue-Saturation-Value
Brightness-Contrast

Hue/Saturation/Value
Brightness/Contrast

I think dashes should be reserved to tied words, for example black-body. For combo nodes I prefer nothing at all.

Alright reverted the socket name changes. Now all it's left is to decide a standard for this type of combo nodes's naming. Example: Hue Saturation Value Brightness Contrast Hue-Saturation-Value Brightness-Contrast Hue/Saturation/Value Brightness/Contrast I think dashes should be reserved to tied words, for example *black-body*. For combo nodes I prefer nothing at all.
Hans Goudey commented 2023-03-25 21:29:17 +01:00
Member
Copy Link

Personally I think I like the option with the slashes best. I like that it distinguishes from the typical verb-first naming from geometry nodes or the "single object" naming from shader nodes like "Principled BSDF". Compared to the other names it emphasizes how the words aren't meant to be combined the same way.

I could also see it being unnecessary complexity though, and I don't really have a strong opinion.

Personally I think I like the option with the slashes best. I like that it distinguishes from the typical verb-first naming from geometry nodes or the "single object" naming from shader nodes like "Principled BSDF". Compared to the other names it emphasizes how the words aren't meant to be combined the same way. I could also see it being unnecessary complexity though, and I don't really have a strong opinion.
Hans Goudey changed title from WIP: Rename Bright/Contrast to Brightness Contrast to WIP: Nodes: Rename Bright/Contrast to Brightness Contrast 2023-03-27 16:06:15 +02:00
Daniel Salazar closed this pull request 2023-04-05 09:56:08 +02:00
Daniel Salazar reopened this pull request 2023-04-05 09:56:56 +02:00
Pablo Vazquez commented 2023-04-05 12:18:44 +02:00
Member
Copy Link

Personally I think I like the option with the slashes best.

I like the version with the slashes best too, but I wonder if that's going to prevent search from finding the node by typing "HSL", since fuzzy search looks for the first letter of each word.

Daniel, have you tested if search is affected? (both search from the Add menu and F3)

> Personally I think I like the option with the slashes best. I like the version with the slashes best too, but I wonder if that's going to prevent search from finding the node by typing "HSL", since fuzzy search looks for the first letter of each word. Daniel, have you tested if search is affected? (both search from the Add menu and F3)
Hans Goudey commented 2023-04-05 14:23:52 +02:00
Member
Copy Link

If needed, we could change fuzzy search to split by slashes too, in addition to spaces.

If needed, we could change fuzzy search to split by slashes too, in addition to spaces.
👍 2
Daniel Salazar changed title from WIP: Nodes: Rename Bright/Contrast to Brightness Contrast to WIP: Nodes: Rename Bright/Contrast to Brightness/Contrast 2023-04-05 20:16:33 +02:00
Daniel Salazar commented 2023-04-05 20:20:28 +02:00
Author
Member
Copy Link

Personally I think I like the option with the slashes best.

I like the version with the slashes best too, but I wonder if that's going to prevent search from finding the node by typing "HSL", since fuzzy search looks for the first letter of each word.

Daniel, have you tested if search is affected? (both search from the Add menu and F3)

@HooglyBoogly @pablovazquez

Alright seems like we have consensus? I personally like the readability without the slashes best.But if slashes are preferred all I ask is consistency in other similar nodes like Hue Saturation Value which I would shortly rename into Hue/Saturation/Value. Agreed?

image

> > Personally I think I like the option with the slashes best. > > I like the version with the slashes best too, but I wonder if that's going to prevent search from finding the node by typing "HSL", since fuzzy search looks for the first letter of each word. > > Daniel, have you tested if search is affected? (both search from the Add menu and F3) @HooglyBoogly @pablovazquez Alright seems like we have consensus? I personally like the readability **without** the slashes best.But if slashes are preferred all I ask is consistency in other similar nodes like *Hue Saturation Value* which I would shortly rename into *Hue/Saturation/Value*. Agreed? ![image](/attachments/6a2e6d33-3a5e-44d4-97f5-3bdffef9465d)
image.png
17 KiB
Daniel Salazar added 1 commit 2023-04-06 03:05:41 +02:00
Daniel Salazar added 2 commits 2023-04-06 03:23:49 +02:00
Daniel Salazar changed title from WIP: Nodes: Rename Bright/Contrast to Brightness/Contrast to Nodes: Rename Bright/Contrast to Brightness/Contrast 2023-04-06 03:28:45 +02:00
Daniel Salazar requested review from Hans Goudey 2023-04-06 03:29:05 +02:00
Pablo Vazquez commented 2023-04-07 11:50:02 +02:00
Member
Copy Link

But if slashes are preferred all I ask is consistency in other similar nodes like Hue Saturation Value which I would shortly rename into Hue/Saturation/Value. Agreed?

Yep. Consistency is key.

> But if slashes are preferred all I ask is consistency in other similar nodes like *Hue Saturation Value* which I would shortly rename into *Hue/Saturation/Value*. Agreed? Yep. Consistency is key.
👍 1
Daniel Salazar added 1 commit 2023-04-07 20:44:40 +02:00
Daniel Salazar added 1 commit 2023-04-07 20:47:16 +02:00
Missing name change on a comment
All checks were successful
buildbot/vexp-code-patch-coordinator Build done.
Details
957aeb80e1
Daniel Salazar commented 2023-04-07 20:54:18 +02:00
Author
Member
Copy Link

@blender-bot build

@blender-bot build
Daniel Salazar changed title from Nodes: Rename Bright/Contrast to Brightness/Contrast to UI: Rename Bright/Contrast to Brightness/Contrast 2023-04-08 22:20:50 +02:00
Daniel Salazar commented 2023-04-08 22:21:23 +02:00
Author
Member
Copy Link

I've changed the tag to UI: since this affects operators for vertex colors, sequencer and grease pencil too. But it's nothing more than a UI change.

I've changed the tag to *UI:* since this affects operators for vertex colors, sequencer and grease pencil too. But it's nothing more than a UI change.
Hans Goudey requested review from Pablo Vazquez 2023-04-11 15:47:47 +02:00
Pablo Vazquez approved these changes 2023-04-11 16:18:23 +02:00
Hans Goudey approved these changes 2023-04-11 21:15:05 +02:00
Daniel Salazar merged commit f8108d6dfd into main 2023-04-11 21:32:40 +02:00
Daniel Salazar deleted branch brightness-contrast-node-rename 2023-04-11 21:32:41 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Pablo Vazquez
Hans Goudey
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Code Documentation
Code comments, Python/RNA API descriptions

  
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 & 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, see policy: https://developer.blender.org/docs/handbook/bug_reports/vulnerability_reports/

  
Module
Animation & Rigging

  
Module
Asset System
Asset datablocks, libraries, browser and shelf

  
Module
Asset System

  
Module
Core

  
Module
Development Management

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline & 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
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Code Documentation
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 & 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
Asset System
Module
Asset System
Module
Core
Module
Development Management
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline & 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
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
4 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#104998
No description provided.
Delete Branch "zanqdo/blender:brightness-contrast-node-rename"

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?