Add option to hide UV mask effect.

Author: Nusiq

docs/img/color_mask.png

@@ -15,6 +15,12 @@ sides (side1-6) are corelated to their placement on the texture.
 New masks are added with "Add mask" dropdown menu. There are 8 different types
 of masks.
 
+
+!!! note
+
+    All masks have an eye icon in the upper right corner that can be used to
+    temporarily disable / enable the mask.
+
 ## Color Palette Mask
 ![](../img/color_palette_mask.png)
 

docs/img/color_palette_mask.png

@@ -65,7 +65,7 @@
     "author": "Artur",
     "description": "",
     "blender": (2, 80, 0),
-    "version": (5, 0, 4),  # COMPATIBILITY BREAKING CHANGE, NEW FEATURE, BUGFIX
+    "version": (5, 1, 0),  # COMPATIBILITY BREAKING CHANGE, NEW FEATURE, BUGFIX
     "location": "",
     "warning": "",
     "category": "Generic"

docs/img/ellipse_mask.png

@@ -145,6 +145,16 @@ def apply(self, image: np.ndarray):
     def get_mask(self, image: np.array) -> np.array:
         '''Returns 2D matrix with the filter array.'''
 
+
+class DummyMask(MultiplicativeMask):
+    '''
+    A multiplicative mask that always return a white image.
+    '''
+    def get_mask(self, image):
+        w, h, _ = image.shape
+        return np.ones((w, h))[:,:, np.newaxis]
+    
+
 class Stripe(NamedTuple):
     '''
     Stripes are used in StripesMask and ColorPaletteMask mask in a collection
@@ -620,7 +630,10 @@ def _get_masks_from_side(side: Iterable, n_steps: int) -> Sequence[Mask]:
                     mode=s_props.mode)
             else:
                 raise ValueError('Unknown mask type')
-            result.append(mask)
+            if s_props.ui_hidden:
+                result.append(DummyMask())
+            else:
+                result.append(mask)
         return tuple(result)
 
     return  _get_masks_from_side(iter(side), n_steps=len(side))

docs/img/gradient_mask.png

@@ -36,6 +36,8 @@ class OBJECT_NusiqMcblendColorProperties(bpy.types.PropertyGroup):
 # UV-mask properties
 class OBJECT_NusiqMcblendUvMaskProperties(bpy.types.PropertyGroup):
     '''Properties of UV-mask.'''
+    ui_hidden: BoolProperty(  # type: ignore
+        name='Hide', default=False)
     ui_collapsed: BoolProperty(  # type: ignore
         name='Collapse', default=False)
     mask_type: EnumProperty(  # type: ignore
@@ -511,6 +513,7 @@ def draw_mask(
             # box.scale_x = True
             col = box.column()
             row = col.row()
+
             if mask.ui_collapsed:
                 row.prop(
                     mask, "ui_collapsed", text="", icon='DISCLOSURE_TRI_RIGHT',
@@ -535,6 +538,15 @@ def draw_mask(
                     text='')
                 op_props.move_from = index
                 op_props.move_to = index + 1
+            # Hide button
+            if mask.ui_hidden:
+                row.prop(
+                    mask, "ui_hidden", text="", icon='HIDE_ON',
+                    emboss=False)
+            else:
+                row.prop(
+                    mask, "ui_hidden", text="", icon='HIDE_OFF',
+                    emboss=False)
             # Delete button
             op_props = row.operator(
                 "object.nusiq_mcblend_remove_uv_mask", icon='X', text='')