Merging r40345 through r40365 from trunk into soc-2011-garlic
[blender.git] / source / blender / blenlib / BLI_math_rotation.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: some of this file.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * */
27
28 #ifndef BLI_MATH_ROTATION_H
29 #define BLI_MATH_ROTATION_H
30
31 /** \file BLI_math_rotation.h
32  *  \ingroup bli
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #define RAD2DEG(_rad) ((_rad)*(180.0/M_PI))
40 #define DEG2RAD(_deg) ((_deg)*(M_PI/180.0))
41
42
43 #define RAD2DEGF(_rad) ((_rad)*(float)(180.0/M_PI))
44 #define DEG2RADF(_deg) ((_deg)*(float)(M_PI/180.0))
45
46 /******************************** Quaternions ********************************/
47 /* stored in (w, x, y, z) order                                              */
48
49 /* init */
50 void unit_axis_angle(float axis[3], float *angle);
51 void unit_qt(float q[4]);
52 void copy_qt_qt(float q[4], const float a[4]);
53
54 /* arithmetic */
55 void mul_qt_qtqt(float q[4], const float a[4], const float b[4]);
56 void mul_qt_v3(const float q[4], float r[3]);
57 void mul_qt_fl(float q[4], const float f);
58 void mul_fac_qt_fl(float q[4], const float f);
59
60 void sub_qt_qtqt(float q[4], const float a[4], const float b[4]);
61
62 void invert_qt(float q[4]);
63 void invert_qt_qt(float q1[4], const float q2[4]);
64 void conjugate_qt(float q[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 int is_zero_qt(float q[4]);
71
72 /* interpolation */
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_to_quat(float q[4], float mat[3][3]);
81 void mat4_to_quat(float q[4], float mat[4][4]);
82 void tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
83 void vec_to_quat(float q[4], const float vec[3], short axis, const short upflag);
84 /* note: v1 and v2 must be normalized */
85 void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
86 void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
87
88 /* TODO: don't what this is, but it's not the same as mat3_to_quat */
89 void mat3_to_quat_is_ok(float q[4], float mat[3][3]);
90
91 /* other */
92 void print_qt(const char *str, const float q[4]);
93
94 /******************************** Axis Angle *********************************/
95
96 /* conversion */
97 void axis_angle_to_quat(float r[4], const float axis[3], float angle);
98 void axis_angle_to_mat3(float R[3][3], const float axis[3], const float angle);
99 void axis_angle_to_mat4(float R[4][4], const float axis[3], const float angle);
100
101 void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
102 void mat3_to_axis_angle(float axis[3], float *angle, float M[3][3]);
103 void mat4_to_axis_angle(float axis[3], float *angle, float M[4][4]);
104
105 void single_axis_angle_to_mat3(float R[3][3], const char axis, const float angle);
106
107 /****************************** Vector/Rotation ******************************/
108 /* old axis angle code                                                       */
109 /* TODO: the following calls should probably be depreceated sometime         */
110
111 /* conversion */
112 void vec_rot_to_quat(float quat[4], const float vec[3], const float phi);
113 void vec_rot_to_mat3(float mat[3][3], const float vec[3], const float phi);
114 void vec_rot_to_mat4(float mat[4][4], const float vec[3], const float phi);
115
116 /******************************** XYZ Eulers *********************************/
117
118 void eul_to_quat(float quat[4], const float eul[3]);
119 void eul_to_mat3(float mat[3][3], const float eul[3]);
120 void eul_to_mat4(float mat[4][4], const float eul[3]);
121
122 void quat_to_eul(float eul[3], const float quat[4]);
123 void mat3_to_eul(float eul[3], float mat[3][3]);
124 void mat4_to_eul(float eul[3], float mat[4][4]);
125
126 void compatible_eul(float eul[3], const float old[3]);
127 void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]);
128
129 void rotate_eul(float eul[3], const char axis, const float angle);
130
131 /************************** Arbitrary Order Eulers ***************************/
132
133 /* warning: must match the eRotationModes in DNA_action_types.h
134  * order matters - types are saved to file. */
135
136 typedef enum eEulerRotationOrders {
137         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
138         EULER_ORDER_XYZ = 1,
139         EULER_ORDER_XZY,
140         EULER_ORDER_YXZ,
141         EULER_ORDER_YZX,
142         EULER_ORDER_ZXY,
143         EULER_ORDER_ZYX
144         /* there are 6 more entries with dulpicate entries included */
145 } eEulerRotationOrders;
146
147 void eulO_to_quat(float quat[4], const float eul[3], const short order);
148 void eulO_to_mat3(float mat[3][3], const float eul[3], const short order);
149 void eulO_to_mat4(float mat[4][4], const float eul[3], const short order);
150 void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const short order);
151 void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], const short order);
152  
153 void quat_to_eulO(float eul[3], const short order, const float quat[4]);
154 void mat3_to_eulO(float eul[3], const short order, float mat[3][3]);
155 void mat4_to_eulO(float eul[3], const short order, float mat[4][4]);
156 void axis_angle_to_eulO(float eul[3], const short order, const float axis[3], const float angle);
157
158 void mat3_to_compatible_eulO(float eul[3], float old[3], short order, float mat[3][3]);
159 void mat4_to_compatible_eulO(float eul[3], float old[3], short order, float mat[4][4]);
160
161 void rotate_eulO(float eul[3], short order, char axis, float angle);
162
163 /******************************* Dual Quaternions ****************************/
164
165 typedef struct DualQuat {
166         float quat[4];
167         float trans[4];
168
169         float scale[4][4];
170         float scale_weight;
171 } DualQuat;
172
173 void copy_dq_dq(DualQuat *r, DualQuat *dq);
174 void normalize_dq(DualQuat *dq, float totw);
175 void add_weighted_dq_dq(DualQuat *r, DualQuat *dq, float weight);
176 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
177
178 void mat4_to_dquat(DualQuat *r, float base[4][4], float M[4][4]);
179 void dquat_to_mat4(float R[4][4], DualQuat *dq);
180
181 void quat_apply_track(float quat[4], short axis, short upflag);
182 void vec_apply_track(float vec[3], short axis);
183
184 float lens_to_angle(float lens);
185 float angle_to_lens(float angle);
186
187 float angle_wrap_rad(float angle);
188 float angle_wrap_deg(float angle);
189
190 #ifdef __cplusplus
191 }
192 #endif
193
194 #endif /* BLI_MATH_ROTATION_H */
195