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