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