code cleanup: use const events for modal and invoke operators.
[blender.git] / source / blender / editors / transform / transform_input.c
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  * Contributor(s): none yet.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/editors/transform/transform_input.c
24  *  \ingroup edtransform
25  */
26
27
28 #include <stdlib.h>
29 #include <math.h>
30
31 #include "DNA_screen_types.h"
32
33 #include "BLI_math.h"
34 #include "BLI_utildefines.h"
35
36 #include "WM_types.h"
37
38 #include "transform.h"
39
40 #include "MEM_guardedalloc.h" 
41
42 /* ************************** INPUT FROM MOUSE *************************** */
43
44 static void InputVector(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
45 {
46         float vec[3], dvec[3];
47         if (mi->precision) {
48                 /* calculate the main translation and the precise one separate */
49                 convertViewVec(t, dvec, (mval[0] - mi->precision_mval[0]), (mval[1] - mi->precision_mval[1]));
50                 mul_v3_fl(dvec, 0.1f);
51                 convertViewVec(t, vec, (mi->precision_mval[0] - t->imval[0]), (mi->precision_mval[1] - t->imval[1]));
52                 add_v3_v3v3(output, vec, dvec);
53         }
54         else {
55                 convertViewVec(t, output, (mval[0] - t->imval[0]), (mval[1] - t->imval[1]));
56         }
57
58 }
59
60 static void InputSpring(TransInfo *UNUSED(t), MouseInput *mi, const int mval[2], float output[3])
61 {
62         float ratio, precise_ratio, dx, dy;
63         if (mi->precision) {
64                 /* calculate ratio for shiftkey pos, and for total, and blend these for precision */
65                 dx = (float)(mi->center[0] - mi->precision_mval[0]);
66                 dy = (float)(mi->center[1] - mi->precision_mval[1]);
67                 ratio = sqrtf(dx * dx + dy * dy);
68
69                 dx = (float)(mi->center[0] - mval[0]);
70                 dy = (float)(mi->center[1] - mval[1]);
71                 precise_ratio = (float)sqrt(dx * dx + dy * dy);
72
73                 ratio = (ratio + (precise_ratio - ratio) / 10.0f) / mi->factor;
74         }
75         else {
76                 dx = (float)(mi->center[0] - mval[0]);
77                 dy = (float)(mi->center[1] - mval[1]);
78                 ratio = sqrtf(dx * dx + dy * dy) / mi->factor;
79         }
80
81         output[0] = ratio;
82 }
83
84 static void InputSpringFlip(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
85 {
86         InputSpring(t, mi, mval, output);
87
88         /* flip scale */
89         /* values can become really big when zoomed in so use longs [#26598] */
90         if ((long long int)(mi->center[0] - mval[0]) * (long long int)(mi->center[0] - mi->imval[0]) +
91             (long long int)(mi->center[1] - mval[1]) * (long long int)(mi->center[1] - mi->imval[1]) < 0)
92         {
93                 output[0] *= -1.0f;
94         }
95 }
96
97 static void InputTrackBall(TransInfo *UNUSED(t), MouseInput *mi, const int mval[2], float output[3])
98 {
99
100         if (mi->precision) {
101                 output[0] = (mi->imval[1] - mi->precision_mval[1]) + (mi->precision_mval[1] - mval[1]) * 0.1f;
102                 output[1] = (mi->precision_mval[0] - mi->imval[0]) + (mval[0] - mi->precision_mval[0]) * 0.1f;
103         }
104         else {
105                 output[0] = (float)(mi->imval[1] - mval[1]);
106                 output[1] = (float)(mval[0] - mi->imval[0]);
107         }
108
109         output[0] *= mi->factor;
110         output[1] *= mi->factor;
111 }
112
113 static void InputHorizontalRatio(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
114 {
115         float x, pad;
116
117         pad = t->ar->winx / 10;
118
119         if (mi->precision) {
120                 /* deal with Shift key by adding motion / 10 to motion before shift press */
121                 x = mi->precision_mval[0] + (float)(mval[0] - mi->precision_mval[0]) / 10.0f;
122         }
123         else {
124                 x = mval[0];
125         }
126
127         output[0] = (x - pad) / (t->ar->winx - 2 * pad);
128 }
129
130 static void InputHorizontalAbsolute(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
131 {
132         float vec[3];
133
134         InputVector(t, mi, mval, vec);
135         project_v3_v3v3(vec, vec, t->viewinv[0]);
136
137         output[0] = dot_v3v3(t->viewinv[0], vec) * 2.0f;
138 }
139
140 static void InputVerticalRatio(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
141 {
142         float y, pad;
143
144         pad = t->ar->winy / 10;
145
146         if (mi->precision) {
147                 /* deal with Shift key by adding motion / 10 to motion before shift press */
148                 y = mi->precision_mval[1] + (float)(mval[1] - mi->precision_mval[1]) / 10.0f;
149         }
150         else {
151                 y = mval[0];
152         }
153
154         output[0] = (y - pad) / (t->ar->winy - 2 * pad);
155 }
156
157 static void InputVerticalAbsolute(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
158 {
159         float vec[3];
160
161         InputVector(t, mi, mval, vec);
162         project_v3_v3v3(vec, vec, t->viewinv[1]);
163
164         output[0] = dot_v3v3(t->viewinv[1], vec) * 2.0f;
165 }
166
167 void setCustomPoints(TransInfo *UNUSED(t), MouseInput *mi, const int start[2], const int end[2])
168 {
169         int *data;
170
171         if (mi->data == NULL) {
172                 mi->data = MEM_callocN(sizeof(int) * 4, "custom points");
173         }
174         
175         data = mi->data;
176
177         data[0] = start[0];
178         data[1] = start[1];
179         data[2] = end[0];
180         data[3] = end[1];
181 }
182
183 static void InputCustomRatioFlip(TransInfo *UNUSED(t), MouseInput *mi, const int mval[2], float output[3])
184 {
185         double length;
186         double distance;
187         double dx, dy;
188         int *data = mi->data;
189         
190         if (data) {
191                 dx = data[2] - data[0];
192                 dy = data[3] - data[1];
193                 
194                 length = sqrt(dx * dx + dy * dy);
195                 
196                 if (mi->precision) {
197                         /* deal with Shift key by adding motion / 10 to motion before shift press */
198                         int mdx, mdy;
199                         mdx = (mi->precision_mval[0] + (float)(mval[0] - mi->precision_mval[0]) / 10.0f) - data[2];
200                         mdy = (mi->precision_mval[1] + (float)(mval[1] - mi->precision_mval[1]) / 10.0f) - data[3];
201
202                         distance = (length != 0.0) ? (mdx * dx + mdy * dy) / length : 0.0;
203                 }
204                 else {
205                         int mdx, mdy;
206                         mdx = mval[0] - data[2];
207                         mdy = mval[1] - data[3];
208
209                         distance = (length != 0.0) ? (mdx * dx + mdy * dy) / length : 0.0;
210                 }
211
212                 output[0] = (length != 0.0) ? (double)(distance / length) : 0.0;
213         }
214 }
215
216 static void InputCustomRatio(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
217 {
218         InputCustomRatioFlip(t, mi, mval, output);
219         output[0] = -output[0];
220 }
221
222 static void InputAngle(TransInfo *UNUSED(t), MouseInput *mi, const int mval[2], float output[3])
223 {
224         double dx2 = mval[0] - mi->center[0];
225         double dy2 = mval[1] - mi->center[1];
226         double B = sqrt(dx2 * dx2 + dy2 * dy2);
227
228         double dx1 = mi->imval[0] - mi->center[0];
229         double dy1 = mi->imval[1] - mi->center[1];
230         double A = sqrt(dx1 * dx1 + dy1 * dy1);
231
232         double dx3 = mval[0] - mi->imval[0];
233         double dy3 = mval[1] - mi->imval[1];
234
235         double *angle = mi->data;
236
237         /* use doubles here, to make sure a "1.0" (no rotation) doesnt become 9.999999e-01, which gives 0.02 for acos */
238         double deler = (((dx1 * dx1 + dy1 * dy1) +
239                          (dx2 * dx2 + dy2 * dy2) -
240                          (dx3 * dx3 + dy3 * dy3)) / (2.0 * ((A * B) ? (A * B) : 1.0)));
241         /* ((A * B) ? (A * B) : 1.0) this takes care of potential divide by zero errors */
242
243         float dphi;
244
245         dphi = saacos((float)deler);
246         if ((dx1 * dy2 - dx2 * dy1) > 0.0) dphi = -dphi;
247
248         /* If the angle is zero, because of lack of precision close to the 1.0 value in acos
249          * approximate the angle with the opposite side of the normalized triangle
250          * This is a good approximation here since the smallest acos value seems to be around
251          * 0.02 degree and lower values don't even have a 0.01% error compared to the approximation
252          */
253         if (dphi == 0) {
254                 double dx, dy;
255
256                 dx2 /= A;
257                 dy2 /= A;
258
259                 dx1 /= B;
260                 dy1 /= B;
261
262                 dx = dx1 - dx2;
263                 dy = dy1 - dy2;
264
265                 dphi = sqrt(dx * dx + dy * dy);
266                 if ((dx1 * dy2 - dx2 * dy1) > 0.0) dphi = -dphi;
267         }
268
269         if (mi->precision) {
270                 dphi = dphi / 30.0f;
271         }
272
273         /* if no delta angle, don't update initial position */
274         if (dphi != 0) {
275                 mi->imval[0] = mval[0];
276                 mi->imval[1] = mval[1];
277         }
278
279         *angle += (double)dphi;
280
281         output[0] = *angle;
282 }
283
284 void initMouseInput(TransInfo *UNUSED(t), MouseInput *mi, const int center[2], const int mval[2])
285 {
286         mi->factor = 0;
287         mi->precision = 0;
288
289         mi->center[0] = center[0];
290         mi->center[1] = center[1];
291
292         mi->imval[0] = mval[0];
293         mi->imval[1] = mval[1];
294
295         mi->post = NULL;
296 }
297
298 static void calcSpringFactor(MouseInput *mi)
299 {
300         mi->factor = sqrtf(((float)(mi->center[1] - mi->imval[1])) * ((float)(mi->center[1] - mi->imval[1])) +
301                            ((float)(mi->center[0] - mi->imval[0])) * ((float)(mi->center[0] - mi->imval[0])));
302
303         if (mi->factor == 0.0f) {
304                 mi->factor = 1.0f; /* prevent Inf */
305         }
306 }
307
308 void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode)
309 {
310         /* incase we allocate a new value */
311         void *mi_data_prev = mi->data;
312
313         switch (mode) {
314                 case INPUT_VECTOR:
315                         mi->apply = InputVector;
316                         t->helpline = HLP_NONE;
317                         break;
318                 case INPUT_SPRING:
319                         calcSpringFactor(mi);
320                         mi->apply = InputSpring;
321                         t->helpline = HLP_SPRING;
322                         break;
323                 case INPUT_SPRING_FLIP:
324                         calcSpringFactor(mi);
325                         mi->apply = InputSpringFlip;
326                         t->helpline = HLP_SPRING;
327                         break;
328                 case INPUT_ANGLE:
329                         mi->data = MEM_callocN(sizeof(double), "angle accumulator");
330                         mi->apply = InputAngle;
331                         t->helpline = HLP_ANGLE;
332                         break;
333                 case INPUT_TRACKBALL:
334                         /* factor has to become setting or so */
335                         mi->factor = 0.01f;
336                         mi->apply = InputTrackBall;
337                         t->helpline = HLP_TRACKBALL;
338                         break;
339                 case INPUT_HORIZONTAL_RATIO:
340                         mi->factor = (float)(mi->center[0] - mi->imval[0]);
341                         mi->apply = InputHorizontalRatio;
342                         t->helpline = HLP_HARROW;
343                         break;
344                 case INPUT_HORIZONTAL_ABSOLUTE:
345                         mi->apply = InputHorizontalAbsolute;
346                         t->helpline = HLP_HARROW;
347                         break;
348                 case INPUT_VERTICAL_RATIO:
349                         mi->apply = InputVerticalRatio;
350                         t->helpline = HLP_VARROW;
351                         break;
352                 case INPUT_VERTICAL_ABSOLUTE:
353                         mi->apply = InputVerticalAbsolute;
354                         t->helpline = HLP_VARROW;
355                         break;
356                 case INPUT_CUSTOM_RATIO:
357                         mi->apply = InputCustomRatio;
358                         t->helpline = HLP_NONE;
359                         break;
360                 case INPUT_CUSTOM_RATIO_FLIP:
361                         mi->apply = InputCustomRatioFlip;
362                         t->helpline = HLP_NONE;
363                         break;
364                 case INPUT_NONE:
365                 default:
366                         mi->apply = NULL;
367                         break;
368         }
369
370         /* if we've allocated new data, free the old data
371          * less hassle then checking before every alloc above */
372         if (mi_data_prev && (mi_data_prev != mi->data)) {
373                 MEM_freeN(mi_data_prev);
374         }
375
376         /* bootstrap mouse input with initial values */
377         applyMouseInput(t, mi, mi->imval, t->values);
378 }
379
380 void setInputPostFct(MouseInput *mi, void (*post)(struct TransInfo *t, float values[3]))
381 {
382         mi->post = post;
383 }
384
385 void applyMouseInput(TransInfo *t, MouseInput *mi, const int mval[2], float output[3])
386 {
387         if (mi->apply != NULL) {
388                 mi->apply(t, mi, mval, output);
389         }
390
391         if (mi->post) {
392                 mi->post(t, output);
393         }
394 }
395
396 int handleMouseInput(TransInfo *t, MouseInput *mi, const wmEvent *event)
397 {
398         int redraw = TREDRAW_NOTHING;
399
400         switch (event->type) {
401                 case LEFTSHIFTKEY:
402                 case RIGHTSHIFTKEY:
403                         if (event->val == KM_PRESS) {
404                                 t->modifiers |= MOD_PRECISION;
405                                 /* shift is modifier for higher precision transform
406                                  * store the mouse position where the normal movement ended */
407                                 copy_v2_v2_int(mi->precision_mval, event->mval);
408                                 mi->precision = 1;
409                                 redraw = TREDRAW_HARD;
410                         }
411                         else if (event->val == KM_RELEASE) {
412                                 t->modifiers &= ~MOD_PRECISION;
413                                 mi->precision = 0;
414                                 redraw = TREDRAW_HARD;
415                         }
416                         break;
417         }
418
419         return redraw;
420 }