BLI_math_rotation: properly name the quaternion power function.
[blender.git] / source / blender / blenlib / intern / math_rotation.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20
21  * The Original Code is: some of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  * */
25
26 /** \file blender/blenlib/intern/math_rotation.c
27  *  \ingroup bli
28  */
29
30 #include <assert.h>
31 #include "BLI_math.h"
32
33 #include "BLI_strict_flags.h"
34
35 /******************************** Quaternions ********************************/
36
37 /* used to test is a quat is not normalized (only used for debug prints) */
38 #ifdef DEBUG
39 #  define QUAT_EPSILON 0.0001
40 #endif
41
42 /* convenience, avoids setting Y axis everywhere */
43 void unit_axis_angle(float axis[3], float *angle)
44 {
45         axis[0] = 0.0f;
46         axis[1] = 1.0f;
47         axis[2] = 0.0f;
48         *angle = 0.0f;
49 }
50
51 void unit_qt(float q[4])
52 {
53         q[0] = 1.0f;
54         q[1] = q[2] = q[3] = 0.0f;
55 }
56
57 void copy_qt_qt(float q1[4], const float q2[4])
58 {
59         q1[0] = q2[0];
60         q1[1] = q2[1];
61         q1[2] = q2[2];
62         q1[3] = q2[3];
63 }
64
65 bool is_zero_qt(const float q[4])
66 {
67         return (q[0] == 0 && q[1] == 0 && q[2] == 0 && q[3] == 0);
68 }
69
70 void mul_qt_qtqt(float q[4], const float q1[4], const float q2[4])
71 {
72         float t0, t1, t2;
73
74         t0 = q1[0] * q2[0] - q1[1] * q2[1] - q1[2] * q2[2] - q1[3] * q2[3];
75         t1 = q1[0] * q2[1] + q1[1] * q2[0] + q1[2] * q2[3] - q1[3] * q2[2];
76         t2 = q1[0] * q2[2] + q1[2] * q2[0] + q1[3] * q2[1] - q1[1] * q2[3];
77         q[3] = q1[0] * q2[3] + q1[3] * q2[0] + q1[1] * q2[2] - q1[2] * q2[1];
78         q[0] = t0;
79         q[1] = t1;
80         q[2] = t2;
81 }
82
83 /**
84  * \note:
85  * Assumes a unit quaternion?
86  *
87  * in fact not, but you may want to use a unit quat, read on...
88  *
89  * Shortcut for 'q v q*' when \a v is actually a quaternion.
90  * This removes the need for converting a vector to a quaternion,
91  * calculating q's conjugate and converting back to a vector.
92  * It also happens to be faster (17+,24* vs * 24+,32*).
93  * If \a q is not a unit quaternion, then \a v will be both rotated by
94  * the same amount as if q was a unit quaternion, and scaled by the square of
95  * the length of q.
96  *
97  * For people used to python mathutils, its like:
98  * def mul_qt_v3(q, v): (q * Quaternion((0.0, v[0], v[1], v[2])) * q.conjugated())[1:]
99  *
100  * \note: multiplying by 3x3 matrix is ~25% faster.
101  */
102 void mul_qt_v3(const float q[4], float v[3])
103 {
104         float t0, t1, t2;
105
106         t0 = -q[1] * v[0] - q[2] * v[1] - q[3] * v[2];
107         t1 = q[0] * v[0] + q[2] * v[2] - q[3] * v[1];
108         t2 = q[0] * v[1] + q[3] * v[0] - q[1] * v[2];
109         v[2] = q[0] * v[2] + q[1] * v[1] - q[2] * v[0];
110         v[0] = t1;
111         v[1] = t2;
112
113         t1 = t0 * -q[1] + v[0] * q[0] - v[1] * q[3] + v[2] * q[2];
114         t2 = t0 * -q[2] + v[1] * q[0] - v[2] * q[1] + v[0] * q[3];
115         v[2] = t0 * -q[3] + v[2] * q[0] - v[0] * q[2] + v[1] * q[1];
116         v[0] = t1;
117         v[1] = t2;
118 }
119
120 void conjugate_qt_qt(float q1[4], const float q2[4])
121 {
122         q1[0] =  q2[0];
123         q1[1] = -q2[1];
124         q1[2] = -q2[2];
125         q1[3] = -q2[3];
126 }
127
128 void conjugate_qt(float q[4])
129 {
130         q[1] = -q[1];
131         q[2] = -q[2];
132         q[3] = -q[3];
133 }
134
135 float dot_qtqt(const float q1[4], const float q2[4])
136 {
137         return q1[0] * q2[0] + q1[1] * q2[1] + q1[2] * q2[2] + q1[3] * q2[3];
138 }
139
140 void invert_qt(float q[4])
141 {
142         const float f = dot_qtqt(q, q);
143
144         if (f == 0.0f)
145                 return;
146
147         conjugate_qt(q);
148         mul_qt_fl(q, 1.0f / f);
149 }
150
151 void invert_qt_qt(float q1[4], const float q2[4])
152 {
153         copy_qt_qt(q1, q2);
154         invert_qt(q1);
155 }
156
157 /**
158  * This is just conjugate_qt for cases we know \a q is unit-length.
159  * we could use #conjugate_qt directly, but use this function to show intent,
160  * and assert if its ever becomes non-unit-length.
161  */
162 void invert_qt_normalized(float q[4])
163 {
164         BLI_ASSERT_UNIT_QUAT(q);
165         conjugate_qt(q);
166
167 }
168
169 void invert_qt_qt_normalized(float q1[4], const float q2[4])
170 {
171         copy_qt_qt(q1, q2);
172         invert_qt_normalized(q1);
173 }
174
175 /* simple mult */
176 void mul_qt_fl(float q[4], const float f)
177 {
178         q[0] *= f;
179         q[1] *= f;
180         q[2] *= f;
181         q[3] *= f;
182 }
183
184 void sub_qt_qtqt(float q[4], const float q1[4], const float q2[4])
185 {
186         float nq2[4];
187
188         nq2[0] = -q2[0];
189         nq2[1] = q2[1];
190         nq2[2] = q2[2];
191         nq2[3] = q2[3];
192
193         mul_qt_qtqt(q, q1, nq2);
194 }
195
196 /* raise a unit quaternion to the specified power */
197 void pow_qt_fl_normalized(float q[4], const float fac)
198 {
199         BLI_ASSERT_UNIT_QUAT(q);
200         const float angle = fac * saacos(q[0]); /* quat[0] = cos(0.5 * angle), but now the 0.5 and 2.0 rule out */
201         const float co = cosf(angle);
202         const float si = sinf(angle);
203         q[0] = co;
204         normalize_v3_length(q + 1, si);
205 }
206
207 /* skip error check, currently only needed by mat3_to_quat_is_ok */
208 static void quat_to_mat3_no_error(float m[3][3], const float q[4])
209 {
210         double q0, q1, q2, q3, qda, qdb, qdc, qaa, qab, qac, qbb, qbc, qcc;
211
212         q0 = M_SQRT2 * (double)q[0];
213         q1 = M_SQRT2 * (double)q[1];
214         q2 = M_SQRT2 * (double)q[2];
215         q3 = M_SQRT2 * (double)q[3];
216
217         qda = q0 * q1;
218         qdb = q0 * q2;
219         qdc = q0 * q3;
220         qaa = q1 * q1;
221         qab = q1 * q2;
222         qac = q1 * q3;
223         qbb = q2 * q2;
224         qbc = q2 * q3;
225         qcc = q3 * q3;
226
227         m[0][0] = (float)(1.0 - qbb - qcc);
228         m[0][1] = (float)(qdc + qab);
229         m[0][2] = (float)(-qdb + qac);
230
231         m[1][0] = (float)(-qdc + qab);
232         m[1][1] = (float)(1.0 - qaa - qcc);
233         m[1][2] = (float)(qda + qbc);
234
235         m[2][0] = (float)(qdb + qac);
236         m[2][1] = (float)(-qda + qbc);
237         m[2][2] = (float)(1.0 - qaa - qbb);
238 }
239
240 void quat_to_mat3(float m[3][3], const float q[4])
241 {
242 #ifdef DEBUG
243         float f;
244         if (!((f = dot_qtqt(q, q)) == 0.0f || (fabsf(f - 1.0f) < (float)QUAT_EPSILON))) {
245                 fprintf(stderr, "Warning! quat_to_mat3() called with non-normalized: size %.8f *** report a bug ***\n", f);
246         }
247 #endif
248
249         quat_to_mat3_no_error(m, q);
250 }
251
252 void quat_to_mat4(float m[4][4], const float q[4])
253 {
254         double q0, q1, q2, q3, qda, qdb, qdc, qaa, qab, qac, qbb, qbc, qcc;
255
256 #ifdef DEBUG
257         if (!((q0 = dot_qtqt(q, q)) == 0.0 || (fabs(q0 - 1.0) < QUAT_EPSILON))) {
258                 fprintf(stderr, "Warning! quat_to_mat4() called with non-normalized: size %.8f *** report a bug ***\n", (float)q0);
259         }
260 #endif
261
262         q0 = M_SQRT2 * (double)q[0];
263         q1 = M_SQRT2 * (double)q[1];
264         q2 = M_SQRT2 * (double)q[2];
265         q3 = M_SQRT2 * (double)q[3];
266
267         qda = q0 * q1;
268         qdb = q0 * q2;
269         qdc = q0 * q3;
270         qaa = q1 * q1;
271         qab = q1 * q2;
272         qac = q1 * q3;
273         qbb = q2 * q2;
274         qbc = q2 * q3;
275         qcc = q3 * q3;
276
277         m[0][0] = (float)(1.0 - qbb - qcc);
278         m[0][1] = (float)(qdc + qab);
279         m[0][2] = (float)(-qdb + qac);
280         m[0][3] = 0.0f;
281
282         m[1][0] = (float)(-qdc + qab);
283         m[1][1] = (float)(1.0 - qaa - qcc);
284         m[1][2] = (float)(qda + qbc);
285         m[1][3] = 0.0f;
286
287         m[2][0] = (float)(qdb + qac);
288         m[2][1] = (float)(-qda + qbc);
289         m[2][2] = (float)(1.0 - qaa - qbb);
290         m[2][3] = 0.0f;
291
292         m[3][0] = m[3][1] = m[3][2] = 0.0f;
293         m[3][3] = 1.0f;
294 }
295
296 void mat3_normalized_to_quat(float q[4], float mat[3][3])
297 {
298         double tr, s;
299
300         BLI_ASSERT_UNIT_M3(mat);
301
302         tr = 0.25 * (double)(1.0f + mat[0][0] + mat[1][1] + mat[2][2]);
303
304         if (tr > (double)1e-4f) {
305                 s = sqrt(tr);
306                 q[0] = (float)s;
307                 s = 1.0 / (4.0 * s);
308                 q[1] = (float)((double)(mat[1][2] - mat[2][1]) * s);
309                 q[2] = (float)((double)(mat[2][0] - mat[0][2]) * s);
310                 q[3] = (float)((double)(mat[0][1] - mat[1][0]) * s);
311         }
312         else {
313                 if (mat[0][0] > mat[1][1] && mat[0][0] > mat[2][2]) {
314                         s = 2.0f * sqrtf(1.0f + mat[0][0] - mat[1][1] - mat[2][2]);
315                         q[1] = (float)(0.25 * s);
316
317                         s = 1.0 / s;
318                         q[0] = (float)((double)(mat[1][2] - mat[2][1]) * s);
319                         q[2] = (float)((double)(mat[1][0] + mat[0][1]) * s);
320                         q[3] = (float)((double)(mat[2][0] + mat[0][2]) * s);
321                 }
322                 else if (mat[1][1] > mat[2][2]) {
323                         s = 2.0f * sqrtf(1.0f + mat[1][1] - mat[0][0] - mat[2][2]);
324                         q[2] = (float)(0.25 * s);
325
326                         s = 1.0 / s;
327                         q[0] = (float)((double)(mat[2][0] - mat[0][2]) * s);
328                         q[1] = (float)((double)(mat[1][0] + mat[0][1]) * s);
329                         q[3] = (float)((double)(mat[2][1] + mat[1][2]) * s);
330                 }
331                 else {
332                         s = 2.0f * sqrtf(1.0f + mat[2][2] - mat[0][0] - mat[1][1]);
333                         q[3] = (float)(0.25 * s);
334
335                         s = 1.0 / s;
336                         q[0] = (float)((double)(mat[0][1] - mat[1][0]) * s);
337                         q[1] = (float)((double)(mat[2][0] + mat[0][2]) * s);
338                         q[2] = (float)((double)(mat[2][1] + mat[1][2]) * s);
339                 }
340         }
341
342         normalize_qt(q);
343 }
344 void mat3_to_quat(float q[4], float m[3][3])
345 {
346         float unit_mat[3][3];
347
348         /* work on a copy */
349         /* this is needed AND a 'normalize_qt' in the end */
350         normalize_m3_m3(unit_mat, m);
351         mat3_normalized_to_quat(q, unit_mat);
352 }
353
354 void mat4_normalized_to_quat(float q[4], float m[4][4])
355 {
356         float mat3[3][3];
357
358         copy_m3_m4(mat3, m);
359         mat3_normalized_to_quat(q, mat3);
360 }
361
362 void mat4_to_quat(float q[4], float m[4][4])
363 {
364         float mat3[3][3];
365
366         copy_m3_m4(mat3, m);
367         mat3_to_quat(q, mat3);
368 }
369
370 void mat3_to_quat_is_ok(float q[4], float wmat[3][3])
371 {
372         float mat[3][3], matr[3][3], matn[3][3], q1[4], q2[4], angle, si, co, nor[3];
373
374         /* work on a copy */
375         copy_m3_m3(mat, wmat);
376         normalize_m3(mat);
377
378         /* rotate z-axis of matrix to z-axis */
379
380         nor[0] = mat[2][1]; /* cross product with (0,0,1) */
381         nor[1] = -mat[2][0];
382         nor[2] = 0.0;
383         normalize_v3(nor);
384
385         co = mat[2][2];
386         angle = 0.5f * saacos(co);
387
388         co = cosf(angle);
389         si = sinf(angle);
390         q1[0] = co;
391         q1[1] = -nor[0] * si; /* negative here, but why? */
392         q1[2] = -nor[1] * si;
393         q1[3] = -nor[2] * si;
394
395         /* rotate back x-axis from mat, using inverse q1 */
396         quat_to_mat3_no_error(matr, q1);
397         invert_m3_m3(matn, matr);
398         mul_m3_v3(matn, mat[0]);
399
400         /* and align x-axes */
401         angle = 0.5f * atan2f(mat[0][1], mat[0][0]);
402
403         co = cosf(angle);
404         si = sinf(angle);
405         q2[0] = co;
406         q2[1] = 0.0f;
407         q2[2] = 0.0f;
408         q2[3] = si;
409
410         mul_qt_qtqt(q, q1, q2);
411 }
412
413 float normalize_qt(float q[4])
414 {
415         const float len = sqrtf(dot_qtqt(q, q));
416
417         if (len != 0.0f) {
418                 mul_qt_fl(q, 1.0f / len);
419         }
420         else {
421                 q[1] = 1.0f;
422                 q[0] = q[2] = q[3] = 0.0f;
423         }
424
425         return len;
426 }
427
428 float normalize_qt_qt(float r[4], const float q[4])
429 {
430         copy_qt_qt(r, q);
431         return normalize_qt(r);
432 }
433
434 /**
435  * Calculate a rotation matrix from 2 normalized vectors.
436  */
437 void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3])
438 {
439         float axis[3];
440         /* avoid calculating the angle */
441         float angle_sin;
442         float angle_cos;
443
444         BLI_ASSERT_UNIT_V3(v1);
445         BLI_ASSERT_UNIT_V3(v2);
446
447         cross_v3_v3v3(axis, v1, v2);
448
449         angle_sin = normalize_v3(axis);
450         angle_cos = dot_v3v3(v1, v2);
451
452         if (angle_sin > FLT_EPSILON) {
453 axis_calc:
454                 BLI_ASSERT_UNIT_V3(axis);
455                 axis_angle_normalized_to_mat3_ex(m, axis, angle_sin, angle_cos);
456                 BLI_ASSERT_UNIT_M3(m);
457         }
458         else {
459                 if (angle_cos > 0.0f) {
460                         /* Same vectors, zero rotation... */
461                         unit_m3(m);
462                 }
463                 else {
464                         /* Colinear but opposed vectors, 180 rotation... */
465                         ortho_v3_v3(axis, v1);
466                         normalize_v3(axis);
467                         angle_sin =  0.0f;  /* sin(M_PI) */
468                         angle_cos = -1.0f;  /* cos(M_PI) */
469                         goto axis_calc;
470                 }
471         }
472 }
473
474 /* note: expects vectors to be normalized */
475 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3])
476 {
477         float axis[3];
478
479         cross_v3_v3v3(axis, v1, v2);
480
481         if (normalize_v3(axis) > FLT_EPSILON) {
482                 float angle;
483
484                 angle = angle_normalized_v3v3(v1, v2);
485
486                 axis_angle_normalized_to_quat(q, axis, angle);
487         }
488         else {
489                 /* degenerate case */
490
491                 if (dot_v3v3(v1, v2) > 0.0f) {
492                         /* Same vectors, zero rotation... */
493                         unit_qt(q);
494                 }
495                 else {
496                         /* Colinear but opposed vectors, 180 rotation... */
497                         ortho_v3_v3(axis, v1);
498                         axis_angle_to_quat(q, axis, (float)M_PI);
499                 }
500         }
501 }
502
503 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4])
504 {
505         float tquat[4];
506
507         conjugate_qt_qt(tquat, q1);
508
509         mul_qt_fl(tquat, 1.0f / dot_qtqt(tquat, tquat));
510
511         mul_qt_qtqt(q, tquat, q2);
512 }
513
514
515 /* -------------------------------------------------------------------- */
516 /** \name Quaternion Angle
517  *
518  * Unlike the angle between vectors, this does NOT return the shortest angle.
519  * See signed functions below for this.
520  *
521  * \{ */
522
523 float angle_normalized_qt(const float q[4])
524 {
525         BLI_ASSERT_UNIT_QUAT(q);
526         return 2.0f * saacos(q[0]);
527 }
528
529 float angle_qt(const float q[4])
530 {
531         float tquat[4];
532
533         normalize_qt_qt(tquat, q);
534
535         return angle_normalized_qt(tquat);
536 }
537
538 float angle_normalized_qtqt(const float q1[4], const float q2[4])
539 {
540         float qdelta[4];
541
542         BLI_ASSERT_UNIT_QUAT(q1);
543         BLI_ASSERT_UNIT_QUAT(q2);
544
545         rotation_between_quats_to_quat(qdelta, q1, q2);
546
547         return angle_normalized_qt(qdelta);
548 }
549
550 float angle_qtqt(const float q1[4], const float q2[4])
551 {
552         float quat1[4], quat2[4];
553
554         normalize_qt_qt(quat1, q1);
555         normalize_qt_qt(quat2, q2);
556
557         return angle_normalized_qtqt(quat1, quat2);
558 }
559
560 /** \} */
561
562 /* -------------------------------------------------------------------- */
563 /** \name Quaternion Angle (Signed)
564  *
565  * Angles with quaternion calculation can exceed 180d,
566  * Having signed versions of these functions allows 'fabsf(angle_signed_qtqt(...))'
567  * to give us the shortest angle between quaternions.
568  * With higher precision than subtracting pi afterwards.
569  *
570  * \{ */
571
572 float angle_signed_normalized_qt(const float q[4])
573 {
574         BLI_ASSERT_UNIT_QUAT(q);
575         if (q[0] >= 0.0f) {
576                 return 2.0f * saacos(q[0]);
577         }
578         else {
579                 return -2.0f * saacos(-q[0]);
580         }
581 }
582
583 float angle_signed_normalized_qtqt(const float q1[4], const float q2[4])
584 {
585         if (dot_qtqt(q1, q2) >= 0.0f) {
586                 return angle_normalized_qtqt(q1, q2);
587         }
588         else {
589                 float q2_copy[4];
590                 negate_v4_v4(q2_copy, q2);
591                 return -angle_normalized_qtqt(q1, q2_copy);
592         }
593 }
594
595 float angle_signed_qt(const float q[4])
596 {
597         float tquat[4];
598
599         normalize_qt_qt(tquat, q);
600
601         return angle_signed_normalized_qt(tquat);
602 }
603
604 float angle_signed_qtqt(const float q1[4], const float q2[4])
605 {
606         if (dot_qtqt(q1, q2) >= 0.0f) {
607                 return angle_qtqt(q1, q2);
608         }
609         else {
610                 float q2_copy[4];
611                 negate_v4_v4(q2_copy, q2);
612                 return -angle_qtqt(q1, q2_copy);
613         }
614 }
615
616 /** \} */
617
618 void vec_to_quat(float q[4], const float vec[3], short axis, const short upflag)
619 {
620         const float eps = 1e-4f;
621         float nor[3], tvec[3];
622         float angle, si, co, len;
623
624         assert(axis >= 0 && axis <= 5);
625         assert(upflag >= 0 && upflag <= 2);
626
627         /* first set the quat to unit */
628         unit_qt(q);
629
630         len = len_v3(vec);
631
632         if (UNLIKELY(len == 0.0f)) {
633                 return;
634         }
635
636         /* rotate to axis */
637         if (axis > 2) {
638                 copy_v3_v3(tvec, vec);
639                 axis = (short)(axis - 3);
640         }
641         else {
642                 negate_v3_v3(tvec, vec);
643         }
644
645         /* nasty! I need a good routine for this...
646          * problem is a rotation of an Y axis to the negative Y-axis for example.
647          */
648
649         if (axis == 0) { /* x-axis */
650                 nor[0] =  0.0;
651                 nor[1] = -tvec[2];
652                 nor[2] =  tvec[1];
653
654                 if (fabsf(tvec[1]) + fabsf(tvec[2]) < eps)
655                         nor[1] = 1.0f;
656
657                 co = tvec[0];
658         }
659         else if (axis == 1) { /* y-axis */
660                 nor[0] =  tvec[2];
661                 nor[1] =  0.0;
662                 nor[2] = -tvec[0];
663
664                 if (fabsf(tvec[0]) + fabsf(tvec[2]) < eps)
665                         nor[2] = 1.0f;
666
667                 co = tvec[1];
668         }
669         else { /* z-axis */
670                 nor[0] = -tvec[1];
671                 nor[1] =  tvec[0];
672                 nor[2] =  0.0;
673
674                 if (fabsf(tvec[0]) + fabsf(tvec[1]) < eps)
675                         nor[0] = 1.0f;
676
677                 co = tvec[2];
678         }
679         co /= len;
680
681         normalize_v3(nor);
682
683         axis_angle_normalized_to_quat(q, nor, saacos(co));
684
685         if (axis != upflag) {
686                 float mat[3][3];
687                 float q2[4];
688                 const float *fp = mat[2];
689                 quat_to_mat3(mat, q);
690
691                 if (axis == 0) {
692                         if (upflag == 1) angle =  0.5f * atan2f(fp[2], fp[1]);
693                         else             angle = -0.5f * atan2f(fp[1], fp[2]);
694                 }
695                 else if (axis == 1) {
696                         if (upflag == 0) angle = -0.5f * atan2f(fp[2], fp[0]);
697                         else             angle =  0.5f * atan2f(fp[0], fp[2]);
698                 }
699                 else {
700                         if (upflag == 0) angle =  0.5f * atan2f(-fp[1], -fp[0]);
701                         else             angle = -0.5f * atan2f(-fp[0], -fp[1]);
702                 }
703
704                 co = cosf(angle);
705                 si = sinf(angle) / len;
706                 q2[0] = co;
707                 q2[1] = tvec[0] * si;
708                 q2[2] = tvec[1] * si;
709                 q2[3] = tvec[2] * si;
710
711                 mul_qt_qtqt(q, q2, q);
712         }
713 }
714
715 #if 0
716
717 /* A & M Watt, Advanced animation and rendering techniques, 1992 ACM press */
718 void QuatInterpolW(float *result, float quat1[4], float quat2[4], float t)
719 {
720         float omega, cosom, sinom, sc1, sc2;
721
722         cosom = quat1[0] * quat2[0] + quat1[1] * quat2[1] + quat1[2] * quat2[2] + quat1[3] * quat2[3];
723
724         /* rotate around shortest angle */
725         if ((1.0f + cosom) > 0.0001f) {
726
727                 if ((1.0f - cosom) > 0.0001f) {
728                         omega = (float)acos(cosom);
729                         sinom = sinf(omega);
730                         sc1 = sinf((1.0 - t) * omega) / sinom;
731                         sc2 = sinf(t * omega) / sinom;
732                 }
733                 else {
734                         sc1 = 1.0f - t;
735                         sc2 = t;
736                 }
737                 result[0] = sc1 * quat1[0] + sc2 * quat2[0];
738                 result[1] = sc1 * quat1[1] + sc2 * quat2[1];
739                 result[2] = sc1 * quat1[2] + sc2 * quat2[2];
740                 result[3] = sc1 * quat1[3] + sc2 * quat2[3];
741         }
742         else {
743                 result[0] = quat2[3];
744                 result[1] = -quat2[2];
745                 result[2] = quat2[1];
746                 result[3] = -quat2[0];
747
748                 sc1 = sinf((1.0 - t) * M_PI_2);
749                 sc2 = sinf(t * M_PI_2);
750
751                 result[0] = sc1 * quat1[0] + sc2 * result[0];
752                 result[1] = sc1 * quat1[1] + sc2 * result[1];
753                 result[2] = sc1 * quat1[2] + sc2 * result[2];
754                 result[3] = sc1 * quat1[3] + sc2 * result[3];
755         }
756 }
757 #endif
758
759 /**
760  * Generic function for implementing slerp
761  * (quaternions and spherical vector coords).
762  *
763  * \param t: factor in [0..1]
764  * \param cosom: dot product from normalized vectors/quats.
765  * \param r_w: calculated weights.
766  */
767 void interp_dot_slerp(const float t, const float cosom, float r_w[2])
768 {
769         const float eps = 1e-4f;
770
771         BLI_assert(IN_RANGE_INCL(cosom, -1.0001f, 1.0001f));
772
773         /* within [-1..1] range, avoid aligned axis */
774         if (LIKELY(fabsf(cosom) < (1.0f - eps))) {
775                 float omega, sinom;
776
777                 omega = acosf(cosom);
778                 sinom = sinf(omega);
779                 r_w[0] = sinf((1.0f - t) * omega) / sinom;
780                 r_w[1] = sinf(t * omega) / sinom;
781         }
782         else {
783                 /* fallback to lerp */
784                 r_w[0] = 1.0f - t;
785                 r_w[1] = t;
786         }
787 }
788
789 void interp_qt_qtqt(float result[4], const float quat1[4], const float quat2[4], const float t)
790 {
791         float quat[4], cosom, w[2];
792
793         BLI_ASSERT_UNIT_QUAT(quat1);
794         BLI_ASSERT_UNIT_QUAT(quat2);
795
796         cosom = dot_qtqt(quat1, quat2);
797
798         /* rotate around shortest angle */
799         if (cosom < 0.0f) {
800                 cosom = -cosom;
801                 negate_v4_v4(quat, quat1);
802         }
803         else {
804                 copy_qt_qt(quat, quat1);
805         }
806
807         interp_dot_slerp(t, cosom, w);
808
809         result[0] = w[0] * quat[0] + w[1] * quat2[0];
810         result[1] = w[0] * quat[1] + w[1] * quat2[1];
811         result[2] = w[0] * quat[2] + w[1] * quat2[2];
812         result[3] = w[0] * quat[3] + w[1] * quat2[3];
813 }
814
815 void add_qt_qtqt(float result[4], const float quat1[4], const float quat2[4], const float t)
816 {
817         result[0] = quat1[0] + t * quat2[0];
818         result[1] = quat1[1] + t * quat2[1];
819         result[2] = quat1[2] + t * quat2[2];
820         result[3] = quat1[3] + t * quat2[3];
821 }
822
823 /* same as tri_to_quat() but takes pre-computed normal from the triangle
824  * used for ngons when we know their normal */
825 void tri_to_quat_ex(float quat[4], const float v1[3], const float v2[3], const float v3[3],
826                     const float no_orig[3])
827 {
828         /* imaginary x-axis, y-axis triangle is being rotated */
829         float vec[3], q1[4], q2[4], n[3], si, co, angle, mat[3][3], imat[3][3];
830
831         /* move z-axis to face-normal */
832 #if 0
833         normal_tri_v3(vec, v1, v2, v3);
834 #else
835         copy_v3_v3(vec, no_orig);
836         (void)v3;
837 #endif
838
839         n[0] =  vec[1];
840         n[1] = -vec[0];
841         n[2] =  0.0f;
842         normalize_v3(n);
843
844         if (n[0] == 0.0f && n[1] == 0.0f) {
845                 n[0] = 1.0f;
846         }
847
848         angle = -0.5f * saacos(vec[2]);
849         co = cosf(angle);
850         si = sinf(angle);
851         q1[0] = co;
852         q1[1] = n[0] * si;
853         q1[2] = n[1] * si;
854         q1[3] = 0.0f;
855
856         /* rotate back line v1-v2 */
857         quat_to_mat3(mat, q1);
858         invert_m3_m3(imat, mat);
859         sub_v3_v3v3(vec, v2, v1);
860         mul_m3_v3(imat, vec);
861
862         /* what angle has this line with x-axis? */
863         vec[2] = 0.0f;
864         normalize_v3(vec);
865
866         angle = 0.5f * atan2f(vec[1], vec[0]);
867         co = cosf(angle);
868         si = sinf(angle);
869         q2[0] = co;
870         q2[1] = 0.0f;
871         q2[2] = 0.0f;
872         q2[3] = si;
873
874         mul_qt_qtqt(quat, q1, q2);
875 }
876
877 /**
878  * \return the length of the normal, use to test for degenerate triangles.
879  */
880 float tri_to_quat(float quat[4], const float v1[3], const float v2[3], const float v3[3])
881 {
882         float vec[3];
883         const float len = normal_tri_v3(vec, v1, v2, v3);
884
885         tri_to_quat_ex(quat, v1, v2, v3, vec);
886         return len;
887 }
888
889 void print_qt(const char *str, const float q[4])
890 {
891         printf("%s: %.3f %.3f %.3f %.3f\n", str, q[0], q[1], q[2], q[3]);
892 }
893
894 /******************************** Axis Angle *********************************/
895
896 void axis_angle_normalized_to_quat(float q[4], const float axis[3], const float angle)
897 {
898         const float phi = 0.5f * angle;
899         const float si = sinf(phi);
900         const float co = cosf(phi);
901         BLI_ASSERT_UNIT_V3(axis);
902         q[0] = co;
903         mul_v3_v3fl(q + 1, axis, si);
904 }
905
906 void axis_angle_to_quat(float q[4], const float axis[3], const float angle)
907 {
908         float nor[3];
909
910         if (LIKELY(normalize_v3_v3(nor, axis) != 0.0f)) {
911                 axis_angle_normalized_to_quat(q, nor, angle);
912         }
913         else {
914                 unit_qt(q);
915         }
916 }
917
918 /* Quaternions to Axis Angle */
919 void quat_to_axis_angle(float axis[3], float *angle, const float q[4])
920 {
921         float ha, si;
922
923 #ifdef DEBUG
924         if (!((ha = dot_qtqt(q, q)) == 0.0f || (fabsf(ha - 1.0f) < (float)QUAT_EPSILON))) {
925                 fprintf(stderr, "Warning! quat_to_axis_angle() called with non-normalized: size %.8f *** report a bug ***\n", ha);
926         }
927 #endif
928
929         /* calculate angle/2, and sin(angle/2) */
930         ha = acosf(q[0]);
931         si = sinf(ha);
932
933         /* from half-angle to angle */
934         *angle = ha * 2;
935
936         /* prevent division by zero for axis conversion */
937         if (fabsf(si) < 0.0005f)
938                 si = 1.0f;
939
940         axis[0] = q[1] / si;
941         axis[1] = q[2] / si;
942         axis[2] = q[3] / si;
943 }
944
945 /* Axis Angle to Euler Rotation */
946 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle)
947 {
948         float q[4];
949
950         /* use quaternions as intermediate representation for now... */
951         axis_angle_to_quat(q, axis, angle);
952         quat_to_eulO(eul, order, q);
953 }
954
955 /* Euler Rotation to Axis Angle */
956 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order)
957 {
958         float q[4];
959
960         /* use quaternions as intermediate representation for now... */
961         eulO_to_quat(q, eul, order);
962         quat_to_axis_angle(axis, angle, q);
963 }
964
965 /**
966  * axis angle to 3x3 matrix
967  *
968  * This takes the angle with sin/cos applied so we can avoid calculating it in some cases.
969  *
970  * \param axis: rotation axis (must be normalized).
971  * \param angle_sin: sin(angle)
972  * \param angle_cos: cos(angle)
973  */
974 void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
975                                       const float angle_sin, const float angle_cos)
976 {
977         float nsi[3], ico;
978         float n_00, n_01, n_11, n_02, n_12, n_22;
979
980         BLI_ASSERT_UNIT_V3(axis);
981
982         /* now convert this to a 3x3 matrix */
983
984         ico = (1.0f - angle_cos);
985         nsi[0] = axis[0] * angle_sin;
986         nsi[1] = axis[1] * angle_sin;
987         nsi[2] = axis[2] * angle_sin;
988
989         n_00 = (axis[0] * axis[0]) * ico;
990         n_01 = (axis[0] * axis[1]) * ico;
991         n_11 = (axis[1] * axis[1]) * ico;
992         n_02 = (axis[0] * axis[2]) * ico;
993         n_12 = (axis[1] * axis[2]) * ico;
994         n_22 = (axis[2] * axis[2]) * ico;
995
996         mat[0][0] = n_00 + angle_cos;
997         mat[0][1] = n_01 + nsi[2];
998         mat[0][2] = n_02 - nsi[1];
999         mat[1][0] = n_01 - nsi[2];
1000         mat[1][1] = n_11 + angle_cos;
1001         mat[1][2] = n_12 + nsi[0];
1002         mat[2][0] = n_02 + nsi[1];
1003         mat[2][1] = n_12 - nsi[0];
1004         mat[2][2] = n_22 + angle_cos;
1005 }
1006
1007 void axis_angle_normalized_to_mat3(float mat[3][3], const float axis[3], const float angle)
1008 {
1009         axis_angle_normalized_to_mat3_ex(mat, axis, sinf(angle), cosf(angle));
1010 }
1011
1012
1013 /* axis angle to 3x3 matrix - safer version (normalization of axis performed) */
1014 void axis_angle_to_mat3(float mat[3][3], const float axis[3], const float angle)
1015 {
1016         float nor[3];
1017
1018         /* normalize the axis first (to remove unwanted scaling) */
1019         if (normalize_v3_v3(nor, axis) == 0.0f) {
1020                 unit_m3(mat);
1021                 return;
1022         }
1023
1024         axis_angle_normalized_to_mat3(mat, nor, angle);
1025 }
1026
1027 /* axis angle to 4x4 matrix - safer version (normalization of axis performed) */
1028 void axis_angle_to_mat4(float mat[4][4], const float axis[3], const float angle)
1029 {
1030         float tmat[3][3];
1031
1032         axis_angle_to_mat3(tmat, axis, angle);
1033         unit_m4(mat);
1034         copy_m4_m3(mat, tmat);
1035 }
1036
1037 /* 3x3 matrix to axis angle */
1038 void mat3_normalized_to_axis_angle(float axis[3], float *angle, float mat[3][3])
1039 {
1040         float q[4];
1041
1042         /* use quaternions as intermediate representation */
1043         /* TODO: it would be nicer to go straight there... */
1044         mat3_normalized_to_quat(q, mat);
1045         quat_to_axis_angle(axis, angle, q);
1046 }
1047 void mat3_to_axis_angle(float axis[3], float *angle, float mat[3][3])
1048 {
1049         float q[4];
1050
1051         /* use quaternions as intermediate representation */
1052         /* TODO: it would be nicer to go straight there... */
1053         mat3_to_quat(q, mat);
1054         quat_to_axis_angle(axis, angle, q);
1055 }
1056
1057 /* 4x4 matrix to axis angle */
1058 void mat4_normalized_to_axis_angle(float axis[3], float *angle, float mat[4][4])
1059 {
1060         float q[4];
1061
1062         /* use quaternions as intermediate representation */
1063         /* TODO: it would be nicer to go straight there... */
1064         mat4_normalized_to_quat(q, mat);
1065         quat_to_axis_angle(axis, angle, q);
1066 }
1067
1068 /* 4x4 matrix to axis angle */
1069 void mat4_to_axis_angle(float axis[3], float *angle, float mat[4][4])
1070 {
1071         float q[4];
1072
1073         /* use quaternions as intermediate representation */
1074         /* TODO: it would be nicer to go straight there... */
1075         mat4_to_quat(q, mat);
1076         quat_to_axis_angle(axis, angle, q);
1077 }
1078
1079 void axis_angle_to_mat4_single(float mat[4][4], const char axis, const float angle)
1080 {
1081         float mat3[3][3];
1082         axis_angle_to_mat3_single(mat3, axis, angle);
1083         copy_m4_m3(mat, mat3);
1084 }
1085
1086 /* rotation matrix from a single axis */
1087 void axis_angle_to_mat3_single(float mat[3][3], const char axis, const float angle)
1088 {
1089         const float angle_cos = cosf(angle);
1090         const float angle_sin = sinf(angle);
1091
1092         switch (axis) {
1093                 case 'X': /* rotation around X */
1094                         mat[0][0] = 1.0f;
1095                         mat[0][1] = 0.0f;
1096                         mat[0][2] = 0.0f;
1097                         mat[1][0] = 0.0f;
1098                         mat[1][1] = angle_cos;
1099                         mat[1][2] = angle_sin;
1100                         mat[2][0] = 0.0f;
1101                         mat[2][1] = -angle_sin;
1102                         mat[2][2] = angle_cos;
1103                         break;
1104                 case 'Y': /* rotation around Y */
1105                         mat[0][0] = angle_cos;
1106                         mat[0][1] = 0.0f;
1107                         mat[0][2] = -angle_sin;
1108                         mat[1][0] = 0.0f;
1109                         mat[1][1] = 1.0f;
1110                         mat[1][2] = 0.0f;
1111                         mat[2][0] = angle_sin;
1112                         mat[2][1] = 0.0f;
1113                         mat[2][2] = angle_cos;
1114                         break;
1115                 case 'Z': /* rotation around Z */
1116                         mat[0][0] = angle_cos;
1117                         mat[0][1] = angle_sin;
1118                         mat[0][2] = 0.0f;
1119                         mat[1][0] = -angle_sin;
1120                         mat[1][1] = angle_cos;
1121                         mat[1][2] = 0.0f;
1122                         mat[2][0] = 0.0f;
1123                         mat[2][1] = 0.0f;
1124                         mat[2][2] = 1.0f;
1125                         break;
1126                 default:
1127                         BLI_assert(0);
1128                         break;
1129         }
1130 }
1131
1132 void angle_to_mat2(float mat[2][2], const float angle)
1133 {
1134         const float angle_cos = cosf(angle);
1135         const float angle_sin = sinf(angle);
1136
1137         /* 2D rotation matrix */
1138         mat[0][0] =  angle_cos;
1139         mat[0][1] =  angle_sin;
1140         mat[1][0] = -angle_sin;
1141         mat[1][1] =  angle_cos;
1142 }
1143
1144 void axis_angle_to_quat_single(float q[4], const char axis, const float angle)
1145 {
1146         const float angle_half = angle * 0.5f;
1147         const float angle_cos = cosf(angle_half);
1148         const float angle_sin = sinf(angle_half);
1149         const int axis_index = (axis - 'X');
1150
1151         assert(axis >= 'X' && axis <= 'Z');
1152
1153         q[0] = angle_cos;
1154         zero_v3(q + 1);
1155         q[axis_index + 1] = angle_sin;
1156 }
1157
1158 /****************************** Exponential Map ******************************/
1159
1160 void quat_normalized_to_expmap(float expmap[3], const float q[4])
1161 {
1162         float angle;
1163         BLI_ASSERT_UNIT_QUAT(q);
1164
1165         /* Obtain axis/angle representation. */
1166         quat_to_axis_angle(expmap, &angle, q);
1167
1168         /* Convert to exponential map. */
1169         mul_v3_fl(expmap, angle);
1170 }
1171
1172 void quat_to_expmap(float expmap[3], const float q[4])
1173 {
1174         float q_no[4];
1175         normalize_qt_qt(q_no, q);
1176         quat_normalized_to_expmap(expmap, q_no);
1177 }
1178
1179 void expmap_to_quat(float r[4], const float expmap[3])
1180 {
1181         float axis[3];
1182         float angle;
1183
1184         /* Obtain axis/angle representation. */
1185         if (LIKELY((angle = normalize_v3_v3(axis, expmap)) != 0.0f)) {
1186                 axis_angle_normalized_to_quat(r, axis, angle_wrap_rad(angle));
1187         }
1188         else {
1189                 unit_qt(r);
1190         }
1191 }
1192
1193 /******************************** XYZ Eulers *********************************/
1194
1195 /* XYZ order */
1196 void eul_to_mat3(float mat[3][3], const float eul[3])
1197 {
1198         double ci, cj, ch, si, sj, sh, cc, cs, sc, ss;
1199
1200         ci = cos(eul[0]);
1201         cj = cos(eul[1]);
1202         ch = cos(eul[2]);
1203         si = sin(eul[0]);
1204         sj = sin(eul[1]);
1205         sh = sin(eul[2]);
1206         cc = ci * ch;
1207         cs = ci * sh;
1208         sc = si * ch;
1209         ss = si * sh;
1210
1211         mat[0][0] = (float)(cj * ch);
1212         mat[1][0] = (float)(sj * sc - cs);
1213         mat[2][0] = (float)(sj * cc + ss);
1214         mat[0][1] = (float)(cj * sh);
1215         mat[1][1] = (float)(sj * ss + cc);
1216         mat[2][1] = (float)(sj * cs - sc);
1217         mat[0][2] = (float)-sj;
1218         mat[1][2] = (float)(cj * si);
1219         mat[2][2] = (float)(cj * ci);
1220
1221 }
1222
1223 /* XYZ order */
1224 void eul_to_mat4(float mat[4][4], const float eul[3])
1225 {
1226         double ci, cj, ch, si, sj, sh, cc, cs, sc, ss;
1227
1228         ci = cos(eul[0]);
1229         cj = cos(eul[1]);
1230         ch = cos(eul[2]);
1231         si = sin(eul[0]);
1232         sj = sin(eul[1]);
1233         sh = sin(eul[2]);
1234         cc = ci * ch;
1235         cs = ci * sh;
1236         sc = si * ch;
1237         ss = si * sh;
1238
1239         mat[0][0] = (float)(cj * ch);
1240         mat[1][0] = (float)(sj * sc - cs);
1241         mat[2][0] = (float)(sj * cc + ss);
1242         mat[0][1] = (float)(cj * sh);
1243         mat[1][1] = (float)(sj * ss + cc);
1244         mat[2][1] = (float)(sj * cs - sc);
1245         mat[0][2] = (float)-sj;
1246         mat[1][2] = (float)(cj * si);
1247         mat[2][2] = (float)(cj * ci);
1248
1249
1250         mat[3][0] = mat[3][1] = mat[3][2] = mat[0][3] = mat[1][3] = mat[2][3] = 0.0f;
1251         mat[3][3] = 1.0f;
1252 }
1253
1254 /* returns two euler calculation methods, so we can pick the best */
1255
1256 /* XYZ order */
1257 static void mat3_normalized_to_eul2(const float mat[3][3], float eul1[3], float eul2[3])
1258 {
1259         const float cy = hypotf(mat[0][0], mat[0][1]);
1260
1261         BLI_ASSERT_UNIT_M3(mat);
1262
1263         if (cy > 16.0f * FLT_EPSILON) {
1264
1265                 eul1[0] = atan2f(mat[1][2], mat[2][2]);
1266                 eul1[1] = atan2f(-mat[0][2], cy);
1267                 eul1[2] = atan2f(mat[0][1], mat[0][0]);
1268
1269                 eul2[0] = atan2f(-mat[1][2], -mat[2][2]);
1270                 eul2[1] = atan2f(-mat[0][2], -cy);
1271                 eul2[2] = atan2f(-mat[0][1], -mat[0][0]);
1272
1273         }
1274         else {
1275                 eul1[0] = atan2f(-mat[2][1], mat[1][1]);
1276                 eul1[1] = atan2f(-mat[0][2], cy);
1277                 eul1[2] = 0.0f;
1278
1279                 copy_v3_v3(eul2, eul1);
1280         }
1281 }
1282
1283 /* XYZ order */
1284 void mat3_normalized_to_eul(float eul[3], float mat[3][3])
1285 {
1286         float eul1[3], eul2[3];
1287
1288         mat3_normalized_to_eul2(mat, eul1, eul2);
1289
1290         /* return best, which is just the one with lowest values it in */
1291         if (fabsf(eul1[0]) + fabsf(eul1[1]) + fabsf(eul1[2]) > fabsf(eul2[0]) + fabsf(eul2[1]) + fabsf(eul2[2])) {
1292                 copy_v3_v3(eul, eul2);
1293         }
1294         else {
1295                 copy_v3_v3(eul, eul1);
1296         }
1297 }
1298 void mat3_to_eul(float eul[3], float mat[3][3])
1299 {
1300         float unit_mat[3][3];
1301         normalize_m3_m3(unit_mat, mat);
1302         mat3_normalized_to_eul(eul, unit_mat);
1303 }
1304
1305 /* XYZ order */
1306 void mat4_normalized_to_eul(float eul[3], float m[4][4])
1307 {
1308         float mat3[3][3];
1309         copy_m3_m4(mat3, m);
1310         mat3_normalized_to_eul(eul, mat3);
1311 }
1312 void mat4_to_eul(float eul[3], float m[4][4])
1313 {
1314         float mat3[3][3];
1315         copy_m3_m4(mat3, m);
1316         mat3_to_eul(eul, mat3);
1317 }
1318
1319 /* XYZ order */
1320 void quat_to_eul(float eul[3], const float quat[4])
1321 {
1322         float unit_mat[3][3];
1323         quat_to_mat3(unit_mat, quat);
1324         mat3_normalized_to_eul(eul, unit_mat);
1325 }
1326
1327 /* XYZ order */
1328 void eul_to_quat(float quat[4], const float eul[3])
1329 {
1330         float ti, tj, th, ci, cj, ch, si, sj, sh, cc, cs, sc, ss;
1331
1332         ti = eul[0] * 0.5f;
1333         tj = eul[1] * 0.5f;
1334         th = eul[2] * 0.5f;
1335         ci = cosf(ti);
1336         cj = cosf(tj);
1337         ch = cosf(th);
1338         si = sinf(ti);
1339         sj = sinf(tj);
1340         sh = sinf(th);
1341         cc = ci * ch;
1342         cs = ci * sh;
1343         sc = si * ch;
1344         ss = si * sh;
1345
1346         quat[0] = cj * cc + sj * ss;
1347         quat[1] = cj * sc - sj * cs;
1348         quat[2] = cj * ss + sj * cc;
1349         quat[3] = cj * cs - sj * sc;
1350 }
1351
1352 /* XYZ order */
1353 void rotate_eul(float beul[3], const char axis, const float ang)
1354 {
1355         float eul[3], mat1[3][3], mat2[3][3], totmat[3][3];
1356
1357         assert(axis >= 'X' && axis <= 'Z');
1358
1359         eul[0] = eul[1] = eul[2] = 0.0f;
1360         if (axis == 'X') eul[0] = ang;
1361         else if (axis == 'Y') eul[1] = ang;
1362         else eul[2] = ang;
1363
1364         eul_to_mat3(mat1, eul);
1365         eul_to_mat3(mat2, beul);
1366
1367         mul_m3_m3m3(totmat, mat2, mat1);
1368
1369         mat3_to_eul(beul, totmat);
1370 }
1371
1372 /* order independent! */
1373 void compatible_eul(float eul[3], const float oldrot[3])
1374 {
1375         /* we could use M_PI as pi_thresh: which is correct but 5.1 gives better results.
1376          * Checked with baking actions to fcurves - campbell */
1377         const float pi_thresh = (5.1f);
1378         const float pi_x2     = (2.0f * (float)M_PI);
1379
1380         float deul[3];
1381         unsigned int i;
1382
1383         /* correct differences of about 360 degrees first */
1384         for (i = 0; i < 3; i++) {
1385                 deul[i] = eul[i] - oldrot[i];
1386                 if (deul[i] > pi_thresh) {
1387                         eul[i] -= floorf(( deul[i] / pi_x2) + 0.5f) * pi_x2;
1388                         deul[i] = eul[i] - oldrot[i];
1389                 }
1390                 else if (deul[i] < -pi_thresh) {
1391                         eul[i] += floorf((-deul[i] / pi_x2) + 0.5f) * pi_x2;
1392                         deul[i] = eul[i] - oldrot[i];
1393                 }
1394         }
1395
1396         /* is 1 of the axis rotations larger than 180 degrees and the other small? NO ELSE IF!! */
1397         if (fabsf(deul[0]) > 3.2f && fabsf(deul[1]) < 1.6f && fabsf(deul[2]) < 1.6f) {
1398                 if (deul[0] > 0.0f) eul[0] -= pi_x2;
1399                 else                eul[0] += pi_x2;
1400         }
1401         if (fabsf(deul[1]) > 3.2f && fabsf(deul[2]) < 1.6f && fabsf(deul[0]) < 1.6f) {
1402                 if (deul[1] > 0.0f) eul[1] -= pi_x2;
1403                 else                eul[1] += pi_x2;
1404         }
1405         if (fabsf(deul[2]) > 3.2f && fabsf(deul[0]) < 1.6f && fabsf(deul[1]) < 1.6f) {
1406                 if (deul[2] > 0.0f) eul[2] -= pi_x2;
1407                 else                eul[2] += pi_x2;
1408         }
1409 }
1410
1411 /* uses 2 methods to retrieve eulers, and picks the closest */
1412
1413 /* XYZ order */
1414 void mat3_normalized_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3])
1415 {
1416         float eul1[3], eul2[3];
1417         float d1, d2;
1418
1419         mat3_normalized_to_eul2(mat, eul1, eul2);
1420
1421         compatible_eul(eul1, oldrot);
1422         compatible_eul(eul2, oldrot);
1423
1424         d1 = fabsf(eul1[0] - oldrot[0]) + fabsf(eul1[1] - oldrot[1]) + fabsf(eul1[2] - oldrot[2]);
1425         d2 = fabsf(eul2[0] - oldrot[0]) + fabsf(eul2[1] - oldrot[1]) + fabsf(eul2[2] - oldrot[2]);
1426
1427         /* return best, which is just the one with lowest difference */
1428         if (d1 > d2) {
1429                 copy_v3_v3(eul, eul2);
1430         }
1431         else {
1432                 copy_v3_v3(eul, eul1);
1433         }
1434 }
1435 void mat3_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3])
1436 {
1437         float unit_mat[3][3];
1438         normalize_m3_m3(unit_mat, mat);
1439         mat3_normalized_to_compatible_eul(eul, oldrot, unit_mat);
1440 }
1441
1442 void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4])
1443 {
1444         float unit_mat[3][3];
1445         quat_to_mat3(unit_mat, quat);
1446         mat3_normalized_to_compatible_eul(eul, oldrot, unit_mat);
1447 }
1448
1449 /************************** Arbitrary Order Eulers ***************************/
1450
1451 /* Euler Rotation Order Code:
1452  * was adapted from
1453  *      ANSI C code from the article
1454  *      "Euler Angle Conversion"
1455  *      by Ken Shoemake, shoemake@graphics.cis.upenn.edu
1456  *      in "Graphics Gems IV", Academic Press, 1994
1457  * for use in Blender
1458  */
1459
1460 /* Type for rotation order info - see wiki for derivation details */
1461 typedef struct RotOrderInfo {
1462         short axis[3];
1463         short parity; /* parity of axis permutation (even=0, odd=1) - 'n' in original code */
1464 } RotOrderInfo;
1465
1466 /* Array of info for Rotation Order calculations
1467  * WARNING: must be kept in same order as eEulerRotationOrders
1468  */
1469 static const RotOrderInfo rotOrders[] = {
1470         /* i, j, k, n */
1471         {{0, 1, 2}, 0}, /* XYZ */
1472         {{0, 2, 1}, 1}, /* XZY */
1473         {{1, 0, 2}, 1}, /* YXZ */
1474         {{1, 2, 0}, 0}, /* YZX */
1475         {{2, 0, 1}, 0}, /* ZXY */
1476         {{2, 1, 0}, 1}  /* ZYX */
1477 };
1478
1479 /* Get relevant pointer to rotation order set from the array
1480  * NOTE: since we start at 1 for the values, but arrays index from 0,
1481  *       there is -1 factor involved in this process...
1482  */
1483 static const RotOrderInfo *get_rotation_order_info(const short order)
1484 {
1485         assert(order >= 0 && order <= 6);
1486         if (order < 1)
1487                 return &rotOrders[0];
1488         else if (order < 6)
1489                 return &rotOrders[order - 1];
1490         else
1491                 return &rotOrders[5];
1492 }
1493
1494 /* Construct quaternion from Euler angles (in radians). */
1495 void eulO_to_quat(float q[4], const float e[3], const short order)
1496 {
1497         const RotOrderInfo *R = get_rotation_order_info(order);
1498         short i = R->axis[0], j = R->axis[1], k = R->axis[2];
1499         double ti, tj, th, ci, cj, ch, si, sj, sh, cc, cs, sc, ss;
1500         double a[3];
1501
1502         ti = e[i] * 0.5f;
1503         tj = e[j] * (R->parity ? -0.5f : 0.5f);
1504         th = e[k] * 0.5f;
1505
1506         ci = cos(ti);
1507         cj = cos(tj);
1508         ch = cos(th);
1509         si = sin(ti);
1510         sj = sin(tj);
1511         sh = sin(th);
1512
1513         cc = ci * ch;
1514         cs = ci * sh;
1515         sc = si * ch;
1516         ss = si * sh;
1517
1518         a[i] = cj * sc - sj * cs;
1519         a[j] = cj * ss + sj * cc;
1520         a[k] = cj * cs - sj * sc;
1521
1522         q[0] = (float)(cj * cc + sj * ss);
1523         q[1] = (float)(a[0]);
1524         q[2] = (float)(a[1]);
1525         q[3] = (float)(a[2]);
1526
1527         if (R->parity) q[j + 1] = -q[j + 1];
1528 }
1529
1530 /* Convert quaternion to Euler angles (in radians). */
1531 void quat_to_eulO(float e[3], short const order, const float q[4])
1532 {
1533         float unit_mat[3][3];
1534
1535         quat_to_mat3(unit_mat, q);
1536         mat3_normalized_to_eulO(e, order, unit_mat);
1537 }
1538
1539 /* Construct 3x3 matrix from Euler angles (in radians). */
1540 void eulO_to_mat3(float M[3][3], const float e[3], const short order)
1541 {
1542         const RotOrderInfo *R = get_rotation_order_info(order);
1543         short i = R->axis[0], j = R->axis[1], k = R->axis[2];
1544         double ti, tj, th, ci, cj, ch, si, sj, sh, cc, cs, sc, ss;
1545
1546         if (R->parity) {
1547                 ti = -e[i];
1548                 tj = -e[j];
1549                 th = -e[k];
1550         }
1551         else {
1552                 ti = e[i];
1553                 tj = e[j];
1554                 th = e[k];
1555         }
1556
1557         ci = cos(ti);
1558         cj = cos(tj);
1559         ch = cos(th);
1560         si = sin(ti);
1561         sj = sin(tj);
1562         sh = sin(th);
1563
1564         cc = ci * ch;
1565         cs = ci * sh;
1566         sc = si * ch;
1567         ss = si * sh;
1568
1569         M[i][i] = (float)(cj * ch);
1570         M[j][i] = (float)(sj * sc - cs);
1571         M[k][i] = (float)(sj * cc + ss);
1572         M[i][j] = (float)(cj * sh);
1573         M[j][j] = (float)(sj * ss + cc);
1574         M[k][j] = (float)(sj * cs - sc);
1575         M[i][k] = (float)(-sj);
1576         M[j][k] = (float)(cj * si);
1577         M[k][k] = (float)(cj * ci);
1578 }
1579
1580 /* returns two euler calculation methods, so we can pick the best */
1581 static void mat3_normalized_to_eulo2(float mat[3][3], float eul1[3], float eul2[3], const short order)
1582 {
1583         const RotOrderInfo *R = get_rotation_order_info(order);
1584         short i = R->axis[0], j = R->axis[1], k = R->axis[2];
1585         float cy;
1586
1587         BLI_ASSERT_UNIT_M3(mat);
1588
1589         cy = hypotf(mat[i][i], mat[i][j]);
1590
1591         if (cy > 16.0f * FLT_EPSILON) {
1592                 eul1[i] = atan2f(mat[j][k], mat[k][k]);
1593                 eul1[j] = atan2f(-mat[i][k], cy);
1594                 eul1[k] = atan2f(mat[i][j], mat[i][i]);
1595
1596                 eul2[i] = atan2f(-mat[j][k], -mat[k][k]);
1597                 eul2[j] = atan2f(-mat[i][k], -cy);
1598                 eul2[k] = atan2f(-mat[i][j], -mat[i][i]);
1599         }
1600         else {
1601                 eul1[i] = atan2f(-mat[k][j], mat[j][j]);
1602                 eul1[j] = atan2f(-mat[i][k], cy);
1603                 eul1[k] = 0;
1604
1605                 copy_v3_v3(eul2, eul1);
1606         }
1607
1608         if (R->parity) {
1609                 negate_v3(eul1);
1610                 negate_v3(eul2);
1611         }
1612 }
1613
1614 /* Construct 4x4 matrix from Euler angles (in radians). */
1615 void eulO_to_mat4(float mat[4][4], const float e[3], const short order)
1616 {
1617         float unit_mat[3][3];
1618
1619         /* for now, we'll just do this the slow way (i.e. copying matrices) */
1620         eulO_to_mat3(unit_mat, e, order);
1621         copy_m4_m3(mat, unit_mat);
1622 }
1623
1624 /* Convert 3x3 matrix to Euler angles (in radians). */
1625 void mat3_normalized_to_eulO(float eul[3], const short order, float m[3][3])
1626 {
1627         float eul1[3], eul2[3];
1628         float d1, d2;
1629
1630         mat3_normalized_to_eulo2(m, eul1, eul2, order);
1631
1632         d1 = fabsf(eul1[0]) + fabsf(eul1[1]) + fabsf(eul1[2]);
1633         d2 = fabsf(eul2[0]) + fabsf(eul2[1]) + fabsf(eul2[2]);
1634
1635         /* return best, which is just the one with lowest values it in */
1636         if (d1 > d2) {
1637                 copy_v3_v3(eul, eul2);
1638         }
1639         else {
1640                 copy_v3_v3(eul, eul1);
1641         }
1642 }
1643 void mat3_to_eulO(float eul[3], const short order, float m[3][3])
1644 {
1645         float unit_mat[3][3];
1646         normalize_m3_m3(unit_mat, m);
1647         mat3_normalized_to_eulO(eul, order, unit_mat);
1648 }
1649
1650 /* Convert 4x4 matrix to Euler angles (in radians). */
1651 void mat4_normalized_to_eulO(float eul[3], const short order, float m[4][4])
1652 {
1653         float mat3[3][3];
1654
1655         /* for now, we'll just do this the slow way (i.e. copying matrices) */
1656         copy_m3_m4(mat3, m);
1657         mat3_normalized_to_eulO(eul, order, mat3);
1658 }
1659
1660 void mat4_to_eulO(float eul[3], const short order, float m[4][4])
1661 {
1662         float mat3[3][3];
1663         copy_m3_m4(mat3, m);
1664         normalize_m3(mat3);
1665         mat3_normalized_to_eulO(eul, order, mat3);
1666 }
1667
1668
1669 /* uses 2 methods to retrieve eulers, and picks the closest */
1670 void mat3_normalized_to_compatible_eulO(float eul[3], float oldrot[3], const short order, float mat[3][3])
1671 {
1672         float eul1[3], eul2[3];
1673         float d1, d2;
1674
1675         mat3_normalized_to_eulo2(mat, eul1, eul2, order);
1676
1677         compatible_eul(eul1, oldrot);
1678         compatible_eul(eul2, oldrot);
1679
1680         d1 = fabsf(eul1[0] - oldrot[0]) + fabsf(eul1[1] - oldrot[1]) + fabsf(eul1[2] - oldrot[2]);
1681         d2 = fabsf(eul2[0] - oldrot[0]) + fabsf(eul2[1] - oldrot[1]) + fabsf(eul2[2] - oldrot[2]);
1682
1683         /* return best, which is just the one with lowest difference */
1684         if (d1 > d2) {
1685                 copy_v3_v3(eul, eul2);
1686         }
1687         else {
1688                 copy_v3_v3(eul, eul1);
1689         }
1690 }
1691 void mat3_to_compatible_eulO(float eul[3], float oldrot[3], const short order, float mat[3][3])
1692 {
1693         float unit_mat[3][3];
1694
1695         normalize_m3_m3(unit_mat, mat);
1696         mat3_normalized_to_compatible_eulO(eul, oldrot, order, unit_mat);
1697 }
1698
1699 void mat4_normalized_to_compatible_eulO(float eul[3], float oldrot[3], const short order, float m[4][4])
1700 {
1701         float mat3[3][3];
1702
1703         /* for now, we'll just do this the slow way (i.e. copying matrices) */
1704         copy_m3_m4(mat3, m);
1705         mat3_normalized_to_compatible_eulO(eul, oldrot, order, mat3);
1706 }
1707 void mat4_to_compatible_eulO(float eul[3], float oldrot[3], const short order, float m[4][4])
1708 {
1709         float mat3[3][3];
1710
1711         /* for now, we'll just do this the slow way (i.e. copying matrices) */
1712         copy_m3_m4(mat3, m);
1713         normalize_m3(mat3);
1714         mat3_normalized_to_compatible_eulO(eul, oldrot, order, mat3);
1715 }
1716
1717 void quat_to_compatible_eulO(float eul[3], float oldrot[3], const short order, const float quat[4])
1718 {
1719         float unit_mat[3][3];
1720
1721         quat_to_mat3(unit_mat, quat);
1722         mat3_normalized_to_compatible_eulO(eul, oldrot, order, unit_mat);
1723 }
1724
1725 /* rotate the given euler by the given angle on the specified axis */
1726 /* NOTE: is this safe to do with different axis orders? */
1727
1728 void rotate_eulO(float beul[3], const short order, char axis, float ang)
1729 {
1730         float eul[3], mat1[3][3], mat2[3][3], totmat[3][3];
1731
1732         assert(axis >= 'X' && axis <= 'Z');
1733
1734         zero_v3(eul);
1735
1736         if (axis == 'X')
1737                 eul[0] = ang;
1738         else if (axis == 'Y')
1739                 eul[1] = ang;
1740         else
1741                 eul[2] = ang;
1742
1743         eulO_to_mat3(mat1, eul, order);
1744         eulO_to_mat3(mat2, beul, order);
1745
1746         mul_m3_m3m3(totmat, mat2, mat1);
1747
1748         mat3_to_eulO(beul, order, totmat);
1749 }
1750
1751 /* the matrix is written to as 3 axis vectors */
1752 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order)
1753 {
1754         const RotOrderInfo *R = get_rotation_order_info(order);
1755
1756         float mat[3][3];
1757         float teul[3];
1758
1759         /* first axis is local */
1760         eulO_to_mat3(mat, eul, order);
1761         copy_v3_v3(gmat[R->axis[0]], mat[R->axis[0]]);
1762
1763         /* second axis is local minus first rotation */
1764         copy_v3_v3(teul, eul);
1765         teul[R->axis[0]] = 0;
1766         eulO_to_mat3(mat, teul, order);
1767         copy_v3_v3(gmat[R->axis[1]], mat[R->axis[1]]);
1768
1769
1770         /* Last axis is global */
1771         zero_v3(gmat[R->axis[2]]);
1772         gmat[R->axis[2]][R->axis[2]] = 1;
1773 }
1774
1775 /******************************* Dual Quaternions ****************************/
1776
1777 /**
1778  * Conversion routines between (regular quaternion, translation) and
1779  * dual quaternion.
1780  *
1781  * Version 1.0.0, February 7th, 2007
1782  *
1783  * Copyright (C) 2006-2007 University of Dublin, Trinity College, All Rights
1784  * Reserved
1785  *
1786  * This software is provided 'as-is', without any express or implied
1787  * warranty.  In no event will the author(s) be held liable for any damages
1788  * arising from the use of this software.
1789  *
1790  * Permission is granted to anyone to use this software for any purpose,
1791  * including commercial applications, and to alter it and redistribute it
1792  * freely, subject to the following restrictions:
1793  *
1794  * 1. The origin of this software must not be misrepresented; you must not
1795  *    claim that you wrote the original software. If you use this software
1796  *    in a product, an acknowledgment in the product documentation would be
1797  *    appreciated but is not required.
1798  * 2. Altered source versions must be plainly marked as such, and must not be
1799  *    misrepresented as being the original software.
1800  * 3. This notice may not be removed or altered from any source distribution.
1801  *
1802  * \author Ladislav Kavan, kavanl@cs.tcd.ie
1803  *
1804  * Changes for Blender:
1805  * - renaming, style changes and optimization's
1806  * - added support for scaling
1807  */
1808
1809 void mat4_to_dquat(DualQuat *dq, float basemat[4][4], float mat[4][4])
1810 {
1811         float *t, *q, dscale[3], scale[3], basequat[4], mat3[3][3];
1812         float baseRS[4][4], baseinv[4][4], baseR[4][4], baseRinv[4][4];
1813         float R[4][4], S[4][4];
1814
1815         /* split scaling and rotation, there is probably a faster way to do
1816          * this, it's done like this now to correctly get negative scaling */
1817         mul_m4_m4m4(baseRS, mat, basemat);
1818         mat4_to_size(scale, baseRS);
1819
1820         dscale[0] = scale[0] - 1.0f;
1821         dscale[1] = scale[1] - 1.0f;
1822         dscale[2] = scale[2] - 1.0f;
1823
1824         copy_m3_m4(mat3, mat);
1825
1826         if (!is_orthonormal_m3(mat3) || (determinant_m4(mat) < 0.0f) || len_squared_v3(dscale) > SQUARE(1e-4f)) {
1827                 /* extract R and S  */
1828                 float tmp[4][4];
1829
1830                 /* extra orthogonalize, to avoid flipping with stretched bones */
1831                 copy_m4_m4(tmp, baseRS);
1832                 orthogonalize_m4(tmp, 1);
1833                 mat4_to_quat(basequat, tmp);
1834
1835                 quat_to_mat4(baseR, basequat);
1836                 copy_v3_v3(baseR[3], baseRS[3]);
1837
1838                 invert_m4_m4(baseinv, basemat);
1839                 mul_m4_m4m4(R, baseR, baseinv);
1840
1841                 invert_m4_m4(baseRinv, baseR);
1842                 mul_m4_m4m4(S, baseRinv, baseRS);
1843
1844                 /* set scaling part */
1845                 mul_m4_series(dq->scale, basemat, S, baseinv);
1846                 dq->scale_weight = 1.0f;
1847         }
1848         else {
1849                 /* matrix does not contain scaling */
1850                 copy_m4_m4(R, mat);
1851                 dq->scale_weight = 0.0f;
1852         }
1853
1854         /* non-dual part */
1855         mat4_to_quat(dq->quat, R);
1856
1857         /* dual part */
1858         t = R[3];
1859         q = dq->quat;
1860         dq->trans[0] = -0.5f * ( t[0] * q[1] + t[1] * q[2] + t[2] * q[3]);
1861         dq->trans[1] =  0.5f * ( t[0] * q[0] + t[1] * q[3] - t[2] * q[2]);
1862         dq->trans[2] =  0.5f * (-t[0] * q[3] + t[1] * q[0] + t[2] * q[1]);
1863         dq->trans[3] =  0.5f * ( t[0] * q[2] - t[1] * q[1] + t[2] * q[0]);
1864 }
1865
1866 void dquat_to_mat4(float mat[4][4], const DualQuat *dq)
1867 {
1868         float len, q0[4];
1869         const float *t;
1870
1871         /* regular quaternion */
1872         copy_qt_qt(q0, dq->quat);
1873
1874         /* normalize */
1875         len = sqrtf(dot_qtqt(q0, q0));
1876         if (len != 0.0f) {
1877                 len = 1.0f / len;
1878         }
1879         mul_qt_fl(q0, len);
1880
1881         /* rotation */
1882         quat_to_mat4(mat, q0);
1883
1884         /* translation */
1885         t = dq->trans;
1886         mat[3][0] = 2.0f * (-t[0] * q0[1] + t[1] * q0[0] - t[2] * q0[3] + t[3] * q0[2]) * len;
1887         mat[3][1] = 2.0f * (-t[0] * q0[2] + t[1] * q0[3] + t[2] * q0[0] - t[3] * q0[1]) * len;
1888         mat[3][2] = 2.0f * (-t[0] * q0[3] - t[1] * q0[2] + t[2] * q0[1] + t[3] * q0[0]) * len;
1889
1890         /* scaling */
1891         if (dq->scale_weight) {
1892                 mul_m4_m4m4(mat, mat, dq->scale);
1893         }
1894 }
1895
1896 void add_weighted_dq_dq(DualQuat *dqsum, const DualQuat *dq, float weight)
1897 {
1898         bool flipped = false;
1899
1900         /* make sure we interpolate quats in the right direction */
1901         if (dot_qtqt(dq->quat, dqsum->quat) < 0) {
1902                 flipped = true;
1903                 weight = -weight;
1904         }
1905
1906         /* interpolate rotation and translation */
1907         dqsum->quat[0] += weight * dq->quat[0];
1908         dqsum->quat[1] += weight * dq->quat[1];
1909         dqsum->quat[2] += weight * dq->quat[2];
1910         dqsum->quat[3] += weight * dq->quat[3];
1911
1912         dqsum->trans[0] += weight * dq->trans[0];
1913         dqsum->trans[1] += weight * dq->trans[1];
1914         dqsum->trans[2] += weight * dq->trans[2];
1915         dqsum->trans[3] += weight * dq->trans[3];
1916
1917         /* interpolate scale - but only if needed */
1918         if (dq->scale_weight) {
1919                 float wmat[4][4];
1920
1921                 if (flipped) /* we don't want negative weights for scaling */
1922                         weight = -weight;
1923
1924                 copy_m4_m4(wmat, (float(*)[4])dq->scale);
1925                 mul_m4_fl(wmat, weight);
1926                 add_m4_m4m4(dqsum->scale, dqsum->scale, wmat);
1927                 dqsum->scale_weight += weight;
1928         }
1929 }
1930
1931 void normalize_dq(DualQuat *dq, float totweight)
1932 {
1933         const float scale = 1.0f / totweight;
1934
1935         mul_qt_fl(dq->quat, scale);
1936         mul_qt_fl(dq->trans, scale);
1937
1938         if (dq->scale_weight) {
1939                 float addweight = totweight - dq->scale_weight;
1940
1941                 if (addweight) {
1942                         dq->scale[0][0] += addweight;
1943                         dq->scale[1][1] += addweight;
1944                         dq->scale[2][2] += addweight;
1945                         dq->scale[3][3] += addweight;
1946                 }
1947
1948                 mul_m4_fl(dq->scale, scale);
1949                 dq->scale_weight = 1.0f;
1950         }
1951 }
1952
1953 void mul_v3m3_dq(float co[3], float mat[3][3], DualQuat *dq)
1954 {
1955         float M[3][3], t[3], scalemat[3][3], len2;
1956         float w = dq->quat[0], x = dq->quat[1], y = dq->quat[2], z = dq->quat[3];
1957         float t0 = dq->trans[0], t1 = dq->trans[1], t2 = dq->trans[2], t3 = dq->trans[3];
1958
1959         /* rotation matrix */
1960         M[0][0] = w * w + x * x - y * y - z * z;
1961         M[1][0] = 2 * (x * y - w * z);
1962         M[2][0] = 2 * (x * z + w * y);
1963
1964         M[0][1] = 2 * (x * y + w * z);
1965         M[1][1] = w * w + y * y - x * x - z * z;
1966         M[2][1] = 2 * (y * z - w * x);
1967
1968         M[0][2] = 2 * (x * z - w * y);
1969         M[1][2] = 2 * (y * z + w * x);
1970         M[2][2] = w * w + z * z - x * x - y * y;
1971
1972         len2 = dot_qtqt(dq->quat, dq->quat);
1973         if (len2 > 0.0f)
1974                 len2 = 1.0f / len2;
1975
1976         /* translation */
1977         t[0] = 2 * (-t0 * x + w * t1 - t2 * z + y * t3);
1978         t[1] = 2 * (-t0 * y + t1 * z - x * t3 + w * t2);
1979         t[2] = 2 * (-t0 * z + x * t2 + w * t3 - t1 * y);
1980
1981         /* apply scaling */
1982         if (dq->scale_weight)
1983                 mul_m4_v3(dq->scale, co);
1984
1985         /* apply rotation and translation */
1986         mul_m3_v3(M, co);
1987         co[0] = (co[0] + t[0]) * len2;
1988         co[1] = (co[1] + t[1]) * len2;
1989         co[2] = (co[2] + t[2]) * len2;
1990
1991         /* compute crazyspace correction mat */
1992         if (mat) {
1993                 if (dq->scale_weight) {
1994                         copy_m3_m4(scalemat, dq->scale);
1995                         mul_m3_m3m3(mat, M, scalemat);
1996                 }
1997                 else
1998                         copy_m3_m3(mat, M);
1999                 mul_m3_fl(mat, len2);
2000         }
2001 }
2002
2003 void copy_dq_dq(DualQuat *dq1, const DualQuat *dq2)
2004 {
2005         memcpy(dq1, dq2, sizeof(DualQuat));
2006 }
2007
2008 /* axis matches eTrackToAxis_Modes */
2009 void quat_apply_track(float quat[4], short axis, short upflag)
2010 {
2011         /* rotations are hard coded to match vec_to_quat */
2012         const float sqrt_1_2 = (float)M_SQRT1_2;
2013         const float quat_track[][4] = {
2014                 {sqrt_1_2, 0.0, -sqrt_1_2, 0.0}, /* pos-y90 */
2015                 {0.5, 0.5, 0.5, 0.5}, /* Quaternion((1,0,0), radians(90)) * Quaternion((0,1,0), radians(90)) */
2016                 {sqrt_1_2, 0.0, 0.0, sqrt_1_2}, /* pos-z90 */
2017                 {sqrt_1_2, 0.0, sqrt_1_2, 0.0}, /* neg-y90 */
2018                 {0.5, -0.5, -0.5, 0.5}, /* Quaternion((1,0,0), radians(-90)) * Quaternion((0,1,0), radians(-90)) */
2019                 {0.0, sqrt_1_2, sqrt_1_2, 0.0} /* no rotation */
2020         };
2021
2022         assert(axis >= 0 && axis <= 5);
2023         assert(upflag >= 0 && upflag <= 2);
2024
2025         mul_qt_qtqt(quat, quat, quat_track[axis]);
2026
2027         if (axis > 2) {
2028                 axis = (short)(axis - 3);
2029         }
2030
2031         /* there are 2 possible up-axis for each axis used, the 'quat_track' applies so the first
2032          * up axis is used X->Y, Y->X, Z->X, if this first up axis isn't used then rotate 90d
2033          * the strange bit shift below just find the low axis {X:Y, Y:X, Z:X} */
2034         if (upflag != (2 - axis) >> 1) {
2035                 float q[4] = {sqrt_1_2, 0.0, 0.0, 0.0}; /* assign 90d rotation axis */
2036                 q[axis + 1] = ((axis == 1)) ? sqrt_1_2 : -sqrt_1_2; /* flip non Y axis */
2037                 mul_qt_qtqt(quat, quat, q);
2038         }
2039 }
2040
2041 void vec_apply_track(float vec[3], short axis)
2042 {
2043         float tvec[3];
2044
2045         assert(axis >= 0 && axis <= 5);
2046
2047         copy_v3_v3(tvec, vec);
2048
2049         switch (axis) {
2050                 case 0: /* pos-x */
2051                         /* vec[0] =  0.0; */
2052                         vec[1] = tvec[2];
2053                         vec[2] = -tvec[1];
2054                         break;
2055                 case 1: /* pos-y */
2056                         /* vec[0] = tvec[0]; */
2057                         /* vec[1] =  0.0; */
2058                         /* vec[2] = tvec[2]; */
2059                         break;
2060                 case 2: /* pos-z */
2061                         /* vec[0] = tvec[0]; */
2062                         /* vec[1] = tvec[1]; */
2063                         /* vec[2] =  0.0; */
2064                         break;
2065                 case 3: /* neg-x */
2066                         /* vec[0] =  0.0; */
2067                         vec[1] = tvec[2];
2068                         vec[2] = -tvec[1];
2069                         break;
2070                 case 4: /* neg-y */
2071                         vec[0] = -tvec[2];
2072                         /* vec[1] =  0.0; */
2073                         vec[2] = tvec[0];
2074                         break;
2075                 case 5: /* neg-z */
2076                         vec[0] = -tvec[0];
2077                         vec[1] = -tvec[1];
2078                         /* vec[2] =  0.0; */
2079                         break;
2080         }
2081 }
2082
2083 /* lens/angle conversion (radians) */
2084 float focallength_to_fov(float focal_length, float sensor)
2085 {
2086         return 2.0f * atanf((sensor / 2.0f) / focal_length);
2087 }
2088
2089 float fov_to_focallength(float hfov, float sensor)
2090 {
2091         return (sensor / 2.0f) / tanf(hfov * 0.5f);
2092 }
2093
2094 /* 'mod_inline(-3, 4)= 1', 'fmod(-3, 4)= -3' */
2095 static float mod_inline(float a, float b)
2096 {
2097         return a - (b * floorf(a / b));
2098 }
2099
2100 float angle_wrap_rad(float angle)
2101 {
2102         return mod_inline(angle + (float)M_PI, (float)M_PI * 2.0f) - (float)M_PI;
2103 }
2104
2105 float angle_wrap_deg(float angle)
2106 {
2107         return mod_inline(angle + 180.0f, 360.0f) - 180.0f;
2108 }
2109
2110 /* returns an angle compatible with angle_compat */
2111 float angle_compat_rad(float angle, float angle_compat)
2112 {
2113         return angle_compat + angle_wrap_rad(angle - angle_compat);
2114 }
2115
2116 /* axis conversion */
2117 static float _axis_convert_matrix[23][3][3] = {
2118         {{-1.0, 0.0, 0.0}, {0.0, -1.0, 0.0}, {0.0, 0.0, 1.0}},
2119         {{-1.0, 0.0, 0.0}, {0.0, 0.0, -1.0}, {0.0, -1.0, 0.0}},
2120         {{-1.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {0.0, 1.0, 0.0}},
2121         {{-1.0, 0.0, 0.0}, {0.0, 1.0, 0.0}, {0.0, 0.0, -1.0}},
2122         {{0.0, -1.0, 0.0}, {-1.0, 0.0, 0.0}, {0.0, 0.0, -1.0}},
2123         {{0.0, 0.0, 1.0}, {-1.0, 0.0, 0.0}, {0.0, -1.0, 0.0}},
2124         {{0.0, 0.0, -1.0}, {-1.0, 0.0, 0.0}, {0.0, 1.0, 0.0}},
2125         {{0.0, 1.0, 0.0}, {-1.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},
2126         {{0.0, -1.0, 0.0}, {0.0, 0.0, 1.0}, {-1.0, 0.0, 0.0}},
2127         {{0.0, 0.0, -1.0}, {0.0, -1.0, 0.0}, {-1.0, 0.0, 0.0}},
2128         {{0.0, 0.0, 1.0}, {0.0, 1.0, 0.0}, {-1.0, 0.0, 0.0}},
2129         {{0.0, 1.0, 0.0}, {0.0, 0.0, -1.0}, {-1.0, 0.0, 0.0}},
2130         {{0.0, -1.0, 0.0}, {0.0, 0.0, -1.0}, {1.0, 0.0, 0.0}},
2131         {{0.0, 0.0, 1.0}, {0.0, -1.0, 0.0}, {1.0, 0.0, 0.0}},
2132         {{0.0, 0.0, -1.0}, {0.0, 1.0, 0.0}, {1.0, 0.0, 0.0}},
2133         {{0.0, 1.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},
2134         {{0.0, -1.0, 0.0}, {1.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},
2135         {{0.0, 0.0, -1.0}, {1.0, 0.0, 0.0}, {0.0, -1.0, 0.0}},
2136         {{0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}, {0.0, 1.0, 0.0}},
2137         {{0.0, 1.0, 0.0}, {1.0, 0.0, 0.0}, {0.0, 0.0, -1.0}},
2138         {{1.0, 0.0, 0.0}, {0.0, -1.0, 0.0}, {0.0, 0.0, -1.0}},
2139         {{1.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {0.0, -1.0, 0.0}},
2140         {{1.0, 0.0, 0.0}, {0.0, 0.0, -1.0}, {0.0, 1.0, 0.0}},
2141 };
2142
2143 static int _axis_convert_lut[23][24] = {
2144         {0x8C8, 0x4D0, 0x2E0, 0xAE8, 0x701, 0x511, 0x119, 0xB29, 0x682, 0x88A,
2145          0x09A, 0x2A2, 0x80B, 0x413, 0x223, 0xA2B, 0x644, 0x454, 0x05C, 0xA6C,
2146          0x745, 0x94D, 0x15D, 0x365},
2147         {0xAC8, 0x8D0, 0x4E0, 0x2E8, 0x741, 0x951, 0x159, 0x369, 0x702, 0xB0A,
2148          0x11A, 0x522, 0xA0B, 0x813, 0x423, 0x22B, 0x684, 0x894, 0x09C, 0x2AC,
2149          0x645, 0xA4D, 0x05D, 0x465},
2150         {0x4C8, 0x2D0, 0xAE0, 0x8E8, 0x681, 0x291, 0x099, 0x8A9, 0x642, 0x44A,
2151          0x05A, 0xA62, 0x40B, 0x213, 0xA23, 0x82B, 0x744, 0x354, 0x15C, 0x96C,
2152          0x705, 0x50D, 0x11D, 0xB25},
2153         {0x2C8, 0xAD0, 0x8E0, 0x4E8, 0x641, 0xA51, 0x059, 0x469, 0x742, 0x34A,
2154          0x15A, 0x962, 0x20B, 0xA13, 0x823, 0x42B, 0x704, 0xB14, 0x11C, 0x52C,
2155          0x685, 0x28D, 0x09D, 0x8A5},
2156         {0x708, 0xB10, 0x120, 0x528, 0x8C1, 0xAD1, 0x2D9, 0x4E9, 0x942, 0x74A,
2157          0x35A, 0x162, 0x64B, 0xA53, 0x063, 0x46B, 0x804, 0xA14, 0x21C, 0x42C,
2158          0x885, 0x68D, 0x29D, 0x0A5},
2159         {0xB08, 0x110, 0x520, 0x728, 0x941, 0x151, 0x359, 0x769, 0x802, 0xA0A,
2160          0x21A, 0x422, 0xA4B, 0x053, 0x463, 0x66B, 0x884, 0x094, 0x29C, 0x6AC,
2161          0x8C5, 0xACD, 0x2DD, 0x4E5},
2162         {0x508, 0x710, 0xB20, 0x128, 0x881, 0x691, 0x299, 0x0A9, 0x8C2, 0x4CA,
2163          0x2DA, 0xAE2, 0x44B, 0x653, 0xA63, 0x06B, 0x944, 0x754, 0x35C, 0x16C,
2164          0x805, 0x40D, 0x21D, 0xA25},
2165         {0x108, 0x510, 0x720, 0xB28, 0x801, 0x411, 0x219, 0xA29, 0x882, 0x08A,
2166          0x29A, 0x6A2, 0x04B, 0x453, 0x663, 0xA6B, 0x8C4, 0x4D4, 0x2DC, 0xAEC,
2167          0x945, 0x14D, 0x35D, 0x765},
2168         {0x748, 0x350, 0x160, 0x968, 0xAC1, 0x2D1, 0x4D9, 0x8E9, 0xA42, 0x64A,
2169          0x45A, 0x062, 0x68B, 0x293, 0x0A3, 0x8AB, 0xA04, 0x214, 0x41C, 0x82C,
2170          0xB05, 0x70D, 0x51D, 0x125},
2171         {0x948, 0x750, 0x360, 0x168, 0xB01, 0x711, 0x519, 0x129, 0xAC2, 0x8CA,
2172          0x4DA, 0x2E2, 0x88B, 0x693, 0x2A3, 0x0AB, 0xA44, 0x654, 0x45C, 0x06C,
2173          0xA05, 0x80D, 0x41D, 0x225},
2174         {0x348, 0x150, 0x960, 0x768, 0xA41, 0x051, 0x459, 0x669, 0xA02, 0x20A,
2175          0x41A, 0x822, 0x28B, 0x093, 0x8A3, 0x6AB, 0xB04, 0x114, 0x51C, 0x72C,
2176          0xAC5, 0x2CD, 0x4DD, 0x8E5},
2177         {0x148, 0x950, 0x760, 0x368, 0xA01, 0x811, 0x419, 0x229, 0xB02, 0x10A,
2178          0x51A, 0x722, 0x08B, 0x893, 0x6A3, 0x2AB, 0xAC4, 0x8D4, 0x4DC, 0x2EC,
2179          0xA45, 0x04D, 0x45D, 0x665},
2180         {0x688, 0x890, 0x0A0, 0x2A8, 0x4C1, 0x8D1, 0xAD9, 0x2E9, 0x502, 0x70A,
2181          0xB1A, 0x122, 0x74B, 0x953, 0x163, 0x36B, 0x404, 0x814, 0xA1C, 0x22C,
2182          0x445, 0x64D, 0xA5D, 0x065},
2183         {0x888, 0x090, 0x2A0, 0x6A8, 0x501, 0x111, 0xB19, 0x729, 0x402, 0x80A,
2184          0xA1A, 0x222, 0x94B, 0x153, 0x363, 0x76B, 0x444, 0x054, 0xA5C, 0x66C,
2185          0x4C5, 0x8CD, 0xADD, 0x2E5},
2186         {0x288, 0x690, 0x8A0, 0x0A8, 0x441, 0x651, 0xA59, 0x069, 0x4C2, 0x2CA,
2187          0xADA, 0x8E2, 0x34B, 0x753, 0x963, 0x16B, 0x504, 0x714, 0xB1C, 0x12C,
2188          0x405, 0x20D, 0xA1D, 0x825},
2189         {0x088, 0x290, 0x6A0, 0x8A8, 0x401, 0x211, 0xA19, 0x829, 0x442, 0x04A,
2190          0xA5A, 0x662, 0x14B, 0x353, 0x763, 0x96B, 0x4C4, 0x2D4, 0xADC, 0x8EC,
2191          0x505, 0x10D, 0xB1D, 0x725},
2192         {0x648, 0x450, 0x060, 0xA68, 0x2C1, 0x4D1, 0x8D9, 0xAE9, 0x282, 0x68A,
2193          0x89A, 0x0A2, 0x70B, 0x513, 0x123, 0xB2B, 0x204, 0x414, 0x81C, 0xA2C,
2194          0x345, 0x74D, 0x95D, 0x165},
2195         {0xA48, 0x650, 0x460, 0x068, 0x341, 0x751, 0x959, 0x169, 0x2C2, 0xACA,
2196          0x8DA, 0x4E2, 0xB0B, 0x713, 0x523, 0x12B, 0x284, 0x694, 0x89C, 0x0AC,
2197          0x205, 0xA0D, 0x81D, 0x425},
2198         {0x448, 0x050, 0xA60, 0x668, 0x281, 0x091, 0x899, 0x6A9, 0x202, 0x40A,
2199          0x81A, 0xA22, 0x50B, 0x113, 0xB23, 0x72B, 0x344, 0x154, 0x95C, 0x76C,
2200          0x2C5, 0x4CD, 0x8DD, 0xAE5},
2201         {0x048, 0xA50, 0x660, 0x468, 0x201, 0xA11, 0x819, 0x429, 0x342, 0x14A,
2202          0x95A, 0x762, 0x10B, 0xB13, 0x723, 0x52B, 0x2C4, 0xAD4, 0x8DC, 0x4EC,
2203          0x285, 0x08D, 0x89D, 0x6A5},
2204         {0x808, 0xA10, 0x220, 0x428, 0x101, 0xB11, 0x719, 0x529, 0x142, 0x94A,
2205          0x75A, 0x362, 0x8CB, 0xAD3, 0x2E3, 0x4EB, 0x044, 0xA54, 0x65C, 0x46C,
2206          0x085, 0x88D, 0x69D, 0x2A5},
2207         {0xA08, 0x210, 0x420, 0x828, 0x141, 0x351, 0x759, 0x969, 0x042, 0xA4A,
2208          0x65A, 0x462, 0xACB, 0x2D3, 0x4E3, 0x8EB, 0x084, 0x294, 0x69C, 0x8AC,
2209          0x105, 0xB0D, 0x71D, 0x525},
2210         {0x408, 0x810, 0xA20, 0x228, 0x081, 0x891, 0x699, 0x2A9, 0x102, 0x50A,
2211          0x71A, 0xB22, 0x4CB, 0x8D3, 0xAE3, 0x2EB, 0x144, 0x954, 0x75C, 0x36C,
2212          0x045, 0x44D, 0x65D, 0xA65},
2213 };
2214
2215 // _axis_convert_num = {'X': 0, 'Y': 1, 'Z': 2, '-X': 3, '-Y': 4, '-Z': 5}
2216
2217 BLI_INLINE int _axis_signed(const int axis)
2218 {
2219         return (axis < 3) ? axis : axis - 3;
2220 }
2221
2222 /**
2223  * Each argument us an axis in ['X', 'Y', 'Z', '-X', '-Y', '-Z']
2224  * where the first 2 are a source and the second 2 are the target.
2225  */
2226 bool mat3_from_axis_conversion(
2227         int src_forward, int src_up, int dst_forward, int dst_up,
2228         float r_mat[3][3])
2229 {
2230         // from functools import reduce
2231         int value;
2232
2233         if (src_forward == dst_forward && src_up == dst_up) {
2234                 unit_m3(r_mat);
2235                 return false;
2236         }
2237
2238         if ((_axis_signed(src_forward) == _axis_signed(src_up)) ||
2239             (_axis_signed(dst_forward)   == _axis_signed(dst_up)))
2240         {
2241                 /* we could assert here! */
2242                 unit_m3(r_mat);
2243                 return false;
2244         }
2245
2246         value = ((src_forward << (0 * 3)) |
2247                  (src_up      << (1 * 3)) |
2248                  (dst_forward << (2 * 3)) |
2249                  (dst_up      << (3 * 3)));
2250
2251         for (uint i = 0; i < (sizeof(_axis_convert_matrix) / sizeof(*_axis_convert_matrix)); i++) {
2252                 for (uint j = 0; j < (sizeof(*_axis_convert_lut) / sizeof(*_axis_convert_lut[0])); j++) {
2253                         if (_axis_convert_lut[i][j] == value) {
2254                                 copy_m3_m3(r_mat, _axis_convert_matrix[i]);
2255                                 return true;
2256                         }
2257                 }
2258
2259         }
2260 //      BLI_assert(0);
2261         return false;
2262 }
2263
2264 /**
2265  * Use when the second axis can be guessed.
2266  */
2267 bool mat3_from_axis_conversion_single(
2268         int src_axis, int dst_axis,
2269         float r_mat[3][3])
2270 {
2271         if (src_axis == dst_axis) {
2272                 unit_m3(r_mat);
2273                 return false;
2274         }
2275
2276         /* Pick predictable next axis. */
2277         int src_axis_next = (src_axis + 1) % 3;
2278         int dst_axis_next = (dst_axis + 1) % 3;
2279
2280         if ((src_axis < 3) != (dst_axis < 3)) {
2281                 /* Flip both axis so matrix sign remains positive. */
2282                 dst_axis_next += 3;
2283         }
2284
2285         return mat3_from_axis_conversion(src_axis, src_axis_next, dst_axis, dst_axis_next, r_mat);
2286 }