Update sculpt mode symmetry options as properties of meshes #108107

New Issue

Julien Kaspar · 2023-05-20T16:58:37+02:00

Julien Kaspar commented

2023-05-20 16:58:37 +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.

There have been multiple patches to improve the symmetry behavior on painting/sculpt modes:

Some bpy.data.scenes properties have been left out of this and still need to be unified as a mesh property instead:

tool_settings.sculpt.lock_x
tool_settings.sculpt.lock_y
tool_settings.sculpt.lock_z
tool_settings.sculpt.use_symmetry_feather
tool_settings.sculpt.radial_symmetry[0]
tool_settings.sculpt.radial_symmetry[1]
tool_settings.sculpt.radial_symmetry[2]
tool_settings.sculpt.tile_offset[0]
tool_settings.sculpt.tile_offset[1]
tool_settings.sculpt.tile_offset[2]
tool_settings.sculpt.symmetrize_direction

(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. There have been multiple patches to improve the symmetry behavior on painting/sculpt modes: - 5502517c3c - fa9b05149c2ca3915a4fb2670c87a648d927336c Some `bpy.data.scenes` properties have been left out of this and still need to be unified as a mesh property instead: - `tool_settings.sculpt.lock_x` - `tool_settings.sculpt.lock_y` - `tool_settings.sculpt.lock_z` - `tool_settings.sculpt.use_symmetry_feather` - `tool_settings.sculpt.radial_symmetry[0]` - `tool_settings.sculpt.radial_symmetry[1]` - `tool_settings.sculpt.radial_symmetry[2]` - `tool_settings.sculpt.tile_offset[0]` - `tool_settings.sculpt.tile_offset[1]` - `tool_settings.sculpt.tile_offset[2]` - `tool_settings.sculpt.symmetrize_direction`

Julien Kaspar added the

Sculpt, Paint & Texture

labels 2023-05-20 16:58:38 +02:00

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

Julien Kaspar changed title from ~~Update all sculpt mode symmetry options properties of meshes~~ to Update sculpt mode symmetry options as properties of meshes

2023-05-20 16:59:03 +02:00

dgkf commented

2023-05-24 00:10:01 +02:00

Thanks for filing this as a Good First Issue! I've been keen to contribute for a while and waiting for some new issues to drop!

This looks like it's within my capabilities and would be a good entry into contributing to blender. With a quick glance through the other PRs you linked, I think I have a reasonable idea of what needs to happen - at least enough to do my due diligence trying to understand what the changes would look like. I'll follow up if I need more guidance.

Thanks for filing this as a _Good First Issue_! I've been keen to contribute for a while and waiting for some new issues to drop! This looks like it's within my capabilities and would be a good entry into contributing to blender. With a quick glance through the other PRs you linked, I think I have a reasonable idea of what needs to happen - at least enough to do my due diligence trying to understand what the changes would look like. I'll follow up if I need more guidance.

❤️ 1

dgkf commented

2023-05-29 05:08:57 +02:00

Hi @JosephEagar and @JulienKaspar, just following up with a small progress update and looking for feedback to make sure I'm heading in the right direction.

I've only tackled the tool_settings.sculpt.lock_[x|y|z] settings so far (6e1457e857) and wanted to get confirmation that my approach is what you had in mind before continuing with the rest.

Just to outline briefly what has been done:

A new mesh data lock field was added. Modeled after the symmetry field, this is a char that uses bit encoding to flag locked axes
6e1457e857 (diff-81f02e349c4d2da7313556c5d876fc3d01779090)
These flags are exposed in the mesh RNA as lock_[x|y|z]
6e1457e857 (diff-fb1b990e2905fb7e654c85fc4542ea07d0bc800d)
These flags are exposed in the unified object RNA through use_mesh_lock_[x|y|z]
6e1457e857 (diff-de8ed8944af694d61797d1b4d07e15c385c6bafa)
SCULPT_clip updated to provide object data through which we extract the mesh-associated fields
6e1457e857 (diff-e836d5c7c3c5232ac739532fdb40db8abca0a18d)
The sculpt symmetry paint panel now registers mesh properties instead of sculpt tool settings
6e1457e857 (diff-8bce79955e727d966a996c81b733c12d54456e1c)

And a couple questions as I'm continuing to chip away at this:

How would you like to tackle lifecycle management of the tools_settings.sculpt.* variety? Does this functionality need to continue in a deprecated capacity?
I haven't delved into unit testing yet. What would be the expectations for adding tests for a PR like this?

Hi @JosephEagar and @JulienKaspar, just following up with a small progress update and looking for feedback to make sure I'm heading in the right direction. I've only tackled the `tool_settings.sculpt.lock_[x|y|z]` settings so far (https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef) and wanted to get confirmation that my approach is what you had in mind before continuing with the rest. Just to outline briefly what has been done: - A new mesh data `lock` field was added. Modeled after the `symmetry` field, this is a `char` that uses bit encoding to flag locked axes https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef#diff-81f02e349c4d2da7313556c5d876fc3d01779090 - These flags are exposed in the mesh RNA as `lock_[x|y|z]` https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef#diff-fb1b990e2905fb7e654c85fc4542ea07d0bc800d - These flags are exposed in the unified object RNA through `use_mesh_lock_[x|y|z]` https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef#diff-de8ed8944af694d61797d1b4d07e15c385c6bafa - `SCULPT_clip` updated to provide object data through which we extract the mesh-associated fields https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef#diff-e836d5c7c3c5232ac739532fdb40db8abca0a18d - The sculpt symmetry paint panel now registers mesh properties instead of sculpt tool settings https://projects.blender.org/dgkf/blender/commit/6e1457e857a345b909f610f660ed9af745922cef#diff-8bce79955e727d966a996c81b733c12d54456e1c And a couple questions as I'm continuing to chip away at this: - How would you like to tackle lifecycle management of the `tools_settings.sculpt.*` variety? Does this functionality need to continue in a deprecated capacity? - I haven't delved into unit testing yet. What would be the expectations for adding tests for a PR like this?

dgkf commented

2023-06-01 04:39:23 +02:00

@JosephEagar and @JulienKaspar - Just following up to see if I can get some eyes on this work-in-progress. See last comment for some description of where I'm at.

Hoping to get confirmation/course correction before the weekend when I can put a bit more time into this.

@JosephEagar and @JulienKaspar - Just following up to see if I can get some eyes on this work-in-progress. See last comment for some description of where I'm at. Hoping to get confirmation/course correction before the weekend when I can put a bit more time into this.

Joseph Eagar commented

2023-06-05 18:46:09 +02:00

We might want to think about using a struct.

typedef struct PaintSymmetry {
  char symmetry;
  char symmetrize_direction;
  char lock;
  char feather;
  float tile[3];
  float radial_symmetry[3];
} PaintSymmetry;

But that can come later. What you've done so far is a good start.

We might want to think about using a struct. ```C typedef struct PaintSymmetry { char symmetry; char symmetrize_direction; char lock; char feather; float tile[3]; float radial_symmetry[3]; } PaintSymmetry; ``` But that can come later. What you've done so far is a good start.

👍 1

dgkf referenced a pull request that will close this issue

2023-07-16 03:42:47 +02:00

Unifying sculpt, weight paint & vertex paint symmetry options under mesh properties #110156

Sign in to join this conversation.