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