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