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