Update "Input Samples" settings as brush data #108109

New Issue

Julien Kaspar · 2023-05-20T17:20:17+02:00

Julien Kaspar commented

2023-05-20 17:20:17 +02:00

(NOTE) This task is part of the community & sub tasks of the workboard. Anyone is free to pick up this task and contribute. For any questions or needed reviewers, please tag @Sergey @HooglyBoogly and @JulienKaspar.

Currently the brush setting "Input Samples" (tool_settings.sculpt.input_samples) is stored in bpy.data.scenes["Scene"].

To follow useful conventions with other brush settings, this should be updated to be stored in bpy.data.brushes["Brush"] instead. For the use case of having the input samples unified between all brushes, an additional scene property bpy.data.scenes["Scene"].tool_settings.unified_paint_settings.use_unified_input_samples should be added, including a a button to toggle it in the UI.

A mockup:

(NOTE) This task is part of the community & sub tasks of the workboard. Anyone is free to pick up this task and contribute. For any questions or needed reviewers, please tag @Sergey @HooglyBoogly and @JulienKaspar. Currently the brush setting "Input Samples" (`tool_settings.sculpt.input_samples`) is stored in `bpy.data.scenes["Scene"]`. To follow useful conventions with other brush settings, this should be updated to be stored in `bpy.data.brushes["Brush"]` instead. For the use case of having the input samples unified between all brushes, an additional scene property `bpy.data.scenes["Scene"].tool_settings.unified_paint_settings.use_unified_input_samples` should be added, including a a button to toggle it in the UI. A mockup: ![400_input_samples.png](/attachments/87b97260-ecd4-4f6e-a11a-ef13bdf1cd22)

400_input_samples.png

60 KiB

Julien Kaspar added the

Type

To Do

Module

Sculpt, Paint & Texture

labels 2023-05-20 17:20:17 +02:00

Julien Kaspar added this to the Sculpt, Paint & Texture project 2023-05-20 17:20:18 +02:00

Julien Kaspar referenced this issue

2023-09-04 10:39:21 +02:00

Input Sample on Sculpt Brushes isn't Saved with Brushes #111906

Sean Kim commented

2023-12-15 17:55:12 +01:00

Heyo, I was looking around for ways to dip my toes into contributing with Blender recently and this seemed like a pretty self contained issue to work on. I'll reach out in the module channel if I have any particular questions, but I just wanted to put a note here to avoid duplicate work if anyone else happened to stumble upon this task.

Julien Kaspar commented

2023-12-19 12:55:45 +01:00

@Sean-Kim That sounds great! Thanks for looking into this 👍

Sean Kim commented

2023-12-21 06:04:21 +01:00

Is this expected to be a breaking change on the user side of things or does the PR need to address making sure that if a user had a value set in the current stroke settings that it then gets reflected in the new field in the unified_paint_settings and also has the appropriate use_unified_input_samples flag marked?

Is this expected to be a breaking change on the user side of things or does the PR need to address making sure that if a user had a value set in the current stroke settings that it then gets reflected in the new field in the `unified_paint_settings` and also has the appropriate `use_unified_input_samples` flag marked?

Julien Kaspar commented

2023-12-21 10:56:54 +01:00

@Sean-Kim I would expect the value that is already set in existing files to be used for the unfified scene value. But the use_unified_input_samples flag shouldn't be set by default.

@Sean-Kim I would expect the value that is already set in existing files to be used for the unfified scene value. But the `use_unified_input_samples` flag shouldn't be set by default.

👍 1

Sean Kim commented

2024-01-11 03:39:27 +01:00

@JulienKaspar So, I think I've found a bit of a wrinkle in the proposed plan. By moving this data to UnifiedPaintSettings there's a bit of flexibility that the current implementation allows that wouldn't be able to be replicated with a single value.

Currently, the input_samples value is consistent across all brushes within a particular mode (e.g. Sculpt vs Vertex Paint). By having a value & flag within the UnifiedPaintSettings it would mean that users wouldn't be able to have a separate input_samples value for different modes, they would need to have that data changed on each individual brush.

I'm unsure if this is actually an issue in practice or if this is a contrived example, thoughts?

@JulienKaspar So, I think I've found a bit of a wrinkle in the proposed plan. By moving this data to `UnifiedPaintSettings` there's a bit of flexibility that the current implementation allows that wouldn't be able to be replicated with a single value. Currently, the `input_samples` value is consistent across all brushes within a particular mode (e.g. Sculpt vs Vertex Paint). By having a value & flag within the `UnifiedPaintSettings` it would mean that users wouldn't be able to have a separate `input_samples` value for different modes, they would need to have that data changed on each individual brush. I'm unsure if this is actually an issue in practice or if this is a contrived example, thoughts?

Sean Kim referenced this issue

2024-01-13 00:13:50 +01:00

Sculpt: Add per-brush input samples #117080

Sean Kim referenced this issue from blender/blender-manual

2024-01-30 01:13:27 +01:00

Sculpt: Update Propagation Steps docs #104692

Hans Goudey referenced this issue from a commit

2024-01-30 05:08:35 +01:00

Sculpt: Add per-brush input samples

Bastien Montagne referenced this issue from a commit

2024-02-05 10:46:50 +01:00

Sculpt: Update Propagation Steps docs