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