14c1976b45c575f767d858b8be1cefdd84832f77
[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         if (stroke && brush && (brush->flag & BRUSH_SMOOTH_STROKE)) {
108                 glColor4ubv(paint->paint_cursor_col);
109                 glEnable(GL_LINE_SMOOTH);
110                 glEnable(GL_BLEND);
111
112                 sdrawline(x, y, (int)stroke->last_mouse_position[0],
113                           (int)stroke->last_mouse_position[1]);
114                 glDisable(GL_BLEND);
115                 glDisable(GL_LINE_SMOOTH);
116         }
117 }
118
119 /* if this is a tablet event, return tablet pressure and set *pen_flip
120  * to 1 if the eraser tool is being used, 0 otherwise */
121 static float event_tablet_data(wmEvent *event, int *pen_flip)
122 {
123         int erasor = 0;
124         float pressure = 1;
125
126         if (event->tablet_data) {
127                 wmTabletData *wmtab = event->tablet_data;
128
129                 erasor = (wmtab->Active == EVT_TABLET_ERASER);
130                 pressure = (wmtab->Active != EVT_TABLET_NONE) ? wmtab->Pressure : 1;
131         }
132
133         if (pen_flip)
134                 (*pen_flip) = erasor;
135
136         return pressure;
137 }
138
139 /* Put the location of the next stroke dot into the stroke RNA and apply it to the mesh */
140 static void paint_brush_stroke_add_step(bContext *C, wmOperator *op, wmEvent *event, const float mouse_in[2])
141 {
142         Scene *scene = CTX_data_scene(C);
143         Paint *paint = paint_get_active_from_context(C);
144         PaintMode mode = paintmode_get_active_from_context(C);
145         Brush *brush = paint_brush(paint);
146         PaintStroke *stroke = op->customdata;
147         float mouse_out[2];
148         PointerRNA itemptr;
149         float location[3];
150         float pressure;
151         int pen_flip;
152
153         /* see if tablet affects event */
154         pressure = event_tablet_data(event, &pen_flip);
155
156         /* TODO: as sculpt and other paint modes are unified, this
157          * separation will go away */
158         if (paint_supports_jitter(mode)) {
159                 float delta[2];
160
161                 BKE_brush_jitter_pos(scene, brush, mouse_in, mouse_out);
162
163                 /* XXX: meh, this is round about because
164                  * BKE_brush_jitter_pos isn't written in the best way to
165                  * be reused here */
166                 if (brush->flag & BRUSH_JITTER_PRESSURE) {
167                         sub_v2_v2v2(delta, mouse_out, mouse_in);
168                         mul_v2_fl(delta, pressure);
169                         add_v2_v2v2(mouse_out, mouse_in, delta);
170                 }
171         }
172         else {
173                 copy_v2_v2(mouse_out, mouse_in);
174         }
175
176         /* TODO: can remove the if statement once all modes have this */
177         if (stroke->get_location)
178                 stroke->get_location(C, location, mouse_out);
179         else
180                 zero_v3(location);
181
182         /* Add to stroke */
183         RNA_collection_add(op->ptr, "stroke", &itemptr);
184
185         RNA_float_set_array(&itemptr, "location", location);
186         RNA_float_set_array(&itemptr, "mouse", mouse_out);
187         RNA_boolean_set(&itemptr, "pen_flip", pen_flip);
188         RNA_float_set(&itemptr, "pressure", pressure);
189
190         copy_v2_v2(stroke->last_mouse_position, mouse_out);
191
192         stroke->update_step(C, stroke, &itemptr);
193 }
194
195 /* Returns zero if no sculpt changes should be made, non-zero otherwise */
196 static int paint_smooth_stroke(PaintStroke *stroke, float output[2],
197                                const PaintSample *sample)
198 {
199         output[0] = sample->mouse[0];
200         output[1] = sample->mouse[1];
201
202         if ((stroke->brush->flag & BRUSH_SMOOTH_STROKE) &&  
203             !ELEM4(stroke->brush->sculpt_tool,
204                    SCULPT_TOOL_GRAB,
205                    SCULPT_TOOL_THUMB,
206                    SCULPT_TOOL_ROTATE,
207                    SCULPT_TOOL_SNAKE_HOOK) &&
208             !(stroke->brush->flag & BRUSH_ANCHORED) &&
209             !(stroke->brush->flag & BRUSH_RESTORE_MESH))
210         {
211                 float u = stroke->brush->smooth_stroke_factor, v = 1.0f - u;
212                 float dx = stroke->last_mouse_position[0] - sample->mouse[0];
213                 float dy = stroke->last_mouse_position[1] - sample->mouse[1];
214
215                 /* If the mouse is moving within the radius of the last move,
216                  * don't update the mouse position. This allows sharp turns. */
217                 if (dx * dx + dy * dy < stroke->brush->smooth_stroke_radius * stroke->brush->smooth_stroke_radius)
218                         return 0;
219
220                 output[0] = sample->mouse[0] * v + stroke->last_mouse_position[0] * u;
221                 output[1] = sample->mouse[1] * v + stroke->last_mouse_position[1] * u;
222         }
223
224         return 1;
225 }
226
227 /* For brushes with stroke spacing enabled, moves mouse in steps
228  * towards the final mouse location. */
229 static int paint_space_stroke(bContext *C, wmOperator *op, wmEvent *event, const float final_mouse[2])
230 {
231         PaintStroke *stroke = op->customdata;
232         int cnt = 0;
233
234         if (paint_space_stroke_enabled(stroke->brush)) {
235                 float mouse[2];
236                 float vec[2];
237                 float length, scale;
238
239                 copy_v2_v2(mouse, stroke->last_mouse_position);
240                 sub_v2_v2v2(vec, final_mouse, mouse);
241
242                 length = len_v2(vec);
243
244                 if (length > FLT_EPSILON) {
245                         const Scene *scene = CTX_data_scene(C);
246                         int steps;
247                         int i;
248                         float size_pressure = 1.0f;
249                         float pressure = event_tablet_data(event, NULL);
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                                 size_pressure = pressure;
254                         
255                         if (size_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 = max_ff(1.0f, BKE_brush_size_get(scene, stroke->brush) * size_pressure);
259                                 float spacing = stroke->brush->spacing;
260
261                                 if (stroke->brush->flag & BRUSH_SPACING_PRESSURE)
262                                         spacing = max_ff(1.0f, spacing * (1.5f - pressure));
263
264                                 scale = (size_clamp * spacing / 50.0f) / length;
265                                 if (scale > FLT_EPSILON) {
266                                         mul_v2_fl(vec, scale);
267
268                                         steps = (int)(1.0f / scale);
269
270                                         for (i = 0; i < steps; ++i, ++cnt) {
271                                                 add_v2_v2(mouse, vec);
272                                                 paint_brush_stroke_add_step(C, op, event, mouse);
273                                         }
274                                 }
275                         }
276                 }
277         }
278
279         return cnt;
280 }
281
282 /**** Public API ****/
283
284 PaintStroke *paint_stroke_new(bContext *C,
285                               StrokeGetLocation get_location,
286                               StrokeTestStart test_start,
287                               StrokeUpdateStep update_step,
288                               StrokeDone done, int event_type)
289 {
290         PaintStroke *stroke = MEM_callocN(sizeof(PaintStroke), "PaintStroke");
291
292         stroke->brush = paint_brush(paint_get_active_from_context(C));
293         view3d_set_viewcontext(C, &stroke->vc);
294         if (stroke->vc.v3d)
295                 view3d_get_transformation(stroke->vc.ar, stroke->vc.rv3d, stroke->vc.obact, &stroke->mats);
296
297         stroke->get_location = get_location;
298         stroke->test_start = test_start;
299         stroke->update_step = update_step;
300         stroke->done = done;
301         stroke->event_type = event_type; /* for modal, return event */
302         
303         return stroke;
304 }
305
306 void paint_stroke_data_free(struct wmOperator *op)
307 {
308         MEM_freeN(op->customdata);
309         op->customdata = NULL;
310 }
311
312 static void stroke_done(struct bContext *C, struct wmOperator *op)
313 {
314         struct PaintStroke *stroke = op->customdata;
315
316         if (stroke->stroke_started && stroke->done)
317                 stroke->done(C, stroke);
318
319         if (stroke->timer) {
320                 WM_event_remove_timer(
321                         CTX_wm_manager(C),
322                         CTX_wm_window(C),
323                         stroke->timer);
324         }
325
326         if (stroke->smooth_stroke_cursor)
327                 WM_paint_cursor_end(CTX_wm_manager(C), stroke->smooth_stroke_cursor);
328
329         paint_stroke_data_free(op);
330 }
331
332 /* Returns zero if the stroke dots should not be spaced, non-zero otherwise */
333 bool paint_space_stroke_enabled(Brush *br)
334 {
335         return (br->flag & BRUSH_SPACE) && paint_supports_dynamic_size(br);
336 }
337
338 /* return true if the brush size can change during paint (normally used for pressure) */
339 bool paint_supports_dynamic_size(Brush *br)
340 {
341         return !(br->flag & BRUSH_ANCHORED) &&
342                !ELEM4(br->sculpt_tool, SCULPT_TOOL_GRAB, SCULPT_TOOL_THUMB, SCULPT_TOOL_ROTATE, SCULPT_TOOL_SNAKE_HOOK);
343 }
344
345 bool paint_supports_jitter(PaintMode mode)
346 {
347         return ELEM(mode, PAINT_SCULPT, PAINT_TEXTURE_PROJECTIVE);
348 }
349
350 #define PAINT_STROKE_MODAL_CANCEL 1
351
352 /* called in paint_ops.c, on each regeneration of keymaps  */
353 struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf)
354 {
355         static struct EnumPropertyItem modal_items[] = {
356                 {PAINT_STROKE_MODAL_CANCEL, "CANCEL", 0,
357                 "Cancel",
358                 "Cancel and undo a stroke in progress"},
359
360                 { 0 }
361         };
362
363         static const char *name = "Paint Stroke Modal";
364
365         struct wmKeyMap *keymap = WM_modalkeymap_get(keyconf, name);
366
367         /* this function is called for each spacetype, only needs to add map once */
368         if (!keymap) {
369                 keymap = WM_modalkeymap_add(keyconf, name, modal_items);
370
371                 /* items for modal map */
372                 WM_modalkeymap_add_item(
373                         keymap, ESCKEY, KM_PRESS, KM_ANY, 0, PAINT_STROKE_MODAL_CANCEL);
374         }
375
376         return keymap;
377 }
378
379 static void paint_stroke_add_sample(const Paint *paint,
380                                     PaintStroke *stroke,
381                                     float x, float y)
382 {
383         PaintSample *sample = &stroke->samples[stroke->cur_sample];
384         int max_samples = MIN2(PAINT_MAX_INPUT_SAMPLES,
385                                MAX2(paint->num_input_samples, 1));
386
387         sample->mouse[0] = x;
388         sample->mouse[1] = y;
389
390         stroke->cur_sample++;
391         if (stroke->cur_sample >= max_samples)
392                 stroke->cur_sample = 0;
393         if (stroke->num_samples < max_samples)
394                 stroke->num_samples++;
395 }
396
397 static void paint_stroke_sample_average(const PaintStroke *stroke,
398                                         PaintSample *average)
399 {
400         int i;
401         
402         memset(average, 0, sizeof(*average));
403
404         BLI_assert(stroke->num_samples > 0);
405         
406         for (i = 0; i < stroke->num_samples; i++)
407                 add_v2_v2(average->mouse, stroke->samples[i].mouse);
408
409         mul_v2_fl(average->mouse, 1.0f / stroke->num_samples);
410
411         /*printf("avg=(%f, %f), num=%d\n", average->mouse[0], average->mouse[1], stroke->num_samples);*/
412 }
413
414 int paint_stroke_modal(bContext *C, wmOperator *op, wmEvent *event)
415 {
416         Paint *p = paint_get_active_from_context(C);
417         PaintStroke *stroke = op->customdata;
418         PaintSample sample_average;
419         float mouse[2];
420         int first = 0;
421
422         paint_stroke_add_sample(p, stroke, event->mval[0], event->mval[1]);
423         paint_stroke_sample_average(stroke, &sample_average);
424
425         /* let NDOF motion pass through to the 3D view so we can paint and rotate simultaneously!
426          * this isn't perfect... even when an extra MOUSEMOVE is spoofed, the stroke discards it
427          * since the 2D deltas are zero -- code in this file needs to be updated to use the
428          * post-NDOF_MOTION MOUSEMOVE */
429         if (event->type == NDOF_MOTION)
430                 return OPERATOR_PASS_THROUGH;
431
432         if (!stroke->stroke_started) {
433                 copy_v2_v2(stroke->last_mouse_position, sample_average.mouse);
434                 stroke->stroke_started = stroke->test_start(C, op, sample_average.mouse);
435                 BLI_assert((stroke->stroke_started & ~1) == 0);  /* 0/1 */
436
437                 if (stroke->stroke_started) {
438                         stroke->smooth_stroke_cursor =
439                             WM_paint_cursor_activate(CTX_wm_manager(C), paint_poll, paint_draw_smooth_stroke, stroke);
440
441                         if (stroke->brush->flag & BRUSH_AIRBRUSH)
442                                 stroke->timer = WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, stroke->brush->rate);
443                 }
444
445                 first = 1;
446                 //ED_region_tag_redraw(ar);
447         }
448
449         /* Cancel */
450         if (event->type == EVT_MODAL_MAP && event->val == PAINT_STROKE_MODAL_CANCEL) {
451                 if (op->type->cancel)
452                         return op->type->cancel(C, op);
453                 else
454                         return paint_stroke_cancel(C, op);
455         }
456
457         if (event->type == stroke->event_type && event->val == KM_RELEASE) {
458                 stroke_done(C, op);
459                 return OPERATOR_FINISHED;
460         }
461         else if ((first) ||
462                  (ELEM(event->type, MOUSEMOVE, INBETWEEN_MOUSEMOVE)) ||
463                  (event->type == TIMER && (event->customdata == stroke->timer)) )
464         {
465                 if (stroke->stroke_started) {
466                         if (paint_smooth_stroke(stroke, mouse, &sample_average)) {
467                                 if (paint_space_stroke_enabled(stroke->brush)) {
468                                         if (!paint_space_stroke(C, op, event, mouse)) {
469                                                 //ED_region_tag_redraw(ar);
470                                         }
471                                 }
472                                 else {
473                                         paint_brush_stroke_add_step(C, op, event, mouse);
474                                 }
475                         }
476                         else {
477                                 ; //ED_region_tag_redraw(ar);
478                         }
479                 }
480         }
481
482         /* we want the stroke to have the first daub at the start location
483          * instead of waiting till we have moved the space distance */
484         if (first &&
485             stroke->stroke_started &&
486             paint_space_stroke_enabled(stroke->brush) &&
487             !(stroke->brush->flag & BRUSH_ANCHORED) &&
488             !(stroke->brush->flag & BRUSH_SMOOTH_STROKE))
489         {
490                 paint_brush_stroke_add_step(C, op, event, mouse);
491         }
492         
493         return OPERATOR_RUNNING_MODAL;
494 }
495
496 int paint_stroke_exec(bContext *C, wmOperator *op)
497 {
498         PaintStroke *stroke = op->customdata;
499
500         /* only when executed for the first time */
501         if (stroke->stroke_started == 0) {
502                 /* XXX stroke->last_mouse_position is unset, this may cause problems */
503                 stroke->test_start(C, op, NULL);
504                 stroke->stroke_started = 1;
505         }
506
507         RNA_BEGIN (op->ptr, itemptr, "stroke")
508         {
509                 stroke->update_step(C, stroke, &itemptr);
510         }
511         RNA_END;
512
513         stroke_done(C, op);
514
515         return OPERATOR_FINISHED;
516 }
517
518 int paint_stroke_cancel(bContext *C, wmOperator *op)
519 {
520         stroke_done(C, op);
521         return OPERATOR_CANCELLED;
522 }
523
524 ViewContext *paint_stroke_view_context(PaintStroke *stroke)
525 {
526         return &stroke->vc;
527 }
528
529 void *paint_stroke_mode_data(struct PaintStroke *stroke)
530 {
531         return stroke->mode_data;
532 }
533
534 void paint_stroke_set_mode_data(PaintStroke *stroke, void *mode_data)
535 {
536         stroke->mode_data = mode_data;
537 }
538
539 int paint_poll(bContext *C)
540 {
541         Paint *p = paint_get_active_from_context(C);
542         Object *ob = CTX_data_active_object(C);
543         ScrArea *sa = CTX_wm_area(C);
544         ARegion *ar = CTX_wm_region(C);
545
546         return p && ob && paint_brush(p) &&
547                (sa && sa->spacetype == SPACE_VIEW3D) &&
548                (ar && ar->regiontype == RGN_TYPE_WINDOW);
549 }