GPencil: Add "Self Overlap" parameter to materials to disable Stencil
[blender.git] / release / scripts / startup / bl_ui / properties_material_gpencil.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20 import bpy
21 from bpy.types import Menu, Panel, UIList
22 from rna_prop_ui import PropertyPanel
23 from bl_ui.utils import PresetPanel
24
25 from bl_ui.properties_grease_pencil_common import (
26     GreasePencilMaterialsPanel,
27 )
28
29
30 class GPENCIL_MT_color_context_menu(Menu):
31     bl_label = "Layer"
32
33     def draw(self, _context):
34         layout = self.layout
35
36         layout.operator("gpencil.color_reveal", icon='RESTRICT_VIEW_OFF', text="Show All")
37         layout.operator("gpencil.color_hide", icon='RESTRICT_VIEW_ON', text="Hide Others").unselected = True
38
39         layout.separator()
40
41         layout.operator("gpencil.color_lock_all", icon='LOCKED', text="Lock All")
42         layout.operator("gpencil.color_unlock_all", icon='UNLOCKED', text="UnLock All")
43
44         layout.operator("gpencil.stroke_lock_color", text="Lock Unselected")
45         layout.operator("gpencil.lock_layer", text="Lock Unused")
46
47
48 class GPENCIL_UL_matslots(UIList):
49     def draw_item(self, _context, layout, _data, item, icon, _active_data, _active_propname, _index):
50         slot = item
51         ma = slot.material
52         if (ma is not None) and (ma.grease_pencil is not None):
53             gpcolor = ma.grease_pencil
54
55             if self.layout_type in {'DEFAULT', 'COMPACT'}:
56                 if gpcolor.lock:
57                     layout.active = False
58
59                 row = layout.row(align=True)
60                 row.enabled = not gpcolor.lock
61                 row.prop(ma, "name", text="", emboss=False, icon_value=icon)
62
63                 row = layout.row(align=True)
64                 row.prop(gpcolor, "lock", text="", emboss=False)
65                 row.prop(gpcolor, "hide", text="", emboss=False)
66                 if gpcolor.ghost is True:
67                     icon = 'ONIONSKIN_OFF'
68                 else:
69                     icon = 'ONIONSKIN_ON'
70                 row.prop(gpcolor, "ghost", text="", icon=icon, emboss=False)
71
72             elif self.layout_type == 'GRID':
73                 layout.alignment = 'CENTER'
74                 layout.label(text="", icon_value=icon)
75
76
77 class GPMaterialButtonsPanel:
78     bl_space_type = 'PROPERTIES'
79     bl_region_type = 'WINDOW'
80     bl_context = "material"
81
82     @classmethod
83     def poll(cls, context):
84         ma = context.material
85         return ma and ma.grease_pencil
86
87
88 class MATERIAL_PT_gpencil_slots(GreasePencilMaterialsPanel, Panel):
89     bl_label = "Grease Pencil Material Slots"
90     bl_space_type = 'PROPERTIES'
91     bl_region_type = 'WINDOW'
92     bl_context = "material"
93     bl_options = {'HIDE_HEADER'}
94
95     @classmethod
96     def poll(cls, context):
97         ob = context.object
98         ma = context.material
99
100         return (ma and ma.grease_pencil) or (ob and ob.type == 'GPENCIL')
101
102
103 # Used as parent for "Stroke" and "Fill" panels
104 class MATERIAL_PT_gpencil_surface(GPMaterialButtonsPanel, Panel):
105     bl_label = "Surface"
106
107     def draw_header_preset(self, _context):
108         MATERIAL_PT_gpencil_material_presets.draw_panel_header(self.layout)
109
110     def draw(self, _context):
111         layout = self.layout
112         layout.use_property_split = True
113
114
115 class MATERIAL_PT_gpencil_strokecolor(GPMaterialButtonsPanel, Panel):
116     bl_label = "Stroke"
117     bl_parent_id = 'MATERIAL_PT_gpencil_surface'
118
119     def draw_header(self, context):
120         ma = context.material
121         if ma is not None and ma.grease_pencil is not None:
122             gpcolor = ma.grease_pencil
123             self.layout.enabled = not gpcolor.lock
124             self.layout.prop(gpcolor, "show_stroke", text="")
125
126     def draw(self, context):
127         layout = self.layout
128         layout.use_property_split = True
129
130         ma = context.material
131         if ma is not None and ma.grease_pencil is not None:
132             gpcolor = ma.grease_pencil
133
134             col = layout.column()
135             col.enabled = not gpcolor.lock
136
137             col.prop(gpcolor, "mode")
138
139             col.prop(gpcolor, "stroke_style", text="Style")
140
141             if gpcolor.stroke_style == 'TEXTURE':
142                 row = col.row()
143                 row.enabled = not gpcolor.lock
144                 col = row.column(align=True)
145                 col.template_ID(gpcolor, "stroke_image", open="image.open")
146                 if gpcolor.mode == 'LINE':
147                     col.prop(gpcolor, "pixel_size", text="UV Factor")
148
149                 col.prop(gpcolor, "use_stroke_pattern", text="Use As Stencil Mask")
150                 if gpcolor.use_stroke_pattern is False:
151                     col.prop(gpcolor, "use_stroke_texture_mix", text="Mix Color")
152                     if gpcolor.use_stroke_texture_mix is True:
153                         col.prop(gpcolor, "mix_stroke_factor", text="Factor")
154
155             if (
156                     gpcolor.stroke_style == 'SOLID' or
157                     gpcolor.use_stroke_pattern or
158                     gpcolor.use_stroke_texture_mix
159             ):
160                 col.prop(gpcolor, "color", text="Color")
161
162             if gpcolor.mode in {'DOTS', 'BOX'}:
163                 col.prop(gpcolor, "alignment_mode")
164
165             if gpcolor.mode == 'LINE':
166                 col.prop(gpcolor, "use_overlap_strokes")
167
168 class MATERIAL_PT_gpencil_fillcolor(GPMaterialButtonsPanel, Panel):
169     bl_label = "Fill"
170     bl_parent_id = 'MATERIAL_PT_gpencil_surface'
171
172     def draw_header(self, context):
173         ma = context.material
174         gpcolor = ma.grease_pencil
175         self.layout.enabled = not gpcolor.lock
176         self.layout.prop(gpcolor, "show_fill", text="")
177
178     def draw(self, context):
179         layout = self.layout
180         layout.use_property_split = True
181
182         ma = context.material
183         gpcolor = ma.grease_pencil
184
185         # color settings
186         col = layout.column()
187         col.enabled = not gpcolor.lock
188         col.prop(gpcolor, "fill_style", text="Style")
189
190         if gpcolor.fill_style == 'GRADIENT':
191             col.prop(gpcolor, "gradient_type")
192
193         if gpcolor.fill_style != 'TEXTURE':
194             col.prop(gpcolor, "fill_color", text="Color")
195
196             if gpcolor.fill_style in {'GRADIENT', 'CHECKER'}:
197                 col.prop(gpcolor, "mix_color", text="Secondary Color")
198
199             if gpcolor.fill_style == 'GRADIENT':
200                 col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
201
202             if gpcolor.fill_style in {'GRADIENT', 'CHECKER'}:
203                 col.prop(gpcolor, "flip", text="Flip Colors")
204
205                 col.prop(gpcolor, "pattern_shift", text="Location")
206                 col.prop(gpcolor, "pattern_scale", text="Scale")
207
208             if gpcolor.gradient_type == 'RADIAL' and gpcolor.fill_style not in {'SOLID', 'CHECKER'}:
209                 col.prop(gpcolor, "pattern_radius", text="Radius")
210             else:
211                 if gpcolor.fill_style != 'SOLID':
212                     col.prop(gpcolor, "pattern_angle", text="Angle")
213
214             if gpcolor.fill_style == 'CHECKER':
215                 col.prop(gpcolor, "pattern_gridsize", text="Box Size")
216
217         # Texture
218         if gpcolor.fill_style == 'TEXTURE' or (gpcolor.use_fill_texture_mix is True and gpcolor.fill_style == 'SOLID'):
219             col.template_ID(gpcolor, "fill_image", open="image.open")
220
221             if gpcolor.fill_style == 'TEXTURE':
222                 col.prop(gpcolor, "use_fill_pattern", text="Use As Stencil Mask")
223                 if gpcolor.use_fill_pattern is True:
224                     col.prop(gpcolor, "fill_color", text="Color")
225
226             col.prop(gpcolor, "texture_offset", text="Offset")
227             col.prop(gpcolor, "texture_scale", text="Scale")
228             col.prop(gpcolor, "texture_angle")
229             col.prop(gpcolor, "texture_opacity")
230             col.prop(gpcolor, "texture_clamp", text="Clip Image")
231
232             if gpcolor.use_fill_pattern is False:
233                 col.prop(gpcolor, "use_fill_texture_mix", text="Mix With Color")
234
235                 if gpcolor.use_fill_texture_mix is True:
236                     col.prop(gpcolor, "fill_color", text="Mix Color")
237                     col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
238
239
240 class MATERIAL_PT_gpencil_preview(GPMaterialButtonsPanel, Panel):
241     bl_label = "Preview"
242     COMPAT_ENGINES = {'BLENDER_EEVEE'}
243     bl_options = {'DEFAULT_CLOSED'}
244
245     def draw(self, context):
246         ma = context.material
247         self.layout.label(text=ma.name)
248         self.layout.template_preview(ma)
249
250
251 class MATERIAL_PT_gpencil_custom_props(GPMaterialButtonsPanel, PropertyPanel, Panel):
252     COMPAT_ENGINES = {'BLENDER_EEVEE', 'BLENDER_WORKBENCH'}
253     _context_path = "object.active_material"
254     _property_type = bpy.types.Material
255
256
257 class MATERIAL_PT_gpencil_options(GPMaterialButtonsPanel, Panel):
258     bl_label = "Options"
259     bl_options = {'DEFAULT_CLOSED'}
260
261     def draw(self, context):
262         layout = self.layout
263         layout.use_property_split = True
264
265         ma = context.material
266         gpcolor = ma.grease_pencil
267         layout.prop(gpcolor, "pass_index")
268
269
270 class MATERIAL_PT_gpencil_material_presets(PresetPanel, Panel):
271     """Material settings"""
272     bl_label = "Material Presets"
273     preset_subdir = "gpencil_material"
274     preset_operator = "script.execute_preset"
275     preset_add_operator = "scene.gpencil_material_preset_add"
276
277
278 classes = (
279     GPENCIL_UL_matslots,
280     GPENCIL_MT_color_context_menu,
281     MATERIAL_PT_gpencil_slots,
282     MATERIAL_PT_gpencil_preview,
283     MATERIAL_PT_gpencil_material_presets,
284     MATERIAL_PT_gpencil_surface,
285     MATERIAL_PT_gpencil_strokecolor,
286     MATERIAL_PT_gpencil_fillcolor,
287     MATERIAL_PT_gpencil_options,
288     MATERIAL_PT_gpencil_custom_props,
289 )
290
291 if __name__ == "__main__":  # only for live edit.
292     from bpy.utils import register_class
293     for cls in classes:
294         register_class(cls)