object_skinify.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 bl_info = {
  20     "name": "Skinify Rig",
  21     "author": "Albert Makac (karab44)",
  22     "version": (0, 11, 0),
  23     "blender": (2, 80, 0),
  24     "location": "Properties > Bone > Skinify Rig (visible on pose mode only)",
  25     "description": "Creates a mesh object from selected bones",
  26     "warning": "Work in progress",
  27     "wiki_url": "https://wiki.blender.org/index.php/Extensions:2.6/"
  28                 "Py/Scripts/Object/Skinify",
  29     "category": "Object"}
  30
  31 import bpy
  32 from bpy.props import (
  33         FloatProperty,
  34         IntProperty,
  35         BoolProperty,
  36         PointerProperty,
  37         )
  38 from bpy.types import (
  39         Operator,
  40         Panel,
  41         PropertyGroup,
  42         )
  43 from mathutils import (
  44         Vector,
  45         Euler,
  46         )
  47 from bpy.app.handlers import persistent
  48 from enum import Enum
  49
  50 # can the armature data properties group_prop and row be fetched directly from the rigify script?
  51 horse_data = \
  52         (1, 5), (2, 4), (3, 0), (4, 3), (5, 4), (1, 0), (1, 0), (7, 2), (8, 5), (9, 4), \
  53         (7, 2), (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), \
  54         (13, 6), (1, 4), (14, 6), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  55
  56 shark_data = \
  57         (1, 5), (2, 4), (1, 0), (3, 3), (4, 4), (5, 6), (6, 5), (7, 4), (6, 5), (7, 4), \
  58         (8, 3), (9, 4), (1, 0), (1, 6), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), \
  59         (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  60
  61 bird_data = \
  62         (1, 6), (2, 4), (1, 0), (3, 3), (4, 4), (1, 0), (1, 0), (6, 5), (8, 0), (7, 4), (6, 5), \
  63         (8, 0), (7, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (1, 0), (1, 0), \
  64         (13, 6), (14, 4), (1, 0), (8, 6), (1, 0), (1, 0), (1, 0), (14, 1),
  65
  66 cat_data = \
  67         (1, 5), (2, 2), (2, 3), (3, 3), (4, 4), (5, 6), (6, 4), (7, 2), (8, 5), (9, 4), (7, 2), \
  68         (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (13, 3), (14, 4), \
  69         (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (16, 1),
  70
  71 biped_data = \
  72         (1, 0), (1, 0), (1, 0), (3, 3), (4, 4), (1, 0), (1, 0), (7, 2), (8, 5), (9, 4), (7, 2), \
  73         (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (1, 0), (1, 0), \
  74         (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  75
  76 human_data = \
  77         (1, 5), (2, 2), (2, 3), (3, 3), (4, 4), (5, 6), (6, 4), (7, 2), (8, 5), (9, 4), (7, 2), \
  78         (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (1, 0), (1, 0), \
  79         (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  80
  81 wolf_data = \
  82         (1, 5), (2, 2), (2, 3), (3, 3), (4, 4), (5, 6), (6, 4), (7, 2), (8, 5), (9, 4), (7, 2), \
  83         (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (13, 6), (1, 0), \
  84         (13, 0), (13, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  85
  86 quadruped_data = \
  87         (1, 0), (2, 0), (2, 0), (3, 3), (4, 4), (5, 0), (6, 0), (7, 2), (8, 5), (9, 4), \
  88         (7, 2), (8, 5), (9, 4), (10, 2), (11, 5), (12, 4), (10, 2), (11, 5), (12, 4), (13, 6), \
  89         (1, 0), (13, 0), (13, 0), (1, 0), (1, 0), (1, 0), (1, 0), (1, 0), (14, 1),
  90
  91 human_legacy_data = \
  92         (1, None), (1, None), (2, None), (1, None), (3, None), (3, None), (4, None), (5, None), \
  93         (6, None), (4, None), (5, None), (6, None), (7, None), (8, None), (9, None), (7, None), \
  94         (8, None), (9, None), (1, None), (1, None), (1, None), (1, None), (1, None), (1, None), \
  95         (1, None), (1, None), (1, None), (1, None),
  96
  97 pitchipoy_data = \
  98         (1, None), (2, None), (2, None), (3, None), (4, None), (5, None), (6, None), (7, None), \
  99         (8, None), (9, None), (7, None), (8, None), (9, None), (10, None), (11, None), (12, None), \
 100         (10, None), (11, None), (12, None), (1, None), (1, None), (1, None), (1, None), (1, None), \
 101         (1, None), (1, None), (1, None), (1, None),
 102
 103 rigify_data = horse_data, shark_data, bird_data, cat_data, biped_data, human_data, \
 104               wolf_data, quadruped_data, human_legacy_data, pitchipoy_data
 105
 106
 107 class Rig_type(Enum):
 108     HORSE = 0
 109     SHARK = 1
 110     BIRD = 2
 111     CAT = 3
 112     BIPED = 4
 113     HUMAN = 5
 114     WOLF = 6
 115     QUAD = 7
 116     LEGACY = 8
 117     PITCHIPOY = 9
 118     OTHER = 10
 119
 120
 121 rig_type = Rig_type.OTHER
 122
 123
 124 class Idx_Store(object):
 125     def __init__(self, rig_type):
 126         self.rig_type = rig_type
 127         self.hand_r_merge = []
 128         self.hand_l_merge = []
 129         self.hands_pretty = []
 130         self.root = []
 131
 132         if not self.rig_type == Rig_type.LEGACY and \
 133                 not self.rig_type == Rig_type.HUMAN and \
 134                 not self.rig_type == Rig_type.PITCHIPOY:
 135             return
 136
 137         if self.rig_type == Rig_type.LEGACY:
 138             self.hand_l_merge = [7, 12, 16, 21, 26, 27]
 139             self.hand_r_merge = [30, 31, 36, 40, 45, 50]
 140             self.hands_pretty = [6, 29]
 141             self.root = [59]
 142
 143         if self.rig_type == Rig_type.HUMAN or self.rig_type == Rig_type.PITCHIPOY:
 144             self.hand_l_merge = [9, 10, 15, 19, 24, 29]
 145             self.hand_r_merge = [32, 33, 37, 42, 47, 52]
 146             self.hands_pretty = [8, 31]
 147             self.root = [56]
 148
 149     def get_all_idx(self):
 150         return self.hand_l_merge, self.hand_r_merge, self.hands_pretty, self.root
 151
 152     def get_hand_l_merge_idx(self):
 153         return self.hand_l_merge
 154
 155     def get_hand_r_merge_idx(self):
 156         return self.hand_r_merge
 157
 158     def get_hands_pretty_idx(self):
 159         return self.hands_pretty
 160
 161     def get_root_idx(self):
 162         return self.root
 163
 164
 165 # initialize properties
 166 def init_props():
 167     # additional check - this should be a rare case if the handler
 168     # wasn't removed for some reason and the add-on is not toggled on/off
 169     if hasattr(bpy.types.Scene, "skinify"):
 170         scn = bpy.context.scene.skinify
 171
 172         scn.connect_mesh = False
 173         scn.connect_parents = False
 174         scn.generate_all = False
 175         scn.thickness = 0.8
 176         scn.finger_thickness = 0.25
 177         scn.apply_mod = True
 178         scn.parent_armature = True
 179         scn.sub_level = 1
 180
 181
 182 # selects vertices
 183 def select_vertices(mesh_obj, idx):
 184     bpy.context.view_layer.objects.active = mesh_obj
 185     mode = mesh_obj.mode
 186     bpy.ops.object.mode_set(mode='EDIT')
 187     bpy.ops.mesh.select_all(action='DESELECT')
 188     bpy.ops.object.mode_set(mode='OBJECT')
 189
 190     for i in idx:
 191         mesh_obj.data.vertices[i].select = True
 192
 193     selectedVerts = [v.index for v in mesh_obj.data.vertices if v.select]
 194
 195     bpy.ops.object.mode_set(mode=mode)
 196     return selectedVerts
 197
 198
 199 def identify_rig():
 200     if 'rigify_layers' not in bpy.context.object.data:
 201         return Rig_type.OTHER  # non recognized
 202
 203     LEGACY_LAYERS_SIZE = 28
 204     layers = bpy.context.object.data['rigify_layers']
 205
 206     for type, rig in enumerate(rigify_data):
 207         index = 0
 208
 209         for props in layers:
 210             if len(layers) == LEGACY_LAYERS_SIZE and 'group_prop' not in props:
 211
 212                 if props['row'] != rig[index][0] or rig[index][1] is not None:
 213                     break
 214
 215             elif (props['row'] != rig[index][0]) or (props['group_prop'] != rig[index][1]):
 216                 break
 217
 218             # SUCCESS if reach the end
 219             if index == len(layers) - 1:
 220                 return Rig_type(type)
 221
 222             index = index + 1
 223
 224     return Rig_type.OTHER
 225
 226
 227 def prepare_ignore_list(rig_type, bones):
 228     # detect the head, face, hands, breast, heels or other exceptionary bones to exclusion or customization
 229     common_ignore_list = ['eye', 'heel', 'breast', 'root']
 230
 231     # edit these lists to suits your taste
 232
 233     horse_ignore_list = ['chest', 'belly', 'pelvis', 'jaw', 'nose', 'skull', 'ear.']
 234
 235     shark_ignore_list = ['jaw']
 236
 237     bird_ignore_list = [
 238             'face', 'pelvis', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 239             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue', 'beak'
 240             ]
 241     cat_ignore_list = [
 242             'face', 'belly' 'pelvis.C', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 243             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue'
 244             ]
 245     biped_ignore_list = ['pelvis']
 246
 247     human_ignore_list = [
 248             'face', 'pelvis', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 249             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue'
 250             ]
 251     wolf_ignore_list = [
 252             'face', 'pelvis', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 253             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue'
 254             ]
 255     quad_ignore_list = [
 256             'face', 'pelvis', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 257             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue'
 258             ]
 259     rigify_legacy_ignore_list = []
 260
 261     pitchipoy_ignore_list = [
 262             'face', 'pelvis', 'nose', 'lip', 'jaw', 'chin', 'ear.', 'brow',
 263             'lid', 'forehead', 'temple', 'cheek', 'teeth', 'tongue'
 264             ]
 265
 266     other_ignore_list = []
 267
 268     ignore_list = common_ignore_list
 269
 270     if rig_type == Rig_type.HORSE:
 271         ignore_list = ignore_list + horse_ignore_list
 272         print("RIDER OF THE APOCALYPSE")
 273     elif rig_type == Rig_type.SHARK:
 274         ignore_list = ignore_list + shark_ignore_list
 275         print("DEADLY JAWS")
 276     elif rig_type == Rig_type.BIRD:
 277         ignore_list = ignore_list + bird_ignore_list
 278         print("WINGS OF LIBERTY")
 279     elif rig_type == Rig_type.CAT:
 280         ignore_list = ignore_list + cat_ignore_list
 281         print("MEOW")
 282     elif rig_type == Rig_type.BIPED:
 283         ignore_list = ignore_list + biped_ignore_list
 284         print("HUMANOID")
 285     elif rig_type == Rig_type.HUMAN:
 286         ignore_list = ignore_list + human_ignore_list
 287         print("JUST A HUMAN AFTER ALL")
 288     elif rig_type == Rig_type.WOLF:
 289         ignore_list = ignore_list + wolf_ignore_list
 290         print("WHITE FANG")
 291     elif rig_type == Rig_type.QUAD:
 292         ignore_list = ignore_list + quad_ignore_list
 293         print("MYSTERIOUS CREATURE")
 294     elif rig_type == Rig_type.LEGACY:
 295         ignore_list = ignore_list + rigify_legacy_ignore_list
 296         print("LEGACY RIGIFY")
 297     elif rig_type == Rig_type.PITCHIPOY:
 298         ignore_list = ignore_list + pitchipoy_ignore_list
 299         print("PITCHIPOY")
 300     elif rig_type == Rig_type.OTHER:
 301         ignore_list = ignore_list + other_ignore_list
 302         print("rig non recognized...")
 303
 304     return ignore_list
 305
 306
 307 # generates edges from vertices used by skin modifier
 308 def generate_edges(mesh, shape_object, bones, scale, connect_mesh=False, connect_parents=False,
 309                    head_ornaments=False, generate_all=False):
 310     """
 311     This function adds vertices for all heads and tails
 312     """
 313     # scene preferences
 314
 315     alternate_scale_list = []
 316
 317     me = mesh
 318     verts = []
 319     edges = []
 320     idx = 0
 321     alternate_scale_idx_list = list()
 322
 323     rig_type = identify_rig()
 324     ignore_list = prepare_ignore_list(rig_type, bones)
 325
 326     # edge generator loop
 327     for b in bones:
 328         # look for rig's hands and their childs
 329         if 'hand' in b.name.lower():
 330             # prepare the list
 331             for c in b.children_recursive:
 332                 alternate_scale_list.append(c.name)
 333
 334         found = False
 335
 336         for i in ignore_list:
 337             if i in b.name.lower():
 338                 found = True
 339                 break
 340
 341         if found and generate_all is False:
 342             continue
 343
 344         # fix for drawing rootbone and relationship lines
 345         if 'root' in b.name.lower() and generate_all is False:
 346             continue
 347
 348         # ignore any head ornaments
 349         if head_ornaments is False:
 350             if b.parent is not None:
 351
 352                 if 'head' in b.parent.name.lower() and not rig_type == Rig_type.HUMAN:
 353                     continue
 354
 355                 if 'face' in b.parent.name.lower() and rig_type == Rig_type.HUMAN:
 356                     continue
 357
 358         if connect_parents:
 359             if b.parent is not None and b.parent.bone.select is True and b.bone.use_connect is False:
 360                 if 'root' in b.parent.name.lower() and generate_all is False:
 361                     continue
 362                 # ignore shoulder
 363                 if 'shoulder' in b.name.lower() and connect_mesh is True:
 364                     continue
 365                 # connect the upper arm directly with chest omitting shoulders
 366                 if 'shoulder' in b.parent.name.lower() and connect_mesh is True:
 367                     vert1 = b.head
 368                     vert2 = b.parent.parent.tail
 369
 370                 else:
 371                     vert1 = b.head
 372                     vert2 = b.parent.tail
 373
 374                 verts.append(vert1)
 375                 verts.append(vert2)
 376                 edges.append([idx, idx + 1])
 377
 378                 # also make list of edges made of gaps between the bones
 379                 for a in alternate_scale_list:
 380                     if b.name == a:
 381                         alternate_scale_idx_list.append(idx)
 382                         alternate_scale_idx_list.append(idx + 1)
 383
 384                 idx = idx + 2
 385             # for bvh free floating hips and hips correction for rigify and pitchipoy
 386             if ((generate_all is False and 'hip' in b.name.lower()) or
 387               (generate_all is False and (b.name == 'hips' and rig_type == Rig_type.LEGACY) or
 388               (b.name == 'spine' and rig_type == Rig_type.PITCHIPOY) or (b.name == 'spine' and
 389                rig_type == Rig_type.HUMAN) or (b.name == 'spine' and rig_type == Rig_type.BIPED))):
 390                 continue
 391
 392         vert1 = b.head
 393         vert2 = b.tail
 394         verts.append(vert1)
 395         verts.append(vert2)
 396
 397         edges.append([idx, idx + 1])
 398
 399         for a in alternate_scale_list:
 400             if b.name == a:
 401                 alternate_scale_idx_list.append(idx)
 402                 alternate_scale_idx_list.append(idx + 1)
 403
 404         idx = idx + 2
 405
 406     # Create mesh from given verts, faces
 407     me.from_pydata(verts, edges, [])
 408     # Update mesh with new data
 409     me.update()
 410
 411     # set object scale exact as armature's scale
 412     shape_object.scale = scale
 413
 414     return alternate_scale_idx_list, rig_type
 415
 416
 417 def generate_mesh(shape_object, size, thickness=0.8, finger_thickness=0.25, sub_level=1,
 418                   connect_mesh=False, connect_parents=False, generate_all=False, apply_mod=True,
 419                   alternate_scale_idx_list=[], rig_type=0, bones=[]):
 420     """
 421     This function adds modifiers for generated edges
 422     """
 423     total_bones_num = bpy.context.selected_pose_bones_from_active_object
 424     selected_bones_num = len(bones)
 425
 426     bpy.ops.object.mode_set(mode='EDIT')
 427     bpy.ops.mesh.select_all(action='DESELECT')
 428
 429     # add skin modifier
 430     shape_object.modifiers.new("Skin", 'SKIN')
 431     bpy.ops.mesh.select_all(action='SELECT')
 432
 433     override = bpy.context.copy()
 434     for area in bpy.context.screen.areas:
 435         if area.type == 'VIEW_3D':
 436             for region in area.regions:
 437                 if region.type == 'WINDOW':
 438                     override['area'] = area
 439                     override['region'] = region
 440                     override['edit_object'] = bpy.context.edit_object
 441                     override['scene'] = bpy.context.scene
 442                     override['active_object'] = shape_object
 443                     override['object'] = shape_object
 444                     override['modifier'] = bpy.context.object.modifiers
 445                     break
 446
 447     # calculate optimal thickness for defaults
 448     bpy.ops.object.skin_root_mark(override)
 449     bpy.ops.transform.skin_resize(
 450         override,
 451         value=(1 * thickness * (size / 10), 1 * thickness * (size / 10), 1 * thickness * (size / 10)),
 452         constraint_axis=(False, False, False),
 453         orient_type='GLOBAL',
 454         mirror=False,
 455         use_proportional_edit=False,
 456     )
 457     shape_object.modifiers["Skin"].use_smooth_shade = True
 458     shape_object.modifiers["Skin"].use_x_symmetry = True
 459
 460     # select finger vertices and calculate optimal thickness for fingers to fix proportions
 461     if len(alternate_scale_idx_list) > 0:
 462         select_vertices(shape_object, alternate_scale_idx_list)
 463
 464         bpy.ops.object.skin_loose_mark_clear(override, action='MARK')
 465         # by default set fingers thickness to 25 percent of body thickness
 466         bpy.ops.transform.skin_resize(
 467             override,
 468             value=(finger_thickness, finger_thickness, finger_thickness),
 469             constraint_axis=(False, False, False), orient_type='GLOBAL',
 470             mirror=False,
 471             use_proportional_edit=False,
 472         )
 473         # make loose hands only for better topology
 474
 475     # bpy.ops.mesh.select_all(action='DESELECT')
 476
 477     if connect_mesh:
 478         bpy.ops.object.mode_set(mode='EDIT')
 479         bpy.ops.mesh.select_all(action='DESELECT')
 480         bpy.ops.mesh.select_all(action='SELECT')
 481         bpy.ops.mesh.remove_doubles()
 482
 483     idx_store = Idx_Store(rig_type)
 484
 485     # fix rigify and pitchipoy hands topology
 486     if connect_mesh and connect_parents and generate_all is False and \
 487             (rig_type == Rig_type.LEGACY or rig_type == Rig_type.PITCHIPOY or rig_type == Rig_type.HUMAN) and \
 488             selected_bones_num == total_bones_num:
 489         # thickness will set palm vertex for both hands look pretty
 490         corrective_thickness = 2.5
 491         # left hand verts
 492         merge_idx = idx_store.get_hand_l_merge_idx()
 493
 494         select_vertices(shape_object, merge_idx)
 495         bpy.ops.mesh.merge(type='CENTER')
 496         bpy.ops.transform.skin_resize(
 497             override,
 498             value=(corrective_thickness, corrective_thickness, corrective_thickness),
 499             constraint_axis=(False, False, False), orient_type='GLOBAL',
 500             mirror=False,
 501             use_proportional_edit=False,
 502         )
 503         bpy.ops.mesh.select_all(action='DESELECT')
 504
 505         # right hand verts
 506         merge_idx = idx_store.get_hand_r_merge_idx()
 507
 508         select_vertices(shape_object, merge_idx)
 509         bpy.ops.mesh.merge(type='CENTER')
 510         bpy.ops.transform.skin_resize(
 511             override,
 512             value=(corrective_thickness, corrective_thickness, corrective_thickness),
 513             constraint_axis=(False, False, False), orient_type='GLOBAL',
 514             mirror=False,
 515             use_proportional_edit=False,
 516         )
 517
 518         # making hands even more pretty
 519         bpy.ops.mesh.select_all(action='DESELECT')
 520         hands_idx = idx_store.get_hands_pretty_idx()
 521
 522         select_vertices(shape_object, hands_idx)
 523         # change the thickness to make hands look less blocky and more sexy
 524         corrective_thickness = 0.7
 525         bpy.ops.transform.skin_resize(
 526             override,
 527             value=(corrective_thickness, corrective_thickness, corrective_thickness),
 528             constraint_axis=(False, False, False), orient_type='GLOBAL',
 529             mirror=False,
 530             use_proportional_edit=False,
 531         )
 532         bpy.ops.mesh.select_all(action='DESELECT')
 533
 534     # todo optionally take root from rig's hip tail or head depending on scenario
 535
 536     root_idx = idx_store.get_root_idx()
 537
 538     if selected_bones_num == total_bones_num:
 539         root_idx = [0]
 540
 541     if len(root_idx) > 0:
 542         select_vertices(shape_object, root_idx)
 543         bpy.ops.object.skin_root_mark(override)
 544     # skin in edit mode
 545     # add Subsurf modifier
 546     shape_object.modifiers.new("Subsurf", 'SUBSURF')
 547     shape_object.modifiers["Subsurf"].levels = sub_level
 548     shape_object.modifiers["Subsurf"].render_levels = sub_level
 549
 550     bpy.ops.object.mode_set(mode='OBJECT')
 551
 552     # object mode apply all modifiers
 553     if apply_mod:
 554         bpy.ops.object.modifier_apply(override, apply_as='DATA', modifier="Skin")
 555         bpy.ops.object.modifier_apply(override, apply_as='DATA', modifier="Subsurf")
 556
 557     return {'FINISHED'}
 558
 559
 560 def main(context):
 561     """
 562     This script will create a custom shape
 563     """
 564
 565     # ### Check if selection is OK ###
 566     if len(context.selected_pose_bones) == 0 or \
 567             len(context.selected_objects) == 0 or \
 568             context.selected_objects[0].type != 'ARMATURE':
 569         return {'CANCELLED'}, "No bone selected or the Armature is hidden"
 570
 571     scn = bpy.context.scene
 572     sknfy = scn.skinify
 573
 574     # initialize the mesh object
 575     mesh_name = context.selected_objects[0].name + "_mesh"
 576     obj_name = context.selected_objects[0].name + "_object"
 577     armature_object = context.object
 578
 579     origin = context.object.location
 580     bone_selection = context.selected_pose_bones
 581     oldLocation = None
 582     oldRotation = None
 583     oldScale = None
 584     armature_object = context.view_layer.objects.active
 585     armature_object.select_set(True)
 586
 587     old_pose_pos = armature_object.data.pose_position
 588     bpy.ops.object.mode_set(mode='OBJECT')
 589     oldLocation = Vector(armature_object.location)
 590     oldRotation = Euler(armature_object.rotation_euler)
 591     oldScale = Vector(armature_object.scale)
 592
 593     bpy.ops.object.rotation_clear(clear_delta=False)
 594     bpy.ops.object.location_clear(clear_delta=False)
 595     bpy.ops.object.scale_clear(clear_delta=False)
 596     if sknfy.apply_mod and sknfy.parent_armature:
 597         armature_object.data.pose_position = 'REST'
 598
 599     scale = bpy.context.object.scale
 600     size = bpy.context.object.dimensions[2]
 601
 602     bpy.ops.object.mode_set(mode='OBJECT')
 603     bpy.ops.object.select_all(action='DESELECT')
 604
 605     bpy.ops.object.add(type='MESH', enter_editmode=False, location=origin)
 606
 607     # get the mesh object
 608     ob = context.view_layer.objects.active
 609     ob.name = obj_name
 610     me = ob.data
 611     me.name = mesh_name
 612
 613     # this way we fit mesh and bvh with armature modifier correctly
 614
 615     alternate_scale_idx_list, rig_type = generate_edges(
 616                                                 me, ob, bone_selection, scale, sknfy.connect_mesh,
 617                                                 sknfy.connect_parents, sknfy.head_ornaments,
 618                                                 sknfy.generate_all
 619                                                 )
 620
 621     generate_mesh(ob, size, sknfy.thickness, sknfy.finger_thickness, sknfy.sub_level,
 622                   sknfy.connect_mesh, sknfy.connect_parents, sknfy.generate_all,
 623                   sknfy.apply_mod, alternate_scale_idx_list, rig_type, bone_selection)
 624
 625     # parent mesh with armature only if modifiers are applied
 626     if sknfy.apply_mod and sknfy.parent_armature:
 627         bpy.ops.object.mode_set(mode='OBJECT')
 628         bpy.ops.object.select_all(action='DESELECT')
 629         ob.select_set(True)
 630         armature_object.select_set(True)
 631         bpy.context.view_layer.objects.active = armature_object
 632
 633         bpy.ops.object.parent_set(type='ARMATURE_AUTO')
 634         armature_object.data.pose_position = old_pose_pos
 635         armature_object.select_set(False)
 636     else:
 637         bpy.ops.object.mode_set(mode='OBJECT')
 638         ob.location = oldLocation
 639         ob.rotation_euler = oldRotation
 640         ob.scale = oldScale
 641         ob.select_set(False)
 642         armature_object.select_set(True)
 643         scn.objects.active = armature_object
 644
 645     armature_object.location = oldLocation
 646     armature_object.rotation_euler = oldRotation
 647     armature_object.scale = oldScale
 648     bpy.ops.object.mode_set(mode='POSE')
 649
 650     return {'FINISHED'}, me
 651
 652
 653 class BONE_OT_custom_shape(Operator):
 654     bl_idname = "object.skinify_rig"
 655     bl_label = "Skinify Rig"
 656     bl_description = "Creates a mesh object at the selected bones positions"
 657     bl_options = {'UNDO', 'INTERNAL'}
 658
 659     @classmethod
 660     def poll(cls, context):
 661         return context.active_object is not None
 662
 663     def execute(self, context):
 664         Mesh = main(context)
 665         if Mesh[0] == {'CANCELLED'}:
 666             self.report({'WARNING'}, Mesh[1])
 667             return {'CANCELLED'}
 668         else:
 669             self.report({'INFO'}, Mesh[1].name + " has been created")
 670
 671             return {'FINISHED'}
 672
 673
 674 class BONE_PT_custom_shape(Panel):
 675     bl_space_type = "VIEW_3D"
 676     bl_region_type = "UI"
 677     bl_category = "Object"
 678 #    bl_context = "bone"
 679     bl_label = "Skinify Rig"
 680
 681     @classmethod
 682     def poll(cls, context):
 683         ob = context.object
 684         return ob and ob.mode == 'POSE' #and context.bone
 685
 686     def draw(self, context):
 687         layout = self.layout
 688         scn = context.scene.skinify
 689
 690         row = layout.row()
 691         row.operator("object.skinify_rig", text="Add Shape", icon='BONE_DATA')
 692
 693         split = layout.split(factor=0.3)
 694         split.label(text="Thickness:")
 695         split.prop(scn, "thickness", text="Body", icon='MOD_SKIN')
 696         split.prop(scn, "finger_thickness", text="Fingers", icon='HAND')
 697
 698         split = layout.split(factor=0.3)
 699         split.label(text="Mesh Density:")
 700         split.prop(scn, "sub_level", icon='MESH_ICOSPHERE')
 701
 702         row = layout.row()
 703         row.prop(scn, "connect_mesh", icon='EDITMODE_HLT')
 704         row.prop(scn, "connect_parents", icon='CONSTRAINT_BONE')
 705         row = layout.row()
 706         row.prop(scn, "head_ornaments", icon='GROUP_BONE')
 707         row.prop(scn, "generate_all", icon='GROUP_BONE')
 708         row = layout.row()
 709         row.prop(scn, "apply_mod", icon='FILE_TICK')
 710         if scn.apply_mod:
 711             row = layout.row()
 712             row.prop(scn, "parent_armature", icon='POSE_HLT')
 713
 714
 715 # define the scene properties in a group - call them with context.scene.skinify
 716 class Skinify_Properties(PropertyGroup):
 717     sub_level: IntProperty(
 718             name="Sub level",
 719             min=0, max=4,
 720             default=1,
 721             description="Mesh density"
 722             )
 723     thickness: FloatProperty(
 724             name="Thickness",
 725             min=0.01,
 726             default=0.8,
 727             description="Adjust shape thickness"
 728             )
 729     finger_thickness: FloatProperty(
 730             name="Finger Thickness",
 731             min=0.01, max=1.0,
 732             default=0.25,
 733             description="Adjust finger thickness relative to body"
 734             )
 735     connect_mesh: BoolProperty(
 736             name="Solid Shape",
 737             default=False,
 738             description="Makes solid shape from bone chains"
 739             )
 740     connect_parents: BoolProperty(
 741             name="Fill Gaps",
 742             default=False,
 743             description="Fills the gaps between parented bones"
 744             )
 745     generate_all: BoolProperty(
 746             name="All Shapes",
 747             default=False,
 748             description="Generates shapes from all bones"
 749             )
 750     head_ornaments: BoolProperty(
 751             name="Head Ornaments",
 752             default=False,
 753             description="Includes head ornaments"
 754             )
 755     apply_mod: BoolProperty(
 756             name="Apply Modifiers",
 757             default=True,
 758             description="Applies Modifiers to mesh"
 759             )
 760     parent_armature: BoolProperty(
 761             name="Parent Armature",
 762             default=True,
 763             description="Applies mesh to Armature"
 764             )
 765
 766
 767 # startup defaults
 768
 769 @persistent
 770 def startup_init(dummy):
 771     init_props()
 772
 773
 774 def register():
 775     bpy.utils.register_class(BONE_OT_custom_shape)
 776     bpy.utils.register_class(BONE_PT_custom_shape)
 777     bpy.utils.register_class(Skinify_Properties)
 778
 779     bpy.types.Scene.skinify = PointerProperty(
 780                                     type=Skinify_Properties
 781                                     )
 782     # startup defaults
 783     bpy.app.handlers.load_post.append(startup_init)
 784
 785
 786 def unregister():
 787     bpy.utils.unregister_class(BONE_OT_custom_shape)
 788     bpy.utils.unregister_class(BONE_PT_custom_shape)
 789     bpy.utils.unregister_class(Skinify_Properties)
 790
 791     # cleanup the handler
 792     bpy.app.handlers.load_post.remove(startup_init)
 793
 794     del bpy.types.Scene.skinify
 795
 796
 797 if __name__ == "__main__":
 798     register()