Merge branch 'blender2.7'
[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
57 void pow_qt_fl_normalized(float q[4], const float f);
58
59 void sub_qt_qtqt(float q[4], const float a[4], const float b[4]);
60
61 void invert_qt(float q[4]);
62 void invert_qt_qt(float q1[4], const float q2[4]);
63 void invert_qt_normalized(float q[4]);
64 void invert_qt_qt_normalized(float q1[4], const float q2[4]);
65 void conjugate_qt(float q[4]);
66 void conjugate_qt_qt(float q1[4], const float q2[4]);
67 float dot_qtqt(const float a[4], const float b[4]);
68 float normalize_qt(float q[4]);
69 float normalize_qt_qt(float q1[4], const float q2[4]);
70
71 /* comparison */
72 bool is_zero_qt(const float q[4]);
73
74 /* interpolation */
75 void interp_dot_slerp(const float t, const float cosom, float w[2]);
76 void interp_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
77 void add_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
78
79 /* conversion */
80 void quat_to_mat3(float mat[3][3], const float q[4]);
81 void quat_to_mat4(float mat[4][4], const float q[4]);
82
83 void mat3_normalized_to_quat(float q[4], float mat[3][3]);
84 void mat4_normalized_to_quat(float q[4], float mat[4][4]);
85 void mat3_to_quat(float q[4], float mat[3][3]);
86 void mat4_to_quat(float q[4], float mat[4][4]);
87 void tri_to_quat_ex(float quat[4], const float v1[3], const float v2[3], const float v3[3],
88                     const float no_orig[3]);
89 float tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
90 void  vec_to_quat(float q[4], const float vec[3], short axis, const short upflag);
91 /* note: v1 and v2 must be normalized */
92 void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3]);
93 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
94 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
95
96 float angle_normalized_qt(const float q[4]);
97 float angle_normalized_qtqt(const float q1[4], const float q2[4]);
98 float angle_qt(const float q[4]);
99 float angle_qtqt(const float q1[4], const float q2[4]);
100
101 float angle_signed_normalized_qt(const float q[4]);
102 float angle_signed_normalized_qtqt(const float q1[4], const float q2[4]);
103 float angle_signed_qt(const float q[4]);
104 float angle_signed_qtqt(const float q1[4], const float q2[4]);
105
106 /* TODO: don't what this is, but it's not the same as mat3_to_quat */
107 void mat3_to_quat_is_ok(float q[4], float mat[3][3]);
108
109 /* other */
110 void print_qt(const char *str, const float q[4]);
111
112 #define print_qt_id(q) print_qt(STRINGIFY(q), q)
113
114 /******************************** Axis Angle *********************************/
115
116 /* conversion */
117 void axis_angle_normalized_to_quat(float r[4], const float axis[3], const float angle);
118 void axis_angle_to_quat(float r[4], const float axis[3], const float angle);
119 void axis_angle_to_mat3(float R[3][3], const float axis[3], const float angle);
120 void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
121                                       const float angle_sin, const float angle_cos);
122 void axis_angle_normalized_to_mat3(float R[3][3], const float axis[3], const float angle);
123 void axis_angle_to_mat4(float R[4][4], const float axis[3], const float angle);
124
125 void mat3_normalized_to_axis_angle(float axis[3], float *angle, float M[3][3]);
126 void mat4_normalized_to_axis_angle(float axis[3], float *angle, float M[4][4]);
127 void mat3_to_axis_angle(float axis[3], float *angle, float M[3][3]);
128 void mat4_to_axis_angle(float axis[3], float *angle, float M[4][4]);
129 void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
130
131 void      angle_to_mat2(float R[2][2], const float angle);
132 void axis_angle_to_mat3_single(float R[3][3], const char axis, const float angle);
133 void axis_angle_to_mat4_single(float R[4][4], const char axis, const float angle);
134
135 void axis_angle_to_quat_single(float q[4], const char axis, const float angle);
136
137 /****************************** Exponential Map ******************************/
138 void quat_to_expmap(float expmap[3], const float q[4]);
139 void quat_normalized_to_expmap(float expmap[3], const float q[4]);
140 void expmap_to_quat(float r[4], const float expmap[3]);
141
142 /******************************** XYZ Eulers *********************************/
143
144 void eul_to_quat(float quat[4], const float eul[3]);
145 void eul_to_mat3(float mat[3][3], const float eul[3]);
146 void eul_to_mat4(float mat[4][4], const float eul[3]);
147
148 void mat3_normalized_to_eul(float eul[3], float mat[3][3]);
149 void mat4_normalized_to_eul(float eul[3], float mat[4][4]);
150 void mat3_to_eul(float eul[3], float mat[3][3]);
151 void mat4_to_eul(float eul[3], float mat[4][4]);
152 void quat_to_eul(float eul[3], const float quat[4]);
153
154 void mat3_normalized_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
155 void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
156 void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4]);
157 void compatible_eul(float eul[3], const float old[3]);
158
159 void rotate_eul(float eul[3], const char axis, const float angle);
160
161 /************************** Arbitrary Order Eulers ***************************/
162
163 /* warning: must match the eRotationModes in DNA_action_types.h
164  * order matters - types are saved to file. */
165
166 typedef enum eEulerRotationOrders {
167         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
168         EULER_ORDER_XYZ = 1,
169         EULER_ORDER_XZY,
170         EULER_ORDER_YXZ,
171         EULER_ORDER_YZX,
172         EULER_ORDER_ZXY,
173         EULER_ORDER_ZYX
174         /* there are 6 more entries with dulpicate entries included */
175 } eEulerRotationOrders;
176
177 void eulO_to_quat(float quat[4], const float eul[3], const short order);
178 void eulO_to_mat3(float mat[3][3], const float eul[3], const short order);
179 void eulO_to_mat4(float mat[4][4], const float eul[3], const short order);
180 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order);
181 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order);
182
183 void mat3_normalized_to_eulO(float eul[3], const short order, float mat[3][3]);
184 void mat4_normalized_to_eulO(float eul[3], const short order, float mat[4][4]);
185 void mat3_to_eulO(float eul[3], const short order, float mat[3][3]);
186 void mat4_to_eulO(float eul[3], const short order, float mat[4][4]);
187 void quat_to_eulO(float eul[3], const short order, const float quat[4]);
188 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle);
189
190 void mat3_normalized_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[3][3]);
191 void mat4_normalized_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[4][4]);
192 void mat3_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[3][3]);
193 void mat4_to_compatible_eulO(float eul[3], float old[3], const short order, float mat[4][4]);
194 void quat_to_compatible_eulO(float eul[3], float old[3], const short order, const float quat[4]);
195
196 void rotate_eulO(float eul[3], const short order, char axis, float angle);
197
198 /******************************* Dual Quaternions ****************************/
199
200 typedef struct DualQuat {
201         float quat[4];
202         float trans[4];
203
204         float scale[4][4];
205         float scale_weight;
206 } DualQuat;
207
208 void copy_dq_dq(DualQuat *r, const DualQuat *dq);
209 void normalize_dq(DualQuat *dq, float totw);
210 void add_weighted_dq_dq(DualQuat *r, const DualQuat *dq, float weight);
211 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
212
213 void mat4_to_dquat(DualQuat *r, float base[4][4], float M[4][4]);
214 void dquat_to_mat4(float R[4][4], const DualQuat *dq);
215
216 void quat_apply_track(float quat[4], short axis, short upflag);
217 void vec_apply_track(float vec[3], short axis);
218
219 float focallength_to_fov(float focal_length, float sensor);
220 float fov_to_focallength(float fov, float sensor);
221
222 float angle_wrap_rad(float angle);
223 float angle_wrap_deg(float angle);
224
225 float angle_compat_rad(float angle, float angle_compat);
226
227 bool mat3_from_axis_conversion(
228         int src_forward, int src_up, int dst_forward, int dst_up,
229         float r_mat[3][3]);
230 bool mat3_from_axis_conversion_single(
231         int src_axis, int dst_axis,
232         float r_mat[3][3]);
233
234 #ifdef __cplusplus
235 }
236 #endif
237
238 #endif /* __BLI_MATH_ROTATION_H__ */