Merged changes in the trunk up to revision 49478.
[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 float dot_qtqt(const float a[4], const float b[4]);
64 float normalize_qt(float q[4]);
65 float normalize_qt_qt(float q1[4], const float q2[4]);
66
67 /* comparison */
68 int is_zero_qt(float q[4]);
69
70 /* interpolation */
71 void interp_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
72 void add_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
73
74 /* conversion */
75 void quat_to_mat3(float mat[3][3], const float q[4]);
76 void quat_to_mat4(float mat[4][4], const float q[4]);
77
78 void mat3_to_quat(float q[4], float mat[3][3]);
79 void mat4_to_quat(float q[4], float mat[4][4]);
80 void tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
81 void vec_to_quat(float q[4], const float vec[3], short axis, const short upflag);
82 /* note: v1 and v2 must be normalized */
83 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
84 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
85
86 /* TODO: don't what this is, but it's not the same as mat3_to_quat */
87 void mat3_to_quat_is_ok(float q[4], float mat[3][3]);
88
89 /* other */
90 void print_qt(const char *str, const float q[4]);
91
92 /******************************** Axis Angle *********************************/
93
94 /* conversion */
95 void axis_angle_to_quat(float r[4], const float axis[3], const float angle);
96 void axis_angle_to_mat3(float R[3][3], const float axis[3], const float angle);
97 void axis_angle_to_mat4(float R[4][4], const float axis[3], const float angle);
98
99 void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
100 void mat3_to_axis_angle(float axis[3], float *angle, float M[3][3]);
101 void mat4_to_axis_angle(float axis[3], float *angle, float M[4][4]);
102
103 void single_axis_angle_to_mat3(float R[3][3], const char axis, const float angle);
104
105 /****************************** Vector/Rotation ******************************/
106 /* old axis angle code                                                       */
107 /* TODO: the following calls should probably be depreceated sometime         */
108
109 /* conversion */
110 void vec_rot_to_mat3(float mat[3][3], const float vec[3], const float phi);
111
112 /******************************** XYZ Eulers *********************************/
113
114 void eul_to_quat(float quat[4], const float eul[3]);
115 void eul_to_mat3(float mat[3][3], const float eul[3]);
116 void eul_to_mat4(float mat[4][4], const float eul[3]);
117
118 void quat_to_eul(float eul[3], const float quat[4]);
119 void mat3_to_eul(float eul[3], float mat[3][3]);
120 void mat4_to_eul(float eul[3], float mat[4][4]);
121
122 void compatible_eul(float eul[3], const float old[3]);
123 void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
124
125 void rotate_eul(float eul[3], const char axis, const float angle);
126
127 /************************** Arbitrary Order Eulers ***************************/
128
129 /* warning: must match the eRotationModes in DNA_action_types.h
130  * order matters - types are saved to file. */
131
132 typedef enum eEulerRotationOrders {
133         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
134         EULER_ORDER_XYZ = 1,
135         EULER_ORDER_XZY,
136         EULER_ORDER_YXZ,
137         EULER_ORDER_YZX,
138         EULER_ORDER_ZXY,
139         EULER_ORDER_ZYX
140         /* there are 6 more entries with dulpicate entries included */
141 } eEulerRotationOrders;
142
143 void eulO_to_quat(float quat[4], const float eul[3], const short order);
144 void eulO_to_mat3(float mat[3][3], const float eul[3], const short order);
145 void eulO_to_mat4(float mat[4][4], const float eul[3], const short order);
146 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order);
147 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order);
148  
149 void quat_to_eulO(float eul[3], const short order, const float quat[4]);
150 void mat3_to_eulO(float eul[3], const short order, float mat[3][3]);
151 void mat4_to_eulO(float eul[3], const short order, float mat[4][4]);
152 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle);
153
154 void mat3_to_compatible_eulO(float eul[3], float old[3], short order, float mat[3][3]);
155 void mat4_to_compatible_eulO(float eul[3], float old[3], short order, float mat[4][4]);
156
157 void rotate_eulO(float eul[3], short order, char axis, float angle);
158
159 /******************************* Dual Quaternions ****************************/
160
161 typedef struct DualQuat {
162         float quat[4];
163         float trans[4];
164
165         float scale[4][4];
166         float scale_weight;
167 } DualQuat;
168
169 void copy_dq_dq(DualQuat *r, DualQuat *dq);
170 void normalize_dq(DualQuat *dq, float totw);
171 void add_weighted_dq_dq(DualQuat *r, DualQuat *dq, float weight);
172 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat * dq);
173
174 void mat4_to_dquat(DualQuat * r, float base[4][4], float M[4][4]);
175 void dquat_to_mat4(float R[4][4], DualQuat * dq);
176
177 void quat_apply_track(float quat[4], short axis, short upflag);
178 void vec_apply_track(float vec[3], short axis);
179
180 float focallength_to_fov(float focal_length, float sensor);
181 float fov_to_focallength(float fov, float sensor);
182
183 float angle_wrap_rad(float angle);
184 float angle_wrap_deg(float angle);
185
186 #ifdef __cplusplus
187 }
188 #endif
189
190 #endif /* __BLI_MATH_ROTATION_H__ */
191