GPv3: Mask toggle in dopesheet channel #121259

Pratik Borhade · 2024-04-30T12:43:04+02:00

Pratik Borhade commented

2024-04-30 12:43:04 +02:00

Add use_mask property in dopesheet layer channel

Main	PR

Add `use_mask` property in dopesheet layer channel | Main | PR | | -- | -- | | ![image](/attachments/f86effea-2838-47d1-8f6f-a73c449b04cf) | ![image](/attachments/f846ccfc-4a9c-404b-bfe1-d6f919a5967d) |

image.png

17 KiB

image.png

18 KiB

Pratik Borhade added 1 commit 2024-04-30 12:43:14 +02:00

f0e5150ec4 GPv3: Mask toggle in dopesheet channel

Add `use_mask` property in dopesheet layer channel

Pratik Borhade requested review from Falk David 2024-04-30 12:43:32 +02:00

Pratik Borhade added the

Module

Grease Pencil

label 2024-04-30 12:43:40 +02:00

Pratik Borhade added this to the Grease Pencil project 2024-04-30 12:43:50 +02:00

Falk David reviewed 2024-04-30 12:48:52 +02:00

Falk David left a comment

Thanks

Falk David reviewed 2024-04-30 12:49:23 +02:00

source/blender/editors/animation/anim_channels_defines.cc

						
				@ -5588,0 +5593,4 @@

				  const std::optional<std::string> layer_mask_rna_path = RNA_path_from_ID_to_property(

				      &ptr, layer_mask_prop);

				  if (RNA_path_resolve_property(&id_ptr, layer_mask_rna_path->c_str(), &ptr, &layer_mask_prop)) {

				    const int icon = layer->use_masks() ? ICON_CLIPUV_DEHLT : ICON_CLIPUV_HLT;

Falk David commented

2024-04-30 12:49:23 +02:00

Does this work here? Thinking of the onion skinning icon.

Pratik Borhade commented

2024-04-30 12:54:49 +02:00

Hi, current changes are working, yes. That's why I included both on-off icons in screenshot 🙃

If we want this to work like onion_skinning, we could add RNA_def_property_ui_icon(prop, ICON_CLIPUV_DEHLT , 1); for use_masks in rna_grease_pencil.cc. This will also involve some changes inside interface_template_grease_pencil_layer_tree.cc for mask property

Hi, current changes are working, yes. That's why I included both on-off icons in screenshot 🙃 - - - If we want this to work like onion_skinning, we could add `RNA_def_property_ui_icon(prop, ICON_CLIPUV_DEHLT , 1);` for use_masks in `rna_grease_pencil.cc`. This will also involve some changes inside `interface_template_grease_pencil_layer_tree.cc` for mask property

Falk David commented

2024-04-30 13:01:09 +02:00

Right it might be better to make the icon part of the RNA property like you suggested. I think that should make it more consistent!

Pratik Borhade commented

2024-04-30 13:32:27 +02:00

Actually, this doesn't work well for the use_mask property exposed in layer properties panel. The checkbox toggle shows the mask-icon. So I think it might be better to go with current definition 😅

Actually, this doesn't work well for the `use_mask` property exposed in layer properties panel. The checkbox toggle shows the mask-icon. So I think it might be better to go with current definition 😅 ![image](/attachments/89f8777c-3ef5-488e-8436-29e811d9e611)

Pratik Borhade commented

2024-04-30 13:45:49 +02:00

Following diff works but changes I did in properties_data_grease_pencil.py are more like a hack to fix the wrong icon shown in the above image.
Let me know if this diff is: 1) needed in this PR 2) not needed 3) expected to be submitted as separate PR

git diff :)

diff --git a/scripts/startup/bl_ui/properties_data_grease_pencil.py b/scripts/startup/bl_ui/properties_data_grease_pencil.py
index 010ffb6dc8b..5d7d3a03aad 100644
--- a/scripts/startup/bl_ui/properties_data_grease_pencil.py
+++ b/scripts/startup/bl_ui/properties_data_grease_pencil.py
@@ -46,7 +46,7 @@ class GreasePencil_LayerMaskPanel:
         grease_pencil = ob.data
         layer = grease_pencil.layers.active

-        self.layout.prop(layer, "use_masks", text="")
+        self.layout.prop(layer, "use_masks", text="", toggle=0, invert_checkbox=True)

     def draw(self, context):
         layout = self.layout
diff --git a/source/blender/editors/animation/anim_channels_defines.cc b/source/blender/editors/animation/anim_channels_defines.cc
index b62512c5069..a0e8bd61b52 100644
--- a/source/blender/editors/animation/anim_channels_defines.cc
+++ b/source/blender/editors/animation/anim_channels_defines.cc
@@ -5599,7 +5599,7 @@ static void draw_grease_pencil_layer_widgets(bAnimListElem *ale,
                   layer_mask_prop,
                   array_index,
                   "",
-                  icon,
+                  ICON_CLIPUV_DEHLT,
                   offset,
                   rect->ymin,
                   ICON_WIDTH,
diff --git a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
index 316e237dea2..116daabcd61 100644
--- a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
+++ b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
@@ -261,7 +261,7 @@ class LayerViewItem : public AbstractTreeViewItem {
     const int icon_mask = (layer_.base.flag & GP_LAYER_TREE_NODE_HIDE_MASKS) == 0 ?
                               ICON_CLIPUV_DEHLT :
                               ICON_CLIPUV_HLT;
-    uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, icon_mask);
+    uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, ICON_NONE);

     sub = uiLayoutRow(&row, true);
     uiLayoutSetActive(sub, layer_.parent_group().use_onion_skinning());
diff --git a/source/blender/makesrna/intern/rna_grease_pencil.cc b/source/blender/makesrna/intern/rna_grease_pencil.cc
index 36d9eab488f..172a2b42737 100644
--- a/source/blender/makesrna/intern/rna_grease_pencil.cc
+++ b/source/blender/makesrna/intern/rna_grease_pencil.cc
@@ -409,6 +409,7 @@ static void rna_def_grease_pencil_layer(BlenderRNA *brna)

   /* Use Masks. */
   prop = RNA_def_property(srna, "use_masks", PROP_BOOLEAN, PROP_NONE);
+  RNA_def_property_ui_icon(prop, ICON_CLIPUV_DEHLT, 1);
   RNA_def_property_boolean_negative_sdna(
       prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_HIDE_MASKS);
   RNA_def_property_ui_text(

Following diff works but changes I did in `properties_data_grease_pencil.py` are more like a hack to fix the wrong icon shown in the above image. Let me know if this diff is: 1) needed in this PR 2) not needed 3) expected to be submitted as separate PR <details> <summary> git diff :) </summary> ```Diff diff --git a/scripts/startup/bl_ui/properties_data_grease_pencil.py b/scripts/startup/bl_ui/properties_data_grease_pencil.py index 010ffb6dc8b..5d7d3a03aad 100644 --- a/scripts/startup/bl_ui/properties_data_grease_pencil.py +++ b/scripts/startup/bl_ui/properties_data_grease_pencil.py @@ -46,7 +46,7 @@ class GreasePencil_LayerMaskPanel: grease_pencil = ob.data layer = grease_pencil.layers.active - self.layout.prop(layer, "use_masks", text="") + self.layout.prop(layer, "use_masks", text="", toggle=0, invert_checkbox=True) def draw(self, context): layout = self.layout diff --git a/source/blender/editors/animation/anim_channels_defines.cc b/source/blender/editors/animation/anim_channels_defines.cc index b62512c5069..a0e8bd61b52 100644 --- a/source/blender/editors/animation/anim_channels_defines.cc +++ b/source/blender/editors/animation/anim_channels_defines.cc @@ -5599,7 +5599,7 @@ static void draw_grease_pencil_layer_widgets(bAnimListElem *ale, layer_mask_prop, array_index, "", - icon, + ICON_CLIPUV_DEHLT, offset, rect->ymin, ICON_WIDTH, diff --git a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc index 316e237dea2..116daabcd61 100644 --- a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc +++ b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc @@ -261,7 +261,7 @@ class LayerViewItem : public AbstractTreeViewItem { const int icon_mask = (layer_.base.flag & GP_LAYER_TREE_NODE_HIDE_MASKS) == 0 ? ICON_CLIPUV_DEHLT : ICON_CLIPUV_HLT; - uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, icon_mask); + uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, ICON_NONE); sub = uiLayoutRow(&row, true); uiLayoutSetActive(sub, layer_.parent_group().use_onion_skinning()); diff --git a/source/blender/makesrna/intern/rna_grease_pencil.cc b/source/blender/makesrna/intern/rna_grease_pencil.cc index 36d9eab488f..172a2b42737 100644 --- a/source/blender/makesrna/intern/rna_grease_pencil.cc +++ b/source/blender/makesrna/intern/rna_grease_pencil.cc @@ -409,6 +409,7 @@ static void rna_def_grease_pencil_layer(BlenderRNA *brna) /* Use Masks. */ prop = RNA_def_property(srna, "use_masks", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_ui_icon(prop, ICON_CLIPUV_DEHLT, 1); RNA_def_property_boolean_negative_sdna( prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_HIDE_MASKS); RNA_def_property_ui_text( ``` </details>

Falk David commented

2024-04-30 15:25:35 +02:00

to fix the wrong icon shown in the above image.

The image seems to have been deleted. Could you try and post it again? I'm not sure I understand what's going wrong in the data-properties mask panel.

> to fix the wrong icon shown in the above image. The image seems to have been deleted. Could you try and post it again? I'm not sure I understand what's going wrong in the data-properties mask panel.

Falk David commented

2024-04-30 15:56:19 +02:00

Looks like the mask icon is reversed in the icon sheet (e.g. the ON state comes before the OFF state) which is not the case for the other icons 🙄.

Here is a diff:

diff --git a/scripts/startup/bl_ui/properties_data_grease_pencil.py b/scripts/startup/bl_ui/properties_data_grease_pencil.py
index 8d1b162f214..6cbe189de9a 100644
--- a/scripts/startup/bl_ui/properties_data_grease_pencil.py
+++ b/scripts/startup/bl_ui/properties_data_grease_pencil.py
@@ -46,7 +46,7 @@ class GreasePencil_LayerMaskPanel:
         grease_pencil = ob.data
         layer = grease_pencil.layers.active
 
-        self.layout.prop(layer, "use_masks", text="")
+        self.layout.prop(layer, "use_masks", text="", toggle=0)
 
     def draw(self, context):
         layout = self.layout
diff --git a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
index 316e237dea2..b3b54daea95 100644
--- a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
+++ b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc
@@ -258,10 +258,7 @@ class LayerViewItem : public AbstractTreeViewItem {
 
     sub = uiLayoutRow(&row, true);
     uiLayoutSetActive(sub, layer_.parent_group().use_masks());
-    const int icon_mask = (layer_.base.flag & GP_LAYER_TREE_NODE_HIDE_MASKS) == 0 ?
-                              ICON_CLIPUV_DEHLT :
-                              ICON_CLIPUV_HLT;
-    uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, icon_mask);
+    uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, ICON_NONE);
 
     sub = uiLayoutRow(&row, true);
     uiLayoutSetActive(sub, layer_.parent_group().use_onion_skinning());
diff --git a/source/blender/makesrna/intern/rna_grease_pencil.cc b/source/blender/makesrna/intern/rna_grease_pencil.cc
index 36d9eab488f..a7999626d6c 100644
--- a/source/blender/makesrna/intern/rna_grease_pencil.cc
+++ b/source/blender/makesrna/intern/rna_grease_pencil.cc
@@ -409,6 +409,7 @@ static void rna_def_grease_pencil_layer(BlenderRNA *brna)
 
   /* Use Masks. */
   prop = RNA_def_property(srna, "use_masks", PROP_BOOLEAN, PROP_NONE);
+  RNA_def_property_ui_icon(prop, ICON_CLIPUV_HLT, -1);
   RNA_def_property_boolean_negative_sdna(
       prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_HIDE_MASKS);
   RNA_def_property_ui_text(

Looks like the mask icon is reversed in the icon sheet (e.g. the ON state comes before the OFF state) which is not the case for the other icons 🙄. Here is a diff: <details> ```Diff diff --git a/scripts/startup/bl_ui/properties_data_grease_pencil.py b/scripts/startup/bl_ui/properties_data_grease_pencil.py index 8d1b162f214..6cbe189de9a 100644 --- a/scripts/startup/bl_ui/properties_data_grease_pencil.py +++ b/scripts/startup/bl_ui/properties_data_grease_pencil.py @@ -46,7 +46,7 @@ class GreasePencil_LayerMaskPanel: grease_pencil = ob.data layer = grease_pencil.layers.active - self.layout.prop(layer, "use_masks", text="") + self.layout.prop(layer, "use_masks", text="", toggle=0) def draw(self, context): layout = self.layout diff --git a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc index 316e237dea2..b3b54daea95 100644 --- a/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc +++ b/source/blender/editors/interface/templates/interface_template_grease_pencil_layer_tree.cc @@ -258,10 +258,7 @@ class LayerViewItem : public AbstractTreeViewItem { sub = uiLayoutRow(&row, true); uiLayoutSetActive(sub, layer_.parent_group().use_masks()); - const int icon_mask = (layer_.base.flag & GP_LAYER_TREE_NODE_HIDE_MASKS) == 0 ? - ICON_CLIPUV_DEHLT : - ICON_CLIPUV_HLT; - uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, icon_mask); + uiItemR(sub, &layer_ptr, "use_masks", UI_ITEM_R_ICON_ONLY, nullptr, ICON_NONE); sub = uiLayoutRow(&row, true); uiLayoutSetActive(sub, layer_.parent_group().use_onion_skinning()); diff --git a/source/blender/makesrna/intern/rna_grease_pencil.cc b/source/blender/makesrna/intern/rna_grease_pencil.cc index 36d9eab488f..a7999626d6c 100644 --- a/source/blender/makesrna/intern/rna_grease_pencil.cc +++ b/source/blender/makesrna/intern/rna_grease_pencil.cc @@ -409,6 +409,7 @@ static void rna_def_grease_pencil_layer(BlenderRNA *brna) /* Use Masks. */ prop = RNA_def_property(srna, "use_masks", PROP_BOOLEAN, PROP_NONE); + RNA_def_property_ui_icon(prop, ICON_CLIPUV_HLT, -1); RNA_def_property_boolean_negative_sdna( prop, "GreasePencilLayerTreeNode", "flag", GP_LAYER_TREE_NODE_HIDE_MASKS); RNA_def_property_ui_text( ``` </details>

Pratik Borhade commented

2024-05-01 13:08:23 +02:00

Didn't notice that. I'll give a try :)

Pratik Borhade commented

2024-05-01 13:20:14 +02:00

Thanks, that worked :D
Updated the PR.

Thanks, that worked :D Updated the PR.

filedescriptor marked this conversation as resolved

Pratik Borhade added 1 commit 2024-05-01 13:19:25 +02:00

5438a7c296 Make icon part of rna property

Falk David approved these changes 2024-05-01 15:09:46 +02:00

Falk David left a comment

Thanks!

Falk David merged commit a42e2a5a29 into main

2024-05-01 15:10:33 +02:00

Falk David referenced this issue from a commit

2024-05-01 15:10:33 +02:00

GPv3: Mask toggle in dopesheet channel

Pratik Borhade deleted branch gpv3-mask-channel-toggle

2024-05-01 15:20:03 +02:00

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

GPv3: Mask toggle in dopesheet channel #121259