1 # SPDX-License-Identifier: GPL-2.0-or-later
6 from string
import capwords
7 from collections
import defaultdict
8 from types
import ModuleType
9 from typing
import Iterable
13 from .utils
.rig
import METARIG_DIR
, get_resource
15 from . import feature_set_list
18 class ArmatureSubMenu(bpy
.types
.Menu
):
19 # bl_idname = 'ARMATURE_MT_armature_class'
21 operators
: list[tuple[str, str]]
23 def draw(self
, context
):
25 layout
.label(text
=self
.bl_label
)
26 for op
, name
in self
.operators
:
27 text
= capwords(name
.replace("_", " ")) + " (Meta-Rig)"
28 layout
.operator(op
, icon
='OUTLINER_OB_ARMATURE', text
=text
)
31 def get_metarigs(metarig_table
: dict[str, ModuleType |
dict],
32 base_dir
: str, base_path
: list[str], *,
33 path
: Iterable
[str] = (), nested
=False):
34 """ Searches for metarig modules, and returns a list of the
38 dir_path
= os
.path
.join(base_dir
, *path
)
41 files
: list[str] = os
.listdir(dir_path
)
42 except FileNotFoundError
:
48 is_dir
= os
.path
.isdir(os
.path
.join(dir_path
, f
)) # Whether the file is a directory
51 if f
[0] in [".", "_"]:
53 if f
.count(".") >= 2 or (is_dir
and "." in f
):
54 print("Warning: %r, filename contains a '.', skipping" % os
.path
.join(*path
, f
))
57 if is_dir
: # Check directories
58 get_metarigs(metarig_table
[f
], base_dir
, base_path
, path
=[*path
, f
], nested
=True)
59 elif f
.endswith(".py"):
60 # Check straight-up python files
62 module
= get_resource('.'.join([*base_path
, *path
, f
]))
64 metarig_table
[f
] = module
66 metarig_table
[METARIG_DIR
][f
] = module
69 def make_metarig_add_execute(module
):
70 """ Create an execute method for a metarig creation operator.
72 def execute(_self
, context
):
74 bpy
.ops
.object.armature_add()
75 obj
= context
.active_object
77 obj
.data
.name
= "metarig"
80 bpy
.ops
.object.mode_set(mode
='EDIT')
81 bones
= context
.active_object
.data
.edit_bones
82 bones
.remove(bones
[0])
87 bpy
.ops
.object.mode_set(mode
='OBJECT')
92 def make_metarig_menu_func(bl_idname
: str, text
: str):
93 """ For some reason lambda's don't work for adding multiple menu
94 items, so we use this instead to generate the functions.
96 def metarig_menu(self
, _context
):
97 self
.layout
.operator(bl_idname
, icon
='OUTLINER_OB_ARMATURE', text
=text
)
101 def make_submenu_func(bl_idname
: str, text
: str):
102 def metarig_menu(self
, _context
):
103 self
.layout
.menu(bl_idname
, icon
='OUTLINER_OB_ARMATURE', text
=text
)
107 # Get the metarig modules
108 def get_internal_metarigs():
109 base_rigify_dir
= os
.path
.dirname(__file__
)
110 base_rigify_path
= __name__
.split('.')[:-1]
112 get_metarigs(metarigs
,
113 os
.path
.join(base_rigify_dir
, METARIG_DIR
),
114 [*base_rigify_path
, METARIG_DIR
])
117 def infinite_default_dict():
118 return defaultdict(infinite_default_dict
)
121 metarigs
= infinite_default_dict()
123 armature_submenus
= []
127 def create_metarig_ops(dic
: dict |
None = None):
131 """Create metarig add Operators"""
132 for metarig_category
in dic
:
133 if metarig_category
== "external":
134 create_metarig_ops(dic
[metarig_category
])
136 if metarig_category
not in metarig_ops
:
137 metarig_ops
[metarig_category
] = []
138 for m
in dic
[metarig_category
].values():
139 name
= m
.__name
__.rsplit('.', 1)[1]
141 # Dynamically construct an Operator
142 op_type
= type("Add_" + name
+ "_Metarig", (bpy
.types
.Operator
,), {})
143 op_type
.bl_idname
= "object.armature_" + name
+ "_metarig_add"
144 op_type
.bl_label
= "Add " + name
.replace("_", " ").capitalize() + " (metarig)"
145 op_type
.bl_options
= {'REGISTER', 'UNDO'}
146 op_type
.execute
= make_metarig_add_execute(m
)
148 metarig_ops
[metarig_category
].append((op_type
, name
))
151 def create_menu_funcs():
153 for mop
, name
in metarig_ops
[METARIG_DIR
]:
154 text
= capwords(name
.replace("_", " ")) + " (Meta-Rig)"
155 menu_funcs
+= [make_metarig_menu_func(mop
.bl_idname
, text
)]
158 def create_armature_submenus(dic
: dict |
None = None):
162 metarig_categories
= list(dic
.keys())
163 metarig_categories
.sort()
164 for metarig_category
in metarig_categories
:
165 # Create menu functions
166 if metarig_category
== "external":
167 create_armature_submenus(dic
=metarigs
["external"])
169 if metarig_category
== METARIG_DIR
:
172 armature_submenus
.append(type('Class_' + metarig_category
+ '_submenu',
173 (ArmatureSubMenu
,), {}))
174 armature_submenus
[-1].bl_label
= metarig_category
+ ' (submenu)'
175 armature_submenus
[-1].bl_idname
= 'ARMATURE_MT_%s_class' % metarig_category
176 armature_submenus
[-1].operators
= []
177 menu_funcs
+= [make_submenu_func(armature_submenus
[-1].bl_idname
, metarig_category
)]
179 for mop
, name
in metarig_ops
[metarig_category
]:
180 arm_sub
= next((e
for e
in armature_submenus
181 if e
.bl_label
== metarig_category
+ ' (submenu)'),
183 arm_sub
.operators
.append((mop
.bl_idname
, name
,))
186 def init_metarig_menu():
187 get_internal_metarigs()
190 create_armature_submenus()
197 from bpy
.utils
import register_class
199 for cl
in metarig_ops
:
200 for mop
, name
in metarig_ops
[cl
]:
203 for arm_sub
in armature_submenus
:
204 register_class(arm_sub
)
206 for mf
in menu_funcs
:
207 bpy
.types
.VIEW3D_MT_armature_add
.append(mf
)
211 from bpy
.utils
import unregister_class
213 for cl
in metarig_ops
:
214 for mop
, name
in metarig_ops
[cl
]:
215 unregister_class(mop
)
217 for arm_sub
in armature_submenus
:
218 unregister_class(arm_sub
)
220 for mf
in menu_funcs
:
221 bpy
.types
.VIEW3D_MT_armature_add
.remove(mf
)
224 def get_external_metarigs(feature_module_names
: list[str]):
227 # Clear and fill metarigs public variables
229 get_internal_metarigs()
231 for module_name
in feature_module_names
:
232 # noinspection PyBroadException
234 base_dir
, base_path
= feature_set_list
.get_dir_path(module_name
, METARIG_DIR
)
236 get_metarigs(metarigs
['external'], base_dir
, base_path
)
238 print(f
"Rigify Error: Could not load feature set '{module_name}' metarigs: "
239 f
"exception occurred.\n")
240 traceback
.print_exc()
245 armature_submenus
.clear()
250 create_armature_submenus()