1 # ##### BEGIN GPL LICENSE BLOCK #####
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.
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.
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.
17 # ##### END GPL LICENCE BLOCK #####
20 "name": "Bone Selection Sets",
21 "author": "Inês Almeida, Sybren A. Stüvel, Antony Riakiotakis, Dan Eicher",
23 "blender": (2, 80, 0),
24 "location": "Properties > Object Data (Armature) > Selection Sets",
25 "description": "List of Bone sets for easy selection while animating",
27 "wiki_url": "https://docs.blender.org/manual/en/dev/addons/"
28 "animation/bone_selection_sets.html",
29 "category": "Animation",
33 from bpy
.types
import (
40 from bpy
.props
import (
49 # Data Structure ##############################################################
51 # Note: bones are stored by name, this means that if the bone is renamed,
52 # there can be problems. However, bone renaming is unlikely during animation.
53 class SelectionEntry(PropertyGroup
):
54 name
: StringProperty(name
="Bone Name")
57 class SelectionSet(PropertyGroup
):
58 name
: StringProperty(name
="Set Name")
59 bone_ids
: CollectionProperty(type=SelectionEntry
)
60 is_selected
: BoolProperty(name
="Is Selected")
63 # UI Panel w/ UIList ##########################################################
65 class POSE_MT_selection_sets_context_menu(Menu
):
66 bl_label
= "Selection Sets Specials"
68 def draw(self
, context
):
71 layout
.operator("pose.selection_set_delete_all", icon
='X')
72 layout
.operator("pose.selection_set_remove_bones", icon
='X')
73 layout
.operator("pose.selection_set_copy", icon
='COPYDOWN')
74 layout
.operator("pose.selection_set_paste", icon
='PASTEDOWN')
77 class POSE_PT_selection_sets(Panel
):
78 bl_label
= "Selection Sets"
79 bl_space_type
= 'PROPERTIES'
80 bl_region_type
= 'WINDOW'
82 bl_options
= {'DEFAULT_CLOSED'}
85 def poll(cls
, context
):
86 return (context
.object and
87 context
.object.type == 'ARMATURE' and
90 def draw(self
, context
):
96 row
.enabled
= (context
.mode
== 'POSE')
99 rows
= 4 if len(arm
.selection_sets
) > 0 else 1
101 "POSE_UL_selection_set", "", # type and unique id
102 arm
, "selection_sets", # pointer to the CollectionProperty
103 arm
, "active_selection_set", # pointer to the active identifier
107 # add/remove/specials UI list Menu
108 col
= row
.column(align
=True)
109 col
.operator("pose.selection_set_add", icon
='ADD', text
="")
110 col
.operator("pose.selection_set_remove", icon
='REMOVE', text
="")
111 col
.menu("POSE_MT_selection_sets_context_menu", icon
='DOWNARROW_HLT', text
="")
113 # move up/down arrows
114 if len(arm
.selection_sets
) > 0:
116 col
.operator("pose.selection_set_move", icon
='TRIA_UP', text
="").direction
= 'UP'
117 col
.operator("pose.selection_set_move", icon
='TRIA_DOWN', text
="").direction
= 'DOWN'
122 sub
= row
.row(align
=True)
123 sub
.operator("pose.selection_set_assign", text
="Assign")
124 sub
.operator("pose.selection_set_unassign", text
="Remove")
126 sub
= row
.row(align
=True)
127 sub
.operator("pose.selection_set_select", text
="Select")
128 sub
.operator("pose.selection_set_deselect", text
="Deselect")
131 class POSE_UL_selection_set(UIList
):
132 def draw_item(self
, context
, layout
, data
, item
, icon
, active_data
, active_propname
, index
):
134 layout
.prop(item
, "name", text
="", icon
='GROUP_BONE', emboss
=False)
135 if self
.layout_type
in ('DEFAULT', 'COMPACT'):
136 layout
.prop(item
, "is_selected", text
="")
139 class POSE_MT_selection_set_create(Menu
):
140 bl_label
= "Choose Selection Set"
142 def draw(self
, context
):
144 layout
.operator("pose.selection_set_add_and_assign",
145 text
="New Selection Set")
148 class POSE_MT_selection_sets_select(Menu
):
149 bl_label
= 'Select Selection Set'
152 def poll(cls
, context
):
153 return POSE_OT_selection_set_select
.poll(context
)
155 def draw(self
, context
):
157 layout
.operator_context
= 'EXEC_DEFAULT'
158 for idx
, sel_set
in enumerate(context
.object.selection_sets
):
159 props
= layout
.operator(POSE_OT_selection_set_select
.bl_idname
, text
=sel_set
.name
)
160 props
.selection_set_index
= idx
163 # Operators ###################################################################
165 class PluginOperator(Operator
):
166 """Operator only available for objects of type armature in pose mode."""
168 def poll(cls
, context
):
169 return (context
.object and
170 context
.object.type == 'ARMATURE' and
171 context
.mode
== 'POSE')
174 class NeedSelSetPluginOperator(PluginOperator
):
175 """Operator only available if the armature has a selected selection set."""
177 def poll(cls
, context
):
178 if not super().poll(context
):
181 return 0 <= arm
.active_selection_set
< len(arm
.selection_sets
)
184 class POSE_OT_selection_set_delete_all(PluginOperator
):
185 bl_idname
= "pose.selection_set_delete_all"
186 bl_label
= "Delete All Sets"
187 bl_description
= "Deletes All Selection Sets"
188 bl_options
= {'UNDO', 'REGISTER'}
190 def execute(self
, context
):
192 arm
.selection_sets
.clear()
196 class POSE_OT_selection_set_remove_bones(PluginOperator
):
197 bl_idname
= "pose.selection_set_remove_bones"
198 bl_label
= "Remove Selected Bones from All Sets"
199 bl_description
= "Removes the Selected Bones from All Sets"
200 bl_options
= {'UNDO', 'REGISTER'}
202 def execute(self
, context
):
205 # iterate only the selected bones in current pose that are not hidden
206 for bone
in context
.selected_pose_bones
:
207 for selset
in arm
.selection_sets
:
208 if bone
.name
in selset
.bone_ids
:
209 idx
= selset
.bone_ids
.find(bone
.name
)
210 selset
.bone_ids
.remove(idx
)
215 class POSE_OT_selection_set_move(NeedSelSetPluginOperator
):
216 bl_idname
= "pose.selection_set_move"
217 bl_label
= "Move Selection Set in List"
218 bl_description
= "Move the active Selection Set up/down the list of sets"
219 bl_options
= {'UNDO', 'REGISTER'}
221 direction
: EnumProperty(
222 name
="Move Direction",
223 description
="Direction to move the active Selection Set: UP (default) or DOWN",
225 ('UP', "Up", "", -1),
226 ('DOWN', "Down", "", 1),
233 def poll(cls
, context
):
234 if not super().poll(context
):
237 return len(arm
.selection_sets
) > 1
239 def execute(self
, context
):
242 active_idx
= arm
.active_selection_set
243 new_idx
= active_idx
+ (-1 if self
.direction
== 'UP' else 1)
245 if new_idx
< 0 or new_idx
>= len(arm
.selection_sets
):
248 arm
.selection_sets
.move(active_idx
, new_idx
)
249 arm
.active_selection_set
= new_idx
254 class POSE_OT_selection_set_add(PluginOperator
):
255 bl_idname
= "pose.selection_set_add"
256 bl_label
= "Create Selection Set"
257 bl_description
= "Creates a new empty Selection Set"
258 bl_options
= {'UNDO', 'REGISTER'}
260 def execute(self
, context
):
262 sel_sets
= arm
.selection_sets
263 new_sel_set
= sel_sets
.add()
264 new_sel_set
.name
= uniqify("SelectionSet", sel_sets
.keys())
266 # select newly created set
267 arm
.active_selection_set
= len(sel_sets
) - 1
272 class POSE_OT_selection_set_remove(NeedSelSetPluginOperator
):
273 bl_idname
= "pose.selection_set_remove"
274 bl_label
= "Delete Selection Set"
275 bl_description
= "Delete a Selection Set"
276 bl_options
= {'UNDO', 'REGISTER'}
278 def execute(self
, context
):
281 arm
.selection_sets
.remove(arm
.active_selection_set
)
283 # change currently active selection set
284 numsets
= len(arm
.selection_sets
)
285 if (arm
.active_selection_set
> (numsets
- 1) and numsets
> 0):
286 arm
.active_selection_set
= len(arm
.selection_sets
) - 1
291 class POSE_OT_selection_set_assign(PluginOperator
):
292 bl_idname
= "pose.selection_set_assign"
293 bl_label
= "Add Bones to Selection Set"
294 bl_description
= "Add selected bones to Selection Set"
295 bl_options
= {'UNDO', 'REGISTER'}
297 def invoke(self
, context
, event
):
300 if not (arm
.active_selection_set
< len(arm
.selection_sets
)):
301 bpy
.ops
.wm
.call_menu("INVOKE_DEFAULT",
302 name
="POSE_MT_selection_set_create")
304 bpy
.ops
.pose
.selection_set_assign('EXEC_DEFAULT')
308 def execute(self
, context
):
310 act_sel_set
= arm
.selection_sets
[arm
.active_selection_set
]
312 # iterate only the selected bones in current pose that are not hidden
313 for bone
in context
.selected_pose_bones
:
314 if bone
.name
not in act_sel_set
.bone_ids
:
315 bone_id
= act_sel_set
.bone_ids
.add()
316 bone_id
.name
= bone
.name
321 class POSE_OT_selection_set_unassign(NeedSelSetPluginOperator
):
322 bl_idname
= "pose.selection_set_unassign"
323 bl_label
= "Remove Bones from Selection Set"
324 bl_description
= "Remove selected bones from Selection Set"
325 bl_options
= {'UNDO', 'REGISTER'}
327 def execute(self
, context
):
329 act_sel_set
= arm
.selection_sets
[arm
.active_selection_set
]
331 # iterate only the selected bones in current pose that are not hidden
332 for bone
in context
.selected_pose_bones
:
333 if bone
.name
in act_sel_set
.bone_ids
:
334 idx
= act_sel_set
.bone_ids
.find(bone
.name
)
335 act_sel_set
.bone_ids
.remove(idx
)
340 class POSE_OT_selection_set_select(NeedSelSetPluginOperator
):
341 bl_idname
= "pose.selection_set_select"
342 bl_label
= "Select Selection Set"
343 bl_description
= "Add Selection Set bones to current selection"
344 bl_options
= {'UNDO', 'REGISTER'}
346 selection_set_index
: IntProperty(
347 name
='Selection Set Index',
349 description
='Which Selection Set to select; -1 uses the active Selection Set',
353 def execute(self
, context
):
356 if self
.selection_set_index
== -1:
357 idx
= arm
.active_selection_set
359 idx
= self
.selection_set_index
360 sel_set
= arm
.selection_sets
[idx
]
362 for bone
in context
.visible_pose_bones
:
363 if bone
.name
in sel_set
.bone_ids
:
364 bone
.bone
.select
= True
369 class POSE_OT_selection_set_deselect(NeedSelSetPluginOperator
):
370 bl_idname
= "pose.selection_set_deselect"
371 bl_label
= "Deselect Selection Set"
372 bl_description
= "Remove Selection Set bones from current selection"
373 bl_options
= {'UNDO', 'REGISTER'}
375 def execute(self
, context
):
377 act_sel_set
= arm
.selection_sets
[arm
.active_selection_set
]
379 for bone
in context
.selected_pose_bones
:
380 if bone
.name
in act_sel_set
.bone_ids
:
381 bone
.bone
.select
= False
386 class POSE_OT_selection_set_add_and_assign(PluginOperator
):
387 bl_idname
= "pose.selection_set_add_and_assign"
388 bl_label
= "Create and Add Bones to Selection Set"
389 bl_description
= "Creates a new Selection Set with the currently selected bones"
390 bl_options
= {'UNDO', 'REGISTER'}
392 def execute(self
, context
):
393 bpy
.ops
.pose
.selection_set_add('EXEC_DEFAULT')
394 bpy
.ops
.pose
.selection_set_assign('EXEC_DEFAULT')
398 class POSE_OT_selection_set_copy(NeedSelSetPluginOperator
):
399 bl_idname
= "pose.selection_set_copy"
400 bl_label
= "Copy Selection Set(s)"
401 bl_description
= "Copies the selected Selection Set(s) to the clipboard"
402 bl_options
= {'UNDO', 'REGISTER'}
404 def execute(self
, context
):
405 context
.window_manager
.clipboard
= to_json(context
)
406 self
.report({'INFO'}, 'Copied Selection Set(s) to Clipboard')
410 class POSE_OT_selection_set_paste(PluginOperator
):
411 bl_idname
= "pose.selection_set_paste"
412 bl_label
= "Paste Selection Set(s)"
413 bl_description
= "Adds new Selection Set(s) from the Clipboard"
414 bl_options
= {'UNDO', 'REGISTER'}
416 def execute(self
, context
):
420 from_json(context
, context
.window_manager
.clipboard
)
421 except (json
.JSONDecodeError
, KeyError):
422 self
.report({'ERROR'}, 'The clipboard does not contain a Selection Set')
424 # Select the pasted Selection Set.
425 context
.object.active_selection_set
= len(context
.object.selection_sets
) - 1
430 # Helper Functions ############################################################
432 def menu_func_select_selection_set(self
, context
):
433 self
.layout
.menu('POSE_MT_selection_sets_select', text
="Bone Selection Set")
436 def to_json(context
) -> str:
437 """Convert the selected Selection Sets of the current rig to JSON.
439 Selected Sets are the active_selection_set determined by the UIList
440 plus any with the is_selected checkbox on."""
444 active_idx
= arm
.active_selection_set
447 for idx
, sel_set
in enumerate(context
.object.selection_sets
):
448 if idx
== active_idx
or sel_set
.is_selected
:
449 bones
= [bone_id
.name
for bone_id
in sel_set
.bone_ids
]
450 json_obj
[sel_set
.name
] = bones
452 return json
.dumps(json_obj
)
455 def from_json(context
, as_json
: str):
456 """Add the selection sets (one or more) from JSON to the current rig."""
459 json_obj
= json
.loads(as_json
)
460 arm_sel_sets
= context
.object.selection_sets
462 for name
, bones
in json_obj
.items():
463 new_sel_set
= arm_sel_sets
.add()
464 new_sel_set
.name
= uniqify(name
, arm_sel_sets
.keys())
465 for bone_name
in bones
:
466 bone_id
= new_sel_set
.bone_ids
.add()
467 bone_id
.name
= bone_name
470 def uniqify(name
: str, other_names
: list) -> str:
471 """Return a unique name with .xxx suffix if necessary.
475 >>> uniqify('hey', ['there'])
477 >>> uniqify('hey', ['hey.001', 'hey.005'])
479 >>> uniqify('hey', ['hey', 'hey.001', 'hey.005'])
481 >>> uniqify('hey', ['hey', 'hey.005', 'hey.001'])
483 >>> uniqify('hey', ['hey', 'hey.005', 'hey.001', 'hey.left'])
485 >>> uniqify('hey', ['hey', 'hey.001', 'hey.002'])
488 It also works with a dict_keys object:
489 >>> uniqify('hey', {'hey': 1, 'hey.005': 1, 'hey.001': 1}.keys())
493 if name
not in other_names
:
496 # Construct the list of numbers already in use.
497 offset
= len(name
) + 1
498 others
= (n
[offset
:] for n
in other_names
499 if n
.startswith(name
+ '.'))
500 numbers
= sorted(int(suffix
) for suffix
in others
503 # Find the first unused number.
509 return "{}.{:03d}".format(name
, min_index
)
512 # Registry ####################################################################
515 POSE_MT_selection_set_create
,
516 POSE_MT_selection_sets_context_menu
,
517 POSE_MT_selection_sets_select
,
518 POSE_PT_selection_sets
,
519 POSE_UL_selection_set
,
522 POSE_OT_selection_set_delete_all
,
523 POSE_OT_selection_set_remove_bones
,
524 POSE_OT_selection_set_move
,
525 POSE_OT_selection_set_add
,
526 POSE_OT_selection_set_remove
,
527 POSE_OT_selection_set_assign
,
528 POSE_OT_selection_set_unassign
,
529 POSE_OT_selection_set_select
,
530 POSE_OT_selection_set_deselect
,
531 POSE_OT_selection_set_add_and_assign
,
532 POSE_OT_selection_set_copy
,
533 POSE_OT_selection_set_paste
,
537 # Store keymaps here to access after registration.
543 bpy
.utils
.register_class(cls
)
546 bpy
.types
.Object
.selection_sets
= CollectionProperty(
548 name
="Selection Sets",
549 description
="List of groups of bones for easy selection"
551 bpy
.types
.Object
.active_selection_set
= IntProperty(
552 name
="Active Selection Set",
553 description
="Index of the currently active selection set",
557 # Add shortcuts to the keymap.
558 wm
= bpy
.context
.window_manager
559 km
= wm
.keyconfigs
.addon
.keymaps
.new(name
='Pose')
560 kmi
= km
.keymap_items
.new('wm.call_menu', 'W', 'PRESS', alt
=True, shift
=True)
561 kmi
.properties
.name
= 'POSE_MT_selection_sets_select'
562 addon_keymaps
.append((km
, kmi
))
564 # Add entries to menus.
565 bpy
.types
.VIEW3D_MT_select_pose
.append(menu_func_select_selection_set
)
570 bpy
.utils
.unregister_class(cls
)
573 del bpy
.types
.Object
.selection_sets
574 del bpy
.types
.Object
.active_selection_set
576 # Clear shortcuts from the keymap.
577 for km
, kmi
in addon_keymaps
:
578 km
.keymap_items
.remove(kmi
)
579 addon_keymaps
.clear()
581 # Clear entries from menus.
582 bpy
.types
.VIEW3D_MT_select_pose
.remove(menu_func_select_selection_set
)
586 if __name__
== "__main__":