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