New Grease Pencil object for 2D animation

This commit merge the full development done in greasepencil-object branch and include mainly the following features.

- New grease pencil object.
- New drawing engine.
- New grease pencil modes Draw/Sculpt/Edit and Weight Paint.
- New brushes for grease pencil.
- New modifiers for grease pencil.
- New shaders FX.
- New material system (replace old palettes and colors).
- Split of annotations (old grease pencil) and new grease pencil object.
- UI adapted to blender 2.8.

You can get more info here:

https://code.blender.org/2017/12/drawing-2d-animation-in-blender-2-8/
https://code.blender.org/2018/07/grease-pencil-status-update/

This is the result of nearly two years of development and I want thanks firstly the other members of the grease pencil team: Daniel M. Lara, Matias Mendiola and Joshua Leung for their support, ideas and to keep working in the project all the time, without them this project had been impossible.

Also, I want thanks other Blender developers for their help, advices and to be there always to help me, and specially to Clément Foucault, Dalai Felinto, Pablo Vázquez and Campbell Barton.

1 files changed, 322 insertions, 0 deletions

diff --git a/release/scripts/startup/bl_ui/properties_material_gpencil.py b/release/scripts/startup/bl_ui/properties_material_gpencil.py
new file mode 100644
index 00000000000..2d823594547
--- /dev/null
+++ b/release/scripts/startup/bl_ui/properties_material_gpencil.py
@@ -0,0 +1,322 @@
+# ##### BEGIN GPL LICENSE BLOCK #####
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 2
+#  of the License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software Foundation,
+#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# <pep8 compliant>
+import bpy
+from bpy.types import Menu, Panel, UIList
+from rna_prop_ui import PropertyPanel
+
+
+class GPENCIL_MT_color_specials(Menu):
+    bl_label = "Layer"
+
+    def draw(self, context):
+        layout = self.layout
+
+        layout.operator("gpencil.color_reveal", icon='RESTRICT_VIEW_OFF', text="Show All")
+        layout.operator("gpencil.color_hide", icon='RESTRICT_VIEW_ON', text="Hide Others").unselected = True
+
+        layout.separator()
+
+        layout.operator("gpencil.color_lock_all", icon='LOCKED', text="Lock All")
+        layout.operator("gpencil.color_unlock_all", icon='UNLOCKED', text="UnLock All")
+
+        layout.separator()
+
+        layout.operator("gpencil.stroke_lock_color", icon='BORDER_RECT', text="Lock Unselected")
+        layout.operator("gpencil.lock_layer", icon='COLOR', text="Lock Unused")
+
+
+class GPENCIL_UL_matslots(UIList):
+    def draw_item(self, context, layout, data, item, icon, active_data, active_propname, index):
+        slot = item
+        ma = slot.material
+        if (ma is not None) and (ma.grease_pencil is not None):
+            gpcolor = ma.grease_pencil
+
+            if self.layout_type in {'DEFAULT', 'COMPACT'}:
+                if gpcolor.lock:
+                    layout.active = False
+
+                row = layout.row(align=True)
+                row.enabled = not gpcolor.lock
+                row.prop(ma, "name", text="", emboss=False, icon_value=icon)
+
+                row = layout.row(align=True)
+                row.prop(gpcolor, "lock", text="", emboss=False)
+                row.prop(gpcolor, "hide", text="", emboss=False)
+                if gpcolor.ghost is True:
+                    icon = 'GHOST_DISABLED'
+                else:
+                    icon = 'GHOST_ENABLED'
+                row.prop(gpcolor, "ghost", text="", icon=icon, emboss=False)
+
+            elif self.layout_type == 'GRID':
+                layout.alignment = 'CENTER'
+                layout.label(text="", icon_value=icon)
+
+
+class GPMaterialButtonsPanel:
+    bl_space_type = 'PROPERTIES'
+    bl_region_type = 'WINDOW'
+    bl_context = "material"
+
+    @classmethod
+    def poll(cls, context):
+        ob = context.object
+        return (ob and ob.type == 'GPENCIL' and
+                ob.active_material and
+                ob.active_material.grease_pencil)
+
+
+
+class MATERIAL_PT_gpencil_slots(Panel):
+    bl_label = "Grease Pencil Material Slots"
+    bl_space_type = 'PROPERTIES'
+    bl_region_type = 'WINDOW'
+    bl_context = "material"
+    bl_options = {'HIDE_HEADER'}
+
+    @classmethod
+    def poll(cls, context):
+        ob = context.object
+        return ob and ob.type == 'GPENCIL'
+
+    @staticmethod
+    def draw(self, context):
+        layout = self.layout
+        gpd = context.gpencil_data
+
+        mat = context.object.active_material
+        ob = context.object
+        slot = context.material_slot
+        space = context.space_data
+
+        if ob:
+            is_sortable = len(ob.material_slots) > 1
+            rows = 1
+            if (is_sortable):
+                rows = 4
+
+            row = layout.row()
+
+            row.template_list("GPENCIL_UL_matslots", "", ob, "material_slots", ob, "active_material_index", rows=rows)
+
+            col = row.column(align=True)
+            col.operator("object.material_slot_add", icon='ZOOMIN', text="")
+            col.operator("object.material_slot_remove", icon='ZOOMOUT', text="")
+
+            col.menu("GPENCIL_MT_color_specials", icon='DOWNARROW_HLT', text="")
+
+            if is_sortable:
+                col.separator()
+
+                col.operator("object.material_slot_move", icon='TRIA_UP', text="").direction = 'UP'
+                col.operator("object.material_slot_move", icon='TRIA_DOWN', text="").direction = 'DOWN'
+
+                col.separator()
+
+                sub = col.column(align=True)
+                sub.operator("gpencil.color_isolate", icon='LOCKED', text="").affect_visibility = False
+                sub.operator("gpencil.color_isolate", icon='RESTRICT_VIEW_OFF', text="").affect_visibility = True
+
+        row = layout.row()
+
+        if ob:
+            row.template_ID(ob, "active_material", new="material.new", live_icon=True)
+
+            if slot:
+                icon_link = 'MESH_DATA' if slot.link == 'DATA' else 'OBJECT_DATA'
+                row.prop(slot, "link", icon=icon_link, icon_only=True)
+
+            if gpd.use_stroke_edit_mode:
+                row = layout.row(align=True)
+                row.operator("gpencil.stroke_change_color", text="Assign")
+                row.operator("gpencil.color_select", text="Select")
+
+        elif mat:
+            row.template_ID(space, "pin_id")
+
+
+# Used as parent for "Stroke" and "Fill" panels
+class MATERIAL_PT_gpencil_surface(GPMaterialButtonsPanel, Panel):
+    bl_label = "Surface"
+
+    @classmethod
+    def poll(cls, context):
+        ob = context.object
+        ma = context.object.active_material
+        if ma is None or ma.grease_pencil is None:
+            return False
+
+        return ob and ob.type == 'GPENCIL'
+
+    @staticmethod
+    def draw(self, context):
+        layout = self.layout
+        layout.use_property_split = True
+
+
+class MATERIAL_PT_gpencil_strokecolor(GPMaterialButtonsPanel, Panel):
+    bl_label = "Stroke"
+    bl_parent_id = 'MATERIAL_PT_gpencil_surface'
+
+    @staticmethod
+    def draw(self, context):
+        layout = self.layout
+        layout.use_property_split = True
+
+        ma = context.object.active_material
+        if ma is not None and ma.grease_pencil is not None:
+            gpcolor = ma.grease_pencil
+
+            col = layout.column()
+            col.active = not gpcolor.lock
+
+            col.prop(gpcolor, "mode")
+
+            col.prop(gpcolor, "stroke_style", text="Style")
+
+            if gpcolor.stroke_style == 'TEXTURE':
+                row = col.row()
+                row.enabled = not gpcolor.lock
+                col = row.column(align=True)
+                col.template_ID(gpcolor, "stroke_image", open="image.open")
+                col.prop(gpcolor, "pixel_size", text="UV Factor")
+                col.prop(gpcolor, "use_stroke_pattern", text="Use As Pattern")
+
+            if gpcolor.stroke_style == 'SOLID' or gpcolor.use_stroke_pattern is True:
+                col.prop(gpcolor, "color", text="Color")
+
+
+class MATERIAL_PT_gpencil_fillcolor(GPMaterialButtonsPanel, Panel):
+    bl_label = "Fill"
+    bl_parent_id = 'MATERIAL_PT_gpencil_surface'
+
+    @staticmethod
+    def draw(self, context):
+        layout = self.layout
+        layout.use_property_split = True
+
+        ma = context.object.active_material
+        if ma is not None and ma.grease_pencil:
+            gpcolor = ma.grease_pencil
+
+            # color settings
+            col = layout.column()
+            col.active = not gpcolor.lock
+            col.prop(gpcolor, "fill_style", text="Style")
+
+            if gpcolor.fill_style == 'GRADIENT':
+                col.prop(gpcolor, "gradient_type")
+
+            if gpcolor.fill_style != 'TEXTURE':
+                col.prop(gpcolor, "fill_color", text="Color")
+
+                if gpcolor.fill_style in ('GRADIENT', 'CHESSBOARD'):
+                    col.prop(gpcolor, "mix_color", text="Secondary Color")
+
+                if gpcolor.fill_style == 'GRADIENT':
+                    col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
+
+                if gpcolor.fill_style in ('GRADIENT', 'CHESSBOARD'):
+                    col.prop(gpcolor, "flip", text="Flip Colors")
+
+                    col.prop(gpcolor, "pattern_shift", text="Location")
+                    col.prop(gpcolor, "pattern_scale", text="Scale")
+
+                if gpcolor.gradient_type == 'RADIAL' and gpcolor.fill_style not in ('SOLID', 'CHESSBOARD'):
+                    col.prop(gpcolor, "pattern_radius", text="Radius")
+                else:
+                    if gpcolor.fill_style != 'SOLID':
+                        col.prop(gpcolor, "pattern_angle", text="Angle")
+
+                if gpcolor.fill_style == 'CHESSBOARD':
+                    col.prop(gpcolor, "pattern_gridsize", text="Box Size")
+
+            # Texture
+            if gpcolor.fill_style == 'TEXTURE' or (gpcolor.texture_mix is True and gpcolor.fill_style == 'SOLID'):
+                col.template_ID(gpcolor, "fill_image", open="image.open")
+
+                if gpcolor.fill_style == 'TEXTURE':
+                    col.prop(gpcolor, "use_fill_pattern", text="Use As Pattern")
+                    if gpcolor.use_fill_pattern is True:
+                        col.prop(gpcolor, "fill_color", text="Color")
+
+                col.prop(gpcolor, "texture_offset", text="Offset")
+                col.prop(gpcolor, "texture_scale", text="Scale")
+                col.prop(gpcolor, "texture_angle")
+                col.prop(gpcolor, "texture_opacity")
+                col.prop(gpcolor, "texture_clamp", text="Clip Image")
+
+                if gpcolor.use_fill_pattern is False:
+                    col.prop(gpcolor, "texture_mix", text="Mix With Color")
+
+                    if gpcolor.texture_mix is True:
+                        col.prop(gpcolor, "fill_color", text="Mix Color")
+                        col.prop(gpcolor, "mix_factor", text="Mix Factor", slider=True)
+
+
+class MATERIAL_PT_gpencil_preview(GPMaterialButtonsPanel, Panel):
+    bl_label = "Preview"
+    COMPAT_ENGINES = {'BLENDER_EEVEE'}
+    bl_options = {'DEFAULT_CLOSED'}
+
+    def draw(self, context):
+        ma = context.object.active_material
+        self.layout.label(ma.name)
+        self.layout.template_preview(ma)
+
+
+class MATERIAL_PT_gpencil_custom_props(GPMaterialButtonsPanel, PropertyPanel, Panel):
+    COMPAT_ENGINES = {'BLENDER_EEVEE', 'BLENDER_OPENGL'}
+    _context_path = "object.active_material"
+    _property_type = bpy.types.Material
+
+
+class MATERIAL_PT_gpencil_options(GPMaterialButtonsPanel, Panel):
+    bl_label = "Options"
+    bl_options = {'DEFAULT_CLOSED'}
+
+    @staticmethod
+    def draw(self, context):
+        layout = self.layout
+        layout.use_property_split = True
+
+        ma = context.object.active_material
+        if ma is not None and ma.grease_pencil is not None:
+            gpcolor = ma.grease_pencil
+            layout.prop(gpcolor, "pass_index")
+
+
+classes = (
+    GPENCIL_UL_matslots,
+    GPENCIL_MT_color_specials,
+    MATERIAL_PT_gpencil_slots,
+    MATERIAL_PT_gpencil_preview,
+    MATERIAL_PT_gpencil_surface,
+    MATERIAL_PT_gpencil_strokecolor,
+    MATERIAL_PT_gpencil_fillcolor,
+    MATERIAL_PT_gpencil_options,
+    MATERIAL_PT_gpencil_custom_props,
+)
+
+if __name__ == "__main__":  # only for live edit.
+    from bpy.utils import register_class
+    for cls in classes:
+        register_class(cls)