Cleanup: comment line length (windowmanager)
[blender.git] / source / blender / windowmanager / intern / wm_gesture.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup wm
22  *
23  * Gestures (cursor motions) creating, evaluating and drawing, shared between operators.
24  */
25
26 #include "DNA_screen_types.h"
27 #include "DNA_vec_types.h"
28 #include "DNA_userdef_types.h"
29 #include "DNA_windowmanager_types.h"
30
31 #include "MEM_guardedalloc.h"
32
33 #include "BLI_bitmap_draw_2d.h"
34 #include "BLI_blenlib.h"
35 #include "BLI_math.h"
36 #include "BLI_utildefines.h"
37 #include "BLI_lasso_2d.h"
38
39 #include "BKE_context.h"
40
41 #include "WM_api.h"
42 #include "WM_types.h"
43
44 #include "wm.h"
45 #include "wm_draw.h"
46
47 #include "GPU_immediate.h"
48 #include "GPU_immediate_util.h"
49 #include "GPU_state.h"
50
51 #include "BIF_glutil.h"
52
53 /* context checked on having screen, window and area */
54 wmGesture *WM_gesture_new(bContext *C, const wmEvent *event, int type)
55 {
56   wmGesture *gesture = MEM_callocN(sizeof(wmGesture), "new gesture");
57   wmWindow *window = CTX_wm_window(C);
58   ARegion *ar = CTX_wm_region(C);
59
60   BLI_addtail(&window->gesture, gesture);
61
62   gesture->type = type;
63   gesture->event_type = event->type;
64   gesture->winrct = ar->winrct;
65   gesture->userdata_free = true; /* Free if userdata is set. */
66   gesture->modal_state = GESTURE_MODAL_NOP;
67
68   if (ELEM(type,
69            WM_GESTURE_RECT,
70            WM_GESTURE_CROSS_RECT,
71            WM_GESTURE_TWEAK,
72            WM_GESTURE_CIRCLE,
73            WM_GESTURE_STRAIGHTLINE)) {
74     rcti *rect = MEM_callocN(sizeof(rcti), "gesture rect new");
75
76     gesture->customdata = rect;
77     rect->xmin = event->x - gesture->winrct.xmin;
78     rect->ymin = event->y - gesture->winrct.ymin;
79     if (type == WM_GESTURE_CIRCLE) {
80       /* caller is responsible for initializing 'xmax' to radius. */
81     }
82     else {
83       rect->xmax = event->x - gesture->winrct.xmin;
84       rect->ymax = event->y - gesture->winrct.ymin;
85     }
86   }
87   else if (ELEM(type, WM_GESTURE_LINES, WM_GESTURE_LASSO)) {
88     short *lasso;
89     gesture->points_alloc = 1024;
90     gesture->customdata = lasso = MEM_mallocN(sizeof(short[2]) * gesture->points_alloc,
91                                               "lasso points");
92     lasso[0] = event->x - gesture->winrct.xmin;
93     lasso[1] = event->y - gesture->winrct.ymin;
94     gesture->points = 1;
95   }
96
97   return gesture;
98 }
99
100 void WM_gesture_end(bContext *C, wmGesture *gesture)
101 {
102   wmWindow *win = CTX_wm_window(C);
103
104   if (win->tweak == gesture) {
105     win->tweak = NULL;
106   }
107   BLI_remlink(&win->gesture, gesture);
108   MEM_freeN(gesture->customdata);
109   if (gesture->userdata && gesture->userdata_free) {
110     MEM_freeN(gesture->userdata);
111   }
112   MEM_freeN(gesture);
113 }
114
115 void WM_gestures_remove(bContext *C)
116 {
117   wmWindow *win = CTX_wm_window(C);
118
119   while (win->gesture.first) {
120     WM_gesture_end(C, win->gesture.first);
121   }
122 }
123
124 bool WM_gesture_is_modal_first(const wmGesture *gesture)
125 {
126   if (gesture == NULL) {
127     return true;
128   }
129   return (gesture->is_active_prev == false);
130 }
131
132 /* tweak and line gestures */
133 int wm_gesture_evaluate(wmGesture *gesture)
134 {
135   if (gesture->type == WM_GESTURE_TWEAK) {
136     rcti *rect = gesture->customdata;
137     int dx = BLI_rcti_size_x(rect);
138     int dy = BLI_rcti_size_y(rect);
139     float tweak_threshold = U.tweak_threshold * U.dpi_fac;
140     if (abs(dx) + abs(dy) > tweak_threshold) {
141       int theta = round_fl_to_int(4.0f * atan2f((float)dy, (float)dx) / (float)M_PI);
142       int val = EVT_GESTURE_W;
143
144       if (theta == 0) {
145         val = EVT_GESTURE_E;
146       }
147       else if (theta == 1) {
148         val = EVT_GESTURE_NE;
149       }
150       else if (theta == 2) {
151         val = EVT_GESTURE_N;
152       }
153       else if (theta == 3) {
154         val = EVT_GESTURE_NW;
155       }
156       else if (theta == -1) {
157         val = EVT_GESTURE_SE;
158       }
159       else if (theta == -2) {
160         val = EVT_GESTURE_S;
161       }
162       else if (theta == -3) {
163         val = EVT_GESTURE_SW;
164       }
165
166 #if 0
167       /* debug */
168       if (val == 1)
169         printf("tweak north\n");
170       if (val == 2)
171         printf("tweak north-east\n");
172       if (val == 3)
173         printf("tweak east\n");
174       if (val == 4)
175         printf("tweak south-east\n");
176       if (val == 5)
177         printf("tweak south\n");
178       if (val == 6)
179         printf("tweak south-west\n");
180       if (val == 7)
181         printf("tweak west\n");
182       if (val == 8)
183         printf("tweak north-west\n");
184 #endif
185       return val;
186     }
187   }
188   return 0;
189 }
190
191 /* ******************* gesture draw ******************* */
192
193 static void wm_gesture_draw_line(wmGesture *gt)
194 {
195   rcti *rect = (rcti *)gt->customdata;
196
197   uint shdr_pos = GPU_vertformat_attr_add(
198       immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
199
200   immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
201
202   float viewport_size[4];
203   glGetFloatv(GL_VIEWPORT, viewport_size);
204   immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
205
206   immUniform1i("colors_len", 2); /* "advanced" mode */
207   immUniformArray4fv(
208       "colors", (float *)(float[][4]){{0.4f, 0.4f, 0.4f, 1.0f}, {1.0f, 1.0f, 1.0f, 1.0f}}, 2);
209   immUniform1f("dash_width", 8.0f);
210
211   float xmin = (float)rect->xmin;
212   float ymin = (float)rect->ymin;
213
214   immBegin(GPU_PRIM_LINES, 2);
215   immVertex2f(shdr_pos, xmin, ymin);
216   immVertex2f(shdr_pos, (float)rect->xmax, (float)rect->ymax);
217   immEnd();
218
219   immUnbindProgram();
220 }
221
222 static void wm_gesture_draw_rect(wmGesture *gt)
223 {
224   rcti *rect = (rcti *)gt->customdata;
225
226   uint shdr_pos = GPU_vertformat_attr_add(
227       immVertexFormat(), "pos", GPU_COMP_I32, 2, GPU_FETCH_INT_TO_FLOAT);
228
229   GPU_blend(true);
230
231   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
232   immUniformColor4f(1.0f, 1.0f, 1.0f, 0.05f);
233
234   immRecti(shdr_pos, rect->xmin, rect->ymin, rect->xmax, rect->ymax);
235
236   immUnbindProgram();
237
238   GPU_blend(false);
239
240   shdr_pos = GPU_vertformat_attr_add(immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
241
242   immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
243
244   float viewport_size[4];
245   glGetFloatv(GL_VIEWPORT, viewport_size);
246   immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
247
248   immUniform1i("colors_len", 2); /* "advanced" mode */
249   immUniformArray4fv(
250       "colors", (float *)(float[][4]){{0.4f, 0.4f, 0.4f, 1.0f}, {1.0f, 1.0f, 1.0f, 1.0f}}, 2);
251   immUniform1f("dash_width", 8.0f);
252
253   imm_draw_box_wire_2d(
254       shdr_pos, (float)rect->xmin, (float)rect->ymin, (float)rect->xmax, (float)rect->ymax);
255
256   immUnbindProgram();
257
258   /* draws a diagonal line in the lined box to test wm_gesture_draw_line */
259   // wm_gesture_draw_line(gt);
260 }
261
262 static void wm_gesture_draw_circle(wmGesture *gt)
263 {
264   rcti *rect = (rcti *)gt->customdata;
265
266   GPU_blend(true);
267
268   const uint shdr_pos = GPU_vertformat_attr_add(
269       immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
270
271   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
272
273   immUniformColor4f(1.0f, 1.0f, 1.0f, 0.05f);
274   imm_draw_circle_fill_2d(shdr_pos, (float)rect->xmin, (float)rect->ymin, (float)rect->xmax, 40);
275
276   immUnbindProgram();
277
278   GPU_blend(false);
279
280   immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
281
282   float viewport_size[4];
283   glGetFloatv(GL_VIEWPORT, viewport_size);
284   immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
285
286   immUniform1i("colors_len", 2); /* "advanced" mode */
287   immUniformArray4fv(
288       "colors", (float *)(float[][4]){{0.4f, 0.4f, 0.4f, 1.0f}, {1.0f, 1.0f, 1.0f, 1.0f}}, 2);
289   immUniform1f("dash_width", 4.0f);
290
291   imm_draw_circle_wire_2d(shdr_pos, (float)rect->xmin, (float)rect->ymin, (float)rect->xmax, 40);
292
293   immUnbindProgram();
294 }
295
296 struct LassoFillData {
297   unsigned char *px;
298   int width;
299 };
300
301 static void draw_filled_lasso_px_cb(int x, int x_end, int y, void *user_data)
302 {
303   struct LassoFillData *data = user_data;
304   unsigned char *col = &(data->px[(y * data->width) + x]);
305   memset(col, 0x10, x_end - x);
306 }
307
308 static void draw_filled_lasso(wmGesture *gt)
309 {
310   const short *lasso = (short *)gt->customdata;
311   const int tot = gt->points;
312   int(*moves)[2] = MEM_mallocN(sizeof(*moves) * (tot + 1), __func__);
313   int i;
314   rcti rect;
315   float red[4] = {1.0f, 0.0f, 0.0f, 0.0f};
316
317   for (i = 0; i < tot; i++, lasso += 2) {
318     moves[i][0] = lasso[0];
319     moves[i][1] = lasso[1];
320   }
321
322   BLI_lasso_boundbox(&rect, (const int(*)[2])moves, tot);
323
324   BLI_rcti_translate(&rect, gt->winrct.xmin, gt->winrct.ymin);
325   BLI_rcti_isect(&gt->winrct, &rect, &rect);
326   BLI_rcti_translate(&rect, -gt->winrct.xmin, -gt->winrct.ymin);
327
328   /* highly unlikely this will fail, but could crash if (tot == 0) */
329   if (BLI_rcti_is_empty(&rect) == false) {
330     const int w = BLI_rcti_size_x(&rect);
331     const int h = BLI_rcti_size_y(&rect);
332     unsigned char *pixel_buf = MEM_callocN(sizeof(*pixel_buf) * w * h, __func__);
333     struct LassoFillData lasso_fill_data = {pixel_buf, w};
334
335     BLI_bitmap_draw_2d_poly_v2i_n(rect.xmin,
336                                   rect.ymin,
337                                   rect.xmax,
338                                   rect.ymax,
339                                   (const int(*)[2])moves,
340                                   tot,
341                                   draw_filled_lasso_px_cb,
342                                   &lasso_fill_data);
343
344     /* Additive Blending */
345     GPU_blend(true);
346     glBlendFunc(GL_ONE, GL_ONE);
347
348     GLint unpack_alignment;
349     glGetIntegerv(GL_UNPACK_ALIGNMENT, &unpack_alignment);
350
351     glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
352
353     IMMDrawPixelsTexState state = immDrawPixelsTexSetup(GPU_SHADER_2D_IMAGE_SHUFFLE_COLOR);
354     GPU_shader_bind(state.shader);
355     GPU_shader_uniform_vector(
356         state.shader, GPU_shader_get_uniform_ensure(state.shader, "shuffle"), 4, 1, red);
357
358     immDrawPixelsTex(&state,
359                      rect.xmin,
360                      rect.ymin,
361                      w,
362                      h,
363                      GL_RED,
364                      GL_UNSIGNED_BYTE,
365                      GL_NEAREST,
366                      pixel_buf,
367                      1.0f,
368                      1.0f,
369                      NULL);
370
371     GPU_shader_unbind();
372
373     glPixelStorei(GL_UNPACK_ALIGNMENT, unpack_alignment);
374
375     MEM_freeN(pixel_buf);
376
377     GPU_blend(false);
378     glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
379   }
380
381   MEM_freeN(moves);
382 }
383
384 static void wm_gesture_draw_lasso(wmGesture *gt, bool filled)
385 {
386   const short *lasso = (short *)gt->customdata;
387   int i;
388
389   if (filled) {
390     draw_filled_lasso(gt);
391   }
392
393   const int numverts = gt->points;
394
395   /* Nothing to draw, do early output. */
396   if (numverts < 2) {
397     return;
398   }
399
400   const uint shdr_pos = GPU_vertformat_attr_add(
401       immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
402
403   immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
404
405   float viewport_size[4];
406   glGetFloatv(GL_VIEWPORT, viewport_size);
407   immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
408
409   immUniform1i("colors_len", 2); /* "advanced" mode */
410   immUniformArray4fv(
411       "colors", (float *)(float[][4]){{0.4f, 0.4f, 0.4f, 1.0f}, {1.0f, 1.0f, 1.0f, 1.0f}}, 2);
412   immUniform1f("dash_width", 2.0f);
413
414   immBegin((gt->type == WM_GESTURE_LASSO) ? GPU_PRIM_LINE_LOOP : GPU_PRIM_LINE_STRIP, numverts);
415
416   for (i = 0; i < gt->points; i++, lasso += 2) {
417     immVertex2f(shdr_pos, (float)lasso[0], (float)lasso[1]);
418   }
419
420   immEnd();
421
422   immUnbindProgram();
423 }
424
425 static void wm_gesture_draw_cross(wmWindow *win, wmGesture *gt)
426 {
427   rcti *rect = (rcti *)gt->customdata;
428   const int winsize_x = WM_window_pixels_x(win);
429   const int winsize_y = WM_window_pixels_y(win);
430
431   float x1, x2, y1, y2;
432
433   const uint shdr_pos = GPU_vertformat_attr_add(
434       immVertexFormat(), "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
435
436   immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
437
438   float viewport_size[4];
439   glGetFloatv(GL_VIEWPORT, viewport_size);
440   immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
441
442   immUniform1i("colors_len", 2); /* "advanced" mode */
443   immUniformArray4fv(
444       "colors", (float *)(float[][4]){{0.4f, 0.4f, 0.4f, 1.0f}, {1.0f, 1.0f, 1.0f, 1.0f}}, 2);
445   immUniform1f("dash_width", 8.0f);
446
447   immBegin(GPU_PRIM_LINES, 4);
448
449   x1 = (float)(rect->xmin - winsize_x);
450   y1 = (float)rect->ymin;
451   x2 = (float)(rect->xmin + winsize_x);
452   y2 = y1;
453
454   immVertex2f(shdr_pos, x1, y1);
455   immVertex2f(shdr_pos, x2, y2);
456
457   x1 = (float)rect->xmin;
458   y1 = (float)(rect->ymin - winsize_y);
459   x2 = x1;
460   y2 = (float)(rect->ymin + winsize_y);
461
462   immVertex2f(shdr_pos, x1, y1);
463   immVertex2f(shdr_pos, x2, y2);
464
465   immEnd();
466
467   immUnbindProgram();
468 }
469
470 /* called in wm_draw.c */
471 void wm_gesture_draw(wmWindow *win)
472 {
473   wmGesture *gt = (wmGesture *)win->gesture.first;
474
475   GPU_line_width(1.0f);
476   for (; gt; gt = gt->next) {
477     /* all in subwindow space */
478     wmViewport(&gt->winrct);
479
480     if (gt->type == WM_GESTURE_RECT) {
481       wm_gesture_draw_rect(gt);
482     }
483     //      else if (gt->type == WM_GESTURE_TWEAK)
484     //          wm_gesture_draw_line(gt);
485     else if (gt->type == WM_GESTURE_CIRCLE) {
486       wm_gesture_draw_circle(gt);
487     }
488     else if (gt->type == WM_GESTURE_CROSS_RECT) {
489       if (gt->is_active) {
490         wm_gesture_draw_rect(gt);
491       }
492       else {
493         wm_gesture_draw_cross(win, gt);
494       }
495     }
496     else if (gt->type == WM_GESTURE_LINES) {
497       wm_gesture_draw_lasso(gt, false);
498     }
499     else if (gt->type == WM_GESTURE_LASSO) {
500       wm_gesture_draw_lasso(gt, true);
501     }
502     else if (gt->type == WM_GESTURE_STRAIGHTLINE) {
503       wm_gesture_draw_line(gt);
504     }
505   }
506 }
507
508 void wm_gesture_tag_redraw(bContext *C)
509 {
510   bScreen *screen = CTX_wm_screen(C);
511
512   if (screen) {
513     screen->do_draw_gesture = true;
514   }
515 }