14bb955cf84bcea00c3e56ba85cce99d8c1fced2
[blender.git] / source / blender / editors / gpencil / gpencil_paint.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  * This is a new part of Blender
18  */
19
20 /** \file
21  * \ingroup edgpencil
22  */
23
24 #include <stdio.h>
25 #include <stddef.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <math.h>
29
30 #include "MEM_guardedalloc.h"
31
32 #include "BLI_blenlib.h"
33 #include "BLI_math.h"
34 #include "BLI_utildefines.h"
35 #include "BLI_rand.h"
36 #include "BLI_math_geom.h"
37
38 #include "BLT_translation.h"
39
40 #include "PIL_time.h"
41
42 #include "DNA_meshdata_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_gpencil_types.h"
46 #include "DNA_material_types.h"
47 #include "DNA_brush_types.h"
48 #include "DNA_windowmanager_types.h"
49
50 #include "BKE_colortools.h"
51 #include "BKE_main.h"
52 #include "BKE_brush.h"
53 #include "BKE_paint.h"
54 #include "BKE_context.h"
55 #include "BKE_deform.h"
56 #include "BKE_global.h"
57 #include "BKE_gpencil.h"
58 #include "BKE_report.h"
59 #include "BKE_layer.h"
60 #include "BKE_material.h"
61 #include "BKE_screen.h"
62 #include "BKE_tracking.h"
63
64 #include "UI_view2d.h"
65
66 #include "ED_gpencil.h"
67 #include "ED_screen.h"
68 #include "ED_object.h"
69 #include "ED_view3d.h"
70 #include "ED_clip.h"
71
72 #include "GPU_immediate.h"
73 #include "GPU_immediate_util.h"
74 #include "GPU_state.h"
75
76 #include "RNA_access.h"
77 #include "RNA_define.h"
78
79 #include "WM_api.h"
80 #include "WM_types.h"
81
82 #include "DEG_depsgraph.h"
83 #include "DEG_depsgraph_query.h"
84
85 #include "gpencil_intern.h"
86
87 /* ******************************************* */
88 /* 'Globals' and Defines */
89
90 /* values for tGPsdata->status */
91 typedef enum eGPencil_PaintStatus {
92   GP_STATUS_IDLING = 0, /* stroke isn't in progress yet */
93   GP_STATUS_PAINTING,   /* a stroke is in progress */
94   GP_STATUS_ERROR,      /* something wasn't correctly set up */
95   GP_STATUS_DONE,       /* painting done */
96 } eGPencil_PaintStatus;
97
98 /* Return flags for adding points to stroke buffer */
99 typedef enum eGP_StrokeAdd_Result {
100   GP_STROKEADD_INVALID = -2,  /* error occurred - insufficient info to do so */
101   GP_STROKEADD_OVERFLOW = -1, /* error occurred - cannot fit any more points */
102   GP_STROKEADD_NORMAL,        /* point was successfully added */
103   GP_STROKEADD_FULL,          /* cannot add any more points to buffer */
104 } eGP_StrokeAdd_Result;
105
106 /* Runtime flags */
107 typedef enum eGPencil_PaintFlags {
108   GP_PAINTFLAG_FIRSTRUN = (1 << 0), /* operator just started */
109   GP_PAINTFLAG_STROKEADDED = (1 << 1),
110   GP_PAINTFLAG_SELECTMASK = (1 << 3),
111   GP_PAINTFLAG_HARD_ERASER = (1 << 4),
112   GP_PAINTFLAG_STROKE_ERASER = (1 << 5),
113   GP_PAINTFLAG_REQ_VECTOR = (1 << 6),
114 } eGPencil_PaintFlags;
115
116 /* Temporary 'Stroke' Operation data
117  *   "p" = op->customdata
118  */
119 typedef struct tGPsdata {
120   bContext *C;
121
122   /** main database pointer. */
123   Main *bmain;
124   /** current scene from context. */
125   Scene *scene;
126   struct Depsgraph *depsgraph;
127
128   /** current object. */
129   Object *ob;
130   /** window where painting originated. */
131   wmWindow *win;
132   /** area where painting originated. */
133   ScrArea *sa;
134   /** region where painting originated. */
135   ARegion *ar;
136   /** needed for GP_STROKE_2DSPACE. */
137   View2D *v2d;
138   /** for using the camera rect within the 3d view. */
139   rctf *subrect;
140   rctf subrect_data;
141
142   /** settings to pass to gp_points_to_xy(). */
143   GP_SpaceConversion gsc;
144
145   /** pointer to owner of gp-datablock. */
146   PointerRNA ownerPtr;
147   /** gp-datablock layer comes from. */
148   bGPdata *gpd;
149   /** layer we're working on. */
150   bGPDlayer *gpl;
151   /** frame we're working on. */
152   bGPDframe *gpf;
153
154   /** projection-mode flags (toolsettings - eGPencil_Placement_Flags) */
155   char *align_flag;
156
157   /** current status of painting. */
158   eGPencil_PaintStatus status;
159   /** mode for painting. */
160   eGPencil_PaintModes paintmode;
161   /** flags that can get set during runtime (eGPencil_PaintFlags) */
162   eGPencil_PaintFlags flags;
163
164   /** radius of influence for eraser. */
165   short radius;
166
167   /** current mouse-position. */
168   float mval[2];
169   /** previous recorded mouse-position. */
170   float mvalo[2];
171   /** initial recorded mouse-position */
172   float mvali[2];
173
174   /** current stylus pressure. */
175   float pressure;
176   /** previous stylus pressure. */
177   float opressure;
178
179   /* These need to be doubles, as (at least under unix) they are in seconds since epoch,
180    * float (and its 7 digits precision) is definitively not enough here!
181    * double, with its 15 digits precision,
182    * ensures us millisecond precision for a few centuries at least.
183    */
184   /** Used when converting to path. */
185   double inittime;
186   /** Used when converting to path. */
187   double curtime;
188   /** Used when converting to path. */
189   double ocurtime;
190
191   /** Inverted transformation matrix applying when converting coords from screen-space
192    * to region space. */
193   float imat[4][4];
194   float mat[4][4];
195
196   /** custom color - hack for enforcing a particular color for track/mask editing. */
197   float custom_color[4];
198
199   /** radial cursor data for drawing eraser. */
200   void *erasercursor;
201
202   /* mat settings are only used for 3D view */
203   /** current material */
204   Material *material;
205   /** current drawing brush */
206   Brush *brush;
207   /** default eraser brush */
208   Brush *eraser;
209
210   /** 1: line horizontal, 2: line vertical, other: not defined */
211   short straight;
212   /** lock drawing to one axis */
213   int lock_axis;
214   /** the stroke is no fill mode */
215   bool disable_fill;
216
217   RNG *rng;
218
219   /** key used for invoking the operator */
220   short keymodifier;
221   /** shift modifier flag */
222   short shift;
223   /** size in pixels for uv calculation */
224   float totpixlen;
225
226   /* guide */
227   /** guide spacing */
228   float guide_spacing;
229   /** half guide spacing */
230   float half_spacing;
231   /** origin */
232   float origin[2];
233
234   ReportList *reports;
235 } tGPsdata;
236
237 /* ------ */
238
239 #define STROKE_HORIZONTAL 1
240 #define STROKE_VERTICAL 2
241
242 /* Macros for accessing sensitivity thresholds... */
243 /* minimum number of pixels mouse should move before new point created */
244 #define MIN_MANHATTEN_PX (U.gp_manhattendist)
245 /* minimum length of new segment before new point can be added */
246 #define MIN_EUCLIDEAN_PX (U.gp_euclideandist)
247
248 static void gp_update_cache(bGPdata *gpd)
249 {
250   if (gpd) {
251     DEG_id_tag_update(&gpd->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY);
252     gpd->flag |= GP_DATA_CACHE_IS_DIRTY;
253   }
254 }
255
256 static bool gp_stroke_added_check(tGPsdata *p)
257 {
258   return (p->gpf && p->gpf->strokes.last && p->flags & GP_PAINTFLAG_STROKEADDED);
259 }
260
261 static void gp_stroke_added_enable(tGPsdata *p)
262 {
263   BLI_assert(p->gpf->strokes.last != NULL);
264   p->flags |= GP_PAINTFLAG_STROKEADDED;
265
266   /* drawing batch cache is dirty now */
267   gp_update_cache(p->gpd);
268 }
269
270 /* ------ */
271 /* Forward defines for some functions... */
272
273 static void gp_session_validatebuffer(tGPsdata *p);
274
275 /* ******************************************* */
276 /* Context Wrangling... */
277
278 /* check if context is suitable for drawing */
279 static bool gpencil_draw_poll(bContext *C)
280 {
281   if (ED_operator_regionactive(C)) {
282     ScrArea *sa = CTX_wm_area(C);
283     /* 3D Viewport */
284     if (sa->spacetype != SPACE_VIEW3D) {
285       return false;
286     }
287
288     /* check if Grease Pencil isn't already running */
289     if (ED_gpencil_session_active() != 0) {
290       CTX_wm_operator_poll_msg_set(C, "Grease Pencil operator is already active");
291       return false;
292     }
293
294     /* only grease pencil object type */
295     Object *ob = CTX_data_active_object(C);
296     if ((ob == NULL) || (ob->type != OB_GPENCIL)) {
297       return false;
298     }
299
300     bGPdata *gpd = (bGPdata *)ob->data;
301     if (!GPENCIL_PAINT_MODE(gpd)) {
302       return false;
303     }
304
305     ToolSettings *ts = CTX_data_scene(C)->toolsettings;
306     if (!ts->gp_paint->paint.brush) {
307       CTX_wm_operator_poll_msg_set(C, "Grease Pencil has no active paint tool");
308       return false;
309     }
310
311     return true;
312   }
313   else {
314     CTX_wm_operator_poll_msg_set(C, "Active region not set");
315     return false;
316   }
317 }
318
319 /* check if projecting strokes into 3d-geometry in the 3D-View */
320 static bool gpencil_project_check(tGPsdata *p)
321 {
322   bGPdata *gpd = p->gpd;
323   return ((gpd->runtime.sbuffer_sflag & GP_STROKE_3DSPACE) &&
324           (*p->align_flag & (GP_PROJECT_DEPTH_VIEW | GP_PROJECT_DEPTH_STROKE)));
325 }
326
327 /* ******************************************* */
328 /* Calculations/Conversions */
329
330 /* Utilities --------------------------------- */
331
332 /* get the reference point for stroke-point conversions */
333 static void gp_get_3d_reference(tGPsdata *p, float vec[3])
334 {
335   Object *ob = NULL;
336   if (p->ownerPtr.type == &RNA_Object) {
337     ob = (Object *)p->ownerPtr.data;
338   }
339   ED_gp_get_drawing_reference(p->scene, ob, p->gpl, *p->align_flag, vec);
340 }
341
342 /* Stroke Editing ---------------------------- */
343 /* check if the current mouse position is suitable for adding a new point */
344 static bool gp_stroke_filtermval(tGPsdata *p, const float mval[2], float mvalo[2])
345 {
346   Brush *brush = p->brush;
347   int dx = (int)fabsf(mval[0] - mvalo[0]);
348   int dy = (int)fabsf(mval[1] - mvalo[1]);
349   brush->gpencil_settings->flag &= ~GP_BRUSH_STABILIZE_MOUSE_TEMP;
350
351   /* if buffer is empty, just let this go through (i.e. so that dots will work) */
352   if (p->gpd->runtime.sbuffer_size == 0) {
353     return true;
354   }
355   /* if lazy mouse, check minimum distance */
356   else if (GPENCIL_LAZY_MODE(brush, p->shift)) {
357     brush->gpencil_settings->flag |= GP_BRUSH_STABILIZE_MOUSE_TEMP;
358     if ((dx * dx + dy * dy) > (brush->smooth_stroke_radius * brush->smooth_stroke_radius)) {
359       return true;
360     }
361     else {
362       /* If the mouse is moving within the radius of the last move,
363        * don't update the mouse position. This allows sharp turns. */
364       copy_v2_v2(p->mval, p->mvalo);
365       return false;
366     }
367   }
368   /* check if mouse moved at least certain distance on both axes (best case)
369    * - aims to eliminate some jitter-noise from input when trying to draw straight lines freehand
370    */
371   else if ((dx > MIN_MANHATTEN_PX) && (dy > MIN_MANHATTEN_PX)) {
372     return true;
373
374     /* Check if the distance since the last point is significant enough:
375      * - Prevents points being added too densely
376      * - Distance here doesn't use sqrt to prevent slowness.
377      *   We should still be safe from overflows though.
378      */
379   }
380   else if ((dx * dx + dy * dy) > MIN_EUCLIDEAN_PX * MIN_EUCLIDEAN_PX) {
381     return true;
382
383     /* mouse 'didn't move' */
384   }
385   else {
386     return false;
387   }
388 }
389
390 /* reproject stroke to plane locked to axis in 3d cursor location */
391 static void gp_reproject_toplane(tGPsdata *p, bGPDstroke *gps)
392 {
393   bGPdata *gpd = p->gpd;
394   Object *obact = (Object *)p->ownerPtr.data;
395
396   float origin[3];
397   RegionView3D *rv3d = p->ar->regiondata;
398
399   /* verify the stroke mode is CURSOR 3d space mode */
400   if ((gpd->runtime.sbuffer_sflag & GP_STROKE_3DSPACE) == 0) {
401     return;
402   }
403   if ((*p->align_flag & GP_PROJECT_VIEWSPACE) == 0) {
404     return;
405   }
406   if ((*p->align_flag & GP_PROJECT_DEPTH_VIEW) || (*p->align_flag & GP_PROJECT_DEPTH_STROKE)) {
407     return;
408   }
409
410   /* get drawing origin */
411   gp_get_3d_reference(p, origin);
412   ED_gp_project_stroke_to_plane(p->scene, obact, rv3d, gps, origin, p->lock_axis - 1);
413 }
414
415 /* convert screen-coordinates to buffer-coordinates */
416 /* XXX this method needs a total overhaul! */
417 static void gp_stroke_convertcoords(tGPsdata *p, const float mval[2], float out[3], float *depth)
418 {
419   bGPdata *gpd = p->gpd;
420
421   /* in 3d-space - pt->x/y/z are 3 side-by-side floats */
422   if (gpd->runtime.sbuffer_sflag & GP_STROKE_3DSPACE) {
423
424     /* add small offset to keep stroke over the surface */
425     if ((depth) && (gpd->zdepth_offset > 0.0f) && (*p->align_flag & GP_PROJECT_DEPTH_VIEW)) {
426       *depth *= (1.0f - gpd->zdepth_offset);
427     }
428
429     int mval_i[2];
430     round_v2i_v2fl(mval_i, mval);
431
432     if (gpencil_project_check(p) && (ED_view3d_autodist_simple(p->ar, mval_i, out, 0, depth))) {
433       /* projecting onto 3D-Geometry
434        * - nothing more needs to be done here, since view_autodist_simple() has already done it
435        */
436
437       /* verify valid zdepth, if it's wrong, the default drawing mode is used
438        * and the function doesn't return now */
439       if ((depth == NULL) || (*depth <= 1.0f)) {
440         return;
441       }
442     }
443
444     float mval_prj[2];
445     float rvec[3], dvec[3];
446     float mval_f[2];
447     float zfac;
448
449     /* Current method just converts each point in screen-coordinates to
450      * 3D-coordinates using the 3D-cursor as reference. In general, this
451      * works OK, but it could of course be improved. */
452
453     gp_get_3d_reference(p, rvec);
454     zfac = ED_view3d_calc_zfac(p->ar->regiondata, rvec, NULL);
455
456     if (ED_view3d_project_float_global(p->ar, rvec, mval_prj, V3D_PROJ_TEST_NOP) ==
457         V3D_PROJ_RET_OK) {
458       sub_v2_v2v2(mval_f, mval_prj, mval);
459       ED_view3d_win_to_delta(p->ar, mval_f, dvec, zfac);
460       sub_v3_v3v3(out, rvec, dvec);
461     }
462     else {
463       zero_v3(out);
464     }
465   }
466 }
467
468 /* apply jitter to stroke */
469 static void gp_brush_jitter(bGPdata *gpd,
470                             Brush *brush,
471                             tGPspoint *pt,
472                             const float mval[2],
473                             const float pressure,
474                             float r_mval[2],
475                             RNG *rng)
476 {
477   float tmp_pressure = pressure;
478   if (brush->gpencil_settings->draw_jitter > 0.0f) {
479     float curvef = curvemapping_evaluateF(brush->gpencil_settings->curve_jitter, 0, pressure);
480     tmp_pressure = curvef * brush->gpencil_settings->draw_sensitivity;
481   }
482   /* exponential value */
483   const float exfactor = (brush->gpencil_settings->draw_jitter + 2.0f) *
484                          (brush->gpencil_settings->draw_jitter + 2.0f);
485   const float fac = BLI_rng_get_float(rng) * exfactor * tmp_pressure;
486   /* Jitter is applied perpendicular to the mouse movement vector (2D space) */
487   float mvec[2], svec[2];
488   /* mouse movement in ints -> floats */
489   if (gpd->runtime.sbuffer_size > 1) {
490     mvec[0] = (mval[0] - (pt - 1)->x);
491     mvec[1] = (mval[1] - (pt - 1)->y);
492     normalize_v2(mvec);
493   }
494   else {
495     mvec[0] = 0.0f;
496     mvec[1] = 0.0f;
497   }
498   /* rotate mvec by 90 degrees... */
499   svec[0] = -mvec[1];
500   svec[1] = mvec[0];
501   /* scale the displacement by the random, and apply */
502   if (BLI_rng_get_float(rng) > 0.5f) {
503     mul_v2_fl(svec, -fac);
504   }
505   else {
506     mul_v2_fl(svec, fac);
507   }
508
509   r_mval[0] = mval[0] + svec[0];
510   r_mval[1] = mval[1] + svec[1];
511 }
512
513 /* apply pressure change depending of the angle of the stroke to simulate a pen with shape */
514 static void gp_brush_angle(bGPdata *gpd, Brush *brush, tGPspoint *pt, const float mval[2])
515 {
516   float mvec[2];
517   float sen = brush->gpencil_settings->draw_angle_factor; /* sensitivity */
518   float fac;
519   float mpressure;
520
521   /* default angle of brush in radians */
522   float angle = brush->gpencil_settings->draw_angle;
523   /* angle vector of the brush with full thickness */
524   float v0[2] = {cos(angle), sin(angle)};
525
526   /* Apply to first point (only if there are 2 points because before no data to do it ) */
527   if (gpd->runtime.sbuffer_size == 1) {
528     mvec[0] = (mval[0] - (pt - 1)->x);
529     mvec[1] = (mval[1] - (pt - 1)->y);
530     normalize_v2(mvec);
531
532     /* uses > 1.0f to get a smooth transition in first point */
533     fac = 1.4f - fabs(dot_v2v2(v0, mvec)); /* 0.0 to 1.0 */
534     (pt - 1)->pressure = (pt - 1)->pressure - (sen * fac);
535
536     CLAMP((pt - 1)->pressure, GPENCIL_ALPHA_OPACITY_THRESH, 1.0f);
537   }
538
539   /* apply from second point */
540   if (gpd->runtime.sbuffer_size >= 1) {
541     mvec[0] = (mval[0] - (pt - 1)->x);
542     mvec[1] = (mval[1] - (pt - 1)->y);
543     normalize_v2(mvec);
544
545     fac = 1.0f - fabs(dot_v2v2(v0, mvec)); /* 0.0 to 1.0 */
546     /* interpolate with previous point for smoother transitions */
547     mpressure = interpf(pt->pressure - (sen * fac), (pt - 1)->pressure, 0.3f);
548     pt->pressure = mpressure;
549
550     CLAMP(pt->pressure, GPENCIL_ALPHA_OPACITY_THRESH, 1.0f);
551   }
552 }
553
554 /* Apply smooth to buffer while drawing
555  * to smooth point C, use 2 before (A, B) and current point (D):
556  *
557  *   A----B-----C------D
558  *
559  * \param p: Temp data
560  * \param inf: Influence factor
561  * \param idx: Index of the last point (need minimum 3 points in the array)
562  */
563 static void gp_smooth_buffer(tGPsdata *p, float inf, int idx)
564 {
565   bGPdata *gpd = p->gpd;
566   short num_points = gpd->runtime.sbuffer_size;
567
568   /* Do nothing if not enough points to smooth out */
569   if ((num_points < 3) || (idx < 3) || (inf == 0.0f)) {
570     return;
571   }
572
573   tGPspoint *points = (tGPspoint *)gpd->runtime.sbuffer;
574   float steps = 4.0f;
575   if (idx < 4) {
576     steps--;
577   }
578
579   tGPspoint *pta = idx >= 4 ? &points[idx - 4] : NULL;
580   tGPspoint *ptb = idx >= 3 ? &points[idx - 3] : NULL;
581   tGPspoint *ptc = idx >= 2 ? &points[idx - 2] : NULL;
582   tGPspoint *ptd = &points[idx - 1];
583
584   float sco[2] = {0.0f};
585   float a[2], b[2], c[2], d[2];
586   const float average_fac = 1.0f / steps;
587
588   /* Compute smoothed coordinate by taking the ones nearby */
589   if (pta) {
590     copy_v2_v2(a, &pta->x);
591     madd_v2_v2fl(sco, a, average_fac);
592   }
593   if (ptb) {
594     copy_v2_v2(b, &ptb->x);
595     madd_v2_v2fl(sco, b, average_fac);
596   }
597   if (ptc) {
598     copy_v2_v2(c, &ptc->x);
599     madd_v2_v2fl(sco, c, average_fac);
600   }
601   if (ptd) {
602     copy_v2_v2(d, &ptd->x);
603     madd_v2_v2fl(sco, d, average_fac);
604   }
605
606   /* Based on influence factor, blend between original and optimal smoothed coordinate */
607   interp_v2_v2v2(c, c, sco, inf);
608   copy_v2_v2(&ptc->x, c);
609 }
610
611 /* add current stroke-point to buffer (returns whether point was successfully added) */
612 static short gp_stroke_addpoint(tGPsdata *p, const float mval[2], float pressure, double curtime)
613 {
614   bGPdata *gpd = p->gpd;
615   Brush *brush = p->brush;
616   tGPspoint *pt;
617   ToolSettings *ts = p->scene->toolsettings;
618   Object *obact = (Object *)p->ownerPtr.data;
619   Depsgraph *depsgraph = p->depsgraph;
620   RegionView3D *rv3d = p->ar->regiondata;
621   View3D *v3d = p->sa->spacedata.first;
622   MaterialGPencilStyle *gp_style = p->material->gp_style;
623   const int def_nr = obact->actdef - 1;
624   const bool have_weight = (bool)BLI_findlink(&obact->defbase, def_nr);
625
626   /* check painting mode */
627   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
628     /* straight lines only - i.e. only store start and end point in buffer */
629     if (gpd->runtime.sbuffer_size == 0) {
630       /* first point in buffer (start point) */
631       pt = (tGPspoint *)(gpd->runtime.sbuffer);
632
633       /* store settings */
634       copy_v2_v2(&pt->x, mval);
635       /* T44932 - Pressure vals are unreliable, so ignore for now */
636       pt->pressure = 1.0f;
637       pt->strength = 1.0f;
638       pt->time = (float)(curtime - p->inittime);
639
640       /* increment buffer size */
641       gpd->runtime.sbuffer_size++;
642     }
643     else {
644       /* just reset the endpoint to the latest value
645        * - assume that pointers for this are always valid...
646        */
647       pt = ((tGPspoint *)(gpd->runtime.sbuffer) + 1);
648
649       /* store settings */
650       copy_v2_v2(&pt->x, mval);
651       /* T44932 - Pressure vals are unreliable, so ignore for now */
652       pt->pressure = 1.0f;
653       pt->strength = 1.0f;
654       pt->time = (float)(curtime - p->inittime);
655
656       /* now the buffer has 2 points (and shouldn't be allowed to get any larger) */
657       gpd->runtime.sbuffer_size = 2;
658     }
659
660     /* can keep carrying on this way :) */
661     return GP_STROKEADD_NORMAL;
662   }
663   else if (p->paintmode == GP_PAINTMODE_DRAW) { /* normal drawing */
664     /* check if still room in buffer */
665     if (gpd->runtime.sbuffer_size >= GP_STROKE_BUFFER_MAX) {
666       return GP_STROKEADD_OVERFLOW;
667     }
668
669     /* get pointer to destination point */
670     pt = ((tGPspoint *)(gpd->runtime.sbuffer) + gpd->runtime.sbuffer_size);
671
672     /* store settings */
673     /* pressure */
674     if (brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE) {
675       float curvef = curvemapping_evaluateF(
676           brush->gpencil_settings->curve_sensitivity, 0, pressure);
677       pt->pressure = curvef * brush->gpencil_settings->draw_sensitivity;
678     }
679     else {
680       pt->pressure = 1.0f;
681     }
682
683     /* Apply jitter to position */
684     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
685         (brush->gpencil_settings->draw_jitter > 0.0f)) {
686       float r_mval[2];
687       const float jitpress = (brush->gpencil_settings->flag & GP_BRUSH_USE_JITTER_PRESSURE) ?
688                                  pressure :
689                                  1.0f;
690       gp_brush_jitter(gpd, brush, pt, mval, jitpress, r_mval, p->rng);
691       copy_v2_v2(&pt->x, r_mval);
692     }
693     else {
694       copy_v2_v2(&pt->x, mval);
695     }
696     /* apply randomness to pressure */
697     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
698         (brush->gpencil_settings->draw_random_press > 0.0f)) {
699       float curvef = curvemapping_evaluateF(
700           brush->gpencil_settings->curve_sensitivity, 0, pressure);
701       float tmp_pressure = curvef * brush->gpencil_settings->draw_sensitivity;
702       if (BLI_rng_get_float(p->rng) > 0.5f) {
703         pt->pressure -= tmp_pressure * brush->gpencil_settings->draw_random_press *
704                         BLI_rng_get_float(p->rng);
705       }
706       else {
707         pt->pressure += tmp_pressure * brush->gpencil_settings->draw_random_press *
708                         BLI_rng_get_float(p->rng);
709       }
710       CLAMP(pt->pressure, GPENCIL_STRENGTH_MIN, 1.0f);
711     }
712
713     /* apply randomness to uv texture rotation */
714     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
715         (brush->gpencil_settings->uv_random > 0.0f)) {
716       if (BLI_rng_get_float(p->rng) > 0.5f) {
717         pt->uv_rot = (BLI_rng_get_float(p->rng) * M_PI * -1) * brush->gpencil_settings->uv_random;
718       }
719       else {
720         pt->uv_rot = (BLI_rng_get_float(p->rng) * M_PI) * brush->gpencil_settings->uv_random;
721       }
722       CLAMP(pt->uv_rot, -M_PI_2, M_PI_2);
723     }
724     else {
725       pt->uv_rot = 0.0f;
726     }
727
728     /* apply angle of stroke to brush size */
729     if (brush->gpencil_settings->draw_angle_factor != 0.0f) {
730       gp_brush_angle(gpd, brush, pt, mval);
731     }
732
733     /* color strength */
734     if (brush->gpencil_settings->flag & GP_BRUSH_USE_STENGTH_PRESSURE) {
735       float curvef = curvemapping_evaluateF(brush->gpencil_settings->curve_strength, 0, pressure);
736       float tmp_pressure = curvef * brush->gpencil_settings->draw_sensitivity;
737
738       pt->strength = tmp_pressure * brush->gpencil_settings->draw_strength;
739     }
740     else {
741       pt->strength = brush->gpencil_settings->draw_strength;
742     }
743     CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
744
745     /* apply randomness to color strength */
746     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
747         (brush->gpencil_settings->draw_random_strength > 0.0f)) {
748       if (BLI_rng_get_float(p->rng) > 0.5f) {
749         pt->strength -= pt->strength * brush->gpencil_settings->draw_random_strength *
750                         BLI_rng_get_float(p->rng);
751       }
752       else {
753         pt->strength += pt->strength * brush->gpencil_settings->draw_random_strength *
754                         BLI_rng_get_float(p->rng);
755       }
756       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
757     }
758
759     /* point time */
760     pt->time = (float)(curtime - p->inittime);
761
762     /* point uv (only 3d view) */
763     if ((p->sa->spacetype == SPACE_VIEW3D) && (gpd->runtime.sbuffer_size > 0)) {
764       float pixsize = gp_style->texture_pixsize / 1000000.0f;
765       tGPspoint *ptb = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_size - 1;
766       bGPDspoint spt, spt2;
767
768       /* get origin to reproject point */
769       float origin[3];
770       gp_get_3d_reference(p, origin);
771       /* reproject current */
772       ED_gpencil_tpoint_to_point(p->ar, origin, pt, &spt);
773       ED_gp_project_point_to_plane(p->scene, obact, rv3d, origin, p->lock_axis - 1, &spt);
774
775       /* reproject previous */
776       ED_gpencil_tpoint_to_point(p->ar, origin, ptb, &spt2);
777       ED_gp_project_point_to_plane(p->scene, obact, rv3d, origin, p->lock_axis - 1, &spt2);
778       p->totpixlen += len_v3v3(&spt.x, &spt2.x) / pixsize;
779       pt->uv_fac = p->totpixlen;
780       if ((gp_style) && (gp_style->sima)) {
781         pt->uv_fac /= gp_style->sima->gen_x;
782       }
783     }
784     else {
785       p->totpixlen = 0.0f;
786       pt->uv_fac = 0.0f;
787     }
788
789     /* increment counters */
790     gpd->runtime.sbuffer_size++;
791
792     /* smooth while drawing previous points with a reduction factor for previous */
793     if (brush->gpencil_settings->active_smooth > 0.0f) {
794       for (int s = 0; s < 3; s++) {
795         gp_smooth_buffer(p,
796                          brush->gpencil_settings->active_smooth * ((3.0f - s) / 3.0f),
797                          gpd->runtime.sbuffer_size - s);
798       }
799     }
800
801     /* check if another operation can still occur */
802     if (gpd->runtime.sbuffer_size == GP_STROKE_BUFFER_MAX) {
803       return GP_STROKEADD_FULL;
804     }
805     else {
806       return GP_STROKEADD_NORMAL;
807     }
808   }
809   else if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
810
811     /* enable special flag for drawing engine */
812     gpd->flag |= GP_DATA_STROKE_POLYGON;
813
814     bGPDlayer *gpl = BKE_gpencil_layer_getactive(gpd);
815     /* get pointer to destination point */
816     pt = (tGPspoint *)(gpd->runtime.sbuffer);
817
818     /* store settings */
819     copy_v2_v2(&pt->x, mval);
820     /* T44932 - Pressure vals are unreliable, so ignore for now */
821     pt->pressure = 1.0f;
822     pt->strength = 1.0f;
823     pt->time = (float)(curtime - p->inittime);
824
825     /* if there's stroke for this poly line session add (or replace last) point
826      * to stroke. This allows to draw lines more interactively (see new segment
827      * during mouse slide, e.g.)
828      */
829     if (gp_stroke_added_check(p)) {
830       bGPDstroke *gps = p->gpf->strokes.last;
831       bGPDspoint *pts;
832       MDeformVert *dvert = NULL;
833
834       /* first time point is adding to temporary buffer -- need to allocate new point in stroke */
835       if (gpd->runtime.sbuffer_size == 0) {
836         gps->points = MEM_reallocN(gps->points, sizeof(bGPDspoint) * (gps->totpoints + 1));
837         if (gps->dvert != NULL) {
838           gps->dvert = MEM_reallocN(gps->dvert, sizeof(MDeformVert) * (gps->totpoints + 1));
839         }
840         gps->totpoints++;
841       }
842
843       pts = &gps->points[gps->totpoints - 1];
844       if (gps->dvert != NULL) {
845         dvert = &gps->dvert[gps->totpoints - 1];
846       }
847       /* special case for poly lines: normally,
848        * depth is needed only when creating new stroke from buffer,
849        * but poly lines are converting to stroke instantly,
850        * so initialize depth buffer before converting coordinates
851        */
852       if (gpencil_project_check(p)) {
853         view3d_region_operator_needs_opengl(p->win, p->ar);
854         ED_view3d_autodist_init(
855             p->depsgraph, p->ar, v3d, (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 1 : 0);
856       }
857
858       /* convert screen-coordinates to appropriate coordinates (and store them) */
859       gp_stroke_convertcoords(p, &pt->x, &pts->x, NULL);
860       /* reproject to plane (only in 3d space) */
861       gp_reproject_toplane(p, gps);
862       /* if parented change position relative to parent object */
863       gp_apply_parent_point(depsgraph, obact, gpd, gpl, pts);
864       /* copy pressure and time */
865       pts->pressure = pt->pressure;
866       pts->strength = pt->strength;
867       pts->time = pt->time;
868       pts->uv_fac = pt->uv_fac;
869       pts->uv_rot = pt->uv_rot;
870
871       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
872         BKE_gpencil_dvert_ensure(gps);
873         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
874         if (dw) {
875           dw->weight = ts->vgroup_weight;
876         }
877       }
878       else {
879         if (dvert != NULL) {
880           dvert->totweight = 0;
881           dvert->dw = NULL;
882         }
883       }
884
885       /* force fill recalc */
886       gps->flag |= GP_STROKE_RECALC_GEOMETRY;
887       /* drawing batch cache is dirty now */
888       gp_update_cache(p->gpd);
889     }
890
891     /* increment counters */
892     if (gpd->runtime.sbuffer_size == 0) {
893       gpd->runtime.sbuffer_size++;
894     }
895
896     return GP_STROKEADD_NORMAL;
897   }
898
899   /* return invalid state for now... */
900   return GP_STROKEADD_INVALID;
901 }
902
903 /* make a new stroke from the buffer data */
904 static void gp_stroke_newfrombuffer(tGPsdata *p)
905 {
906   bGPdata *gpd = p->gpd;
907   bGPDlayer *gpl = p->gpl;
908   bGPDstroke *gps;
909   bGPDspoint *pt;
910   tGPspoint *ptc;
911   MDeformVert *dvert = NULL;
912   Brush *brush = p->brush;
913   ToolSettings *ts = p->scene->toolsettings;
914   Depsgraph *depsgraph = p->depsgraph;
915   Object *obact = (Object *)p->ownerPtr.data;
916   RegionView3D *rv3d = p->ar->regiondata;
917   const int def_nr = obact->actdef - 1;
918   const bool have_weight = (bool)BLI_findlink(&obact->defbase, def_nr);
919   const char *align_flag = &ts->gpencil_v3d_align;
920   const bool is_depth = (bool)(*align_flag & (GP_PROJECT_DEPTH_VIEW | GP_PROJECT_DEPTH_STROKE));
921   const bool is_camera = (bool)(ts->gp_sculpt.lock_axis == 0) && (rv3d->persp == RV3D_CAMOB) &&
922                          (!is_depth);
923   int i, totelem;
924
925   /* Since strokes are so fine,
926    * when using their depth we need a margin otherwise they might get missed. */
927   int depth_margin = (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 4 : 0;
928
929   /* get total number of points to allocate space for
930    * - drawing straight-lines only requires the endpoints
931    */
932   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
933     totelem = (gpd->runtime.sbuffer_size >= 2) ? 2 : gpd->runtime.sbuffer_size;
934   }
935   else {
936     totelem = gpd->runtime.sbuffer_size;
937   }
938
939   /* exit with error if no valid points from this stroke */
940   if (totelem == 0) {
941     if (G.debug & G_DEBUG) {
942       printf("Error: No valid points in stroke buffer to convert (tot=%d)\n",
943              gpd->runtime.sbuffer_size);
944     }
945     return;
946   }
947
948   /* special case for poly line -- for already added stroke during session
949    * coordinates are getting added to stroke immediately to allow more
950    * interactive behavior
951    */
952   if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
953     /* be sure to hide any lazy cursor */
954     ED_gpencil_toggle_brush_cursor(p->C, true, NULL);
955
956     if (gp_stroke_added_check(p)) {
957       return;
958     }
959   }
960
961   /* allocate memory for a new stroke */
962   gps = MEM_callocN(sizeof(bGPDstroke), "gp_stroke");
963
964   /* copy appropriate settings for stroke */
965   gps->totpoints = totelem;
966   gps->thickness = brush->size;
967   gps->gradient_f = brush->gpencil_settings->gradient_f;
968   copy_v2_v2(gps->gradient_s, brush->gpencil_settings->gradient_s);
969   gps->flag = gpd->runtime.sbuffer_sflag;
970   gps->inittime = p->inittime;
971
972   /* enable recalculation flag by default (only used if hq fill) */
973   gps->flag |= GP_STROKE_RECALC_GEOMETRY;
974
975   /* allocate enough memory for a continuous array for storage points */
976   const int subdivide = brush->gpencil_settings->draw_subdivide;
977
978   gps->points = MEM_callocN(sizeof(bGPDspoint) * gps->totpoints, "gp_stroke_points");
979
980   /* initialize triangle memory to dummy data */
981   gps->triangles = MEM_callocN(sizeof(bGPDtriangle), "GP Stroke triangulation");
982   gps->flag |= GP_STROKE_RECALC_GEOMETRY;
983   gps->tot_triangles = 0;
984   /* drawing batch cache is dirty now */
985   gp_update_cache(p->gpd);
986   /* set pointer to first non-initialized point */
987   pt = gps->points + (gps->totpoints - totelem);
988   if (gps->dvert != NULL) {
989     dvert = gps->dvert + (gps->totpoints - totelem);
990   }
991
992   /* copy points from the buffer to the stroke */
993   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
994     /* straight lines only -> only endpoints */
995     {
996       /* first point */
997       ptc = gpd->runtime.sbuffer;
998
999       /* convert screen-coordinates to appropriate coordinates (and store them) */
1000       gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
1001       /* copy pressure and time */
1002       pt->pressure = ptc->pressure;
1003       pt->strength = ptc->strength;
1004       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1005       pt->time = ptc->time;
1006       pt++;
1007
1008       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1009         BKE_gpencil_dvert_ensure(gps);
1010         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1011         if (dw) {
1012           dw->weight = ts->vgroup_weight;
1013         }
1014         dvert++;
1015       }
1016       else {
1017         if (dvert != NULL) {
1018           dvert->totweight = 0;
1019           dvert->dw = NULL;
1020           dvert++;
1021         }
1022       }
1023     }
1024
1025     if (totelem == 2) {
1026       /* last point if applicable */
1027       ptc = ((tGPspoint *)gpd->runtime.sbuffer) + (gpd->runtime.sbuffer_size - 1);
1028
1029       /* convert screen-coordinates to appropriate coordinates (and store them) */
1030       gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
1031       /* copy pressure and time */
1032       pt->pressure = ptc->pressure;
1033       pt->strength = ptc->strength;
1034       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1035       pt->time = ptc->time;
1036
1037       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1038         BKE_gpencil_dvert_ensure(gps);
1039         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1040         if (dw) {
1041           dw->weight = ts->vgroup_weight;
1042         }
1043       }
1044       else {
1045         if (dvert != NULL) {
1046           dvert->totweight = 0;
1047           dvert->dw = NULL;
1048         }
1049       }
1050     }
1051
1052     /* reproject to plane (only in 3d space) */
1053     gp_reproject_toplane(p, gps);
1054     pt = gps->points;
1055     for (i = 0; i < gps->totpoints; i++, pt++) {
1056       /* if parented change position relative to parent object */
1057       gp_apply_parent_point(depsgraph, obact, gpd, gpl, pt);
1058     }
1059
1060     /* if camera view, reproject flat to view to avoid perspective effect */
1061     if (is_camera) {
1062       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1063     }
1064   }
1065   else if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
1066     /* first point */
1067     ptc = gpd->runtime.sbuffer;
1068
1069     /* convert screen-coordinates to appropriate coordinates (and store them) */
1070     gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
1071     /* reproject to plane (only in 3d space) */
1072     gp_reproject_toplane(p, gps);
1073     /* if parented change position relative to parent object */
1074     gp_apply_parent_point(depsgraph, obact, gpd, gpl, pt);
1075     /* if camera view, reproject flat to view to avoid perspective effect */
1076     if (is_camera) {
1077       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1078     }
1079     /* copy pressure and time */
1080     pt->pressure = ptc->pressure;
1081     pt->strength = ptc->strength;
1082     CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1083     pt->time = ptc->time;
1084
1085     if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1086       BKE_gpencil_dvert_ensure(gps);
1087       MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1088       if (dw) {
1089         dw->weight = ts->vgroup_weight;
1090       }
1091     }
1092     else {
1093       if (dvert != NULL) {
1094         dvert->totweight = 0;
1095         dvert->dw = NULL;
1096       }
1097     }
1098   }
1099   else {
1100     float *depth_arr = NULL;
1101
1102     /* get an array of depths, far depths are blended */
1103     if (gpencil_project_check(p)) {
1104       int mval_i[2], mval_prev[2] = {0};
1105       int interp_depth = 0;
1106       int found_depth = 0;
1107
1108       depth_arr = MEM_mallocN(sizeof(float) * gpd->runtime.sbuffer_size, "depth_points");
1109
1110       for (i = 0, ptc = gpd->runtime.sbuffer; i < gpd->runtime.sbuffer_size; i++, ptc++, pt++) {
1111
1112         round_v2i_v2fl(mval_i, &ptc->x);
1113
1114         if ((ED_view3d_autodist_depth(p->ar, mval_i, depth_margin, depth_arr + i) == 0) &&
1115             (i && (ED_view3d_autodist_depth_seg(
1116                        p->ar, mval_i, mval_prev, depth_margin + 1, depth_arr + i) == 0))) {
1117           interp_depth = true;
1118         }
1119         else {
1120           found_depth = true;
1121         }
1122
1123         copy_v2_v2_int(mval_prev, mval_i);
1124       }
1125
1126       if (found_depth == false) {
1127         /* eeh... not much we can do.. :/, ignore depth in this case, use the 3D cursor */
1128         for (i = gpd->runtime.sbuffer_size - 1; i >= 0; i--) {
1129           depth_arr[i] = 0.9999f;
1130         }
1131       }
1132       else {
1133         if ((ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_ENDPOINTS) ||
1134             (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_FIRST)) {
1135           int first_valid = 0;
1136           int last_valid = 0;
1137
1138           /* find first valid contact point */
1139           for (i = 0; i < gpd->runtime.sbuffer_size; i++) {
1140             if (depth_arr[i] != FLT_MAX) {
1141               break;
1142             }
1143           }
1144           first_valid = i;
1145
1146           /* find last valid contact point */
1147           if (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_FIRST) {
1148             last_valid = first_valid;
1149           }
1150           else {
1151             for (i = gpd->runtime.sbuffer_size - 1; i >= 0; i--) {
1152               if (depth_arr[i] != FLT_MAX) {
1153                 break;
1154               }
1155             }
1156             last_valid = i;
1157           }
1158           /* invalidate any other point, to interpolate between
1159            * first and last contact in an imaginary line between them */
1160           for (i = 0; i < gpd->runtime.sbuffer_size; i++) {
1161             if ((i != first_valid) && (i != last_valid)) {
1162               depth_arr[i] = FLT_MAX;
1163             }
1164           }
1165           interp_depth = true;
1166         }
1167
1168         if (interp_depth) {
1169           interp_sparse_array(depth_arr, gpd->runtime.sbuffer_size, FLT_MAX);
1170         }
1171       }
1172     }
1173
1174     pt = gps->points;
1175     dvert = gps->dvert;
1176
1177     /* convert all points (normal behavior) */
1178     for (i = 0, ptc = gpd->runtime.sbuffer; i < gpd->runtime.sbuffer_size && ptc;
1179          i++, ptc++, pt++) {
1180       /* convert screen-coordinates to appropriate coordinates (and store them) */
1181       gp_stroke_convertcoords(p, &ptc->x, &pt->x, depth_arr ? depth_arr + i : NULL);
1182
1183       /* copy pressure and time */
1184       pt->pressure = ptc->pressure;
1185       pt->strength = ptc->strength;
1186       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1187       pt->time = ptc->time;
1188       pt->uv_fac = ptc->uv_fac;
1189       pt->uv_rot = ptc->uv_rot;
1190
1191       if (dvert != NULL) {
1192         dvert->totweight = 0;
1193         dvert->dw = NULL;
1194         dvert++;
1195       }
1196     }
1197
1198     /* subdivide and smooth the stroke */
1199     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) && (subdivide > 0)) {
1200       gp_subdivide_stroke(gps, subdivide);
1201     }
1202     /* apply randomness to stroke */
1203     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
1204         (brush->gpencil_settings->draw_random_sub > 0.0f)) {
1205       gp_randomize_stroke(gps, brush, p->rng);
1206     }
1207
1208     /* Smooth stroke after subdiv - only if there's something to do for each iteration,
1209      * the factor is reduced to get a better smoothing
1210      * without changing too much the original stroke. */
1211     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1212         (brush->gpencil_settings->draw_smoothfac > 0.0f)) {
1213       float reduce = 0.0f;
1214       for (int r = 0; r < brush->gpencil_settings->draw_smoothlvl; r++) {
1215         for (i = 0; i < gps->totpoints - 1; i++) {
1216           BKE_gpencil_smooth_stroke(gps, i, brush->gpencil_settings->draw_smoothfac - reduce);
1217           BKE_gpencil_smooth_stroke_strength(gps, i, brush->gpencil_settings->draw_smoothfac);
1218         }
1219         reduce += 0.25f;  // reduce the factor
1220       }
1221     }
1222     /* smooth thickness */
1223     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1224         (brush->gpencil_settings->thick_smoothfac > 0.0f)) {
1225       for (int r = 0; r < brush->gpencil_settings->thick_smoothlvl * 2; r++) {
1226         for (i = 0; i < gps->totpoints - 1; i++) {
1227           BKE_gpencil_smooth_stroke_thickness(gps, i, brush->gpencil_settings->thick_smoothfac);
1228         }
1229       }
1230     }
1231
1232     /* reproject to plane (only in 3d space) */
1233     gp_reproject_toplane(p, gps);
1234     /* change position relative to parent object */
1235     gp_apply_parent(depsgraph, obact, gpd, gpl, gps);
1236     /* if camera view, reproject flat to view to avoid perspective effect */
1237     if (is_camera) {
1238       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1239     }
1240
1241     if (depth_arr) {
1242       MEM_freeN(depth_arr);
1243     }
1244   }
1245
1246   /* Save material index */
1247   gps->mat_nr = BKE_gpencil_object_material_get_index_from_brush(p->ob, p->brush);
1248
1249   /* calculate UVs along the stroke */
1250   ED_gpencil_calc_stroke_uv(obact, gps);
1251
1252   /* add stroke to frame, usually on tail of the listbase, but if on back is enabled the stroke
1253    * is added on listbase head because the drawing order is inverse and the head stroke is the
1254    * first to draw. This is very useful for artist when drawing the background.
1255    */
1256   if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
1257       (p->paintmode != GP_PAINTMODE_DRAW_POLY)) {
1258     BLI_addhead(&p->gpf->strokes, gps);
1259   }
1260   else {
1261     BLI_addtail(&p->gpf->strokes, gps);
1262   }
1263   /* add weights */
1264   if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1265     BKE_gpencil_dvert_ensure(gps);
1266     for (i = 0; i < gps->totpoints; i++) {
1267       MDeformVert *ve = &gps->dvert[i];
1268       MDeformWeight *dw = defvert_verify_index(ve, def_nr);
1269       if (dw) {
1270         dw->weight = ts->vgroup_weight;
1271       }
1272     }
1273   }
1274
1275   /* post process stroke */
1276   if ((p->brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1277       p->brush->gpencil_settings->flag & GP_BRUSH_TRIM_STROKE) {
1278     BKE_gpencil_trim_stroke(gps);
1279   }
1280
1281   gp_stroke_added_enable(p);
1282 }
1283
1284 /* --- 'Eraser' for 'Paint' Tool ------ */
1285
1286 /* which which point is infront (result should only be used for comparison) */
1287 static float view3d_point_depth(const RegionView3D *rv3d, const float co[3])
1288 {
1289   if (rv3d->is_persp) {
1290     return ED_view3d_calc_zfac(rv3d, co, NULL);
1291   }
1292   else {
1293     return -dot_v3v3(rv3d->viewinv[2], co);
1294   }
1295 }
1296
1297 /* only erase stroke points that are visible */
1298 static bool gp_stroke_eraser_is_occluded(tGPsdata *p,
1299                                          const bGPDspoint *pt,
1300                                          const int x,
1301                                          const int y)
1302 {
1303   Object *obact = (Object *)p->ownerPtr.data;
1304   Brush *brush = p->brush;
1305   Brush *eraser = p->eraser;
1306   BrushGpencilSettings *gp_settings = NULL;
1307
1308   if (brush->gpencil_tool == GPAINT_TOOL_ERASE) {
1309     gp_settings = brush->gpencil_settings;
1310   }
1311   else if ((eraser != NULL) & (eraser->gpencil_tool == GPAINT_TOOL_ERASE)) {
1312     gp_settings = eraser->gpencil_settings;
1313   }
1314
1315   if ((gp_settings != NULL) && (p->sa->spacetype == SPACE_VIEW3D) &&
1316       (gp_settings->flag & GP_BRUSH_OCCLUDE_ERASER)) {
1317     RegionView3D *rv3d = p->ar->regiondata;
1318     bGPDlayer *gpl = p->gpl;
1319
1320     const int mval_i[2] = {x, y};
1321     float mval_3d[3];
1322     float fpt[3];
1323
1324     float diff_mat[4][4];
1325     /* calculate difference matrix if parent object */
1326     ED_gpencil_parent_location(p->depsgraph, obact, p->gpd, gpl, diff_mat);
1327
1328     if (ED_view3d_autodist_simple(p->ar, mval_i, mval_3d, 0, NULL)) {
1329       const float depth_mval = view3d_point_depth(rv3d, mval_3d);
1330
1331       mul_v3_m4v3(fpt, diff_mat, &pt->x);
1332       const float depth_pt = view3d_point_depth(rv3d, fpt);
1333
1334       if (depth_pt > depth_mval) {
1335         return true;
1336       }
1337     }
1338   }
1339   return false;
1340 }
1341
1342 /* apply a falloff effect to brush strength, based on distance */
1343 static float gp_stroke_eraser_calc_influence(tGPsdata *p,
1344                                              const float mval[2],
1345                                              const int radius,
1346                                              const int co[2])
1347 {
1348   Brush *brush = p->brush;
1349   /* Linear Falloff... */
1350   int mval_i[2];
1351   round_v2i_v2fl(mval_i, mval);
1352   float distance = (float)len_v2v2_int(mval_i, co);
1353   float fac;
1354
1355   CLAMP(distance, 0.0f, (float)radius);
1356   fac = 1.0f - (distance / (float)radius);
1357
1358   /* apply strength factor */
1359   fac *= brush->gpencil_settings->draw_strength;
1360
1361   /* Control this further using pen pressure */
1362   if (brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE) {
1363     fac *= p->pressure;
1364   }
1365   /* Return influence factor computed here */
1366   return fac;
1367 }
1368
1369 /* helper to free a stroke */
1370 static void gp_free_stroke(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps)
1371 {
1372   if (gps->points) {
1373     MEM_freeN(gps->points);
1374   }
1375
1376   if (gps->dvert) {
1377     BKE_gpencil_free_stroke_weights(gps);
1378     MEM_freeN(gps->dvert);
1379   }
1380
1381   if (gps->triangles) {
1382     MEM_freeN(gps->triangles);
1383   }
1384   BLI_freelinkN(&gpf->strokes, gps);
1385   gp_update_cache(gpd);
1386 }
1387
1388 /**
1389  * Analyze points to be removed when soft eraser is used
1390  * to avoid that segments gets the end points rounded.
1391  * The round caps breaks the artistic effect.
1392  */
1393 static void gp_stroke_soft_refine(bGPDstroke *gps)
1394 {
1395   bGPDspoint *pt = NULL;
1396   bGPDspoint *pt2 = NULL;
1397   int i;
1398
1399   /* check if enough points*/
1400   if (gps->totpoints < 3) {
1401     return;
1402   }
1403
1404   /* loop all points to untag any point that next is not tagged */
1405   pt = gps->points;
1406   for (i = 1; i < gps->totpoints - 1; i++, pt++) {
1407     if (pt->flag & GP_SPOINT_TAG) {
1408       pt2 = &gps->points[i + 1];
1409       if ((pt2->flag & GP_SPOINT_TAG) == 0) {
1410         pt->flag &= ~GP_SPOINT_TAG;
1411       }
1412     }
1413   }
1414
1415   /* loop reverse all points to untag any point that previous is not tagged */
1416   pt = &gps->points[gps->totpoints - 1];
1417   for (i = gps->totpoints - 1; i > 0; i--, pt--) {
1418     if (pt->flag & GP_SPOINT_TAG) {
1419       pt2 = &gps->points[i - 1];
1420       if ((pt2->flag & GP_SPOINT_TAG) == 0) {
1421         pt->flag &= ~GP_SPOINT_TAG;
1422       }
1423     }
1424   }
1425 }
1426
1427 /* eraser tool - evaluation per stroke */
1428 /* TODO: this could really do with some optimization (KD-Tree/BVH?) */
1429 static void gp_stroke_eraser_dostroke(tGPsdata *p,
1430                                       bGPDlayer *gpl,
1431                                       bGPDframe *gpf,
1432                                       bGPDstroke *gps,
1433                                       const float mval[2],
1434                                       const float mvalo[2],
1435                                       const int radius,
1436                                       const rcti *rect)
1437 {
1438   Depsgraph *depsgraph = p->depsgraph;
1439   Object *obact = (Object *)p->ownerPtr.data;
1440   Brush *eraser = p->eraser;
1441   bGPDspoint *pt0, *pt1, *pt2;
1442   int pc0[2] = {0};
1443   int pc1[2] = {0};
1444   int pc2[2] = {0};
1445   int i;
1446   float diff_mat[4][4];
1447   int mval_i[2];
1448   round_v2i_v2fl(mval_i, mval);
1449
1450   /* calculate difference matrix */
1451   ED_gpencil_parent_location(depsgraph, obact, p->gpd, gpl, diff_mat);
1452
1453   if (gps->totpoints == 0) {
1454     /* just free stroke */
1455     gp_free_stroke(p->gpd, gpf, gps);
1456   }
1457   else if (gps->totpoints == 1) {
1458     /* only process if it hasn't been masked out... */
1459     if (!(p->flags & GP_PAINTFLAG_SELECTMASK) || (gps->points->flag & GP_SPOINT_SELECT)) {
1460       bGPDspoint pt_temp;
1461       gp_point_to_parent_space(gps->points, diff_mat, &pt_temp);
1462       gp_point_to_xy(&p->gsc, gps, &pt_temp, &pc1[0], &pc1[1]);
1463       /* do boundbox check first */
1464       if ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) {
1465         /* only check if point is inside */
1466         if (len_v2v2_int(mval_i, pc1) <= radius) {
1467           /* free stroke */
1468           gp_free_stroke(p->gpd, gpf, gps);
1469         }
1470       }
1471     }
1472   }
1473   else if ((p->flags & GP_PAINTFLAG_STROKE_ERASER) ||
1474            (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_STROKE)) {
1475     for (i = 0; (i + 1) < gps->totpoints; i++) {
1476
1477       /* only process if it hasn't been masked out... */
1478       if ((p->flags & GP_PAINTFLAG_SELECTMASK) && !(gps->points->flag & GP_SPOINT_SELECT)) {
1479         continue;
1480       }
1481
1482       /* get points to work with */
1483       pt1 = gps->points + i;
1484       bGPDspoint npt;
1485       gp_point_to_parent_space(pt1, diff_mat, &npt);
1486       gp_point_to_xy(&p->gsc, gps, &npt, &pc1[0], &pc1[1]);
1487
1488       /* do boundbox check first */
1489       if ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) {
1490         /* only check if point is inside */
1491         if (len_v2v2_int(mval_i, pc1) <= radius) {
1492           /* free stroke */
1493           gp_free_stroke(p->gpd, gpf, gps);
1494           return;
1495         }
1496       }
1497     }
1498   }
1499   else {
1500     /* Pressure threshold at which stroke should be culled */
1501     const float cull_thresh = 0.005f;
1502
1503     /* Amount to decrease the pressure of each point with each stroke */
1504     const float strength = 0.1f;
1505
1506     /* Perform culling? */
1507     bool do_cull = false;
1508
1509     /* Clear Tags
1510      *
1511      * Note: It's better this way, as we are sure that
1512      * we don't miss anything, though things will be
1513      * slightly slower as a result
1514      */
1515     for (i = 0; i < gps->totpoints; i++) {
1516       bGPDspoint *pt = &gps->points[i];
1517       pt->flag &= ~GP_SPOINT_TAG;
1518     }
1519
1520     /* First Pass: Loop over the points in the stroke
1521      *   1) Thin out parts of the stroke under the brush
1522      *   2) Tag "too thin" parts for removal (in second pass)
1523      */
1524     for (i = 0; (i + 1) < gps->totpoints; i++) {
1525       /* get points to work with */
1526       pt0 = i > 0 ? gps->points + i - 1 : NULL;
1527       pt1 = gps->points + i;
1528       pt2 = gps->points + i + 1;
1529
1530       /* only process if it hasn't been masked out... */
1531       if ((p->flags & GP_PAINTFLAG_SELECTMASK) && !(gps->points->flag & GP_SPOINT_SELECT)) {
1532         continue;
1533       }
1534
1535       bGPDspoint npt;
1536       if (pt0) {
1537         gp_point_to_parent_space(pt0, diff_mat, &npt);
1538         gp_point_to_xy(&p->gsc, gps, &npt, &pc0[0], &pc0[1]);
1539       }
1540       else {
1541         /* avoid null values */
1542         copy_v2_v2_int(pc0, pc1);
1543       }
1544
1545       gp_point_to_parent_space(pt1, diff_mat, &npt);
1546       gp_point_to_xy(&p->gsc, gps, &npt, &pc1[0], &pc1[1]);
1547
1548       gp_point_to_parent_space(pt2, diff_mat, &npt);
1549       gp_point_to_xy(&p->gsc, gps, &npt, &pc2[0], &pc2[1]);
1550
1551       /* Check that point segment of the boundbox of the eraser stroke */
1552       if (((!ELEM(V2D_IS_CLIPPED, pc0[0], pc0[1])) && BLI_rcti_isect_pt(rect, pc0[0], pc0[1])) ||
1553           ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) ||
1554           ((!ELEM(V2D_IS_CLIPPED, pc2[0], pc2[1])) && BLI_rcti_isect_pt(rect, pc2[0], pc2[1]))) {
1555         /* Check if point segment of stroke had anything to do with
1556          * eraser region  (either within stroke painted, or on its lines)
1557          * - this assumes that linewidth is irrelevant
1558          */
1559         if (gp_stroke_inside_circle(mval, mvalo, radius, pc0[0], pc0[1], pc2[0], pc2[1])) {
1560           if ((gp_stroke_eraser_is_occluded(p, pt0, pc0[0], pc0[1]) == false) ||
1561               (gp_stroke_eraser_is_occluded(p, pt1, pc1[0], pc1[1]) == false) ||
1562               (gp_stroke_eraser_is_occluded(p, pt2, pc2[0], pc2[1]) == false)) {
1563             /* Point is affected: */
1564             /* Adjust thickness
1565              *  - Influence of eraser falls off with distance from the middle of the eraser
1566              *  - Second point gets less influence, as it might get hit again in the next segment
1567              */
1568
1569             /* Adjust strength if the eraser is soft */
1570             if (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_SOFT) {
1571               float f_strength = eraser->gpencil_settings->era_strength_f / 100.0f;
1572               float f_thickness = eraser->gpencil_settings->era_thickness_f / 100.0f;
1573               float influence = 0.0f;
1574
1575               if (pt0) {
1576                 influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc0);
1577                 pt0->strength -= influence * strength * f_strength * 0.5f;
1578                 CLAMP_MIN(pt0->strength, 0.0f);
1579                 pt0->pressure -= influence * strength * f_thickness * 0.5f;
1580               }
1581
1582               influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc1);
1583               pt1->strength -= influence * strength * f_strength;
1584               CLAMP_MIN(pt1->strength, 0.0f);
1585               pt1->pressure -= influence * strength * f_thickness;
1586
1587               influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc2);
1588               pt2->strength -= influence * strength * f_strength * 0.5f;
1589               CLAMP_MIN(pt2->strength, 0.0f);
1590               pt2->pressure -= influence * strength * f_thickness * 0.5f;
1591
1592               /* if invisible, delete point */
1593               if ((pt0) && ((pt0->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1594                             (pt0->pressure < cull_thresh))) {
1595                 pt0->flag |= GP_SPOINT_TAG;
1596                 do_cull = true;
1597               }
1598               if ((pt1->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1599                   (pt1->pressure < cull_thresh)) {
1600                 pt1->flag |= GP_SPOINT_TAG;
1601                 do_cull = true;
1602               }
1603               if ((pt2->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1604                   (pt2->pressure < cull_thresh)) {
1605                 pt2->flag |= GP_SPOINT_TAG;
1606                 do_cull = true;
1607               }
1608             }
1609             else {
1610               pt1->pressure -= gp_stroke_eraser_calc_influence(p, mval, radius, pc1) * strength;
1611               pt2->pressure -= gp_stroke_eraser_calc_influence(p, mval, radius, pc2) * strength *
1612                                0.5f;
1613             }
1614
1615             /* 2) Tag any point with overly low influence for removal in the next pass */
1616             if ((pt1->pressure < cull_thresh) || (p->flags & GP_PAINTFLAG_HARD_ERASER) ||
1617                 (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_HARD)) {
1618               pt1->flag |= GP_SPOINT_TAG;
1619               do_cull = true;
1620             }
1621             if ((pt2->pressure < cull_thresh) || (p->flags & GP_PAINTFLAG_HARD_ERASER) ||
1622                 (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_HARD)) {
1623               pt2->flag |= GP_SPOINT_TAG;
1624               do_cull = true;
1625             }
1626           }
1627         }
1628       }
1629     }
1630
1631     /* Second Pass: Remove any points that are tagged */
1632     if (do_cull) {
1633       /* if soft eraser, must analyze points to be sure the stroke ends
1634        * don't get rounded */
1635       if (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_SOFT) {
1636         gp_stroke_soft_refine(gps);
1637       }
1638
1639       gp_stroke_delete_tagged_points(gpf, gps, gps->next, GP_SPOINT_TAG, false, 0);
1640     }
1641     gp_update_cache(p->gpd);
1642   }
1643 }
1644
1645 /* erase strokes which fall under the eraser strokes */
1646 static void gp_stroke_doeraser(tGPsdata *p)
1647 {
1648   bGPDlayer *gpl;
1649   bGPDstroke *gps, *gpn;
1650   rcti rect;
1651   Brush *brush = p->brush;
1652   Brush *eraser = p->eraser;
1653   bool use_pressure = false;
1654   float press = 1.0f;
1655   BrushGpencilSettings *gp_settings = NULL;
1656
1657   /* detect if use pressure in eraser */
1658   if (brush->gpencil_tool == GPAINT_TOOL_ERASE) {
1659     use_pressure = (bool)(brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE);
1660     gp_settings = brush->gpencil_settings;
1661   }
1662   else if ((eraser != NULL) & (eraser->gpencil_tool == GPAINT_TOOL_ERASE)) {
1663     use_pressure = (bool)(eraser->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE);
1664     gp_settings = eraser->gpencil_settings;
1665   }
1666   if (use_pressure) {
1667     press = p->pressure;
1668     CLAMP(press, 0.01f, 1.0f);
1669   }
1670   /* rect is rectangle of eraser */
1671   const int calc_radius = (int)p->radius * press;
1672   rect.xmin = p->mval[0] - calc_radius;
1673   rect.ymin = p->mval[1] - calc_radius;
1674   rect.xmax = p->mval[0] + calc_radius;
1675   rect.ymax = p->mval[1] + calc_radius;
1676
1677   if (p->sa->spacetype == SPACE_VIEW3D) {
1678     if ((gp_settings != NULL) && (gp_settings->flag & GP_BRUSH_OCCLUDE_ERASER)) {
1679       View3D *v3d = p->sa->spacedata.first;
1680       view3d_region_operator_needs_opengl(p->win, p->ar);
1681       ED_view3d_autodist_init(p->depsgraph, p->ar, v3d, 0);
1682     }
1683   }
1684
1685   /* loop over all layers too, since while it's easy to restrict editing to
1686    * only a subset of layers, it is harder to perform the same erase operation
1687    * on multiple layers...
1688    */
1689   for (gpl = p->gpd->layers.first; gpl; gpl = gpl->next) {
1690     bGPDframe *gpf = gpl->actframe;
1691
1692     /* only affect layer if it's editable (and visible) */
1693     if (gpencil_layer_is_editable(gpl) == false) {
1694       continue;
1695     }
1696     else if (gpf == NULL) {
1697       continue;
1698     }
1699
1700     /* loop over strokes, checking segments for intersections */
1701     for (gps = gpf->strokes.first; gps; gps = gpn) {
1702       gpn = gps->next;
1703       /* check if the color is editable */
1704       if (ED_gpencil_stroke_color_use(p->ob, gpl, gps) == false) {
1705         continue;
1706       }
1707       /* Not all strokes in the datablock may be valid in the current editor/context
1708        * (e.g. 2D space strokes in the 3D view, if the same datablock is shared)
1709        */
1710       if (ED_gpencil_stroke_can_use_direct(p->sa, gps)) {
1711         gp_stroke_eraser_dostroke(p, gpl, gpf, gps, p->mval, p->mvalo, calc_radius, &rect);
1712       }
1713     }
1714   }
1715 }
1716
1717 /* ******************************************* */
1718 /* Sketching Operator */
1719
1720 /* clear the session buffers (call this before AND after a paint operation) */
1721 static void gp_session_validatebuffer(tGPsdata *p)
1722 {
1723   bGPdata *gpd = p->gpd;
1724   Brush *brush = p->brush;
1725
1726   /* clear memory of buffer (or allocate it if starting a new session) */
1727   if (gpd->runtime.sbuffer) {
1728     /* printf("\t\tGP - reset sbuffer\n"); */
1729     memset(gpd->runtime.sbuffer, 0, sizeof(tGPspoint) * GP_STROKE_BUFFER_MAX);
1730   }
1731   else {
1732     /* printf("\t\tGP - allocate sbuffer\n"); */
1733     gpd->runtime.sbuffer = MEM_callocN(sizeof(tGPspoint) * GP_STROKE_BUFFER_MAX,
1734                                        "gp_session_strokebuffer");
1735   }
1736
1737   /* reset indices */
1738   gpd->runtime.sbuffer_size = 0;
1739
1740   /* reset flags */
1741   gpd->runtime.sbuffer_sflag = 0;
1742
1743   /* reset region */
1744   gpd->runtime.ar = NULL;
1745
1746   /* reset inittime */
1747   p->inittime = 0.0;
1748
1749   /* reset lazy */
1750   if (brush) {
1751     brush->gpencil_settings->flag &= ~GP_BRUSH_STABILIZE_MOUSE_TEMP;
1752   }
1753 }
1754
1755 /* helper to get default eraser and create one if no eraser brush */
1756 static Brush *gp_get_default_eraser(Main *bmain, ToolSettings *ts)
1757 {
1758   Brush *brush_dft = NULL;
1759   Paint *paint = &ts->gp_paint->paint;
1760   Brush *brush_old = paint->brush;
1761   for (Brush *brush = bmain->brushes.first; brush; brush = brush->id.next) {
1762     if ((brush->ob_mode == OB_MODE_PAINT_GPENCIL) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
1763       /* save first eraser to use later if no default */
1764       if (brush_dft == NULL) {
1765         brush_dft = brush;
1766       }
1767       /* found default */
1768       if (brush->gpencil_settings->flag & GP_BRUSH_DEFAULT_ERASER) {
1769         return brush;
1770       }
1771     }
1772   }
1773   /* if no default, but exist eraser brush, return this and set as default */
1774   if (brush_dft) {
1775     brush_dft->gpencil_settings->flag |= GP_BRUSH_DEFAULT_ERASER;
1776     return brush_dft;
1777   }
1778   /* create a new soft eraser brush */
1779   else {
1780     brush_dft = BKE_brush_add_gpencil(bmain, ts, "Soft Eraser");
1781     brush_dft->size = 30.0f;
1782     brush_dft->gpencil_settings->flag |= (GP_BRUSH_ENABLE_CURSOR | GP_BRUSH_DEFAULT_ERASER);
1783     brush_dft->gpencil_settings->icon_id = GP_BRUSH_ICON_ERASE_SOFT;
1784     brush_dft->gpencil_tool = GPAINT_TOOL_ERASE;
1785     brush_dft->gpencil_settings->eraser_mode = GP_BRUSH_ERASER_SOFT;
1786
1787     /* reset current brush */
1788     BKE_paint_brush_set(paint, brush_old);
1789
1790     return brush_dft;
1791   }
1792 }
1793
1794 /* helper to set default eraser and disable others */
1795 static void gp_set_default_eraser(Main *bmain, Brush *brush_dft)
1796 {
1797   if (brush_dft == NULL) {
1798     return;
1799   }
1800
1801   for (Brush *brush = bmain->brushes.first; brush; brush = brush->id.next) {
1802     if ((brush->gpencil_settings) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
1803       if (brush == brush_dft) {
1804         brush->gpencil_settings->flag |= GP_BRUSH_DEFAULT_ERASER;
1805       }
1806       else if (brush->gpencil_settings->flag & GP_BRUSH_DEFAULT_ERASER) {
1807         brush->gpencil_settings->flag &= ~GP_BRUSH_DEFAULT_ERASER;
1808       }
1809     }
1810   }
1811 }
1812
1813 /* initialize a drawing brush */
1814 static void gp_init_drawing_brush(bContext *C, tGPsdata *p)
1815 {
1816   Scene *scene = CTX_data_scene(C);
1817   ToolSettings *ts = CTX_data_tool_settings(C);
1818
1819   Paint *paint = &ts->gp_paint->paint;
1820   bool changed = false;
1821   /* if not exist, create a new one */
1822   if ((paint->brush == NULL) || (paint->brush->gpencil_settings == NULL)) {
1823     /* create new brushes */
1824     BKE_brush_gpencil_presets(C);
1825     changed = true;
1826   }
1827   /* be sure curves are initializated */
1828   curvemapping_initialize(paint->brush->gpencil_settings->curve_sensitivity);
1829   curvemapping_initialize(paint->brush->gpencil_settings->curve_strength);
1830   curvemapping_initialize(paint->brush->gpencil_settings->curve_jitter);
1831
1832   /* assign to temp tGPsdata */
1833   p->brush = paint->brush;
1834   if (paint->brush->gpencil_tool != GPAINT_TOOL_ERASE) {
1835     p->eraser = gp_get_default_eraser(p->bmain, ts);
1836   }
1837   else {
1838     p->eraser = paint->brush;
1839   }
1840   /* set new eraser as default */
1841   gp_set_default_eraser(p->bmain, p->eraser);
1842
1843   /* use radius of eraser */
1844   p->radius = (short)p->eraser->size;
1845
1846   /* GPXX: Need this update to synchronize brush with draw manager.
1847    * Maybe this update can be removed when the new tool system
1848    * will be in place, but while, we need this to keep drawing working.
1849    */
1850   if (changed) {
1851     DEG_id_tag_update(&scene->id, ID_RECALC_COPY_ON_WRITE);
1852   }
1853 }
1854
1855 /* initialize a paint brush and a default color if not exist */
1856 static void gp_init_colors(tGPsdata *p)
1857 {
1858   bGPdata *gpd = p->gpd;
1859   Brush *brush = p->brush;
1860
1861   MaterialGPencilStyle *gp_style = NULL;
1862
1863   /* use brush material */
1864   p->material = BKE_gpencil_object_material_ensure_from_active_input_brush(p->bmain, p->ob, brush);
1865
1866   /* assign color information to temp tGPsdata */
1867   gp_style = p->material->gp_style;
1868   if (gp_style) {
1869
1870     /* set colors */
1871     if (gp_style->flag & GP_STYLE_STROKE_SHOW) {
1872       copy_v4_v4(gpd->runtime.scolor, gp_style->stroke_rgba);
1873     }
1874     else {
1875       /* if no stroke, use fill */
1876       copy_v4_v4(gpd->runtime.scolor, gp_style->fill_rgba);
1877     }
1878     copy_v4_v4(gpd->runtime.sfill, gp_style->fill_rgba);
1879     /* add some alpha to make easy the filling without hide strokes */
1880     if (gpd->runtime.sfill[3] > 0.8f) {
1881       gpd->runtime.sfill[3] = 0.8f;
1882     }
1883
1884     gpd->runtime.mode = (short)gp_style->mode;
1885     gpd->runtime.bstroke_style = gp_style->stroke_style;
1886     gpd->runtime.bfill_style = gp_style->fill_style;
1887   }
1888 }
1889
1890 /* (re)init new painting data */
1891 static bool gp_session_initdata(bContext *C, wmOperator *op, tGPsdata *p)
1892 {
1893   Main *bmain = CTX_data_main(C);
1894   bGPdata **gpd_ptr = NULL;
1895   ScrArea *curarea = CTX_wm_area(C);
1896   ARegion *ar = CTX_wm_region(C);
1897   ToolSettings *ts = CTX_data_tool_settings(C);
1898   Object *obact = CTX_data_active_object(C);
1899
1900   /* make sure the active view (at the starting time) is a 3d-view */
1901   if (curarea == NULL) {
1902     p->status = GP_STATUS_ERROR;
1903     if (G.debug & G_DEBUG) {
1904       printf("Error: No active view for painting\n");
1905     }
1906     return 0;
1907   }
1908
1909   /* pass on current scene and window */
1910   p->C = C;
1911   p->bmain = CTX_data_main(C);
1912   p->scene = CTX_data_scene(C);
1913   p->depsgraph = CTX_data_depsgraph(C);
1914   p->win = CTX_wm_window(C);
1915   p->disable_fill = RNA_boolean_get(op->ptr, "disable_fill");
1916
1917   unit_m4(p->imat);
1918   unit_m4(p->mat);
1919
1920   switch (curarea->spacetype) {
1921     /* supported views first */
1922     case SPACE_VIEW3D: {
1923       /* View3D *v3d = curarea->spacedata.first; */
1924       /* RegionView3D *rv3d = ar->regiondata; */
1925
1926       /* set current area
1927        * - must verify that region data is 3D-view (and not something else)
1928        */
1929       /* CAUTION: If this is the "toolbar", then this will change on the first stroke */
1930       p->sa = curarea;
1931       p->ar = ar;
1932       p->align_flag = &ts->gpencil_v3d_align;
1933
1934       if (ar->regiondata == NULL) {
1935         p->status = GP_STATUS_ERROR;
1936         if (G.debug & G_DEBUG) {
1937           printf(
1938               "Error: 3D-View active region doesn't have any region data, so cannot be "
1939               "drawable\n");
1940         }
1941         return 0;
1942       }
1943
1944       if ((!obact) || (obact->type != OB_GPENCIL)) {
1945         View3D *v3d = p->sa->spacedata.first;
1946         /* if active object doesn't exist or isn't a GP Object, create one */
1947         const float *cur = p->scene->cursor.location;
1948
1949         ushort local_view_bits = 0;
1950         if (v3d->localvd) {
1951           local_view_bits = v3d->local_view_uuid;
1952         }
1953         /* create new default object */
1954         obact = ED_gpencil_add_object(C, p->scene, cur, local_view_bits);
1955       }
1956       /* assign object after all checks to be sure we have one active */
1957       p->ob = obact;
1958
1959       break;
1960     }
1961
1962     /* unsupported views */
1963     default: {
1964       p->status = GP_STATUS_ERROR;
1965       if (G.debug & G_DEBUG) {
1966         printf("Error: Active view not appropriate for Grease Pencil drawing\n");
1967       }
1968       return 0;
1969     }
1970   }
1971
1972   /* get gp-data */
1973   gpd_ptr = ED_gpencil_data_get_pointers(C, &p->ownerPtr);
1974   if ((gpd_ptr == NULL) || ED_gpencil_data_owner_is_annotation(&p->ownerPtr)) {
1975     p->status = GP_STATUS_ERROR;
1976     if (G.debug & G_DEBUG) {
1977       printf("Error: Current context doesn't allow for any Grease Pencil data\n");
1978     }
1979     return 0;
1980   }
1981   else {
1982     /* if no existing GPencil block exists, add one */
1983     if (*gpd_ptr == NULL) {
1984       *gpd_ptr = BKE_gpencil_data_addnew(bmain, "GPencil");
1985     }
1986     p->gpd = *gpd_ptr;
1987   }
1988
1989   /* clear out buffer (stored in gp-data), in case something contaminated it */
1990   gp_session_validatebuffer(p);
1991
1992   /* set brush and create a new one if null */
1993   gp_init_drawing_brush(C, p);
1994
1995   /* setup active color */
1996   if (curarea->spacetype == SPACE_VIEW3D) {
1997     /* region where paint was originated */
1998     p->gpd->runtime.ar = CTX_wm_region(C);
1999
2000     /* NOTE: This is only done for 3D view, as Materials aren't used for
2001      *       annotations in 2D editors
2002      */
2003     int totcol = p->ob->totcol;
2004
2005     gp_init_colors(p);
2006
2007     /* check whether the material was newly added */
2008     if (totcol != p->ob->totcol) {
2009       WM_event_add_notifier(C, NC_SPACE | ND_SPACE_PROPERTIES, NULL);
2010     }
2011   }
2012
2013   /* lock axis (in some modes, disable) */
2014   if (((*p->align_flag & GP_PROJECT_DEPTH_VIEW) == 0) &&
2015       ((*p->align_flag & GP_PROJECT_DEPTH_STROKE) == 0)) {
2016     p->lock_axis = ts->gp_sculpt.lock_axis;
2017   }
2018   else {
2019     p->lock_axis = 0;
2020   }
2021
2022   return 1;
2023 }
2024
2025 /* init new painting session */
2026 static tGPsdata *gp_session_initpaint(bContext *C, wmOperator *op)
2027 {
2028   tGPsdata *p = NULL;
2029
2030   /* Create new context data */
2031   p = MEM_callocN(sizeof(tGPsdata), "GPencil Drawing Data");
2032
2033   /* Try to initialize context data
2034    * WARNING: This may not always succeed (e.g. using GP in an annotation-only context)
2035    */
2036   if (gp_session_initdata(C, op, p) == 0) {
2037     /* Invalid state - Exit
2038      * NOTE: It should be safe to just free the data, since failing context checks should
2039      * only happen when no data has been allocated.
2040      */
2041     MEM_freeN(p);
2042     return NULL;
2043   }
2044
2045   /* Random generator, only init once. */
2046   uint rng_seed = (uint)(PIL_check_seconds_timer_i() & UINT_MAX);
2047   rng_seed ^= POINTER_AS_UINT(p);
2048   p->rng = BLI_rng_new(rng_seed);
2049
2050   /* return context data for running paint operator */
2051   return p;
2052 }
2053
2054 /* cleanup after a painting session */
2055 static void gp_session_cleanup(tGPsdata *p)
2056 {
2057   bGPdata *gpd = (p) ? p->gpd : NULL;
2058
2059   /* error checking */
2060   if (gpd == NULL) {
2061     return;
2062   }
2063
2064   /* free stroke buffer */
2065   if (gpd->runtime.sbuffer) {
2066     /* printf("\t\tGP - free sbuffer\n"); */
2067     MEM_SAFE_FREE(gpd->runtime.sbuffer);
2068     gpd->runtime.sbuffer = NULL;
2069   }
2070
2071   /* clear flags */
2072   gpd->runtime.sbuffer_size = 0;
2073   gpd->runtime.sbuffer_sflag = 0;
2074   p->inittime = 0.0;
2075 }
2076
2077 static void gp_session_free(tGPsdata *p)
2078 {
2079   if (p->rng != NULL) {
2080     BLI_rng_free(p->rng);
2081   }
2082
2083   MEM_freeN(p);
2084 }
2085
2086 /* init new stroke */
2087 static void gp_paint_initstroke(tGPsdata *p, eGPencil_PaintModes paintmode, Depsgraph *depsgraph)
2088 {
2089   Scene *scene = p->scene;
2090   ToolSettings *ts = scene->toolsettings;
2091   int cfra_eval = (int)DEG_get_ctime(p->depsgraph);
2092
2093   /* get active layer (or add a new one if non-existent) */
2094   p->gpl = BKE_gpencil_layer_getactive(p->gpd);
2095   if (p->gpl == NULL) {
2096     p->gpl = BKE_gpencil_layer_addnew(p->gpd, DATA_("GP_Layer"), true);
2097
2098     if (p->custom_color[3]) {
2099       copy_v3_v3(p->gpl->color, p->custom_color);
2100     }
2101   }
2102   if ((paintmode != GP_PAINTMODE_ERASER) && (p->gpl->flag & GP_LAYER_LOCKED)) {
2103     p->status = GP_STATUS_ERROR;
2104     if (G.debug & G_DEBUG) {
2105       printf("Error: Cannot paint on locked layer\n");
2106     }
2107     return;
2108   }
2109
2110   /* get active frame (add a new one if not matching frame) */
2111   if (paintmode == GP_PAINTMODE_ERASER) {
2112     /* Eraser mode:
2113      * 1) Add new frames to all frames that we might touch,
2114      * 2) Ensure that p->gpf refers to the frame used for the active layer
2115      *    (to avoid problems with other tools which expect it to exist)
2116      */
2117     bool has_layer_to_erase = false;
2118
2119     for (bGPDlayer *gpl = p->gpd->layers.first; gpl; gpl = gpl->next) {
2120       /* Skip if layer not editable */
2121       if (gpencil_layer_is_editable(gpl) == false) {
2122         continue;
2123       }
2124
2125       /* Add a new frame if needed (and based off the active frame,
2126        * as we need some existing strokes to erase)
2127        *
2128        * Note: We don't add a new frame if there's nothing there now, so
2129        *       -> If there are no frames at all, don't add one
2130        *       -> If there are no strokes in that frame, don't add a new empty frame
2131        */
2132       if (gpl->actframe && gpl->actframe->strokes.first) {
2133         gpl->actframe = BKE_gpencil_layer_getframe(gpl, cfra_eval, GP_GETFRAME_ADD_COPY);
2134         has_layer_to_erase = true;
2135       }
2136
2137       /* XXX: we omit GP_FRAME_PAINT here for now,
2138        * as it is only really useful for doing
2139        * paintbuffer drawing
2140        */
2141     }
2142
2143     /* Ensure this gets set... */
2144     p->gpf = p->gpl->actframe;
2145
2146     /* Restrict eraser to only affecting selected strokes, if the "selection mask" is on
2147      * (though this is only available in editmode)
2148      */
2149     if (p->gpd->flag & GP_DATA_STROKE_EDITMODE) {
2150       if (ts->gp_sculpt.flag & GP_SCULPT_SETT_FLAG_SELECT_MASK) {
2151         p->flags |= GP_PAINTFLAG_SELECTMASK;
2152       }
2153     }
2154
2155     if (has_layer_to_erase == false) {
2156       p->status = GP_STATUS_ERROR;
2157       return;
2158     }
2159   }
2160   else {
2161     /* Drawing Modes - Add a new frame if needed on the active layer */
2162     short add_frame_mode;
2163
2164     if (ts->gpencil_flags & GP_TOOL_FLAG_RETAIN_LAST) {
2165       add_frame_mode = GP_GETFRAME_ADD_COPY;
2166     }
2167     else {
2168       add_frame_mode = GP_GETFRAME_ADD_NEW;
2169     }
2170
2171     p->gpf = BKE_gpencil_layer_getframe(p->gpl, cfra_eval, add_frame_mode);
2172
2173     if (p->gpf == NULL) {
2174       p->status = GP_STATUS_ERROR;
2175       if (G.debug & G_DEBUG) {
2176         printf("Error: No frame created (gpencil_paint_init)\n");
2177       }
2178       return;
2179     }
2180     else {
2181       p->gpf->flag |= GP_FRAME_PAINT;
2182     }
2183   }
2184
2185   /* set 'eraser' for this stroke if using eraser */
2186   p->paintmode = paintmode;
2187   if (p->paintmode == GP_PAINTMODE_ERASER) {
2188     p->gpd->runtime.sbuffer_sflag |= GP_STROKE_ERASER;
2189   }
2190   else {
2191     /* disable eraser flags - so that we can switch modes during a session */
2192     p->gpd->runtime.sbuffer_sflag &= ~GP_STROKE_ERASER;
2193   }
2194
2195   /* set special fill stroke mode */
2196   if (p->disable_fill == true) {
2197     p->gpd->runtime.sbuffer_sflag |= GP_STROKE_NOFILL;
2198     /* replace stroke color with fill color */
2199     copy_v4_v4(p->gpd->runtime.scolor, p->gpd->runtime.sfill);
2200   }
2201
2202   /* set 'initial run' flag, which is only used to denote when a new stroke is starting */
2203   p->flags |= GP_PAINTFLAG_FIRSTRUN;
2204
2205   /* when drawing in the camera view, in 2D space, set the subrect */
2206   p->subrect = NULL;
2207   if ((*p->align_flag & GP_PROJECT_VIEWSPACE) == 0) {
2208     if (p->sa->spacetype == SPACE_VIEW3D) {
2209       View3D *v3d = p->sa->spacedata.first;
2210       RegionView3D *rv3d = p->ar->regiondata;
2211
2212       /* for camera view set the subrect */
2213       if (rv3d->persp == RV3D_CAMOB) {
2214         /* no shift */
2215         ED_view3d_calc_camera_border(
2216             p->scene, depsgraph, p->ar, v3d, rv3d, &p->subrect_data, true);
2217         p->subrect = &p->subrect_data;
2218       }
2219     }
2220   }
2221
2222   /* init stroke point space-conversion settings... */
2223   p->gsc.gpd = p->gpd;
2224   p->gsc.gpl = p->gpl;
2225
2226   p->gsc.sa = p->sa;
2227   p->gsc.ar = p->ar;
2228   p->gsc.v2d = p->v2d;
2229
2230   p->gsc.subrect_data = p->subrect_data;
2231   p->gsc.subrect = p->subrect;
2232
2233   copy_m4_m4(p->gsc.mat, p->mat);
2234
2235   /* check if points will need to be made in view-aligned space */
2236   if (*p->align_flag & GP_PROJECT_VIEWSPACE) {
2237     switch (p->sa->spacetype) {
2238       case SPACE_VIEW3D: {
2239         p->gpd->runtime.sbuffer_sflag |= GP_STROKE_3DSPACE;
2240         break;
2241       }
2242     }
2243   }
2244 }
2245
2246 /* finish off a stroke (clears buffer, but doesn't finish the paint operation) */
2247 static void gp_paint_strokeend(tGPsdata *p)
2248 {
2249   ToolSettings *ts = p->scene->toolsettings;
2250   /* for surface sketching, need to set the right OpenGL context stuff so that
2251    * the conversions will project the values correctly...
2252    */
2253   if (gpencil_project_check(p)) {
2254     View3D *v3d = p->sa->spacedata.first;
2255
2256     /* need to restore the original projection settings before packing up */
2257     view3d_region_operator_needs_opengl(p->win, p->ar);
2258     ED_view3d_autodist_init(
2259         p->depsgraph, p->ar, v3d, (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 1 : 0);
2260   }
2261
2262   /* check if doing eraser or not */
2263   if ((p->gpd->runtime.sbuffer_sflag & GP_STROKE_ERASER) == 0) {
2264     /* transfer stroke to frame */
2265     gp_stroke_newfrombuffer(p);
2266   }
2267
2268   /* clean up buffer now */
2269   gp_session_validatebuffer(p);
2270 }
2271
2272 /* finish off stroke painting operation */
2273 static void gp_paint_cleanup(tGPsdata *p)
2274 {
2275   /* p->gpd==NULL happens when stroke failed to initialize,
2276    * for example when GP is hidden in current space (sergey)
2277    */
2278   if (p->gpd) {
2279     /* finish off a stroke */
2280     gp_paint_strokeend(p);
2281   }
2282
2283   /* "unlock" frame */
2284   if (p->gpf) {
2285     p->gpf->flag &= ~GP_FRAME_PAINT;
2286   }
2287 }
2288
2289 /* ------------------------------- */
2290
2291 /* Helper callback for drawing the cursor itself */
2292 static void gpencil_draw_eraser(bContext *UNUSED(C), int x, int y, void *p_ptr)
2293 {
2294   tGPsdata *p = (tGPsdata *)p_ptr;
2295
2296   if (p->paintmode == GP_PAINTMODE_ERASER) {
2297     GPUVertFormat *format = immVertexFormat();
2298     const uint shdr_pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2299     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2300
2301     GPU_line_smooth(true);
2302     GPU_blend(true);
2303     GPU_blend_set_func_separate(
2304         GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
2305
2306     immUniformColor4ub(255, 100, 100, 20);
2307     imm_draw_circle_fill_2d(shdr_pos, x, y, p->radius, 40);
2308
2309     immUnbindProgram();
2310
2311     immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
2312
2313     float viewport_size[4];
2314     GPU_viewport_size_get_f(viewport_size);
2315     immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
2316
2317     immUniformColor4f(1.0f, 0.39f, 0.39f, 0.78f);
2318     immUniform1i("colors_len", 0); /* "simple" mode */
2319     immUniform1f("dash_width", 12.0f);
2320     immUniform1f("dash_factor", 0.5f);
2321
2322     imm_draw_circle_wire_2d(shdr_pos,
2323                             x,
2324                             y,
2325                             p->radius,
2326                             /* XXX Dashed shader gives bad results with sets of small segments
2327                              * currently, temp hack around the issue. :( */
2328                             max_ii(8, p->radius / 2)); /* was fixed 40 */
2329
2330     immUnbindProgram();
2331
2332     GPU_blend(false);
2333     GPU_line_smooth(false);
2334   }
2335 }
2336
2337 /* Turn brush cursor in 3D view on/off */
2338 static void gpencil_draw_toggle_eraser_cursor(bContext *C, tGPsdata *p, short enable)
2339 {
2340   if (p->erasercursor && !enable) {
2341     /* clear cursor */
2342     WM_paint_cursor_end(CTX_wm_manager(C), p->erasercursor);
2343     p->erasercursor = NULL;
2344   }
2345   else if (enable && !p->erasercursor) {
2346     ED_gpencil_toggle_brush_cursor(p->C, false, NULL);
2347     /* enable cursor */
2348     p->erasercursor = WM_paint_cursor_activate(CTX_wm_manager(C),
2349                                                SPACE_TYPE_ANY,
2350                                                RGN_TYPE_ANY,
2351                                                NULL, /* XXX */
2352                                                gpencil_draw_eraser,
2353                                                p);
2354   }
2355 }
2356
2357 /* Check if tablet eraser is being used (when processing events) */
2358 static bool gpencil_is_tablet_eraser_active(const wmEvent *event)
2359 {
2360   if (event->tablet_data) {
2361     const wmTabletData *wmtab = event->tablet_data;
2362     return (wmtab->Active == EVT_TABLET_ERASER);
2363   }
2364
2365   return false;
2366 }
2367
2368 /* ------------------------------- */
2369
2370 static void gpencil_draw_exit(bContext *C, wmOperator *op)
2371 {
2372   tGPsdata *p = op->customdata;
2373
2374   /* don't assume that operator data exists at all */
2375   if (p) {
2376     /* check size of buffer before cleanup, to determine if anything happened here */
2377     if (p->paintmode == GP_PAINTMODE_ERASER) {
2378       /* turn off radial brush cursor */
2379       gpencil_draw_toggle_eraser_cursor(C, p, false);
2380     }
2381
2382     /* always store the new eraser size to be used again next time
2383      * NOTE: Do this even when not in eraser mode, as eraser may
2384      *       have been toggled at some point.
2385      */
2386     if (p->eraser) {
2387       p->eraser->size = p->radius;
2388     }
2389
2390     /* restore cursor to indicate end of drawing */
2391     if (p->sa->spacetype != SPACE_VIEW3D) {
2392       WM_cursor_modal_restore(CTX_wm_window(C));
2393     }
2394     else {
2395
2396       /* drawing batch cache is dirty now */
2397       bGPdata *gpd = CTX_data_gpencil_data(C);
2398       if (gpd) {
2399         gpd->flag &= ~GP_DATA_STROKE_POLYGON;
2400         gp_update_cache(gpd);
2401       }
2402     }
2403
2404     /* clear undo stack */
2405     gpencil_undo_finish();
2406
2407     /* cleanup */
2408     gp_paint_cleanup(p);
2409     gp_session_cleanup(p);
2410     ED_gpencil_toggle_brush_cursor(C, true, NULL);
2411
2412     /* finally, free the temp data */
2413     gp_session_free(p);
2414     p = NULL;
2415   }
2416
2417   op->customdata = NULL;
2418 }
2419
2420 static void gpencil_draw_cancel(bContext *C, wmOperator *op)
2421 {
2422   /* this is just a wrapper around exit() */
2423   gpencil_draw_exit(C, op);
2424 }
2425
2426 /* ------------------------------- */
2427
2428 static int gpencil_draw_init(bContext *C, wmOperator *op, const wmEvent *event)
2429 {
2430   tGPsdata *p;
2431   eGPencil_PaintModes paintmode = RNA_enum_get(op->ptr, "mode");
2432   ToolSettings *ts = CTX_data_tool_settings(C);
2433   Brush *brush = BKE_paint_brush(&ts->gp_paint->paint);
2434
2435   /* if mode is draw and the brush is eraser, cancel */
2436   if (paintmode != GP_PAINTMODE_ERASER) {
2437     if ((brush) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
2438       return 0;
2439     }
2440   }
2441
2442   /* check context */
2443   p = op->customdata = gp_session_initpaint(C, op);
2444   if ((p == NULL) || (p->status == GP_STATUS_ERROR)) {
2445     /* something wasn't set correctly in context */
2446     gpencil_draw_exit(C, op);
2447     return 0;
2448   }
2449
2450   /* init painting data */
2451   gp_paint_initstroke(p, paintmode, CTX_data_depsgraph(C));
2452   if (p->status == GP_STATUS_ERROR) {
2453     gpencil_draw_exit(C, op);
2454     return 0;
2455   }
2456
2457   if (event != NULL) {
2458     p->keymodifier = event->keymodifier;
2459   }
2460   else {
2461     p->keymodifier = -1;
2462   }
2463
2464   p->reports = op->reports;
2465
2466   /* everything is now setup ok */
2467   return 1;
2468 }
2469
2470 /* ------------------------------- */
2471
2472 /* update UI indicators of status, including cursor and header prints */
2473 static void gpencil_draw_status_indicators(bContext *C, tGPsdata *p)
2474 {
2475   /* header prints */
2476   switch (p->status) {
2477     case GP_STATUS_IDLING: {
2478       /* print status info */
2479       switch (p->paintmode) {
2480         case GP_PAINTMODE_ERASER: {
2481           ED_workspace_status_text(
2482               C,
2483               IFACE_("Grease Pencil Erase Session: Hold and drag LMB or RMB to erase | "
2484                      "ESC/Enter to end  (or click outside this area)"));
2485           break;
2486         }
2487         case GP_PAINTMODE_DRAW_STRAIGHT: {
2488           ED_workspace_status_text(
2489               C,
2490               IFACE_("Grease Pencil Line Session: Hold and drag LMB to draw | "
2491                      "ESC/Enter to end  (or click outside this area)"));
2492           break;
2493         }
2494         case GP_PAINTMODE_SET_CP: {
2495           ED_workspace_status_text(
2496               C,
2497               IFACE_("Grease Pencil Guides: LMB click and release to place reference point | "
2498                      "Esc/RMB to cancel"));
2499           break;
2500         }
2501         case GP_PAINTMODE_DRAW: {
2502           GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2503           if (guide->use_guide) {
2504             ED_workspace_status_text(
2505                 C,
2506                 IFACE_("Grease Pencil Freehand Session: Hold and drag LMB to draw | "
2507                        "M key to flip guide | O key to move reference point"));
2508           }
2509           else {
2510             ED_workspace_status_text(
2511                 C, IFACE_("Grease Pencil Freehand Session: Hold and drag LMB to draw"));
2512           }
2513           break;
2514         }
2515         case GP_PAINTMODE_DRAW_POLY: {
2516           ED_workspace_status_text(
2517               C,
2518               IFACE_("Grease Pencil Poly Session: LMB click to place next stroke vertex | "
2519                      "Release Shift/ESC/Enter to end  (or click outside this area)"));
2520           break;
2521         }
2522         default: /* unhandled future cases */
2523         {
2524           ED_workspace_status_text(
2525               C, IFACE_("Grease Pencil Session: ESC/Enter to end   (or click outside this area)"));
2526           break;
2527         }
2528       }
2529       break;
2530     }
2531     case GP_STATUS_ERROR:
2532     case GP_STATUS_DONE: {
2533       /* clear status string */
2534       ED_workspace_status_text(C, NULL);
2535       break;
2536     }
2537     case GP_STATUS_PAINTING:
2538       break;
2539   }
2540 }
2541
2542 /* ------------------------------- */
2543
2544 /* create a new stroke point at the point indicated by the painting context */
2545 static void gpencil_draw_apply(bContext *C, wmOperator *op, tGPsdata *p, Depsgraph *depsgraph)
2546 {
2547   bGPdata *gpd = p->gpd;
2548   tGPspoint *pt = NULL;
2549
2550   /* handle drawing/erasing -> test for erasing first */
2551   if (p->paintmode == GP_PAINTMODE_ERASER) {
2552     /* do 'live' erasing now */
2553     gp_stroke_doeraser(p);
2554
2555     /* store used values */
2556     copy_v2_v2(p->mvalo, p->mval);
2557     p->opressure = p->pressure;
2558   }
2559   /* Only add current point to buffer if mouse moved
2560    * (even though we got an event, it might be just noise). */
2561   else if (gp_stroke_filtermval(p, p->mval, p->mvalo)) {
2562
2563     /* if lazy mouse, interpolate the last and current mouse positions */
2564     if (GPENCIL_LAZY_MODE(p->brush, p->shift)) {
2565       float now_mouse[2];
2566       float last_mouse[2];
2567       copy_v2_v2(now_mouse, p->mval);
2568       copy_v2_v2(last_mouse, p->mvalo);
2569       interp_v2_v2v2(now_mouse, now_mouse, last_mouse, p->brush->smooth_stroke_factor);
2570       copy_v2_v2(p->mval, now_mouse);
2571     }
2572
2573     /* try to add point */
2574     short ok = gp_stroke_addpoint(p, p->mval, p->pressure, p->curtime);
2575
2576     /* handle errors while adding point */
2577     if ((ok == GP_STROKEADD_FULL) || (ok == GP_STROKEADD_OVERFLOW)) {
2578       /* finish off old stroke */
2579       gp_paint_strokeend(p);
2580       /* And start a new one!!! Else, projection errors! */
2581       gp_paint_initstroke(p, p->paintmode, depsgraph);
2582
2583       /* start a new stroke, starting from previous point */
2584       /* XXX Must manually reset inittime... */
2585       /* XXX We only need to reuse previous point if overflow! */
2586       if (ok == GP_STROKEADD_OVERFLOW) {
2587         p->inittime = p->ocurtime;
2588         gp_stroke_addpoint(p, p->mvalo, p->opressure, p->ocurtime);
2589       }
2590       else {
2591         p->inittime = p->curtime;
2592       }
2593       gp_stroke_addpoint(p, p->mval, p->pressure, p->curtime);
2594     }
2595     else if (ok == GP_STROKEADD_INVALID) {
2596       /* the painting operation cannot continue... */
2597       BKE_report(op->reports, RPT_ERROR, "Cannot paint stroke");
2598       p->status = GP_STATUS_ERROR;
2599
2600       if (G.debug & G_DEBUG) {
2601         printf("Error: Grease-Pencil Paint - Add Point Invalid\n");
2602       }
2603       return;
2604     }
2605
2606     /* store used values */
2607     copy_v2_v2(p->mvalo, p->mval);
2608     p->opressure = p->pressure;
2609     p->ocurtime = p->curtime;
2610
2611     pt = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_size - 1;
2612     if (p->paintmode != GP_PAINTMODE_ERASER) {
2613       ED_gpencil_toggle_brush_cursor(C, true, &pt->x);
2614     }
2615   }
2616   else if ((p->brush->gpencil_settings->flag & GP_BRUSH_STABILIZE_MOUSE_TEMP) &&
2617            (gpd->runtime.sbuffer_size > 0)) {
2618     pt = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_size - 1;
2619     if (p->paintmode != GP_PAINTMODE_ERASER) {
2620       ED_gpencil_toggle_brush_cursor(C, true, &pt->x);
2621     }
2622   }
2623 }
2624
2625 /* Helper to rotate point around origin */
2626 static void gp_rotate_v2_v2v2fl(float v[2],
2627                                 const float p[2],
2628                                 const float origin[2],
2629                                 const float angle)
2630 {
2631   float pt[2];
2632   float r[2];
2633   sub_v2_v2v2(pt, p, origin);
2634   rotate_v2_v2fl(r, pt, angle);
2635   add_v2_v2v2(v, r, origin);
2636 }
2637
2638 /* Helper to snap value to grid */
2639 static float gp_snap_to_grid_fl(float v, const float offset, const float spacing)
2640 {
2641   if (spacing > 0.0f) {
2642     return roundf(v / spacing) * spacing + fmodf(offset, spacing);
2643   }
2644   else {
2645     return v;
2646   }
2647 }
2648
2649 static void UNUSED_FUNCTION(gp_snap_to_grid_v2)(float v[2],
2650                                                 const float offset[2],
2651                                                 const float spacing)
2652 {
2653   v[0] = gp_snap_to_grid_fl(v[0], offset[0], spacing);
2654   v[1] = gp_snap_to_grid_fl(v[1], offset[1], spacing);
2655 }
2656
2657 /* get reference point - screen coords to buffer coords */
2658 static void gp_origin_set(wmOperator *op, const int mval[2])
2659 {
2660   tGPsdata *p = op->customdata;
2661   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2662   float origin[2];
2663   float point[3];
2664   copy_v2fl_v2i(origin, mval);
2665   gp_stroke_convertcoords(p, origin, point, NULL);
2666   if (guide->reference_point == GP_GUIDE_REF_CUSTOM) {
2667     copy_v3_v3(guide->location, point);
2668   }
2669   else if (guide->reference_point == GP_GUIDE_REF_CURSOR) {
2670     copy_v3_v3(p->scene->cursor.location, point);
2671   }
2672 }
2673
2674 /* get reference point - buffer coords to screen coords */
2675 static void gp_origin_get(tGPsdata *p, float origin[2])
2676 {
2677   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2678   float location[3];
2679   if (guide->reference_point == GP_GUIDE_REF_CUSTOM) {
2680     copy_v3_v3(location, guide->location);
2681   }
2682   else if (guide->reference_point == GP_GUIDE_REF_OBJECT && guide->reference_object != NULL) {
2683     copy_v3_v3(location, guide->reference_object->loc);
2684   }
2685   else {
2686     copy_v3_v3(location, p->scene->cursor.location);
2687   }
2688   GP_SpaceConversion *gsc = &p->gsc;
2689   gp_point_3d_to_xy(gsc, p->gpd->runtime.sbuffer_sflag, location, origin);
2690 }
2691
2692 /* handle draw event */
2693 static void gpencil_draw_apply_event(
2694     bContext *C, wmOperator *op, const wmEvent *event, Depsgraph *depsgraph, float x, float y)
2695 {
2696   tGPsdata *p = op->customdata;
2697   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2698   PointerRNA itemptr;
2699   float mousef[2];
2700   int tablet = 0;
2701   bool is_speed_guide = ((guide->use_guide) &&
2702                          (p->brush && (p->brush->gpencil_tool == GPAINT_TOOL_DRAW)));
2703
2704   /* convert from window-space to area-space mouse coordinates
2705    * add any x,y override position for fake events
2706    */
2707   p->mval[0] = (float)event->mval[0] - x;
2708   p->mval[1] = (float)event->mval[1] - y;
2709   p->shift = event->shift;
2710
2711   /* verify direction for straight lines */
2712   if ((is_speed_guide) ||
2713       ((event->alt > 0) && (RNA_boolean_get(op->ptr, "disable_straight") == false))) {
2714     if (p->straight == 0) {
2715       int dx = (int)fabsf(p->mval[0] - p->mvali[0]);
2716       int dy = (int)fabsf(p->mval[1] - p->mvali[1]);
2717       if ((dx > 0) || (dy > 0)) {
2718         /* store mouse direction */
2719         if (dx > dy) {
2720           p->straight = STROKE_HORIZONTAL;
2721         }
2722         else if (dx < dy) {
2723           p->straight = STROKE_VERTICAL;
2724         }
2725       }
2726     }
2727   }
2728
2729   p->curtime = PIL_check_seconds_timer();
2730
2731   /* handle pressure sensitivity (which is supplied by tablets) */
2732   if (event->tablet_data) {
2733     const wmTabletData *wmtab = event->tablet_data;
2734
2735     tablet = (wmtab->Active != EVT_TABLET_NONE);
2736     p->pressure = wmtab->Pressure;
2737
2738     /* Hack for pressure sensitive eraser on D+RMB when using a tablet:
2739      * The pen has to float over the tablet surface, resulting in
2740      * zero pressure (T47101). Ignore pressure values if floating
2741      * (i.e. "effectively zero" pressure), and only when the "active"
2742      * end is the stylus (i.e. the default when not eraser)
2743      */
2744     if (p->paintmode == GP_PAINTMODE_ERASER) {
2745       if ((wmtab->Active != EVT_TABLET_ERASER) && (p->pressure < 0.001f)) {
2746         p->pressure = 1.0f;
2747       }
2748     }
2749   }
2750   else {
2751     /* No tablet data -> No pressure info is available */
2752     p->pressure = 1.0f;
2753   }
2754
2755   /* special eraser modes */
2756   if (p->paintmode == GP_PAINTMODE_ERASER) {
2757     if (event->shift > 0) {
2758       p->flags |= GP_PAINTFLAG_HARD_ERASER;
2759     }
2760     else {
2761       p->flags &= ~GP_PAINTFLAG_HARD_ERASER;
2762     }
2763     if (event->alt > 0) {
2764       p->flags |= GP_PAINTFLAG_STROKE_ERASER;
2765     }
2766     else {
2767       p->flags &= ~GP_PAINTFLAG_STROKE_ERASER;
2768     }
2769   }
2770
2771   /* special exception for start of strokes (i.e. maybe for just a dot) */
2772   if (p->flags & GP_PAINTFLAG_FIRSTRUN) {
2773     p->flags &= ~GP_PAINTFLAG_FIRSTRUN;
2774
2775     /* set values */
2776     copy_v2_v2(p->mvalo, p->mval);
2777     p->opressure = p->pressure;
2778     p->inittime = p->ocurtime = p->curtime;
2779     p->straight = 0;
2780
2781     /* save initial mouse */
2782     copy_v2_v2(p->mvali, p->mval);
2783
2784     /* calculate once and store snapping distance and origin */
2785     RegionView3D *rv3d = p->ar->regiondata;
2786     float scale = 1.0f;
2787     if (rv3d->is_persp) {
2788       float vec[3];
2789       gp_get_3d_reference(p, vec);
2790       mul_m4_v3(rv3d->persmat, vec);
2791       scale = vec[2] * rv3d->pixsize;
2792     }
2793     else {
2794       scale = rv3d->pixsize;
2795     }
2796     p->guide_spacing = guide->spacing / scale;
2797     p->half_spacing = p->guide_spacing * 0.5f;
2798     gp_origin_get(p, p->origin);
2799
2800     /* special exception here for too high pressure values on first touch in
2801      * windows for some tablets, then we just skip first touch...
2802      */
2803     if (tablet && (p->pressure >= 0.99f)) {
2804       return;
2805     }
2806
2807     /* special exception for grid snapping
2808      * it requires direction which needs at least two points
2809      */
2810     if (!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP) && is_speed_guide &&
2811         guide->use_snapping && (guide->type == GP_GUIDE_GRID)) {
2812       p->flags |= GP_PAINTFLAG_REQ_VECTOR;
2813     }
2814   }
2815
2816   /* wait for vector then add initial point */
2817   if (p->flags & GP_PAINTFLAG_REQ_VECTOR) {
2818     if (p->straight == 0) {
2819       return;
2820     }
2821
2822     p->flags &= ~GP_PAINTFLAG_REQ_VECTOR;
2823
2824     /* create fake events */
2825     float tmp[2];
2826     float pt[2];
2827     copy_v2_v2(tmp, p->mval);
2828     sub_v2_v2v2(pt, p->mval, p->mvali);
2829     gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph(C), pt[0], pt[1]);
2830     if (len_v2v2(p->mval, p->mvalo)) {
2831       sub_v2_v2v2(pt, p->mval, p->mvalo);
2832       gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph(C), pt[0], pt[1]);
2833     }
2834     copy_v2_v2(p->mval, tmp);
2835   }
2836
2837   /* check if stroke is straight or guided */
2838   if ((p->paintmode != GP_PAINTMODE_ERASER) && ((p->straight) || (is_speed_guide))) {
2839     /* guided stroke */
2840     if (is_speed_guide) {
2841       switch (guide->type) {
2842         default:
2843         case GP_GUIDE_CIRCULAR: {
2844           float distance;
2845           distance = len_v2v2(p->mvali, p->origin);
2846
2847           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2848             distance = gp_snap_to_grid_fl(distance, 0.0f, p->guide_spacing);
2849           }
2850
2851           dist_ensure_v2_v2fl(p->mval, p->origin, distance);
2852           break;
2853         }
2854         case GP_GUIDE_RADIAL: {
2855           if (guide->use_snapping && (guide->angle_snap > 0.0f)) {
2856             float point[2];
2857             float xy[2];
2858             float angle;
2859             float half_angle = guide->angle_snap * 0.5f;
2860             sub_v2_v2v2(xy, p->mvali, p->origin);
2861             angle = atan2f(xy[1], xy[0]);
2862             angle += (M_PI * 2.0f);
2863             angle = fmodf(angle + half_angle, guide->angle_snap);
2864             angle -= half_angle;
2865             gp_rotate_v2_v2v2fl(point, p->mvali, p->origin, -angle);
2866             closest_to_line_v2(p->mval, p->mval, point, p->origin);
2867           }
2868           else {
2869             closest_to_line_v2(p->mval, p->mval, p->mvali, p->origin);
2870           }
2871           break;
2872         }
2873         case GP_GUIDE_PARALLEL: {
2874           float point[2];
2875           float unit[2];
2876           copy_v2_v2(unit, p->mvali);
2877           unit[0] += 1.0f; /* start from horizontal */
2878           gp_rotate_v2_v2v2fl(point, unit, p->mvali, guide->angle);
2879           closest_to_line_v2(p->mval, p->mval, p->mvali, point);
2880
2881           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2882             gp_rotate_v2_v2v2fl(p->mval, p->mval, p->origin, -guide->angle);
2883             p->mval[1] = gp_snap_to_grid_fl(
2884                 p->mval[1] - p->half_spacing, p->origin[1], p->guide_spacing);
2885             gp_rotate_v2_v2v2fl(p->mval, p->mval, p->origin, guide->angle);
2886           }
2887           break;
2888         }
2889         case GP_GUIDE_GRID: {
2890           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2891             float point[2];
2892             float unit[2];
2893             float angle;
2894             copy_v2_v2(unit, p->mvali);
2895             unit[0] += 1.0f; /* start from horizontal */
2896             angle = (p->straight == STROKE_VERTICAL) ? M_PI_2 : 0.0f;
2897             gp_rotate_v2_v2v2fl(point, unit, p->mvali, angle);
2898             closest_to_line_v2(p->mval, p->mval, p->mvali, point);
2899
2900             if (p->straight == STROKE_HORIZONTAL) {
2901               p->mval[1] = gp_snap_to_grid_fl(
2902                   p->mval[1] - p->half_spacing, p->origin[1], p->guide_spacing);
2903             }
2904             else {
2905               p->mval[0] = gp_snap_to_grid_fl(
2906                   p->mval[0] - p->half_spacing, p->origin[0], p->guide_spacing);
2907             }
2908           }
2909           else if (p->straight == STROKE_HORIZONTAL) {
2910             p->mval[1] = p->mvali[1]; /* replace y */
2911           }
2912           else {
2913             p->mval[0] = p->mvali[0]; /* replace x */
2914           }
2915           break;
2916         }
2917       }
2918     }
2919     else if (p->straight == STROKE_HORIZONTAL) {
2920       p->mval[1] = p->mvali[1]; /* replace y */
2921     }
2922     else {
2923       p->mval[0] = p->mvali[0]; /* replace x */
2924     }
2925   }
2926
2927   /* fill in stroke data (not actually used directly by gpencil_draw_apply) */
2928   RNA_collection_add(op->ptr, "stroke", &itemptr);
2929
2930   mousef[0] = p->mval[0];
2931   mousef[1] = p->mval[1];
2932   RNA_float_set_array(&itemptr, "mouse", mousef);
2933   RNA_float_set(&itemptr, "pressure", p->pressure);
2934   RNA_boolean_set(&itemptr, "is_start", (p->flags & GP_PAINTFLAG_FIRSTRUN) != 0);
2935
2936   RNA_float_set(&itemptr, "time", p->curtime - p->inittime);
2937
2938   /* apply the current latest drawing point */
2939   gpencil_draw_apply(C, op, p, depsgraph);
2940
2941   /* force refresh */
2942   /* just active area for now, since doing whole screen is too slow */
2943   ED_region_tag_redraw(p->ar);
2944 }
2945
2946 /* ------------------------------- */
2947
2948 /* operator 'redo' (i.e. after changing some properties, but also for repeat last) */
2949 static int gpencil_draw_exec(bContext *C, wmOperator *op)
2950 {
2951   tGPsdata *p = NULL;
2952   Depsgraph *depsgraph = CTX_data_depsgraph(C);
2953
2954   /* printf("GPencil - Starting Re-Drawing\n"); */
2955
2956   /* try to initialize context data needed while drawing */
2957   if (!gpencil_draw_init(C, op, NULL)) {
2958     MEM_SAFE_FREE(op->customdata);
2959     /* printf("\tGP - no valid data\n"); */
2960     return OPERATOR_CANCELLED;
2961   }
2962   else {
2963     p = op->customdata;
2964   }
2965
2966   /* printf("\tGP - Start redrawing stroke\n"); */
2967
2968   /* loop over the stroke RNA elements recorded (i.e. progress of mouse movement),
2969    * setting the relevant values in context at each step, then applying
2970    */
2971   RNA_BEGIN (op->ptr, itemptr, "stroke") {
2972     float mousef[2];
2973
2974     /* printf("\t\tGP - stroke elem\n"); */
2975
2976     /* get relevant data for this point from stroke */
2977     RNA_float_get_array(&itemptr, "mouse", mousef);
2978     p->mval[0] = mousef[0];
2979     p->mval[1] = mousef[1];
2980     p->pressure = RNA_float_get(&itemptr, "pressure");
2981     p->curtime = (double)RNA_float_get(&itemptr, "time") + p->inittime;
2982
2983     if (RNA_boolean_get(&itemptr, "is_start")) {
2984       /* if first-run flag isn't set already (i.e. not true first stroke),
2985        * then we must terminate the previous one first before continuing
2986        */
2987       if ((p->flags & GP_PAINTFLAG_FIRSTRUN) == 0) {
2988         /* TODO: both of these ops can set error-status, but we probably don't need to worry */
2989         gp_paint_strokeend(p);
2990         gp_paint_initstroke(p, p->paintmode, depsgraph);
2991       }
2992     }
2993
2994     /* if first run, set previous data too */
2995     if (p->flags & GP_PAINTFLAG_FIRSTRUN) {
2996       p->flags &= ~GP_PAINTFLAG_FIRSTRUN;
2997
2998       p->mvalo[0] = p->mval[0];
2999       p->mvalo[1] = p->mval[1];
3000       p->opressure = p->pressure;
3001       p->ocurtime = p->curtime;
3002     }
3003
3004     /* apply this data as necessary now (as per usual) */
3005     gpencil_draw_apply(C, op, p, depsgraph);
3006   }
3007   RNA_END;
3008
3009   /* printf("\tGP - done\n"); */
3010
3011   /* cleanup */
3012   gpencil_draw_exit(C, op);
3013
3014   /* refreshes */
3015   WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3016
3017   /* done */
3018   return OPERATOR_FINISHED;
3019 }
3020
3021 /* ------------------------------- */
3022
3023 /* handle events for guides */
3024 static void gpencil_guide_event_handling(bContext *C,
3025                                          wmOperator *op,
3026                                          const wmEvent *event,
3027                                          tGPsdata *p)
3028 {
3029   bool add_notifier = false;
3030   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
3031
3032   /* Enter or exit set center point mode */
3033   if ((event->type == OKEY) && (event->val == KM_RELEASE)) {
3034     if (p->paintmode == GP_PAINTMODE_DRAW && guide->reference_point != GP_GUIDE_REF_OBJECT) {
3035       add_notifier = true;
3036       p->paintmode = GP_PAINTMODE_SET_CP;
3037       ED_gpencil_toggle_brush_cursor(C, false, NULL);
3038     }
3039   }
3040   /* Freehand mode, turn off speed guide */
3041   else if ((event->type == VKEY) && (event->val == KM_RELEASE)) {
3042     guide->use_guide = false;
3043     add_notifier = true;
3044   }
3045   /* Alternate or flip direction */
3046   else if ((event->type == MKEY) && (event->val == KM_RELEASE)) {
3047     if (guide->type == GP_GUIDE_CIRCULAR) {
3048       add_notifier = true;
3049       guide->type = GP_GUIDE_RADIAL;
3050     }
3051     else if (guide->type == GP_GUIDE_RADIAL) {
3052       add_notifier = true;
3053       guide->type = GP_GUIDE_CIRCULAR;
3054     }
3055     else if (guide->type == GP_GUIDE_PARALLEL) {
3056       add_notifier = true;
3057       guide->angle += M_PI_2;
3058       guide->angle = angle_compat_rad(guide->angle, M_PI);
3059     }
3060     else {
3061       add_notifier = false;
3062     }
3063   }
3064   /* Line guides */
3065   else if ((event->type == LKEY) && (event->val == KM_RELEASE)) {
3066     add_notifier = true;
3067     guide->use_guide = true;
3068     if (event->ctrl) {
3069       guide->angle = 0.0f;
3070       guide->type = GP_GUIDE_PARALLEL;
3071     }
3072     else if (event->alt) {
3073       guide->type = GP_GUIDE_PARALLEL;
3074       guide->angle = RNA_float_get(op->ptr, "guide_last_angle");
3075     }
3076     else {
3077       guide->type = GP_GUIDE_PARALLEL;
3078     }
3079   }
3080   /* Point guide */
3081   else if ((event->type == CKEY) && (event->val == KM_RELEASE)) {
3082     add_notifier = true;
3083     if (!guide->use_guide) {
3084       guide->use_guide = true;
3085       guide->type = GP_GUIDE_CIRCULAR;
3086     }
3087     else if (guide->type == GP_GUIDE_CIRCULAR) {
3088       guide->type = GP_GUIDE_RADIAL;
3089     }
3090     else if (guide->type == GP_GUIDE_RADIAL) {
3091       guide->type = GP_GUIDE_CIRCULAR;
3092     }
3093     else {
3094       guide->type = GP_GUIDE_CIRCULAR;
3095     }
3096   }
3097   /* Change line angle  */
3098   else if (ELEM(event->type, JKEY, KKEY) && (event->val == KM_RELEASE)) {
3099     add_notifier = true;
3100     float angle = guide->angle;
3101     float adjust = (float)M_PI / 180.0f;
3102     if (event->alt) {
3103       adjust *= 45.0f;
3104     }
3105     else if (!event->shift) {
3106       adjust *= 15.0f;
3107     }
3108     angle += (event->type == JKEY) ? adjust : -adjust;
3109     angle = angle_compat_rad(angle, M_PI);
3110     guide->angle = angle;
3111   }
3112
3113   if (add_notifier) {
3114     WM_event_add_notifier(C, NC_SCENE | ND_TOOLSETTINGS | NC_GPENCIL | NA_EDITED, NULL);
3115   }
3116 }
3117
3118 /* start of interactive drawing part of operator */
3119 static int gpencil_draw_invoke(bContext *C, wmOperator *op, const wmEvent *event)
3120 {
3121   tGPsdata *p = NULL;
3122   Object *ob = CTX_data_active_object(C);
3123   bGPdata *gpd = (bGPdata *)ob->data;
3124
3125   if (G.debug & G_DEBUG) {
3126     printf("GPencil - Starting Drawing\n");
3127   }
3128
3129   /* support for tablets eraser pen */
3130   if (gpencil_is_tablet_eraser_active(event)) {
3131     RNA_enum_set(op->ptr, "mode", GP_PAINTMODE_ERASER);
3132   }
3133
3134   /* do not draw in locked or invisible layers */
3135   eGPencil_PaintModes paintmode = RNA_enum_get(op->ptr, "mode");
3136   if (paintmode != GP_PAINTMODE_ERASER) {
3137     bGPDlayer *gpl = CTX_data_active_gpencil_layer(C);
3138     if ((gpl) && ((gpl->flag & GP_LAYER_LOCKED) || (gpl->flag & GP_LAYER_HIDE))) {
3139       BKE_report(op->reports, RPT_ERROR, "Active layer is locked or hide");
3140       return OPERATOR_CANCELLED;
3141     }
3142   }
3143   else {
3144     /* don't erase empty frames */
3145     bool has_layer_to_erase = false;
3146     for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
3147       /* Skip if layer not editable */
3148       if (gpencil_layer_is_editable(gpl)) {
3149         if (gpl->actframe && gpl->actframe->strokes.first) {
3150           has_layer_to_erase = true;
3151           break;
3152         }
3153       }
3154     }
3155     if (!has_layer_to_erase) {
3156       BKE_report(op->reports, RPT_ERROR, "Nothing to erase or all layers locked");
3157       return OPERATOR_FINISHED;
3158     }
3159   }
3160
3161   /* try to initialize context data needed while drawing */
3162   if (!gpencil_draw_init(C, op, event)) {
3163     if (op->customdata) {
3164       MEM_freeN(op->customdata);
3165     }
3166     if (G.debug & G_DEBUG) {
3167       printf("\tGP - no valid data\n");
3168     }
3169     return OPERATOR_CANCELLED;
3170   }
3171   else {
3172     p = op->customdata;
3173   }
3174
3175   /* TODO: set any additional settings that we can take from the events?
3176    * TODO? if tablet is erasing, force eraser to be on? */
3177
3178   /* TODO: move cursor setting stuff to stroke-start so that paintmode can be changed midway... */
3179
3180   /* if eraser is on, draw radial aid */
3181   if (p->paintmode == GP_PAINTMODE_ERASER) {
3182     gpencil_draw_toggle_eraser_cursor(C, p, true);
3183   }
3184   else {
3185     ED_gpencil_toggle_brush_cursor(C, true, NULL);
3186   }
3187
3188   /* only start drawing immediately if we're allowed to do so... */
3189   if (RNA_boolean_get(op->ptr, "wait_for_input") == false) {
3190     /* hotkey invoked - start drawing */
3191     /* printf("\tGP - set first spot\n"); */
3192     p->status = GP_STATUS_PAINTING;
3193
3194     /* handle the initial drawing - i.e. for just doing a simple dot */
3195     gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph(C), 0.0f, 0.0f);
3196     op->flag |= OP_IS_MODAL_CURSOR_REGION;
3197   }
3198   else {
3199     /* toolbar invoked - don't start drawing yet... */
3200     /* printf("\tGP - hotkey invoked... waiting for click-drag\n"); */
3201     op->flag |= OP_IS_MODAL_CURSOR_REGION;
3202   }
3203
3204   /* enable paint mode */
3205   /* handle speed guide events before drawing inside view3d */
3206   if (!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP)) {
3207     gpencil_guide_event_handling(C, op, event, p);
3208   }
3209
3210   if (ob && (ob->type == OB_GPENCIL) && ((p->gpd->flag & GP_DATA_STROKE_PAINTMODE) == 0)) {
3211     /* FIXME: use the mode switching operator, this misses notifiers, messages. */
3212     /* Just set paintmode flag... */
3213     p->gpd->flag |= GP_DATA_STROKE_PAINTMODE;
3214     /* disable other GP modes */
3215     p->gpd->flag &= ~GP_DATA_STROKE_EDITMODE;
3216     p->gpd->flag &= ~GP_DATA_STROKE_SCULPTMODE;
3217     p->gpd->flag &= ~GP_DATA_STROKE_WEIGHTMODE;
3218     /* set workspace mode */
3219     ob->restore_mode = ob->mode;
3220     ob->mode = OB_MODE_PAINT_GPENCIL;
3221     /* redraw mode on screen */
3222     WM_event_add_notifier(C, NC_SCENE | ND_MODE, NULL);
3223   }
3224
3225   WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3226
3227   /* add a modal handler for this operator, so that we can then draw continuous strokes */
3228   WM_event_add_modal_handler(C, op);
3229
3230   return OPERATOR_RUNNING_MODAL;
3231 }
3232
3233 /* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */
3234 static bool gpencil_area_exists(bContext *C, ScrArea *sa_test)
3235 {
3236   bScreen *sc = CTX_wm_screen(C);
3237   return (BLI_findindex(&sc->areabase, sa_test) != -1);
3238 }
3239
3240 static tGPsdata *gpencil_stroke_begin(bContext *C, wmOperator *op)
3241 {
3242   tGPsdata *p = op->customdata;
3243
3244   /* we must check that we're still within the area that we're set up to work from
3245    * otherwise we could crash (see bug #20586)
3246    */
3247   if (CTX_wm_area(C) != p->sa) {
3248     printf("\t\t\tGP - wrong area execution abort!\n");
3249     p->status = GP_STATUS_ERROR;
3250   }
3251
3252   /* printf("\t\tGP - start stroke\n"); */
3253
3254   /* we may need to set up paint env again if we're resuming */
3255   /* XXX: watch it with the paintmode! in future,
3256    *      it'd be nice to allow changing paint-mode when in sketching-sessions */
3257
3258   if (gp_session_initdata(C, op, p)) {
3259     gp_paint_initstroke(p, p->paintmode, CTX_data_depsgraph(C));
3260   }
3261
3262   if (p->status != GP_STATUS_ERROR) {
3263     p->status = GP_STATUS_PAINTING;
3264     op->flag &= ~OP_IS_MODAL_CURSOR_REGION;
3265   }
3266
3267   return op->customdata;
3268 }
3269
3270 static void gpencil_stroke_end(wmOperator *op)
3271 {
3272   tGPsdata *p = op->customdata;
3273
3274   gp_paint_cleanup(p);
3275
3276   gpencil_undo_push(p->gpd);
3277
3278   gp_session_cleanup(p);
3279
3280   p->status = GP_STATUS_IDLING;
3281   op->flag |= OP_IS_MODAL_CURSOR_REGION;
3282
3283   p->gpd = NULL;
3284   p->gpl = NULL;
3285   p->gpf = NULL;
3286 }
3287
3288 /* Move last stroke in the listbase to the head
3289  * to be drawn below all previous strokes in the layer. */
3290 static void gpencil_move_last_stroke_to_back(bContext *C)
3291 {
3292   /* Move last stroke (the polygon) to head of the listbase stroke
3293    * to draw on back of all previous strokes. */
3294   bGPdata *gpd = ED_gpencil_data_get_active(C);
3295   bGPDlayer *gpl = BKE_gpencil_layer_getactive(gpd);
3296
3297   /* sanity checks */
3298   if (ELEM(NULL, gpd, gpl, gpl->actframe)) {
3299     return;
3300   }
3301
3302   bGPDframe *gpf = gpl->actframe;
3303   bGPDstroke *gps = gpf->strokes.last;
3304   if (ELEM(NULL, gps)) {
3305     return;
3306   }
3307
3308   BLI_remlink(&gpf->strokes, gps);
3309   BLI_insertlinkbefore(&gpf->strokes, gpf->strokes.first, gps);
3310 }
3311
3312 /* add events for missing mouse movements when the artist draw very fast */
3313 static void gpencil_add_missing_events(bContext *C,
3314                                        wmOperator *op,
3315                                        const wmEvent *event,
3316                                        tGPsdata *p)
3317 {
3318   Brush *brush = p->brush;
3319   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
3320   int input_samples = brush->gpencil_settings->input_samples;
3321
3322   /* ensure sampling when using circular guide */
3323   if (guide->use_guide && (guide->type == GP_GUIDE_CIRCULAR)) {
3324     input_samples = GP_MAX_INPUT_SAMPLES;
3325   }
3326
3327   if (input_samples == 0) {
3328     return;
3329   }
3330
3331   RegionView3D *rv3d = p->ar->regiondata;
3332   float defaultpixsize = rv3d->pixsize * 1000.0f;
3333   int samples = (GP_MAX_INPUT_SAMPLES - input_samples + 1);
3334   float thickness = (float)brush->size;
3335
3336   float pt[2], a[2], b[2];
3337   float vec[3];
3338   float scale = 1.0f;
3339
3340   /* get pixel scale */
3341   gp_get_3d_reference(p, vec);
3342   mul_m4_v3(rv3d->persmat, vec);
3343   if (rv3d->is_persp) {
3344     scale = vec[2] * defaultpixsize;
3345   }
3346   else {
3347     scale = defaultpixsize;
3348   }
3349
3350   /* The thickness of the brush is reduced of thickness to get overlap dots */
3351   float dot_factor = 0.50f;
3352   if (samples < 2) {
3353     dot_factor = 0.05f;
3354   }
3355   else if (samples < 4) {
3356     dot_factor = 0.10f;
3357   }
3358   else if (samples < 7) {
3359     dot_factor = 0.3f;
3360   }
3361   else if (samples < 10) {
3362     dot_factor = 0.4f;
3363   }
3364   float factor = ((thickness * dot_factor) / scale) * samples;
3365
3366   copy_v2_v2(a, p->mvalo);
3367   b[0] = (float)event->mval[0] + 1.0f;
3368   b[1] = (float)event->mval[1] + 1.0f;
3369
3370   /* get distance in pixels */
3371   float dist = len_v2v2(a, b);
3372
3373   /* for very small distances, add a half way point */
3374   if (dist <= 2.0f) {
3375     interp_v2_v2v2(pt, a, b, 0.5f);
3376     sub_v2_v2v2(pt, b, pt);
3377     /* create fake event */
3378     gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph(C), pt[0], pt[1]);
3379   }
3380   else if (dist >= factor) {
3381     int slices = 2 + (int)((dist - 1.0) / factor);
3382     float n = 1.0f / slices;
3383     for (int i = 1; i < slices; i++) {
3384       interp_v2_v2v2(pt, a, b, n * i);
3385       sub_v2_v2v2(pt, b, pt);
3386       /* create fake event */
3387       gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph(C), pt[0], pt[1]);
3388     }
3389   }
3390 }
3391
3392 /* events handling during interactive drawing part of operator */
3393 static int gpencil_draw_modal(bContext *C, wmOperator *op, const wmEvent *event)
3394 {
3395   tGPsdata *p = op->customdata;
3396   ToolSettings *ts = CTX_data_tool_settings(C);
3397   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
3398   /* default exit state - pass through to support MMB view nav, etc. */
3399   int estate = OPERATOR_PASS_THROUGH;
3400
3401   /* if (event->type == NDOF_MOTION)
3402    *    return OPERATOR_PASS_THROUGH;
3403    * -------------------------------
3404    * [mce] Not quite what I was looking
3405    * for, but a good start! GP continues to
3406    * draw on the screen while the 3D mouse
3407    * moves the viewpoint. Problem is that
3408    * the stroke is converted to 3D only after
3409    * it is finished. This approach should work
3410    * better in tools that immediately apply
3411    * in 3D space.
3412    */
3413
3414   if (p->status == GP_STATUS_IDLING) {
3415     ARegion *ar = CTX_wm_region(C);
3416     p->ar = ar;
3417   }
3418
3419   /* special mode for editing control points */
3420   if (p->paintmode == GP_PAINTMODE_SET_CP) {
3421     wmWindow *win = p->win;
3422     WM_cursor_modal_set(win, BC_NSEW_SCROLLCURSOR);
3423     bool drawmode = false;
3424
3425     switch (event->type) {
3426       /* cancel */
3427       case ESCKEY:
3428       case RIGHTMOUSE: {
3429         if (ELEM(event->val, KM_RELEASE)) {
3430           drawmode = true;
3431         }
3432         break;
3433       }
3434       /* set */
3435       case LEFTMOUSE: {
3436         if (ELEM(event->val, KM_RELEASE)) {
3437           gp_origin_set(op, event->mval);
3438           drawmode = true;
3439         }
3440         break;
3441       }
3442     }
3443     if (drawmode) {
3444       p->status = GP_STATUS_IDLING;
3445       p->paintmode = GP_PAINTMODE_DRAW;
3446       ED_gpencil_toggle_brush_cursor(C, true, NULL);
3447       DEG_id_tag_update(&p->scene->id, ID_RECALC_COPY_ON_WRITE);
3448     }
3449     else {
3450       return OPERATOR_RUNNING_MODAL;
3451     }
3452   }
3453
3454   /* We don't pass on key events, GP is used with key-modifiers -
3455    * prevents Dkey to insert drivers. */
3456   if (ISKEYBOARD(event->type)) {
3457     if (ELEM(event->type, LEFTARROWKEY, DOWNARROWKEY, RIGHTARROWKEY, UPARROWKEY, ZKEY)) {
3458       /* allow some keys:
3459        *   - for frame changing [#33412]
3460        *   - for undo (during sketching sessions)
3461        */
3462     }
3463     else if (ELEM(event->type, PAD0, PAD1, PAD2, PAD3, PAD4, PAD5, PAD6, PAD7, PAD8, PAD9)) {
3464       /* allow numpad keys so that camera/view manipulations can still take place
3465        * - PAD0 in particular is really important for Grease Pencil drawing,
3466        *   as animators may be working "to camera", so having this working
3467        *   is essential for ensuring that they can quickly return to that view
3468        */
3469     }
3470     else if ((event->type == BKEY) && (event->val == KM_RELEASE)) {
3471       /* Add Blank Frame
3472        * - Since this operator is non-modal, we can just call it here, and keep going...
3473        * - This operator is especially useful when animating
3474        */
3475       WM_operator_name_call(C, "GPENCIL_OT_blank_frame_add", WM_OP_EXEC_DEFAULT, NULL);
3476       estate = OPERATOR_RUNNING_MODAL;
3477     }
3478     else if ((!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP))) {
3479       gpencil_guide_event_handling(C, op, event, p);
3480       estate = OPERATOR_RUNNING_MODAL;
3481     }
3482     else {
3483       estate = OPERATOR_RUNNING_MODAL;
3484     }
3485   }
3486
3487   // printf("\tGP - handle modal event...\n");
3488
3489   /* Exit painting mode (and/or end current stroke).
3490    *
3491    * NOTE: cannot do RIGHTMOUSE (as is standard for canceling)
3492    * as that would break polyline T32647.
3493    */
3494   /* if polyline and release shift must cancel */
3495   if ((ELEM(event->type, RETKEY, PADENTER, ESCKEY, SPACEKEY, EKEY)) ||
3496       ((p->paintmode == GP_PAINTMODE_DRAW_POLY) && (event->shift == 0))) {
3497     /* exit() ends the current stroke before cleaning up */
3498     /* printf("\t\tGP - end of paint op + end of stroke\n"); */
3499     /* if drawing polygon and enable on back, must move stroke */
3500     if (ts) {
3501       if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
3502           (p->paintmode == GP_PAINTMODE_DRAW_POLY)) {
3503         if (p->flags & GP_PAINTFLAG_STROKEADDED) {
3504           gpencil_move_last_stroke_to_back(C);
3505         }
3506       }
3507     }
3508
3509     p->status = GP_STATUS_DONE;
3510     estate = OPERATOR_FINISHED;
3511   }
3512
3513   /* toggle painting mode upon mouse-button movement
3514    * - LEFTMOUSE  = standard drawing (all) / straight line drawing (all) / polyline (toolbox only)
3515    * - RIGHTMOUSE = polyline (hotkey) / eraser (all)
3516    *   (Disabling RIGHTMOUSE case here results in bugs like [#32647])
3517    * also making sure we have a valid event value, to not exit too early
3518    */
3519   if (ELEM(event->type, LEFTMOUSE, RIGHTMOUSE) && (ELEM(event->val, KM_PRESS, KM_RELEASE))) {
3520     /* if painting, end stroke */
3521     if (p->status == GP_STATUS_PAINTING) {
3522       int sketch = 0;
3523
3524       /* basically, this should be mouse-button up = end stroke
3525        * BUT, polyline drawing is an exception -- all knots should be added during one session
3526        */
3527       sketch |= (p->paintmode == GP_PAINTMODE_DRAW_POLY);
3528
3529       if (sketch) {
3530         /* end stroke only, and then wait to resume painting soon */
3531         /* printf("\t\tGP - end stroke only\n"); */
3532         gpencil_stroke_end(op);
3533
3534         /* If eraser mode is on, turn it off after the stroke finishes
3535          * NOTE: This just makes it nicer to work with drawing sessions
3536          */
3537         if (p->paintmode == GP_PAINTMODE_ERASER) {
3538           p->paintmode = RNA_enum_get(op->ptr, "mode");
3539
3540           /* if the original mode was *still* eraser,
3541            * we'll let it say for now, since this gives
3542            * users an opportunity to have visual feedback
3543            * when adjusting eraser size
3544            */
3545           if (p->paintmode != GP_PAINTMODE_ERASER) {
3546             /* turn off cursor...
3547              * NOTE: this should be enough for now
3548              *       Just hiding this makes it seem like
3549              *       you can paint again...
3550              */
3551             gpencil_draw_toggle_eraser_cursor(C, p, false);
3552           }
3553         }
3554
3555         /* we've just entered idling state, so this event was processed (but no others yet) */
3556         estate = OPERATOR_RUNNING_MODAL;
3557
3558         /* stroke could be smoothed, send notifier to refresh screen */
3559         WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3560       }
3561       else {
3562         /* printf("\t\tGP - end of stroke + op\n"); */
3563         /* if drawing polygon and enable on back, must move stroke */
3564         if (ts) {
3565           if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
3566               (p->paintmode == GP_PAINTMODE_DRAW_POLY)) {
3567             if (p->flags & GP_PAINTFLAG_STROKEADDED) {
3568               gpencil_move_last_stroke_to_back(C);
3569             }
3570           }
3571         }
3572         /* drawing batch cache is dirty now */
3573         gp_update_cache(p->gpd);
3574
3575         p->status = GP_STATUS_DONE;
3576         estate = OPERATOR_FINISHED;
3577       }
3578     }
3579     else if (event->val == KM_PRESS) {
3580       bool in_bounds = false;