greasepencil_tools/prefs.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 import bpy
  20 import os
  21 from bpy.props import (
  22         BoolProperty,
  23         EnumProperty,
  24         StringProperty,
  25         PointerProperty,
  26         # IntProperty,
  27         )
  28
  29 from .ui_panels import GP_PT_sidebarPanel
  30
  31 def get_addon_prefs():
  32     import os
  33     addon_name = os.path.splitext(__name__)[0]
  34     addon_prefs = bpy.context.preferences.addons[addon_name].preferences
  35     return (addon_prefs)
  36
  37 from .timeline_scrub import GPTS_timeline_settings, draw_ts_pref
  38
  39 ## Addons Preferences Update Panel
  40 def update_panel(self, context):
  41     try:
  42         bpy.utils.unregister_class(GP_PT_sidebarPanel)
  43     except:
  44         pass
  45     GP_PT_sidebarPanel.bl_category = get_addon_prefs().category
  46     bpy.utils.register_class(GP_PT_sidebarPanel)
  47
  48 ## keymap binder for rotate canvas
  49 def auto_rebind(self, context):
  50     unregister_keymaps()
  51     register_keymaps()
  52
  53 class GreasePencilAddonPrefs(bpy.types.AddonPreferences):
  54     bl_idname = os.path.splitext(__name__)[0] #'greasepencil-addon' ... __package__ ?
  55     # bl_idname = __name__
  56
  57     ts: PointerProperty(type=GPTS_timeline_settings)
  58
  59     category : StringProperty(
  60             name="Category",
  61             description="Choose a name for the category of the panel",
  62             default="Grease Pencil",
  63             update=update_panel)
  64
  65     pref_tabs : EnumProperty(
  66         items=(('PREF', "Preferences", "Preferences properties of GP"),
  67                ('TUTO', "Tutorial", "How to use the tool"),
  68                # ('KEYMAP', "Keymap", "customise the default keymap"),
  69                ),
  70                default='PREF')
  71
  72     # --- props
  73     use_clic_drag : BoolProperty(
  74         name='Use click drag directly on points',
  75         description="Change the active tool to 'tweak' during modal, Allow to direct clic-drag points of the box",
  76         default=True)
  77
  78     default_deform_type : EnumProperty(
  79         items=(('KEY_LINEAR', "Linear (perspective mode)", "Linear interpolation, like corner deform / perspective tools of classic 2D", 'IPO_LINEAR',0),
  80                ('KEY_BSPLINE', "Spline (smooth deform)", "Spline interpolation transformation\nBest when lattice is subdivided", 'IPO_CIRC',1),
  81                ),
  82         name='Starting Interpolation', default='KEY_LINEAR', description='Choose default interpolation when entering mode')
  83
  84     # About interpolation : https://docs.blender.org/manual/en/2.83/animation/shape_keys/shape_keys_panel.html#fig-interpolation-type
  85
  86     auto_swap_deform_type : BoolProperty(
  87         name='Auto swap interpolation mode',
  88         description="Automatically set interpolation to 'spline' when subdividing lattice\n Back to 'linear' when",
  89         default=True)
  90
  91     ## rotate canvas variables
  92
  93     ## Use HUD
  94     canvas_use_hud: BoolProperty(
  95         name = "Use Hud",
  96         description = "Display angle lines and angle value as text on viewport",
  97         default = False)
  98
  99     ## Canvas rotate
 100     canvas_use_shortcut: BoolProperty(
 101         name = "Use Default Shortcut",
 102         description = "Use default shortcut: mouse double-click + modifier",
 103         default = True,
 104         update=auto_rebind)
 105
 106     mouse_click : EnumProperty(
 107         name="Mouse button", description="click on right/left/middle mouse button in combination with a modifier to trigger alignement",
 108         default='MIDDLEMOUSE',
 109         items=(
 110             ('RIGHTMOUSE', 'Right click', 'Use click on Right mouse button', 'MOUSE_RMB', 0),
 111             ('LEFTMOUSE', 'Left click', 'Use click on Left mouse button', 'MOUSE_LMB', 1),
 112             ('MIDDLEMOUSE', 'Mid click', 'Use click on Mid mouse button', 'MOUSE_MMB', 2),
 113             ),
 114         update=auto_rebind)
 115
 116     use_shift: BoolProperty(
 117             name = "combine with shift",
 118             description = "add shift",
 119             default = False,
 120             update=auto_rebind)
 121
 122     use_alt: BoolProperty(
 123             name = "combine with alt",
 124             description = "add alt",
 125             default = True,
 126             update=auto_rebind)
 127
 128     use_ctrl: BoolProperty(
 129             name = "combine with ctrl",
 130             description = "add ctrl",
 131             default = True,
 132             update=auto_rebind)
 133
 134     def draw(self, context):
 135             prefs = get_addon_prefs()
 136             layout = self.layout
 137             # layout.use_property_split = True
 138             row= layout.row(align=True)
 139             row.prop(self, "pref_tabs", expand=True)
 140
 141             if self.pref_tabs == 'PREF':
 142
 143                 ## TAB CATEGORY
 144                 box = layout.box()
 145                 row = box.row(align=True)
 146                 row.label(text="Panel Category:")
 147                 row.prop(self, "category", text="")
 148
 149                 ## BOX DEFORM
 150                 box = layout.box()
 151                 box.label(text='Box Deform:')
 152                 box.prop(self, "use_clic_drag")
 153                 # box.separator()
 154                 box.prop(self, "default_deform_type")
 155                 box.label(text="Deformer type can be changed during modal with 'M' key, this is for default behavior", icon='INFO')
 156
 157                 box.prop(self, "auto_swap_deform_type")
 158                 box.label(text="Once 'M' is hit, auto swap is desactivated to stay in your chosen mode", icon='INFO')
 159
 160                 ## ROTATE CANVAS
 161                 box = layout.box()
 162                 box.label(text='Rotate canvas:')
 163
 164                 box.prop(self, "canvas_use_shortcut", text='Bind Shortcuts')
 165
 166                 if self.canvas_use_shortcut:
 167
 168                     row = box.row()
 169                     row.label(text="(Auto rebind when changing shortcut)")#icon=""
 170                     # row.operator("prefs.rebind_shortcut", text='Bind/Rebind shortcuts', icon='FILE_REFRESH')#EVENT_SPACEKEY
 171                     row = box.row(align = True)
 172                     row.prop(self, "use_ctrl", text='Ctrl')#, expand=True
 173                     row.prop(self, "use_alt", text='Alt')#, expand=True
 174                     row.prop(self, "use_shift", text='Shift')#, expand=True
 175                     row.prop(self, "mouse_click",text='')#expand=True
 176
 177                     if not self.use_ctrl and not self.use_alt and not self.use_shift:
 178                         box.label(text="Choose at least one modifier to combine with click (default: Ctrl+Alt)", icon="ERROR")# INFO
 179
 180                 else:
 181                     box.label(text="No hotkey has been set automatically. Following operators needs to be set manually:", icon="ERROR")
 182                     box.label(text="view3d.rotate_canvas")
 183                 box.prop(self, 'canvas_use_hud')
 184
 185                 ## SCRUB TIMELINE
 186                 box = layout.box()
 187                 draw_ts_pref(prefs.ts, box)
 188
 189             if self.pref_tabs == 'TUTO':
 190
 191                 #**Behavior from context mode**
 192                 col = layout.column()
 193                 col.label(text='Box Deform Tool')
 194                 col.label(text="Usage:", icon='MOD_LATTICE')
 195                 col.label(text="Use the shortcut 'Ctrl+T' in available modes (listed below)")
 196                 col.label(text="The lattice box is generated facing your view (be sure to face canvas if you want to stay on it)")
 197                 col.label(text="Use shortcuts below to deform (a help will be displayed in the topbar)")
 198
 199                 col.separator()
 200                 col.label(text="Shortcuts:", icon='HAND')
 201                 col.label(text="Spacebar / Enter : Confirm")
 202                 col.label(text="Delete / Backspace / Tab(twice) / Ctrl+T : Cancel")
 203                 col.label(text="M : Toggle between Linear and Spline mode at any moment")
 204                 col.label(text="1-9 top row number : Subdivide the box")
 205                 col.label(text="Ctrl + arrows-keys : Subdivide the box incrementally in individual X/Y axis")
 206
 207                 col.separator()
 208                 col.label(text="Modes and deformation target:", icon='PIVOT_BOUNDBOX')
 209                 col.label(text="- Object mode : The whole GP object is deformed (including all frames)")
 210                 col.label(text="- GPencil Edit mode : Deform Selected points")
 211                 col.label(text="- Gpencil Paint : Deform last Strokes")
 212                 # col.label(text="- Lattice edit : Revive the modal after a ctrl+Z")
 213
 214                 col.separator()
 215                 col.label(text="Notes:", icon='TEXT')
 216                 col.label(text="- If you return in box deform after applying (with a ctrl+Z), you need to hit 'Ctrl+T' again to revive the modal.")
 217                 col.label(text="- A cancel warning will be displayed the first time you hit Tab")
 218
 219
 220 ### rotate canvas keymap
 221
 222
 223 addon_keymaps = []
 224 def register_keymaps():
 225     pref = get_addon_prefs()
 226     if not pref.canvas_use_shortcut:
 227         return
 228     addon = bpy.context.window_manager.keyconfigs.addon
 229
 230     km = addon.keymaps.new(name = "3D View", space_type = "VIEW_3D")
 231
 232     if 'view3d.rotate_canvas' not in km.keymap_items:
 233         km = addon.keymaps.new(name='3D View', space_type='VIEW_3D')
 234         kmi = km.keymap_items.new('view3d.rotate_canvas',
 235         type=pref.mouse_click, value="PRESS", alt=pref.use_alt, ctrl=pref.use_ctrl, shift=pref.use_shift, any=False)
 236
 237         addon_keymaps.append((km, kmi))
 238
 239 def unregister_keymaps():
 240     for km, kmi in addon_keymaps:
 241         km.keymap_items.remove(kmi)
 242     addon_keymaps.clear()
 243
 244
 245
 246 ### REGISTER ---
 247
 248 classes = (
 249     GPTS_timeline_settings,
 250     GreasePencilAddonPrefs,
 251 )
 252
 253 def register():
 254     for cls in classes:
 255         bpy.utils.register_class(cls)
 256     # Force box deform running to false
 257     bpy.context.preferences.addons[os.path.splitext(__name__)[0]].preferences.boxdeform_running = False
 258     register_keymaps()
 259
 260 def unregister():
 261     unregister_keymaps()
 262     for cls in reversed(classes):
 263         bpy.utils.unregister_class(cls)