2ae24db7c3338b91a0e227eb2cd2fcbf3a124eef
[blender.git] / source / blender / editors / sculpt_paint / paint_stroke.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  * The Original Code is Copyright (C) 2009 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Jason Wilkins, Tom Musgrove.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  *
27  */
28
29 /** \file blender/editors/sculpt_paint/paint_stroke.c
30  *  \ingroup edsculpt
31  */
32
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BLI_math.h"
37 #include "BLI_utildefines.h"
38
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_brush_types.h"
42
43 #include "RNA_access.h"
44
45 #include "BKE_context.h"
46 #include "BKE_paint.h"
47 #include "BKE_brush.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #include "BIF_gl.h"
53 #include "BIF_glutil.h"
54
55 #include "ED_screen.h"
56 #include "ED_view3d.h"
57
58 #include "paint_intern.h"
59
60 #include <float.h>
61 #include <math.h>
62
63 typedef struct PaintSample {
64         float mouse[2];
65
66         /* TODO: other input properties, e.g. tablet pressure */
67 } PaintSample;
68
69 typedef struct PaintStroke {
70         void *mode_data;
71         void *smooth_stroke_cursor;
72         wmTimer *timer;
73
74         /* Cached values */
75         ViewContext vc;
76         bglMats mats;
77         Brush *brush;
78
79         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES prior inputs
80          * to smooth the stroke */
81         PaintSample samples[PAINT_MAX_INPUT_SAMPLES];
82         int num_samples;
83         int cur_sample;
84
85         float last_mouse_position[2];
86
87         /* Set whether any stroke step has yet occurred
88          * e.g. in sculpt mode, stroke doesn't start until cursor
89          * passes over the mesh */
90         int stroke_started;
91         /* event that started stroke, for modal() return */
92         int event_type;
93         
94         StrokeGetLocation get_location;
95         StrokeTestStart test_start;
96         StrokeUpdateStep update_step;
97         StrokeDone done;
98 } PaintStroke;
99
100 /*** Cursor ***/
101 static void paint_draw_smooth_stroke(bContext *C, int x, int y, void *customdata) 
102 {
103         Paint *paint = paint_get_active_from_context(C);
104         Brush *brush = paint_brush(paint);
105         PaintStroke *stroke = customdata;
106
107         glColor4ubv(paint->paint_cursor_col);
108         glEnable(GL_LINE_SMOOTH);
109         glEnable(GL_BLEND);
110
111         if (stroke && brush && (brush->flag & BRUSH_SMOOTH_STROKE)) {
112                 ARegion *ar = CTX_wm_region(C);
113                 sdrawline(x, y, (int)stroke->last_mouse_position[0] - ar->winrct.xmin,
114                           (int)stroke->last_mouse_position[1] - ar->winrct.ymin);
115         }
116
117         glDisable(GL_BLEND);
118         glDisable(GL_LINE_SMOOTH);
119 }
120
121 /* if this is a tablet event, return tablet pressure and set *pen_flip
122  * to 1 if the eraser tool is being used, 0 otherwise */
123 static float event_tablet_data(wmEvent *event, int *pen_flip)
124 {
125         int erasor = 0;
126         float pressure = 1;
127
128         if (event->custom == EVT_DATA_TABLET) {
129                 wmTabletData *wmtab = event->customdata;
130
131                 erasor = (wmtab->Active == EVT_TABLET_ERASER);
132                 pressure = (wmtab->Active != EVT_TABLET_NONE) ? wmtab->Pressure : 1;
133         }
134
135         if (pen_flip)
136                 (*pen_flip) = erasor;
137
138         return pressure;
139 }
140
141 /* Put the location of the next stroke dot into the stroke RNA and apply it to the mesh */
142 static void paint_brush_stroke_add_step(bContext *C, wmOperator *op, wmEvent *event, const float mouse_in[2])
143 {
144         Scene *scene = CTX_data_scene(C);
145         Paint *paint = paint_get_active_from_context(C);
146         Brush *brush = paint_brush(paint);
147         PaintStroke *stroke = op->customdata;
148         float mouse_out[2];
149         PointerRNA itemptr;
150         float location[3];
151         float pressure;
152         int pen_flip;
153
154         /* see if tablet affects event */
155         pressure = event_tablet_data(event, &pen_flip);
156
157         /* TODO: as sculpt and other paint modes are unified, this
158          * separation will go away */
159         if (stroke->vc.obact->sculpt) {
160                 float delta[2];
161
162                 BKE_brush_jitter_pos(scene, brush, mouse_in, mouse_out);
163
164                 /* XXX: meh, this is round about because
165                  * BKE_brush_jitter_pos isn't written in the best way to
166                  * be reused here */
167                 if (brush->flag & BRUSH_JITTER_PRESSURE) {
168                         sub_v2_v2v2(delta, mouse_out, mouse_in);
169                         mul_v2_fl(delta, pressure);
170                         add_v2_v2v2(mouse_out, mouse_in, delta);
171                 }
172         }
173         else {
174                 copy_v2_v2(mouse_out, mouse_in);
175         }
176
177         /* TODO: can remove the if statement once all modes have this */
178         if (stroke->get_location)
179                 stroke->get_location(C, location, mouse_out);
180         else
181                 zero_v3(location);
182
183         /* Add to stroke */
184         RNA_collection_add(op->ptr, "stroke", &itemptr);
185
186         RNA_float_set_array(&itemptr, "location", location);
187         RNA_float_set_array(&itemptr, "mouse", mouse_out);
188         RNA_boolean_set(&itemptr, "pen_flip", pen_flip);
189         RNA_float_set(&itemptr, "pressure", pressure);
190
191         copy_v2_v2(stroke->last_mouse_position, mouse_out);
192
193         stroke->update_step(C, stroke, &itemptr);
194 }
195
196 /* Returns zero if no sculpt changes should be made, non-zero otherwise */
197 static int paint_smooth_stroke(PaintStroke *stroke, float output[2],
198                                                            const PaintSample *sample)
199 {
200         output[0] = sample->mouse[0];
201         output[1] = sample->mouse[1];
202
203         if ((stroke->brush->flag & BRUSH_SMOOTH_STROKE) &&  
204             !ELEM4(stroke->brush->sculpt_tool,
205                    SCULPT_TOOL_GRAB,
206                    SCULPT_TOOL_THUMB,
207                    SCULPT_TOOL_ROTATE,
208                    SCULPT_TOOL_SNAKE_HOOK) &&
209             !(stroke->brush->flag & BRUSH_ANCHORED) &&
210             !(stroke->brush->flag & BRUSH_RESTORE_MESH))
211         {
212                 float u = stroke->brush->smooth_stroke_factor, v = 1.0f - u;
213                 float dx = stroke->last_mouse_position[0] - sample->mouse[0];
214                 float dy = stroke->last_mouse_position[1] - sample->mouse[1];
215
216                 /* If the mouse is moving within the radius of the last move,
217                  * don't update the mouse position. This allows sharp turns. */
218                 if (dx * dx + dy * dy < stroke->brush->smooth_stroke_radius * stroke->brush->smooth_stroke_radius)
219                         return 0;
220
221                 output[0] = sample->mouse[0] * v + stroke->last_mouse_position[0] * u;
222                 output[1] = sample->mouse[1] * v + stroke->last_mouse_position[1] * u;
223         }
224
225         return 1;
226 }
227
228 /* For brushes with stroke spacing enabled, moves mouse in steps
229  * towards the final mouse location. */
230 static int paint_space_stroke(bContext *C, wmOperator *op, wmEvent *event, const float final_mouse[2])
231 {
232         PaintStroke *stroke = op->customdata;
233         int cnt = 0;
234
235         if (paint_space_stroke_enabled(stroke->brush)) {
236                 float mouse[2];
237                 float vec[2];
238                 float length, scale;
239
240                 copy_v2_v2(mouse, stroke->last_mouse_position);
241                 sub_v2_v2v2(vec, final_mouse, mouse);
242
243                 length = len_v2(vec);
244
245                 if (length > FLT_EPSILON) {
246                         const Scene *scene = CTX_data_scene(C);
247                         int steps;
248                         int i;
249                         float pressure = 1.0f;
250
251                         /* XXX mysterious :) what has 'use size' do with this here... if you don't check for it, pressure fails */
252                         if (BKE_brush_use_size_pressure(scene, stroke->brush))
253                                 pressure = event_tablet_data(event, NULL);
254                         
255                         if (pressure > FLT_EPSILON) {
256                                 /* brushes can have a minimum size of 1.0 but with pressure it can be smaller then a pixel
257                                  * causing very high step sizes, hanging blender [#32381] */
258                                 const float size_clamp = maxf(1.0f, BKE_brush_size_get(scene, stroke->brush) * pressure);
259                                 scale = (size_clamp * stroke->brush->spacing / 50.0f) / length;
260                                 if (scale > FLT_EPSILON) {
261                                         mul_v2_fl(vec, scale);
262
263                                         steps = (int)(1.0f / scale);
264
265                                         for (i = 0; i < steps; ++i, ++cnt) {
266                                                 add_v2_v2(mouse, vec);
267                                                 paint_brush_stroke_add_step(C, op, event, mouse);
268                                         }
269                                 }
270                         }
271                 }
272         }
273
274         return cnt;
275 }
276
277 /**** Public API ****/
278
279 PaintStroke *paint_stroke_new(bContext *C,
280                               StrokeGetLocation get_location,
281                               StrokeTestStart test_start,
282                               StrokeUpdateStep update_step,
283                               StrokeDone done, int event_type)
284 {
285         PaintStroke *stroke = MEM_callocN(sizeof(PaintStroke), "PaintStroke");
286
287         stroke->brush = paint_brush(paint_get_active_from_context(C));
288         view3d_set_viewcontext(C, &stroke->vc);
289         view3d_get_transformation(stroke->vc.ar, stroke->vc.rv3d, stroke->vc.obact, &stroke->mats);
290
291         stroke->get_location = get_location;
292         stroke->test_start = test_start;
293         stroke->update_step = update_step;
294         stroke->done = done;
295         stroke->event_type = event_type; /* for modal, return event */
296         
297         return stroke;
298 }
299
300 void paint_stroke_data_free(struct wmOperator *op)
301 {
302         MEM_freeN(op->customdata);
303         op->customdata = NULL;
304 }
305
306 static void stroke_done(struct bContext *C, struct wmOperator *op)
307 {
308         struct PaintStroke *stroke = op->customdata;
309
310         if (stroke->stroke_started && stroke->done)
311                 stroke->done(C, stroke);
312
313         if (stroke->timer) {
314                 WM_event_remove_timer(
315                         CTX_wm_manager(C),
316                         CTX_wm_window(C),
317                         stroke->timer);
318         }
319
320         if (stroke->smooth_stroke_cursor)
321                 WM_paint_cursor_end(CTX_wm_manager(C), stroke->smooth_stroke_cursor);
322
323         paint_stroke_data_free(op);
324 }
325
326 /* Returns zero if the stroke dots should not be spaced, non-zero otherwise */
327 int paint_space_stroke_enabled(Brush *br)
328 {
329         return (br->flag & BRUSH_SPACE) &&
330                !(br->flag & BRUSH_ANCHORED) &&
331                !ELEM4(br->sculpt_tool, SCULPT_TOOL_GRAB, SCULPT_TOOL_THUMB, SCULPT_TOOL_ROTATE, SCULPT_TOOL_SNAKE_HOOK);
332 }
333
334 #define PAINT_STROKE_MODAL_CANCEL 1
335
336 /* called in paint_ops.c, on each regeneration of keymaps  */
337 struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf)
338 {
339         static struct EnumPropertyItem modal_items[] = {
340                 {PAINT_STROKE_MODAL_CANCEL, "CANCEL", 0,
341                 "Cancel",
342                 "Cancel and undo a stroke in progress"},
343
344                 { 0 }
345         };
346
347         static const char *name = "Paint Stroke Modal";
348
349         struct wmKeyMap *keymap = WM_modalkeymap_get(keyconf, name);
350
351         /* this function is called for each spacetype, only needs to add map once */
352         if (!keymap) {
353                 keymap = WM_modalkeymap_add(keyconf, name, modal_items);
354
355                 /* items for modal map */
356                 WM_modalkeymap_add_item(
357                         keymap, ESCKEY, KM_PRESS, KM_ANY, 0, PAINT_STROKE_MODAL_CANCEL);
358         }
359
360         return keymap;
361 }
362
363 static void paint_stroke_add_sample(const Paint *paint,
364                                     PaintStroke *stroke,
365                                     float x, float y)
366 {
367         PaintSample *sample = &stroke->samples[stroke->cur_sample];
368         int max_samples = MIN2(PAINT_MAX_INPUT_SAMPLES,
369                                MAX2(paint->num_input_samples, 1));
370
371         sample->mouse[0] = x;
372         sample->mouse[1] = y;
373
374         stroke->cur_sample++;
375         if (stroke->cur_sample >= max_samples)
376                 stroke->cur_sample = 0;
377         if (stroke->num_samples < max_samples)
378                 stroke->num_samples++;
379 }
380
381 static void paint_stroke_sample_average(const PaintStroke *stroke,
382                                         PaintSample *average)
383 {
384         int i;
385         
386         memset(average, 0, sizeof(*average));
387
388         BLI_assert(stroke->num_samples > 0);
389         
390         for (i = 0; i < stroke->num_samples; i++)
391                 add_v2_v2(average->mouse, stroke->samples[i].mouse);
392
393         mul_v2_fl(average->mouse, 1.0f / stroke->num_samples);
394
395         /*printf("avg=(%f, %f), num=%d\n", average->mouse[0], average->mouse[1], stroke->num_samples);*/
396 }
397
398 int paint_stroke_modal(bContext *C, wmOperator *op, wmEvent *event)
399 {
400         Paint *p = paint_get_active_from_context(C);
401         PaintStroke *stroke = op->customdata;
402         PaintSample sample_average;
403         float mouse[2];
404         int first = 0;
405
406         paint_stroke_add_sample(p, stroke, event->x, event->y);
407         paint_stroke_sample_average(stroke, &sample_average);
408
409         // let NDOF motion pass through to the 3D view so we can paint and rotate simultaneously!
410         // this isn't perfect... even when an extra MOUSEMOVE is spoofed, the stroke discards it
411         // since the 2D deltas are zero -- code in this file needs to be updated to use the
412         // post-NDOF_MOTION MOUSEMOVE
413         if (event->type == NDOF_MOTION)
414                 return OPERATOR_PASS_THROUGH;
415
416         if (!stroke->stroke_started) {
417                 copy_v2_v2(stroke->last_mouse_position, sample_average.mouse);
418                 stroke->stroke_started = stroke->test_start(C, op, sample_average.mouse);
419
420                 if (stroke->stroke_started) {
421                         stroke->smooth_stroke_cursor =
422                             WM_paint_cursor_activate(CTX_wm_manager(C), paint_poll, paint_draw_smooth_stroke, stroke);
423
424                         if (stroke->brush->flag & BRUSH_AIRBRUSH)
425                                 stroke->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, stroke->brush->rate);
426                 }
427
428                 first = 1;
429                 //ED_region_tag_redraw(ar);
430         }
431
432         /* Cancel */
433         if (event->type == EVT_MODAL_MAP && event->val == PAINT_STROKE_MODAL_CANCEL) {
434                 if (op->type->cancel)
435                         return op->type->cancel(C, op);
436                 else
437                         return paint_stroke_cancel(C, op);
438         }
439
440         if (event->type == stroke->event_type && event->val == KM_RELEASE) {
441                 stroke_done(C, op);
442                 return OPERATOR_FINISHED;
443         }
444         else if ((first) ||
445                  (ELEM(event->type, MOUSEMOVE, INBETWEEN_MOUSEMOVE)) ||
446                  (event->type == TIMER && (event->customdata == stroke->timer)) )
447         {
448                 if (stroke->stroke_started) {
449                         if (paint_smooth_stroke(stroke, mouse, &sample_average)) {
450                                 if (paint_space_stroke_enabled(stroke->brush)) {
451                                         if (!paint_space_stroke(C, op, event, mouse)) {
452                                                 //ED_region_tag_redraw(ar);
453                                         }
454                                 }
455                                 else {
456                                         paint_brush_stroke_add_step(C, op, event, mouse);
457                                 }
458                         }
459                         else {
460                                 ; //ED_region_tag_redraw(ar);
461                         }
462                 }
463         }
464
465         /* we want the stroke to have the first daub at the start location
466          * instead of waiting till we have moved the space distance */
467         if (first &&
468             stroke->stroke_started &&
469             paint_space_stroke_enabled(stroke->brush) &&
470             !(stroke->brush->flag & BRUSH_ANCHORED) &&
471             !(stroke->brush->flag & BRUSH_SMOOTH_STROKE))
472         {
473                 paint_brush_stroke_add_step(C, op, event, mouse);
474         }
475         
476         return OPERATOR_RUNNING_MODAL;
477 }
478
479 int paint_stroke_exec(bContext *C, wmOperator *op)
480 {
481         PaintStroke *stroke = op->customdata;
482
483         /* only when executed for the first time */
484         if (stroke->stroke_started == 0) {
485                 /* XXX stroke->last_mouse_position is unset, this may cause problems */
486                 stroke->test_start(C, op, NULL);
487                 stroke->stroke_started = 1;
488         }
489
490         RNA_BEGIN (op->ptr, itemptr, "stroke")
491         {
492                 stroke->update_step(C, stroke, &itemptr);
493         }
494         RNA_END;
495
496         stroke_done(C, op);
497
498         return OPERATOR_FINISHED;
499 }
500
501 int paint_stroke_cancel(bContext *C, wmOperator *op)
502 {
503         stroke_done(C, op);
504         return OPERATOR_CANCELLED;
505 }
506
507 ViewContext *paint_stroke_view_context(PaintStroke *stroke)
508 {
509         return &stroke->vc;
510 }
511
512 void *paint_stroke_mode_data(struct PaintStroke *stroke)
513 {
514         return stroke->mode_data;
515 }
516
517 void paint_stroke_set_mode_data(PaintStroke *stroke, void *mode_data)
518 {
519         stroke->mode_data = mode_data;
520 }
521
522 int paint_poll(bContext *C)
523 {
524         Paint *p = paint_get_active_from_context(C);
525         Object *ob = CTX_data_active_object(C);
526         ScrArea *sa = CTX_wm_area(C);
527         ARegion *ar = CTX_wm_region(C);
528
529         return p && ob && paint_brush(p) &&
530                (sa && sa->spacetype == SPACE_VIEW3D) &&
531                (ar && ar->regiontype == RGN_TYPE_WINDOW);
532 }