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