GPencil: Fix unreported unable to deselect when masking is OFF
[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_used == 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 / 1000.0f));
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 = BKE_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_used > 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_used == 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_used >= 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   const short num_points = gpd->runtime.sbuffer_used;
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   const float steps = (idx < 4) ? 3.0f : 4.0f;
575
576   tGPspoint *pta = idx >= 4 ? &points[idx - 4] : NULL;
577   tGPspoint *ptb = idx >= 3 ? &points[idx - 3] : NULL;
578   tGPspoint *ptc = idx >= 2 ? &points[idx - 2] : NULL;
579   tGPspoint *ptd = &points[idx - 1];
580
581   float sco[2] = {0.0f};
582   float a[2], b[2], c[2], d[2];
583   float pressure = 0.0f;
584   const float average_fac = 1.0f / steps;
585
586   /* Compute smoothed coordinate by taking the ones nearby */
587   if (pta) {
588     copy_v2_v2(a, &pta->x);
589     madd_v2_v2fl(sco, a, average_fac);
590     pressure += pta->pressure * average_fac;
591   }
592   if (ptb) {
593     copy_v2_v2(b, &ptb->x);
594     madd_v2_v2fl(sco, b, average_fac);
595     pressure += ptb->pressure * average_fac;
596   }
597   if (ptc) {
598     copy_v2_v2(c, &ptc->x);
599     madd_v2_v2fl(sco, c, average_fac);
600     pressure += ptc->pressure * average_fac;
601   }
602   if (ptd) {
603     copy_v2_v2(d, &ptd->x);
604     madd_v2_v2fl(sco, d, average_fac);
605     pressure += ptd->pressure * average_fac;
606   }
607
608   /* Based on influence factor, blend between original and optimal smoothed coordinate. */
609   interp_v2_v2v2(c, c, sco, inf);
610   copy_v2_v2(&ptc->x, c);
611   /* Interpolate pressure. */
612   ptc->pressure = interpf(ptc->pressure, pressure, inf);
613 }
614
615 /* add current stroke-point to buffer (returns whether point was successfully added) */
616 static short gp_stroke_addpoint(tGPsdata *p, const float mval[2], float pressure, double curtime)
617 {
618   bGPdata *gpd = p->gpd;
619   Brush *brush = p->brush;
620   tGPspoint *pt;
621   ToolSettings *ts = p->scene->toolsettings;
622   Object *obact = (Object *)p->ownerPtr.data;
623   Depsgraph *depsgraph = p->depsgraph;
624   RegionView3D *rv3d = p->ar->regiondata;
625   View3D *v3d = p->sa->spacedata.first;
626   MaterialGPencilStyle *gp_style = p->material->gp_style;
627   const int def_nr = obact->actdef - 1;
628   const bool have_weight = (bool)BLI_findlink(&obact->defbase, def_nr);
629
630   /* check painting mode */
631   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
632     /* straight lines only - i.e. only store start and end point in buffer */
633     if (gpd->runtime.sbuffer_used == 0) {
634       /* first point in buffer (start point) */
635       pt = (tGPspoint *)(gpd->runtime.sbuffer);
636
637       /* store settings */
638       copy_v2_v2(&pt->x, mval);
639       /* T44932 - Pressure vals are unreliable, so ignore for now */
640       pt->pressure = 1.0f;
641       pt->strength = 1.0f;
642       pt->time = (float)(curtime - p->inittime);
643
644       /* increment buffer size */
645       gpd->runtime.sbuffer_used++;
646     }
647     else {
648       /* just reset the endpoint to the latest value
649        * - assume that pointers for this are always valid...
650        */
651       pt = ((tGPspoint *)(gpd->runtime.sbuffer) + 1);
652
653       /* store settings */
654       copy_v2_v2(&pt->x, mval);
655       /* T44932 - Pressure vals are unreliable, so ignore for now */
656       pt->pressure = 1.0f;
657       pt->strength = 1.0f;
658       pt->time = (float)(curtime - p->inittime);
659
660       /* now the buffer has 2 points (and shouldn't be allowed to get any larger) */
661       gpd->runtime.sbuffer_used = 2;
662     }
663
664     /* can keep carrying on this way :) */
665     return GP_STROKEADD_NORMAL;
666   }
667   else if (p->paintmode == GP_PAINTMODE_DRAW) { /* normal drawing */
668     /* check if still room in buffer or add more */
669     gpd->runtime.sbuffer = ED_gpencil_sbuffer_ensure(
670         gpd->runtime.sbuffer, &gpd->runtime.sbuffer_size, &gpd->runtime.sbuffer_used, false);
671
672     /* get pointer to destination point */
673     pt = ((tGPspoint *)(gpd->runtime.sbuffer) + gpd->runtime.sbuffer_used);
674
675     /* store settings */
676     /* pressure */
677     if (brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE) {
678       float curvef = BKE_curvemapping_evaluateF(
679           brush->gpencil_settings->curve_sensitivity, 0, pressure);
680       pt->pressure = curvef * brush->gpencil_settings->draw_sensitivity;
681     }
682     else {
683       pt->pressure = 1.0f;
684     }
685
686     /* Apply jitter to position */
687     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
688         (brush->gpencil_settings->draw_jitter > 0.0f)) {
689       float r_mval[2];
690       const float jitpress = (brush->gpencil_settings->flag & GP_BRUSH_USE_JITTER_PRESSURE) ?
691                                  pressure :
692                                  1.0f;
693       gp_brush_jitter(gpd, brush, pt, mval, jitpress, r_mval, p->rng);
694       copy_v2_v2(&pt->x, r_mval);
695     }
696     else {
697       copy_v2_v2(&pt->x, mval);
698     }
699     /* apply randomness to pressure */
700     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
701         (brush->gpencil_settings->draw_random_press > 0.0f)) {
702       float curvef = BKE_curvemapping_evaluateF(
703           brush->gpencil_settings->curve_sensitivity, 0, pressure);
704       float tmp_pressure = curvef * brush->gpencil_settings->draw_sensitivity;
705       if (BLI_rng_get_float(p->rng) > 0.5f) {
706         pt->pressure -= tmp_pressure * brush->gpencil_settings->draw_random_press *
707                         BLI_rng_get_float(p->rng);
708       }
709       else {
710         pt->pressure += tmp_pressure * brush->gpencil_settings->draw_random_press *
711                         BLI_rng_get_float(p->rng);
712       }
713       CLAMP(pt->pressure, GPENCIL_STRENGTH_MIN, 1.0f);
714     }
715
716     /* apply randomness to uv texture rotation */
717     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
718         (brush->gpencil_settings->uv_random > 0.0f)) {
719       if (BLI_rng_get_float(p->rng) > 0.5f) {
720         pt->uv_rot = (BLI_rng_get_float(p->rng) * M_PI * -1) * brush->gpencil_settings->uv_random;
721       }
722       else {
723         pt->uv_rot = (BLI_rng_get_float(p->rng) * M_PI) * brush->gpencil_settings->uv_random;
724       }
725       CLAMP(pt->uv_rot, -M_PI_2, M_PI_2);
726     }
727     else {
728       pt->uv_rot = 0.0f;
729     }
730
731     /* apply angle of stroke to brush size */
732     if (brush->gpencil_settings->draw_angle_factor != 0.0f) {
733       gp_brush_angle(gpd, brush, pt, mval);
734     }
735
736     /* color strength */
737     if (brush->gpencil_settings->flag & GP_BRUSH_USE_STENGTH_PRESSURE) {
738       float curvef = BKE_curvemapping_evaluateF(
739           brush->gpencil_settings->curve_strength, 0, pressure);
740       float tmp_pressure = curvef * brush->gpencil_settings->draw_sensitivity;
741
742       pt->strength = tmp_pressure * brush->gpencil_settings->draw_strength;
743     }
744     else {
745       pt->strength = brush->gpencil_settings->draw_strength;
746     }
747     CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
748
749     /* apply randomness to color strength */
750     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
751         (brush->gpencil_settings->draw_random_strength > 0.0f)) {
752       if (BLI_rng_get_float(p->rng) > 0.5f) {
753         pt->strength -= pt->strength * brush->gpencil_settings->draw_random_strength *
754                         BLI_rng_get_float(p->rng);
755       }
756       else {
757         pt->strength += pt->strength * brush->gpencil_settings->draw_random_strength *
758                         BLI_rng_get_float(p->rng);
759       }
760       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
761     }
762
763     /* point time */
764     pt->time = (float)(curtime - p->inittime);
765
766     /* point uv (only 3d view) */
767     if ((p->sa->spacetype == SPACE_VIEW3D) && (gpd->runtime.sbuffer_used > 0)) {
768       float pixsize = gp_style->texture_pixsize / 1000000.0f;
769       tGPspoint *ptb = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_used - 1;
770       bGPDspoint spt, spt2;
771
772       /* get origin to reproject point */
773       float origin[3];
774       gp_get_3d_reference(p, origin);
775       /* reproject current */
776       ED_gpencil_tpoint_to_point(p->ar, origin, pt, &spt);
777       ED_gp_project_point_to_plane(p->scene, obact, rv3d, origin, p->lock_axis - 1, &spt);
778
779       /* reproject previous */
780       ED_gpencil_tpoint_to_point(p->ar, origin, ptb, &spt2);
781       ED_gp_project_point_to_plane(p->scene, obact, rv3d, origin, p->lock_axis - 1, &spt2);
782       p->totpixlen += len_v3v3(&spt.x, &spt2.x) / pixsize;
783       pt->uv_fac = p->totpixlen;
784       if ((gp_style) && (gp_style->sima)) {
785         pt->uv_fac /= gp_style->sima->gen_x;
786       }
787     }
788     else {
789       p->totpixlen = 0.0f;
790       pt->uv_fac = 0.0f;
791     }
792
793     /* increment counters */
794     gpd->runtime.sbuffer_used++;
795
796     /* smooth while drawing previous points with a reduction factor for previous */
797     if (brush->gpencil_settings->active_smooth > 0.0f) {
798       for (int s = 0; s < 3; s++) {
799         gp_smooth_buffer(p,
800                          brush->gpencil_settings->active_smooth * ((3.0f - s) / 3.0f),
801                          gpd->runtime.sbuffer_used - s);
802       }
803     }
804
805     return GP_STROKEADD_NORMAL;
806   }
807   else if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
808
809     /* enable special flag for drawing engine */
810     gpd->flag |= GP_DATA_STROKE_POLYGON;
811
812     bGPDlayer *gpl = BKE_gpencil_layer_getactive(gpd);
813     /* get pointer to destination point */
814     pt = (tGPspoint *)(gpd->runtime.sbuffer);
815
816     /* store settings */
817     copy_v2_v2(&pt->x, mval);
818     /* T44932 - Pressure vals are unreliable, so ignore for now */
819     pt->pressure = 1.0f;
820     pt->strength = 1.0f;
821     pt->time = (float)(curtime - p->inittime);
822
823     /* if there's stroke for this poly line session add (or replace last) point
824      * to stroke. This allows to draw lines more interactively (see new segment
825      * during mouse slide, e.g.)
826      */
827     if (gp_stroke_added_check(p)) {
828       bGPDstroke *gps = p->gpf->strokes.last;
829       bGPDspoint *pts;
830       MDeformVert *dvert = NULL;
831
832       /* first time point is adding to temporary buffer -- need to allocate new point in stroke */
833       if (gpd->runtime.sbuffer_used == 0) {
834         gps->points = MEM_reallocN(gps->points, sizeof(bGPDspoint) * (gps->totpoints + 1));
835         if (gps->dvert != NULL) {
836           gps->dvert = MEM_reallocN(gps->dvert, sizeof(MDeformVert) * (gps->totpoints + 1));
837         }
838         gps->totpoints++;
839       }
840
841       pts = &gps->points[gps->totpoints - 1];
842       if (gps->dvert != NULL) {
843         dvert = &gps->dvert[gps->totpoints - 1];
844       }
845       /* special case for poly lines: normally,
846        * depth is needed only when creating new stroke from buffer,
847        * but poly lines are converting to stroke instantly,
848        * so initialize depth buffer before converting coordinates
849        */
850       if (gpencil_project_check(p)) {
851         view3d_region_operator_needs_opengl(p->win, p->ar);
852         ED_view3d_autodist_init(
853             p->depsgraph, p->ar, v3d, (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 1 : 0);
854       }
855
856       /* convert screen-coordinates to appropriate coordinates (and store them) */
857       gp_stroke_convertcoords(p, &pt->x, &pts->x, NULL);
858       /* reproject to plane (only in 3d space) */
859       gp_reproject_toplane(p, gps);
860       /* if parented change position relative to parent object */
861       gp_apply_parent_point(depsgraph, obact, gpd, gpl, pts);
862       /* copy pressure and time */
863       pts->pressure = pt->pressure;
864       pts->strength = pt->strength;
865       pts->time = pt->time;
866       pts->uv_fac = pt->uv_fac;
867       pts->uv_rot = pt->uv_rot;
868
869       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
870         BKE_gpencil_dvert_ensure(gps);
871         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
872         if (dw) {
873           dw->weight = ts->vgroup_weight;
874         }
875       }
876       else {
877         if (dvert != NULL) {
878           dvert->totweight = 0;
879           dvert->dw = NULL;
880         }
881       }
882
883       /* force fill recalc */
884       gps->flag |= GP_STROKE_RECALC_GEOMETRY;
885       /* drawing batch cache is dirty now */
886       gp_update_cache(p->gpd);
887     }
888
889     /* increment counters */
890     if (gpd->runtime.sbuffer_used == 0) {
891       gpd->runtime.sbuffer_used++;
892     }
893
894     return GP_STROKEADD_NORMAL;
895   }
896
897   /* return invalid state for now... */
898   return GP_STROKEADD_INVALID;
899 }
900
901 /* make a new stroke from the buffer data */
902 static void gp_stroke_newfrombuffer(tGPsdata *p)
903 {
904   bGPdata *gpd = p->gpd;
905   bGPDlayer *gpl = p->gpl;
906   bGPDstroke *gps;
907   bGPDspoint *pt;
908   tGPspoint *ptc;
909   MDeformVert *dvert = NULL;
910   Brush *brush = p->brush;
911   ToolSettings *ts = p->scene->toolsettings;
912   Depsgraph *depsgraph = p->depsgraph;
913   Object *obact = (Object *)p->ownerPtr.data;
914   RegionView3D *rv3d = p->ar->regiondata;
915   const int def_nr = obact->actdef - 1;
916   const bool have_weight = (bool)BLI_findlink(&obact->defbase, def_nr);
917   const char *align_flag = &ts->gpencil_v3d_align;
918   const bool is_depth = (bool)(*align_flag & (GP_PROJECT_DEPTH_VIEW | GP_PROJECT_DEPTH_STROKE));
919   const bool is_camera = (bool)(ts->gp_sculpt.lock_axis == 0) && (rv3d->persp == RV3D_CAMOB) &&
920                          (!is_depth);
921   int i, totelem;
922
923   /* Since strokes are so fine,
924    * when using their depth we need a margin otherwise they might get missed. */
925   int depth_margin = (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 4 : 0;
926
927   /* get total number of points to allocate space for
928    * - drawing straight-lines only requires the endpoints
929    */
930   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
931     totelem = (gpd->runtime.sbuffer_used >= 2) ? 2 : gpd->runtime.sbuffer_used;
932   }
933   else {
934     totelem = gpd->runtime.sbuffer_used;
935   }
936
937   /* exit with error if no valid points from this stroke */
938   if (totelem == 0) {
939     if (G.debug & G_DEBUG) {
940       printf("Error: No valid points in stroke buffer to convert (tot=%d)\n",
941              gpd->runtime.sbuffer_used);
942     }
943     return;
944   }
945
946   /* special case for poly line -- for already added stroke during session
947    * coordinates are getting added to stroke immediately to allow more
948    * interactive behavior
949    */
950   if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
951     /* be sure to hide any lazy cursor */
952     ED_gpencil_toggle_brush_cursor(p->C, true, NULL);
953
954     if (gp_stroke_added_check(p)) {
955       return;
956     }
957   }
958
959   /* allocate memory for a new stroke */
960   gps = MEM_callocN(sizeof(bGPDstroke), "gp_stroke");
961
962   /* copy appropriate settings for stroke */
963   gps->totpoints = totelem;
964   gps->thickness = brush->size;
965   gps->gradient_f = brush->gpencil_settings->gradient_f;
966   copy_v2_v2(gps->gradient_s, brush->gpencil_settings->gradient_s);
967   gps->flag = gpd->runtime.sbuffer_sflag;
968   gps->inittime = p->inittime;
969
970   /* enable recalculation flag by default (only used if hq fill) */
971   gps->flag |= GP_STROKE_RECALC_GEOMETRY;
972
973   /* allocate enough memory for a continuous array for storage points */
974   const int subdivide = brush->gpencil_settings->draw_subdivide;
975
976   gps->points = MEM_callocN(sizeof(bGPDspoint) * gps->totpoints, "gp_stroke_points");
977
978   /* initialize triangle memory to dummy data */
979   gps->triangles = MEM_callocN(sizeof(bGPDtriangle), "GP Stroke triangulation");
980   gps->flag |= GP_STROKE_RECALC_GEOMETRY;
981   gps->tot_triangles = 0;
982   /* drawing batch cache is dirty now */
983   gp_update_cache(p->gpd);
984   /* set pointer to first non-initialized point */
985   pt = gps->points + (gps->totpoints - totelem);
986   if (gps->dvert != NULL) {
987     dvert = gps->dvert + (gps->totpoints - totelem);
988   }
989
990   /* copy points from the buffer to the stroke */
991   if (p->paintmode == GP_PAINTMODE_DRAW_STRAIGHT) {
992     /* straight lines only -> only endpoints */
993     {
994       /* first point */
995       ptc = gpd->runtime.sbuffer;
996
997       /* convert screen-coordinates to appropriate coordinates (and store them) */
998       gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
999       /* copy pressure and time */
1000       pt->pressure = ptc->pressure;
1001       pt->strength = ptc->strength;
1002       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1003       pt->time = ptc->time;
1004       pt++;
1005
1006       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1007         BKE_gpencil_dvert_ensure(gps);
1008         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1009         if (dw) {
1010           dw->weight = ts->vgroup_weight;
1011         }
1012         dvert++;
1013       }
1014       else {
1015         if (dvert != NULL) {
1016           dvert->totweight = 0;
1017           dvert->dw = NULL;
1018           dvert++;
1019         }
1020       }
1021     }
1022
1023     if (totelem == 2) {
1024       /* last point if applicable */
1025       ptc = ((tGPspoint *)gpd->runtime.sbuffer) + (gpd->runtime.sbuffer_used - 1);
1026
1027       /* convert screen-coordinates to appropriate coordinates (and store them) */
1028       gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
1029       /* copy pressure and time */
1030       pt->pressure = ptc->pressure;
1031       pt->strength = ptc->strength;
1032       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1033       pt->time = ptc->time;
1034
1035       if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1036         BKE_gpencil_dvert_ensure(gps);
1037         MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1038         if (dw) {
1039           dw->weight = ts->vgroup_weight;
1040         }
1041       }
1042       else {
1043         if (dvert != NULL) {
1044           dvert->totweight = 0;
1045           dvert->dw = NULL;
1046         }
1047       }
1048     }
1049
1050     /* reproject to plane (only in 3d space) */
1051     gp_reproject_toplane(p, gps);
1052     pt = gps->points;
1053     for (i = 0; i < gps->totpoints; i++, pt++) {
1054       /* if parented change position relative to parent object */
1055       gp_apply_parent_point(depsgraph, obact, gpd, gpl, pt);
1056     }
1057
1058     /* if camera view, reproject flat to view to avoid perspective effect */
1059     if (is_camera) {
1060       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1061     }
1062   }
1063   else if (p->paintmode == GP_PAINTMODE_DRAW_POLY) {
1064     /* first point */
1065     ptc = gpd->runtime.sbuffer;
1066
1067     /* convert screen-coordinates to appropriate coordinates (and store them) */
1068     gp_stroke_convertcoords(p, &ptc->x, &pt->x, NULL);
1069     /* reproject to plane (only in 3d space) */
1070     gp_reproject_toplane(p, gps);
1071     /* if parented change position relative to parent object */
1072     gp_apply_parent_point(depsgraph, obact, gpd, gpl, pt);
1073     /* if camera view, reproject flat to view to avoid perspective effect */
1074     if (is_camera) {
1075       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1076     }
1077     /* copy pressure and time */
1078     pt->pressure = ptc->pressure;
1079     pt->strength = ptc->strength;
1080     CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1081     pt->time = ptc->time;
1082
1083     if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1084       BKE_gpencil_dvert_ensure(gps);
1085       MDeformWeight *dw = defvert_verify_index(dvert, def_nr);
1086       if (dw) {
1087         dw->weight = ts->vgroup_weight;
1088       }
1089     }
1090     else {
1091       if (dvert != NULL) {
1092         dvert->totweight = 0;
1093         dvert->dw = NULL;
1094       }
1095     }
1096   }
1097   else {
1098     float *depth_arr = NULL;
1099
1100     /* get an array of depths, far depths are blended */
1101     if (gpencil_project_check(p)) {
1102       int mval_i[2], mval_prev[2] = {0};
1103       int interp_depth = 0;
1104       int found_depth = 0;
1105
1106       depth_arr = MEM_mallocN(sizeof(float) * gpd->runtime.sbuffer_used, "depth_points");
1107
1108       for (i = 0, ptc = gpd->runtime.sbuffer; i < gpd->runtime.sbuffer_used; i++, ptc++, pt++) {
1109
1110         round_v2i_v2fl(mval_i, &ptc->x);
1111
1112         if ((ED_view3d_autodist_depth(p->ar, mval_i, depth_margin, depth_arr + i) == 0) &&
1113             (i && (ED_view3d_autodist_depth_seg(
1114                        p->ar, mval_i, mval_prev, depth_margin + 1, depth_arr + i) == 0))) {
1115           interp_depth = true;
1116         }
1117         else {
1118           found_depth = true;
1119         }
1120
1121         copy_v2_v2_int(mval_prev, mval_i);
1122       }
1123
1124       if (found_depth == false) {
1125         /* eeh... not much we can do.. :/, ignore depth in this case, use the 3D cursor */
1126         for (i = gpd->runtime.sbuffer_used - 1; i >= 0; i--) {
1127           depth_arr[i] = 0.9999f;
1128         }
1129       }
1130       else {
1131         if ((ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) &&
1132             ((ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_ENDPOINTS) ||
1133              (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_FIRST))) {
1134           int first_valid = 0;
1135           int last_valid = 0;
1136
1137           /* find first valid contact point */
1138           for (i = 0; i < gpd->runtime.sbuffer_used; i++) {
1139             if (depth_arr[i] != FLT_MAX) {
1140               break;
1141             }
1142           }
1143           first_valid = i;
1144
1145           /* find last valid contact point */
1146           if (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE_FIRST) {
1147             last_valid = first_valid;
1148           }
1149           else {
1150             for (i = gpd->runtime.sbuffer_used - 1; i >= 0; i--) {
1151               if (depth_arr[i] != FLT_MAX) {
1152                 break;
1153               }
1154             }
1155             last_valid = i;
1156           }
1157           /* invalidate any other point, to interpolate between
1158            * first and last contact in an imaginary line between them */
1159           for (i = 0; i < gpd->runtime.sbuffer_used; i++) {
1160             if ((i != first_valid) && (i != last_valid)) {
1161               depth_arr[i] = FLT_MAX;
1162             }
1163           }
1164           interp_depth = true;
1165         }
1166
1167         if (interp_depth) {
1168           interp_sparse_array(depth_arr, gpd->runtime.sbuffer_used, FLT_MAX);
1169         }
1170       }
1171     }
1172
1173     pt = gps->points;
1174     dvert = gps->dvert;
1175
1176     /* convert all points (normal behavior) */
1177     for (i = 0, ptc = gpd->runtime.sbuffer; i < gpd->runtime.sbuffer_used && ptc;
1178          i++, ptc++, pt++) {
1179       /* convert screen-coordinates to appropriate coordinates (and store them) */
1180       gp_stroke_convertcoords(p, &ptc->x, &pt->x, depth_arr ? depth_arr + i : NULL);
1181
1182       /* copy pressure and time */
1183       pt->pressure = ptc->pressure;
1184       pt->strength = ptc->strength;
1185       CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
1186       pt->time = ptc->time;
1187       pt->uv_fac = ptc->uv_fac;
1188       pt->uv_rot = ptc->uv_rot;
1189
1190       if (dvert != NULL) {
1191         dvert->totweight = 0;
1192         dvert->dw = NULL;
1193         dvert++;
1194       }
1195     }
1196
1197     /* subdivide and smooth the stroke */
1198     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) && (subdivide > 0)) {
1199       gp_subdivide_stroke(gps, subdivide);
1200     }
1201     /* apply randomness to stroke */
1202     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_RANDOM) &&
1203         (brush->gpencil_settings->draw_random_sub > 0.0f)) {
1204       gp_randomize_stroke(gps, brush, p->rng);
1205     }
1206
1207     /* Smooth stroke after subdiv - only if there's something to do for each iteration,
1208      * the factor is reduced to get a better smoothing
1209      * without changing too much the original stroke. */
1210     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1211         (brush->gpencil_settings->draw_smoothfac > 0.0f)) {
1212       float reduce = 0.0f;
1213       for (int r = 0; r < brush->gpencil_settings->draw_smoothlvl; r++) {
1214         for (i = 0; i < gps->totpoints - 1; i++) {
1215           BKE_gpencil_smooth_stroke(gps, i, brush->gpencil_settings->draw_smoothfac - reduce);
1216           BKE_gpencil_smooth_stroke_strength(gps, i, brush->gpencil_settings->draw_smoothfac);
1217         }
1218         reduce += 0.25f; /* reduce the factor */
1219       }
1220     }
1221     /* smooth thickness */
1222     if ((brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1223         (brush->gpencil_settings->thick_smoothfac > 0.0f)) {
1224       for (int r = 0; r < brush->gpencil_settings->thick_smoothlvl * 2; r++) {
1225         for (i = 0; i < gps->totpoints - 1; i++) {
1226           BKE_gpencil_smooth_stroke_thickness(gps, i, brush->gpencil_settings->thick_smoothfac);
1227         }
1228       }
1229     }
1230
1231     /* reproject to plane (only in 3d space) */
1232     gp_reproject_toplane(p, gps);
1233     /* change position relative to parent object */
1234     gp_apply_parent(depsgraph, obact, gpd, gpl, gps);
1235     /* if camera view, reproject flat to view to avoid perspective effect */
1236     if (is_camera) {
1237       ED_gpencil_project_stroke_to_view(p->C, p->gpl, gps);
1238     }
1239
1240     if (depth_arr) {
1241       MEM_freeN(depth_arr);
1242     }
1243   }
1244
1245   /* Save material index */
1246   gps->mat_nr = BKE_gpencil_object_material_get_index_from_brush(p->ob, p->brush);
1247
1248   /* calculate UVs along the stroke */
1249   ED_gpencil_calc_stroke_uv(obact, gps);
1250
1251   /* add stroke to frame, usually on tail of the listbase, but if on back is enabled the stroke
1252    * is added on listbase head because the drawing order is inverse and the head stroke is the
1253    * first to draw. This is very useful for artist when drawing the background.
1254    */
1255   if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
1256       (p->paintmode != GP_PAINTMODE_DRAW_POLY)) {
1257     BLI_addhead(&p->gpf->strokes, gps);
1258   }
1259   else {
1260     BLI_addtail(&p->gpf->strokes, gps);
1261   }
1262   /* add weights */
1263   if ((ts->gpencil_flags & GP_TOOL_FLAG_CREATE_WEIGHTS) && (have_weight)) {
1264     BKE_gpencil_dvert_ensure(gps);
1265     for (i = 0; i < gps->totpoints; i++) {
1266       MDeformVert *ve = &gps->dvert[i];
1267       MDeformWeight *dw = defvert_verify_index(ve, def_nr);
1268       if (dw) {
1269         dw->weight = ts->vgroup_weight;
1270       }
1271     }
1272   }
1273
1274   /* post process stroke */
1275   if ((p->brush->gpencil_settings->flag & GP_BRUSH_GROUP_SETTINGS) &&
1276       p->brush->gpencil_settings->flag & GP_BRUSH_TRIM_STROKE) {
1277     BKE_gpencil_trim_stroke(gps);
1278   }
1279
1280   gp_stroke_added_enable(p);
1281 }
1282
1283 /* --- 'Eraser' for 'Paint' Tool ------ */
1284
1285 /* which which point is infront (result should only be used for comparison) */
1286 static float view3d_point_depth(const RegionView3D *rv3d, const float co[3])
1287 {
1288   if (rv3d->is_persp) {
1289     return ED_view3d_calc_zfac(rv3d, co, NULL);
1290   }
1291   else {
1292     return -dot_v3v3(rv3d->viewinv[2], co);
1293   }
1294 }
1295
1296 /* only erase stroke points that are visible */
1297 static bool gp_stroke_eraser_is_occluded(tGPsdata *p,
1298                                          const bGPDspoint *pt,
1299                                          const int x,
1300                                          const int y)
1301 {
1302   Object *obact = (Object *)p->ownerPtr.data;
1303   Brush *brush = p->brush;
1304   Brush *eraser = p->eraser;
1305   BrushGpencilSettings *gp_settings = NULL;
1306
1307   if (brush->gpencil_tool == GPAINT_TOOL_ERASE) {
1308     gp_settings = brush->gpencil_settings;
1309   }
1310   else if ((eraser != NULL) & (eraser->gpencil_tool == GPAINT_TOOL_ERASE)) {
1311     gp_settings = eraser->gpencil_settings;
1312   }
1313
1314   if ((gp_settings != NULL) && (p->sa->spacetype == SPACE_VIEW3D) &&
1315       (gp_settings->flag & GP_BRUSH_OCCLUDE_ERASER)) {
1316     RegionView3D *rv3d = p->ar->regiondata;
1317     bGPDlayer *gpl = p->gpl;
1318
1319     const int mval_i[2] = {x, y};
1320     float mval_3d[3];
1321     float fpt[3];
1322
1323     float diff_mat[4][4];
1324     /* calculate difference matrix if parent object */
1325     ED_gpencil_parent_location(p->depsgraph, obact, p->gpd, gpl, diff_mat);
1326
1327     if (ED_view3d_autodist_simple(p->ar, mval_i, mval_3d, 0, NULL)) {
1328       const float depth_mval = view3d_point_depth(rv3d, mval_3d);
1329
1330       mul_v3_m4v3(fpt, diff_mat, &pt->x);
1331       const float depth_pt = view3d_point_depth(rv3d, fpt);
1332
1333       if (depth_pt > depth_mval) {
1334         return true;
1335       }
1336     }
1337   }
1338   return false;
1339 }
1340
1341 /* apply a falloff effect to brush strength, based on distance */
1342 static float gp_stroke_eraser_calc_influence(tGPsdata *p,
1343                                              const float mval[2],
1344                                              const int radius,
1345                                              const int co[2])
1346 {
1347   Brush *brush = p->brush;
1348   /* Linear Falloff... */
1349   int mval_i[2];
1350   round_v2i_v2fl(mval_i, mval);
1351   float distance = (float)len_v2v2_int(mval_i, co);
1352   float fac;
1353
1354   CLAMP(distance, 0.0f, (float)radius);
1355   fac = 1.0f - (distance / (float)radius);
1356
1357   /* apply strength factor */
1358   fac *= brush->gpencil_settings->draw_strength;
1359
1360   /* Control this further using pen pressure */
1361   if (brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE) {
1362     fac *= p->pressure;
1363   }
1364   /* Return influence factor computed here */
1365   return fac;
1366 }
1367
1368 /* helper to free a stroke */
1369 static void gp_free_stroke(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps)
1370 {
1371   if (gps->points) {
1372     MEM_freeN(gps->points);
1373   }
1374
1375   if (gps->dvert) {
1376     BKE_gpencil_free_stroke_weights(gps);
1377     MEM_freeN(gps->dvert);
1378   }
1379
1380   if (gps->triangles) {
1381     MEM_freeN(gps->triangles);
1382   }
1383   BLI_freelinkN(&gpf->strokes, gps);
1384   gp_update_cache(gpd);
1385 }
1386
1387 /**
1388  * Analyze points to be removed when soft eraser is used
1389  * to avoid that segments gets the end points rounded.
1390  * The round caps breaks the artistic effect.
1391  */
1392 static void gp_stroke_soft_refine(bGPDstroke *gps)
1393 {
1394   bGPDspoint *pt = NULL;
1395   bGPDspoint *pt2 = NULL;
1396   int i;
1397
1398   /* check if enough points*/
1399   if (gps->totpoints < 3) {
1400     return;
1401   }
1402
1403   /* loop all points to untag any point that next is not tagged */
1404   pt = gps->points;
1405   for (i = 1; i < gps->totpoints - 1; i++, pt++) {
1406     if (pt->flag & GP_SPOINT_TAG) {
1407       pt2 = &gps->points[i + 1];
1408       if ((pt2->flag & GP_SPOINT_TAG) == 0) {
1409         pt->flag &= ~GP_SPOINT_TAG;
1410       }
1411     }
1412   }
1413
1414   /* loop reverse all points to untag any point that previous is not tagged */
1415   pt = &gps->points[gps->totpoints - 1];
1416   for (i = gps->totpoints - 1; i > 0; i--, pt--) {
1417     if (pt->flag & GP_SPOINT_TAG) {
1418       pt2 = &gps->points[i - 1];
1419       if ((pt2->flag & GP_SPOINT_TAG) == 0) {
1420         pt->flag &= ~GP_SPOINT_TAG;
1421       }
1422     }
1423   }
1424 }
1425
1426 /* eraser tool - evaluation per stroke */
1427 /* TODO: this could really do with some optimization (KD-Tree/BVH?) */
1428 static void gp_stroke_eraser_dostroke(tGPsdata *p,
1429                                       bGPDlayer *gpl,
1430                                       bGPDframe *gpf,
1431                                       bGPDstroke *gps,
1432                                       const float mval[2],
1433                                       const float mvalo[2],
1434                                       const int radius,
1435                                       const rcti *rect)
1436 {
1437   Depsgraph *depsgraph = p->depsgraph;
1438   Object *obact = (Object *)p->ownerPtr.data;
1439   Brush *eraser = p->eraser;
1440   bGPDspoint *pt0, *pt1, *pt2;
1441   int pc0[2] = {0};
1442   int pc1[2] = {0};
1443   int pc2[2] = {0};
1444   int i;
1445   float diff_mat[4][4];
1446   int mval_i[2];
1447   round_v2i_v2fl(mval_i, mval);
1448
1449   /* calculate difference matrix */
1450   ED_gpencil_parent_location(depsgraph, obact, p->gpd, gpl, diff_mat);
1451
1452   if (gps->totpoints == 0) {
1453     /* just free stroke */
1454     gp_free_stroke(p->gpd, gpf, gps);
1455   }
1456   else if (gps->totpoints == 1) {
1457     /* only process if it hasn't been masked out... */
1458     if (!(p->flags & GP_PAINTFLAG_SELECTMASK) || (gps->points->flag & GP_SPOINT_SELECT)) {
1459       bGPDspoint pt_temp;
1460       gp_point_to_parent_space(gps->points, diff_mat, &pt_temp);
1461       gp_point_to_xy(&p->gsc, gps, &pt_temp, &pc1[0], &pc1[1]);
1462       /* do boundbox check first */
1463       if ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) {
1464         /* only check if point is inside */
1465         if (len_v2v2_int(mval_i, pc1) <= radius) {
1466           /* free stroke */
1467           gp_free_stroke(p->gpd, gpf, gps);
1468         }
1469       }
1470     }
1471   }
1472   else if ((p->flags & GP_PAINTFLAG_STROKE_ERASER) ||
1473            (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_STROKE)) {
1474     for (i = 0; (i + 1) < gps->totpoints; i++) {
1475
1476       /* only process if it hasn't been masked out... */
1477       if ((p->flags & GP_PAINTFLAG_SELECTMASK) && !(gps->points->flag & GP_SPOINT_SELECT)) {
1478         continue;
1479       }
1480
1481       /* get points to work with */
1482       pt1 = gps->points + i;
1483       bGPDspoint npt;
1484       gp_point_to_parent_space(pt1, diff_mat, &npt);
1485       gp_point_to_xy(&p->gsc, gps, &npt, &pc1[0], &pc1[1]);
1486
1487       /* do boundbox check first */
1488       if ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) {
1489         /* only check if point is inside */
1490         if (len_v2v2_int(mval_i, pc1) <= radius) {
1491           /* free stroke */
1492           gp_free_stroke(p->gpd, gpf, gps);
1493           return;
1494         }
1495       }
1496     }
1497   }
1498   else {
1499     /* Pressure threshold at which stroke should be culled */
1500     const float cull_thresh = 0.005f;
1501
1502     /* Amount to decrease the pressure of each point with each stroke */
1503     const float strength = 0.1f;
1504
1505     /* Perform culling? */
1506     bool do_cull = false;
1507
1508     /* Clear Tags
1509      *
1510      * Note: It's better this way, as we are sure that
1511      * we don't miss anything, though things will be
1512      * slightly slower as a result
1513      */
1514     for (i = 0; i < gps->totpoints; i++) {
1515       bGPDspoint *pt = &gps->points[i];
1516       pt->flag &= ~GP_SPOINT_TAG;
1517     }
1518
1519     /* First Pass: Loop over the points in the stroke
1520      *   1) Thin out parts of the stroke under the brush
1521      *   2) Tag "too thin" parts for removal (in second pass)
1522      */
1523     for (i = 0; (i + 1) < gps->totpoints; i++) {
1524       /* get points to work with */
1525       pt0 = i > 0 ? gps->points + i - 1 : NULL;
1526       pt1 = gps->points + i;
1527       pt2 = gps->points + i + 1;
1528
1529       /* only process if it hasn't been masked out... */
1530       if ((p->flags & GP_PAINTFLAG_SELECTMASK) && !(gps->points->flag & GP_SPOINT_SELECT)) {
1531         continue;
1532       }
1533
1534       bGPDspoint npt;
1535       if (pt0) {
1536         gp_point_to_parent_space(pt0, diff_mat, &npt);
1537         gp_point_to_xy(&p->gsc, gps, &npt, &pc0[0], &pc0[1]);
1538       }
1539       else {
1540         /* avoid null values */
1541         copy_v2_v2_int(pc0, pc1);
1542       }
1543
1544       gp_point_to_parent_space(pt1, diff_mat, &npt);
1545       gp_point_to_xy(&p->gsc, gps, &npt, &pc1[0], &pc1[1]);
1546
1547       gp_point_to_parent_space(pt2, diff_mat, &npt);
1548       gp_point_to_xy(&p->gsc, gps, &npt, &pc2[0], &pc2[1]);
1549
1550       /* Check that point segment of the boundbox of the eraser stroke */
1551       if (((!ELEM(V2D_IS_CLIPPED, pc0[0], pc0[1])) && BLI_rcti_isect_pt(rect, pc0[0], pc0[1])) ||
1552           ((!ELEM(V2D_IS_CLIPPED, pc1[0], pc1[1])) && BLI_rcti_isect_pt(rect, pc1[0], pc1[1])) ||
1553           ((!ELEM(V2D_IS_CLIPPED, pc2[0], pc2[1])) && BLI_rcti_isect_pt(rect, pc2[0], pc2[1]))) {
1554         /* Check if point segment of stroke had anything to do with
1555          * eraser region  (either within stroke painted, or on its lines)
1556          * - this assumes that linewidth is irrelevant
1557          */
1558         if (gp_stroke_inside_circle(mval, mvalo, radius, pc0[0], pc0[1], pc2[0], pc2[1])) {
1559           if ((gp_stroke_eraser_is_occluded(p, pt0, pc0[0], pc0[1]) == false) ||
1560               (gp_stroke_eraser_is_occluded(p, pt1, pc1[0], pc1[1]) == false) ||
1561               (gp_stroke_eraser_is_occluded(p, pt2, pc2[0], pc2[1]) == false)) {
1562             /* Point is affected: */
1563             /* Adjust thickness
1564              *  - Influence of eraser falls off with distance from the middle of the eraser
1565              *  - Second point gets less influence, as it might get hit again in the next segment
1566              */
1567
1568             /* Adjust strength if the eraser is soft */
1569             if (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_SOFT) {
1570               float f_strength = eraser->gpencil_settings->era_strength_f / 100.0f;
1571               float f_thickness = eraser->gpencil_settings->era_thickness_f / 100.0f;
1572               float influence = 0.0f;
1573
1574               if (pt0) {
1575                 influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc0);
1576                 pt0->strength -= influence * strength * f_strength * 0.5f;
1577                 CLAMP_MIN(pt0->strength, 0.0f);
1578                 pt0->pressure -= influence * strength * f_thickness * 0.5f;
1579               }
1580
1581               influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc1);
1582               pt1->strength -= influence * strength * f_strength;
1583               CLAMP_MIN(pt1->strength, 0.0f);
1584               pt1->pressure -= influence * strength * f_thickness;
1585
1586               influence = gp_stroke_eraser_calc_influence(p, mval, radius, pc2);
1587               pt2->strength -= influence * strength * f_strength * 0.5f;
1588               CLAMP_MIN(pt2->strength, 0.0f);
1589               pt2->pressure -= influence * strength * f_thickness * 0.5f;
1590
1591               /* if invisible, delete point */
1592               if ((pt0) && ((pt0->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1593                             (pt0->pressure < cull_thresh))) {
1594                 pt0->flag |= GP_SPOINT_TAG;
1595                 do_cull = true;
1596               }
1597               if ((pt1->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1598                   (pt1->pressure < cull_thresh)) {
1599                 pt1->flag |= GP_SPOINT_TAG;
1600                 do_cull = true;
1601               }
1602               if ((pt2->strength <= GPENCIL_ALPHA_OPACITY_THRESH) ||
1603                   (pt2->pressure < cull_thresh)) {
1604                 pt2->flag |= GP_SPOINT_TAG;
1605                 do_cull = true;
1606               }
1607             }
1608             else {
1609               pt1->pressure -= gp_stroke_eraser_calc_influence(p, mval, radius, pc1) * strength;
1610               pt2->pressure -= gp_stroke_eraser_calc_influence(p, mval, radius, pc2) * strength *
1611                                0.5f;
1612             }
1613
1614             /* 2) Tag any point with overly low influence for removal in the next pass */
1615             if ((pt1->pressure < cull_thresh) || (p->flags & GP_PAINTFLAG_HARD_ERASER) ||
1616                 (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_HARD)) {
1617               pt1->flag |= GP_SPOINT_TAG;
1618               do_cull = true;
1619             }
1620             if ((pt2->pressure < cull_thresh) || (p->flags & GP_PAINTFLAG_HARD_ERASER) ||
1621                 (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_HARD)) {
1622               pt2->flag |= GP_SPOINT_TAG;
1623               do_cull = true;
1624             }
1625           }
1626         }
1627       }
1628     }
1629
1630     /* Second Pass: Remove any points that are tagged */
1631     if (do_cull) {
1632       /* if soft eraser, must analyze points to be sure the stroke ends
1633        * don't get rounded */
1634       if (eraser->gpencil_settings->eraser_mode == GP_BRUSH_ERASER_SOFT) {
1635         gp_stroke_soft_refine(gps);
1636       }
1637
1638       gp_stroke_delete_tagged_points(gpf, gps, gps->next, GP_SPOINT_TAG, false, 0);
1639     }
1640     gp_update_cache(p->gpd);
1641   }
1642 }
1643
1644 /* erase strokes which fall under the eraser strokes */
1645 static void gp_stroke_doeraser(tGPsdata *p)
1646 {
1647   bGPDlayer *gpl;
1648   bGPDstroke *gps, *gpn;
1649   rcti rect;
1650   Brush *brush = p->brush;
1651   Brush *eraser = p->eraser;
1652   bool use_pressure = false;
1653   float press = 1.0f;
1654   BrushGpencilSettings *gp_settings = NULL;
1655
1656   /* detect if use pressure in eraser */
1657   if (brush->gpencil_tool == GPAINT_TOOL_ERASE) {
1658     use_pressure = (bool)(brush->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE);
1659     gp_settings = brush->gpencil_settings;
1660   }
1661   else if ((eraser != NULL) & (eraser->gpencil_tool == GPAINT_TOOL_ERASE)) {
1662     use_pressure = (bool)(eraser->gpencil_settings->flag & GP_BRUSH_USE_PRESSURE);
1663     gp_settings = eraser->gpencil_settings;
1664   }
1665   if (use_pressure) {
1666     press = p->pressure;
1667     CLAMP(press, 0.01f, 1.0f);
1668   }
1669   /* rect is rectangle of eraser */
1670   const int calc_radius = (int)p->radius * press;
1671   rect.xmin = p->mval[0] - calc_radius;
1672   rect.ymin = p->mval[1] - calc_radius;
1673   rect.xmax = p->mval[0] + calc_radius;
1674   rect.ymax = p->mval[1] + calc_radius;
1675
1676   if (p->sa->spacetype == SPACE_VIEW3D) {
1677     if ((gp_settings != NULL) && (gp_settings->flag & GP_BRUSH_OCCLUDE_ERASER)) {
1678       View3D *v3d = p->sa->spacedata.first;
1679       view3d_region_operator_needs_opengl(p->win, p->ar);
1680       ED_view3d_autodist_init(p->depsgraph, p->ar, v3d, 0);
1681     }
1682   }
1683
1684   /* loop over all layers too, since while it's easy to restrict editing to
1685    * only a subset of layers, it is harder to perform the same erase operation
1686    * on multiple layers...
1687    */
1688   for (gpl = p->gpd->layers.first; gpl; gpl = gpl->next) {
1689     bGPDframe *gpf = gpl->actframe;
1690
1691     /* only affect layer if it's editable (and visible) */
1692     if (gpencil_layer_is_editable(gpl) == false) {
1693       continue;
1694     }
1695     else if (gpf == NULL) {
1696       continue;
1697     }
1698
1699     /* loop over strokes, checking segments for intersections */
1700     for (gps = gpf->strokes.first; gps; gps = gpn) {
1701       gpn = gps->next;
1702       /* check if the color is editable */
1703       if (ED_gpencil_stroke_color_use(p->ob, gpl, gps) == false) {
1704         continue;
1705       }
1706       /* Not all strokes in the datablock may be valid in the current editor/context
1707        * (e.g. 2D space strokes in the 3D view, if the same datablock is shared)
1708        */
1709       if (ED_gpencil_stroke_can_use_direct(p->sa, gps)) {
1710         gp_stroke_eraser_dostroke(p, gpl, gpf, gps, p->mval, p->mvalo, calc_radius, &rect);
1711       }
1712     }
1713   }
1714 }
1715
1716 /* ******************************************* */
1717 /* Sketching Operator */
1718
1719 /* clear the session buffers (call this before AND after a paint operation) */
1720 static void gp_session_validatebuffer(tGPsdata *p)
1721 {
1722   bGPdata *gpd = p->gpd;
1723   Brush *brush = p->brush;
1724
1725   /* clear memory of buffer (or allocate it if starting a new session) */
1726   gpd->runtime.sbuffer = ED_gpencil_sbuffer_ensure(
1727       gpd->runtime.sbuffer, &gpd->runtime.sbuffer_size, &gpd->runtime.sbuffer_used, true);
1728
1729   /* reset flags */
1730   gpd->runtime.sbuffer_sflag = 0;
1731
1732   /* reset region */
1733   gpd->runtime.ar = NULL;
1734
1735   /* reset inittime */
1736   p->inittime = 0.0;
1737
1738   /* reset lazy */
1739   if (brush) {
1740     brush->gpencil_settings->flag &= ~GP_BRUSH_STABILIZE_MOUSE_TEMP;
1741   }
1742 }
1743
1744 /* helper to get default eraser and create one if no eraser brush */
1745 static Brush *gp_get_default_eraser(Main *bmain, ToolSettings *ts)
1746 {
1747   Brush *brush_dft = NULL;
1748   Paint *paint = &ts->gp_paint->paint;
1749   Brush *brush_old = paint->brush;
1750   for (Brush *brush = bmain->brushes.first; brush; brush = brush->id.next) {
1751     if ((brush->ob_mode == OB_MODE_PAINT_GPENCIL) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
1752       /* save first eraser to use later if no default */
1753       if (brush_dft == NULL) {
1754         brush_dft = brush;
1755       }
1756       /* found default */
1757       if (brush->gpencil_settings->flag & GP_BRUSH_DEFAULT_ERASER) {
1758         return brush;
1759       }
1760     }
1761   }
1762   /* if no default, but exist eraser brush, return this and set as default */
1763   if (brush_dft) {
1764     brush_dft->gpencil_settings->flag |= GP_BRUSH_DEFAULT_ERASER;
1765     return brush_dft;
1766   }
1767   /* create a new soft eraser brush */
1768   else {
1769     brush_dft = BKE_brush_add_gpencil(bmain, ts, "Soft Eraser");
1770     brush_dft->size = 30.0f;
1771     brush_dft->gpencil_settings->flag |= (GP_BRUSH_ENABLE_CURSOR | GP_BRUSH_DEFAULT_ERASER);
1772     brush_dft->gpencil_settings->icon_id = GP_BRUSH_ICON_ERASE_SOFT;
1773     brush_dft->gpencil_tool = GPAINT_TOOL_ERASE;
1774     brush_dft->gpencil_settings->eraser_mode = GP_BRUSH_ERASER_SOFT;
1775
1776     /* reset current brush */
1777     BKE_paint_brush_set(paint, brush_old);
1778
1779     return brush_dft;
1780   }
1781 }
1782
1783 /* helper to set default eraser and disable others */
1784 static void gp_set_default_eraser(Main *bmain, Brush *brush_dft)
1785 {
1786   if (brush_dft == NULL) {
1787     return;
1788   }
1789
1790   for (Brush *brush = bmain->brushes.first; brush; brush = brush->id.next) {
1791     if ((brush->gpencil_settings) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
1792       if (brush == brush_dft) {
1793         brush->gpencil_settings->flag |= GP_BRUSH_DEFAULT_ERASER;
1794       }
1795       else if (brush->gpencil_settings->flag & GP_BRUSH_DEFAULT_ERASER) {
1796         brush->gpencil_settings->flag &= ~GP_BRUSH_DEFAULT_ERASER;
1797       }
1798     }
1799   }
1800 }
1801
1802 /* initialize a drawing brush */
1803 static void gp_init_drawing_brush(bContext *C, tGPsdata *p)
1804 {
1805   Scene *scene = CTX_data_scene(C);
1806   ToolSettings *ts = CTX_data_tool_settings(C);
1807
1808   Paint *paint = &ts->gp_paint->paint;
1809   bool changed = false;
1810   /* if not exist, create a new one */
1811   if ((paint->brush == NULL) || (paint->brush->gpencil_settings == NULL)) {
1812     /* create new brushes */
1813     BKE_brush_gpencil_presets(C);
1814     changed = true;
1815   }
1816   /* be sure curves are initializated */
1817   BKE_curvemapping_initialize(paint->brush->gpencil_settings->curve_sensitivity);
1818   BKE_curvemapping_initialize(paint->brush->gpencil_settings->curve_strength);
1819   BKE_curvemapping_initialize(paint->brush->gpencil_settings->curve_jitter);
1820
1821   /* assign to temp tGPsdata */
1822   p->brush = paint->brush;
1823   if (paint->brush->gpencil_tool != GPAINT_TOOL_ERASE) {
1824     p->eraser = gp_get_default_eraser(p->bmain, ts);
1825   }
1826   else {
1827     p->eraser = paint->brush;
1828   }
1829   /* set new eraser as default */
1830   gp_set_default_eraser(p->bmain, p->eraser);
1831
1832   /* use radius of eraser */
1833   p->radius = (short)p->eraser->size;
1834
1835   /* GPXX: Need this update to synchronize brush with draw manager.
1836    * Maybe this update can be removed when the new tool system
1837    * will be in place, but while, we need this to keep drawing working.
1838    */
1839   if (changed) {
1840     DEG_id_tag_update(&scene->id, ID_RECALC_COPY_ON_WRITE);
1841   }
1842 }
1843
1844 /* initialize a paint brush and a default color if not exist */
1845 static void gp_init_colors(tGPsdata *p)
1846 {
1847   bGPdata *gpd = p->gpd;
1848   Brush *brush = p->brush;
1849
1850   MaterialGPencilStyle *gp_style = NULL;
1851
1852   /* use brush material */
1853   p->material = BKE_gpencil_object_material_ensure_from_active_input_brush(p->bmain, p->ob, brush);
1854
1855   /* assign color information to temp tGPsdata */
1856   gp_style = p->material->gp_style;
1857   if (gp_style) {
1858
1859     /* set colors */
1860     if (gp_style->flag & GP_STYLE_STROKE_SHOW) {
1861       copy_v4_v4(gpd->runtime.scolor, gp_style->stroke_rgba);
1862     }
1863     else {
1864       /* if no stroke, use fill */
1865       copy_v4_v4(gpd->runtime.scolor, gp_style->fill_rgba);
1866     }
1867     copy_v4_v4(gpd->runtime.sfill, gp_style->fill_rgba);
1868     /* add some alpha to make easy the filling without hide strokes */
1869     if (gpd->runtime.sfill[3] > 0.8f) {
1870       gpd->runtime.sfill[3] = 0.8f;
1871     }
1872
1873     gpd->runtime.mode = (short)gp_style->mode;
1874     gpd->runtime.bstroke_style = gp_style->stroke_style;
1875     gpd->runtime.bfill_style = gp_style->fill_style;
1876   }
1877 }
1878
1879 /* (re)init new painting data */
1880 static bool gp_session_initdata(bContext *C, wmOperator *op, tGPsdata *p)
1881 {
1882   Main *bmain = CTX_data_main(C);
1883   bGPdata **gpd_ptr = NULL;
1884   ScrArea *curarea = CTX_wm_area(C);
1885   ARegion *ar = CTX_wm_region(C);
1886   ToolSettings *ts = CTX_data_tool_settings(C);
1887   Object *obact = CTX_data_active_object(C);
1888
1889   /* make sure the active view (at the starting time) is a 3d-view */
1890   if (curarea == NULL) {
1891     p->status = GP_STATUS_ERROR;
1892     if (G.debug & G_DEBUG) {
1893       printf("Error: No active view for painting\n");
1894     }
1895     return 0;
1896   }
1897
1898   /* pass on current scene and window */
1899   p->C = C;
1900   p->bmain = CTX_data_main(C);
1901   p->scene = CTX_data_scene(C);
1902   p->depsgraph = CTX_data_ensure_evaluated_depsgraph(C);
1903   p->win = CTX_wm_window(C);
1904   p->disable_fill = RNA_boolean_get(op->ptr, "disable_fill");
1905
1906   unit_m4(p->imat);
1907   unit_m4(p->mat);
1908
1909   switch (curarea->spacetype) {
1910     /* supported views first */
1911     case SPACE_VIEW3D: {
1912       /* View3D *v3d = curarea->spacedata.first; */
1913       /* RegionView3D *rv3d = ar->regiondata; */
1914
1915       /* set current area
1916        * - must verify that region data is 3D-view (and not something else)
1917        */
1918       /* CAUTION: If this is the "toolbar", then this will change on the first stroke */
1919       p->sa = curarea;
1920       p->ar = ar;
1921       p->align_flag = &ts->gpencil_v3d_align;
1922
1923       if (ar->regiondata == NULL) {
1924         p->status = GP_STATUS_ERROR;
1925         if (G.debug & G_DEBUG) {
1926           printf(
1927               "Error: 3D-View active region doesn't have any region data, so cannot be "
1928               "drawable\n");
1929         }
1930         return 0;
1931       }
1932
1933       if ((!obact) || (obact->type != OB_GPENCIL)) {
1934         View3D *v3d = p->sa->spacedata.first;
1935         /* if active object doesn't exist or isn't a GP Object, create one */
1936         const float *cur = p->scene->cursor.location;
1937
1938         ushort local_view_bits = 0;
1939         if (v3d->localvd) {
1940           local_view_bits = v3d->local_view_uuid;
1941         }
1942         /* create new default object */
1943         obact = ED_gpencil_add_object(C, p->scene, cur, local_view_bits);
1944       }
1945       /* assign object after all checks to be sure we have one active */
1946       p->ob = obact;
1947
1948       break;
1949     }
1950
1951     /* unsupported views */
1952     default: {
1953       p->status = GP_STATUS_ERROR;
1954       if (G.debug & G_DEBUG) {
1955         printf("Error: Active view not appropriate for Grease Pencil drawing\n");
1956       }
1957       return 0;
1958     }
1959   }
1960
1961   /* get gp-data */
1962   gpd_ptr = ED_gpencil_data_get_pointers(C, &p->ownerPtr);
1963   if ((gpd_ptr == NULL) || ED_gpencil_data_owner_is_annotation(&p->ownerPtr)) {
1964     p->status = GP_STATUS_ERROR;
1965     if (G.debug & G_DEBUG) {
1966       printf("Error: Current context doesn't allow for any Grease Pencil data\n");
1967     }
1968     return 0;
1969   }
1970   else {
1971     /* if no existing GPencil block exists, add one */
1972     if (*gpd_ptr == NULL) {
1973       *gpd_ptr = BKE_gpencil_data_addnew(bmain, "GPencil");
1974     }
1975     p->gpd = *gpd_ptr;
1976   }
1977
1978   /* clear out buffer (stored in gp-data), in case something contaminated it */
1979   gp_session_validatebuffer(p);
1980
1981   /* set brush and create a new one if null */
1982   gp_init_drawing_brush(C, p);
1983
1984   /* setup active color */
1985   if (curarea->spacetype == SPACE_VIEW3D) {
1986     /* region where paint was originated */
1987     p->gpd->runtime.ar = CTX_wm_region(C);
1988
1989     /* NOTE: This is only done for 3D view, as Materials aren't used for
1990      *       annotations in 2D editors
1991      */
1992     int totcol = p->ob->totcol;
1993
1994     gp_init_colors(p);
1995
1996     /* check whether the material was newly added */
1997     if (totcol != p->ob->totcol) {
1998       WM_event_add_notifier(C, NC_SPACE | ND_SPACE_PROPERTIES, NULL);
1999     }
2000   }
2001
2002   /* lock axis (in some modes, disable) */
2003   if (((*p->align_flag & GP_PROJECT_DEPTH_VIEW) == 0) &&
2004       ((*p->align_flag & GP_PROJECT_DEPTH_STROKE) == 0)) {
2005     p->lock_axis = ts->gp_sculpt.lock_axis;
2006   }
2007   else {
2008     p->lock_axis = 0;
2009   }
2010
2011   return 1;
2012 }
2013
2014 /* init new painting session */
2015 static tGPsdata *gp_session_initpaint(bContext *C, wmOperator *op)
2016 {
2017   tGPsdata *p = NULL;
2018
2019   /* Create new context data */
2020   p = MEM_callocN(sizeof(tGPsdata), "GPencil Drawing Data");
2021
2022   /* Try to initialize context data
2023    * WARNING: This may not always succeed (e.g. using GP in an annotation-only context)
2024    */
2025   if (gp_session_initdata(C, op, p) == 0) {
2026     /* Invalid state - Exit
2027      * NOTE: It should be safe to just free the data, since failing context checks should
2028      * only happen when no data has been allocated.
2029      */
2030     MEM_freeN(p);
2031     return NULL;
2032   }
2033
2034   /* Random generator, only init once. */
2035   uint rng_seed = (uint)(PIL_check_seconds_timer_i() & UINT_MAX);
2036   rng_seed ^= POINTER_AS_UINT(p);
2037   p->rng = BLI_rng_new(rng_seed);
2038
2039   /* return context data for running paint operator */
2040   return p;
2041 }
2042
2043 /* cleanup after a painting session */
2044 static void gp_session_cleanup(tGPsdata *p)
2045 {
2046   bGPdata *gpd = (p) ? p->gpd : NULL;
2047
2048   /* error checking */
2049   if (gpd == NULL) {
2050     return;
2051   }
2052
2053   /* free stroke buffer */
2054   if (gpd->runtime.sbuffer) {
2055     /* printf("\t\tGP - free sbuffer\n"); */
2056     MEM_SAFE_FREE(gpd->runtime.sbuffer);
2057     gpd->runtime.sbuffer = NULL;
2058   }
2059
2060   /* clear flags */
2061   gpd->runtime.sbuffer_used = 0;
2062   gpd->runtime.sbuffer_size = 0;
2063   gpd->runtime.sbuffer_sflag = 0;
2064   p->inittime = 0.0;
2065 }
2066
2067 static void gp_session_free(tGPsdata *p)
2068 {
2069   if (p->rng != NULL) {
2070     BLI_rng_free(p->rng);
2071   }
2072
2073   MEM_freeN(p);
2074 }
2075
2076 /* init new stroke */
2077 static void gp_paint_initstroke(tGPsdata *p, eGPencil_PaintModes paintmode, Depsgraph *depsgraph)
2078 {
2079   Scene *scene = p->scene;
2080   ToolSettings *ts = scene->toolsettings;
2081
2082   /* get active layer (or add a new one if non-existent) */
2083   p->gpl = BKE_gpencil_layer_getactive(p->gpd);
2084   if (p->gpl == NULL) {
2085     p->gpl = BKE_gpencil_layer_addnew(p->gpd, DATA_("GP_Layer"), true);
2086
2087     if (p->custom_color[3]) {
2088       copy_v3_v3(p->gpl->color, p->custom_color);
2089     }
2090   }
2091   if ((paintmode != GP_PAINTMODE_ERASER) && (p->gpl->flag & GP_LAYER_LOCKED)) {
2092     p->status = GP_STATUS_ERROR;
2093     if (G.debug & G_DEBUG) {
2094       printf("Error: Cannot paint on locked layer\n");
2095     }
2096     return;
2097   }
2098
2099   /* get active frame (add a new one if not matching frame) */
2100   if (paintmode == GP_PAINTMODE_ERASER) {
2101     /* Eraser mode:
2102      * 1) Add new frames to all frames that we might touch,
2103      * 2) Ensure that p->gpf refers to the frame used for the active layer
2104      *    (to avoid problems with other tools which expect it to exist)
2105      */
2106     bool has_layer_to_erase = false;
2107
2108     for (bGPDlayer *gpl = p->gpd->layers.first; gpl; gpl = gpl->next) {
2109       /* Skip if layer not editable */
2110       if (gpencil_layer_is_editable(gpl) == false) {
2111         continue;
2112       }
2113
2114       /* Add a new frame if needed (and based off the active frame,
2115        * as we need some existing strokes to erase)
2116        *
2117        * Note: We don't add a new frame if there's nothing there now, so
2118        *       -> If there are no frames at all, don't add one
2119        *       -> If there are no strokes in that frame, don't add a new empty frame
2120        */
2121       if (gpl->actframe && gpl->actframe->strokes.first) {
2122         gpl->actframe = BKE_gpencil_layer_getframe(gpl, CFRA, GP_GETFRAME_ADD_COPY);
2123         has_layer_to_erase = true;
2124       }
2125
2126       /* XXX: we omit GP_FRAME_PAINT here for now,
2127        * as it is only really useful for doing
2128        * paintbuffer drawing
2129        */
2130     }
2131
2132     /* Ensure this gets set... */
2133     p->gpf = p->gpl->actframe;
2134
2135     if (has_layer_to_erase == false) {
2136       p->status = GP_STATUS_ERROR;
2137       return;
2138     }
2139   }
2140   else {
2141     /* Drawing Modes - Add a new frame if needed on the active layer */
2142     short add_frame_mode;
2143
2144     if (ts->gpencil_flags & GP_TOOL_FLAG_RETAIN_LAST) {
2145       add_frame_mode = GP_GETFRAME_ADD_COPY;
2146     }
2147     else {
2148       add_frame_mode = GP_GETFRAME_ADD_NEW;
2149     }
2150
2151     p->gpf = BKE_gpencil_layer_getframe(p->gpl, CFRA, add_frame_mode);
2152
2153     if (p->gpf == NULL) {
2154       p->status = GP_STATUS_ERROR;
2155       if (G.debug & G_DEBUG) {
2156         printf("Error: No frame created (gpencil_paint_init)\n");
2157       }
2158       return;
2159     }
2160     else {
2161       p->gpf->flag |= GP_FRAME_PAINT;
2162     }
2163   }
2164
2165   /* set 'eraser' for this stroke if using eraser */
2166   p->paintmode = paintmode;
2167   if (p->paintmode == GP_PAINTMODE_ERASER) {
2168     p->gpd->runtime.sbuffer_sflag |= GP_STROKE_ERASER;
2169   }
2170   else {
2171     /* disable eraser flags - so that we can switch modes during a session */
2172     p->gpd->runtime.sbuffer_sflag &= ~GP_STROKE_ERASER;
2173   }
2174
2175   /* set special fill stroke mode */
2176   if (p->disable_fill == true) {
2177     p->gpd->runtime.sbuffer_sflag |= GP_STROKE_NOFILL;
2178     /* replace stroke color with fill color */
2179     copy_v4_v4(p->gpd->runtime.scolor, p->gpd->runtime.sfill);
2180   }
2181
2182   /* set 'initial run' flag, which is only used to denote when a new stroke is starting */
2183   p->flags |= GP_PAINTFLAG_FIRSTRUN;
2184
2185   /* when drawing in the camera view, in 2D space, set the subrect */
2186   p->subrect = NULL;
2187   if ((*p->align_flag & GP_PROJECT_VIEWSPACE) == 0) {
2188     if (p->sa->spacetype == SPACE_VIEW3D) {
2189       View3D *v3d = p->sa->spacedata.first;
2190       RegionView3D *rv3d = p->ar->regiondata;
2191
2192       /* for camera view set the subrect */
2193       if (rv3d->persp == RV3D_CAMOB) {
2194         /* no shift */
2195         ED_view3d_calc_camera_border(
2196             p->scene, depsgraph, p->ar, v3d, rv3d, &p->subrect_data, true);
2197         p->subrect = &p->subrect_data;
2198       }
2199     }
2200   }
2201
2202   /* init stroke point space-conversion settings... */
2203   p->gsc.gpd = p->gpd;
2204   p->gsc.gpl = p->gpl;
2205
2206   p->gsc.sa = p->sa;
2207   p->gsc.ar = p->ar;
2208   p->gsc.v2d = p->v2d;
2209
2210   p->gsc.subrect_data = p->subrect_data;
2211   p->gsc.subrect = p->subrect;
2212
2213   copy_m4_m4(p->gsc.mat, p->mat);
2214
2215   /* check if points will need to be made in view-aligned space */
2216   if (*p->align_flag & GP_PROJECT_VIEWSPACE) {
2217     switch (p->sa->spacetype) {
2218       case SPACE_VIEW3D: {
2219         p->gpd->runtime.sbuffer_sflag |= GP_STROKE_3DSPACE;
2220         break;
2221       }
2222     }
2223   }
2224 }
2225
2226 /* finish off a stroke (clears buffer, but doesn't finish the paint operation) */
2227 static void gp_paint_strokeend(tGPsdata *p)
2228 {
2229   ToolSettings *ts = p->scene->toolsettings;
2230   /* for surface sketching, need to set the right OpenGL context stuff so that
2231    * the conversions will project the values correctly...
2232    */
2233   if (gpencil_project_check(p)) {
2234     View3D *v3d = p->sa->spacedata.first;
2235
2236     /* need to restore the original projection settings before packing up */
2237     view3d_region_operator_needs_opengl(p->win, p->ar);
2238     ED_view3d_autodist_init(
2239         p->depsgraph, p->ar, v3d, (ts->gpencil_v3d_align & GP_PROJECT_DEPTH_STROKE) ? 1 : 0);
2240   }
2241
2242   /* check if doing eraser or not */
2243   if ((p->gpd->runtime.sbuffer_sflag & GP_STROKE_ERASER) == 0) {
2244     /* transfer stroke to frame */
2245     gp_stroke_newfrombuffer(p);
2246   }
2247
2248   /* clean up buffer now */
2249   gp_session_validatebuffer(p);
2250 }
2251
2252 /* finish off stroke painting operation */
2253 static void gp_paint_cleanup(tGPsdata *p)
2254 {
2255   /* p->gpd==NULL happens when stroke failed to initialize,
2256    * for example when GP is hidden in current space (sergey)
2257    */
2258   if (p->gpd) {
2259     /* finish off a stroke */
2260     gp_paint_strokeend(p);
2261   }
2262
2263   /* "unlock" frame */
2264   if (p->gpf) {
2265     p->gpf->flag &= ~GP_FRAME_PAINT;
2266   }
2267 }
2268
2269 /* ------------------------------- */
2270
2271 /* Helper callback for drawing the cursor itself */
2272 static void gpencil_draw_eraser(bContext *UNUSED(C), int x, int y, void *p_ptr)
2273 {
2274   tGPsdata *p = (tGPsdata *)p_ptr;
2275
2276   if (p->paintmode == GP_PAINTMODE_ERASER) {
2277     GPUVertFormat *format = immVertexFormat();
2278     const uint shdr_pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2279     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2280
2281     GPU_line_smooth(true);
2282     GPU_blend(true);
2283     GPU_blend_set_func_separate(
2284         GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
2285
2286     immUniformColor4ub(255, 100, 100, 20);
2287     imm_draw_circle_fill_2d(shdr_pos, x, y, p->radius, 40);
2288
2289     immUnbindProgram();
2290
2291     immBindBuiltinProgram(GPU_SHADER_2D_LINE_DASHED_UNIFORM_COLOR);
2292
2293     float viewport_size[4];
2294     GPU_viewport_size_get_f(viewport_size);
2295     immUniform2f("viewport_size", viewport_size[2], viewport_size[3]);
2296
2297     immUniformColor4f(1.0f, 0.39f, 0.39f, 0.78f);
2298     immUniform1i("colors_len", 0); /* "simple" mode */
2299     immUniform1f("dash_width", 12.0f);
2300     immUniform1f("dash_factor", 0.5f);
2301
2302     imm_draw_circle_wire_2d(shdr_pos,
2303                             x,
2304                             y,
2305                             p->radius,
2306                             /* XXX Dashed shader gives bad results with sets of small segments
2307                              * currently, temp hack around the issue. :( */
2308                             max_ii(8, p->radius / 2)); /* was fixed 40 */
2309
2310     immUnbindProgram();
2311
2312     GPU_blend(false);
2313     GPU_line_smooth(false);
2314   }
2315 }
2316
2317 /* Turn brush cursor in 3D view on/off */
2318 static void gpencil_draw_toggle_eraser_cursor(bContext *C, tGPsdata *p, short enable)
2319 {
2320   if (p->erasercursor && !enable) {
2321     /* clear cursor */
2322     WM_paint_cursor_end(CTX_wm_manager(C), p->erasercursor);
2323     p->erasercursor = NULL;
2324   }
2325   else if (enable && !p->erasercursor) {
2326     ED_gpencil_toggle_brush_cursor(p->C, false, NULL);
2327     /* enable cursor */
2328     p->erasercursor = WM_paint_cursor_activate(CTX_wm_manager(C),
2329                                                SPACE_TYPE_ANY,
2330                                                RGN_TYPE_ANY,
2331                                                NULL, /* XXX */
2332                                                gpencil_draw_eraser,
2333                                                p);
2334   }
2335 }
2336
2337 /* Check if tablet eraser is being used (when processing events) */
2338 static bool gpencil_is_tablet_eraser_active(const wmEvent *event)
2339 {
2340   if (event->tablet_data) {
2341     const wmTabletData *wmtab = event->tablet_data;
2342     return (wmtab->Active == EVT_TABLET_ERASER);
2343   }
2344
2345   return false;
2346 }
2347
2348 /* ------------------------------- */
2349
2350 static void gpencil_draw_exit(bContext *C, wmOperator *op)
2351 {
2352   tGPsdata *p = op->customdata;
2353
2354   /* don't assume that operator data exists at all */
2355   if (p) {
2356     /* check size of buffer before cleanup, to determine if anything happened here */
2357     if (p->paintmode == GP_PAINTMODE_ERASER) {
2358       /* turn off radial brush cursor */
2359       gpencil_draw_toggle_eraser_cursor(C, p, false);
2360     }
2361
2362     /* always store the new eraser size to be used again next time
2363      * NOTE: Do this even when not in eraser mode, as eraser may
2364      *       have been toggled at some point.
2365      */
2366     if (p->eraser) {
2367       p->eraser->size = p->radius;
2368     }
2369
2370     /* restore cursor to indicate end of drawing */
2371     if (p->sa->spacetype != SPACE_VIEW3D) {
2372       WM_cursor_modal_restore(CTX_wm_window(C));
2373     }
2374     else {
2375       /* drawing batch cache is dirty now */
2376       bGPdata *gpd = CTX_data_gpencil_data(C);
2377       if (gpd) {
2378         gpd->flag &= ~GP_DATA_STROKE_POLYGON;
2379         gp_update_cache(gpd);
2380       }
2381     }
2382
2383     /* clear undo stack */
2384     gpencil_undo_finish();
2385
2386     /* cleanup */
2387     gp_paint_cleanup(p);
2388     gp_session_cleanup(p);
2389     ED_gpencil_toggle_brush_cursor(C, true, NULL);
2390
2391     /* finally, free the temp data */
2392     gp_session_free(p);
2393     p = NULL;
2394   }
2395
2396   op->customdata = NULL;
2397 }
2398
2399 static void gpencil_draw_cancel(bContext *C, wmOperator *op)
2400 {
2401   /* this is just a wrapper around exit() */
2402   gpencil_draw_exit(C, op);
2403 }
2404
2405 /* ------------------------------- */
2406
2407 static int gpencil_draw_init(bContext *C, wmOperator *op, const wmEvent *event)
2408 {
2409   tGPsdata *p;
2410   eGPencil_PaintModes paintmode = RNA_enum_get(op->ptr, "mode");
2411   ToolSettings *ts = CTX_data_tool_settings(C);
2412   Brush *brush = BKE_paint_brush(&ts->gp_paint->paint);
2413
2414   /* if mode is draw and the brush is eraser, cancel */
2415   if (paintmode != GP_PAINTMODE_ERASER) {
2416     if ((brush) && (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
2417       return 0;
2418     }
2419   }
2420
2421   /* check context */
2422   p = op->customdata = gp_session_initpaint(C, op);
2423   if ((p == NULL) || (p->status == GP_STATUS_ERROR)) {
2424     /* something wasn't set correctly in context */
2425     gpencil_draw_exit(C, op);
2426     return 0;
2427   }
2428
2429   /* init painting data */
2430   gp_paint_initstroke(p, paintmode, CTX_data_ensure_evaluated_depsgraph(C));
2431   if (p->status == GP_STATUS_ERROR) {
2432     gpencil_draw_exit(C, op);
2433     return 0;
2434   }
2435
2436   if (event != NULL) {
2437     p->keymodifier = event->keymodifier;
2438   }
2439   else {
2440     p->keymodifier = -1;
2441   }
2442
2443   p->reports = op->reports;
2444
2445   /* everything is now setup ok */
2446   return 1;
2447 }
2448
2449 /* ------------------------------- */
2450
2451 /* ensure that the correct cursor icon is set */
2452 static void gpencil_draw_cursor_set(tGPsdata *p)
2453 {
2454   UNUSED_VARS(p);
2455   return;
2456   /* Disable while we get a better cursor handling for direct input devices (Cintiq/Ipad)*/
2457 #if 0
2458   Brush *brush = p->brush;
2459   if ((p->paintmode == GP_PAINTMODE_ERASER) || (brush->gpencil_tool == GPAINT_TOOL_ERASE)) {
2460     WM_cursor_modal_set(p->win, BC_CROSSCURSOR); /* XXX need a better cursor */
2461   }
2462   else {
2463     WM_cursor_modal_set(p->win, CURSOR_NONE);
2464   }
2465 #endif
2466 }
2467
2468 /* update UI indicators of status, including cursor and header prints */
2469 static void gpencil_draw_status_indicators(bContext *C, tGPsdata *p)
2470 {
2471   /* header prints */
2472   switch (p->status) {
2473     case GP_STATUS_IDLING: {
2474       /* print status info */
2475       switch (p->paintmode) {
2476         case GP_PAINTMODE_ERASER: {
2477           ED_workspace_status_text(
2478               C,
2479               TIP_("Grease Pencil Erase Session: Hold and drag LMB or RMB to erase | "
2480                    "ESC/Enter to end  (or click outside this area)"));
2481           break;
2482         }
2483         case GP_PAINTMODE_DRAW_STRAIGHT: {
2484           ED_workspace_status_text(C,
2485                                    TIP_("Grease Pencil Line Session: Hold and drag LMB to draw | "
2486                                         "ESC/Enter to end  (or click outside this area)"));
2487           break;
2488         }
2489         case GP_PAINTMODE_SET_CP: {
2490           ED_workspace_status_text(
2491               C,
2492               TIP_("Grease Pencil Guides: LMB click and release to place reference point | "
2493                    "Esc/RMB to cancel"));
2494           break;
2495         }
2496         case GP_PAINTMODE_DRAW: {
2497           GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2498           if (guide->use_guide) {
2499             ED_workspace_status_text(
2500                 C,
2501                 TIP_("Grease Pencil Freehand Session: Hold and drag LMB to draw | "
2502                      "M key to flip guide | O key to move reference point"));
2503           }
2504           else {
2505             ED_workspace_status_text(
2506                 C, TIP_("Grease Pencil Freehand Session: Hold and drag LMB to draw"));
2507           }
2508           break;
2509         }
2510         case GP_PAINTMODE_DRAW_POLY: {
2511           ED_workspace_status_text(
2512               C,
2513               TIP_("Grease Pencil Poly Session: LMB click to place next stroke vertex | "
2514                    "Release Shift/ESC/Enter to end (or click outside this area)"));
2515           break;
2516         }
2517         default: /* unhandled future cases */
2518         {
2519           ED_workspace_status_text(
2520               C, TIP_("Grease Pencil Session: ESC/Enter to end (or click outside this area)"));
2521           break;
2522         }
2523       }
2524       break;
2525     }
2526     case GP_STATUS_ERROR:
2527     case GP_STATUS_DONE: {
2528       /* clear status string */
2529       ED_workspace_status_text(C, NULL);
2530       break;
2531     }
2532     case GP_STATUS_PAINTING:
2533       break;
2534   }
2535 }
2536
2537 /* ------------------------------- */
2538
2539 /* create a new stroke point at the point indicated by the painting context */
2540 static void gpencil_draw_apply(bContext *C, wmOperator *op, tGPsdata *p, Depsgraph *depsgraph)
2541 {
2542   bGPdata *gpd = p->gpd;
2543   tGPspoint *pt = NULL;
2544
2545   /* handle drawing/erasing -> test for erasing first */
2546   if (p->paintmode == GP_PAINTMODE_ERASER) {
2547     /* do 'live' erasing now */
2548     gp_stroke_doeraser(p);
2549
2550     /* store used values */
2551     copy_v2_v2(p->mvalo, p->mval);
2552     p->opressure = p->pressure;
2553   }
2554   /* Only add current point to buffer if mouse moved
2555    * (even though we got an event, it might be just noise). */
2556   else if (gp_stroke_filtermval(p, p->mval, p->mvalo)) {
2557
2558     /* if lazy mouse, interpolate the last and current mouse positions */
2559     if (GPENCIL_LAZY_MODE(p->brush, p->shift)) {
2560       float now_mouse[2];
2561       float last_mouse[2];
2562       copy_v2_v2(now_mouse, p->mval);
2563       copy_v2_v2(last_mouse, p->mvalo);
2564       interp_v2_v2v2(now_mouse, now_mouse, last_mouse, p->brush->smooth_stroke_factor);
2565       copy_v2_v2(p->mval, now_mouse);
2566     }
2567
2568     /* try to add point */
2569     short ok = gp_stroke_addpoint(p, p->mval, p->pressure, p->curtime);
2570
2571     /* handle errors while adding point */
2572     if ((ok == GP_STROKEADD_FULL) || (ok == GP_STROKEADD_OVERFLOW)) {
2573       /* finish off old stroke */
2574       gp_paint_strokeend(p);
2575       /* And start a new one!!! Else, projection errors! */
2576       gp_paint_initstroke(p, p->paintmode, depsgraph);
2577
2578       /* start a new stroke, starting from previous point */
2579       /* XXX Must manually reset inittime... */
2580       /* XXX We only need to reuse previous point if overflow! */
2581       if (ok == GP_STROKEADD_OVERFLOW) {
2582         p->inittime = p->ocurtime;
2583         gp_stroke_addpoint(p, p->mvalo, p->opressure, p->ocurtime);
2584       }
2585       else {
2586         p->inittime = p->curtime;
2587       }
2588       gp_stroke_addpoint(p, p->mval, p->pressure, p->curtime);
2589     }
2590     else if (ok == GP_STROKEADD_INVALID) {
2591       /* the painting operation cannot continue... */
2592       BKE_report(op->reports, RPT_ERROR, "Cannot paint stroke");
2593       p->status = GP_STATUS_ERROR;
2594
2595       if (G.debug & G_DEBUG) {
2596         printf("Error: Grease-Pencil Paint - Add Point Invalid\n");
2597       }
2598       return;
2599     }
2600
2601     /* store used values */
2602     copy_v2_v2(p->mvalo, p->mval);
2603     p->opressure = p->pressure;
2604     p->ocurtime = p->curtime;
2605
2606     pt = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_used - 1;
2607     if (p->paintmode != GP_PAINTMODE_ERASER) {
2608       ED_gpencil_toggle_brush_cursor(C, true, &pt->x);
2609     }
2610   }
2611   else if ((p->brush->gpencil_settings->flag & GP_BRUSH_STABILIZE_MOUSE_TEMP) &&
2612            (gpd->runtime.sbuffer_used > 0)) {
2613     pt = (tGPspoint *)gpd->runtime.sbuffer + gpd->runtime.sbuffer_used - 1;
2614     if (p->paintmode != GP_PAINTMODE_ERASER) {
2615       ED_gpencil_toggle_brush_cursor(C, true, &pt->x);
2616     }
2617   }
2618 }
2619
2620 /* Helper to rotate point around origin */
2621 static void gp_rotate_v2_v2v2fl(float v[2],
2622                                 const float p[2],
2623                                 const float origin[2],
2624                                 const float angle)
2625 {
2626   float pt[2];
2627   float r[2];
2628   sub_v2_v2v2(pt, p, origin);
2629   rotate_v2_v2fl(r, pt, angle);
2630   add_v2_v2v2(v, r, origin);
2631 }
2632
2633 /* Helper to snap value to grid */
2634 static float gp_snap_to_grid_fl(float v, const float offset, const float spacing)
2635 {
2636   if (spacing > 0.0f) {
2637     return roundf(v / spacing) * spacing + fmodf(offset, spacing);
2638   }
2639   else {
2640     return v;
2641   }
2642 }
2643
2644 static void UNUSED_FUNCTION(gp_snap_to_grid_v2)(float v[2],
2645                                                 const float offset[2],
2646                                                 const float spacing)
2647 {
2648   v[0] = gp_snap_to_grid_fl(v[0], offset[0], spacing);
2649   v[1] = gp_snap_to_grid_fl(v[1], offset[1], spacing);
2650 }
2651
2652 /* get reference point - screen coords to buffer coords */
2653 static void gp_origin_set(wmOperator *op, const int mval[2])
2654 {
2655   tGPsdata *p = op->customdata;
2656   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2657   float origin[2];
2658   float point[3];
2659   copy_v2fl_v2i(origin, mval);
2660   gp_stroke_convertcoords(p, origin, point, NULL);
2661   if (guide->reference_point == GP_GUIDE_REF_CUSTOM) {
2662     copy_v3_v3(guide->location, point);
2663   }
2664   else if (guide->reference_point == GP_GUIDE_REF_CURSOR) {
2665     copy_v3_v3(p->scene->cursor.location, point);
2666   }
2667 }
2668
2669 /* get reference point - buffer coords to screen coords */
2670 static void gp_origin_get(tGPsdata *p, float origin[2])
2671 {
2672   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2673   float location[3];
2674   if (guide->reference_point == GP_GUIDE_REF_CUSTOM) {
2675     copy_v3_v3(location, guide->location);
2676   }
2677   else if (guide->reference_point == GP_GUIDE_REF_OBJECT && guide->reference_object != NULL) {
2678     copy_v3_v3(location, guide->reference_object->loc);
2679   }
2680   else {
2681     copy_v3_v3(location, p->scene->cursor.location);
2682   }
2683   GP_SpaceConversion *gsc = &p->gsc;
2684   gp_point_3d_to_xy(gsc, p->gpd->runtime.sbuffer_sflag, location, origin);
2685 }
2686
2687 /* handle draw event */
2688 static void gpencil_draw_apply_event(
2689     bContext *C, wmOperator *op, const wmEvent *event, Depsgraph *depsgraph, float x, float y)
2690 {
2691   tGPsdata *p = op->customdata;
2692   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
2693   PointerRNA itemptr;
2694   float mousef[2];
2695   int tablet = 0;
2696   bool is_speed_guide = ((guide->use_guide) &&
2697                          (p->brush && (p->brush->gpencil_tool == GPAINT_TOOL_DRAW)));
2698
2699   /* convert from window-space to area-space mouse coordinates
2700    * add any x,y override position for fake events
2701    */
2702   p->mval[0] = (float)event->mval[0] - x;
2703   p->mval[1] = (float)event->mval[1] - y;
2704   p->shift = event->shift;
2705
2706   /* verify direction for straight lines */
2707   if ((is_speed_guide) ||
2708       ((event->alt > 0) && (RNA_boolean_get(op->ptr, "disable_straight") == false))) {
2709     if (p->straight == 0) {
2710       int dx = (int)fabsf(p->mval[0] - p->mvali[0]);
2711       int dy = (int)fabsf(p->mval[1] - p->mvali[1]);
2712       if ((dx > 0) || (dy > 0)) {
2713         /* store mouse direction */
2714         if (dx > dy) {
2715           p->straight = STROKE_HORIZONTAL;
2716         }
2717         else if (dx < dy) {
2718           p->straight = STROKE_VERTICAL;
2719         }
2720       }
2721     }
2722   }
2723
2724   p->curtime = PIL_check_seconds_timer();
2725
2726   /* handle pressure sensitivity (which is supplied by tablets) */
2727   if (event->tablet_data) {
2728     const wmTabletData *wmtab = event->tablet_data;
2729
2730     tablet = (wmtab->Active != EVT_TABLET_NONE);
2731     p->pressure = wmtab->Pressure;
2732
2733     /* Hack for pressure sensitive eraser on D+RMB when using a tablet:
2734      * The pen has to float over the tablet surface, resulting in
2735      * zero pressure (T47101). Ignore pressure values if floating
2736      * (i.e. "effectively zero" pressure), and only when the "active"
2737      * end is the stylus (i.e. the default when not eraser)
2738      */
2739     if (p->paintmode == GP_PAINTMODE_ERASER) {
2740       if ((wmtab->Active != EVT_TABLET_ERASER) && (p->pressure < 0.001f)) {
2741         p->pressure = 1.0f;
2742       }
2743     }
2744   }
2745   else {
2746     /* No tablet data -> No pressure info is available */
2747     p->pressure = 1.0f;
2748   }
2749
2750   /* special eraser modes */
2751   if (p->paintmode == GP_PAINTMODE_ERASER) {
2752     if (event->shift > 0) {
2753       p->flags |= GP_PAINTFLAG_HARD_ERASER;
2754     }
2755     else {
2756       p->flags &= ~GP_PAINTFLAG_HARD_ERASER;
2757     }
2758     if (event->alt > 0) {
2759       p->flags |= GP_PAINTFLAG_STROKE_ERASER;
2760     }
2761     else {
2762       p->flags &= ~GP_PAINTFLAG_STROKE_ERASER;
2763     }
2764   }
2765
2766   /* special exception for start of strokes (i.e. maybe for just a dot) */
2767   if (p->flags & GP_PAINTFLAG_FIRSTRUN) {
2768     p->flags &= ~GP_PAINTFLAG_FIRSTRUN;
2769
2770     /* set values */
2771     copy_v2_v2(p->mvalo, p->mval);
2772     p->opressure = p->pressure;
2773     p->inittime = p->ocurtime = p->curtime;
2774     p->straight = 0;
2775
2776     /* save initial mouse */
2777     copy_v2_v2(p->mvali, p->mval);
2778
2779     /* calculate once and store snapping distance and origin */
2780     RegionView3D *rv3d = p->ar->regiondata;
2781     float scale = 1.0f;
2782     if (rv3d->is_persp) {
2783       float vec[3];
2784       gp_get_3d_reference(p, vec);
2785       mul_m4_v3(rv3d->persmat, vec);
2786       scale = vec[2] * rv3d->pixsize;
2787     }
2788     else {
2789       scale = rv3d->pixsize;
2790     }
2791     p->guide_spacing = guide->spacing / scale;
2792     p->half_spacing = p->guide_spacing * 0.5f;
2793     gp_origin_get(p, p->origin);
2794
2795     /* special exception here for too high pressure values on first touch in
2796      * windows for some tablets, then we just skip first touch...
2797      */
2798     if (tablet && (p->pressure >= 0.99f)) {
2799       return;
2800     }
2801
2802     /* special exception for grid snapping
2803      * it requires direction which needs at least two points
2804      */
2805     if (!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP) && is_speed_guide &&
2806         guide->use_snapping && (guide->type == GP_GUIDE_GRID)) {
2807       p->flags |= GP_PAINTFLAG_REQ_VECTOR;
2808     }
2809   }
2810
2811   /* wait for vector then add initial point */
2812   if (p->flags & GP_PAINTFLAG_REQ_VECTOR) {
2813     if (p->straight == 0) {
2814       return;
2815     }
2816
2817     p->flags &= ~GP_PAINTFLAG_REQ_VECTOR;
2818
2819     /* create fake events */
2820     float tmp[2];
2821     float pt[2];
2822     copy_v2_v2(tmp, p->mval);
2823     sub_v2_v2v2(pt, p->mval, p->mvali);
2824     gpencil_draw_apply_event(C, op, event, depsgraph, pt[0], pt[1]);
2825     if (len_v2v2(p->mval, p->mvalo)) {
2826       sub_v2_v2v2(pt, p->mval, p->mvalo);
2827       gpencil_draw_apply_event(C, op, event, depsgraph, pt[0], pt[1]);
2828     }
2829     copy_v2_v2(p->mval, tmp);
2830   }
2831
2832   /* check if stroke is straight or guided */
2833   if ((p->paintmode != GP_PAINTMODE_ERASER) && ((p->straight) || (is_speed_guide))) {
2834     /* guided stroke */
2835     if (is_speed_guide) {
2836       switch (guide->type) {
2837         default:
2838         case GP_GUIDE_CIRCULAR: {
2839           float distance;
2840           distance = len_v2v2(p->mvali, p->origin);
2841
2842           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2843             distance = gp_snap_to_grid_fl(distance, 0.0f, p->guide_spacing);
2844           }
2845
2846           dist_ensure_v2_v2fl(p->mval, p->origin, distance);
2847           break;
2848         }
2849         case GP_GUIDE_RADIAL: {
2850           if (guide->use_snapping && (guide->angle_snap > 0.0f)) {
2851             float point[2];
2852             float xy[2];
2853             float angle;
2854             float half_angle = guide->angle_snap * 0.5f;
2855             sub_v2_v2v2(xy, p->mvali, p->origin);
2856             angle = atan2f(xy[1], xy[0]);
2857             angle += (M_PI * 2.0f);
2858             angle = fmodf(angle + half_angle, guide->angle_snap);
2859             angle -= half_angle;
2860             gp_rotate_v2_v2v2fl(point, p->mvali, p->origin, -angle);
2861             closest_to_line_v2(p->mval, p->mval, point, p->origin);
2862           }
2863           else {
2864             closest_to_line_v2(p->mval, p->mval, p->mvali, p->origin);
2865           }
2866           break;
2867         }
2868         case GP_GUIDE_PARALLEL: {
2869           float point[2];
2870           float unit[2];
2871           copy_v2_v2(unit, p->mvali);
2872           unit[0] += 1.0f; /* start from horizontal */
2873           gp_rotate_v2_v2v2fl(point, unit, p->mvali, guide->angle);
2874           closest_to_line_v2(p->mval, p->mval, p->mvali, point);
2875
2876           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2877             gp_rotate_v2_v2v2fl(p->mval, p->mval, p->origin, -guide->angle);
2878             p->mval[1] = gp_snap_to_grid_fl(
2879                 p->mval[1] - p->half_spacing, p->origin[1], p->guide_spacing);
2880             gp_rotate_v2_v2v2fl(p->mval, p->mval, p->origin, guide->angle);
2881           }
2882           break;
2883         }
2884         case GP_GUIDE_GRID: {
2885           if (guide->use_snapping && (guide->spacing > 0.0f)) {
2886             float point[2];
2887             float unit[2];
2888             float angle;
2889             copy_v2_v2(unit, p->mvali);
2890             unit[0] += 1.0f; /* start from horizontal */
2891             angle = (p->straight == STROKE_VERTICAL) ? M_PI_2 : 0.0f;
2892             gp_rotate_v2_v2v2fl(point, unit, p->mvali, angle);
2893             closest_to_line_v2(p->mval, p->mval, p->mvali, point);
2894
2895             if (p->straight == STROKE_HORIZONTAL) {
2896               p->mval[1] = gp_snap_to_grid_fl(
2897                   p->mval[1] - p->half_spacing, p->origin[1], p->guide_spacing);
2898             }
2899             else {
2900               p->mval[0] = gp_snap_to_grid_fl(
2901                   p->mval[0] - p->half_spacing, p->origin[0], p->guide_spacing);
2902             }
2903           }
2904           else if (p->straight == STROKE_HORIZONTAL) {
2905             p->mval[1] = p->mvali[1]; /* replace y */
2906           }
2907           else {
2908             p->mval[0] = p->mvali[0]; /* replace x */
2909           }
2910           break;
2911         }
2912       }
2913     }
2914     else if (p->straight == STROKE_HORIZONTAL) {
2915       p->mval[1] = p->mvali[1]; /* replace y */
2916     }
2917     else {
2918       p->mval[0] = p->mvali[0]; /* replace x */
2919     }
2920   }
2921
2922   /* fill in stroke data (not actually used directly by gpencil_draw_apply) */
2923   RNA_collection_add(op->ptr, "stroke", &itemptr);
2924
2925   mousef[0] = p->mval[0];
2926   mousef[1] = p->mval[1];
2927   RNA_float_set_array(&itemptr, "mouse", mousef);
2928   RNA_float_set(&itemptr, "pressure", p->pressure);
2929   RNA_boolean_set(&itemptr, "is_start", (p->flags & GP_PAINTFLAG_FIRSTRUN) != 0);
2930
2931   RNA_float_set(&itemptr, "time", p->curtime - p->inittime);
2932
2933   /* apply the current latest drawing point */
2934   gpencil_draw_apply(C, op, p, depsgraph);
2935
2936   /* force refresh */
2937   /* just active area for now, since doing whole screen is too slow */
2938   ED_region_tag_redraw(p->ar);
2939 }
2940
2941 /* ------------------------------- */
2942
2943 /* operator 'redo' (i.e. after changing some properties, but also for repeat last) */
2944 static int gpencil_draw_exec(bContext *C, wmOperator *op)
2945 {
2946   tGPsdata *p = NULL;
2947   Depsgraph *depsgraph = CTX_data_ensure_evaluated_depsgraph(C);
2948
2949   /* printf("GPencil - Starting Re-Drawing\n"); */
2950
2951   /* try to initialize context data needed while drawing */
2952   if (!gpencil_draw_init(C, op, NULL)) {
2953     MEM_SAFE_FREE(op->customdata);
2954     /* printf("\tGP - no valid data\n"); */
2955     return OPERATOR_CANCELLED;
2956   }
2957   else {
2958     p = op->customdata;
2959   }
2960
2961   /* printf("\tGP - Start redrawing stroke\n"); */
2962
2963   /* loop over the stroke RNA elements recorded (i.e. progress of mouse movement),
2964    * setting the relevant values in context at each step, then applying
2965    */
2966   RNA_BEGIN (op->ptr, itemptr, "stroke") {
2967     float mousef[2];
2968
2969     /* printf("\t\tGP - stroke elem\n"); */
2970
2971     /* get relevant data for this point from stroke */
2972     RNA_float_get_array(&itemptr, "mouse", mousef);
2973     p->mval[0] = mousef[0];
2974     p->mval[1] = mousef[1];
2975     p->pressure = RNA_float_get(&itemptr, "pressure");
2976     p->curtime = (double)RNA_float_get(&itemptr, "time") + p->inittime;
2977
2978     if (RNA_boolean_get(&itemptr, "is_start")) {
2979       /* if first-run flag isn't set already (i.e. not true first stroke),
2980        * then we must terminate the previous one first before continuing
2981        */
2982       if ((p->flags & GP_PAINTFLAG_FIRSTRUN) == 0) {
2983         /* TODO: both of these ops can set error-status, but we probably don't need to worry */
2984         gp_paint_strokeend(p);
2985         gp_paint_initstroke(p, p->paintmode, depsgraph);
2986       }
2987     }
2988
2989     /* if first run, set previous data too */
2990     if (p->flags & GP_PAINTFLAG_FIRSTRUN) {
2991       p->flags &= ~GP_PAINTFLAG_FIRSTRUN;
2992
2993       p->mvalo[0] = p->mval[0];
2994       p->mvalo[1] = p->mval[1];
2995       p->opressure = p->pressure;
2996       p->ocurtime = p->curtime;
2997     }
2998
2999     /* apply this data as necessary now (as per usual) */
3000     gpencil_draw_apply(C, op, p, depsgraph);
3001   }
3002   RNA_END;
3003
3004   /* printf("\tGP - done\n"); */
3005
3006   /* cleanup */
3007   gpencil_draw_exit(C, op);
3008
3009   /* refreshes */
3010   WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3011
3012   /* done */
3013   return OPERATOR_FINISHED;
3014 }
3015
3016 /* ------------------------------- */
3017
3018 /* handle events for guides */
3019 static void gpencil_guide_event_handling(bContext *C,
3020                                          wmOperator *op,
3021                                          const wmEvent *event,
3022                                          tGPsdata *p)
3023 {
3024   bool add_notifier = false;
3025   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
3026
3027   /* Enter or exit set center point mode */
3028   if ((event->type == OKEY) && (event->val == KM_RELEASE)) {
3029     if (p->paintmode == GP_PAINTMODE_DRAW && guide->reference_point != GP_GUIDE_REF_OBJECT) {
3030       add_notifier = true;
3031       p->paintmode = GP_PAINTMODE_SET_CP;
3032       ED_gpencil_toggle_brush_cursor(C, false, NULL);
3033     }
3034   }
3035   /* Freehand mode, turn off speed guide */
3036   else if ((event->type == VKEY) && (event->val == KM_RELEASE)) {
3037     guide->use_guide = false;
3038     add_notifier = true;
3039   }
3040   /* Alternate or flip direction */
3041   else if ((event->type == MKEY) && (event->val == KM_RELEASE)) {
3042     if (guide->type == GP_GUIDE_CIRCULAR) {
3043       add_notifier = true;
3044       guide->type = GP_GUIDE_RADIAL;
3045     }
3046     else if (guide->type == GP_GUIDE_RADIAL) {
3047       add_notifier = true;
3048       guide->type = GP_GUIDE_CIRCULAR;
3049     }
3050     else if (guide->type == GP_GUIDE_PARALLEL) {
3051       add_notifier = true;
3052       guide->angle += M_PI_2;
3053       guide->angle = angle_compat_rad(guide->angle, M_PI);
3054     }
3055     else {
3056       add_notifier = false;
3057     }
3058   }
3059   /* Line guides */
3060   else if ((event->type == LKEY) && (event->val == KM_RELEASE)) {
3061     add_notifier = true;
3062     guide->use_guide = true;
3063     if (event->ctrl) {
3064       guide->angle = 0.0f;
3065       guide->type = GP_GUIDE_PARALLEL;
3066     }
3067     else if (event->alt) {
3068       guide->type = GP_GUIDE_PARALLEL;
3069       guide->angle = RNA_float_get(op->ptr, "guide_last_angle");
3070     }
3071     else {
3072       guide->type = GP_GUIDE_PARALLEL;
3073     }
3074   }
3075   /* Point guide */
3076   else if ((event->type == CKEY) && (event->val == KM_RELEASE)) {
3077     add_notifier = true;
3078     if (!guide->use_guide) {
3079       guide->use_guide = true;
3080       guide->type = GP_GUIDE_CIRCULAR;
3081     }
3082     else if (guide->type == GP_GUIDE_CIRCULAR) {
3083       guide->type = GP_GUIDE_RADIAL;
3084     }
3085     else if (guide->type == GP_GUIDE_RADIAL) {
3086       guide->type = GP_GUIDE_CIRCULAR;
3087     }
3088     else {
3089       guide->type = GP_GUIDE_CIRCULAR;
3090     }
3091   }
3092   /* Change line angle  */
3093   else if (ELEM(event->type, JKEY, KKEY) && (event->val == KM_RELEASE)) {
3094     add_notifier = true;
3095     float angle = guide->angle;
3096     float adjust = (float)M_PI / 180.0f;
3097     if (event->alt) {
3098       adjust *= 45.0f;
3099     }
3100     else if (!event->shift) {
3101       adjust *= 15.0f;
3102     }
3103     angle += (event->type == JKEY) ? adjust : -adjust;
3104     angle = angle_compat_rad(angle, M_PI);
3105     guide->angle = angle;
3106   }
3107
3108   if (add_notifier) {
3109     WM_event_add_notifier(C, NC_SCENE | ND_TOOLSETTINGS | NC_GPENCIL | NA_EDITED, NULL);
3110   }
3111 }
3112
3113 /* start of interactive drawing part of operator */
3114 static int gpencil_draw_invoke(bContext *C, wmOperator *op, const wmEvent *event)
3115 {
3116   tGPsdata *p = NULL;
3117   Object *ob = CTX_data_active_object(C);
3118   bGPdata *gpd = (bGPdata *)ob->data;
3119
3120   if (G.debug & G_DEBUG) {
3121     printf("GPencil - Starting Drawing\n");
3122   }
3123
3124   /* support for tablets eraser pen */
3125   if (gpencil_is_tablet_eraser_active(event)) {
3126     RNA_enum_set(op->ptr, "mode", GP_PAINTMODE_ERASER);
3127   }
3128
3129   /* do not draw in locked or invisible layers */
3130   eGPencil_PaintModes paintmode = RNA_enum_get(op->ptr, "mode");
3131   if (paintmode != GP_PAINTMODE_ERASER) {
3132     bGPDlayer *gpl = CTX_data_active_gpencil_layer(C);
3133     if ((gpl) && ((gpl->flag & GP_LAYER_LOCKED) || (gpl->flag & GP_LAYER_HIDE))) {
3134       BKE_report(op->reports, RPT_ERROR, "Active layer is locked or hide");
3135       return OPERATOR_CANCELLED;
3136     }
3137   }
3138   else {
3139     /* don't erase empty frames */
3140     bool has_layer_to_erase = false;
3141     for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
3142       /* Skip if layer not editable */
3143       if (gpencil_layer_is_editable(gpl)) {
3144         if (gpl->actframe && gpl->actframe->strokes.first) {
3145           has_layer_to_erase = true;
3146           break;
3147         }
3148       }
3149     }
3150     if (!has_layer_to_erase) {
3151       BKE_report(op->reports, RPT_ERROR, "Nothing to erase or all layers locked");
3152       return OPERATOR_FINISHED;
3153     }
3154   }
3155
3156   /* try to initialize context data needed while drawing */
3157   if (!gpencil_draw_init(C, op, event)) {
3158     if (op->customdata) {
3159       MEM_freeN(op->customdata);
3160     }
3161     if (G.debug & G_DEBUG) {
3162       printf("\tGP - no valid data\n");
3163     }
3164     return OPERATOR_CANCELLED;
3165   }
3166   else {
3167     p = op->customdata;
3168   }
3169
3170   /* TODO: set any additional settings that we can take from the events?
3171    * TODO? if tablet is erasing, force eraser to be on? */
3172
3173   /* TODO: move cursor setting stuff to stroke-start so that paintmode can be changed midway... */
3174
3175   /* if eraser is on, draw radial aid */
3176   if (p->paintmode == GP_PAINTMODE_ERASER) {
3177     gpencil_draw_toggle_eraser_cursor(C, p, true);
3178   }
3179   else {
3180     ED_gpencil_toggle_brush_cursor(C, true, NULL);
3181   }
3182   /* set cursor
3183    * NOTE: This may change later (i.e. intentionally via brush toggle,
3184    *       or unintentionally if the user scrolls outside the area)...
3185    */
3186   gpencil_draw_cursor_set(p);
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_ensure_evaluated_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_pointer(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   Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C);
3321   int input_samples = brush->gpencil_settings->input_samples;
3322
3323   /* ensure sampling when using circular guide */
3324   if (guide->use_guide && (guide->type == GP_GUIDE_CIRCULAR)) {
3325     input_samples = GP_MAX_INPUT_SAMPLES;
3326   }
3327
3328   if (input_samples == 0) {
3329     return;
3330   }
3331
3332   RegionView3D *rv3d = p->ar->regiondata;
3333   float defaultpixsize = rv3d->pixsize * 1000.0f;
3334   int samples = (GP_MAX_INPUT_SAMPLES - input_samples + 1);
3335   float thickness = (float)brush->size;
3336
3337   float pt[2], a[2], b[2];
3338   float vec[3];
3339   float scale = 1.0f;
3340
3341   /* get pixel scale */
3342   gp_get_3d_reference(p, vec);
3343   mul_m4_v3(rv3d->persmat, vec);
3344   if (rv3d->is_persp) {
3345     scale = vec[2] * defaultpixsize;
3346   }
3347   else {
3348     scale = defaultpixsize;
3349   }
3350
3351   /* The thickness of the brush is reduced of thickness to get overlap dots */
3352   float dot_factor = 0.50f;
3353   if (samples < 2) {
3354     dot_factor = 0.05f;
3355   }
3356   else if (samples < 4) {
3357     dot_factor = 0.10f;
3358   }
3359   else if (samples < 7) {
3360     dot_factor = 0.3f;
3361   }
3362   else if (samples < 10) {
3363     dot_factor = 0.4f;
3364   }
3365   float factor = ((thickness * dot_factor) / scale) * samples;
3366
3367   copy_v2_v2(a, p->mvalo);
3368   b[0] = (float)event->mval[0] + 1.0f;
3369   b[1] = (float)event->mval[1] + 1.0f;
3370
3371   /* get distance in pixels */
3372   float dist = len_v2v2(a, b);
3373
3374   /* for very small distances, add a half way point */
3375   if (dist <= 2.0f) {
3376     interp_v2_v2v2(pt, a, b, 0.5f);
3377     sub_v2_v2v2(pt, b, pt);
3378     /* create fake event */
3379     gpencil_draw_apply_event(C, op, event, depsgraph, pt[0], pt[1]);
3380   }
3381   else if (dist >= factor) {
3382     int slices = 2 + (int)((dist - 1.0) / factor);
3383     float n = 1.0f / slices;
3384     for (int i = 1; i < slices; i++) {
3385       interp_v2_v2v2(pt, a, b, n * i);
3386       sub_v2_v2v2(pt, b, pt);
3387       /* create fake event */
3388       gpencil_draw_apply_event(C, op, event, depsgraph, pt[0], pt[1]);
3389     }
3390   }
3391 }
3392
3393 /* events handling during interactive drawing part of operator */
3394 static int gpencil_draw_modal(bContext *C, wmOperator *op, const wmEvent *event)
3395 {
3396   tGPsdata *p = op->customdata;
3397   ToolSettings *ts = CTX_data_tool_settings(C);
3398   GP_Sculpt_Guide *guide = &p->scene->toolsettings->gp_sculpt.guide;
3399   /* default exit state - pass through to support MMB view nav, etc. */
3400   int estate = OPERATOR_PASS_THROUGH;
3401
3402   /* if (event->type == NDOF_MOTION)
3403    *    return OPERATOR_PASS_THROUGH;
3404    * -------------------------------
3405    * [mce] Not quite what I was looking
3406    * for, but a good start! GP continues to
3407    * draw on the screen while the 3D mouse
3408    * moves the viewpoint. Problem is that
3409    * the stroke is converted to 3D only after
3410    * it is finished. This approach should work
3411    * better in tools that immediately apply
3412    * in 3D space.
3413    */
3414
3415   if (p->status == GP_STATUS_IDLING) {
3416     ARegion *ar = CTX_wm_region(C);
3417     p->ar = ar;
3418   }
3419
3420   /* special mode for editing control points */
3421   if (p->paintmode == GP_PAINTMODE_SET_CP) {
3422     wmWindow *win = p->win;
3423     WM_cursor_modal_set(win, BC_NSEW_SCROLLCURSOR);
3424     bool drawmode = false;
3425
3426     switch (event->type) {
3427       /* cancel */
3428       case ESCKEY:
3429       case RIGHTMOUSE: {
3430         if (ELEM(event->val, KM_RELEASE)) {
3431           drawmode = true;
3432         }
3433         break;
3434       }
3435       /* set */
3436       case LEFTMOUSE: {
3437         if (ELEM(event->val, KM_RELEASE)) {
3438           gp_origin_set(op, event->mval);
3439           drawmode = true;
3440         }
3441         break;
3442       }
3443     }
3444     if (drawmode) {
3445       p->status = GP_STATUS_IDLING;
3446       p->paintmode = GP_PAINTMODE_DRAW;
3447       ED_gpencil_toggle_brush_cursor(C, true, NULL);
3448       DEG_id_tag_update(&p->scene->id, ID_RECALC_COPY_ON_WRITE);
3449     }
3450     else {
3451       return OPERATOR_RUNNING_MODAL;
3452     }
3453   }
3454
3455   /* We don't pass on key events, GP is used with key-modifiers -
3456    * prevents Dkey to insert drivers. */
3457   if (ISKEYBOARD(event->type)) {
3458     if (ELEM(event->type, LEFTARROWKEY, DOWNARROWKEY, RIGHTARROWKEY, UPARROWKEY)) {
3459       /* allow some keys:
3460        *   - for frame changing [#33412]
3461        *   - for undo (during sketching sessions)
3462        */
3463     }
3464     else if (event->type == ZKEY) {
3465       if (event->ctrl) {
3466         p->status = GP_STATUS_DONE;
3467         estate = OPERATOR_FINISHED;
3468       }
3469     }
3470     else if (ELEM(event->type, PAD0, PAD1, PAD2, PAD3, PAD4, PAD5, PAD6, PAD7, PAD8, PAD9)) {
3471       /* allow numpad keys so that camera/view manipulations can still take place
3472        * - PAD0 in particular is really important for Grease Pencil drawing,
3473        *   as animators may be working "to camera", so having this working
3474        *   is essential for ensuring that they can quickly return to that view
3475        */
3476     }
3477     else if ((event->type == BKEY) && (event->val == KM_RELEASE)) {
3478       /* Add Blank Frame
3479        * - Since this operator is non-modal, we can just call it here, and keep going...
3480        * - This operator is especially useful when animating
3481        */
3482       WM_operator_name_call(C, "GPENCIL_OT_blank_frame_add", WM_OP_EXEC_DEFAULT, NULL);
3483       estate = OPERATOR_RUNNING_MODAL;
3484     }
3485     else if ((!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP))) {
3486       gpencil_guide_event_handling(C, op, event, p);
3487       estate = OPERATOR_RUNNING_MODAL;
3488     }
3489     else {
3490       estate = OPERATOR_RUNNING_MODAL;
3491     }
3492   }
3493
3494   // printf("\tGP - handle modal event...\n");
3495
3496   /* Exit painting mode (and/or end current stroke).
3497    *
3498    * NOTE: cannot do RIGHTMOUSE (as is standard for canceling)
3499    * as that would break polyline T32647.
3500    */
3501   /* if polyline and release shift must cancel */
3502   if ((ELEM(event->type, RETKEY, PADENTER, ESCKEY, SPACEKEY, EKEY)) ||
3503       ((p->paintmode == GP_PAINTMODE_DRAW_POLY) && (event->shift == 0))) {
3504     /* exit() ends the current stroke before cleaning up */
3505     /* printf("\t\tGP - end of paint op + end of stroke\n"); */
3506     /* if drawing polygon and enable on back, must move stroke */
3507     if (ts) {
3508       if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
3509           (p->paintmode == GP_PAINTMODE_DRAW_POLY)) {
3510         if (p->flags & GP_PAINTFLAG_STROKEADDED) {
3511           gpencil_move_last_stroke_to_back(C);
3512         }
3513       }
3514     }
3515
3516     p->status = GP_STATUS_DONE;
3517     estate = OPERATOR_FINISHED;
3518   }
3519
3520   /* toggle painting mode upon mouse-button movement
3521    * - LEFTMOUSE  = standard drawing (all) / straight line drawing (all) / polyline (toolbox only)
3522    * - RIGHTMOUSE = polyline (hotkey) / eraser (all)
3523    *   (Disabling RIGHTMOUSE case here results in bugs like [#32647])
3524    * also making sure we have a valid event value, to not exit too early
3525    */
3526   if (ELEM(event->type, LEFTMOUSE, RIGHTMOUSE) && (ELEM(event->val, KM_PRESS, KM_RELEASE))) {
3527     /* if painting, end stroke */
3528     if (p->status == GP_STATUS_PAINTING) {
3529       int sketch = 0;
3530
3531       /* basically, this should be mouse-button up = end stroke
3532        * BUT, polyline drawing is an exception -- all knots should be added during one session
3533        */
3534       sketch |= (p->paintmode == GP_PAINTMODE_DRAW_POLY);
3535
3536       if (sketch) {
3537         /* end stroke only, and then wait to resume painting soon */
3538         /* printf("\t\tGP - end stroke only\n"); */
3539         gpencil_stroke_end(op);
3540
3541         /* If eraser mode is on, turn it off after the stroke finishes
3542          * NOTE: This just makes it nicer to work with drawing sessions
3543          */
3544         if (p->paintmode == GP_PAINTMODE_ERASER) {
3545           p->paintmode = RNA_enum_get(op->ptr, "mode");
3546
3547           /* if the original mode was *still* eraser,
3548            * we'll let it say for now, since this gives
3549            * users an opportunity to have visual feedback
3550            * when adjusting eraser size
3551            */
3552           if (p->paintmode != GP_PAINTMODE_ERASER) {
3553             /* turn off cursor...
3554              * NOTE: this should be enough for now
3555              *       Just hiding this makes it seem like
3556              *       you can paint again...
3557              */
3558             gpencil_draw_toggle_eraser_cursor(C, p, false);
3559           }
3560         }
3561
3562         /* we've just entered idling state, so this event was processed (but no others yet) */
3563         estate = OPERATOR_RUNNING_MODAL;
3564
3565         /* stroke could be smoothed, send notifier to refresh screen */
3566         WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3567       }
3568       else {
3569         /* printf("\t\tGP - end of stroke + op\n"); */
3570         /* if drawing polygon and enable on back, must move stroke */
3571         if (ts) {
3572           if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
3573               (p->paintmode == GP_PAINTMODE_DRAW_POLY)) {
3574             if (p->flags & GP_PAINTFLAG_STROKEADDED) {
3575               gpencil_move_last_stroke_to_back(C);
3576             }
3577           }
3578         }
3579         /* drawing batch cache is dirty now */
3580         gp_update_cache(p->gpd);
3581
3582         p->status = GP_STATUS_DONE;
3583         estate = OPERATOR_FINISHED;
3584       }
3585     }
3586     else if (event->val == KM_PRESS) {
3587       bool in_bounds = false;
3588
3589       /* Check if we're outside the bounds of the active region
3590        * NOTE: An exception here is that if launched from the toolbar,
3591        *       whatever region we're now in should become the new region
3592        */
3593       if ((p->ar) && (p->ar->regiontype == RGN_TYPE_TOOLS)) {
3594         /* Change to whatever region is now under the mouse */
3595         ARegion *current_region = BKE_area_find_region_xy(p->sa, RGN_TYPE_ANY, event->x, event->y);
3596
3597         if (G.debug & G_DEBUG) {
3598           printf("found alternative region %p (old was %p) - at %d %d (sa: %d %d -> %d %d)\n",
3599                  current_region,
3600                  p->ar,
3601                  event->x,
3602                  event->y,
3603                  p->sa->totrct.xmin,
3604                  p->sa->totrct.ymin,
3605                  p->sa->totrct.xmax,
3606                  p->sa->totrct.ymax);
3607         }
3608
3609         if (current_region) {
3610           /* Assume that since we found the cursor in here, it is in bounds
3611            * and that this should be the region that we begin drawing in
3612            */
3613           p->ar = current_region;
3614           in_bounds = true;
3615         }
3616         else {
3617           /* Out of bounds, or invalid in some other way */
3618           p->status = GP_STATUS_ERROR;
3619           estate = OPERATOR_CANCELLED;
3620
3621           if (G.debug & G_DEBUG) {
3622             printf("%s: Region under cursor is out of bounds, so cannot be drawn on\n", __func__);
3623           }
3624         }
3625       }
3626       else if (p->ar) {
3627         /* Perform bounds check using  */
3628         const rcti *region_rect = ED_region_visible_rect(p->ar);
3629         in_bounds = BLI_rcti_isect_pt_v(region_rect, event->mval);
3630       }
3631       else {
3632         /* No region */
3633         p->status = GP_STATUS_ERROR;
3634         estate = OPERATOR_CANCELLED;
3635
3636         if (G.debug & G_DEBUG) {
3637           printf("%s: No active region found in GP Paint session data\n", __func__);
3638         }
3639       }
3640
3641       if (in_bounds) {
3642         /* Switch paintmode (temporarily if need be) based on which button was used
3643          * NOTE: This is to make it more convenient to erase strokes when using drawing sessions
3644          */
3645         if ((event->type == RIGHTMOUSE) || gpencil_is_tablet_eraser_active(event)) {
3646           /* turn on eraser */
3647           p->paintmode = GP_PAINTMODE_ERASER;
3648         }
3649         else if (event->type == LEFTMOUSE) {
3650           /* restore drawmode to default */
3651           p->paintmode = RNA_enum_get(op->ptr, "mode");
3652         }
3653
3654         gpencil_draw_toggle_eraser_cursor(C, p, p->paintmode == GP_PAINTMODE_ERASER);
3655
3656         /* not painting, so start stroke (this should be mouse-button down) */
3657         p = gpencil_stroke_begin(C, op);
3658
3659         if (p->status == GP_STATUS_ERROR) {
3660           estate = OPERATOR_CANCELLED;
3661         }
3662       }
3663       else if (p->status != GP_STATUS_ERROR) {
3664         /* User clicked outside bounds of window while idling, so exit paintmode
3665          * NOTE: Don't enter this case if an error occurred while finding the
3666          *       region (as above)
3667          */
3668         /* if drawing polygon and enable on back, must move stroke */
3669         if (ts) {
3670           if ((ts->gpencil_flags & GP_TOOL_FLAG_PAINT_ONBACK) &&
3671               (p->paintmode == GP_PAINTMODE_DRAW_POLY)) {
3672             if (p->flags & GP_PAINTFLAG_STROKEADDED) {
3673               gpencil_move_last_stroke_to_back(C);
3674             }
3675           }
3676         }
3677         p->status = GP_STATUS_DONE;
3678         estate = OPERATOR_FINISHED;
3679       }
3680     }
3681     else if (event->val == KM_RELEASE) {
3682       p->status = GP_STATUS_IDLING;
3683       op->flag |= OP_IS_MODAL_CURSOR_REGION;
3684       ED_region_tag_redraw(p->ar);
3685     }
3686   }
3687
3688   /* handle mode-specific events */
3689   if (p->status == GP_STATUS_PAINTING) {
3690     /* handle painting mouse-movements? */
3691     if (ELEM(event->type, MOUSEMOVE, INBETWEEN_MOUSEMOVE) || (p->flags & GP_PAINTFLAG_FIRSTRUN)) {
3692       /* handle drawing event */
3693       /* printf("\t\tGP - add point\n"); */
3694
3695       if (((p->flags & GP_PAINTFLAG_FIRSTRUN) == 0) && (p->paintmode != GP_PAINTMODE_ERASER)) {
3696         gpencil_add_missing_events(C, op, event, p);
3697       }
3698
3699       gpencil_draw_apply_event(C, op, event, CTX_data_depsgraph_pointer(C), 0.0f, 0.0f);
3700
3701       /* finish painting operation if anything went wrong just now */
3702       if (p->status == GP_STATUS_ERROR) {
3703         printf("\t\t\t\tGP - add error done!\n");
3704         estate = OPERATOR_CANCELLED;
3705       }
3706       else {
3707         /* event handled, so just tag as running modal */
3708         /* printf("\t\t\t\tGP - add point handled!\n"); */
3709         estate = OPERATOR_RUNNING_MODAL;
3710       }
3711     }
3712     /* eraser size */
3713     else if ((p->paintmode == GP_PAINTMODE_ERASER) &&
3714              ELEM(event->type, WHEELUPMOUSE, WHEELDOWNMOUSE, PADPLUSKEY, PADMINUS)) {
3715       /* just resize the brush (local version)
3716        * TODO: fix the hardcoded size jumps (set to make a visible difference) and hardcoded keys
3717        */
3718       /* printf("\t\tGP - resize eraser\n"); */
3719       switch (event->type) {
3720         case WHEELDOWNMOUSE: /* larger */
3721         case PADPLUSKEY:
3722           p->radius += 5;
3723           break;
3724
3725         case WHEELUPMOUSE: /* smaller */
3726         case PADMINUS:
3727           p->radius -= 5;
3728
3729           if (p->radius <= 0) {
3730             p->radius = 1;
3731           }
3732           break;
3733       }
3734
3735       /* force refresh */
3736       /* just active area for now, since doing whole screen is too slow */
3737       ED_region_tag_redraw(p->ar);
3738
3739       /* event handled, so just tag as running modal */
3740       estate = OPERATOR_RUNNING_MODAL;
3741     }
3742     /* there shouldn't be any other events, but just in case there are, let's swallow them
3743      * (i.e. to prevent problems with undo)
3744      */
3745     else {
3746       /* swallow event to save ourselves trouble */
3747       estate = OPERATOR_RUNNING_MODAL;
3748     }
3749   }
3750
3751   /* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */
3752   if (0 == gpencil_area_exists(C, p->sa)) {
3753     estate = OPERATOR_CANCELLED;
3754   }
3755   else {
3756     /* update status indicators - cursor, header, etc. */
3757     gpencil_draw_status_indicators(C, p);
3758     gpencil_draw_cursor_set(p); /* cursor may have changed outside our control - T44084 */
3759   }
3760
3761   /* process last operations before exiting */
3762   switch (estate) {
3763     case OPERATOR_FINISHED:
3764       /* store stroke angle for parallel guide */
3765       if ((p->straight == 0) || (guide->use_guide && (guide->type == GP_GUIDE_CIRCULAR))) {
3766         float xy[2];
3767         sub_v2_v2v2(xy, p->mval, p->mvali);
3768         float angle = atan2f(xy[1], xy[0]);
3769         RNA_float_set(op->ptr, "guide_last_angle", angle);
3770       }
3771       /* one last flush before we're done */
3772       gpencil_draw_exit(C, op);
3773       WM_event_add_notifier(C, NC_GPENCIL | NA_EDITED, NULL);
3774       break;
3775
3776     case OPERATOR_CANCELLED:
3777       gpencil_draw_exit(C, op);
3778       break;
3779
3780     case OPERATOR_RUNNING_MODAL | OPERATOR_PASS_THROUGH:
3781       /* event doesn't need to be handled */
3782 #if 0
3783       printf("unhandled event -> %d (mmb? = %d | mmv? = %d)\n",
3784              event->type,
3785              event->type == MIDDLEMOUSE,
3786              event->type == MOUSEMOVE);
3787 #endif
3788       break;
3789   }
3790
3791   /* return status code */
3792   return estate;
3793 }
3794
3795 /* ------------------------------- */
3796
3797 static const EnumPropertyItem prop_gpencil_drawmodes[] = {
3798     {GP_PAINTMODE_DRAW, "DRAW", 0, "Draw Freehand", "Draw freehand stroke(s)"},
3799     {GP_PAINTMODE_DRAW_STRAIGHT,
3800      "DRAW_STRAIGHT",
3801      0,
3802      "Draw Straight Lines",
3803      "Draw straight line segment(s)"},
3804     {GP_PAINTMODE_DRAW_POLY,
3805      "DRAW_POLY",
3806      0,
3807      "Draw Poly Line",
3808      "Click to place endpoints of straight line segments (connected)"},
3809     {GP_PAINTMODE_ERASER, "ERASER", 0, "Eraser", "Erase Grease Pencil strokes"},
3810     {0, NULL, 0, NULL, NULL},
3811 };
3812
3813 void GPENCIL_OT_draw(wmOperatorType *ot)
3814 {
3815   PropertyRNA *prop;
3816
3817   /* identifiers */
3818   ot->name = "Grease Pencil Draw";
3819   ot->idname = "GPENCIL_OT_draw";
3820   ot->description = "Draw a new stroke in the active Grease Pencil Object";
3821
3822   /* api callbacks */
3823   ot->exec = gpencil_draw_exec;
3824   ot->invoke = gpencil_draw_invoke;
3825   ot->modal = gpencil_draw_modal;
3826   ot->cancel = gpencil_draw_cancel;
3827   ot->poll = gpencil_draw_poll;
3828
3829   /* flags */
3830   ot->flag = OPTYPE_UNDO | OPTYPE_BLOCKING;
3831
3832   /* settings for drawing */
3833   ot->prop = RNA_def_enum(
3834       ot->srna, "mode", prop_gpencil_drawmodes, 0, "Mode", "Way to interpret mouse movements");
3835
3836   prop = RNA_def_collection_runtime(ot->srna, "stroke", &RNA_OperatorStrokeElement, "Stroke", "");
3837   RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
3838
3839   /* NOTE: wait for input is enabled by default,
3840    * so that all UI code can work properly without needing users to know about this */
3841   prop = RNA_def_boolean(ot->srna,
3842                          "wait_for_input",
3843                          true,
3844                          "Wait for Input",
3845                          "Wait for first click instead of painting immediately");
3846   RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
3847
3848   prop = RNA_def_boolean(
3849       ot->srna, "disable_straight", false, "No Straight lines", "Disable key for straight lines");
3850   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3851
3852   prop = RNA_def_boolean(ot->srna,
3853                          "disable_fill",
3854                          false,
3855                          "No Fill Areas",
3856                          "Disable fill to use stroke as fill boundary");
3857   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3858
3859   /* guides */
3860   prop = RNA_def_float(ot->srna,
3861                        "guide_last_angle",
3862                        0.0f,
3863                        -10000.0f,
3864                        10000.0f,
3865                        "Angle",
3866                        "Speed guide angle",
3867                        -10000.0f,
3868                        10000.0f);
3869 }
3870
3871 /* additional OPs */
3872
3873 static int gpencil_guide_rotate(bContext *C, wmOperator *op)
3874 {
3875   ToolSettings *ts = CTX_data_tool_settings(C);
3876   GP_Sculpt_Guide *guide = &ts->gp_sculpt.guide;
3877   float angle = RNA_float_get(op->ptr, "angle");
3878   bool increment = RNA_boolean_get(op->ptr, "increment");
3879   if (increment) {
3880     float oldangle = guide->angle;
3881     oldangle += angle;
3882     guide->angle = angle_compat_rad(oldangle, M_PI);
3883   }
3884   else {
3885     guide->angle = angle_compat_rad(angle, M_PI);
3886   }
3887
3888   return OPERATOR_FINISHED;
3889 }
3890
3891 void GPENCIL_OT_guide_rotate(wmOperatorType *ot)
3892 {
3893   /* identifiers */
3894   ot->name = "Rotate Guide Angle";
3895   ot->idname = "GPENCIL_OT_guide_rotate";
3896   ot->description = "Rotate guide angle";
3897
3898   /* api callbacks */
3899   ot->exec = gpencil_guide_rotate;
3900
3901   /* flags */
3902   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
3903
3904   PropertyRNA *prop;
3905
3906   prop = RNA_def_boolean(ot->srna, "increment", true, "Increment", "Increment angle");
3907   RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
3908   prop = RNA_def_float(
3909       ot->srna, "angle", 0.0f, -10000.0f, 10000.0f, "Angle", "Guide angle", -10000.0f, 10000.0f);
3910   RNA_def_property_flag(prop, PROP_HIDDEN);
3911 }