60446bf60b66c9dda23a8d273e5225160acfeea9
[blender.git] / source / blender / blenkernel / intern / armature.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <ctype.h>
25 #include <stdlib.h>
26 #include <math.h>
27 #include <string.h>
28 #include <stdio.h>
29 #include <float.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "BLI_math.h"
34 #include "BLI_listbase.h"
35 #include "BLI_string.h"
36 #include "BLI_ghash.h"
37 #include "BLI_task.h"
38 #include "BLI_utildefines.h"
39 #include "BLI_alloca.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_armature_types.h"
43 #include "DNA_constraint_types.h"
44 #include "DNA_gpencil_types.h"
45 #include "DNA_mesh_types.h"
46 #include "DNA_lattice_types.h"
47 #include "DNA_listBase.h"
48 #include "DNA_meshdata_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_object_types.h"
51
52 #include "BKE_animsys.h"
53 #include "BKE_armature.h"
54 #include "BKE_action.h"
55 #include "BKE_anim.h"
56 #include "BKE_constraint.h"
57 #include "BKE_curve.h"
58 #include "BKE_deform.h"
59 #include "BKE_displist.h"
60 #include "BKE_idprop.h"
61 #include "BKE_library.h"
62 #include "BKE_lattice.h"
63 #include "BKE_main.h"
64 #include "BKE_object.h"
65 #include "BKE_scene.h"
66
67 #include "DEG_depsgraph_build.h"
68
69 #include "BIK_api.h"
70
71 #include "atomic_ops.h"
72
73 #include "CLG_log.h"
74
75 static CLG_LogRef LOG = {"bke.armature"};
76
77 /* **************** Generic Functions, data level *************** */
78
79 bArmature *BKE_armature_add(Main *bmain, const char *name)
80 {
81   bArmature *arm;
82
83   arm = BKE_libblock_alloc(bmain, ID_AR, name, 0);
84   arm->deformflag = ARM_DEF_VGROUP | ARM_DEF_ENVELOPE;
85   arm->flag = ARM_COL_CUSTOM; /* custom bone-group colors */
86   arm->layer = 1;
87   return arm;
88 }
89
90 bArmature *BKE_armature_from_object(Object *ob)
91 {
92   if (ob->type == OB_ARMATURE) {
93     return (bArmature *)ob->data;
94   }
95   return NULL;
96 }
97
98 int BKE_armature_bonelist_count(ListBase *lb)
99 {
100   int i = 0;
101   for (Bone *bone = lb->first; bone; bone = bone->next) {
102     i += 1 + BKE_armature_bonelist_count(&bone->childbase);
103   }
104
105   return i;
106 }
107
108 void BKE_armature_bonelist_free(ListBase *lb)
109 {
110   Bone *bone;
111
112   for (bone = lb->first; bone; bone = bone->next) {
113     if (bone->prop) {
114       IDP_FreeProperty(bone->prop);
115       MEM_freeN(bone->prop);
116     }
117     BKE_armature_bonelist_free(&bone->childbase);
118   }
119
120   BLI_freelistN(lb);
121 }
122
123 /** Free (or release) any data used by this armature (does not free the armature itself). */
124 void BKE_armature_free(bArmature *arm)
125 {
126   BKE_animdata_free(&arm->id, false);
127
128   BKE_armature_bonelist_free(&arm->bonebase);
129
130   /* free editmode data */
131   if (arm->edbo) {
132     BLI_freelistN(arm->edbo);
133
134     MEM_freeN(arm->edbo);
135     arm->edbo = NULL;
136   }
137 }
138
139 void BKE_armature_make_local(Main *bmain, bArmature *arm, const bool lib_local)
140 {
141   BKE_id_make_local_generic(bmain, &arm->id, true, lib_local);
142 }
143
144 static void copy_bonechildren(Bone *bone_dst,
145                               const Bone *bone_src,
146                               const Bone *bone_src_act,
147                               Bone **r_bone_dst_act,
148                               const int flag)
149 {
150   Bone *bone_src_child, *bone_dst_child;
151
152   if (bone_src == bone_src_act) {
153     *r_bone_dst_act = bone_dst;
154   }
155
156   if (bone_src->prop) {
157     bone_dst->prop = IDP_CopyProperty_ex(bone_src->prop, flag);
158   }
159
160   /* Copy this bone's list */
161   BLI_duplicatelist(&bone_dst->childbase, &bone_src->childbase);
162
163   /* For each child in the list, update it's children */
164   for (bone_src_child = bone_src->childbase.first, bone_dst_child = bone_dst->childbase.first;
165        bone_src_child;
166        bone_src_child = bone_src_child->next, bone_dst_child = bone_dst_child->next) {
167     bone_dst_child->parent = bone_dst;
168     copy_bonechildren(bone_dst_child, bone_src_child, bone_src_act, r_bone_dst_act, flag);
169   }
170 }
171
172 static void copy_bonechildren_custom_handles(Bone *bone_dst, bArmature *arm_dst, GHash **bone_hash)
173 {
174   Bone *bone_dst_child;
175
176   /* Lazily create the name -> bone hashtable. */
177   if ((bone_dst->bbone_prev || bone_dst->bbone_next) && *bone_hash == NULL) {
178     *bone_hash = BKE_armature_bone_from_name_map(arm_dst);
179   }
180
181   if (bone_dst->bbone_prev) {
182     bone_dst->bbone_prev = BLI_ghash_lookup(*bone_hash, bone_dst->bbone_prev->name);
183   }
184   if (bone_dst->bbone_next) {
185     bone_dst->bbone_next = BLI_ghash_lookup(*bone_hash, bone_dst->bbone_next->name);
186   }
187
188   for (bone_dst_child = bone_dst->childbase.first; bone_dst_child;
189        bone_dst_child = bone_dst_child->next) {
190     copy_bonechildren_custom_handles(bone_dst_child, arm_dst, bone_hash);
191   }
192 }
193
194 /**
195  * Only copy internal data of Armature ID from source
196  * to already allocated/initialized destination.
197  * You probably never want to use that directly,
198  * use #BKE_id_copy or #BKE_id_copy_ex for typical needs.
199  *
200  * WARNING! This function will not handle ID user count!
201  *
202  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
203  */
204 void BKE_armature_copy_data(Main *UNUSED(bmain),
205                             bArmature *arm_dst,
206                             const bArmature *arm_src,
207                             const int flag)
208 {
209   Bone *bone_src, *bone_dst;
210   Bone *bone_dst_act = NULL;
211
212   /* We never handle usercount here for own data. */
213   const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT;
214
215   BLI_duplicatelist(&arm_dst->bonebase, &arm_src->bonebase);
216
217   /* Duplicate the childrens' lists */
218   bone_dst = arm_dst->bonebase.first;
219   for (bone_src = arm_src->bonebase.first; bone_src; bone_src = bone_src->next) {
220     bone_dst->parent = NULL;
221     copy_bonechildren(bone_dst, bone_src, arm_src->act_bone, &bone_dst_act, flag_subdata);
222     bone_dst = bone_dst->next;
223   }
224
225   arm_dst->act_bone = bone_dst_act;
226
227   /* Fix custom handle references. */
228   GHash *bone_hash = NULL; /* lazily created */
229
230   for (bone_dst = arm_dst->bonebase.first; bone_dst; bone_dst = bone_dst->next) {
231     copy_bonechildren_custom_handles(bone_dst, arm_dst, &bone_hash);
232   }
233
234   if (bone_hash) {
235     BLI_ghash_free(bone_hash, NULL, NULL);
236   }
237
238   arm_dst->edbo = NULL;
239   arm_dst->act_edbone = NULL;
240 }
241
242 bArmature *BKE_armature_copy(Main *bmain, const bArmature *arm)
243 {
244   bArmature *arm_copy;
245   BKE_id_copy(bmain, &arm->id, (ID **)&arm_copy);
246   return arm_copy;
247 }
248
249 static Bone *get_named_bone_bonechildren(ListBase *lb, const char *name)
250 {
251   Bone *curBone, *rbone;
252
253   for (curBone = lb->first; curBone; curBone = curBone->next) {
254     if (STREQ(curBone->name, name)) {
255       return curBone;
256     }
257
258     rbone = get_named_bone_bonechildren(&curBone->childbase, name);
259     if (rbone) {
260       return rbone;
261     }
262   }
263
264   return NULL;
265 }
266
267 /**
268  * Walk the list until the bone is found (slow!),
269  * use #BKE_armature_bone_from_name_map for multiple lookups.
270  */
271 Bone *BKE_armature_find_bone_name(bArmature *arm, const char *name)
272 {
273   if (!arm) {
274     return NULL;
275   }
276
277   return get_named_bone_bonechildren(&arm->bonebase, name);
278 }
279
280 static void armature_bone_from_name_insert_recursive(GHash *bone_hash, ListBase *lb)
281 {
282   for (Bone *bone = lb->first; bone; bone = bone->next) {
283     BLI_ghash_insert(bone_hash, bone->name, bone);
284     armature_bone_from_name_insert_recursive(bone_hash, &bone->childbase);
285   }
286 }
287
288 /**
289  * Create a (name -> bone) map.
290  *
291  * \note typically #bPose.chanhash us used via #BKE_pose_channel_find_name
292  * this is for the cases we can't use pose channels.
293  */
294 GHash *BKE_armature_bone_from_name_map(bArmature *arm)
295 {
296   const int bones_count = BKE_armature_bonelist_count(&arm->bonebase);
297   GHash *bone_hash = BLI_ghash_str_new_ex(__func__, bones_count);
298   armature_bone_from_name_insert_recursive(bone_hash, &arm->bonebase);
299   return bone_hash;
300 }
301
302 bool BKE_armature_bone_flag_test_recursive(const Bone *bone, int flag)
303 {
304   if (bone->flag & flag) {
305     return true;
306   }
307   else if (bone->parent) {
308     return BKE_armature_bone_flag_test_recursive(bone->parent, flag);
309   }
310   else {
311     return false;
312   }
313 }
314
315 /* Finds the best possible extension to the name on a particular axis. (For renaming, check for
316  * unique names afterwards) strip_number: removes number extensions  (TODO: not used)
317  * axis: the axis to name on
318  * head/tail: the head/tail co-ordinate of the bone on the specified axis */
319 int bone_autoside_name(
320     char name[MAXBONENAME], int UNUSED(strip_number), short axis, float head, float tail)
321 {
322   unsigned int len;
323   char basename[MAXBONENAME] = "";
324   char extension[5] = "";
325
326   len = strlen(name);
327   if (len == 0) {
328     return 0;
329   }
330   BLI_strncpy(basename, name, sizeof(basename));
331
332   /* Figure out extension to append:
333    * - The extension to append is based upon the axis that we are working on.
334    * - If head happens to be on 0, then we must consider the tail position as well to decide
335    *   which side the bone is on
336    *   -> If tail is 0, then it's bone is considered to be on axis, so no extension should be added
337    *   -> Otherwise, extension is added from perspective of object based on which side tail goes to
338    * - If head is non-zero, extension is added from perspective of object based on side head is on
339    */
340   if (axis == 2) {
341     /* z-axis - vertical (top/bottom) */
342     if (IS_EQF(head, 0.0f)) {
343       if (tail < 0) {
344         strcpy(extension, "Bot");
345       }
346       else if (tail > 0) {
347         strcpy(extension, "Top");
348       }
349     }
350     else {
351       if (head < 0) {
352         strcpy(extension, "Bot");
353       }
354       else {
355         strcpy(extension, "Top");
356       }
357     }
358   }
359   else if (axis == 1) {
360     /* y-axis - depth (front/back) */
361     if (IS_EQF(head, 0.0f)) {
362       if (tail < 0) {
363         strcpy(extension, "Fr");
364       }
365       else if (tail > 0) {
366         strcpy(extension, "Bk");
367       }
368     }
369     else {
370       if (head < 0) {
371         strcpy(extension, "Fr");
372       }
373       else {
374         strcpy(extension, "Bk");
375       }
376     }
377   }
378   else {
379     /* x-axis - horizontal (left/right) */
380     if (IS_EQF(head, 0.0f)) {
381       if (tail < 0) {
382         strcpy(extension, "R");
383       }
384       else if (tail > 0) {
385         strcpy(extension, "L");
386       }
387     }
388     else {
389       if (head < 0) {
390         strcpy(extension, "R");
391         /* XXX Shouldn't this be simple else, as for z and y axes? */
392       }
393       else if (head > 0) {
394         strcpy(extension, "L");
395       }
396     }
397   }
398
399   /* Simple name truncation
400    * - truncate if there is an extension and it wouldn't be able to fit
401    * - otherwise, just append to end
402    */
403   if (extension[0]) {
404     bool changed = true;
405
406     while (changed) { /* remove extensions */
407       changed = false;
408       if (len > 2 && basename[len - 2] == '.') {
409         if (basename[len - 1] == 'L' || basename[len - 1] == 'R') { /* L R */
410           basename[len - 2] = '\0';
411           len -= 2;
412           changed = true;
413         }
414       }
415       else if (len > 3 && basename[len - 3] == '.') {
416         if ((basename[len - 2] == 'F' && basename[len - 1] == 'r') || /* Fr */
417             (basename[len - 2] == 'B' && basename[len - 1] == 'k'))   /* Bk */
418         {
419           basename[len - 3] = '\0';
420           len -= 3;
421           changed = true;
422         }
423       }
424       else if (len > 4 && basename[len - 4] == '.') {
425         if ((basename[len - 3] == 'T' && basename[len - 2] == 'o' &&
426              basename[len - 1] == 'p') || /* Top */
427             (basename[len - 3] == 'B' && basename[len - 2] == 'o' &&
428              basename[len - 1] == 't')) /* Bot */
429         {
430           basename[len - 4] = '\0';
431           len -= 4;
432           changed = true;
433         }
434       }
435     }
436
437     if ((MAXBONENAME - len) < strlen(extension) + 1) { /* add 1 for the '.' */
438       strncpy(name, basename, len - strlen(extension));
439     }
440
441     BLI_snprintf(name, MAXBONENAME, "%s.%s", basename, extension);
442
443     return 1;
444   }
445
446   else {
447     return 0;
448   }
449 }
450
451 /* ************* B-Bone support ******************* */
452
453 /* Compute a set of bezier parameter values that produce approximately equally spaced points. */
454 static void equalize_cubic_bezier(const float control[4][3],
455                                   int temp_segments,
456                                   int final_segments,
457                                   float *r_t_points)
458 {
459   float(*coords)[3] = BLI_array_alloca(coords, temp_segments + 1);
460   float *pdist = BLI_array_alloca(pdist, temp_segments + 1);
461
462   /* Compute the first pass of bezier point coordinates. */
463   for (int i = 0; i < 3; i++) {
464     BKE_curve_forward_diff_bezier(control[0][i],
465                                   control[1][i],
466                                   control[2][i],
467                                   control[3][i],
468                                   &coords[0][i],
469                                   temp_segments,
470                                   sizeof(*coords));
471   }
472
473   /* Calculate the length of the polyline at each point. */
474   pdist[0] = 0.0f;
475
476   for (int i = 0; i < temp_segments; i++) {
477     pdist[i + 1] = pdist[i] + len_v3v3(coords[i], coords[i + 1]);
478   }
479
480   /* Go over distances and calculate new parameter values. */
481   float dist_step = pdist[temp_segments] / final_segments;
482
483   r_t_points[0] = 0.0f;
484
485   for (int i = 1, nr = 1; i <= final_segments; i++) {
486     float dist = i * dist_step;
487
488     /* We're looking for location (distance) 'dist' in the array. */
489     while ((nr < temp_segments) && (dist >= pdist[nr])) {
490       nr++;
491     }
492
493     float fac = (pdist[nr] - dist) / (pdist[nr] - pdist[nr - 1]);
494
495     r_t_points[i] = (nr - fac) / temp_segments;
496   }
497
498   r_t_points[final_segments] = 1.0f;
499 }
500
501 /* Evaluate bezier position and tangent at a specific parameter value
502  * using the De Casteljau algorithm. */
503 static void evaluate_cubic_bezier(const float control[4][3],
504                                   float t,
505                                   float r_pos[3],
506                                   float r_tangent[3])
507 {
508   float layer1[3][3];
509   interp_v3_v3v3(layer1[0], control[0], control[1], t);
510   interp_v3_v3v3(layer1[1], control[1], control[2], t);
511   interp_v3_v3v3(layer1[2], control[2], control[3], t);
512
513   float layer2[2][3];
514   interp_v3_v3v3(layer2[0], layer1[0], layer1[1], t);
515   interp_v3_v3v3(layer2[1], layer1[1], layer1[2], t);
516
517   sub_v3_v3v3(r_tangent, layer2[1], layer2[0]);
518   madd_v3_v3v3fl(r_pos, layer2[0], r_tangent, t);
519 }
520
521 /* Get "next" and "prev" bones - these are used for handle calculations. */
522 void BKE_pchan_bbone_handles_get(bPoseChannel *pchan, bPoseChannel **r_prev, bPoseChannel **r_next)
523 {
524   if (pchan->bone->bbone_prev_type == BBONE_HANDLE_AUTO) {
525     /* Use connected parent. */
526     if (pchan->bone->flag & BONE_CONNECTED) {
527       *r_prev = pchan->parent;
528     }
529     else {
530       *r_prev = NULL;
531     }
532   }
533   else {
534     /* Use the provided bone as prev - leave blank to eliminate this effect altogether. */
535     *r_prev = pchan->bbone_prev;
536   }
537
538   if (pchan->bone->bbone_next_type == BBONE_HANDLE_AUTO) {
539     /* Use connected child. */
540     *r_next = pchan->child;
541   }
542   else {
543     /* Use the provided bone as next - leave blank to eliminate this effect altogether. */
544     *r_next = pchan->bbone_next;
545   }
546 }
547
548 /* Compute B-Bone spline parameters for the given channel. */
549 void BKE_pchan_bbone_spline_params_get(struct bPoseChannel *pchan,
550                                        const bool rest,
551                                        struct BBoneSplineParameters *param)
552 {
553   bPoseChannel *next, *prev;
554   Bone *bone = pchan->bone;
555   float imat[4][4], posemat[4][4];
556   float delta[3];
557
558   memset(param, 0, sizeof(*param));
559
560   param->segments = bone->segments;
561   param->length = bone->length;
562
563   if (!rest) {
564     float scale[3];
565
566     /* Check if we need to take non-uniform bone scaling into account. */
567     mat4_to_size(scale, pchan->pose_mat);
568
569     if (fabsf(scale[0] - scale[1]) > 1e-6f || fabsf(scale[1] - scale[2]) > 1e-6f) {
570       param->do_scale = true;
571       copy_v3_v3(param->scale, scale);
572     }
573   }
574
575   BKE_pchan_bbone_handles_get(pchan, &prev, &next);
576
577   /* Find the handle points, since this is inside bone space, the
578    * first point = (0, 0, 0)
579    * last point =  (0, length, 0) */
580   if (rest) {
581     invert_m4_m4(imat, pchan->bone->arm_mat);
582   }
583   else if (param->do_scale) {
584     copy_m4_m4(posemat, pchan->pose_mat);
585     normalize_m4(posemat);
586     invert_m4_m4(imat, posemat);
587   }
588   else {
589     invert_m4_m4(imat, pchan->pose_mat);
590   }
591
592   if (prev) {
593     float h1[3];
594     bool done = false;
595
596     param->use_prev = true;
597
598     /* Transform previous point inside this bone space. */
599     if (bone->bbone_prev_type == BBONE_HANDLE_RELATIVE) {
600       /* Use delta movement (from restpose), and apply this relative to the current bone's head. */
601       if (rest) {
602         /* In restpose, arm_head == pose_head */
603         zero_v3(param->prev_h);
604         done = true;
605       }
606       else {
607         sub_v3_v3v3(delta, prev->pose_head, prev->bone->arm_head);
608         sub_v3_v3v3(h1, pchan->pose_head, delta);
609       }
610     }
611     else if (bone->bbone_prev_type == BBONE_HANDLE_TANGENT) {
612       /* Use bone direction by offsetting so that its tail meets current bone's head */
613       if (rest) {
614         sub_v3_v3v3(delta, prev->bone->arm_tail, prev->bone->arm_head);
615         sub_v3_v3v3(h1, bone->arm_head, delta);
616       }
617       else {
618         sub_v3_v3v3(delta, prev->pose_tail, prev->pose_head);
619         sub_v3_v3v3(h1, pchan->pose_head, delta);
620       }
621     }
622     else {
623       /* Apply special handling for smoothly joining B-Bone chains */
624       param->prev_bbone = (prev->bone->segments > 1);
625
626       /* Use bone head as absolute position. */
627       copy_v3_v3(h1, rest ? prev->bone->arm_head : prev->pose_head);
628     }
629
630     if (!done) {
631       mul_v3_m4v3(param->prev_h, imat, h1);
632     }
633
634     if (!param->prev_bbone) {
635       /* Find the previous roll to interpolate. */
636       mul_m4_m4m4(param->prev_mat, imat, rest ? prev->bone->arm_mat : prev->pose_mat);
637     }
638   }
639
640   if (next) {
641     float h2[3];
642     bool done = false;
643
644     param->use_next = true;
645
646     /* Transform next point inside this bone space. */
647     if (bone->bbone_next_type == BBONE_HANDLE_RELATIVE) {
648       /* Use delta movement (from restpose), and apply this relative to the current bone's tail. */
649       if (rest) {
650         /* In restpose, arm_head == pose_head */
651         copy_v3_fl3(param->next_h, 0.0f, param->length, 0.0);
652         done = true;
653       }
654       else {
655         sub_v3_v3v3(delta, next->pose_head, next->bone->arm_head);
656         add_v3_v3v3(h2, pchan->pose_tail, delta);
657       }
658     }
659     else if (bone->bbone_next_type == BBONE_HANDLE_TANGENT) {
660       /* Use bone direction by offsetting so that its head meets current bone's tail */
661       if (rest) {
662         sub_v3_v3v3(delta, next->bone->arm_tail, next->bone->arm_head);
663         add_v3_v3v3(h2, bone->arm_tail, delta);
664       }
665       else {
666         sub_v3_v3v3(delta, next->pose_tail, next->pose_head);
667         add_v3_v3v3(h2, pchan->pose_tail, delta);
668       }
669     }
670     else {
671       /* Apply special handling for smoothly joining B-Bone chains */
672       param->next_bbone = (next->bone->segments > 1);
673
674       /* Use bone tail as absolute position. */
675       copy_v3_v3(h2, rest ? next->bone->arm_tail : next->pose_tail);
676     }
677
678     if (!done) {
679       mul_v3_m4v3(param->next_h, imat, h2);
680     }
681
682     /* Find the next roll to interpolate as well. */
683     mul_m4_m4m4(param->next_mat, imat, rest ? next->bone->arm_mat : next->pose_mat);
684   }
685
686   /* Add effects from bbone properties over the top
687    * - These properties allow users to hand-animate the
688    *   bone curve/shape, without having to resort to using
689    *   extra bones
690    * - The "bone" level offsets are for defining the restpose
691    *   shape of the bone (e.g. for curved eyebrows for example).
692    *   -> In the viewport, it's needed to define what the rest pose
693    *      looks like
694    *   -> For "rest == 0", we also still need to have it present
695    *      so that we can "cancel out" this restpose when it comes
696    *      time to deform some geometry, it won't cause double transforms.
697    * - The "pchan" level offsets are the ones that animators actually
698    *   end up animating
699    */
700   {
701     param->ease1 = bone->ease1 + (!rest ? pchan->ease1 : 0.0f);
702     param->ease2 = bone->ease2 + (!rest ? pchan->ease2 : 0.0f);
703
704     param->roll1 = bone->roll1 + (!rest ? pchan->roll1 : 0.0f);
705     param->roll2 = bone->roll2 + (!rest ? pchan->roll2 : 0.0f);
706
707     if (bone->flag & BONE_ADD_PARENT_END_ROLL) {
708       if (prev) {
709         if (prev->bone) {
710           param->roll1 += prev->bone->roll2;
711         }
712
713         if (!rest) {
714           param->roll1 += prev->roll2;
715         }
716       }
717     }
718
719     param->scale_in_x = bone->scale_in_x * (!rest ? pchan->scale_in_x : 1.0f);
720     param->scale_in_y = bone->scale_in_y * (!rest ? pchan->scale_in_y : 1.0f);
721     param->scale_out_x = bone->scale_out_x * (!rest ? pchan->scale_out_x : 1.0f);
722     param->scale_out_y = bone->scale_out_y * (!rest ? pchan->scale_out_y : 1.0f);
723
724     /* Extra curve x / y */
725     param->curve_in_x = bone->curve_in_x + (!rest ? pchan->curve_in_x : 0.0f);
726     param->curve_in_y = bone->curve_in_y + (!rest ? pchan->curve_in_y : 0.0f);
727
728     param->curve_out_x = bone->curve_out_x + (!rest ? pchan->curve_out_x : 0.0f);
729     param->curve_out_y = bone->curve_out_y + (!rest ? pchan->curve_out_y : 0.0f);
730   }
731 }
732
733 /* Fills the array with the desired amount of bone->segments elements.
734  * This calculation is done within unit bone space. */
735 void BKE_pchan_bbone_spline_setup(bPoseChannel *pchan,
736                                   const bool rest,
737                                   const bool for_deform,
738                                   Mat4 *result_array)
739 {
740   BBoneSplineParameters param;
741
742   BKE_pchan_bbone_spline_params_get(pchan, rest, &param);
743
744   pchan->bone->segments = BKE_pchan_bbone_spline_compute(&param, for_deform, result_array);
745 }
746
747 /* Computes the bezier handle vectors and rolls coming from custom handles. */
748 void BKE_pchan_bbone_handles_compute(const BBoneSplineParameters *param,
749                                      float h1[3],
750                                      float *r_roll1,
751                                      float h2[3],
752                                      float *r_roll2,
753                                      bool ease,
754                                      bool offsets)
755 {
756   float mat3[3][3];
757   float length = param->length;
758   float epsilon = 1e-5 * length;
759
760   if (param->do_scale) {
761     length *= param->scale[1];
762   }
763
764   *r_roll1 = *r_roll2 = 0.0f;
765
766   if (param->use_prev) {
767     copy_v3_v3(h1, param->prev_h);
768
769     if (param->prev_bbone) {
770       /* If previous bone is B-bone too, use average handle direction. */
771       h1[1] -= length;
772     }
773
774     if (normalize_v3(h1) < epsilon) {
775       copy_v3_fl3(h1, 0.0f, -1.0f, 0.0f);
776     }
777
778     negate_v3(h1);
779
780     if (!param->prev_bbone) {
781       /* Find the previous roll to interpolate. */
782       copy_m3_m4(mat3, param->prev_mat);
783       mat3_vec_to_roll(mat3, h1, r_roll1);
784     }
785   }
786   else {
787     h1[0] = 0.0f;
788     h1[1] = 1.0;
789     h1[2] = 0.0f;
790   }
791
792   if (param->use_next) {
793     copy_v3_v3(h2, param->next_h);
794
795     /* If next bone is B-bone too, use average handle direction. */
796     if (param->next_bbone) {
797       /* pass */
798     }
799     else {
800       h2[1] -= length;
801     }
802
803     if (normalize_v3(h2) < epsilon) {
804       copy_v3_fl3(h2, 0.0f, 1.0f, 0.0f);
805     }
806
807     /* Find the next roll to interpolate as well. */
808     copy_m3_m4(mat3, param->next_mat);
809     mat3_vec_to_roll(mat3, h2, r_roll2);
810   }
811   else {
812     h2[0] = 0.0f;
813     h2[1] = 1.0f;
814     h2[2] = 0.0f;
815   }
816
817   if (ease) {
818     const float circle_factor = length * (cubic_tangent_factor_circle_v3(h1, h2) / 0.75f);
819
820     const float hlength1 = param->ease1 * circle_factor;
821     const float hlength2 = param->ease2 * circle_factor;
822
823     /* and only now negate h2 */
824     mul_v3_fl(h1, hlength1);
825     mul_v3_fl(h2, -hlength2);
826   }
827
828   /* Add effects from bbone properties over the top
829    * - These properties allow users to hand-animate the
830    *   bone curve/shape, without having to resort to using
831    *   extra bones
832    * - The "bone" level offsets are for defining the restpose
833    *   shape of the bone (e.g. for curved eyebrows for example).
834    *   -> In the viewport, it's needed to define what the rest pose
835    *      looks like
836    *   -> For "rest == 0", we also still need to have it present
837    *      so that we can "cancel out" this restpose when it comes
838    *      time to deform some geometry, it won't cause double transforms.
839    * - The "pchan" level offsets are the ones that animators actually
840    *   end up animating
841    */
842   if (offsets) {
843     /* Add extra rolls. */
844     *r_roll1 += param->roll1;
845     *r_roll2 += param->roll2;
846
847     /* Extra curve x / y */
848     /* NOTE:
849      * Scale correction factors here are to compensate for some random floating-point glitches
850      * when scaling up the bone or it's parent by a factor of approximately 8.15/6, which results
851      * in the bone length getting scaled up too (from 1 to 8), causing the curve to flatten out.
852      */
853     const float xscale_correction = (param->do_scale) ? param->scale[0] : 1.0f;
854     const float yscale_correction = (param->do_scale) ? param->scale[2] : 1.0f;
855
856     h1[0] += param->curve_in_x * xscale_correction;
857     h1[2] += param->curve_in_y * yscale_correction;
858
859     h2[0] += param->curve_out_x * xscale_correction;
860     h2[2] += param->curve_out_y * yscale_correction;
861   }
862 }
863
864 static void make_bbone_spline_matrix(BBoneSplineParameters *param,
865                                      float scalemats[2][4][4],
866                                      float pos[3],
867                                      float axis[3],
868                                      float roll,
869                                      float scalex,
870                                      float scaley,
871                                      float result[4][4])
872 {
873   float mat3[3][3];
874
875   vec_roll_to_mat3(axis, roll, mat3);
876
877   copy_m4_m3(result, mat3);
878   copy_v3_v3(result[3], pos);
879
880   if (param->do_scale) {
881     /* Correct for scaling when this matrix is used in scaled space. */
882     mul_m4_series(result, scalemats[0], result, scalemats[1]);
883   }
884
885   /* BBone scale... */
886   mul_v3_fl(result[0], scalex);
887   mul_v3_fl(result[2], scaley);
888 }
889
890 /* Fade from first to second derivative when the handle is very short. */
891 static void ease_handle_axis(const float deriv1[3], const float deriv2[3], float r_axis[3])
892 {
893   const float gap = 0.1f;
894
895   copy_v3_v3(r_axis, deriv1);
896
897   float len1 = len_squared_v3(deriv1), len2 = len_squared_v3(deriv2);
898   float ratio = len1 / len2;
899
900   if (ratio < gap * gap) {
901     madd_v3_v3fl(r_axis, deriv2, gap - sqrtf(ratio));
902   }
903 }
904
905 /* Fills the array with the desired amount of bone->segments elements.
906  * This calculation is done within unit bone space. */
907 int BKE_pchan_bbone_spline_compute(BBoneSplineParameters *param,
908                                    const bool for_deform,
909                                    Mat4 *result_array)
910 {
911   float scalemats[2][4][4];
912   float bezt_controls[4][3];
913   float h1[3], roll1, h2[3], roll2, prev[3], cur[3], axis[3];
914   float length = param->length;
915
916   if (param->do_scale) {
917     size_to_mat4(scalemats[1], param->scale);
918     invert_m4_m4(scalemats[0], scalemats[1]);
919
920     length *= param->scale[1];
921   }
922
923   BKE_pchan_bbone_handles_compute(param, h1, &roll1, h2, &roll2, true, true);
924
925   /* Make curve. */
926   CLAMP_MAX(param->segments, MAX_BBONE_SUBDIV);
927
928   copy_v3_fl3(bezt_controls[3], 0.0f, length, 0.0f);
929   add_v3_v3v3(bezt_controls[2], bezt_controls[3], h2);
930   copy_v3_v3(bezt_controls[1], h1);
931   zero_v3(bezt_controls[0]);
932
933   float bezt_points[MAX_BBONE_SUBDIV + 1];
934
935   equalize_cubic_bezier(bezt_controls, MAX_BBONE_SUBDIV, param->segments, bezt_points);
936
937   /* Deformation uses N+1 matrices computed at points between the segments. */
938   if (for_deform) {
939     /* Bezier derivatives. */
940     float bezt_deriv1[3][3], bezt_deriv2[2][3];
941
942     for (int i = 0; i < 3; i++) {
943       sub_v3_v3v3(bezt_deriv1[i], bezt_controls[i + 1], bezt_controls[i]);
944     }
945     for (int i = 0; i < 2; i++) {
946       sub_v3_v3v3(bezt_deriv2[i], bezt_deriv1[i + 1], bezt_deriv1[i]);
947     }
948
949     /* End points require special handling to fix zero length handles. */
950     ease_handle_axis(bezt_deriv1[0], bezt_deriv2[0], axis);
951     make_bbone_spline_matrix(param,
952                              scalemats,
953                              bezt_controls[0],
954                              axis,
955                              roll1,
956                              param->scale_in_x,
957                              param->scale_in_y,
958                              result_array[0].mat);
959
960     for (int a = 1; a < param->segments; a++) {
961       evaluate_cubic_bezier(bezt_controls, bezt_points[a], cur, axis);
962
963       float fac = ((float)a) / param->segments;
964       float roll = interpf(roll2, roll1, fac);
965       float scalex = interpf(param->scale_out_x, param->scale_in_x, fac);
966       float scaley = interpf(param->scale_out_y, param->scale_in_y, fac);
967
968       make_bbone_spline_matrix(
969           param, scalemats, cur, axis, roll, scalex, scaley, result_array[a].mat);
970     }
971
972     negate_v3(bezt_deriv2[1]);
973     ease_handle_axis(bezt_deriv1[2], bezt_deriv2[1], axis);
974     make_bbone_spline_matrix(param,
975                              scalemats,
976                              bezt_controls[3],
977                              axis,
978                              roll2,
979                              param->scale_out_x,
980                              param->scale_out_y,
981                              result_array[param->segments].mat);
982   }
983   /* Other code (e.g. display) uses matrices for the segments themselves. */
984   else {
985     zero_v3(prev);
986
987     for (int a = 0; a < param->segments; a++) {
988       evaluate_cubic_bezier(bezt_controls, bezt_points[a + 1], cur, axis);
989
990       sub_v3_v3v3(axis, cur, prev);
991
992       float fac = (a + 0.5f) / param->segments;
993       float roll = interpf(roll2, roll1, fac);
994       float scalex = interpf(param->scale_out_x, param->scale_in_x, fac);
995       float scaley = interpf(param->scale_out_y, param->scale_in_y, fac);
996
997       make_bbone_spline_matrix(
998           param, scalemats, prev, axis, roll, scalex, scaley, result_array[a].mat);
999       copy_v3_v3(prev, cur);
1000     }
1001   }
1002
1003   return param->segments;
1004 }
1005
1006 /* ************ Armature Deform ******************* */
1007
1008 static void allocate_bbone_cache(bPoseChannel *pchan, int segments)
1009 {
1010   bPoseChannel_Runtime *runtime = &pchan->runtime;
1011
1012   if (runtime->bbone_segments != segments) {
1013     BKE_pose_channel_free_bbone_cache(runtime);
1014
1015     runtime->bbone_segments = segments;
1016     runtime->bbone_rest_mats = MEM_malloc_arrayN(
1017         sizeof(Mat4), 1 + (uint)segments, "bPoseChannel_Runtime::bbone_rest_mats");
1018     runtime->bbone_pose_mats = MEM_malloc_arrayN(
1019         sizeof(Mat4), 1 + (uint)segments, "bPoseChannel_Runtime::bbone_pose_mats");
1020     runtime->bbone_deform_mats = MEM_malloc_arrayN(
1021         sizeof(Mat4), 2 + (uint)segments, "bPoseChannel_Runtime::bbone_deform_mats");
1022     runtime->bbone_dual_quats = MEM_malloc_arrayN(
1023         sizeof(DualQuat), 1 + (uint)segments, "bPoseChannel_Runtime::bbone_dual_quats");
1024   }
1025 }
1026
1027 /** Compute and cache the B-Bone shape in the channel runtime struct. */
1028 void BKE_pchan_bbone_segments_cache_compute(bPoseChannel *pchan)
1029 {
1030   bPoseChannel_Runtime *runtime = &pchan->runtime;
1031   Bone *bone = pchan->bone;
1032   int segments = bone->segments;
1033
1034   BLI_assert(segments > 1);
1035
1036   /* Allocate the cache if needed. */
1037   allocate_bbone_cache(pchan, segments);
1038
1039   /* Compute the shape. */
1040   Mat4 *b_bone = runtime->bbone_pose_mats;
1041   Mat4 *b_bone_rest = runtime->bbone_rest_mats;
1042   Mat4 *b_bone_mats = runtime->bbone_deform_mats;
1043   DualQuat *b_bone_dual_quats = runtime->bbone_dual_quats;
1044   int a;
1045
1046   BKE_pchan_bbone_spline_setup(pchan, false, true, b_bone);
1047   BKE_pchan_bbone_spline_setup(pchan, true, true, b_bone_rest);
1048
1049   /* Compute deform matrices. */
1050   /* first matrix is the inverse arm_mat, to bring points in local bone space
1051    * for finding out which segment it belongs to */
1052   invert_m4_m4(b_bone_mats[0].mat, bone->arm_mat);
1053
1054   /* then we make the b_bone_mats:
1055    * - first transform to local bone space
1056    * - translate over the curve to the bbone mat space
1057    * - transform with b_bone matrix
1058    * - transform back into global space */
1059
1060   for (a = 0; a <= bone->segments; a++) {
1061     float tmat[4][4];
1062
1063     invert_m4_m4(tmat, b_bone_rest[a].mat);
1064     mul_m4_series(b_bone_mats[a + 1].mat,
1065                   pchan->chan_mat,
1066                   bone->arm_mat,
1067                   b_bone[a].mat,
1068                   tmat,
1069                   b_bone_mats[0].mat);
1070
1071     mat4_to_dquat(&b_bone_dual_quats[a], bone->arm_mat, b_bone_mats[a + 1].mat);
1072   }
1073 }
1074
1075 /** Copy cached B-Bone segments from one channel to another */
1076 void BKE_pchan_bbone_segments_cache_copy(bPoseChannel *pchan, bPoseChannel *pchan_from)
1077 {
1078   bPoseChannel_Runtime *runtime = &pchan->runtime;
1079   bPoseChannel_Runtime *runtime_from = &pchan_from->runtime;
1080   int segments = runtime_from->bbone_segments;
1081
1082   if (segments <= 1) {
1083     BKE_pose_channel_free_bbone_cache(&pchan->runtime);
1084   }
1085   else {
1086     allocate_bbone_cache(pchan, segments);
1087
1088     memcpy(runtime->bbone_rest_mats, runtime_from->bbone_rest_mats, sizeof(Mat4) * (1 + segments));
1089     memcpy(runtime->bbone_pose_mats, runtime_from->bbone_pose_mats, sizeof(Mat4) * (1 + segments));
1090     memcpy(runtime->bbone_deform_mats,
1091            runtime_from->bbone_deform_mats,
1092            sizeof(Mat4) * (2 + segments));
1093     memcpy(runtime->bbone_dual_quats,
1094            runtime_from->bbone_dual_quats,
1095            sizeof(DualQuat) * (1 + segments));
1096   }
1097 }
1098
1099 /** Calculate index and blend factor for the two B-Bone segment nodes
1100  * affecting the point at 0 <= pos <= 1. */
1101 void BKE_pchan_bbone_deform_segment_index(const bPoseChannel *pchan,
1102                                           float pos,
1103                                           int *r_index,
1104                                           float *r_blend_next)
1105 {
1106   int segments = pchan->bone->segments;
1107
1108   CLAMP(pos, 0.0f, 1.0f);
1109
1110   /* Calculate the indices of the 2 affecting b_bone segments.
1111    * Integer part is the first segment's index.
1112    * Integer part plus 1 is the second segment's index.
1113    * Fractional part is the blend factor. */
1114   float pre_blend = pos * (float)segments;
1115
1116   int index = (int)floorf(pre_blend);
1117   float blend = pre_blend - index;
1118
1119   CLAMP(index, 0, segments);
1120   CLAMP(blend, 0.0f, 1.0f);
1121
1122   *r_index = index;
1123   *r_blend_next = blend;
1124 }
1125
1126 /* Add the effect of one bone or B-Bone segment to the accumulated result. */
1127 static void pchan_deform_accumulate(const DualQuat *deform_dq,
1128                                     const float deform_mat[4][4],
1129                                     const float co_in[3],
1130                                     float weight,
1131                                     float co_accum[3],
1132                                     DualQuat *dq_accum,
1133                                     float mat_accum[3][3])
1134 {
1135   if (weight == 0.0f) {
1136     return;
1137   }
1138
1139   if (dq_accum) {
1140     BLI_assert(!co_accum);
1141
1142     add_weighted_dq_dq(dq_accum, deform_dq, weight);
1143   }
1144   else {
1145     float tmp[3];
1146     mul_v3_m4v3(tmp, deform_mat, co_in);
1147
1148     sub_v3_v3(tmp, co_in);
1149     madd_v3_v3fl(co_accum, tmp, weight);
1150
1151     if (mat_accum) {
1152       float tmpmat[3][3];
1153       copy_m3_m4(tmpmat, deform_mat);
1154
1155       madd_m3_m3m3fl(mat_accum, mat_accum, tmpmat, weight);
1156     }
1157   }
1158 }
1159
1160 static void b_bone_deform(const bPoseChannel *pchan,
1161                           const float co[3],
1162                           float weight,
1163                           float vec[3],
1164                           DualQuat *dq,
1165                           float defmat[3][3])
1166 {
1167   const DualQuat *quats = pchan->runtime.bbone_dual_quats;
1168   const Mat4 *mats = pchan->runtime.bbone_deform_mats;
1169   const float(*mat)[4] = mats[0].mat;
1170   float blend, y;
1171   int index;
1172
1173   /* Transform co to bone space and get its y component. */
1174   y = mat[0][1] * co[0] + mat[1][1] * co[1] + mat[2][1] * co[2] + mat[3][1];
1175
1176   /* Calculate the indices of the 2 affecting b_bone segments. */
1177   BKE_pchan_bbone_deform_segment_index(pchan, y / pchan->bone->length, &index, &blend);
1178
1179   pchan_deform_accumulate(
1180       &quats[index], mats[index + 1].mat, co, weight * (1.0f - blend), vec, dq, defmat);
1181   pchan_deform_accumulate(
1182       &quats[index + 1], mats[index + 2].mat, co, weight * blend, vec, dq, defmat);
1183 }
1184
1185 /* using vec with dist to bone b1 - b2 */
1186 float distfactor_to_bone(
1187     const float vec[3], const float b1[3], const float b2[3], float rad1, float rad2, float rdist)
1188 {
1189   float dist_sq;
1190   float bdelta[3];
1191   float pdelta[3];
1192   float hsqr, a, l, rad;
1193
1194   sub_v3_v3v3(bdelta, b2, b1);
1195   l = normalize_v3(bdelta);
1196
1197   sub_v3_v3v3(pdelta, vec, b1);
1198
1199   a = dot_v3v3(bdelta, pdelta);
1200   hsqr = len_squared_v3(pdelta);
1201
1202   if (a < 0.0f) {
1203     /* If we're past the end of the bone, do a spherical field attenuation thing */
1204     dist_sq = len_squared_v3v3(b1, vec);
1205     rad = rad1;
1206   }
1207   else if (a > l) {
1208     /* If we're past the end of the bone, do a spherical field attenuation thing */
1209     dist_sq = len_squared_v3v3(b2, vec);
1210     rad = rad2;
1211   }
1212   else {
1213     dist_sq = (hsqr - (a * a));
1214
1215     if (l != 0.0f) {
1216       rad = a / l;
1217       rad = rad * rad2 + (1.0f - rad) * rad1;
1218     }
1219     else {
1220       rad = rad1;
1221     }
1222   }
1223
1224   a = rad * rad;
1225   if (dist_sq < a) {
1226     return 1.0f;
1227   }
1228   else {
1229     l = rad + rdist;
1230     l *= l;
1231     if (rdist == 0.0f || dist_sq >= l) {
1232       return 0.0f;
1233     }
1234     else {
1235       a = sqrtf(dist_sq) - rad;
1236       return 1.0f - (a * a) / (rdist * rdist);
1237     }
1238   }
1239 }
1240
1241 static float dist_bone_deform(
1242     bPoseChannel *pchan, float vec[3], DualQuat *dq, float mat[3][3], const float co[3])
1243 {
1244   Bone *bone = pchan->bone;
1245   float fac, contrib = 0.0;
1246
1247   if (bone == NULL) {
1248     return 0.0f;
1249   }
1250
1251   fac = distfactor_to_bone(
1252       co, bone->arm_head, bone->arm_tail, bone->rad_head, bone->rad_tail, bone->dist);
1253
1254   if (fac > 0.0f) {
1255     fac *= bone->weight;
1256     contrib = fac;
1257     if (contrib > 0.0f) {
1258       if (bone->segments > 1 && pchan->runtime.bbone_segments == bone->segments) {
1259         b_bone_deform(pchan, co, fac, vec, dq, mat);
1260       }
1261       else {
1262         pchan_deform_accumulate(
1263             &pchan->runtime.deform_dual_quat, pchan->chan_mat, co, fac, vec, dq, mat);
1264       }
1265     }
1266   }
1267
1268   return contrib;
1269 }
1270
1271 static void pchan_bone_deform(bPoseChannel *pchan,
1272                               float weight,
1273                               float vec[3],
1274                               DualQuat *dq,
1275                               float mat[3][3],
1276                               const float co[3],
1277                               float *contrib)
1278 {
1279   Bone *bone = pchan->bone;
1280
1281   if (!weight) {
1282     return;
1283   }
1284
1285   if (bone->segments > 1 && pchan->runtime.bbone_segments == bone->segments) {
1286     b_bone_deform(pchan, co, weight, vec, dq, mat);
1287   }
1288   else {
1289     pchan_deform_accumulate(
1290         &pchan->runtime.deform_dual_quat, pchan->chan_mat, co, weight, vec, dq, mat);
1291   }
1292
1293   (*contrib) += weight;
1294 }
1295
1296 typedef struct ArmatureUserdata {
1297   Object *armOb;
1298   Object *target;
1299   const Mesh *mesh;
1300   float (*vertexCos)[3];
1301   float (*defMats)[3][3];
1302   float (*prevCos)[3];
1303
1304   bool use_envelope;
1305   bool use_quaternion;
1306   bool invert_vgroup;
1307   bool use_dverts;
1308
1309   int armature_def_nr;
1310
1311   int target_totvert;
1312   MDeformVert *dverts;
1313
1314   int defbase_tot;
1315   bPoseChannel **defnrToPC;
1316
1317   float premat[4][4];
1318   float postmat[4][4];
1319 } ArmatureUserdata;
1320
1321 static void armature_vert_task(void *__restrict userdata,
1322                                const int i,
1323                                const ParallelRangeTLS *__restrict UNUSED(tls))
1324 {
1325   const ArmatureUserdata *data = userdata;
1326   float(*const vertexCos)[3] = data->vertexCos;
1327   float(*const defMats)[3][3] = data->defMats;
1328   float(*const prevCos)[3] = data->prevCos;
1329   const bool use_envelope = data->use_envelope;
1330   const bool use_quaternion = data->use_quaternion;
1331   const bool use_dverts = data->use_dverts;
1332   const int armature_def_nr = data->armature_def_nr;
1333
1334   MDeformVert *dvert;
1335   DualQuat sumdq, *dq = NULL;
1336   bPoseChannel *pchan;
1337   float *co, dco[3];
1338   float sumvec[3], summat[3][3];
1339   float *vec = NULL, (*smat)[3] = NULL;
1340   float contrib = 0.0f;
1341   float armature_weight = 1.0f; /* default to 1 if no overall def group */
1342   float prevco_weight = 1.0f;   /* weight for optional cached vertexcos */
1343
1344   if (use_quaternion) {
1345     memset(&sumdq, 0, sizeof(DualQuat));
1346     dq = &sumdq;
1347   }
1348   else {
1349     sumvec[0] = sumvec[1] = sumvec[2] = 0.0f;
1350     vec = sumvec;
1351
1352     if (defMats) {
1353       zero_m3(summat);
1354       smat = summat;
1355     }
1356   }
1357
1358   if (use_dverts || armature_def_nr != -1) {
1359     if (data->mesh) {
1360       BLI_assert(i < data->mesh->totvert);
1361       dvert = data->mesh->dvert + i;
1362     }
1363     else if (data->dverts && i < data->target_totvert) {
1364       dvert = data->dverts + i;
1365     }
1366     else {
1367       dvert = NULL;
1368     }
1369   }
1370   else {
1371     dvert = NULL;
1372   }
1373
1374   if (armature_def_nr != -1 && dvert) {
1375     armature_weight = defvert_find_weight(dvert, armature_def_nr);
1376
1377     if (data->invert_vgroup) {
1378       armature_weight = 1.0f - armature_weight;
1379     }
1380
1381     /* hackish: the blending factor can be used for blending with prevCos too */
1382     if (prevCos) {
1383       prevco_weight = armature_weight;
1384       armature_weight = 1.0f;
1385     }
1386   }
1387
1388   /* check if there's any  point in calculating for this vert */
1389   if (armature_weight == 0.0f) {
1390     return;
1391   }
1392
1393   /* get the coord we work on */
1394   co = prevCos ? prevCos[i] : vertexCos[i];
1395
1396   /* Apply the object's matrix */
1397   mul_m4_v3(data->premat, co);
1398
1399   if (use_dverts && dvert && dvert->totweight) { /* use weight groups ? */
1400     MDeformWeight *dw = dvert->dw;
1401     int deformed = 0;
1402     unsigned int j;
1403     float acum_weight = 0;
1404     for (j = dvert->totweight; j != 0; j--, dw++) {
1405       const int index = dw->def_nr;
1406       if (index >= 0 && index < data->defbase_tot && (pchan = data->defnrToPC[index])) {
1407         float weight = dw->weight;
1408         Bone *bone = pchan->bone;
1409
1410         deformed = 1;
1411
1412         if (bone && bone->flag & BONE_MULT_VG_ENV) {
1413           weight *= distfactor_to_bone(
1414               co, bone->arm_head, bone->arm_tail, bone->rad_head, bone->rad_tail, bone->dist);
1415         }
1416
1417         /* check limit of weight */
1418         if (data->target->type == OB_GPENCIL) {
1419           if (acum_weight + weight >= 1.0f) {
1420             weight = 1.0f - acum_weight;
1421           }
1422           acum_weight += weight;
1423         }
1424
1425         pchan_bone_deform(pchan, weight, vec, dq, smat, co, &contrib);
1426
1427         /* if acumulated weight limit exceed, exit loop */
1428         if ((data->target->type == OB_GPENCIL) && (acum_weight >= 1.0f)) {
1429           break;
1430         }
1431       }
1432     }
1433     /* if there are vertexgroups but not groups with bones
1434      * (like for softbody groups) */
1435     if (deformed == 0 && use_envelope) {
1436       for (pchan = data->armOb->pose->chanbase.first; pchan; pchan = pchan->next) {
1437         if (!(pchan->bone->flag & BONE_NO_DEFORM)) {
1438           contrib += dist_bone_deform(pchan, vec, dq, smat, co);
1439         }
1440       }
1441     }
1442   }
1443   else if (use_envelope) {
1444     for (pchan = data->armOb->pose->chanbase.first; pchan; pchan = pchan->next) {
1445       if (!(pchan->bone->flag & BONE_NO_DEFORM)) {
1446         contrib += dist_bone_deform(pchan, vec, dq, smat, co);
1447       }
1448     }
1449   }
1450
1451   /* actually should be EPSILON? weight values and contrib can be like 10e-39 small */
1452   if (contrib > 0.0001f) {
1453     if (use_quaternion) {
1454       normalize_dq(dq, contrib);
1455
1456       if (armature_weight != 1.0f) {
1457         copy_v3_v3(dco, co);
1458         mul_v3m3_dq(dco, (defMats) ? summat : NULL, dq);
1459         sub_v3_v3(dco, co);
1460         mul_v3_fl(dco, armature_weight);
1461         add_v3_v3(co, dco);
1462       }
1463       else {
1464         mul_v3m3_dq(co, (defMats) ? summat : NULL, dq);
1465       }
1466
1467       smat = summat;
1468     }
1469     else {
1470       mul_v3_fl(vec, armature_weight / contrib);
1471       add_v3_v3v3(co, vec, co);
1472     }
1473
1474     if (defMats) {
1475       float pre[3][3], post[3][3], tmpmat[3][3];
1476
1477       copy_m3_m4(pre, data->premat);
1478       copy_m3_m4(post, data->postmat);
1479       copy_m3_m3(tmpmat, defMats[i]);
1480
1481       if (!use_quaternion) { /* quaternion already is scale corrected */
1482         mul_m3_fl(smat, armature_weight / contrib);
1483       }
1484
1485       mul_m3_series(defMats[i], post, smat, pre, tmpmat);
1486     }
1487   }
1488
1489   /* always, check above code */
1490   mul_m4_v3(data->postmat, co);
1491
1492   /* interpolate with previous modifier position using weight group */
1493   if (prevCos) {
1494     float mw = 1.0f - prevco_weight;
1495     vertexCos[i][0] = prevco_weight * vertexCos[i][0] + mw * co[0];
1496     vertexCos[i][1] = prevco_weight * vertexCos[i][1] + mw * co[1];
1497     vertexCos[i][2] = prevco_weight * vertexCos[i][2] + mw * co[2];
1498   }
1499 }
1500
1501 void armature_deform_verts(Object *armOb,
1502                            Object *target,
1503                            const Mesh *mesh,
1504                            float (*vertexCos)[3],
1505                            float (*defMats)[3][3],
1506                            int numVerts,
1507                            int deformflag,
1508                            float (*prevCos)[3],
1509                            const char *defgrp_name,
1510                            bGPDstroke *gps)
1511 {
1512   bArmature *arm = armOb->data;
1513   bPoseChannel **defnrToPC = NULL;
1514   MDeformVert *dverts = NULL;
1515   bDeformGroup *dg;
1516   const bool use_envelope = (deformflag & ARM_DEF_ENVELOPE) != 0;
1517   const bool use_quaternion = (deformflag & ARM_DEF_QUATERNION) != 0;
1518   const bool invert_vgroup = (deformflag & ARM_DEF_INVERT_VGROUP) != 0;
1519   int defbase_tot = 0;       /* safety for vertexgroup index overflow */
1520   int i, target_totvert = 0; /* safety for vertexgroup overflow */
1521   bool use_dverts = false;
1522   int armature_def_nr;
1523
1524   /* in editmode, or not an armature */
1525   if (arm->edbo || (armOb->pose == NULL)) {
1526     return;
1527   }
1528
1529   if ((armOb->pose->flag & POSE_RECALC) != 0) {
1530     CLOG_ERROR(&LOG,
1531                "Trying to evaluate influence of armature '%s' which needs Pose recalc!",
1532                armOb->id.name);
1533     BLI_assert(0);
1534   }
1535
1536   /* get the def_nr for the overall armature vertex group if present */
1537   armature_def_nr = defgroup_name_index(target, defgrp_name);
1538
1539   if (ELEM(target->type, OB_MESH, OB_LATTICE, OB_GPENCIL)) {
1540     defbase_tot = BLI_listbase_count(&target->defbase);
1541
1542     if (target->type == OB_MESH) {
1543       Mesh *me = target->data;
1544       dverts = me->dvert;
1545       if (dverts) {
1546         target_totvert = me->totvert;
1547       }
1548     }
1549     else if (target->type == OB_LATTICE) {
1550       Lattice *lt = target->data;
1551       dverts = lt->dvert;
1552       if (dverts) {
1553         target_totvert = lt->pntsu * lt->pntsv * lt->pntsw;
1554       }
1555     }
1556     else if (target->type == OB_GPENCIL) {
1557       dverts = gps->dvert;
1558       if (dverts) {
1559         target_totvert = gps->totpoints;
1560       }
1561     }
1562   }
1563
1564   /* get a vertex-deform-index to posechannel array */
1565   if (deformflag & ARM_DEF_VGROUP) {
1566     if (ELEM(target->type, OB_MESH, OB_LATTICE, OB_GPENCIL)) {
1567       /* if we have a Mesh, only use dverts if it has them */
1568       if (mesh) {
1569         use_dverts = (mesh->dvert != NULL);
1570       }
1571       else if (dverts) {
1572         use_dverts = true;
1573       }
1574
1575       if (use_dverts) {
1576         defnrToPC = MEM_callocN(sizeof(*defnrToPC) * defbase_tot, "defnrToBone");
1577         /* TODO(sergey): Some considerations here:
1578          *
1579          * - Check whether keeping this consistent across frames gives speedup.
1580          */
1581         for (i = 0, dg = target->defbase.first; dg; i++, dg = dg->next) {
1582           defnrToPC[i] = BKE_pose_channel_find_name(armOb->pose, dg->name);
1583           /* exclude non-deforming bones */
1584           if (defnrToPC[i]) {
1585             if (defnrToPC[i]->bone->flag & BONE_NO_DEFORM) {
1586               defnrToPC[i] = NULL;
1587             }
1588           }
1589         }
1590       }
1591     }
1592   }
1593
1594   ArmatureUserdata data = {.armOb = armOb,
1595                            .target = target,
1596                            .mesh = mesh,
1597                            .vertexCos = vertexCos,
1598                            .defMats = defMats,
1599                            .prevCos = prevCos,
1600                            .use_envelope = use_envelope,
1601                            .use_quaternion = use_quaternion,
1602                            .invert_vgroup = invert_vgroup,
1603                            .use_dverts = use_dverts,
1604                            .armature_def_nr = armature_def_nr,
1605                            .target_totvert = target_totvert,
1606                            .dverts = dverts,
1607                            .defbase_tot = defbase_tot,
1608                            .defnrToPC = defnrToPC};
1609
1610   float obinv[4][4];
1611   invert_m4_m4(obinv, target->obmat);
1612
1613   mul_m4_m4m4(data.postmat, obinv, armOb->obmat);
1614   invert_m4_m4(data.premat, data.postmat);
1615
1616   ParallelRangeSettings settings;
1617   BLI_parallel_range_settings_defaults(&settings);
1618   settings.min_iter_per_thread = 32;
1619   BLI_task_parallel_range(0, numVerts, &data, armature_vert_task, &settings);
1620
1621   if (defnrToPC) {
1622     MEM_freeN(defnrToPC);
1623   }
1624 }
1625
1626 /* ************ END Armature Deform ******************* */
1627
1628 void get_objectspace_bone_matrix(struct Bone *bone,
1629                                  float M_accumulatedMatrix[4][4],
1630                                  int UNUSED(root),
1631                                  int UNUSED(posed))
1632 {
1633   copy_m4_m4(M_accumulatedMatrix, bone->arm_mat);
1634 }
1635
1636 /* **************** Space to Space API ****************** */
1637
1638 /* Convert World-Space Matrix to Pose-Space Matrix */
1639 void BKE_armature_mat_world_to_pose(Object *ob, float inmat[4][4], float outmat[4][4])
1640 {
1641   float obmat[4][4];
1642
1643   /* prevent crashes */
1644   if (ob == NULL) {
1645     return;
1646   }
1647
1648   /* get inverse of (armature) object's matrix  */
1649   invert_m4_m4(obmat, ob->obmat);
1650
1651   /* multiply given matrix by object's-inverse to find pose-space matrix */
1652   mul_m4_m4m4(outmat, inmat, obmat);
1653 }
1654
1655 /* Convert World-Space Location to Pose-Space Location
1656  * NOTE: this cannot be used to convert to pose-space location of the supplied
1657  *       pose-channel into its local space (i.e. 'visual'-keyframing) */
1658 void BKE_armature_loc_world_to_pose(Object *ob, const float inloc[3], float outloc[3])
1659 {
1660   float xLocMat[4][4];
1661   float nLocMat[4][4];
1662
1663   /* build matrix for location */
1664   unit_m4(xLocMat);
1665   copy_v3_v3(xLocMat[3], inloc);
1666
1667   /* get bone-space cursor matrix and extract location */
1668   BKE_armature_mat_world_to_pose(ob, xLocMat, nLocMat);
1669   copy_v3_v3(outloc, nLocMat[3]);
1670 }
1671
1672 /* Simple helper, computes the offset bone matrix.
1673  *     offs_bone = yoffs(b-1) + root(b) + bonemat(b). */
1674 void BKE_bone_offset_matrix_get(const Bone *bone, float offs_bone[4][4])
1675 {
1676   BLI_assert(bone->parent != NULL);
1677
1678   /* Bone transform itself. */
1679   copy_m4_m3(offs_bone, bone->bone_mat);
1680
1681   /* The bone's root offset (is in the parent's coordinate system). */
1682   copy_v3_v3(offs_bone[3], bone->head);
1683
1684   /* Get the length translation of parent (length along y axis). */
1685   offs_bone[3][1] += bone->parent->length;
1686 }
1687
1688 /* Construct the matrices (rot/scale and loc)
1689  * to apply the PoseChannels into the armature (object) space.
1690  * I.e. (roughly) the "pose_mat(b-1) * yoffs(b-1) * d_root(b) * bone_mat(b)" in the
1691  *     pose_mat(b)= pose_mat(b-1) * yoffs(b-1) * d_root(b) * bone_mat(b) * chan_mat(b)
1692  * ...function.
1693  *
1694  * This allows to get the transformations of a bone in its object space,
1695  * *before* constraints (and IK) get applied (used by pose evaluation code).
1696  * And reverse: to find pchan transformations needed to place a bone at a given loc/rot/scale
1697  * in object space (used by interactive transform, and snapping code).
1698  *
1699  * Note that, with the HINGE/NO_SCALE/NO_LOCAL_LOCATION options, the location matrix
1700  * will differ from the rotation/scale matrix...
1701  *
1702  * NOTE: This cannot be used to convert to pose-space transforms of the supplied
1703  *       pose-channel into its local space (i.e. 'visual'-keyframing).
1704  *       (note: I don't understand that, so I keep it :p --mont29).
1705  */
1706 void BKE_bone_parent_transform_calc_from_pchan(const bPoseChannel *pchan,
1707                                                BoneParentTransform *r_bpt)
1708 {
1709   const Bone *bone, *parbone;
1710   const bPoseChannel *parchan;
1711
1712   /* set up variables for quicker access below */
1713   bone = pchan->bone;
1714   parbone = bone->parent;
1715   parchan = pchan->parent;
1716
1717   if (parchan) {
1718     float offs_bone[4][4];
1719     /* yoffs(b-1) + root(b) + bonemat(b). */
1720     BKE_bone_offset_matrix_get(bone, offs_bone);
1721
1722     BKE_bone_parent_transform_calc_from_matrices(
1723         bone->flag, offs_bone, parbone->arm_mat, parchan->pose_mat, r_bpt);
1724   }
1725   else {
1726     BKE_bone_parent_transform_calc_from_matrices(bone->flag, bone->arm_mat, NULL, NULL, r_bpt);
1727   }
1728 }
1729
1730 /* Compute the parent transform using data decoupled from specific data structures.
1731  *
1732  * bone_flag: Bone->flag containing settings
1733  * offs_bone: delta from parent to current arm_mat (or just arm_mat if no parent)
1734  * parent_arm_mat, parent_pose_mat: arm_mat and pose_mat of parent, or NULL
1735  * r_bpt: OUTPUT parent transform */
1736 void BKE_bone_parent_transform_calc_from_matrices(int bone_flag,
1737                                                   const float offs_bone[4][4],
1738                                                   const float parent_arm_mat[4][4],
1739                                                   const float parent_pose_mat[4][4],
1740                                                   BoneParentTransform *r_bpt)
1741 {
1742   if (parent_pose_mat) {
1743     /* Compose the rotscale matrix for this bone. */
1744     if ((bone_flag & BONE_HINGE) && (bone_flag & BONE_NO_SCALE)) {
1745       /* Parent rest rotation and scale. */
1746       mul_m4_m4m4(r_bpt->rotscale_mat, parent_arm_mat, offs_bone);
1747     }
1748     else if (bone_flag & BONE_HINGE) {
1749       /* Parent rest rotation and pose scale. */
1750       float tmat[4][4], tscale[3];
1751
1752       /* Extract the scale of the parent pose matrix. */
1753       mat4_to_size(tscale, parent_pose_mat);
1754       size_to_mat4(tmat, tscale);
1755
1756       /* Applies the parent pose scale to the rest matrix. */
1757       mul_m4_m4m4(tmat, tmat, parent_arm_mat);
1758
1759       mul_m4_m4m4(r_bpt->rotscale_mat, tmat, offs_bone);
1760     }
1761     else if (bone_flag & BONE_NO_SCALE) {
1762       /* Parent pose rotation and rest scale (i.e. no scaling). */
1763       float tmat[4][4];
1764       copy_m4_m4(tmat, parent_pose_mat);
1765       normalize_m4(tmat);
1766       mul_m4_m4m4(r_bpt->rotscale_mat, tmat, offs_bone);
1767     }
1768     else {
1769       mul_m4_m4m4(r_bpt->rotscale_mat, parent_pose_mat, offs_bone);
1770     }
1771
1772     /* Compose the loc matrix for this bone. */
1773     /* NOTE: That version does not modify bone's loc when HINGE/NO_SCALE options are set. */
1774
1775     /* In this case, use the object's space *orientation*. */
1776     if (bone_flag & BONE_NO_LOCAL_LOCATION) {
1777       /* XXX I'm sure that code can be simplified! */
1778       float bone_loc[4][4], bone_rotscale[3][3], tmat4[4][4], tmat3[3][3];
1779       unit_m4(bone_loc);
1780       unit_m4(r_bpt->loc_mat);
1781       unit_m4(tmat4);
1782
1783       mul_v3_m4v3(bone_loc[3], parent_pose_mat, offs_bone[3]);
1784
1785       unit_m3(bone_rotscale);
1786       copy_m3_m4(tmat3, parent_pose_mat);
1787       mul_m3_m3m3(bone_rotscale, tmat3, bone_rotscale);
1788
1789       copy_m4_m3(tmat4, bone_rotscale);
1790       mul_m4_m4m4(r_bpt->loc_mat, bone_loc, tmat4);
1791     }
1792     /* Those flags do not affect position, use plain parent transform space! */
1793     else if (bone_flag & (BONE_HINGE | BONE_NO_SCALE)) {
1794       mul_m4_m4m4(r_bpt->loc_mat, parent_pose_mat, offs_bone);
1795     }
1796     /* Else (i.e. default, usual case),
1797      * just use the same matrix for rotation/scaling, and location. */
1798     else {
1799       copy_m4_m4(r_bpt->loc_mat, r_bpt->rotscale_mat);
1800     }
1801   }
1802   /* Root bones. */
1803   else {
1804     /* Rotation/scaling. */
1805     copy_m4_m4(r_bpt->rotscale_mat, offs_bone);
1806     /* Translation. */
1807     if (bone_flag & BONE_NO_LOCAL_LOCATION) {
1808       /* Translation of arm_mat, without the rotation. */
1809       unit_m4(r_bpt->loc_mat);
1810       copy_v3_v3(r_bpt->loc_mat[3], offs_bone[3]);
1811     }
1812     else {
1813       copy_m4_m4(r_bpt->loc_mat, r_bpt->rotscale_mat);
1814     }
1815   }
1816 }
1817
1818 void BKE_bone_parent_transform_clear(struct BoneParentTransform *bpt)
1819 {
1820   unit_m4(bpt->rotscale_mat);
1821   unit_m4(bpt->loc_mat);
1822 }
1823
1824 void BKE_bone_parent_transform_invert(struct BoneParentTransform *bpt)
1825 {
1826   invert_m4(bpt->rotscale_mat);
1827   invert_m4(bpt->loc_mat);
1828 }
1829
1830 void BKE_bone_parent_transform_combine(const struct BoneParentTransform *in1,
1831                                        const struct BoneParentTransform *in2,
1832                                        struct BoneParentTransform *result)
1833 {
1834   mul_m4_m4m4(result->rotscale_mat, in1->rotscale_mat, in2->rotscale_mat);
1835   mul_m4_m4m4(result->loc_mat, in1->loc_mat, in2->loc_mat);
1836 }
1837
1838 void BKE_bone_parent_transform_apply(const struct BoneParentTransform *bpt,
1839                                      const float inmat[4][4],
1840                                      float outmat[4][4])
1841 {
1842   /* in case inmat == outmat */
1843   float tmploc[3];
1844   copy_v3_v3(tmploc, inmat[3]);
1845
1846   mul_m4_m4m4(outmat, bpt->rotscale_mat, inmat);
1847   mul_v3_m4v3(outmat[3], bpt->loc_mat, tmploc);
1848 }
1849
1850 /* Convert Pose-Space Matrix to Bone-Space Matrix.
1851  * NOTE: this cannot be used to convert to pose-space transforms of the supplied
1852  *       pose-channel into its local space (i.e. 'visual'-keyframing) */
1853 void BKE_armature_mat_pose_to_bone(bPoseChannel *pchan, float inmat[4][4], float outmat[4][4])
1854 {
1855   BoneParentTransform bpt;
1856
1857   BKE_bone_parent_transform_calc_from_pchan(pchan, &bpt);
1858   BKE_bone_parent_transform_invert(&bpt);
1859   BKE_bone_parent_transform_apply(&bpt, inmat, outmat);
1860 }
1861
1862 /* Convert Bone-Space Matrix to Pose-Space Matrix. */
1863 void BKE_armature_mat_bone_to_pose(bPoseChannel *pchan, float inmat[4][4], float outmat[4][4])
1864 {
1865   BoneParentTransform bpt;
1866
1867   BKE_bone_parent_transform_calc_from_pchan(pchan, &bpt);
1868   BKE_bone_parent_transform_apply(&bpt, inmat, outmat);
1869 }
1870
1871 /* Convert Pose-Space Location to Bone-Space Location
1872  * NOTE: this cannot be used to convert to pose-space location of the supplied
1873  *       pose-channel into its local space (i.e. 'visual'-keyframing) */
1874 void BKE_armature_loc_pose_to_bone(bPoseChannel *pchan, const float inloc[3], float outloc[3])
1875 {
1876   float xLocMat[4][4];
1877   float nLocMat[4][4];
1878
1879   /* build matrix for location */
1880   unit_m4(xLocMat);
1881   copy_v3_v3(xLocMat[3], inloc);
1882
1883   /* get bone-space cursor matrix and extract location */
1884   BKE_armature_mat_pose_to_bone(pchan, xLocMat, nLocMat);
1885   copy_v3_v3(outloc, nLocMat[3]);
1886 }
1887
1888 void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph,
1889                                       Object *ob,
1890                                       bPoseChannel *pchan,
1891                                       float inmat[4][4],
1892                                       float outmat[4][4])
1893 {
1894   bPoseChannel work_pchan = *pchan;
1895
1896   /* recalculate pose matrix with only parent transformations,
1897    * bone loc/sca/rot is ignored, scene and frame are not used. */
1898   BKE_pose_where_is_bone(depsgraph, NULL, ob, &work_pchan, 0.0f, false);
1899
1900   /* find the matrix, need to remove the bone transforms first so this is
1901    * calculated as a matrix to set rather then a difference ontop of what's
1902    * already there. */
1903   unit_m4(outmat);
1904   BKE_pchan_apply_mat4(&work_pchan, outmat, false);
1905
1906   BKE_armature_mat_pose_to_bone(&work_pchan, inmat, outmat);
1907 }
1908
1909 /**
1910  * Same as #BKE_object_mat3_to_rot().
1911  */
1912 void BKE_pchan_mat3_to_rot(bPoseChannel *pchan, float mat[3][3], bool use_compat)
1913 {
1914   BLI_ASSERT_UNIT_M3(mat);
1915
1916   switch (pchan->rotmode) {
1917     case ROT_MODE_QUAT:
1918       mat3_normalized_to_quat(pchan->quat, mat);
1919       break;
1920     case ROT_MODE_AXISANGLE:
1921       mat3_normalized_to_axis_angle(pchan->rotAxis, &pchan->rotAngle, mat);
1922       break;
1923     default: /* euler */
1924       if (use_compat) {
1925         mat3_normalized_to_compatible_eulO(pchan->eul, pchan->eul, pchan->rotmode, mat);
1926       }
1927       else {
1928         mat3_normalized_to_eulO(pchan->eul, pchan->rotmode, mat);
1929       }
1930       break;
1931   }
1932 }
1933
1934 /**
1935  * Same as #BKE_object_rot_to_mat3().
1936  */
1937 void BKE_pchan_rot_to_mat3(const bPoseChannel *pchan, float mat[3][3])
1938 {
1939   /* rotations may either be quats, eulers (with various rotation orders), or axis-angle */
1940   if (pchan->rotmode > 0) {
1941     /* euler rotations (will cause gimble lock,
1942      * but this can be alleviated a bit with rotation orders) */
1943     eulO_to_mat3(mat, pchan->eul, pchan->rotmode);
1944   }
1945   else if (pchan->rotmode == ROT_MODE_AXISANGLE) {
1946     /* axis-angle - not really that great for 3D-changing orientations */
1947     axis_angle_to_mat3(mat, pchan->rotAxis, pchan->rotAngle);
1948   }
1949   else {
1950     /* quats are normalized before use to eliminate scaling issues */
1951     float quat[4];
1952
1953     /* NOTE: we now don't normalize the stored values anymore,
1954      * since this was kindof evil in some cases but if this proves to be too problematic,
1955      * switch back to the old system of operating directly on the stored copy. */
1956     normalize_qt_qt(quat, pchan->quat);
1957     quat_to_mat3(mat, quat);
1958   }
1959 }
1960
1961 /**
1962  * Apply a 4x4 matrix to the pose bone,
1963  * similar to #BKE_object_apply_mat4().
1964  */
1965 void BKE_pchan_apply_mat4(bPoseChannel *pchan, float mat[4][4], bool use_compat)
1966 {
1967   float rot[3][3];
1968   mat4_to_loc_rot_size(pchan->loc, rot, pchan->size, mat);
1969   BKE_pchan_mat3_to_rot(pchan, rot, use_compat);
1970 }
1971
1972 /**
1973  * Remove rest-position effects from pose-transform for obtaining
1974  * 'visual' transformation of pose-channel.
1975  * (used by the Visual-Keyframing stuff).
1976  */
1977 void BKE_armature_mat_pose_to_delta(float delta_mat[4][4],
1978                                     float pose_mat[4][4],
1979                                     float arm_mat[4][4])
1980 {
1981   float imat[4][4];
1982
1983   invert_m4_m4(imat, arm_mat);
1984   mul_m4_m4m4(delta_mat, imat, pose_mat);
1985 }
1986
1987 /* **************** Rotation Mode Conversions ****************************** */
1988 /* Used for Objects and Pose Channels, since both can have multiple rotation representations */
1989
1990 /* Called from RNA when rotation mode changes
1991  * - the result should be that the rotations given in the provided pointers have had conversions
1992  *   applied (as appropriate), such that the rotation of the element hasn't 'visually' changed  */
1993 void BKE_rotMode_change_values(
1994     float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode)
1995 {
1996   /* check if any change - if so, need to convert data */
1997   if (newMode > 0) { /* to euler */
1998     if (oldMode == ROT_MODE_AXISANGLE) {
1999       /* axis-angle to euler */
2000       axis_angle_to_eulO(eul, newMode, axis, *angle);
2001     }
2002     else if (oldMode == ROT_MODE_QUAT) {
2003       /* quat to euler */
2004       normalize_qt(quat);
2005       quat_to_eulO(eul, newMode, quat);
2006     }
2007     /* else { no conversion needed } */
2008   }
2009   else if (newMode == ROT_MODE_QUAT) { /* to quat */
2010     if (oldMode == ROT_MODE_AXISANGLE) {
2011       /* axis angle to quat */
2012       axis_angle_to_quat(quat, axis, *angle);
2013     }
2014     else if (oldMode > 0) {
2015       /* euler to quat */
2016       eulO_to_quat(quat, eul, oldMode);
2017     }
2018     /* else { no conversion needed } */
2019   }
2020   else if (newMode == ROT_MODE_AXISANGLE) { /* to axis-angle */
2021     if (oldMode > 0) {
2022       /* euler to axis angle */
2023       eulO_to_axis_angle(axis, angle, eul, oldMode);
2024     }
2025     else if (oldMode == ROT_MODE_QUAT) {
2026       /* quat to axis angle */
2027       normalize_qt(quat);
2028       quat_to_axis_angle(axis, angle, quat);
2029     }
2030
2031     /* When converting to axis-angle,
2032      * we need a special exception for the case when there is no axis. */
2033     if (IS_EQF(axis[0], axis[1]) && IS_EQF(axis[1], axis[2])) {
2034       /* for now, rotate around y-axis then (so that it simply becomes the roll) */
2035       axis[1] = 1.0f;
2036     }
2037   }
2038 }
2039
2040 /* **************** The new & simple (but OK!) armature evaluation ********* */
2041
2042 /* ****************** And how it works! ****************************************
2043  *
2044  * This is the bone transformation trick; they're hierarchical so each bone(b)
2045  * is in the coord system of bone(b-1):
2046  *
2047  * arm_mat(b)= arm_mat(b-1) * yoffs(b-1) * d_root(b) * bone_mat(b)
2048  *
2049  * -> yoffs is just the y axis translation in parent's coord system
2050  * -> d_root is the translation of the bone root, also in parent's coord system
2051  *
2052  * pose_mat(b)= pose_mat(b-1) * yoffs(b-1) * d_root(b) * bone_mat(b) * chan_mat(b)
2053  *
2054  * we then - in init deform - store the deform in chan_mat, such that:
2055  *
2056  * pose_mat(b)= arm_mat(b) * chan_mat(b)
2057  *
2058  * *************************************************************************** */
2059
2060 /* Computes vector and roll based on a rotation.
2061  * "mat" must contain only a rotation, and no scaling. */
2062 void mat3_to_vec_roll(const float mat[3][3], float r_vec[3], float *r_roll)
2063 {
2064   if (r_vec) {
2065     copy_v3_v3(r_vec, mat[1]);
2066   }
2067
2068   if (r_roll) {
2069     mat3_vec_to_roll(mat, mat[1], r_roll);
2070   }
2071 }
2072
2073 /* Computes roll around the vector that best approximates the matrix.
2074  * If vec is the Y vector from purely rotational mat, result should be exact. */
2075 void mat3_vec_to_roll(const float mat[3][3], const float vec[3], float *r_roll)
2076 {
2077   float vecmat[3][3], vecmatinv[3][3], rollmat[3][3];
2078
2079   vec_roll_to_mat3(vec, 0.0f, vecmat);
2080   invert_m3_m3(vecmatinv, vecmat);
2081   mul_m3_m3m3(rollmat, vecmatinv, mat);
2082
2083   *r_roll = atan2f(rollmat[2][0], rollmat[2][2]);
2084 }
2085
2086 /* Calculates the rest matrix of a bone based on its vector and a roll around that vector. */
2087 /**
2088  * Given `v = (v.x, v.y, v.z)` our (normalized) bone vector, we want the rotation matrix M
2089  * from the Y axis (so that `M * (0, 1, 0) = v`).
2090  * - The rotation axis a lays on XZ plane, and it is orthonormal to v,
2091  *   hence to the projection of v onto XZ plane.
2092  * - `a = (v.z, 0, -v.x)`
2093  *
2094  * We know a is eigenvector of M (so M * a = a).
2095  * Finally, we have w, such that M * w = (0, 1, 0)
2096  * (i.e. the vector that will be aligned with Y axis once transformed).
2097  * We know w is symmetric to v by the Y axis.
2098  * - `w = (-v.x, v.y, -v.z)`
2099  *
2100  * Solving this, we get (x, y and z being the components of v):
2101  * <pre>
2102  *     ┌ (x^2 * y + z^2) / (x^2 + z^2),   x,   x * z * (y - 1) / (x^2 + z^2) ┐
2103  * M = │  x * (y^2 - 1)  / (x^2 + z^2),   y,    z * (y^2 - 1)  / (x^2 + z^2) │
2104  *     └ x * z * (y - 1) / (x^2 + z^2),   z,   (x^2 + z^2 * y) / (x^2 + z^2) ┘
2105  * </pre>
2106  *
2107  * This is stable as long as v (the bone) is not too much aligned with +/-Y
2108  * (i.e. x and z components are not too close to 0).
2109  *
2110  * Since v is normalized, we have `x^2 + y^2 + z^2 = 1`,
2111  * hence `x^2 + z^2 = 1 - y^2 = (1 - y)(1 + y)`.
2112  *
2113  * This allows to simplifies M like this:
2114  * <pre>
2115  *     ┌ 1 - x^2 / (1 + y),   x,     -x * z / (1 + y) ┐
2116  * M = │                -x,   y,                   -z │
2117  *     └  -x * z / (1 + y),   z,    1 - z^2 / (1 + y) ┘
2118  * </pre>
2119  *
2120  * Written this way, we see the case v = +Y is no more a singularity.
2121  * The only one
2122  * remaining is the bone being aligned with -Y.
2123  *
2124  * Let's handle
2125  * the asymptotic behavior when bone vector is reaching the limit of y = -1.
2126  * Each of the four corner elements can vary from -1 to 1,
2127  * depending on the axis a chosen for doing the rotation.
2128  * And the "rotation" here is in fact established by mirroring XZ plane by that given axis,
2129  * then inversing the Y-axis.
2130  * For sufficiently small x and z, and with y approaching -1,
2131  * all elements but the four corner ones of M will degenerate.
2132  * So let's now focus on these corner elements.
2133  *
2134  * We rewrite M so that it only contains its four corner elements,
2135  * and combine the `1 / (1 + y)` factor:
2136  * <pre>
2137  *                    ┌ 1 + y - x^2,        -x * z ┐
2138  * M* = 1 / (1 + y) * │                            │
2139  *                    └      -x * z,   1 + y - z^2 ┘
2140  * </pre>
2141  *
2142  * When y is close to -1, computing 1 / (1 + y) will cause severe numerical instability,
2143  * so we ignore it and normalize M instead.
2144  * We know `y^2 = 1 - (x^2 + z^2)`, and `y < 0`, hence `y = -sqrt(1 - (x^2 + z^2))`.
2145  *
2146  * Since x and z are both close to 0, we apply the binomial expansion to the first order:
2147  * `y = -sqrt(1 - (x^2 + z^2)) = -1 + (x^2 + z^2) / 2`. Which gives:
2148  * <pre>
2149  *                        ┌  z^2 - x^2,  -2 * x * z ┐
2150  * M* = 1 / (x^2 + z^2) * │                         │
2151  *                        └ -2 * x * z,   x^2 - z^2 ┘
2152  * </pre>
2153  */
2154 void vec_roll_to_mat3_normalized(const float nor[3], const float roll, float mat[3][3])
2155 {
2156 #define THETA_THRESHOLD_NEGY 1.0e-9f
2157 #define THETA_THRESHOLD_NEGY_CLOSE 1.0e-5f
2158
2159   float theta;
2160   float rMatrix[3][3], bMatrix[3][3];
2161
2162   BLI_ASSERT_UNIT_V3(nor);
2163
2164   theta = 1.0f + nor[1];
2165
2166   /* With old algo, 1.0e-13f caused T23954 and T31333, 1.0e-6f caused T27675 and T30438,
2167    * so using 1.0e-9f as best compromise.
2168    *
2169    * New algo is supposed much more precise, since less complex computations are performed,
2170    * but it uses two different threshold values...
2171    *
2172    * Note: When theta is close to zero, we have to check we do have non-null X/Z components as well
2173    *       (due to float precision errors, we can have nor = (0.0, 0.99999994, 0.0)...).
2174    */
2175   if (theta > THETA_THRESHOLD_NEGY_CLOSE || ((nor[0] || nor[2]) && theta > THETA_THRESHOLD_NEGY)) {
2176     /* nor is *not* -Y.
2177      * We got these values for free... so be happy with it... ;)
2178      */
2179     bMatrix[0][1] = -nor[0];
2180     bMatrix[1][0] = nor[0];
2181     bMatrix[1][1] = nor[1];
2182     bMatrix[1][2] = nor[2];
2183     bMatrix[2][1] = -nor[2];
2184     if (theta > THETA_THRESHOLD_NEGY_CLOSE) {
2185       /* If nor is far enough from -Y, apply the general case. */
2186       bMatrix[0][0] = 1 - nor[0] * nor[0] / theta;
2187       bMatrix[2][2] = 1 - nor[2] * nor[2] / theta;
2188       bMatrix[2][0] = bMatrix[0][2] = -nor[0] * nor[2] / theta;
2189     }
2190     else {
2191       /* If nor is too close to -Y, apply the special case. */
2192       theta = nor[0] * nor[0] + nor[2] * nor[2];
2193       bMatrix[0][0] = (nor[0] + nor[2]) * (nor[0] - nor[2]) / -theta;
2194       bMatrix[2][2] = -bMatrix[0][0];
2195       bMatrix[2][0] = bMatrix[0][2] = 2.0f * nor[0] * nor[2] / theta;
2196     }
2197   }
2198   else {
2199     /* If nor is -Y, simple symmetry by Z axis. */
2200     unit_m3(bMatrix);
2201     bMatrix[0][0] = bMatrix[1][1] = -1.0;
2202   }
2203
2204   /* Make Roll matrix */
2205   axis_angle_normalized_to_mat3(rMatrix, nor, roll);
2206
2207   /* Combine and output result */
2208   mul_m3_m3m3(mat, rMatrix, bMatrix);
2209
2210 #undef THETA_THRESHOLD_NEGY
2211 #undef THETA_THRESHOLD_NEGY_CLOSE
2212 }
2213
2214 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3])
2215 {
2216   float nor[3];
2217
2218   normalize_v3_v3(nor, vec);
2219   vec_roll_to_mat3_normalized(nor, roll, mat);
2220 }
2221
2222 /* recursive part, calculates restposition of entire tree of children */
2223 /* used by exiting editmode too */
2224 void BKE_armature_where_is_bone(Bone *bone, Bone *prevbone, const bool use_recursion)
2225 {
2226   float vec[3];
2227
2228   /* Bone Space */
2229   sub_v3_v3v3(vec, bone->tail, bone->head);
2230   bone->length = len_v3(vec);
2231   vec_roll_to_mat3(vec, bone->roll, bone->bone_mat);
2232
2233   /* this is called on old file reading too... */
2234   if (bone->xwidth == 0.0f) {
2235     bone->xwidth = 0.1f;
2236     bone->zwidth = 0.1f;
2237     bone->segments = 1;
2238   }
2239
2240   if (prevbone) {
2241     float offs_bone[4][4];
2242     /* yoffs(b-1) + root(b) + bonemat(b) */
2243     BKE_bone_offset_matrix_get(bone, offs_bone);
2244
2245     /* Compose the matrix for this bone  */
2246     mul_m4_m4m4(bone->arm_mat, prevbone->arm_mat, offs_bone);
2247   }
2248   else {
2249     copy_m4_m3(bone->arm_mat, bone->bone_mat);
2250     copy_v3_v3(bone->arm_mat[3], bone->head);
2251   }
2252
2253   /* and the kiddies */
2254   if (use_recursion) {
2255     prevbone = bone;
2256     for (bone = bone->childbase.first; bone; bone = bone->next) {
2257       BKE_armature_where_is_bone(bone, prevbone, use_recursion);
2258     }
2259   }
2260 }
2261
2262 /* updates vectors and matrices on rest-position level, only needed
2263  * after editing armature itself, now only on reading file */
2264 void BKE_armature_where_is(bArmature *arm)
2265 {
2266   Bone *bone;
2267
2268   /* hierarchical from root to children */
2269   for (bone = arm->bonebase.first; bone; bone = bone->next) {
2270     BKE_armature_where_is_bone(bone, NULL, true);
2271   }
2272 }
2273
2274 /* if bone layer is protected, copy the data from from->pose
2275  * when used with linked libraries this copies from the linked pose into the local pose */
2276 static void pose_proxy_synchronize(Object *ob, Object *from, int layer_protected)
2277 {
2278   bPose *pose = ob->pose, *frompose = from->pose;
2279   bPoseChannel *pchan, *pchanp;
2280   bConstraint *con;
2281   int error = 0;
2282
2283   if (frompose == NULL) {
2284     return;
2285   }
2286
2287   /* in some cases when rigs change, we cant synchronize
2288    * to avoid crashing check for possible errors here */
2289   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
2290     if (pchan->bone->layer & layer_protected) {
2291       if (BKE_pose_channel_find_name(frompose, pchan->name) == NULL) {
2292         CLOG_ERROR(&LOG,
2293                    "failed to sync proxy armature because '%s' is missing pose channel '%s'",
2294                    from->id.name,
2295                    pchan->name);
2296         error = 1;
2297       }
2298     }
2299   }
2300
2301   if (error) {
2302     return;
2303   }
2304
2305   /* clear all transformation values from library */
2306   BKE_pose_rest(frompose);
2307
2308   /* copy over all of the proxy's bone groups */
2309   /* TODO for later
2310    * - implement 'local' bone groups as for constraints
2311    * Note: this isn't trivial, as bones reference groups by index not by pointer,
2312    *       so syncing things correctly needs careful attention */
2313   BLI_freelistN(&pose->agroups);
2314   BLI_duplicatelist(&pose->agroups, &frompose->agroups);
2315   pose->active_group = frompose->active_group;
2316
2317   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
2318     pchanp = BKE_pose_channel_find_name(frompose, pchan->name);
2319
2320     if (UNLIKELY(pchanp == NULL)) {
2321       /* happens for proxies that become invalid because of a missing link
2322        * for regular cases it shouldn't happen at all */
2323     }
2324     else if (pchan->bone->layer & layer_protected) {
2325       ListBase proxylocal_constraints = {NULL, NULL};
2326       bPoseChannel pchanw;
2327
2328       /* copy posechannel to temp, but restore important pointers */
2329       pchanw = *pchanp;
2330       pchanw.bone = pchan->bone;
2331       pchanw.prev = pchan->prev;
2332       pchanw.next = pchan->next;
2333       pchanw.parent = pchan->parent;
2334       pchanw.child = pchan->child;
2335       pchanw.custom_tx = pchan->custom_tx;
2336       pchanw.bbone_prev = pchan->bbone_prev;
2337       pchanw.bbone_next = pchan->bbone_next;
2338
2339       pchanw.mpath = pchan->mpath;
2340       pchan->mpath = NULL;
2341
2342       /* this is freed so copy a copy, else undo crashes */
2343       if (pchanw.prop) {
2344         pchanw.prop = IDP_CopyProperty(pchanw.prop);
2345
2346         /* use the values from the existing props */
2347         if (pchan->prop) {
2348           IDP_SyncGroupValues(pchanw.prop, pchan->prop);
2349         }
2350       }
2351
2352       /* Constraints - proxy constraints are flushed... local ones are added after
2353        * 1: extract constraints not from proxy (CONSTRAINT_PROXY_LOCAL) from pchan's constraints.
2354        * 2: copy proxy-pchan's constraints on-to new.
2355        * 3: add extracted local constraints back on top.
2356        *
2357        * Note for BKE_constraints_copy:
2358        * When copying constraints, disable 'do_extern' otherwise
2359        * we get the libs direct linked in this blend.
2360        */
2361       BKE_constraints_proxylocal_extract(&proxylocal_constraints, &pchan->constraints);
2362       BKE_constraints_copy(&pchanw.constraints, &pchanp->constraints, false);
2363       BLI_movelisttolist(&pchanw.constraints, &proxylocal_constraints);
2364
2365       /* constraints - set target ob pointer to own object */
2366       for (con = pchanw.constraints.first; con; con = con->next) {
2367         const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
2368         ListBase targets = {NULL, NULL};
2369         bConstraintTarget *ct;
2370
2371         if (cti && cti->get_constraint_targets) {
2372           cti->get_constraint_targets(con, &targets);
2373
2374           for (ct = targets.first; ct; ct = ct->next) {
2375             if (ct->tar == from) {
2376               ct->tar = ob;
2377             }
2378           }
2379
2380           if (cti->flush_constraint_targets) {
2381             cti->flush_constraint_targets(con, &targets, 0);
2382           }
2383         }
2384       }
2385
2386       /* free stuff from current channel */
2387       BKE_pose_channel_free(pchan);
2388
2389       /* copy data in temp back over to the cleaned-out (but still allocated) original channel */
2390       *pchan = pchanw;
2391       if (pchan->custom) {
2392         id_us_plus(&pchan->custom->id);
2393       }
2394     }
2395     else {
2396       /* always copy custom shape */
2397       pchan->custom = pchanp->custom;
2398       if (pchan->custom) {
2399         id_us_plus(&pchan->custom->id);
2400       }
2401       if (pchanp->custom_tx) {
2402         pchan->custom_tx = BKE_pose_channel_find_name(pose, pchanp->custom_tx->name);
2403       }
2404
2405       /* ID-Property Syncing */
2406       {
2407         IDProperty *prop_orig = pchan->prop;
2408         if (pchanp->prop) {
2409           pchan->prop = IDP_CopyProperty(pchanp->prop);
2410           if (prop_orig) {
2411             /* copy existing values across when types match */
2412             IDP_SyncGroupValues(pchan->prop, prop_orig);
2413           }
2414         }
2415         else {
2416           pchan->prop = NULL;
2417         }
2418         if (prop_orig) {
2419           IDP_FreeProperty(prop_orig);
2420           MEM_freeN(prop_orig);
2421         }
2422       }
2423     }
2424   }
2425 }
2426
2427 static int rebuild_pose_bone(bPose *pose, Bone *bone, bPoseChannel *parchan, int counter)
2428 {
2429   bPoseChannel *pchan = BKE_pose_channel_verify(pose, bone->name); /* verify checks and/or adds */
2430
2431   pchan->bone = bone;
2432   pchan->parent = parchan;
2433
2434   counter++;
2435
2436   for (bone = bone->childbase.first; bone; bone = bone->next) {
2437     counter = rebuild_pose_bone(pose, bone, pchan, counter);
2438     /* for quick detecting of next bone in chain, only b-bone uses it now */
2439     if (bone->flag & BONE_CONNECTED) {
2440       pchan->child = BKE_pose_channel_find_name(pose, bone->name);
2441     }
2442   }
2443
2444   return counter;
2445 }
2446
2447 /**
2448  * Clear pointers of object's pose
2449  * (needed in remap case, since we cannot always wait for a complete pose rebuild).
2450  */
2451 void BKE_pose_clear_pointers(bPose *pose)
2452 {
2453   for (bPoseChannel *pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
2454     pchan->bone = NULL;
2455     pchan->child = NULL;
2456   }
2457 }
2458
2459 void BKE_pose_remap_bone_pointers(bArmature *armature, bPose *pose)
2460 {
2461   GHash *bone_hash = BKE_armature_bone_from_name_map(armature);
2462   for (bPoseChannel *pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
2463     pchan->bone = BLI_ghash_lookup(bone_hash, pchan->name);
2464   }
2465   BLI_ghash_free(bone_hash, NULL, NULL);
2466 }
2467
2468 /** Find the matching pose channel using the bone name, if not NULL. */
2469 static bPoseChannel *pose_channel_find_bone(bPose *pose, Bone *bone)
2470 {
2471   return (bone != NULL) ? BKE_pose_channel_find_name(pose, bone->name) : NULL;
2472 }
2473
2474 /** Update the links for the B-Bone handles from Bone data. */
2475 void BKE_pchan_rebuild_bbone_handles(bPose *pose, bPoseChannel *pchan)
2476 {
2477   pchan->bbone_prev = pose_channel_find_bone(pose, pchan->bone->bbone_prev);
2478   pchan->bbone_next = pose_channel_find_bone(pose, pchan->bone->bbone_next);
2479 }
2480
2481 /**
2482  * Only after leave editmode, duplicating, validating older files, library syncing.
2483  *
2484  * \note pose->flag is set for it.
2485  *
2486  * \param bmain: May be NULL, only used to tag depsgraph as being dirty...
2487  */
2488 void BKE_pose_rebuild(Main *bmain, Object *ob, bArmature *arm, const bool do_id_user)
2489 {
2490   Bone *bone;
2491   bPose *pose;
2492   bPoseChannel *pchan, *next;
2493   int counter = 0;
2494
2495   /* only done here */
2496   if (ob->pose == NULL) {
2497     /* create new pose */
2498     ob->pose = MEM_callocN(sizeof(bPose), "new pose");
2499
2500     /* set default settings for animviz */
2501     animviz_settings_init(&ob->pose->avs);
2502   }
2503   pose = ob->pose;
2504
2505   /* clear */
2506   BKE_pose_clear_pointers(pose);
2507
2508   /* first step, check if all channels are there */
2509   for (bone = arm->bonebase.first; bone; bone = bone->next) {
2510     counter = rebuild_pose_bone(pose, bone, NULL, counter);
2511   }
2512
2513   /* and a check for garbage */
2514   for (pchan = pose->chanbase.first; pchan; pchan = next) {
2515     next = pchan->next;
2516     if (pchan->bone == NULL) {
2517       BKE_pose_channel_free_ex(pchan, do_id_user);
2518       BKE_pose_channels_hash_free(pose);
2519       BLI_freelinkN(&pose->chanbase, pchan);
2520     }
2521   }
2522
2523   BKE_pose_channels_hash_make(pose);
2524
2525   for (pchan = pose->chanbase.first; pchan; pchan = pchan->next) {
2526     /* Find the custom B-Bone handles. */
2527     BKE_pchan_rebuild_bbone_handles(pose, pchan);
2528   }
2529
2530   /* printf("rebuild pose %s, %d bones\n", ob->id.name, counter); */
2531
2532   /* synchronize protected layers with proxy */
2533   /* HACK! To preserve 2.7x behavior that you always can pose even locked bones,
2534    * do not do any restoration if this is a COW temp copy! */
2535   /* Switched back to just NO_MAIN tag, for some reasons (c)
2536    * using COW tag was working this morning, but not anymore... */
2537   if (ob->proxy != NULL && (ob->id.tag & LIB_TAG_NO_MAIN) == 0) {
2538     BKE_object_copy_proxy_drivers(ob, ob->proxy);
2539     pose_proxy_synchronize(ob, ob->proxy, arm->layer_protected);
2540   }
2541
2542   BKE_pose_update_constraint_flags(pose); /* for IK detection for example */
2543
2544   pose->flag &= ~POSE_RECALC;
2545   pose->flag |= POSE_WAS_REBUILT;
2546
2547   /* Rebuilding poses forces us to also rebuild the dependency graph,
2548    * since there is one node per pose/bone. */
2549   if (bmain != NULL) {
2550     DEG_relations_tag_update(bmain);
2551   }
2552 }
2553
2554 /* ********************** THE POSE SOLVER ******************* */
2555
2556 /* loc/rot/size to given mat4 */
2557 void BKE_pchan_to_mat4(const bPoseChannel *pchan, float chan_mat[4][4])
2558 {
2559   float smat[3][3];
2560   float rmat[3][3];
2561   float tmat[3][3];
2562
2563   /* get scaling matrix */
2564   size_to_mat3(smat, pchan->size);
2565
2566   /* get rotation matrix */
2567   BKE_pchan_rot_to_mat3(pchan, rmat);
2568
2569   /* calculate matrix of bone (as 3x3 matrix, but then copy the 4x4) */
2570   mul_m3_m3m3(tmat, rmat, smat);
2571   copy_m4_m3(chan_mat, tmat);
2572
2573   /* prevent action channels breaking chains */
2574   /* need to check for bone here, CONSTRAINT_TYPE_ACTION uses this call */
2575   if ((pchan->bone == NULL) || !(pchan->bone->flag & BONE_CONNECTED)) {
2576     copy_v3_v3(chan_mat[3], pchan->loc);
2577   }
2578 }
2579
2580 /* loc/rot/size to mat4 */
2581 /* used in constraint.c too */
2582 void BKE_pchan_calc_mat(bPoseChannel *pchan)
2583 {
2584   /* this is just a wrapper around the copy of this function which calculates the matrix
2585    * and stores the result in any given channel
2586    */
2587   BKE_pchan_to_mat4(pchan, pchan->chan_mat);
2588 }
2589
2590 /* calculate tail of posechannel */
2591 void BKE_pose_where_is_bone_tail(bPoseChannel *pchan)
2592 {
2593   float vec[3];
2594
2595   copy_v3_v3(vec, pchan->pose_mat[1]);
2596   mul_v3_fl(vec, pchan->bone->length);
2597   add_v3_v3v3(pchan->pose_tail, pchan->pose_head, vec);
2598 }
2599
2600 /* The main armature solver, does all constraints excluding IK */
2601 /* pchan is validated, as having bone and parent pointer
2602  * 'do_extra': when zero skips loc/size/rot, constraints and strip modifiers.
2603  */
2604 void BKE_pose_where_is_bone(struct Depsgraph *depsgraph,
2605                             Scene *scene,
2606                             Object *ob,
2607                             bPoseChannel *pchan,
2608                             float ctime,
2609                             bool do_extra)
2610 {
2611   /* This gives a chan_mat with actions (ipos) results. */
2612   if (do_extra) {
2613     BKE_pchan_calc_mat(pchan);
2614   }
2615   else {
2616     unit_m4(pchan->chan_mat);
2617   }
2618
2619   /* Construct the posemat based on PoseChannels, that we do before applying constraints. */
2620   /* pose_mat(b) = pose_mat(b-1) * yoffs(b-1) * d_root(b) * bone_mat(b) * chan_mat(b) */
2621   BKE_armature_mat_bone_to_pose(pchan, pchan->chan_mat, pchan->pose_mat);
2622
2623   /* Only rootbones get the cyclic offset (unless user doesn't want that). */
2624   /* XXX That could be a problem for snapping and other "reverse transform" features... */
2625   if (!pchan->parent) {
2626     if ((pchan->bone->flag & BONE_NO_CYCLICOFFSET) == 0) {
2627       add_v3_v3(pchan->pose_mat[3], ob->pose->cyclic_offset);
2628     }
2629   }
2630
2631   if (do_extra) {
2632     /* Do constraints */
2633     if (pchan->constraints.first) {
2634       bConstraintOb *cob;
2635       float vec[3];
2636
2637       /* make a copy of location of PoseChannel for later */
2638       copy_v3_v3(vec, pchan->pose_mat[3]);
2639
2640       /* prepare PoseChannel for Constraint solving
2641        * - makes a copy of matrix, and creates temporary struct to use
2642        */
2643       cob = BKE_constraints_make_evalob(depsgraph, scene, ob, pchan, CONSTRAINT_OBTYPE_BONE);
2644
2645       /* Solve PoseChannel's Constraints */
2646       BKE_constraints_solve(
2647           depsgraph, &pchan->constraints, cob, ctime); /* ctime doesn't alter objects */
2648
2649       /* cleanup after Constraint Solving
2650        * - applies matrix back to pchan, and frees temporary struct used
2651        */
2652       BKE_constraints_clear_evalob(cob);
2653
2654       /* prevent constraints breaking a chain */
2655       if (pchan->bone->flag & BONE_CONNECTED) {
2656         copy_v3_v3(pchan->pose_mat[3], vec);
2657       }
2658     }
2659   }
2660
2661   /* calculate head */
2662   copy_v3_v3(pchan->pose_head, pchan->pose_mat[3]);
2663   /* calculate tail */
2664   BKE_pose_where_is_bone_tail(pchan);
2665 }
2666
2667 /* This only reads anim data from channels, and writes to channels */
2668 /* This is the only function adding poses */
2669 void BKE_pose_where_is(struct Depsgraph *depsgraph, Scene *scene, Object *ob)
2670 {
2671   bArmature *arm;
2672   Bone *bone;
2673   bPoseChannel *pchan;
2674   float imat[4][4];
2675   float ctime;
2676
2677   if (ob->type != OB_ARMATURE) {
2678     return;
2679   }
2680   arm = ob->data;
2681
2682   if (ELEM(NULL, arm, scene)) {
2683     return;
2684   }
2685   if ((ob->pose == NULL) || (ob->pose->flag & POSE_RECALC)) {
2686     /* WARNING! passing NULL bmain here means we won't tag depsgraph's as dirty -
2687      * hopefully this is OK. */
2688     BKE_pose_rebuild(NULL, ob, arm, true);
2689   }
2690
2691   ctime = BKE_scene_frame_get(scene); /* not accurate... */
2692
2693   /* In editmode or restposition we read the data from the bones */
2694   if (arm->edbo || (arm->flag & ARM_RESTPOS)) {
2695     for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2696       bone = pchan->bone;
2697       if (bone) {
2698         copy_m4_m4(pchan->pose_mat, bone->arm_mat);
2699         copy_v3_v3(pchan->pose_head, bone->arm_head);
2700         copy_v3_v3(pchan->pose_tail, bone->arm_tail);
2701       }
2702     }
2703   }
2704   else {
2705     invert_m4_m4(ob->imat, ob->obmat); /* imat is needed */
2706
2707     /* 1. clear flags */
2708     for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2709       pchan->flag &= ~(POSE_DONE | POSE_CHAIN | POSE_IKTREE | POSE_IKSPLINE);
2710     }
2711
2712     /* 2a. construct the IK tree (standard IK) */
2713     BIK_initialize_tree(depsgraph, scene, ob, ctime);
2714
2715     /* 2b. construct the Spline IK trees
2716      * - this is not integrated as an IK plugin, since it should be able
2717      *   to function in conjunction with standard IK
2718      */
2719     BKE_pose_splineik_init_tree(scene, ob, ctime);
2720
2721     /* 3. the main loop, channels are already hierarchical sorted from root to children */
2722     for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2723       /* 4a. if we find an IK root, we handle it separated */
2724       if (pchan->flag & POSE_IKTREE) {
2725         BIK_execute_tree(depsgraph, scene, ob, pchan, ctime);
2726       }
2727       /* 4b. if we find a Spline IK root, we handle it separated too */
2728       else if (pchan->flag & POSE_IKSPLINE) {
2729         BKE_splineik_execute_tree(depsgraph, scene, ob, pchan, ctime);
2730       }
2731       /* 5. otherwise just call the normal solver */
2732       else if (!(pchan->flag & POSE_DONE)) {
2733         BKE_pose_where_is_bone(depsgraph, scene, ob, pchan, ctime, 1);
2734       }
2735     }
2736     /* 6. release the IK tree */
2737     BIK_release_tree(scene, ob, ctime);
2738   }
2739
2740   /* calculating deform matrices */
2741   for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2742     if (pchan->bone) {
2743       invert_m4_m4(imat, pchan->bone->arm_mat);
2744       mul_m4_m4m4(pchan->chan_mat, pchan->pose_mat, imat);
2745     }
2746   }
2747 }
2748
2749 /************** Bounding box ********************/
2750 static int minmax_armature(Object *ob, float r_min[3], float r_max[3])
2751 {
2752   bPoseChannel *pchan;
2753
2754   /* For now, we assume BKE_pose_where_is has already been called
2755    * (hence we have valid data in pachan). */
2756   for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2757     minmax_v3v3_v3(r_min, r_max, pchan->pose_head);
2758     minmax_v3v3_v3(r_min, r_max, pchan->pose_tail);
2759   }
2760
2761   return (BLI_listbase_is_empty(&ob->pose->chanbase) == false);
2762 }
2763
2764 static void boundbox_armature(Object *ob)
2765 {
2766   BoundBox *bb;
2767   float min[3], max[3];
2768
2769   if (ob->runtime.bb == NULL) {
2770     ob->runtime.bb = MEM_callocN(sizeof(BoundBox), "Armature boundbox");
2771   }
2772   bb = ob->runtime.bb;
2773
2774   INIT_MINMAX(min, max);
2775   if (!minmax_armature(ob, min, max)) {
2776     min[0] = min[1] = min[2] = -1.0f;
2777     max[0] = max[1] = max[2] = 1.0f;
2778   }
2779
2780   BKE_boundbox_init_from_minmax(bb, min, max);
2781
2782   bb->flag &= ~BOUNDBOX_DIRTY;
2783 }
2784
2785 BoundBox *BKE_armature_boundbox_get(Object *ob)
2786 {
2787   boundbox_armature(ob);
2788
2789   return ob->runtime.bb;
2790 }
2791
2792 bool BKE_pose_minmax(Object *ob, float r_min[3], float r_max[3], bool use_hidden, bool use_select)
2793 {
2794   bool changed = false;
2795
2796   if (ob->pose) {
2797     bArmature *arm = ob->data;
2798     bPoseChannel *pchan;
2799
2800     for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
2801       /* XXX pchan->bone may be NULL for duplicated bones, see duplicateEditBoneObjects() comment
2802        *     (editarmature.c:2592)... Skip in this case too! */
2803       if (pchan->bone && (!((use_hidden == false) && (PBONE_VISIBLE(arm, pchan->bone) == false)) &&
2804                           !((use_select == true) && ((pchan->bone->flag & BONE_SELECTED) == 0)))) {
2805         bPoseChannel *pchan_tx = (pchan->custom && pchan->custom_tx) ? pchan->custom_tx : pchan;
2806         BoundBox *bb_custom = ((pchan->custom) && !(arm->flag & ARM_NO_CUSTOM)) ?
2807                                   BKE_object_boundbox_get(pchan->custom) :
2808                                   NULL;
2809         if (bb_custom) {
2810           float mat[4][4], smat[4][4];
2811           scale_m4_fl(smat, PCHAN_CUSTOM_DRAW_SIZE(pchan));
2812           mul_m4_series(mat, ob->obmat, pchan_tx->pose_mat, smat);
2813           BKE_boundbox_minmax(bb_custom, mat, r_min, r_max);
2814         }
2815         else {
2816           float vec[3];
2817           mul_v3_m4v3(vec, ob->obmat, pchan_tx->pose_head);
2818           minmax_v3v3_v3(r_min, r_max, vec);
2819           mul_v3_m4v3(vec, ob->obmat, pchan_tx->pose_tail);
2820           minmax_v3v3_v3(r_min, r_max, vec);
2821         }
2822
2823         changed = true;
2824       }
2825     }
2826   }
2827
2828   return changed;
2829 }
2830
2831 /************** Graph evaluation ********************/
2832
2833 bPoseChannel *BKE_armature_ik_solver_find_root(bPoseChannel *pchan, bKinematicConstraint *data)
2834 {
2835   bPoseChannel *rootchan = pchan;
2836   if (!(data->flag & CONSTRAINT_IK_TIP)) {
2837     /* Exclude tip from chain. */
2838     rootchan = rootchan->parent;
2839   }
2840   if (rootchan != NULL) {
2841     int segcount = 0;
2842     while (rootchan->parent) {
2843       /* Continue up chain, until we reach target number of items. */
2844       segcount++;
2845       if (segcount == data->rootbone) {
2846         break;
2847       }
2848       rootchan = rootchan->parent;
2849     }
2850   }
2851   return rootchan;
2852 }
2853
2854 bPoseChannel *BKE_armature_splineik_solver_find_root(bPoseChannel *pchan,
2855                                                      bSplineIKConstraint *data)
2856 {
2857   bPoseChannel *rootchan = pchan;
2858   int segcount = 0;
2859   BLI_assert(rootchan != NULL);
2860   while (rootchan->parent) {
2861     /* Continue up chain, until we reach target number of items. */
2862     segcount++;
2863     if (segcount == data->chainlen) {
2864       break;
2865     }
2866     rootchan = rootchan->parent;
2867   }
2868   return rootchan;
2869 }