External Rigs, metarigs and UI templates

Author: PiOverFour

__init__.py

@@ -37,15 +37,17 @@
     importlib.reload(utils)
     importlib.reload(metarig_menu)
     importlib.reload(rig_lists)
+    importlib.reload(template_list)
+    importlib.reload(feature_sets)
 else:
-    from . import utils, rig_lists, generate, ui, metarig_menu
+    from . import (utils, rig_lists, template_list,
+                   generate, ui, metarig_menu, feature_sets)
 
 import bpy
 import sys
 import os
 from bpy.types import AddonPreferences
 from bpy.props import BoolProperty
-from bpy.props import StringProperty
 
 
 class RigifyPreferences(AddonPreferences):
@@ -119,29 +121,28 @@ def update_legacy(self, context):
 
             register()
 
-    def update_external_rigs(self, context):
-
+    def update_external_rigs(self):
+        """Get external feature sets"""
         if self.legacy_mode:
             return
 
-        custom_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+        feature_sets_path = os.path.join(bpy.utils.script_path_user(), 'rigify')
 
-        if custom_rigs_folder == "" and 'external' in rig_lists.rigs_dict:
-            rig_lists.rigs_dict.pop('external')
-            return
+        invalid_path = not os.path.exists(feature_sets_path)
+        if not invalid_path:
+            if feature_sets_path not in sys.path:
+                sys.path.append(feature_sets_path)
+            # Reload rigs
+            print('Reloading external rigs...')
+            rig_lists.get_external_rigs(feature_sets_path)
 
-        if custom_rigs_folder not in sys.path:
-            sys.path.append(bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder)
+            # Reload metarigs
+            print('Reloading external metarigs...')
+            metarig_menu.get_external_metarigs(feature_sets_path)
 
-        rig_lists.get_external_rigs()
-        if 'external' in rig_lists.rigs_dict and rig_lists.rigs_dict['external']:
-            # Add external rig parameters
-            for rig in rig_lists.rigs_dict['external']['rig_list']:
-                r = utils.get_rig_type(rig, custom_rigs_folder)
-                try:
-                    r.add_parameters(RigifyParameterValidator(RigifyParameters, rig, RIGIFY_PARAMETER_TABLE))
-                except AttributeError:
-                    pass
+            # Reload templates
+            print('Reloading external templates...')
+            template_list.get_external_templates(feature_sets_path)
 
     legacy_mode = BoolProperty(
         name='Rigify Legacy Mode',
@@ -150,14 +151,6 @@ def update_external_rigs(self, context):
         update=update_legacy
     )
 
-    custom_rigs_folder = StringProperty(
-        name='Rigify Custom Rigs',
-        description='Folder Containing User Defined Rig Types',
-        default='',
-        subtype='DIR_PATH',
-        update=update_external_rigs
-    )
-
     show_expanded = BoolProperty()
 
     show_rigs_folder_expanded = BoolProperty()
@@ -186,7 +179,7 @@ def draw(self, context):
         if expand:
             split = col.row().split(percentage=0.15)
             split.label('Description:')
-            split.label(text='This is the folder containing user defined Rig Types')
+            split.label(text='When enabled the add-on will run in legacy mode using the old 2.76b feature set.')
 
         box = column.box()
         rigs_expand = getattr(self, 'show_rigs_folder_expanded')
@@ -199,12 +192,21 @@ def draw(self, context):
         op = sub.operator('wm.context_toggle', text='', icon=icon,
                           emboss=False)
         op.data_path = 'addon_prefs.show_rigs_folder_expanded'
-        row.prop(self, 'custom_rigs_folder')
-
+        sub.label('{}: {}'.format('Rigify', 'External feature sets'))
         if rigs_expand:
+            if os.path.exists(os.path.join(bpy.utils.script_path_user(), 'rigify')):
+                feature_sets_path = os.path.join(bpy.utils.script_path_user(), 'rigify')
+                for fs in os.listdir(feature_sets_path):
+                    row = col.row()
+                    row.label(fs)
+                    op = row.operator("wm.rigify_remove_feature_set", text="Remove", icon='CANCEL')
+                    op.featureset = fs
+            row = col.row(align=True)
+            row.operator("wm.rigify_add_feature_set", text="Install Feature Set from File...", icon='FILESEL')
+
             split = col.row().split(percentage=0.15)
             split.label('Description:')
-            split.label(text='When enabled the add-on will run in legacy mode using the old 2.76b feature set.')
+            split.label(text='External feature sets (rigs, metarigs, ui layouts)')
 
         row = layout.row()
         row.label("End of Rigify Preferences")
@@ -259,6 +261,10 @@ class RigifySelectionColors(bpy.types.PropertyGroup):
                                            )
 
 
+class RigifyTemplate(bpy.types.PropertyGroup):
+    name = bpy.props.StringProperty()
+
+
 class RigifyParameters(bpy.types.PropertyGroup):
     name = bpy.props.StringProperty()
 
@@ -340,9 +346,11 @@ def set_group(self, value):
 
 def register():
     ui.register()
+    feature_sets.register()
     metarig_menu.register()
 
     bpy.utils.register_class(RigifyName)
+    bpy.utils.register_class(RigifyTemplate)
     bpy.utils.register_class(RigifyParameters)
 
     bpy.utils.register_class(RigifyColorSet)
@@ -351,6 +359,12 @@ def register():
     bpy.utils.register_class(RigifyPreferences)
     bpy.types.Armature.rigify_layers = bpy.props.CollectionProperty(type=RigifyArmatureLayer)
 
+    bpy.types.Armature.active_feature_set = bpy.props.EnumProperty(
+        items=feature_sets.feature_set_items,
+        name="Feature Set",
+        description="Feature set to select from for this bone"
+        )
+
     bpy.types.PoseBone.rigify_type = bpy.props.StringProperty(name="Rigify Type", description="Rig type for this bone")
     bpy.types.PoseBone.rigify_parameters = bpy.props.PointerProperty(type=RigifyParameters)
 
@@ -383,7 +397,8 @@ def register():
                                                                            ), name='Theme')
 
     IDStore = bpy.types.WindowManager
-    IDStore.rigify_collection = bpy.props.EnumProperty(items=rig_lists.col_enum_list, default="All",
+    IDStore.rigify_collection = bpy.props.EnumProperty(items=(("All", "All", "All"),),
+                                                       default="All",
                                                        name="Rigify Active Collection",
                                                        description="The selected rig collection")
 
@@ -429,19 +444,27 @@ def update_mode(self, context):
     if (ui and 'legacy' in str(ui)) or bpy.context.user_preferences.addons['rigify'].preferences.legacy_mode:
         # update legacy on restart or reload
         bpy.context.user_preferences.addons['rigify'].preferences.legacy_mode = True
+    IDStore = bpy.types.Armature
+    IDStore.rigify_templates = bpy.props.CollectionProperty(type=RigifyTemplate)
+    IDStore.rigify_active_template = bpy.props.IntProperty(name="Rigify Active Template", description="The selected ui template", default=0)
 
-    # Add rig parameters
-    for rig in rig_lists.rig_list:
-        r = utils.get_rig_type(rig)
-        try:
-            r.add_parameters(RigifyParameterValidator(RigifyParameters, rig, RIGIFY_PARAMETER_TABLE))
-        except AttributeError:
-            pass
+    bpy.context.user_preferences.addons['rigify'].preferences.update_external_rigs()
 
-    external_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
-    if external_rigs_folder and not 'external' in rig_lists.rigs_dict:
-        #force update on reload
-        bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder = external_rigs_folder
+    # Add rig parameters
+    if bpy.context.user_preferences.addons['rigify'].preferences.legacy_mode:
+        for rig in rig_lists.rig_list:
+            r = utils.get_rig_type(rig)
+            try:
+                r.add_parameters(RigifyParameters)
+            except AttributeError:
+                pass
+    else:
+        for rig in rig_lists.rigs:
+            r = rig_lists.rigs[rig]['module']
+            try:
+                r.add_parameters(RigifyParameters)
+            except AttributeError:
+                pass
 
 
 def unregister():
@@ -464,17 +487,21 @@ def unregister():
     del IDStore.rigify_transfer_start_frame
     del IDStore.rigify_transfer_end_frame
 
+    IDStore = bpy.types.Armature
+    del IDStore.rigify_templates
+    del IDStore.rigify_active_template
+
     bpy.utils.unregister_class(RigifyName)
+    bpy.utils.unregister_class(RigifyTemplate)
     bpy.utils.unregister_class(RigifyParameters)
 
     bpy.utils.unregister_class(RigifyColorSet)
     bpy.utils.unregister_class(RigifySelectionColors)
 
     bpy.utils.unregister_class(RigifyArmatureLayer)
-
-    if bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder in sys.path:
-        sys.path.remove(bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder)
-    bpy.utils.unregister_class(RigifyPreferences)
+    if "bl_rna" in RigifyPreferences.__dict__:
+        bpy.utils.unregister_class(RigifyPreferences)
 
     metarig_menu.unregister()
     ui.unregister()
+    feature_sets.unregister()

feature_sets.py

@@ -0,0 +1,96 @@
+#====================== 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 ========================
+
+import bpy
+import os
+from zipfile import ZipFile
+from shutil import rmtree
+
+
+def feature_set_items(scene, context):
+    """Get items for the Feature Set EnumProperty"""
+    feature_sets_path = os.path.join(
+        bpy.utils.script_path_user(), 'rigify')
+    items = [('all',)*3, ('rigify',)*3, ]
+    for fs in os.listdir(feature_sets_path):
+        items.append((fs,)*3)
+
+    return items
+
+class DATA_OT_rigify_add_feature_set(bpy.types.Operator):
+    bl_idname = "wm.rigify_add_feature_set"
+    bl_label = "Add External Feature Set"
+    bl_description = "Add external feature set (rigs, metarigs, ui templates)"
+    bl_options = {"REGISTER", "UNDO"}
+
+    filter_glob = bpy.props.StringProperty(default="*.zip", options={'HIDDEN'})
+    filepath = bpy.props.StringProperty(maxlen=1024, subtype='FILE_PATH', options={'HIDDEN', 'SKIP_SAVE'})
+
+    @classmethod
+    def poll(cls, context):
+        return True
+
+    def invoke(self, context, event):
+        context.window_manager.fileselect_add(self)
+        return {'RUNNING_MODAL'}
+
+    def execute(self, context):
+        addon_prefs = context.user_preferences.addons[__package__].preferences
+
+        rigify_config_path = os.path.join(bpy.utils.script_path_user(), 'rigify')
+        os.makedirs(rigify_config_path, exist_ok=True)
+        with ZipFile(bpy.path.abspath(self.filepath), 'r') as zip_archive:
+            zip_archive.extractall(rigify_config_path)
+
+        addon_prefs.machin = bpy.props.EnumProperty(items=(('a',)*3, ('b',)*3, ('c',)*3),)
+
+        addon_prefs.update_external_rigs()
+        return {'FINISHED'}
+
+
+class DATA_OT_rigify_remove_feature_set(bpy.types.Operator):
+    bl_idname = "wm.rigify_remove_feature_set"
+    bl_label = "Remove External Feature Set"
+    bl_description = "Remove external feature set (rigs, metarigs, ui templates)"
+    bl_options = {"REGISTER", "UNDO"}
+
+    featureset = bpy.props.StringProperty(maxlen=1024, options={'HIDDEN', 'SKIP_SAVE'})
+
+    @classmethod
+    def poll(cls, context):
+        return True
+
+    def invoke(self, context, event):
+        return context.window_manager.invoke_confirm(self, event)
+
+    def execute(self, context):
+        addon_prefs = context.user_preferences.addons[__package__].preferences
+
+        rigify_config_path = os.path.join(bpy.utils.script_path_user(), 'rigify')
+        rmtree(os.path.join(rigify_config_path, self.featureset))
+
+        addon_prefs.update_external_rigs()
+        return {'FINISHED'}
+
+def register():
+    bpy.utils.register_class(DATA_OT_rigify_add_feature_set)
+    bpy.utils.register_class(DATA_OT_rigify_remove_feature_set)
+
+def unregister():
+    bpy.utils.unregister_class(DATA_OT_rigify_add_feature_set)
+    bpy.utils.unregister_class(DATA_OT_rigify_remove_feature_set)

generate.py

@@ -26,15 +26,14 @@
 from rna_prop_ui import rna_idprop_ui_prop_get
 from collections import OrderedDict
 
-from .utils import MetarigError, new_bone, get_rig_type
-from .utils import ORG_PREFIX, MCH_PREFIX, DEF_PREFIX, WGT_PREFIX, ROOT_NAME, make_original_name
-from .utils import RIG_DIR
+from .utils import MetarigError, new_bone
+from .utils import MCH_PREFIX, DEF_PREFIX, WGT_PREFIX, ROOT_NAME, make_original_name
 from .utils import create_root_widget
 from .utils import random_id
 from .utils import copy_attributes
 from .utils import gamma_correct
-from .rig_ui_template import UI_IMPORTS, UI_BASE_UTILITIES, UI_UTILITIES, UI_SLIDERS, layers_ui, UI_REGISTER
-
+from . import rig_lists
+from . import template_list
 
 RIG_MODULE = "rigs"
 ORG_LAYER = [n == 31 for n in range(0, 32)]  # Armature layer that original bones should be moved to.
@@ -341,10 +340,18 @@ def generate_rig(context, metarig):
         t.tick("Initialize rigs: ")
 
         # Generate all the rigs.
+        armature_store = context.armature
+        if len(template_list.templates) > 1:
+            template_name = armature_store.rigify_templates[armature_store.rigify_active_template].name
+        else:
+            template_name = 'rig_ui_template'
+
+        template = template_list.templates[template_name]
+
         ui_scripts = []
-        ui_imports = UI_IMPORTS.copy()
-        ui_utilities = UI_UTILITIES.copy()
-        ui_register = UI_REGISTER.copy()
+        ui_imports = template.UI_IMPORTS.copy()
+        ui_utilities = template.UI_UTILITIES.copy()
+        ui_register = template.UI_REGISTER.copy()
         noparent_bones = []
         for rig in rigs:
             # Go into editmode in the rig armature
@@ -497,13 +504,13 @@ def generate_rig(context, metarig):
 
     for s in OrderedDict.fromkeys(ui_imports):
         script.write(s + "\n")
-    script.write(UI_BASE_UTILITIES % rig_id)
+    script.write(template.UI_BASE_UTILITIES % rig_id)
     for s in OrderedDict.fromkeys(ui_utilities):
         script.write(s + "\n")
-    script.write(UI_SLIDERS)
+    script.write(template.UI_SLIDERS)
     for s in ui_scripts:
         script.write("\n        " + s.replace("\n", "\n        ") + "\n")
-    script.write(layers_ui(vis_layers, layer_layout))
+    script.write(template.layers_ui(vis_layers, layer_layout))
     script.write("\ndef register():\n")
     ui_register = OrderedDict.fromkeys(ui_register)
     for s in ui_register:
@@ -644,8 +651,9 @@ def get_bone_rigs(obj, bone_name, halt_on_missing=False):
 
         # Get the rig
         try:
-            rig = get_rig_type(rig_type).Rig(obj, bone_name, params)
-        except ImportError:
+            rig = rig_lists.rigs[rig_type]["module"]
+            rig = rig.Rig(obj, bone_name, params)
+        except (KeyError, ImportError):
             message = "Rig Type Missing: python module for type '%s' not found (bone: %s)" % (rig_type, bone_name)
             if halt_on_missing:
                 raise MetarigError(message)