1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
|
# SPDX-FileCopyrightText: 2022-2023 Blender Foundation
#
# SPDX-License-Identifier: GPL-2.0-or-later
import bpy
from typing import Tuple, Optional, Sequence, Any
from bpy.types import PropertyGroup, Action, UIList, UILayout, Context, Panel, Operator, Armature
from bpy.props import (EnumProperty, IntProperty, BoolProperty, StringProperty, FloatProperty,
PointerProperty, CollectionProperty)
from bpy.app.translations import (
pgettext_iface as iface_,
pgettext_rpt as rpt_,
)
from .generic_ui_list import draw_ui_list
from ..utils.naming import mirror_name
from ..utils.action_layers import ActionSlotBase
from ..utils.rig import get_rigify_target_rig, is_valid_metarig
def get_action_slots(arm: Armature) -> Sequence['ActionSlot']:
return arm.rigify_action_slots # noqa
def get_action_slots_active(arm: Armature) -> tuple[Sequence['ActionSlot'], int]:
return arm.rigify_action_slots, arm.rigify_active_action_slot # noqa
def poll_trigger_action(_self, action):
"""Whether an action can be used as a corrective action's trigger or not."""
armature_id_store = bpy.context.object.data
assert isinstance(armature_id_store, Armature)
slots, idx = get_action_slots_active(armature_id_store)
active_slot = slots[idx] if 0 <= idx < len(slots) else None
# If this action is the same as the active slot's action, don't show it.
if active_slot and action == active_slot.action:
return False
# If this action is used by any other action slot, show it.
for slot in slots:
if slot.action == action and not slot.is_corrective:
return True
return False
class ActionSlot(PropertyGroup, ActionSlotBase):
action: PointerProperty(
name="Action",
type=Action,
description="Action to apply to the rig via constraints"
)
enabled: BoolProperty(
name="Enabled",
description="Create constraints for this action on the generated rig",
default=True
)
symmetrical: BoolProperty(
name="Symmetrical",
description="Apply the same setup but mirrored to the opposite side control, shown in "
"parentheses. Bones will only be affected by the control with the same side "
"(eg., .L bones will only be affected by the .L control). Bones without a "
"side in their name (so no .L or .R) will be affected by both controls "
"with 0.5 influence each",
default=True
)
subtarget: StringProperty(
name="Control Bone",
description="Select a bone on the generated rig which will drive this action"
)
transform_channel: EnumProperty(name="Transform Channel",
items=[("LOCATION_X", "X Location", "X Location"),
("LOCATION_Y", "Y Location", "Y Location"),
("LOCATION_Z", "Z Location", "Z Location"),
("ROTATION_X", "X Rotation", "X Rotation"),
("ROTATION_Y", "Y Rotation", "Y Rotation"),
("ROTATION_Z", "Z Rotation", "Z Rotation"),
("SCALE_X", "X Scale", "X Scale"),
("SCALE_Y", "Y Scale", "Y Scale"),
("SCALE_Z", "Z Scale", "Z Scale")],
description="Transform channel",
default="LOCATION_X")
target_space: EnumProperty(
name="Transform Space",
items=[("WORLD", "World Space", "World Space", 0),
# ("POSE", "Pose Space", "Pose Space", 1),
# ("LOCAL_WITH_PARENT", "Local With Parent", "Local With Parent", 2),
("LOCAL", "Local Space", "Local Space", 3)],
default="LOCAL"
)
def update_frame_start(self, _context):
if self.frame_start > self.frame_end:
self.frame_end = self.frame_start
frame_start: IntProperty(
name="Start Frame",
description="First frame of the action's timeline",
update=update_frame_start
)
def update_frame_end(self, _context):
if self.frame_end < self.frame_start:
self.frame_start = self.frame_end
frame_end: IntProperty(
name="End Frame",
default=2,
description="Last frame of the action's timeline",
update=update_frame_end
)
trans_min: FloatProperty(
name="Min",
default=-0.05,
description="Value that the transformation value must reach to put the action's timeline "
"to the first frame. Rotations are in degrees"
)
trans_max: FloatProperty(
name="Max",
default=0.05,
description="Value that the transformation value must reach to put the action's timeline "
"to the last frame. Rotations are in degrees"
)
is_corrective: BoolProperty(
name="Corrective",
description="Indicate that this is a corrective action. Corrective actions will activate "
"based on the activation of two other actions (using End Frame if both inputs "
"are at their End Frame, and Start Frame if either is at Start Frame)"
)
trigger_action_a: PointerProperty(
name="Trigger A",
type=Action,
description="Action whose activation will trigger the corrective action",
poll=poll_trigger_action
)
trigger_action_b: PointerProperty(
name="Trigger B",
description="Action whose activation will trigger the corrective action",
type=Action,
poll=poll_trigger_action
)
show_action_a: BoolProperty(name="Show Settings")
show_action_b: BoolProperty(name="Show Settings")
def find_slot_by_action(metarig_data: Armature, action) -> Tuple[Optional[ActionSlot], int]:
"""Find the ActionSlot in the rig which targets this action."""
if not action:
return None, -1
for i, slot in enumerate(get_action_slots(metarig_data)):
if slot.action == action:
return slot, i
else:
return None, -1
def find_duplicate_slot(metarig_data: Armature, action_slot: ActionSlot) -> Optional[ActionSlot]:
"""Find a different ActionSlot in the rig which has the same action."""
for slot in get_action_slots(metarig_data):
if slot.action == action_slot.action and slot != action_slot:
return slot
return None
# =============================================
# Operators
# noinspection PyPep8Naming
class RIGIFY_OT_action_create(Operator):
"""Create a new action"""
# This is needed because bpy.ops.action.new() has a poll function that blocks
# the operator unless it's drawn in an animation UI panel.
bl_idname = "object.rigify_action_create"
bl_label = "New"
bl_options = {'REGISTER', 'UNDO', 'INTERNAL'}
def execute(self, context):
armature_id_store = context.object.data
assert isinstance(armature_id_store, Armature)
action_slots, action_slot_idx = get_action_slots_active(armature_id_store)
action_slot = action_slots[action_slot_idx]
action = bpy.data.actions.new(name="Action")
action_slot.action = action
return {'FINISHED'}
# noinspection PyPep8Naming
class RIGIFY_OT_jump_to_action_slot(Operator):
"""Set Active Action Slot Index"""
bl_idname = "object.rigify_jump_to_action_slot"
bl_label = "Jump to Action Slot"
bl_options = {'REGISTER', 'UNDO', 'INTERNAL'}
to_index: IntProperty()
def execute(self, context):
armature_id_store = context.object.data
armature_id_store.rigify_active_action_slot = self.to_index
return {'FINISHED'}
# =============================================
# UI Panel
# noinspection PyPep8Naming
class RIGIFY_UL_action_slots(UIList):
def draw_item(self, context: Context, layout: UILayout, data: Armature,
action_slot: ActionSlot, icon, active_data, active_propname: str,
slot_index: int = 0, flt_flag: int = 0):
action_slots, action_slot_idx = get_action_slots_active(data)
active_action = action_slots[action_slot_idx]
if self.layout_type in {'DEFAULT', 'COMPACT'}:
if action_slot.action:
row = layout.row()
icon = 'ACTION'
# Check if this action is a trigger for the active corrective action
if active_action.is_corrective and \
action_slot.action in [active_action.trigger_action_a,
active_action.trigger_action_b]:
icon = 'RESTRICT_INSTANCED_OFF'
# Check if the active action is a trigger for this corrective action.
if action_slot.is_corrective and \
active_action.action in [action_slot.trigger_action_a,
action_slot.trigger_action_b]:
icon = 'RESTRICT_INSTANCED_OFF'
row.prop(action_slot.action, 'name', text="", emboss=False, icon=icon)
# Highlight various errors
if find_duplicate_slot(data, action_slot):
# Multiple entries for the same action
row.alert = True
row.label(text="Duplicate", icon='ERROR')
elif action_slot.is_corrective:
text = "Corrective"
icon = 'RESTRICT_INSTANCED_OFF'
for trigger in [action_slot.trigger_action_a,
action_slot.trigger_action_b]:
trigger_slot, trigger_idx = find_slot_by_action(data, trigger)
# No trigger action set, no slot or invalid slot
if not trigger_slot or trigger_slot.is_corrective:
row.alert = True
text = "No Trigger Action"
icon = 'ERROR'
break
row.label(text=text, icon=icon)
else:
text = action_slot.subtarget
icon = 'BONE_DATA'
target_rig = get_rigify_target_rig(data)
if not action_slot.subtarget:
row.alert = True
text = 'No Control Bone'
icon = 'ERROR'
elif target_rig:
# Check for bones not actually present in the generated rig
bones = target_rig.pose.bones
if action_slot.subtarget not in bones:
row.alert = True
text = 'Bad Control Bone'
icon = 'ERROR'
elif (action_slot.symmetrical
and mirror_name(action_slot.subtarget) not in bones):
row.alert = True
text = 'Bad Control Bone'
icon = 'ERROR'
row.label(text=text, icon=icon)
icon = 'CHECKBOX_HLT' if action_slot.enabled else 'CHECKBOX_DEHLT'
row.enabled = action_slot.enabled
layout.prop(action_slot, 'enabled', text="", icon=icon, emboss=False)
# No action
else:
layout.label(text="", translate=False, icon='ACTION')
elif self.layout_type in {'GRID'}:
layout.alignment = 'CENTER'
layout.label(text="", icon_value=icon)
# noinspection PyPep8Naming
class DATA_PT_rigify_actions(Panel):
bl_space_type = 'PROPERTIES'
bl_region_type = 'WINDOW'
bl_context = 'data'
bl_label = "Actions"
bl_parent_id = "DATA_PT_rigify"
bl_options = {'DEFAULT_CLOSED'}
@classmethod
def poll(cls, context):
return context.object.mode in ('POSE', 'OBJECT') and is_valid_metarig(context)
def draw(self, context: Context):
armature_id_store = context.object.data
assert isinstance(armature_id_store, Armature)
action_slots, active_idx = get_action_slots_active(armature_id_store)
layout = self.layout
layout.use_property_split = True
layout.use_property_decorate = False
draw_ui_list(
layout, context,
class_name='RIGIFY_UL_action_slots',
list_context_path='object.data.rigify_action_slots',
active_index_context_path='object.data.rigify_active_action_slot',
)
if len(action_slots) == 0:
return
active_slot = action_slots[active_idx]
layout.template_ID(active_slot, 'action', new=RIGIFY_OT_action_create.bl_idname)
if not active_slot.action:
return
layout = layout.column()
layout.prop(active_slot, 'is_corrective')
if active_slot.is_corrective:
self.draw_ui_corrective(context, active_slot)
else:
target_rig = get_rigify_target_rig(armature_id_store)
self.draw_slot_ui(layout, active_slot, target_rig)
self.draw_status(active_slot)
def draw_ui_corrective(self, context: Context, slot):
layout = self.layout
layout.prop(slot, 'frame_start', text="Frame Start")
layout.prop(slot, 'frame_end', text="End")
layout.separator()
for trigger_prop in ['trigger_action_a', 'trigger_action_b']:
self.draw_ui_trigger(context, slot, trigger_prop)
def draw_ui_trigger(self, context: Context, slot, trigger_prop: str):
layout = self.layout
metarig = context.object
assert isinstance(metarig.data, Armature)
trigger = getattr(slot, trigger_prop)
icon = 'ACTION' if trigger else 'ERROR'
row = layout.row()
row.prop(slot, trigger_prop, icon=icon)
if not trigger:
return
trigger_slot, slot_index = find_slot_by_action(metarig.data, trigger)
if not trigger_slot:
row = layout.split(factor=0.4)
row.separator()
row.alert = True
row.label(text="Action not in list", icon='ERROR')
return
show_prop_name = 'show_action_' + trigger_prop[-1]
show = getattr(slot, show_prop_name)
icon = 'HIDE_OFF' if show else 'HIDE_ON'
row.prop(slot, show_prop_name, icon=icon, text="")
op = row.operator(RIGIFY_OT_jump_to_action_slot.bl_idname, text="", icon='LOOP_FORWARDS')
op.to_index = slot_index
if show:
col = layout.column(align=True)
col.enabled = False
target_rig = get_rigify_target_rig(metarig.data)
self.draw_slot_ui(col, trigger_slot, target_rig)
col.separator()
@staticmethod
def draw_slot_ui(layout, slot, target_rig):
if not target_rig:
row = layout.row()
row.alert = True
row.label(text="Cannot verify bone name without a generated rig", icon='ERROR')
row = layout.row()
bone_icon = 'BONE_DATA' if slot.subtarget else 'ERROR'
if target_rig:
subtarget_exists = slot.subtarget in target_rig.pose.bones
row.prop_search(slot, 'subtarget', target_rig.pose, 'bones', icon=bone_icon)
row.alert = not subtarget_exists
if slot.subtarget and not subtarget_exists:
row = layout.split(factor=0.4)
row.column()
row.alert = True
text = rpt_("Bone not found: {:s}").format(slot.subtarget)
row.label(text=text, translate=False, icon='ERROR')
else:
row.prop(slot, 'subtarget', icon=bone_icon)
flipped_subtarget = mirror_name(slot.subtarget)
if flipped_subtarget != slot.subtarget:
flipped_subtarget_exists = not target_rig or flipped_subtarget in target_rig.pose.bones
row = layout.row()
row.use_property_split = True
text = iface_("Symmetrical ({:s})").format(flipped_subtarget)
row.prop(slot, 'symmetrical', text=text, translate=False)
if slot.symmetrical and not flipped_subtarget_exists:
row.alert = True
row = layout.split(factor=0.4)
row.column()
row.alert = True
text = rpt_("Bone not found: {:s}").format(flipped_subtarget)
row.label(text=text, icon='ERROR', translate=False)
layout.prop(slot, 'frame_start', text="Frame Start")
layout.prop(slot, 'frame_end', text="End")
layout.prop(slot, 'target_space', text="Target Space")
layout.prop(slot, 'transform_channel', text="Transform Channel")
layout.prop(slot, 'trans_min')
layout.prop(slot, 'trans_max')
def draw_status(self, slot):
"""
There are a lot of ways to create incorrect Action setups, so give
the user a warning in those cases.
"""
layout = self.layout
split = layout.split(factor=0.4)
heading = split.row()
heading.alignment = 'RIGHT'
heading.label(text="Status:")
if slot.trans_min == slot.trans_max:
col = split.column(align=True)
col.alert = True
text = rpt_("Min and max values are the same!")
col.label(text=text, translate=False)
text = rpt_("Will be stuck reading frame {:d}!").format(slot.frame_start)
col.label(text=text, translate=False)
return
if slot.frame_start == slot.frame_end:
col = split.column(align=True)
col.alert = True
text = rpt_("Start and end frame cannot be the same!")
col.label(text=text, translate=False)
default_frame = slot.get_default_frame()
if slot.is_default_frame_integer():
text = rpt_("Default Frame: {:.0f}").format(default_frame)
split.label(text=text, translate=False)
else:
split.alert = True
text = rpt_("Default Frame: {:.02f} (Should be a whole number!)").format(default_frame)
split.label(text=text, translate=False)
# =============================================
# Registration
classes = (
ActionSlot,
RIGIFY_OT_action_create,
RIGIFY_OT_jump_to_action_slot,
RIGIFY_UL_action_slots,
DATA_PT_rigify_actions,
)
def register():
from bpy.utils import register_class
for cls in classes:
register_class(cls)
bpy.types.Armature.rigify_action_slots = CollectionProperty(type=ActionSlot)
bpy.types.Armature.rigify_active_action_slot = IntProperty(min=0, default=0)
def unregister():
from bpy.utils import unregister_class
for cls in classes:
unregister_class(cls)
arm_data: Any = bpy.types.Armature
del arm_data.rigify_action_slots
del arm_data.rigify_active_action_slot
|