b1546e3db6c1c9f9ec33d3664b6a65b568956d56
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
29 #define BLI_MATH_ROTATION
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #define RAD2DEG(_rad) ((_rad)*(180.0/M_PI))
36 #define DEG2RAD(_deg) ((_deg)*(M_PI/180.0))
37
38 /******************************** Quaternions ********************************/
39 /* stored in (w, x, y, z) order                                              */
40
41 /* init */
42 void unit_qt(float q[4]);
43 void copy_qt_qt(float q[4], float a[4]);
44
45 /* arithmetic */
46 void mul_qt_qtqt(float q[4], float a[4], float b[4]);
47 void mul_qt_v3(float q[4], float r[3]); // TODO order
48 void mul_qt_fl(float q[4], float f);
49 void mul_fac_qt_fl(float q[4], float f);
50
51 void sub_qt_qtqt(float q[4], float a[4], float b[4]);
52
53 void invert_qt(float q[4]);
54 void conjugate_qt(float q[4]);
55 float dot_qtqt(float a[4], float b[4]);
56 void normalize_qt(float q[4]);
57
58 /* comparison */
59 int is_zero_qt(float q[4]);
60
61 /* interpolation */
62 void interp_qt_qtqt(float q[4], float a[4], float b[4], float t);
63 void add_qt_qtqt(float q[4], float a[4], float b[4], float t); // TODO name
64
65 /* conversion */
66 void quat_to_mat3(float mat[3][3], float q[4]);
67 void quat_to_mat4(float mat[4][4], float q[4]);
68
69 void mat3_to_quat(float q[4], float mat[3][3]);
70 void mat4_to_quat(float q[4], float mat[4][4]);
71 void tri_to_quat(float q[4], float a[3], float b[3], float c[3]);
72 void vec_to_quat(float q[4], float vec[3], short axis, short upflag);
73 void rotation_between_vecs_to_quat(float q[4], float v1[3], float v2[3]);
74
75 void Mat3ToQuat_is_ok(float wmat[][3], float *q); // TODO what is this?
76
77 /* other */
78 void print_qt(char *str, float q[4]);
79
80 /******************************** Axis Angle *********************************/
81
82 /* conversion */
83 void axis_angle_to_quat(float r[4], float axis[3], float angle);
84 void axis_angle_to_mat3(float R[3][3], float axis[3], float angle);
85 void axis_angle_to_mat4(float R[4][4], float axis[3], float angle);
86
87 void quat_to_axis_angle(float axis[3], float *angle, float q[4]);
88 void mat3_to_axis_angle(float axis[3], float *angle, float M[3][3]);
89 void mat4_to_axis_angle(float axis[3], float *angle, float M[4][4]);
90
91 /****************************** Vector/Rotation ******************************/
92 /* old axis angle code                                                       */
93 /* TODO: the following calls should probably be depreceated sometime         */
94
95 /* conversion */
96 void mat3_to_vec_rot(float vec[3], float *phi, float mat[3][3]);
97 void mat4_to_vec_rot(float vec[3], float *phi, float mat[4][4]);
98
99 void vec_rot_to_quat(float quat[4], float vec[3], float phi); // TODO
100 void vec_rot_to_mat3(float mat[3][3], float vec[3], float phi);
101 void vec_rot_to_mat4(float mat[4][4], float vec[3], float phi);
102
103 /******************************** XYZ Eulers *********************************/
104
105 void eul_to_quat(float quat[4], float eul[3]);
106 void eul_to_mat3(float mat[3][3], float eul[3]);
107 void eul_to_mat4(float mat[4][4], float eul[3]);
108
109 void quat_to_eul(float eul[3], float quat[4]);
110 void mat3_to_eul(float eul[3], float mat[3][3]);
111 void mat4_to_eul(float eul[3], float mat[4][4]);
112
113 void compatible_eul(float eul[3], float old[3]);
114 void mat3_to_compatible_eul(float eul[3], float old[3], float mat[3][3]);
115
116 void rotate_eul(float eul[3], char axis, float angle);
117
118 /************************** Arbitrary Order Eulers ***************************/
119
120 /* warning: must match the eRotationModes in DNA_action_types.h
121  * order matters - types are saved to file. */
122
123 typedef enum eEulerRotationOrders {
124         EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
125         EULER_ORDER_XYZ = 1,
126         EULER_ORDER_XZY,
127         EULER_ORDER_YXZ,
128         EULER_ORDER_YZX,
129         EULER_ORDER_ZXY,
130         EULER_ORDER_ZYX,
131         /* there are 6 more entries with dulpicate entries included */
132 } eEulerRotationOrders;
133
134 void eulO_to_quat(float quat[4], float eul[3], short order);
135 void eulO_to_mat3(float mat[3][3], float eul[3], short order);
136 void eulO_to_mat4(float mat[4][4], float eul[3], short order);
137 void eulO_to_axis_angle(float axis[3], float *angle, float eul[3], short order);
138 void eulO_to_gimbal_axis(float gmat[3][3], float eul[3], short order);
139  
140 void quat_to_eulO(float eul[3], short order, float quat[4]);
141 void mat3_to_eulO(float eul[3], short order, float mat[3][3]);
142 void mat4_to_eulO(float eul[3], short order, float mat[4][4]);
143 void axis_angle_to_eulO(float eul[3], short order, float axis[3], float angle);
144
145 void mat3_to_compatible_eulO(float eul[3], float old[3], short order, float mat[3][3]);
146
147 void rotate_eulO(float eul[3], short order, char axis, float angle);
148
149 /******************************* Dual Quaternions ****************************/
150
151 typedef struct DualQuat {
152         float quat[4];
153         float trans[4];
154
155         float scale[4][4];
156         float scale_weight;
157 } DualQuat;
158
159 void copy_dq_dq(DualQuat *r, DualQuat *dq);
160 void normalize_dq(DualQuat *dq, float totw);
161 void add_weighted_dq_dq(DualQuat *r, DualQuat *dq, float weight);
162 void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
163
164 void mat4_to_dquat(DualQuat *r, float base[4][4], float M[4][4]);
165 void dquat_to_mat4(float R[4][4], DualQuat *dq);
166
167 #ifdef __cplusplus
168 }
169 #endif
170
171 #endif /* BLI_MATH_ROTATION */
172