GPencil: Layers and Materials Specials menu updates
[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 = "Material Specials"
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         layout.separator()
48
49         layout.operator("object.material_slot_remove_unused")
50
51
52 class GPENCIL_UL_matslots(UIList):
53     def draw_item(self, _context, layout, _data, item, icon, _active_data, _active_propname, _index):
54         slot = item
55         ma = slot.material
56         if (ma is not None) and (ma.grease_pencil is not None):
57             gpcolor = ma.grease_pencil
58
59             if self.layout_type in {'DEFAULT', 'COMPACT'}:
60                 if gpcolor.lock:
61                     layout.active = False
62
63                 row = layout.row(align=True)
64                 row.enabled = not gpcolor.lock
65                 row.prop(ma, "name", text="", emboss=False, icon_value=icon)
66
67                 row = layout.row(align=True)
68                 row.prop(gpcolor, "lock", text="", emboss=False)
69                 row.prop(gpcolor, "hide", text="", emboss=False)
70                 if gpcolor.ghost is True:
71                     icon = 'ONIONSKIN_OFF'
72                 else:
73                     icon = 'ONIONSKIN_ON'
74                 row.prop(gpcolor, "ghost", text="", icon=icon, emboss=False)
75
76             elif self.layout_type == 'GRID':
77                 layout.alignment = 'CENTER'
78                 layout.label(text="", icon_value=icon)
79
80
81 class GPMaterialButtonsPanel:
82     bl_space_type = 'PROPERTIES'
83     bl_region_type = 'WINDOW'
84     bl_context = "material"
85
86     @classmethod
87     def poll(cls, context):
88         ma = context.material
89         return ma and ma.grease_pencil
90
91
92 class MATERIAL_PT_gpencil_slots(GreasePencilMaterialsPanel, Panel):
93     bl_label = "Grease Pencil Material Slots"
94     bl_space_type = 'PROPERTIES'
95     bl_region_type = 'WINDOW'
96     bl_context = "material"
97     bl_options = {'HIDE_HEADER'}
98
99     @classmethod
100     def poll(cls, context):
101         ob = context.object
102         ma = context.material
103
104         return (ma and ma.grease_pencil) or (ob and ob.type == 'GPENCIL')
105
106
107 # Used as parent for "Stroke" and "Fill" panels
108 class MATERIAL_PT_gpencil_surface(GPMaterialButtonsPanel, Panel):
109     bl_label = "Surface"
110
111     def draw_header_preset(self, _context):
112         MATERIAL_PT_gpencil_material_presets.draw_panel_header(self.layout)
113
114     def draw(self, _context):
115         layout = self.layout
116         layout.use_property_split = True
117
118
119 class MATERIAL_PT_gpencil_strokecolor(GPMaterialButtonsPanel, Panel):
120     bl_label = "Stroke"
121     bl_parent_id = 'MATERIAL_PT_gpencil_surface'
122
123     def draw_header(self, context):
124         ma = context.material
125         if ma is not None and ma.grease_pencil is not None:
126             gpcolor = ma.grease_pencil
127             self.layout.enabled = not gpcolor.lock
128             self.layout.prop(gpcolor, "show_stroke", text="")
129
130     def draw(self, context):
131         layout = self.layout
132         layout.use_property_split = True
133
134         ma = context.material
135         if ma is not None and ma.grease_pencil is not None:
136             gpcolor = ma.grease_pencil
137
138             col = layout.column()
139             col.enabled = not gpcolor.lock
140
141             col.prop(gpcolor, "mode")
142
143             col.prop(gpcolor, "stroke_style", text="Style")
144
145             if gpcolor.stroke_style == 'TEXTURE':
146                 row = col.row()
147                 row.enabled = not gpcolor.lock
148                 col = row.column(align=True)
149                 col.template_ID(gpcolor, "stroke_image", open="image.open")
150                 if gpcolor.mode == 'LINE':
151                     col.prop(gpcolor, "pixel_size", text="UV Factor")
152
153                 col.prop(gpcolor, "use_stroke_pattern", text="Use As Stencil Mask")
154                 if gpcolor.use_stroke_pattern is False:
155                     col.prop(gpcolor, "use_stroke_texture_mix", text="Mix Color")
156                     if gpcolor.use_stroke_texture_mix is True:
157                         col.prop(gpcolor, "mix_stroke_factor", text="Factor")
158
159             if (gpcolor.stroke_style == 'SOLID' or gpcolor.use_stroke_pattern or gpcolor.use_stroke_texture_mix):
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' and gpcolor.stroke_style != 'TEXTURE':
166                 col.prop(gpcolor, "use_overlap_strokes")
167
168
169 class MATERIAL_PT_gpencil_fillcolor(GPMaterialButtonsPanel, Panel):
170     bl_label = "Fill"
171     bl_parent_id = 'MATERIAL_PT_gpencil_surface'
172
173     def draw_header(self, context):
174         ma = context.material
175         gpcolor = ma.grease_pencil
176         self.layout.enabled = not gpcolor.lock
177         self.layout.prop(gpcolor, "show_fill", text="")
178
179     def draw(self, context):
180         layout = self.layout
181         layout.use_property_split = True
182
183         ma = context.material
184         gpcolor = ma.grease_pencil
185
186         # color settings
187         col = layout.column()
188         col.enabled = not gpcolor.lock
189         col.prop(gpcolor, "fill_style", text="Style")
190
191         if gpcolor.fill_style == 'GRADIENT':
192             col.prop(gpcolor, "gradient_type")
193
194         if gpcolor.fill_style != 'TEXTURE':
195             col.prop(gpcolor, "fill_color", text="Color")
196
197             if gpcolor.fill_style in {'GRADIENT', 'CHECKER'}:
198                 col.prop(gpcolor, "mix_color", text="Secondary Color")
199
200             if gpcolor.fill_style == 'GRADIENT':
201                 col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
202
203             if gpcolor.fill_style in {'GRADIENT', 'CHECKER'}:
204                 col.prop(gpcolor, "flip", text="Flip Colors")
205
206                 col.prop(gpcolor, "pattern_shift", text="Location")
207                 col.prop(gpcolor, "pattern_scale", text="Scale")
208
209             if gpcolor.gradient_type == 'RADIAL' and gpcolor.fill_style not in {'SOLID', 'CHECKER'}:
210                 col.prop(gpcolor, "pattern_radius", text="Radius")
211             else:
212                 if gpcolor.fill_style != 'SOLID':
213                     col.prop(gpcolor, "pattern_angle", text="Angle")
214
215             if gpcolor.fill_style == 'CHECKER':
216                 col.prop(gpcolor, "pattern_gridsize", text="Box Size")
217
218         # Texture
219         if gpcolor.fill_style == 'TEXTURE' or (gpcolor.use_fill_texture_mix is True and gpcolor.fill_style == 'SOLID'):
220             col.template_ID(gpcolor, "fill_image", open="image.open")
221
222             if gpcolor.fill_style == 'TEXTURE':
223                 col.prop(gpcolor, "use_fill_pattern", text="Use as Stencil Mask")
224                 if gpcolor.use_fill_pattern is True:
225                     col.prop(gpcolor, "fill_color", text="Color")
226
227             col.prop(gpcolor, "texture_offset", text="Offset")
228             col.prop(gpcolor, "texture_scale", text="Scale")
229             col.prop(gpcolor, "texture_angle")
230             col.prop(gpcolor, "texture_opacity")
231             col.prop(gpcolor, "texture_clamp", text="Clip Image")
232
233             if gpcolor.use_fill_pattern is False:
234                 col.prop(gpcolor, "use_fill_texture_mix", text="Mix with Color")
235
236                 if gpcolor.use_fill_texture_mix is True:
237                     col.prop(gpcolor, "fill_color", text="Mix Color")
238                     col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
239
240
241 class MATERIAL_PT_gpencil_preview(GPMaterialButtonsPanel, Panel):
242     bl_label = "Preview"
243     COMPAT_ENGINES = {'BLENDER_EEVEE'}
244     bl_options = {'DEFAULT_CLOSED'}
245
246     def draw(self, context):
247         ma = context.material
248         self.layout.label(text=ma.name)
249         self.layout.template_preview(ma)
250
251
252 class MATERIAL_PT_gpencil_custom_props(GPMaterialButtonsPanel, PropertyPanel, Panel):
253     COMPAT_ENGINES = {'BLENDER_EEVEE', 'BLENDER_WORKBENCH'}
254     _context_path = "object.active_material"
255     _property_type = bpy.types.Material
256
257
258 class MATERIAL_PT_gpencil_options(GPMaterialButtonsPanel, Panel):
259     bl_label = "Options"
260     bl_options = {'DEFAULT_CLOSED'}
261
262     def draw(self, context):
263         layout = self.layout
264         layout.use_property_split = True
265
266         ma = context.material
267         gpcolor = ma.grease_pencil
268         layout.prop(gpcolor, "pass_index")
269
270
271 class MATERIAL_PT_gpencil_material_presets(PresetPanel, Panel):
272     """Material settings"""
273     bl_label = "Material Presets"
274     preset_subdir = "gpencil_material"
275     preset_operator = "script.execute_preset"
276     preset_add_operator = "scene.gpencil_material_preset_add"
277
278
279 classes = (
280     GPENCIL_UL_matslots,
281     GPENCIL_MT_color_context_menu,
282     MATERIAL_PT_gpencil_slots,
283     MATERIAL_PT_gpencil_preview,
284     MATERIAL_PT_gpencil_material_presets,
285     MATERIAL_PT_gpencil_surface,
286     MATERIAL_PT_gpencil_strokecolor,
287     MATERIAL_PT_gpencil_fillcolor,
288     MATERIAL_PT_gpencil_options,
289     MATERIAL_PT_gpencil_custom_props,
290 )
291
292 if __name__ == "__main__":  # only for live edit.
293     from bpy.utils import register_class
294     for cls in classes:
295         register_class(cls)