-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathrig_ui_addendum.txt
1168 lines (952 loc) · 43.6 KB
/
rig_ui_addendum.txt
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Currently, there is no way to pass extra visibility layers to
# Rigify for the muscle layers. The visibility layers is used to
# display the different bone layers in the N-Panel.
# To get around that, add the below lines at the end of:
# class RigLayers(bpy.types.Panel):
# def draw(self, context):
# these will add the extra buttons to switch between the layers
# Step by Step Instructions
# 1. Goto the "Scripting" workspace
# 2. Select the 'rig_ui.py' script from the internal buffer
# 3. Find "class RigLayers(bpy.types.Panel):"
# 4. Got to the end of the draw method of the class
# 4a. def draw(self, context):
# 5. Copy, Paste and uncomment the below code block at the end of the function
# NOTE: this is python code indentation matters
# row = col.row()
# row.separator()
# row = col.row()
# row.separator()
# row = col.row()
# row.prop(context.active_object.data, 'layers', index=19, toggle=True, text='Muscle Arm.L')
# row.prop(context.active_object.data, 'layers', index=20, toggle=True, text='Muscle Arm.R')
# row = col.row()
# row.prop(context.active_object.data, 'layers', index=21, toggle=True, text='Muscle Leg.L')
# row.prop(context.active_object.data, 'layers', index=22, toggle=True, text='Muscle Leg.R')
# row = col.row()
# row.prop(context.active_object.data, 'layers', index=23, toggle=True, text='Muscle Torso')
# row.prop(context.active_object.data, 'layers', index=24, toggle=True, text='Muscle Neck')
# below is the entire modified script for context
import bpy
from bpy.props import StringProperty
import math
from math import pi
from mathutils import Euler, Matrix, Quaternion, Vector
rig_id = "fpsf61y05a43c2d5"
############################
## Math utility functions ##
############################
def perpendicular_vector(v):
""" Returns a vector that is perpendicular to the one given.
The returned vector is _not_ guaranteed to be normalized.
"""
# Create a vector that is not aligned with v.
# It doesn't matter what vector. Just any vector
# that's guaranteed to not be pointing in the same
# direction.
if abs(v[0]) < abs(v[1]):
tv = Vector((1,0,0))
else:
tv = Vector((0,1,0))
# Use cross prouct to generate a vector perpendicular to
# both tv and (more importantly) v.
return v.cross(tv)
def rotation_difference(mat1, mat2):
""" Returns the shortest-path rotational difference between two
matrices.
"""
q1 = mat1.to_quaternion()
q2 = mat2.to_quaternion()
angle = math.acos(min(1,max(-1,q1.dot(q2)))) * 2
if angle > pi:
angle = -angle + (2*pi)
return angle
def tail_distance(angle,bone_ik,bone_fk):
""" Returns the distance between the tails of two bones
after rotating bone_ik in AXIS_ANGLE mode.
"""
rot_mod=bone_ik.rotation_mode
if rot_mod != 'AXIS_ANGLE':
bone_ik.rotation_mode = 'AXIS_ANGLE'
bone_ik.rotation_axis_angle[0] = angle
bpy.context.view_layer.update()
dv = (bone_fk.tail - bone_ik.tail).length
bone_ik.rotation_mode = rot_mod
return dv
def find_min_range(bone_ik,bone_fk,f=tail_distance,delta=pi/8):
""" finds the range where lies the minimum of function f applied on bone_ik and bone_fk
at a certain angle.
"""
rot_mod=bone_ik.rotation_mode
if rot_mod != 'AXIS_ANGLE':
bone_ik.rotation_mode = 'AXIS_ANGLE'
start_angle = bone_ik.rotation_axis_angle[0]
angle = start_angle
while (angle > (start_angle - 2*pi)) and (angle < (start_angle + 2*pi)):
l_dist = f(angle-delta,bone_ik,bone_fk)
c_dist = f(angle,bone_ik,bone_fk)
r_dist = f(angle+delta,bone_ik,bone_fk)
if min((l_dist,c_dist,r_dist)) == c_dist:
bone_ik.rotation_mode = rot_mod
return (angle-delta,angle+delta)
else:
angle=angle+delta
def ternarySearch(f, left, right, bone_ik, bone_fk, absolutePrecision):
"""
Find minimum of unimodal function f() within [left, right]
To find the maximum, revert the if/else statement or revert the comparison.
"""
while True:
#left and right are the current bounds; the maximum is between them
if abs(right - left) < absolutePrecision:
return (left + right)/2
leftThird = left + (right - left)/3
rightThird = right - (right - left)/3
if f(leftThird, bone_ik, bone_fk) > f(rightThird, bone_ik, bone_fk):
left = leftThird
else:
right = rightThird
#########################################
## "Visual Transform" helper functions ##
#########################################
def get_pose_matrix_in_other_space(mat, pose_bone):
""" Returns the transform matrix relative to pose_bone's current
transform space. In other words, presuming that mat is in
armature space, slapping the returned matrix onto pose_bone
should give it the armature-space transforms of mat.
TODO: try to handle cases with axis-scaled parents better.
"""
rest = pose_bone.bone.matrix_local.copy()
rest_inv = rest.inverted()
if pose_bone.parent:
par_mat = pose_bone.parent.matrix.copy()
par_inv = par_mat.inverted()
par_rest = pose_bone.parent.bone.matrix_local.copy()
else:
par_mat = Matrix()
par_inv = Matrix()
par_rest = Matrix()
# Get matrix in bone's current transform space
smat = rest_inv @ (par_rest @ (par_inv @ mat))
# Compensate for non-local location
#if not pose_bone.bone.use_local_location:
# loc = smat.to_translation() @ (par_rest.inverted() @ rest).to_quaternion()
# smat.translation = loc
return smat
def get_local_pose_matrix(pose_bone):
""" Returns the local transform matrix of the given pose bone.
"""
return get_pose_matrix_in_other_space(pose_bone.matrix, pose_bone)
def set_pose_translation(pose_bone, mat):
""" Sets the pose bone's translation to the same translation as the given matrix.
Matrix should be given in bone's local space.
"""
if pose_bone.bone.use_local_location == True:
pose_bone.location = mat.to_translation()
else:
loc = mat.to_translation()
rest = pose_bone.bone.matrix_local.copy()
if pose_bone.bone.parent:
par_rest = pose_bone.bone.parent.matrix_local.copy()
else:
par_rest = Matrix()
q = (par_rest.inverted() @ rest).to_quaternion()
pose_bone.location = q @ loc
def set_pose_rotation(pose_bone, mat):
""" Sets the pose bone's rotation to the same rotation as the given matrix.
Matrix should be given in bone's local space.
"""
q = mat.to_quaternion()
if pose_bone.rotation_mode == 'QUATERNION':
pose_bone.rotation_quaternion = q
elif pose_bone.rotation_mode == 'AXIS_ANGLE':
pose_bone.rotation_axis_angle[0] = q.angle
pose_bone.rotation_axis_angle[1] = q.axis[0]
pose_bone.rotation_axis_angle[2] = q.axis[1]
pose_bone.rotation_axis_angle[3] = q.axis[2]
else:
pose_bone.rotation_euler = q.to_euler(pose_bone.rotation_mode)
def set_pose_scale(pose_bone, mat):
""" Sets the pose bone's scale to the same scale as the given matrix.
Matrix should be given in bone's local space.
"""
pose_bone.scale = mat.to_scale()
def match_pose_translation(pose_bone, target_bone):
""" Matches pose_bone's visual translation to target_bone's visual
translation.
This function assumes you are in pose mode on the relevant armature.
"""
mat = get_pose_matrix_in_other_space(target_bone.matrix, pose_bone)
set_pose_translation(pose_bone, mat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
def match_pose_rotation(pose_bone, target_bone):
""" Matches pose_bone's visual rotation to target_bone's visual
rotation.
This function assumes you are in pose mode on the relevant armature.
"""
mat = get_pose_matrix_in_other_space(target_bone.matrix, pose_bone)
set_pose_rotation(pose_bone, mat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
def match_pose_scale(pose_bone, target_bone):
""" Matches pose_bone's visual scale to target_bone's visual
scale.
This function assumes you are in pose mode on the relevant armature.
"""
mat = get_pose_matrix_in_other_space(target_bone.matrix, pose_bone)
set_pose_scale(pose_bone, mat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
def correct_rotation(bone_ik, bone_fk):
""" Corrects the ik rotation in ik2fk snapping functions
"""
alfarange = find_min_range(bone_ik,bone_fk)
alfamin = ternarySearch(tail_distance,alfarange[0],alfarange[1],bone_ik,bone_fk,0.1)
rot_mod = bone_ik.rotation_mode
if rot_mod != 'AXIS_ANGLE':
bone_ik.rotation_mode = 'AXIS_ANGLE'
bone_ik.rotation_axis_angle[0] = alfamin
bone_ik.rotation_mode = rot_mod
##############################
## IK/FK snapping functions ##
##############################
def match_pole_target(ik_first, ik_last, pole, match_bone, length):
""" Places an IK chain's pole target to match ik_first's
transforms to match_bone. All bones should be given as pose bones.
You need to be in pose mode on the relevant armature object.
ik_first: first bone in the IK chain
ik_last: last bone in the IK chain
pole: pole target bone for the IK chain
match_bone: bone to match ik_first to (probably first bone in a matching FK chain)
length: distance pole target should be placed from the chain center
"""
a = ik_first.matrix.to_translation()
b = ik_last.matrix.to_translation() + ik_last.vector
# Vector from the head of ik_first to the
# tip of ik_last
ikv = b - a
# Get a vector perpendicular to ikv
pv = perpendicular_vector(ikv).normalized() * length
def set_pole(pvi):
""" Set pole target's position based on a vector
from the arm center line.
"""
# Translate pvi into armature space
ploc = a + (ikv/2) + pvi
# Set pole target to location
mat = get_pose_matrix_in_other_space(Matrix.Translation(ploc), pole)
set_pose_translation(pole, mat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
set_pole(pv)
# Get the rotation difference between ik_first and match_bone
angle = rotation_difference(ik_first.matrix, match_bone.matrix)
# Try compensating for the rotation difference in both directions
pv1 = Matrix.Rotation(angle, 4, ikv) @ pv
set_pole(pv1)
ang1 = rotation_difference(ik_first.matrix, match_bone.matrix)
pv2 = Matrix.Rotation(-angle, 4, ikv) @ pv
set_pole(pv2)
ang2 = rotation_difference(ik_first.matrix, match_bone.matrix)
# Do the one with the smaller angle
if ang1 < ang2:
set_pole(pv1)
##########
## Misc ##
##########
def parse_bone_names(names_string):
if names_string[0] == '[' and names_string[-1] == ']':
return eval(names_string)
else:
return names_string
######################
## IK Arm functions ##
######################
def fk2ik_arm(obj, fk, ik):
""" Matches the fk bones in an arm rig to the ik bones.
obj: armature object
fk: list of fk bone names
ik: list of ik bone names
"""
uarm = obj.pose.bones[fk[0]]
farm = obj.pose.bones[fk[1]]
hand = obj.pose.bones[fk[2]]
uarmi = obj.pose.bones[ik[0]]
farmi = obj.pose.bones[ik[1]]
handi = obj.pose.bones[ik[2]]
if 'auto_stretch' in handi.keys():
# This is kept for compatibility with legacy rigify Human
# Stretch
if handi['auto_stretch'] == 0.0:
uarm['stretch_length'] = handi['stretch_length']
else:
diff = (uarmi.vector.length + farmi.vector.length) / (uarm.vector.length + farm.vector.length)
uarm['stretch_length'] *= diff
# Upper arm position
match_pose_rotation(uarm, uarmi)
match_pose_scale(uarm, uarmi)
# Forearm position
match_pose_rotation(farm, farmi)
match_pose_scale(farm, farmi)
# Hand position
match_pose_rotation(hand, handi)
match_pose_scale(hand, handi)
else:
# Upper arm position
match_pose_translation(uarm, uarmi)
match_pose_rotation(uarm, uarmi)
match_pose_scale(uarm, uarmi)
# Forearm position
#match_pose_translation(hand, handi)
match_pose_rotation(farm, farmi)
match_pose_scale(farm, farmi)
# Hand position
match_pose_translation(hand, handi)
match_pose_rotation(hand, handi)
match_pose_scale(hand, handi)
def ik2fk_arm(obj, fk, ik):
""" Matches the ik bones in an arm rig to the fk bones.
obj: armature object
fk: list of fk bone names
ik: list of ik bone names
"""
uarm = obj.pose.bones[fk[0]]
farm = obj.pose.bones[fk[1]]
hand = obj.pose.bones[fk[2]]
uarmi = obj.pose.bones[ik[0]]
farmi = obj.pose.bones[ik[1]]
handi = obj.pose.bones[ik[2]]
main_parent = obj.pose.bones[ik[4]]
if ik[3] != "" and main_parent['pole_vector']:
pole = obj.pose.bones[ik[3]]
else:
pole = None
if pole:
# Stretch
# handi['stretch_length'] = uarm['stretch_length']
# Hand position
match_pose_translation(handi, hand)
match_pose_rotation(handi, hand)
match_pose_scale(handi, hand)
# Pole target position
match_pole_target(uarmi, farmi, pole, uarm, (uarmi.length + farmi.length))
else:
# Hand position
match_pose_translation(handi, hand)
match_pose_rotation(handi, hand)
match_pose_scale(handi, hand)
# Upper Arm position
match_pose_translation(uarmi, uarm)
match_pose_rotation(uarmi, uarm)
match_pose_scale(uarmi, uarm)
# Rotation Correction
correct_rotation(uarmi, uarm)
######################
## IK Leg functions ##
######################
def fk2ik_leg(obj, fk, ik):
""" Matches the fk bones in a leg rig to the ik bones.
obj: armature object
fk: list of fk bone names
ik: list of ik bone names
"""
thigh = obj.pose.bones[fk[0]]
shin = obj.pose.bones[fk[1]]
foot = obj.pose.bones[fk[2]]
mfoot = obj.pose.bones[fk[3]]
thighi = obj.pose.bones[ik[0]]
shini = obj.pose.bones[ik[1]]
footi = obj.pose.bones[ik[2]]
mfooti = obj.pose.bones[ik[3]]
if 'auto_stretch' in footi.keys():
# This is kept for compatibility with legacy rigify Human
# Stretch
if footi['auto_stretch'] == 0.0:
thigh['stretch_length'] = footi['stretch_length']
else:
diff = (thighi.vector.length + shini.vector.length) / (thigh.vector.length + shin.vector.length)
thigh['stretch_length'] *= diff
# Thigh position
match_pose_rotation(thigh, thighi)
match_pose_scale(thigh, thighi)
# Shin position
match_pose_rotation(shin, shini)
match_pose_scale(shin, shini)
# Foot position
mat = mfoot.bone.matrix_local.inverted() @ foot.bone.matrix_local
footmat = get_pose_matrix_in_other_space(mfooti.matrix, foot) @ mat
set_pose_rotation(foot, footmat)
set_pose_scale(foot, footmat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
else:
# Thigh position
match_pose_translation(thigh, thighi)
match_pose_rotation(thigh, thighi)
match_pose_scale(thigh, thighi)
# Shin position
match_pose_rotation(shin, shini)
match_pose_scale(shin, shini)
# Foot position
mat = mfoot.bone.matrix_local.inverted() @ foot.bone.matrix_local
footmat = get_pose_matrix_in_other_space(mfooti.matrix, foot) @ mat
set_pose_rotation(foot, footmat)
set_pose_scale(foot, footmat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
def ik2fk_leg(obj, fk, ik):
""" Matches the ik bones in a leg rig to the fk bones.
obj: armature object
fk: list of fk bone names
ik: list of ik bone names
"""
thigh = obj.pose.bones[fk[0]]
shin = obj.pose.bones[fk[1]]
mfoot = obj.pose.bones[fk[2]]
if fk[3] != "":
foot = obj.pose.bones[fk[3]]
else:
foot = None
thighi = obj.pose.bones[ik[0]]
shini = obj.pose.bones[ik[1]]
footi = obj.pose.bones[ik[2]]
footroll = obj.pose.bones[ik[3]]
main_parent = obj.pose.bones[ik[6]]
if ik[4] != "" and main_parent['pole_vector']:
pole = obj.pose.bones[ik[4]]
else:
pole = None
mfooti = obj.pose.bones[ik[5]]
if (not pole) and (foot):
# Clear footroll
set_pose_rotation(footroll, Matrix())
# Foot position
mat = mfooti.bone.matrix_local.inverted() @ footi.bone.matrix_local
footmat = get_pose_matrix_in_other_space(foot.matrix, footi) @ mat
set_pose_translation(footi, footmat)
set_pose_rotation(footi, footmat)
set_pose_scale(footi, footmat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
# Thigh position
match_pose_translation(thighi, thigh)
match_pose_rotation(thighi, thigh)
match_pose_scale(thighi, thigh)
# Rotation Correction
correct_rotation(thighi,thigh)
else:
# Stretch
if 'stretch_lenght' in footi.keys() and 'stretch_lenght' in thigh.keys():
# Kept for compat with legacy rigify Human
footi['stretch_length'] = thigh['stretch_length']
# Clear footroll
set_pose_rotation(footroll, Matrix())
# Foot position
mat = mfooti.bone.matrix_local.inverted() @ footi.bone.matrix_local
footmat = get_pose_matrix_in_other_space(mfoot.matrix, footi) @ mat
set_pose_translation(footi, footmat)
set_pose_rotation(footi, footmat)
set_pose_scale(footi, footmat)
bpy.ops.object.mode_set(mode='OBJECT')
bpy.ops.object.mode_set(mode='POSE')
# Pole target position
match_pole_target(thighi, shini, pole, thigh, (thighi.length + shini.length))
##################################
## IK/FK Arm snapping operators ##
##################################
class Rigify_Arm_FK2IK(bpy.types.Operator):
""" Snaps an FK arm to an IK arm.
"""
bl_idname = "pose.rigify_arm_fk2ik_" + rig_id
bl_label = "Rigify Snap FK arm to IK"
bl_options = {'UNDO', 'INTERNAL'}
uarm_fk: StringProperty(name="Upper Arm FK Name")
farm_fk: StringProperty(name="Forerm FK Name")
hand_fk: StringProperty(name="Hand FK Name")
uarm_ik: StringProperty(name="Upper Arm IK Name")
farm_ik: StringProperty(name="Forearm IK Name")
hand_ik: StringProperty(name="Hand IK Name")
@classmethod
def poll(cls, context):
return (context.active_object != None and context.mode == 'POSE')
def execute(self, context):
fk2ik_arm(context.active_object, fk=[self.uarm_fk, self.farm_fk, self.hand_fk], ik=[self.uarm_ik, self.farm_ik, self.hand_ik])
return {'FINISHED'}
class Rigify_Arm_IK2FK(bpy.types.Operator):
""" Snaps an IK arm to an FK arm.
"""
bl_idname = "pose.rigify_arm_ik2fk_" + rig_id
bl_label = "Rigify Snap IK arm to FK"
bl_options = {'UNDO', 'INTERNAL'}
uarm_fk: StringProperty(name="Upper Arm FK Name")
farm_fk: StringProperty(name="Forerm FK Name")
hand_fk: StringProperty(name="Hand FK Name")
uarm_ik: StringProperty(name="Upper Arm IK Name")
farm_ik: StringProperty(name="Forearm IK Name")
hand_ik: StringProperty(name="Hand IK Name")
pole : StringProperty(name="Pole IK Name")
main_parent: StringProperty(name="Main Parent", default="")
@classmethod
def poll(cls, context):
return (context.active_object != None and context.mode == 'POSE')
def execute(self, context):
ik2fk_arm(context.active_object, fk=[self.uarm_fk, self.farm_fk, self.hand_fk], ik=[self.uarm_ik, self.farm_ik, self.hand_ik, self.pole, self.main_parent])
return {'FINISHED'}
##################################
## IK/FK Leg snapping operators ##
##################################
class Rigify_Leg_FK2IK(bpy.types.Operator):
""" Snaps an FK leg to an IK leg.
"""
bl_idname = "pose.rigify_leg_fk2ik_" + rig_id
bl_label = "Rigify Snap FK leg to IK"
bl_options = {'UNDO', 'INTERNAL'}
thigh_fk: StringProperty(name="Thigh FK Name")
shin_fk: StringProperty(name="Shin FK Name")
foot_fk: StringProperty(name="Foot FK Name")
mfoot_fk: StringProperty(name="MFoot FK Name")
thigh_ik: StringProperty(name="Thigh IK Name")
shin_ik: StringProperty(name="Shin IK Name")
foot_ik: StringProperty(name="Foot IK Name")
mfoot_ik: StringProperty(name="MFoot IK Name")
@classmethod
def poll(cls, context):
return (context.active_object != None and context.mode == 'POSE')
def execute(self, context):
fk2ik_leg(context.active_object, fk=[self.thigh_fk, self.shin_fk, self.foot_fk, self.mfoot_fk], ik=[self.thigh_ik, self.shin_ik, self.foot_ik, self.mfoot_ik])
return {'FINISHED'}
class Rigify_Leg_IK2FK(bpy.types.Operator):
""" Snaps an IK leg to an FK leg.
"""
bl_idname = "pose.rigify_leg_ik2fk_" + rig_id
bl_label = "Rigify Snap IK leg to FK"
bl_options = {'UNDO', 'INTERNAL'}
thigh_fk: StringProperty(name="Thigh FK Name")
shin_fk: StringProperty(name="Shin FK Name")
mfoot_fk: StringProperty(name="MFoot FK Name")
foot_fk: StringProperty(name="Foot FK Name", default="")
thigh_ik: StringProperty(name="Thigh IK Name")
shin_ik: StringProperty(name="Shin IK Name")
foot_ik: StringProperty(name="Foot IK Name")
footroll: StringProperty(name="Foot Roll Name")
pole: StringProperty(name="Pole IK Name")
mfoot_ik: StringProperty(name="MFoot IK Name")
main_parent: StringProperty(name="Main Parent", default="")
@classmethod
def poll(cls, context):
return (context.active_object != None and context.mode == 'POSE')
def execute(self, context):
ik2fk_leg(context.active_object, fk=[self.thigh_fk, self.shin_fk, self.mfoot_fk, self.foot_fk], ik=[self.thigh_ik, self.shin_ik, self.foot_ik, self.footroll, self.pole, self.mfoot_ik, self.main_parent])
return {'FINISHED'}
################################
## IK Rotation-Pole functions ##
################################
def rotPoleToggle(rig, limb_type, controls, ik_ctrl, fk_ctrl, parent, pole):
rig_id = rig.data['rig_id']
leg_fk2ik = eval('bpy.ops.pose.rigify_leg_fk2ik_' + rig_id)
arm_fk2ik = eval('bpy.ops.pose.rigify_arm_fk2ik_' + rig_id)
leg_ik2fk = eval('bpy.ops.pose.rigify_leg_ik2fk_' + rig_id)
arm_ik2fk = eval('bpy.ops.pose.rigify_arm_ik2fk_' + rig_id)
controls = parse_bone_names(controls)
ik_ctrl = parse_bone_names(ik_ctrl)
fk_ctrl = parse_bone_names(fk_ctrl)
parent = parse_bone_names(parent)
pole = parse_bone_names(pole)
pbones = bpy.context.selected_pose_bones
bpy.ops.pose.select_all(action='DESELECT')
for b in pbones:
new_pole_vector_value = not rig.pose.bones[parent]['pole_vector']
if b.name in controls or b.name in ik_ctrl:
if limb_type == 'arm':
func1 = arm_fk2ik
func2 = arm_ik2fk
rig.pose.bones[controls[0]].bone.select = not new_pole_vector_value
rig.pose.bones[controls[4]].bone.select = not new_pole_vector_value
rig.pose.bones[parent].bone.select = not new_pole_vector_value
rig.pose.bones[pole].bone.select = new_pole_vector_value
kwargs1 = {'uarm_fk': controls[1], 'farm_fk': controls[2], 'hand_fk': controls[3],
'uarm_ik': controls[0], 'farm_ik': ik_ctrl[1],
'hand_ik': controls[4]}
kwargs2 = {'uarm_fk': controls[1], 'farm_fk': controls[2], 'hand_fk': controls[3],
'uarm_ik': controls[0], 'farm_ik': ik_ctrl[1], 'hand_ik': controls[4],
'pole': pole, 'main_parent': parent}
else:
func1 = leg_fk2ik
func2 = leg_ik2fk
rig.pose.bones[controls[0]].bone.select = not new_pole_vector_value
rig.pose.bones[controls[6]].bone.select = not new_pole_vector_value
rig.pose.bones[controls[5]].bone.select = not new_pole_vector_value
rig.pose.bones[parent].bone.select = not new_pole_vector_value
rig.pose.bones[pole].bone.select = new_pole_vector_value
kwargs1 = {'thigh_fk': controls[1], 'shin_fk': controls[2], 'foot_fk': controls[3],
'mfoot_fk': controls[7], 'thigh_ik': controls[0], 'shin_ik': ik_ctrl[1],
'foot_ik': ik_ctrl[2], 'mfoot_ik': ik_ctrl[2]}
kwargs2 = {'thigh_fk': controls[1], 'shin_fk': controls[2], 'foot_fk': controls[3],
'mfoot_fk': controls[7], 'thigh_ik': controls[0], 'shin_ik': ik_ctrl[1],
'foot_ik': controls[6], 'pole': pole, 'footroll': controls[5], 'mfoot_ik': ik_ctrl[2],
'main_parent': parent}
func1(**kwargs1)
rig.pose.bones[parent]['pole_vector'] = new_pole_vector_value
func2(**kwargs2)
bpy.ops.pose.select_all(action='DESELECT')
###########################
## IK Rotation Pole Snap ##
###########################
class Rigify_Rot2PoleSwitch(bpy.types.Operator):
bl_idname = "pose.rigify_rot2pole_" + rig_id
bl_label = "Rotation - Pole toggle"
bl_description = "Toggles IK chain between rotation and pole target"
bone_name: StringProperty(default='')
limb_type: StringProperty(name="Limb Type")
controls: StringProperty(name="Controls string")
ik_ctrl: StringProperty(name="IK Controls string")
fk_ctrl: StringProperty(name="FK Controls string")
parent: StringProperty(name="Parent name")
pole: StringProperty(name="Pole name")
def execute(self, context):
rig = context.object
if self.bone_name:
bpy.ops.pose.select_all(action='DESELECT')
rig.pose.bones[self.bone_name].bone.select = True
rotPoleToggle(rig, self.limb_type, self.controls, self.ik_ctrl, self.fk_ctrl, self.parent, self.pole)
return {'FINISHED'}
###################
## Rig UI Panels ##
###################
class RigUI(bpy.types.Panel):
bl_space_type = 'VIEW_3D'
bl_region_type = 'UI'
bl_label = "Rig Main Properties"
bl_idname = "VIEW3D_PT_rig_ui_" + rig_id
bl_category = 'Item'
@classmethod
def poll(self, context):
if context.mode != 'POSE':
return False
try:
return (context.active_object.data.get("rig_id") == rig_id)
except (AttributeError, KeyError, TypeError):
return False
def draw(self, context):
layout = self.layout
pose_bones = context.active_object.pose.bones
try:
selected_bones = [bone.name for bone in context.selected_pose_bones]
selected_bones += [context.active_pose_bone.name]
except (AttributeError, TypeError):
return
def is_selected(names):
# Returns whether any of the named bones are selected.
if type(names) == list:
for name in names:
if name in selected_bones:
return True
elif names in selected_bones:
return True
return False
controls = ['head', 'neck', 'chest', 'hips', 'torso']
torso = 'torso'
if is_selected( controls ):
if hasattr(pose_bones[torso],'["head_follow"]'):
layout.prop( pose_bones[ torso ], '["head_follow"]', slider = True )
if hasattr(pose_bones[torso],'["neck_follow"]'):
layout.prop( pose_bones[ torso ], '["neck_follow"]', slider = True )
if hasattr(pose_bones[torso],'["tail_follow"]'):
layout.prop( pose_bones[ torso ], '["tail_follow"]', slider = True )
controls = ['thigh_L_ik', 'thigh_L_fk', 'calf_L_fk', 'foot_L_fk', 'toes_L', 'foot_L_heel_ik', 'foot_L_ik', 'MCH-foot_L_fk', 'thigh_L_parent']
tweaks = ['calf_L_tweak']
ik_ctrl = ['foot_L_ik', 'MCH-thigh_L_ik', 'MCH-thigh_L_ik_target']
fk_ctrl = 'thigh_L_fk'
parent = 'thigh_L_parent'
foot_fk = 'foot_L_fk'
pole = 'thigh_L_ik_target'
# IK/FK Switch on all Control Bones
if is_selected( controls ):
layout.prop( pose_bones[parent], '["IK_FK"]', slider = True )
props = layout.operator("pose.rigify_leg_fk2ik_" + rig_id, text="Snap FK->IK (" + fk_ctrl + ")")
props.thigh_fk = controls[1]
props.shin_fk = controls[2]
props.foot_fk = controls[3]
props.mfoot_fk = controls[7]
props.thigh_ik = controls[0]
props.shin_ik = ik_ctrl[1]
props.foot_ik = ik_ctrl[2]
props.mfoot_ik = ik_ctrl[2]
props = layout.operator("pose.rigify_leg_ik2fk_" + rig_id, text="Snap IK->FK (" + fk_ctrl + ")")
props.thigh_fk = controls[1]
props.shin_fk = controls[2]
props.foot_fk = controls[3]
props.mfoot_fk = controls[7]
props.thigh_ik = controls[0]
props.shin_ik = ik_ctrl[1]
props.foot_ik = controls[6]
props.pole = pole
props.footroll = controls[5]
props.mfoot_ik = ik_ctrl[2]
props.main_parent = parent
props = layout.operator("pose.rigify_rot2pole_" + rig_id, text="Toggle Rotation and Pole")
props.bone_name = controls[1]
props.limb_type = "leg"
props.controls = str(controls)
props.ik_ctrl = str(ik_ctrl)
props.fk_ctrl = str(fk_ctrl)
props.parent = str(parent)
props.pole = str(pole)
# BBone rubber hose on each Respective Tweak
for t in tweaks:
if is_selected( t ):
layout.prop( pose_bones[ t ], '["rubber_tweak"]', slider = True )
# IK Stretch and pole_vector on IK Control bone
if is_selected( ik_ctrl ) or is_selected(parent):
layout.prop( pose_bones[ parent ], '["IK_Stretch"]', slider = True )
layout.prop( pose_bones[ parent ], '["pole_vector"]')
# FK limb follow
if is_selected( fk_ctrl ) or is_selected(parent):
layout.prop( pose_bones[ parent ], '["FK_limb_follow"]', slider = True )
controls = ['thigh_L_ik', 'foot_L_ik', 'foot_L_heel_ik', 'thigh_L_parent']
ctrl = 'thigh_L_parent'
if is_selected( controls ):
layout.prop( pose_bones[ ctrl ], '["IK_follow"]')
if 'pole_follow' in pose_bones[ctrl].keys():
layout.prop( pose_bones[ ctrl ], '["pole_follow"]', slider = True )
if 'root/parent' in pose_bones[ctrl].keys():
layout.prop( pose_bones[ ctrl ], '["root/parent"]', slider = True )
controls = ['thigh_R_ik', 'thigh_R_fk', 'calf_R_fk', 'foot_R_fk', 'toes_R', 'foot_R_heel_ik', 'foot_R_ik', 'MCH-foot_R_fk', 'thigh_R_parent']
tweaks = ['calf_R_tweak']
ik_ctrl = ['foot_R_ik', 'MCH-thigh_R_ik', 'MCH-thigh_R_ik_target']
fk_ctrl = 'thigh_R_fk'
parent = 'thigh_R_parent'
foot_fk = 'foot_R_fk'
pole = 'thigh_R_ik_target'
# IK/FK Switch on all Control Bones
if is_selected( controls ):
layout.prop( pose_bones[parent], '["IK_FK"]', slider = True )
props = layout.operator("pose.rigify_leg_fk2ik_" + rig_id, text="Snap FK->IK (" + fk_ctrl + ")")
props.thigh_fk = controls[1]
props.shin_fk = controls[2]
props.foot_fk = controls[3]
props.mfoot_fk = controls[7]
props.thigh_ik = controls[0]
props.shin_ik = ik_ctrl[1]
props.foot_ik = ik_ctrl[2]
props.mfoot_ik = ik_ctrl[2]
props = layout.operator("pose.rigify_leg_ik2fk_" + rig_id, text="Snap IK->FK (" + fk_ctrl + ")")
props.thigh_fk = controls[1]
props.shin_fk = controls[2]
props.foot_fk = controls[3]
props.mfoot_fk = controls[7]
props.thigh_ik = controls[0]
props.shin_ik = ik_ctrl[1]
props.foot_ik = controls[6]
props.pole = pole
props.footroll = controls[5]
props.mfoot_ik = ik_ctrl[2]
props.main_parent = parent
props = layout.operator("pose.rigify_rot2pole_" + rig_id, text="Toggle Rotation and Pole")
props.bone_name = controls[1]
props.limb_type = "leg"
props.controls = str(controls)
props.ik_ctrl = str(ik_ctrl)
props.fk_ctrl = str(fk_ctrl)
props.parent = str(parent)
props.pole = str(pole)
# BBone rubber hose on each Respective Tweak
for t in tweaks:
if is_selected( t ):
layout.prop( pose_bones[ t ], '["rubber_tweak"]', slider = True )
# IK Stretch and pole_vector on IK Control bone
if is_selected( ik_ctrl ) or is_selected(parent):
layout.prop( pose_bones[ parent ], '["IK_Stretch"]', slider = True )
layout.prop( pose_bones[ parent ], '["pole_vector"]')
# FK limb follow
if is_selected( fk_ctrl ) or is_selected(parent):
layout.prop( pose_bones[ parent ], '["FK_limb_follow"]', slider = True )
controls = ['thigh_R_ik', 'foot_R_ik', 'foot_R_heel_ik', 'thigh_R_parent']
ctrl = 'thigh_R_parent'
if is_selected( controls ):
layout.prop( pose_bones[ ctrl ], '["IK_follow"]')
if 'pole_follow' in pose_bones[ctrl].keys():
layout.prop( pose_bones[ ctrl ], '["pole_follow"]', slider = True )
if 'root/parent' in pose_bones[ctrl].keys():
layout.prop( pose_bones[ ctrl ], '["root/parent"]', slider = True )
controls = ['upperarm_L_ik', 'upperarm_L_fk', 'lowerarm_L_fk', 'hand_L_fk', 'hand_L_ik', 'MCH-hand_L_fk', 'upperarm_L_parent']
tweaks = ['lowerarm_L_tweak']
ik_ctrl = ['hand_L_ik', 'MCH-upperarm_L_ik', 'MCH-upperarm_L_ik_target']
fk_ctrl = 'upperarm_L_fk'
parent = 'upperarm_L_parent'
hand_fk = 'hand_L_fk'
pole = 'upperarm_L_ik_target'
# IK/FK Switch on all Control Bones
if is_selected( controls ):
layout.prop( pose_bones[parent], '["IK_FK"]', slider = True )
props = layout.operator("pose.rigify_arm_fk2ik_" + rig_id, text="Snap FK->IK (" + fk_ctrl + ")")
props.uarm_fk = controls[1]
props.farm_fk = controls[2]
props.hand_fk = controls[3]
props.uarm_ik = controls[0]
props.farm_ik = ik_ctrl[1]
props.hand_ik = controls[4]
props = layout.operator("pose.rigify_arm_ik2fk_" + rig_id, text="Snap IK->FK (" + fk_ctrl + ")")
props.uarm_fk = controls[1]
props.farm_fk = controls[2]
props.hand_fk = controls[3]
props.uarm_ik = controls[0]
props.farm_ik = ik_ctrl[1]
props.hand_ik = controls[4]
props.pole = pole
props.main_parent = parent
props = layout.operator("pose.rigify_rot2pole_" + rig_id, text="Switch Rotation-Pole")
props.bone_name = controls[1]
props.limb_type = "arm"
props.controls = str(controls)
props.ik_ctrl = str(ik_ctrl)
props.fk_ctrl = str(fk_ctrl)
props.parent = str(parent)
props.pole = str(pole)
# BBone rubber hose on each Respective Tweak
for t in tweaks:
if is_selected( t ):
layout.prop( pose_bones[ t ], '["rubber_tweak"]', slider = True )
# IK Stretch and pole_vector on IK Control bone
if is_selected( ik_ctrl ) or is_selected(parent):
layout.prop( pose_bones[ parent ], '["IK_Stretch"]', slider = True )
layout.prop( pose_bones[ parent ], '["pole_vector"]')
# FK limb follow
if is_selected( fk_ctrl ) or is_selected(parent):