mathutils: added exponential map to Quaternion
[blender.git] / source / blender / blenlib / BLI_math_rotation.h
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 #ifndef __BLI_MATH_ROTATION_H__
27 #define __BLI_MATH_ROTATION_H__
28
29 /** \file BLI_math_rotation.h
30  *  \ingroup bli
31  */
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #define RAD2DEG(_rad) ((_rad) * (180.0 / M_PI))
38 #define DEG2RAD(_deg) ((_deg) * (M_PI / 180.0))
39
40
41 #define RAD2DEGF(_rad) ((_rad) * (float)(180.0 / M_PI))
42 #define DEG2RADF(_deg) ((_deg) * (float)(M_PI / 180.0))
43
44 /******************************** Quaternions ********************************/
45 /* stored in (w, x, y, z) order                                              */
46
47 /* init */
48 void unit_axis_angle(float axis[3], float *angle);
49 void unit_qt(float q[4]);
50 void copy_qt_qt(float q[4], const float a[4]);
51
52 /* arithmetic */
53 void mul_qt_qtqt(float q[4], const float a[4], const float b[4]);
54 void mul_qt_v3(const float q[4], float r[3]);
55 void mul_qt_fl(float q[4], const float f);
56 void mul_fac_qt_fl(float q[4], const float f);
57
58 void sub_qt_qtqt(float q[4], const float a[4], const float b[4]);
59
60 void invert_qt(float q[4]);
61 void invert_qt_qt(float q1[4], const float q2[4]);
62 void conjugate_qt(float q[4]);
63 void conjugate_qt_qt(float q1[4], const float q2[4]);
64 float dot_qtqt(const float a[4], const float b[4]);
65 float normalize_qt(float q[4]);
66 float normalize_qt_qt(float q1[4], const float q2[4]);
67
68 /* comparison */
69 bool is_zero_qt(const float q[4]);
70
71 /* interpolation */
72 void interp_dot_slerp(const float t, const float cosom, float w[2]);
73 void interp_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
74 void add_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
75
76 /* conversion */
77 void quat_to_mat3(float mat[3][3], const float q[4]);
78 void quat_to_mat4(float mat[4][4], const float q[4]);
79
80 void mat3_to_quat(float q[4], float mat[3][3]);
81 void mat4_to_quat(float q[4], float mat[4][4]);
82 void tri_to_quat_ex(float quat[4], const float v1[3], const float v2[3], const float v3[3],
83                     const float no_orig[3]);
84 float tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
85 void  vec_to_quat(float q[4], const float vec[3], short axis, const short upflag);
86 /* note: v1 and v2 must be normalized */
87 void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3]);
88 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
89 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
90
91 float angle_normalized_qt(const float q[4]);
92 float angle_normalized_qtqt(const float q1[4], const float q2[4]);
93 float angle_qt(const float q[4]);
94 float angle_qtqt(const float q1[4], const float q2[4]);
95
96 /* TODO: don't what this is, but it's not the same as mat3_to_quat */
97 void mat3_to_quat_is_ok(float q[4], float mat[3][3]);
98
99 /* other */
100 void print_qt(const char *str, const float q[4]);
101
102 #define print_qt_id(q) print_qt(STRINGIFY(q), q)
103
104 /******************************** Axis Angle *********************************/
105
106 /* conversion */
107 void axis_angle_normalized_to_quat(float r[4], const float axis[3], const float angle);
108 void axis_angle_to_quat(float r[4], const float axis[3], const float angle);
109 void axis_angle_to_mat3(float R[3][3], const float axis[3], const float angle);
110 void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
111                                       const float angle_sin, const float angle_cos);
112 void axis_angle_normalized_to_mat3(float R[3][3], const float axis[3], const float angle);
113 void axis_angle_to_mat4(float R[4][4], const float axis[3], const float angle);
114
115 void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
116 void mat3_to_axis_angle(float axis[3], float *angle, float M[3][3]);
117 void mat4_to_axis_angle(float axis[3], float *angle, float M[4][4]);
118
119 void axis_angle_to_mat3_single(float R[3][3], const char axis, const float angle);
120 void      angle_to_mat2(float R[2][2], const float angle);
121
122 /****************************** Exponential Map ******************************/
123 void quat_to_expmap(float expmap[3], const float q[4]);
124 void quat_normalized_to_expmap(float expmap[3], const float q[4]);
125 void expmap_to_quat(float r[4], const float expmap[3]);
126
127 /******************************** XYZ Eulers *********************************/
128
129 void eul_to_quat(float quat[4], const float eul[3]);
130 void eul_to_mat3(float mat[3][3], const float eul[3]);
131 void eul_to_mat4(float mat[4][4], const float eul[3]);
132
133 void quat_to_eul(float eul[3], const float quat[4]);
134 void mat3_to_eul(float eul[3], float mat[3][3]);
135 void mat4_to_eul(float eul[3], float mat[4][4]);
136
137 void compatible_eul(float eul[3], const float old[3]);
138 void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
139
140 void rotate_eul(float eul[3], const char axis, const float angle);
141
142 /************************** Arbitrary Order Eulers ***************************/
143
144 /* warning: must match the eRotationModes in DNA_action_types.h
145  * order matters - types are saved to file. */
146
147 typedef enum eEulerRotationOrders {
148         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
149         EULER_ORDER_XYZ = 1,
150         EULER_ORDER_XZY,
151         EULER_ORDER_YXZ,
152         EULER_ORDER_YZX,
153         EULER_ORDER_ZXY,
154         EULER_ORDER_ZYX
155         /* there are 6 more entries with dulpicate entries included */
156 } eEulerRotationOrders;
157
158 void eulO_to_quat(float quat[4], const float eul[3], const short order);
159 void eulO_to_mat3(float mat[3][3], const float eul[3], const short order);
160 void eulO_to_mat4(float mat[4][4], const float eul[3], const short order);
161 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order);
162 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order);
163  
164 void quat_to_eulO(float eul[3], const short order, const float quat[4]);
165 void mat3_to_eulO(float eul[3], const short order, float mat[3][3]);
166 void mat4_to_eulO(float eul[3], const short order, float mat[4][4]);
167 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle);
168
169 void mat3_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[3][3]);
170 void mat4_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[4][4]);
171
172 void rotate_eulO(float eul[3], const short order, char axis, float angle);
173
174 /******************************* Dual Quaternions ****************************/
175
176 typedef struct DualQuat {
177         float quat[4];
178         float trans[4];
179
180         float scale[4][4];
181         float scale_weight;
182 } DualQuat;
183
184 void copy_dq_dq(DualQuat *r, const DualQuat *dq);
185 void normalize_dq(DualQuat *dq, float totw);
186 void add_weighted_dq_dq(DualQuat *r, const DualQuat *dq, float weight);
187 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
188
189 void mat4_to_dquat(DualQuat *r, float base[4][4], float M[4][4]);
190 void dquat_to_mat4(float R[4][4], const DualQuat *dq);
191
192 void quat_apply_track(float quat[4], short axis, short upflag);
193 void vec_apply_track(float vec[3], short axis);
194
195 float focallength_to_fov(float focal_length, float sensor);
196 float fov_to_focallength(float fov, float sensor);
197
198 float angle_wrap_rad(float angle);
199 float angle_wrap_deg(float angle);
200
201 float angle_compat_rad(float angle, float angle_compat);
202
203 int mat3_from_axis_conversion(int from_forward, int from_up, int to_forward, int to_up,
204                               float r_mat[3][3]);
205
206 #ifdef __cplusplus
207 }
208 #endif
209
210 #endif /* __BLI_MATH_ROTATION_H__ */
211