Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_math_rotation.h
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  * The Original Code is: some of this file.
20  *
21  * */
22
23 #ifndef __BLI_MATH_ROTATION_H__
24 #define __BLI_MATH_ROTATION_H__
25
26 /** \file
27  * \ingroup bli
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #define RAD2DEG(_rad) ((_rad) * (180.0 / M_PI))
35 #define DEG2RAD(_deg) ((_deg) * (M_PI / 180.0))
36
37
38 #define RAD2DEGF(_rad) ((_rad) * (float)(180.0 / M_PI))
39 #define DEG2RADF(_deg) ((_deg) * (float)(M_PI / 180.0))
40
41 /******************************** Quaternions ********************************/
42 /* stored in (w, x, y, z) order                                              */
43
44 /* init */
45 void unit_axis_angle(float axis[3], float *angle);
46 void unit_qt(float q[4]);
47 void copy_qt_qt(float q[4], const float a[4]);
48
49 /* arithmetic */
50 void mul_qt_qtqt(float q[4], const float a[4], const float b[4]);
51 void mul_qt_v3(const float q[4], float r[3]);
52 void mul_qt_fl(float q[4], const float f);
53
54 void pow_qt_fl_normalized(float q[4], const float f);
55
56 void sub_qt_qtqt(float q[4], const float a[4], const float b[4]);
57
58 void invert_qt(float q[4]);
59 void invert_qt_qt(float q1[4], const float q2[4]);
60 void invert_qt_normalized(float q[4]);
61 void invert_qt_qt_normalized(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 quat_to_compatible_quat(float q[4], const float a[4], const float old[4]);
81
82 void mat3_normalized_to_quat(float q[4], const float mat[3][3]);
83 void mat4_normalized_to_quat(float q[4], const float mat[4][4]);
84 void mat3_to_quat(float q[4], const float mat[3][3]);
85 void mat4_to_quat(float q[4], const float mat[4][4]);
86 void tri_to_quat_ex(float quat[4], const float v1[3], const float v2[3], const float v3[3],
87                     const float no_orig[3]);
88 float tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
89 void  vec_to_quat(float q[4], const float vec[3], short axis, const short upflag);
90 /* note: v1 and v2 must be normalized */
91 void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3]);
92 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
93 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
94
95 float angle_normalized_qt(const float q[4]);
96 float angle_normalized_qtqt(const float q1[4], const float q2[4]);
97 float angle_qt(const float q[4]);
98 float angle_qtqt(const float q1[4], const float q2[4]);
99
100 float angle_signed_normalized_qt(const float q[4]);
101 float angle_signed_normalized_qtqt(const float q1[4], const float q2[4]);
102 float angle_signed_qt(const float q[4]);
103 float angle_signed_qtqt(const float q1[4], const float q2[4]);
104
105 /* TODO: don't what this is, but it's not the same as mat3_to_quat */
106 void mat3_to_quat_is_ok(float q[4], const float mat[3][3]);
107
108 /* other */
109 void print_qt(const char *str, const float q[4]);
110
111 #define print_qt_id(q) print_qt(STRINGIFY(q), q)
112
113 /******************************** Axis Angle *********************************/
114
115 /* conversion */
116 void axis_angle_normalized_to_quat(float r[4], const float axis[3], const float angle);
117 void axis_angle_to_quat(float r[4], const float axis[3], const float angle);
118 void axis_angle_to_mat3(float R[3][3], const float axis[3], const float angle);
119 void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
120                                       const float angle_sin, const float angle_cos);
121 void axis_angle_normalized_to_mat3(float R[3][3], const float axis[3], const float angle);
122 void axis_angle_to_mat4(float R[4][4], const float axis[3], const float angle);
123
124 void mat3_normalized_to_axis_angle(float axis[3], float *angle, const float M[3][3]);
125 void mat4_normalized_to_axis_angle(float axis[3], float *angle, const float M[4][4]);
126 void mat3_to_axis_angle(float axis[3], float *angle, const float M[3][3]);
127 void mat4_to_axis_angle(float axis[3], float *angle, const float M[4][4]);
128 void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
129
130 void      angle_to_mat2(float R[2][2], const float angle);
131 void axis_angle_to_mat3_single(float R[3][3], const char axis, const float angle);
132 void axis_angle_to_mat4_single(float R[4][4], const char axis, const float angle);
133
134 void axis_angle_to_quat_single(float q[4], const char axis, const float angle);
135
136 /****************************** Exponential Map ******************************/
137 void quat_to_expmap(float expmap[3], const float q[4]);
138 void quat_normalized_to_expmap(float expmap[3], const float q[4]);
139 void expmap_to_quat(float r[4], const float expmap[3]);
140
141 /******************************** XYZ Eulers *********************************/
142
143 void eul_to_quat(float quat[4], const float eul[3]);
144 void eul_to_mat3(float mat[3][3], const float eul[3]);
145 void eul_to_mat4(float mat[4][4], const float eul[3]);
146
147 void mat3_normalized_to_eul(float eul[3], const float mat[3][3]);
148 void mat4_normalized_to_eul(float eul[3], const float mat[4][4]);
149 void mat3_to_eul(float eul[3], const float mat[3][3]);
150 void mat4_to_eul(float eul[3], const float mat[4][4]);
151 void quat_to_eul(float eul[3], const float quat[4]);
152
153 void mat3_normalized_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
154 void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
155 void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4]);
156 void compatible_eul(float eul[3], const float old[3]);
157
158 void rotate_eul(float eul[3], const char axis, const float angle);
159
160 /************************** Arbitrary Order Eulers ***************************/
161
162 /* warning: must match the eRotationModes in DNA_action_types.h
163  * order matters - types are saved to file. */
164
165 typedef enum eEulerRotationOrders {
166         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
167         EULER_ORDER_XYZ = 1,
168         EULER_ORDER_XZY,
169         EULER_ORDER_YXZ,
170         EULER_ORDER_YZX,
171         EULER_ORDER_ZXY,
172         EULER_ORDER_ZYX
173         /* there are 6 more entries with dulpicate entries included */
174 } eEulerRotationOrders;
175
176 void eulO_to_quat(float quat[4], const float eul[3], const short order);
177 void eulO_to_mat3(float mat[3][3], const float eul[3], const short order);
178 void eulO_to_mat4(float mat[4][4], const float eul[3], const short order);
179 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order);
180 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order);
181
182 void mat3_normalized_to_eulO(float eul[3], const short order, const float mat[3][3]);
183 void mat4_normalized_to_eulO(float eul[3], const short order, const float mat[4][4]);
184 void mat3_to_eulO(float eul[3], const short order, const float mat[3][3]);
185 void mat4_to_eulO(float eul[3], const short order, const float mat[4][4]);
186 void quat_to_eulO(float eul[3], const short order, const float quat[4]);
187 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle);
188
189 void mat3_normalized_to_compatible_eulO(float eul[3], const float old[3], const short order, const float mat[3][3]);
190 void mat4_normalized_to_compatible_eulO(float eul[3], const float old[3], const short order, const float mat[4][4]);
191 void mat3_to_compatible_eulO(float eul[3], const float old[3], const short order, const float mat[3][3]);
192 void mat4_to_compatible_eulO(float eul[3], const float old[3], const short order, const float mat[4][4]);
193 void quat_to_compatible_eulO(float eul[3], const float old[3], const short order, const float quat[4]);
194
195 void rotate_eulO(float eul[3], const short order, char axis, float angle);
196
197 /******************************* Dual Quaternions ****************************/
198
199 typedef struct DualQuat {
200         float quat[4];
201         float trans[4];
202
203         float scale[4][4];
204         float scale_weight;
205 } DualQuat;
206
207 void copy_dq_dq(DualQuat *r, const DualQuat *dq);
208 void normalize_dq(DualQuat *dq, float totw);
209 void add_weighted_dq_dq(DualQuat *r, const DualQuat *dq, float weight);
210 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
211
212 void mat4_to_dquat(DualQuat *r, const float base[4][4], const float M[4][4]);
213 void dquat_to_mat4(float R[4][4], const DualQuat *dq);
214
215 void quat_apply_track(float quat[4], short axis, short upflag);
216 void vec_apply_track(float vec[3], short axis);
217
218 float focallength_to_fov(float focal_length, float sensor);
219 float fov_to_focallength(float fov, float sensor);
220
221 float angle_wrap_rad(float angle);
222 float angle_wrap_deg(float angle);
223
224 float angle_compat_rad(float angle, float angle_compat);
225
226 bool mat3_from_axis_conversion(
227         int src_forward, int src_up, int dst_forward, int dst_up,
228         float r_mat[3][3]);
229 bool mat3_from_axis_conversion_single(
230         int src_axis, int dst_axis,
231         float r_mat[3][3]);
232
233 #ifdef __cplusplus
234 }
235 #endif
236
237 #endif /* __BLI_MATH_ROTATION_H__ */