Merge branch 'master' into blender2.8
[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 "BKE_context.h"
34
35 #include "BLI_math.h"
36 #include "BLI_utildefines.h"
37
38 #include "WM_types.h"
39 #include "WM_api.h"
40
41 #include "transform.h"
42
43 #include "MEM_guardedalloc.h" 
44
45 /* ************************** INPUT FROM MOUSE *************************** */
46
47 static void InputVector(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
48 {
49         convertViewVec(t, output, mval[0] - mi->imval[0], mval[1] - mi->imval[1]);
50 }
51
52 static void InputSpring(TransInfo *UNUSED(t), MouseInput *mi, const double mval[2], float output[3])
53 {
54         double dx, dy;
55         float ratio;
56
57         dx = ((double)mi->center[0] - mval[0]);
58         dy = ((double)mi->center[1] - mval[1]);
59         ratio = hypot(dx, dy) / (double)mi->factor;
60
61         output[0] = ratio;
62 }
63
64 static void InputSpringFlip(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
65 {
66         InputSpring(t, mi, mval, output);
67
68         /* flip scale */
69         /* values can become really big when zoomed in so use longs [#26598] */
70         if ((int64_t)((int)mi->center[0] - mval[0]) * (int64_t)((int)mi->center[0] - mi->imval[0]) +
71             (int64_t)((int)mi->center[1] - mval[1]) * (int64_t)((int)mi->center[1] - mi->imval[1]) < 0)
72         {
73                 output[0] *= -1.0f;
74         }
75 }
76
77 static void InputSpringDelta(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
78 {
79         InputSpring(t, mi, mval, output);
80         output[0] -= 1.0f;
81 }
82
83 static void InputTrackBall(TransInfo *UNUSED(t), MouseInput *mi, const double mval[2], float output[3])
84 {
85         output[0] = (float)(mi->imval[1] - mval[1]);
86         output[1] = (float)(mval[0] - mi->imval[0]);
87
88         output[0] *= mi->factor;
89         output[1] *= mi->factor;
90 }
91
92 static void InputHorizontalRatio(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
93 {
94         const int winx = t->ar ? t->ar->winx : 1;
95
96         output[0] = ((mval[0] - mi->imval[0]) / winx) * 2.0f;
97 }
98
99 static void InputHorizontalAbsolute(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
100 {
101         float vec[3];
102
103         InputVector(t, mi, mval, vec);
104         project_v3_v3v3(vec, vec, t->viewinv[0]);
105
106         output[0] = dot_v3v3(t->viewinv[0], vec) * 2.0f;
107 }
108
109 static void InputVerticalRatio(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
110 {
111         const int winy = t->ar ? t->ar->winy : 1;
112
113         output[0] = ((mval[1] - mi->imval[1]) / winy) * 2.0f;
114 }
115
116 static void InputVerticalAbsolute(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
117 {
118         float vec[3];
119
120         InputVector(t, mi, mval, vec);
121         project_v3_v3v3(vec, vec, t->viewinv[1]);
122
123         output[0] = dot_v3v3(t->viewinv[1], vec) * 2.0f;
124 }
125
126 void setCustomPoints(TransInfo *UNUSED(t), MouseInput *mi, const int mval_start[2], const int mval_end[2])
127 {
128         int *data;
129
130         mi->data = MEM_reallocN(mi->data, sizeof(int) * 4);
131         
132         data = mi->data;
133
134         data[0] = mval_start[0];
135         data[1] = mval_start[1];
136         data[2] = mval_end[0];
137         data[3] = mval_end[1];
138 }
139
140 static void InputCustomRatioFlip(TransInfo *UNUSED(t), MouseInput *mi, const double mval[2], float output[3])
141 {
142         double length;
143         double distance;
144         double dx, dy;
145         const int *data = mi->data;
146         
147         if (data) {
148                 int mdx, mdy;
149                 dx = data[2] - data[0];
150                 dy = data[3] - data[1];
151
152                 length = hypot(dx, dy);
153
154                 mdx = mval[0] - data[2];
155                 mdy = mval[1] - data[3];
156
157                 distance = (length != 0.0) ? (mdx * dx + mdy * dy) / length : 0.0;
158
159                 output[0] = (length != 0.0) ? (double)(distance / length) : 0.0;
160         }
161 }
162
163 static void InputCustomRatio(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
164 {
165         InputCustomRatioFlip(t, mi, mval, output);
166         output[0] = -output[0];
167 }
168
169 struct InputAngle_Data {
170         double angle;
171         double mval_prev[2];
172 };
173
174 static void InputAngle(TransInfo *UNUSED(t), MouseInput *mi, const double mval[2], float output[3])
175 {
176         struct InputAngle_Data *data = mi->data;
177         double dx2 = mval[0] - (double)mi->center[0];
178         double dy2 = mval[1] - (double)mi->center[1];
179         double B = sqrt(dx2 * dx2 + dy2 * dy2);
180
181         double dx1 = data->mval_prev[0] - (double)mi->center[0];
182         double dy1 = data->mval_prev[1] - (double)mi->center[1];
183         double A = sqrt(dx1 * dx1 + dy1 * dy1);
184
185         double dx3 = mval[0] - data->mval_prev[0];
186         double dy3 = mval[1] - data->mval_prev[1];
187
188         /* use doubles here, to make sure a "1.0" (no rotation) doesn't become 9.999999e-01, which gives 0.02 for acos */
189         double deler = (((dx1 * dx1 + dy1 * dy1) +
190                          (dx2 * dx2 + dy2 * dy2) -
191                          (dx3 * dx3 + dy3 * dy3)) / (2.0 * (((A * B) != 0.0) ? (A * B) : 1.0)));
192         /* ((A * B) ? (A * B) : 1.0) this takes care of potential divide by zero errors */
193
194         float dphi;
195
196         dphi = saacos((float)deler);
197         if ((dx1 * dy2 - dx2 * dy1) > 0.0) dphi = -dphi;
198
199         /* If the angle is zero, because of lack of precision close to the 1.0 value in acos
200          * approximate the angle with the opposite side of the normalized triangle
201          * This is a good approximation here since the smallest acos value seems to be around
202          * 0.02 degree and lower values don't even have a 0.01% error compared to the approximation
203          */
204         if (dphi == 0) {
205                 double dx, dy;
206
207                 dx2 /= A;
208                 dy2 /= A;
209
210                 dx1 /= B;
211                 dy1 /= B;
212
213                 dx = dx1 - dx2;
214                 dy = dy1 - dy2;
215
216                 dphi = sqrt(dx * dx + dy * dy);
217                 if ((dx1 * dy2 - dx2 * dy1) > 0.0) dphi = -dphi;
218         }
219
220         data->angle += ((double)dphi) * (mi->precision ? (double)mi->precision_factor : 1.0);
221
222         data->mval_prev[0] = mval[0];
223         data->mval_prev[1] = mval[1];
224
225         output[0] = data->angle;
226 }
227
228 static void InputAngleSpring(TransInfo *t, MouseInput *mi, const double mval[2], float output[3])
229 {
230         float toutput[3];
231
232         InputAngle(t, mi, mval, output);
233         InputSpring(t, mi, mval, toutput);
234
235         output[1] = toutput[0];
236 }
237
238 void initMouseInput(TransInfo *UNUSED(t), MouseInput *mi, const float center[2], const int mval[2], const bool precision)
239 {
240         mi->factor = 0;
241         mi->precision = precision;
242
243         mi->center[0] = center[0];
244         mi->center[1] = center[1];
245
246         mi->imval[0] = mval[0];
247         mi->imval[1] = mval[1];
248
249         mi->post = NULL;
250 }
251
252 static void calcSpringFactor(MouseInput *mi)
253 {
254         mi->factor = sqrtf(((float)(mi->center[1] - mi->imval[1])) * ((float)(mi->center[1] - mi->imval[1])) +
255                            ((float)(mi->center[0] - mi->imval[0])) * ((float)(mi->center[0] - mi->imval[0])));
256
257         if (mi->factor == 0.0f) {
258                 mi->factor = 1.0f; /* prevent Inf */
259         }
260 }
261
262 void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode)
263 {
264         /* incase we allocate a new value */
265         void *mi_data_prev = mi->data;
266
267         mi->use_virtual_mval = true;
268         mi->precision_factor = 1.0f / 10.0f;
269
270         switch (mode) {
271                 case INPUT_VECTOR:
272                         mi->apply = InputVector;
273                         t->helpline = HLP_NONE;
274                         break;
275                 case INPUT_SPRING:
276                         calcSpringFactor(mi);
277                         mi->apply = InputSpring;
278                         t->helpline = HLP_SPRING;
279                         break;
280                 case INPUT_SPRING_FLIP:
281                         calcSpringFactor(mi);
282                         mi->apply = InputSpringFlip;
283                         t->helpline = HLP_SPRING;
284                         break;
285                 case INPUT_SPRING_DELTA:
286                         calcSpringFactor(mi);
287                         mi->apply = InputSpringDelta;
288                         t->helpline = HLP_SPRING;
289                         break;
290                 case INPUT_ANGLE:
291                 case INPUT_ANGLE_SPRING:
292                 {
293                         struct InputAngle_Data *data;
294                         mi->use_virtual_mval = false;
295                         mi->precision_factor = 1.0f / 30.0f;
296                         data = MEM_callocN(sizeof(struct InputAngle_Data), "angle accumulator");
297                         data->mval_prev[0] = mi->imval[0];
298                         data->mval_prev[1] = mi->imval[1];
299                         mi->data = data;
300                         if (mode == INPUT_ANGLE) {
301                                 mi->apply = InputAngle;
302                         }
303                         else {
304                                 calcSpringFactor(mi);
305                                 mi->apply = InputAngleSpring;
306                         }
307                         t->helpline = HLP_ANGLE;
308                         break;
309                 }
310                 case INPUT_TRACKBALL:
311                         mi->precision_factor = 1.0f / 30.0f;
312                         /* factor has to become setting or so */
313                         mi->factor = 0.01f;
314                         mi->apply = InputTrackBall;
315                         t->helpline = HLP_TRACKBALL;
316                         break;
317                 case INPUT_HORIZONTAL_RATIO:
318                         mi->apply = InputHorizontalRatio;
319                         t->helpline = HLP_HARROW;
320                         break;
321                 case INPUT_HORIZONTAL_ABSOLUTE:
322                         mi->apply = InputHorizontalAbsolute;
323                         t->helpline = HLP_HARROW;
324                         break;
325                 case INPUT_VERTICAL_RATIO:
326                         mi->apply = InputVerticalRatio;
327                         t->helpline = HLP_VARROW;
328                         break;
329                 case INPUT_VERTICAL_ABSOLUTE:
330                         mi->apply = InputVerticalAbsolute;
331                         t->helpline = HLP_VARROW;
332                         break;
333                 case INPUT_CUSTOM_RATIO:
334                         mi->apply = InputCustomRatio;
335                         t->helpline = HLP_NONE;
336                         break;
337                 case INPUT_CUSTOM_RATIO_FLIP:
338                         mi->apply = InputCustomRatioFlip;
339                         t->helpline = HLP_NONE;
340                         break;
341                 case INPUT_NONE:
342                 default:
343                         mi->apply = NULL;
344                         break;
345         }
346
347         /* setup for the mouse cursor: either set a custom one,
348          * or hide it if it will be drawn with the helpline */
349         wmWindow *win = CTX_wm_window(t->context);
350         switch (t->helpline) {
351                 case HLP_NONE:
352                         /* INPUT_VECTOR, INPUT_CUSTOM_RATIO, INPUT_CUSTOM_RATIO_FLIP */
353                         if (t->flag & T_MODAL) {
354                                 WM_cursor_set(win, BC_NSEW_SCROLLCURSOR);
355                         }
356                         break;
357                 case HLP_SPRING:
358                 case HLP_ANGLE:
359                 case HLP_TRACKBALL:
360                 case HLP_HARROW:
361                 case HLP_VARROW:
362                         if (t->flag & T_MODAL) {
363                                 WM_cursor_set(win, CURSOR_NONE);
364                         }
365                         break;
366                 default:
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         double mval_db[2];
388
389         if (mi->use_virtual_mval) {
390                 /* update accumulator */
391                 double mval_delta[2];
392
393                 mval_delta[0] = (mval[0] - mi->imval[0]) - mi->virtual_mval.prev[0];
394                 mval_delta[1] = (mval[1] - mi->imval[1]) - mi->virtual_mval.prev[1];
395
396                 mi->virtual_mval.prev[0] += mval_delta[0];
397                 mi->virtual_mval.prev[1] += mval_delta[1];
398
399                 if (mi->precision) {
400                         mval_delta[0] *= (double)mi->precision_factor;
401                         mval_delta[1] *= (double)mi->precision_factor;
402                 }
403
404                 mi->virtual_mval.accum[0] += mval_delta[0];
405                 mi->virtual_mval.accum[1] += mval_delta[1];
406
407                 mval_db[0] = mi->imval[0] + mi->virtual_mval.accum[0];
408                 mval_db[1] = mi->imval[1] + mi->virtual_mval.accum[1];
409         }
410         else {
411                 mval_db[0] = mval[0];
412                 mval_db[1] = mval[1];
413         }
414
415
416         if (mi->apply != NULL) {
417                 mi->apply(t, mi, mval_db, output);
418         }
419
420         if (!is_zero_v3(t->values_modal_offset)) {
421                 float values_ofs[3];
422                 mul_v3_m3v3(values_ofs, t->spacemtx, t->values_modal_offset);
423                 add_v3_v3(t->values, values_ofs);
424         }
425
426         if (mi->post) {
427                 mi->post(t, output);
428         }
429 }
430
431 eRedrawFlag handleMouseInput(TransInfo *t, MouseInput *mi, const wmEvent *event)
432 {
433         eRedrawFlag redraw = TREDRAW_NOTHING;
434
435         switch (event->type) {
436                 case LEFTSHIFTKEY:
437                 case RIGHTSHIFTKEY:
438                         if (event->val == KM_PRESS) {
439                                 t->modifiers |= MOD_PRECISION;
440                                 /* shift is modifier for higher precision transforn */
441                                 mi->precision = 1;
442                                 redraw = TREDRAW_HARD;
443                         }
444                         else if (event->val == KM_RELEASE) {
445                                 t->modifiers &= ~MOD_PRECISION;
446                                 mi->precision = 0;
447                                 redraw = TREDRAW_HARD;
448                         }
449                         break;
450         }
451
452         return redraw;
453 }