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