Cleanup: style, use braces for blenkernel
[blender.git] / source / blender / blenkernel / intern / gpencil.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 bke
22  */
23
24 #include <stdio.h>
25 #include <string.h>
26 #include <stdlib.h>
27 #include <stddef.h>
28 #include <math.h>
29
30 #include "CLG_log.h"
31
32 #include "MEM_guardedalloc.h"
33
34 #include "BLI_blenlib.h"
35 #include "BLI_utildefines.h"
36 #include "BLI_math_vector.h"
37 #include "BLI_string_utils.h"
38
39 #include "BLT_translation.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_material_types.h"
44 #include "DNA_gpencil_types.h"
45 #include "DNA_userdef_types.h"
46 #include "DNA_scene_types.h"
47 #include "DNA_object_types.h"
48
49 #include "BKE_action.h"
50 #include "BKE_animsys.h"
51 #include "BKE_deform.h"
52 #include "BKE_gpencil.h"
53 #include "BKE_colortools.h"
54 #include "BKE_icons.h"
55 #include "BKE_library.h"
56 #include "BKE_main.h"
57 #include "BKE_object.h"
58 #include "BKE_material.h"
59
60 #include "DEG_depsgraph.h"
61
62 static CLG_LogRef LOG = {"bke.gpencil"};
63
64 /* ************************************************** */
65 /* Draw Engine */
66
67 void (*BKE_gpencil_batch_cache_dirty_tag_cb)(bGPdata *gpd) = NULL;
68 void (*BKE_gpencil_batch_cache_free_cb)(bGPdata *gpd) = NULL;
69
70 void BKE_gpencil_batch_cache_dirty_tag(bGPdata *gpd)
71 {
72   if (gpd) {
73     DEG_id_tag_update(&gpd->id, ID_RECALC_GEOMETRY);
74     BKE_gpencil_batch_cache_dirty_tag_cb(gpd);
75   }
76 }
77
78 void BKE_gpencil_batch_cache_free(bGPdata *gpd)
79 {
80   if (gpd) {
81     BKE_gpencil_batch_cache_free_cb(gpd);
82   }
83 }
84
85 /* ************************************************** */
86 /* Memory Management */
87
88 /* clean vertex groups weights */
89 void BKE_gpencil_free_point_weights(MDeformVert *dvert)
90 {
91   if (dvert == NULL) {
92     return;
93   }
94   MEM_SAFE_FREE(dvert->dw);
95 }
96
97 void BKE_gpencil_free_stroke_weights(bGPDstroke *gps)
98 {
99   if (gps == NULL) {
100     return;
101   }
102
103   if (gps->dvert == NULL) {
104     return;
105   }
106
107   for (int i = 0; i < gps->totpoints; i++) {
108     MDeformVert *dvert = &gps->dvert[i];
109     BKE_gpencil_free_point_weights(dvert);
110   }
111 }
112
113 /* free stroke, doesn't unlink from any listbase */
114 void BKE_gpencil_free_stroke(bGPDstroke *gps)
115 {
116   if (gps == NULL) {
117     return;
118   }
119   /* free stroke memory arrays, then stroke itself */
120   if (gps->points) {
121     MEM_freeN(gps->points);
122   }
123   if (gps->dvert) {
124     BKE_gpencil_free_stroke_weights(gps);
125     MEM_freeN(gps->dvert);
126   }
127   if (gps->triangles) {
128     MEM_freeN(gps->triangles);
129   }
130
131   MEM_freeN(gps);
132 }
133
134 /* Free strokes belonging to a gp-frame */
135 bool BKE_gpencil_free_strokes(bGPDframe *gpf)
136 {
137   bGPDstroke *gps_next;
138   bool changed = (BLI_listbase_is_empty(&gpf->strokes) == false);
139
140   /* free strokes */
141   for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps_next) {
142     gps_next = gps->next;
143     BKE_gpencil_free_stroke(gps);
144   }
145   BLI_listbase_clear(&gpf->strokes);
146
147   return changed;
148 }
149
150 /* Free strokes and colors belonging to a gp-frame */
151 bool BKE_gpencil_free_frame_runtime_data(bGPDframe *derived_gpf)
152 {
153   bGPDstroke *gps_next;
154   if (!derived_gpf) {
155     return false;
156   }
157
158   /* free strokes */
159   for (bGPDstroke *gps = derived_gpf->strokes.first; gps; gps = gps_next) {
160     gps_next = gps->next;
161     BKE_gpencil_free_stroke(gps);
162   }
163   BLI_listbase_clear(&derived_gpf->strokes);
164
165   return true;
166 }
167
168 /* Free all of a gp-layer's frames */
169 void BKE_gpencil_free_frames(bGPDlayer *gpl)
170 {
171   bGPDframe *gpf_next;
172
173   /* error checking */
174   if (gpl == NULL) {
175     return;
176   }
177
178   /* free frames */
179   for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf_next) {
180     gpf_next = gpf->next;
181
182     /* free strokes and their associated memory */
183     BKE_gpencil_free_strokes(gpf);
184     BLI_freelinkN(&gpl->frames, gpf);
185   }
186   gpl->actframe = NULL;
187 }
188
189 /* Free all of the gp-layers for a viewport (list should be &gpd->layers or so) */
190 void BKE_gpencil_free_layers(ListBase *list)
191 {
192   bGPDlayer *gpl_next;
193
194   /* error checking */
195   if (list == NULL) {
196     return;
197   }
198
199   /* delete layers */
200   for (bGPDlayer *gpl = list->first; gpl; gpl = gpl_next) {
201     gpl_next = gpl->next;
202
203     /* free layers and their data */
204     BKE_gpencil_free_frames(gpl);
205     BLI_freelinkN(list, gpl);
206   }
207 }
208
209 /** Free (or release) any data used by this grease pencil (does not free the gpencil itself). */
210 void BKE_gpencil_free(bGPdata *gpd, bool free_all)
211 {
212   /* clear animation data */
213   BKE_animdata_free(&gpd->id, false);
214
215   /* free layers */
216   BKE_gpencil_free_layers(&gpd->layers);
217
218   /* materials */
219   MEM_SAFE_FREE(gpd->mat);
220
221   /* free all data */
222   if (free_all) {
223     /* clear cache */
224     BKE_gpencil_batch_cache_free(gpd);
225   }
226 }
227
228 /* ************************************************** */
229 /* Container Creation */
230
231 /* add a new gp-frame to the given layer */
232 bGPDframe *BKE_gpencil_frame_addnew(bGPDlayer *gpl, int cframe)
233 {
234   bGPDframe *gpf = NULL, *gf = NULL;
235   short state = 0;
236
237   /* error checking */
238   if (gpl == NULL) {
239     return NULL;
240   }
241
242   /* allocate memory for this frame */
243   gpf = MEM_callocN(sizeof(bGPDframe), "bGPDframe");
244   gpf->framenum = cframe;
245
246   /* find appropriate place to add frame */
247   if (gpl->frames.first) {
248     for (gf = gpl->frames.first; gf; gf = gf->next) {
249       /* check if frame matches one that is supposed to be added */
250       if (gf->framenum == cframe) {
251         state = -1;
252         break;
253       }
254
255       /* if current frame has already exceeded the frame to add, add before */
256       if (gf->framenum > cframe) {
257         BLI_insertlinkbefore(&gpl->frames, gf, gpf);
258         state = 1;
259         break;
260       }
261     }
262   }
263
264   /* check whether frame was added successfully */
265   if (state == -1) {
266     CLOG_ERROR(&LOG, "Frame (%d) existed already for this layer. Using existing frame", cframe);
267
268     /* free the newly created one, and use the old one instead */
269     MEM_freeN(gpf);
270
271     /* return existing frame instead... */
272     BLI_assert(gf != NULL);
273     gpf = gf;
274   }
275   else if (state == 0) {
276     /* add to end then! */
277     BLI_addtail(&gpl->frames, gpf);
278   }
279
280   /* return frame */
281   return gpf;
282 }
283
284 /* add a copy of the active gp-frame to the given layer */
285 bGPDframe *BKE_gpencil_frame_addcopy(bGPDlayer *gpl, int cframe)
286 {
287   bGPDframe *new_frame;
288   bool found = false;
289
290   /* Error checking/handling */
291   if (gpl == NULL) {
292     /* no layer */
293     return NULL;
294   }
295   else if (gpl->actframe == NULL) {
296     /* no active frame, so just create a new one from scratch */
297     return BKE_gpencil_frame_addnew(gpl, cframe);
298   }
299
300   /* Create a copy of the frame */
301   new_frame = BKE_gpencil_frame_duplicate(gpl->actframe);
302
303   /* Find frame to insert it before */
304   for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
305     if (gpf->framenum > cframe) {
306       /* Add it here */
307       BLI_insertlinkbefore(&gpl->frames, gpf, new_frame);
308
309       found = true;
310       break;
311     }
312     else if (gpf->framenum == cframe) {
313       /* This only happens when we're editing with framelock on...
314        * - Delete the new frame and don't do anything else here...
315        */
316       BKE_gpencil_free_strokes(new_frame);
317       MEM_freeN(new_frame);
318       new_frame = NULL;
319
320       found = true;
321       break;
322     }
323   }
324
325   if (found == false) {
326     /* Add new frame to the end */
327     BLI_addtail(&gpl->frames, new_frame);
328   }
329
330   /* Ensure that frame is set up correctly, and return it */
331   if (new_frame) {
332     new_frame->framenum = cframe;
333     gpl->actframe = new_frame;
334   }
335
336   return new_frame;
337 }
338
339 /* add a new gp-layer and make it the active layer */
340 bGPDlayer *BKE_gpencil_layer_addnew(bGPdata *gpd, const char *name, bool setactive)
341 {
342   bGPDlayer *gpl = NULL;
343   bGPDlayer *gpl_active = NULL;
344
345   /* check that list is ok */
346   if (gpd == NULL) {
347     return NULL;
348   }
349
350   /* allocate memory for frame and add to end of list */
351   gpl = MEM_callocN(sizeof(bGPDlayer), "bGPDlayer");
352
353   gpl_active = BKE_gpencil_layer_getactive(gpd);
354
355   /* add to datablock */
356   if (gpl_active == NULL) {
357     BLI_addtail(&gpd->layers, gpl);
358   }
359   else {
360     /* if active layer, add after that layer */
361     BLI_insertlinkafter(&gpd->layers, gpl_active, gpl);
362   }
363
364   /* annotation vs GP Object behavior is slightly different */
365   if (gpd->flag & GP_DATA_ANNOTATIONS) {
366     /* set default color of new strokes for this layer */
367     copy_v4_v4(gpl->color, U.gpencil_new_layer_col);
368     gpl->opacity = 1.0f;
369
370     /* set default thickness of new strokes for this layer */
371     gpl->thickness = 3;
372
373     /* Onion colors */
374     ARRAY_SET_ITEMS(gpl->gcolor_prev, 0.302f, 0.851f, 0.302f);
375     ARRAY_SET_ITEMS(gpl->gcolor_next, 0.250f, 0.1f, 1.0f);
376   }
377   else {
378     /* thickness parameter represents "thickness change", not absolute thickness */
379     gpl->thickness = 0;
380     gpl->opacity = 1.0f;
381     /* default channel color */
382     ARRAY_SET_ITEMS(gpl->color, 0.2f, 0.2f, 0.2f);
383   }
384
385   /* auto-name */
386   BLI_strncpy(gpl->info, name, sizeof(gpl->info));
387   BLI_uniquename(&gpd->layers,
388                  gpl,
389                  (gpd->flag & GP_DATA_ANNOTATIONS) ? DATA_("Note") : DATA_("GP_Layer"),
390                  '.',
391                  offsetof(bGPDlayer, info),
392                  sizeof(gpl->info));
393
394   /* make this one the active one */
395   if (setactive) {
396     BKE_gpencil_layer_setactive(gpd, gpl);
397   }
398
399   /* return layer */
400   return gpl;
401 }
402
403 /* add a new gp-datablock */
404 bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[])
405 {
406   bGPdata *gpd;
407
408   /* allocate memory for a new block */
409   gpd = BKE_libblock_alloc(bmain, ID_GD, name, 0);
410
411   /* initial settings */
412   gpd->flag = (GP_DATA_DISPINFO | GP_DATA_EXPAND);
413
414   /* general flags */
415   gpd->flag |= GP_DATA_VIEWALIGN;
416   gpd->flag |= GP_DATA_STROKE_FORCE_RECALC;
417   /* always enable object onion skin swith */
418   gpd->flag |= GP_DATA_SHOW_ONIONSKINS;
419   /* GP object specific settings */
420   ARRAY_SET_ITEMS(gpd->line_color, 0.6f, 0.6f, 0.6f, 0.5f);
421
422   gpd->pixfactor = GP_DEFAULT_PIX_FACTOR;
423
424   /* grid settings */
425   ARRAY_SET_ITEMS(gpd->grid.color, 0.5f, 0.5f, 0.5f);  // Color
426   ARRAY_SET_ITEMS(gpd->grid.scale, 1.0f, 1.0f);        // Scale
427   gpd->grid.lines = GP_DEFAULT_GRID_LINES;             // Number of lines
428
429   /* onion-skinning settings (datablock level) */
430   gpd->onion_flag |= (GP_ONION_GHOST_PREVCOL | GP_ONION_GHOST_NEXTCOL);
431   gpd->onion_flag |= GP_ONION_FADE;
432   gpd->onion_mode = GP_ONION_MODE_RELATIVE;
433   gpd->onion_factor = 0.5f;
434   ARRAY_SET_ITEMS(gpd->gcolor_prev, 0.145098f, 0.419608f, 0.137255f); /* green */
435   ARRAY_SET_ITEMS(gpd->gcolor_next, 0.125490f, 0.082353f, 0.529412f); /* blue */
436   gpd->gstep = 1;
437   gpd->gstep_next = 1;
438
439   return gpd;
440 }
441
442 /* ************************************************** */
443 /* Primitive Creation */
444 /* Utilities for easier bulk-creation of geometry */
445
446 /**
447  * Populate stroke with point data from data buffers
448  *
449  * \param array: Flat array of point data values. Each entry has GP_PRIM_DATABUF_SIZE values
450  * \param mat: 4x4 transform matrix to transform points into the right coordinate space
451  */
452 void BKE_gpencil_stroke_add_points(bGPDstroke *gps,
453                                    const float *array,
454                                    const int totpoints,
455                                    const float mat[4][4])
456 {
457   for (int i = 0; i < totpoints; i++) {
458     bGPDspoint *pt = &gps->points[i];
459     const int x = GP_PRIM_DATABUF_SIZE * i;
460
461     pt->x = array[x];
462     pt->y = array[x + 1];
463     pt->z = array[x + 2];
464     mul_m4_v3(mat, &pt->x);
465
466     pt->pressure = array[x + 3];
467     pt->strength = array[x + 4];
468   }
469 }
470
471 /* Create a new stroke, with pre-allocated data buffers */
472 bGPDstroke *BKE_gpencil_add_stroke(bGPDframe *gpf, int mat_idx, int totpoints, short thickness)
473 {
474   /* allocate memory for a new stroke */
475   bGPDstroke *gps = MEM_callocN(sizeof(bGPDstroke), "gp_stroke");
476
477   gps->thickness = thickness;
478   gps->gradient_f = 1.0f;
479   gps->gradient_s[0] = 1.0f;
480   gps->gradient_s[1] = 1.0f;
481
482   gps->inittime = 0;
483
484   /* enable recalculation flag by default */
485   gps->flag = GP_STROKE_RECALC_GEOMETRY | GP_STROKE_3DSPACE;
486
487   gps->totpoints = totpoints;
488   gps->points = MEM_callocN(sizeof(bGPDspoint) * gps->totpoints, "gp_stroke_points");
489
490   /* initialize triangle memory to dummy data */
491   gps->triangles = MEM_callocN(sizeof(bGPDtriangle), "GP Stroke triangulation");
492   gps->flag |= GP_STROKE_RECALC_GEOMETRY;
493   gps->tot_triangles = 0;
494
495   gps->mat_nr = mat_idx;
496
497   /* add to frame */
498   BLI_addtail(&gpf->strokes, gps);
499
500   return gps;
501 }
502
503 /* ************************************************** */
504 /* Data Duplication */
505
506 /* make a copy of a given gpencil weights */
507 void BKE_gpencil_stroke_weights_duplicate(bGPDstroke *gps_src, bGPDstroke *gps_dst)
508 {
509   if (gps_src == NULL) {
510     return;
511   }
512   BLI_assert(gps_src->totpoints == gps_dst->totpoints);
513
514   BKE_defvert_array_copy(gps_dst->dvert, gps_src->dvert, gps_src->totpoints);
515 }
516
517 /* make a copy of a given gpencil stroke */
518 bGPDstroke *BKE_gpencil_stroke_duplicate(bGPDstroke *gps_src)
519 {
520   bGPDstroke *gps_dst = NULL;
521
522   gps_dst = MEM_dupallocN(gps_src);
523   gps_dst->prev = gps_dst->next = NULL;
524
525   gps_dst->points = MEM_dupallocN(gps_src->points);
526
527   if (gps_src->dvert != NULL) {
528     gps_dst->dvert = MEM_dupallocN(gps_src->dvert);
529     BKE_gpencil_stroke_weights_duplicate(gps_src, gps_dst);
530   }
531   else {
532     gps_dst->dvert = NULL;
533   }
534
535   /* Don't clear triangles, so that modifier evaluation can just use
536    * this without extra work first. Most places that need to force
537    * this data to get recalculated will destroy the data anyway though.
538    */
539   gps_dst->triangles = MEM_dupallocN(gps_dst->triangles);
540   /* gps_dst->flag |= GP_STROKE_RECALC_GEOMETRY; */
541
542   /* return new stroke */
543   return gps_dst;
544 }
545
546 /* make a copy of a given gpencil frame */
547 bGPDframe *BKE_gpencil_frame_duplicate(const bGPDframe *gpf_src)
548 {
549   bGPDstroke *gps_dst = NULL;
550   bGPDframe *gpf_dst;
551
552   /* error checking */
553   if (gpf_src == NULL) {
554     return NULL;
555   }
556
557   /* make a copy of the source frame */
558   gpf_dst = MEM_dupallocN(gpf_src);
559   gpf_dst->prev = gpf_dst->next = NULL;
560
561   /* copy strokes */
562   BLI_listbase_clear(&gpf_dst->strokes);
563   for (bGPDstroke *gps_src = gpf_src->strokes.first; gps_src; gps_src = gps_src->next) {
564     /* make copy of source stroke */
565     gps_dst = BKE_gpencil_stroke_duplicate(gps_src);
566     BLI_addtail(&gpf_dst->strokes, gps_dst);
567   }
568
569   /* return new frame */
570   return gpf_dst;
571 }
572
573 /* make a copy of strokes between gpencil frames */
574 void BKE_gpencil_frame_copy_strokes(bGPDframe *gpf_src, struct bGPDframe *gpf_dst)
575 {
576   bGPDstroke *gps_dst = NULL;
577   /* error checking */
578   if ((gpf_src == NULL) || (gpf_dst == NULL)) {
579     return;
580   }
581
582   /* copy strokes */
583   BLI_listbase_clear(&gpf_dst->strokes);
584   for (bGPDstroke *gps_src = gpf_src->strokes.first; gps_src; gps_src = gps_src->next) {
585     /* make copy of source stroke */
586     gps_dst = BKE_gpencil_stroke_duplicate(gps_src);
587     BLI_addtail(&gpf_dst->strokes, gps_dst);
588   }
589 }
590
591 /* make a copy of a given gpencil layer */
592 bGPDlayer *BKE_gpencil_layer_duplicate(const bGPDlayer *gpl_src)
593 {
594   const bGPDframe *gpf_src;
595   bGPDframe *gpf_dst;
596   bGPDlayer *gpl_dst;
597
598   /* error checking */
599   if (gpl_src == NULL) {
600     return NULL;
601   }
602
603   /* make a copy of source layer */
604   gpl_dst = MEM_dupallocN(gpl_src);
605   gpl_dst->prev = gpl_dst->next = NULL;
606
607   /* copy frames */
608   BLI_listbase_clear(&gpl_dst->frames);
609   for (gpf_src = gpl_src->frames.first; gpf_src; gpf_src = gpf_src->next) {
610     /* make a copy of source frame */
611     gpf_dst = BKE_gpencil_frame_duplicate(gpf_src);
612     BLI_addtail(&gpl_dst->frames, gpf_dst);
613
614     /* if source frame was the current layer's 'active' frame, reassign that too */
615     if (gpf_src == gpl_dst->actframe) {
616       gpl_dst->actframe = gpf_dst;
617     }
618   }
619
620   /* return new layer */
621   return gpl_dst;
622 }
623
624 /**
625  * Only copy internal data of GreasePencil ID from source to already allocated/initialized destination.
626  * You probably never want to use that directly, use BKE_id_copy or BKE_id_copy_ex for typical needs.
627  *
628  * WARNING! This function will not handle ID user count!
629  *
630  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
631  */
632 void BKE_gpencil_copy_data(bGPdata *gpd_dst, const bGPdata *gpd_src, const int UNUSED(flag))
633 {
634   /* duplicate material array */
635   if (gpd_src->mat) {
636     gpd_dst->mat = MEM_dupallocN(gpd_src->mat);
637   }
638
639   /* copy layers */
640   BLI_listbase_clear(&gpd_dst->layers);
641   for (const bGPDlayer *gpl_src = gpd_src->layers.first; gpl_src; gpl_src = gpl_src->next) {
642     /* make a copy of source layer and its data */
643     bGPDlayer *gpl_dst = BKE_gpencil_layer_duplicate(
644         gpl_src); /* TODO here too could add unused flags... */
645     BLI_addtail(&gpd_dst->layers, gpl_dst);
646   }
647 }
648
649 /* Standard API to make a copy of GP datablock, separate from copying its data */
650 bGPdata *BKE_gpencil_copy(Main *bmain, const bGPdata *gpd)
651 {
652   bGPdata *gpd_copy;
653   BKE_id_copy(bmain, &gpd->id, (ID **)&gpd_copy);
654   return gpd_copy;
655 }
656
657 /* make a copy of a given gpencil datablock */
658 // XXX: Should this be deprecated?
659 bGPdata *BKE_gpencil_data_duplicate(Main *bmain, const bGPdata *gpd_src, bool internal_copy)
660 {
661   bGPdata *gpd_dst;
662
663   /* Yuck and super-uber-hyper yuck!!!
664    * Should be replaceable with a no-main copy (LIB_ID_COPY_NO_MAIN etc.), but not sure about it,
665    * so for now keep old code for that one. */
666
667   /* error checking */
668   if (gpd_src == NULL) {
669     return NULL;
670   }
671
672   if (internal_copy) {
673     /* make a straight copy for undo buffers used during stroke drawing */
674     gpd_dst = MEM_dupallocN(gpd_src);
675   }
676   else {
677     BLI_assert(bmain != NULL);
678     BKE_id_copy(bmain, &gpd_src->id, (ID **)&gpd_dst);
679   }
680
681   /* Copy internal data (layers, etc.) */
682   BKE_gpencil_copy_data(gpd_dst, gpd_src, 0);
683
684   /* return new */
685   return gpd_dst;
686 }
687
688 void BKE_gpencil_make_local(Main *bmain, bGPdata *gpd, const bool lib_local)
689 {
690   BKE_id_make_local_generic(bmain, &gpd->id, true, lib_local);
691 }
692
693 /* ************************************************** */
694 /* GP Stroke API */
695
696 /* ensure selection status of stroke is in sync with its points */
697 void BKE_gpencil_stroke_sync_selection(bGPDstroke *gps)
698 {
699   bGPDspoint *pt;
700   int i;
701
702   /* error checking */
703   if (gps == NULL) {
704     return;
705   }
706
707   /* we'll stop when we find the first selected point,
708    * so initially, we must deselect
709    */
710   gps->flag &= ~GP_STROKE_SELECT;
711
712   for (i = 0, pt = gps->points; i < gps->totpoints; i++, pt++) {
713     if (pt->flag & GP_SPOINT_SELECT) {
714       gps->flag |= GP_STROKE_SELECT;
715       break;
716     }
717   }
718 }
719
720 /* ************************************************** */
721 /* GP Frame API */
722
723 /* delete the last stroke of the given frame */
724 void BKE_gpencil_frame_delete_laststroke(bGPDlayer *gpl, bGPDframe *gpf)
725 {
726   bGPDstroke *gps = (gpf) ? gpf->strokes.last : NULL;
727   int cfra = (gpf) ? gpf->framenum : 0; /* assume that the current frame was not locked */
728
729   /* error checking */
730   if (ELEM(NULL, gpf, gps)) {
731     return;
732   }
733
734   /* free the stroke and its data */
735   if (gps->points) {
736     MEM_freeN(gps->points);
737   }
738   if (gps->dvert) {
739     BKE_gpencil_free_stroke_weights(gps);
740     MEM_freeN(gps->dvert);
741   }
742   MEM_freeN(gps->triangles);
743   BLI_freelinkN(&gpf->strokes, gps);
744
745   /* if frame has no strokes after this, delete it */
746   if (BLI_listbase_is_empty(&gpf->strokes)) {
747     BKE_gpencil_layer_delframe(gpl, gpf);
748     BKE_gpencil_layer_getframe(gpl, cfra, GP_GETFRAME_USE_PREV);
749   }
750 }
751
752 /* ************************************************** */
753 /* GP Layer API */
754
755 /* Check if the given layer is able to be edited or not */
756 bool gpencil_layer_is_editable(const bGPDlayer *gpl)
757 {
758   /* Sanity check */
759   if (gpl == NULL) {
760     return false;
761   }
762
763   /* Layer must be: Visible + Editable */
764   if ((gpl->flag & (GP_LAYER_HIDE | GP_LAYER_LOCKED)) == 0) {
765     /* Opacity must be sufficiently high that it is still "visible"
766      * Otherwise, it's not really "visible" to the user, so no point editing...
767      */
768     if (gpl->opacity > GPENCIL_ALPHA_OPACITY_THRESH) {
769       return true;
770     }
771   }
772
773   /* Something failed */
774   return false;
775 }
776
777 /* Look up the gp-frame on the requested frame number, but don't add a new one */
778 bGPDframe *BKE_gpencil_layer_find_frame(bGPDlayer *gpl, int cframe)
779 {
780   bGPDframe *gpf;
781
782   /* Search in reverse order, since this is often used for playback/adding,
783    * where it's less likely that we're interested in the earlier frames
784    */
785   for (gpf = gpl->frames.last; gpf; gpf = gpf->prev) {
786     if (gpf->framenum == cframe) {
787       return gpf;
788     }
789   }
790
791   return NULL;
792 }
793
794 /* get the appropriate gp-frame from a given layer
795  * - this sets the layer's actframe var (if allowed to)
796  * - extension beyond range (if first gp-frame is after all frame in interest and cannot add)
797  */
798 bGPDframe *BKE_gpencil_layer_getframe(bGPDlayer *gpl, int cframe, eGP_GetFrame_Mode addnew)
799 {
800   bGPDframe *gpf = NULL;
801   short found = 0;
802
803   /* error checking */
804   if (gpl == NULL) {
805     return NULL;
806   }
807
808   /* check if there is already an active frame */
809   if (gpl->actframe) {
810     gpf = gpl->actframe;
811
812     /* do not allow any changes to layer's active frame if layer is locked from changes
813      * or if the layer has been set to stay on the current frame
814      */
815     if (gpl->flag & GP_LAYER_FRAMELOCK) {
816       return gpf;
817     }
818     /* do not allow any changes to actframe if frame has painting tag attached to it */
819     if (gpf->flag & GP_FRAME_PAINT) {
820       return gpf;
821     }
822
823     /* try to find matching frame */
824     if (gpf->framenum < cframe) {
825       for (; gpf; gpf = gpf->next) {
826         if (gpf->framenum == cframe) {
827           found = 1;
828           break;
829         }
830         else if ((gpf->next) && (gpf->next->framenum > cframe)) {
831           found = 1;
832           break;
833         }
834       }
835
836       /* set the appropriate frame */
837       if (addnew) {
838         if ((found) && (gpf->framenum == cframe)) {
839           gpl->actframe = gpf;
840         }
841         else if (addnew == GP_GETFRAME_ADD_COPY) {
842           gpl->actframe = BKE_gpencil_frame_addcopy(gpl, cframe);
843         }
844         else {
845           gpl->actframe = BKE_gpencil_frame_addnew(gpl, cframe);
846         }
847       }
848       else if (found) {
849         gpl->actframe = gpf;
850       }
851       else {
852         gpl->actframe = gpl->frames.last;
853       }
854     }
855     else {
856       for (; gpf; gpf = gpf->prev) {
857         if (gpf->framenum <= cframe) {
858           found = 1;
859           break;
860         }
861       }
862
863       /* set the appropriate frame */
864       if (addnew) {
865         if ((found) && (gpf->framenum == cframe)) {
866           gpl->actframe = gpf;
867         }
868         else if (addnew == GP_GETFRAME_ADD_COPY) {
869           gpl->actframe = BKE_gpencil_frame_addcopy(gpl, cframe);
870         }
871         else {
872           gpl->actframe = BKE_gpencil_frame_addnew(gpl, cframe);
873         }
874       }
875       else if (found) {
876         gpl->actframe = gpf;
877       }
878       else {
879         gpl->actframe = gpl->frames.first;
880       }
881     }
882   }
883   else if (gpl->frames.first) {
884     /* check which of the ends to start checking from */
885     const int first = ((bGPDframe *)(gpl->frames.first))->framenum;
886     const int last = ((bGPDframe *)(gpl->frames.last))->framenum;
887
888     if (abs(cframe - first) > abs(cframe - last)) {
889       /* find gp-frame which is less than or equal to cframe */
890       for (gpf = gpl->frames.last; gpf; gpf = gpf->prev) {
891         if (gpf->framenum <= cframe) {
892           found = 1;
893           break;
894         }
895       }
896     }
897     else {
898       /* find gp-frame which is less than or equal to cframe */
899       for (gpf = gpl->frames.first; gpf; gpf = gpf->next) {
900         if (gpf->framenum <= cframe) {
901           found = 1;
902           break;
903         }
904       }
905     }
906
907     /* set the appropriate frame */
908     if (addnew) {
909       if ((found) && (gpf->framenum == cframe)) {
910         gpl->actframe = gpf;
911       }
912       else {
913         gpl->actframe = BKE_gpencil_frame_addnew(gpl, cframe);
914       }
915     }
916     else if (found) {
917       gpl->actframe = gpf;
918     }
919     else {
920       /* unresolved errogenous situation! */
921       CLOG_STR_ERROR(&LOG, "cannot find appropriate gp-frame");
922       /* gpl->actframe should still be NULL */
923     }
924   }
925   else {
926     /* currently no frames (add if allowed to) */
927     if (addnew) {
928       gpl->actframe = BKE_gpencil_frame_addnew(gpl, cframe);
929     }
930     else {
931       /* don't do anything... this may be when no frames yet! */
932       /* gpl->actframe should still be NULL */
933     }
934   }
935
936   /* return */
937   return gpl->actframe;
938 }
939
940 /* delete the given frame from a layer */
941 bool BKE_gpencil_layer_delframe(bGPDlayer *gpl, bGPDframe *gpf)
942 {
943   bool changed = false;
944
945   /* error checking */
946   if (ELEM(NULL, gpl, gpf)) {
947     return false;
948   }
949
950   /* if this frame was active, make the previous frame active instead
951    * since it's tricky to set active frame otherwise
952    */
953   if (gpl->actframe == gpf) {
954     gpl->actframe = gpf->prev;
955   }
956
957   /* free the frame and its data */
958   changed = BKE_gpencil_free_strokes(gpf);
959   BLI_freelinkN(&gpl->frames, gpf);
960
961   return changed;
962 }
963
964 /* get the active gp-layer for editing */
965 bGPDlayer *BKE_gpencil_layer_getactive(bGPdata *gpd)
966 {
967   bGPDlayer *gpl;
968
969   /* error checking */
970   if (ELEM(NULL, gpd, gpd->layers.first)) {
971     return NULL;
972   }
973
974   /* loop over layers until found (assume only one active) */
975   for (gpl = gpd->layers.first; gpl; gpl = gpl->next) {
976     if (gpl->flag & GP_LAYER_ACTIVE) {
977       return gpl;
978     }
979   }
980
981   /* no active layer found */
982   return NULL;
983 }
984
985 /* set the active gp-layer */
986 void BKE_gpencil_layer_setactive(bGPdata *gpd, bGPDlayer *active)
987 {
988   bGPDlayer *gpl;
989
990   /* error checking */
991   if (ELEM(NULL, gpd, gpd->layers.first, active)) {
992     return;
993   }
994
995   /* loop over layers deactivating all */
996   for (gpl = gpd->layers.first; gpl; gpl = gpl->next) {
997     gpl->flag &= ~GP_LAYER_ACTIVE;
998     if (gpd->flag & GP_DATA_AUTOLOCK_LAYERS) {
999       gpl->flag |= GP_LAYER_LOCKED;
1000     }
1001   }
1002
1003   /* set as active one */
1004   active->flag |= GP_LAYER_ACTIVE;
1005   if (gpd->flag & GP_DATA_AUTOLOCK_LAYERS) {
1006     active->flag &= ~GP_LAYER_LOCKED;
1007   }
1008 }
1009
1010 /* delete the active gp-layer */
1011 void BKE_gpencil_layer_delete(bGPdata *gpd, bGPDlayer *gpl)
1012 {
1013   /* error checking */
1014   if (ELEM(NULL, gpd, gpl)) {
1015     return;
1016   }
1017
1018   /* free layer */
1019   BKE_gpencil_free_frames(gpl);
1020
1021   /* free icon providing preview of icon color */
1022   BKE_icon_delete(gpl->runtime.icon_id);
1023
1024   BLI_freelinkN(&gpd->layers, gpl);
1025 }
1026
1027 Material *BKE_gpencil_brush_material_get(Brush *brush)
1028 {
1029   Material *ma = NULL;
1030
1031   if ((brush != NULL) && (brush->gpencil_settings != NULL) &&
1032       (brush->gpencil_settings->material != NULL)) {
1033     ma = brush->gpencil_settings->material;
1034   }
1035
1036   return ma;
1037 }
1038
1039 void BKE_gpencil_brush_material_set(Brush *brush, Material *ma)
1040 {
1041   BLI_assert(brush);
1042   BLI_assert(brush->gpencil_settings);
1043   if (brush->gpencil_settings->material != ma) {
1044     if (brush->gpencil_settings->material) {
1045       id_us_min(&brush->gpencil_settings->material->id);
1046     }
1047     if (ma) {
1048       id_us_plus(&ma->id);
1049     }
1050     brush->gpencil_settings->material = ma;
1051   }
1052 }
1053
1054 /* Adds the pinned material to the object if necessary. */
1055 Material *BKE_gpencil_object_material_ensure_from_brush(Main *bmain, Object *ob, Brush *brush)
1056 {
1057   if (brush->gpencil_settings->flag & GP_BRUSH_MATERIAL_PINNED) {
1058     Material *ma = BKE_gpencil_brush_material_get(brush);
1059
1060     /* check if the material is already on object material slots and add it if missing */
1061     if (ma && BKE_gpencil_object_material_get_index(ob, ma) < 0) {
1062       BKE_object_material_slot_add(bmain, ob);
1063       assign_material(bmain, ob, ma, ob->totcol, BKE_MAT_ASSIGN_USERPREF);
1064     }
1065
1066     return ma;
1067   }
1068   else {
1069     /* using active material instead */
1070     return give_current_material(ob, ob->actcol);
1071   }
1072 }
1073
1074 /* Assigns the material to object (if not already present) and returns its index (mat_nr). */
1075 int BKE_gpencil_object_material_ensure(Main *bmain, Object *ob, Material *material)
1076 {
1077   if (!material) {
1078     return -1;
1079   }
1080   int index = BKE_gpencil_object_material_get_index(ob, material);
1081   if (index < 0) {
1082     BKE_object_material_slot_add(bmain, ob);
1083     assign_material(bmain, ob, material, ob->totcol, BKE_MAT_ASSIGN_USERPREF);
1084     return ob->totcol - 1;
1085   }
1086   return index;
1087 }
1088
1089 /** Creates a new gpencil material and assigns it to object.
1090  *
1091  * \param *r_index: value is set to zero based index of the new material if r_index is not NULL
1092  */
1093 Material *BKE_gpencil_object_material_new(Main *bmain, Object *ob, const char *name, int *r_index)
1094 {
1095   Material *ma = BKE_material_add_gpencil(bmain, name);
1096   id_us_min(&ma->id); /* no users yet */
1097
1098   BKE_object_material_slot_add(bmain, ob);
1099   assign_material(bmain, ob, ma, ob->totcol, BKE_MAT_ASSIGN_USERPREF);
1100
1101   if (r_index) {
1102     *r_index = ob->actcol - 1;
1103   }
1104   return ma;
1105 }
1106
1107 /* Returns the material for a brush with respect to its pinned state. */
1108 Material *BKE_gpencil_object_material_get_from_brush(Object *ob, Brush *brush)
1109 {
1110   if ((brush) && (brush->gpencil_settings->flag & GP_BRUSH_MATERIAL_PINNED)) {
1111     Material *ma = BKE_gpencil_brush_material_get(brush);
1112     return ma;
1113   }
1114   else {
1115     return give_current_material(ob, ob->actcol);
1116   }
1117 }
1118
1119 /* Returns the material index for a brush with respect to its pinned state. */
1120 int BKE_gpencil_object_material_get_index_from_brush(Object *ob, Brush *brush)
1121 {
1122   if ((brush) && (brush->gpencil_settings->flag & GP_BRUSH_MATERIAL_PINNED)) {
1123     return BKE_gpencil_object_material_get_index(ob, brush->gpencil_settings->material);
1124   }
1125   else {
1126     return ob->actcol - 1;
1127   }
1128 }
1129
1130 /* Guaranteed to return a material assigned to object. Returns never NULL. */
1131 Material *BKE_gpencil_object_material_ensure_from_active_input_toolsettings(Main *bmain,
1132                                                                             Object *ob,
1133                                                                             ToolSettings *ts)
1134 {
1135   if (ts && ts->gp_paint && ts->gp_paint->paint.brush) {
1136     return BKE_gpencil_object_material_ensure_from_active_input_brush(
1137         bmain, ob, ts->gp_paint->paint.brush);
1138   }
1139   else {
1140     return BKE_gpencil_object_material_ensure_from_active_input_brush(bmain, ob, NULL);
1141   }
1142 }
1143
1144 /* Guaranteed to return a material assigned to object. Returns never NULL. */
1145 Material *BKE_gpencil_object_material_ensure_from_active_input_brush(Main *bmain,
1146                                                                      Object *ob,
1147                                                                      Brush *brush)
1148 {
1149   if (brush) {
1150     Material *ma = BKE_gpencil_object_material_ensure_from_brush(bmain, ob, brush);
1151     if (ma) {
1152       return ma;
1153     }
1154     else if (brush->gpencil_settings->flag & GP_BRUSH_MATERIAL_PINNED) {
1155       /* it is easier to just unpin a NULL material, instead of setting a new one */
1156       brush->gpencil_settings->flag &= ~GP_BRUSH_MATERIAL_PINNED;
1157     }
1158   }
1159   return BKE_gpencil_object_material_ensure_from_active_input_material(bmain, ob);
1160 }
1161
1162 /* Guaranteed to return a material assigned to object. Returns never NULL. Only use this for materials unrelated to user input */
1163 Material *BKE_gpencil_object_material_ensure_from_active_input_material(Main *bmain, Object *ob)
1164 {
1165   Material *ma = give_current_material(ob, ob->actcol);
1166   if (ma) {
1167     return ma;
1168   }
1169   return BKE_gpencil_object_material_new(bmain, ob, "Material", NULL);
1170 }
1171
1172 /* Get active color, and add all default settings if we don't find anything */
1173 Material *BKE_gpencil_object_material_ensure_active(Main *bmain, Object *ob)
1174 {
1175   Material *ma = NULL;
1176
1177   /* sanity checks */
1178   if (ELEM(NULL, bmain, ob)) {
1179     return NULL;
1180   }
1181
1182   ma = BKE_gpencil_object_material_ensure_from_active_input_material(bmain, ob);
1183   if (ma->gp_style == NULL) {
1184     BKE_material_init_gpencil_settings(ma);
1185   }
1186
1187   return ma;
1188 }
1189
1190 /* ************************************************** */
1191 /* GP Object - Boundbox Support */
1192
1193 /**
1194  * Get min/max coordinate bounds for single stroke
1195  * \return Returns whether we found any selected points
1196  */
1197 bool BKE_gpencil_stroke_minmax(const bGPDstroke *gps,
1198                                const bool use_select,
1199                                float r_min[3],
1200                                float r_max[3])
1201 {
1202   const bGPDspoint *pt;
1203   int i;
1204   bool changed = false;
1205
1206   if (ELEM(NULL, gps, r_min, r_max)) {
1207     return false;
1208   }
1209
1210   for (i = 0, pt = gps->points; i < gps->totpoints; i++, pt++) {
1211     if ((use_select == false) || (pt->flag & GP_SPOINT_SELECT)) {
1212       minmax_v3v3_v3(r_min, r_max, &pt->x);
1213       changed = true;
1214     }
1215   }
1216   return changed;
1217 }
1218
1219 /* get min/max bounds of all strokes in GP datablock */
1220 bool BKE_gpencil_data_minmax(const bGPdata *gpd, float r_min[3], float r_max[3])
1221 {
1222   bool changed = false;
1223
1224   INIT_MINMAX(r_min, r_max);
1225
1226   if (gpd == NULL) {
1227     return changed;
1228   }
1229
1230   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1231     bGPDframe *gpf = gpl->actframe;
1232
1233     if (gpf != NULL) {
1234       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1235         changed = BKE_gpencil_stroke_minmax(gps, false, r_min, r_max);
1236       }
1237     }
1238   }
1239
1240   return changed;
1241 }
1242
1243 bool BKE_gpencil_stroke_select_check(const bGPDstroke *gps)
1244 {
1245   const bGPDspoint *pt;
1246   int i;
1247   for (i = 0, pt = gps->points; i < gps->totpoints; i++, pt++) {
1248     if (pt->flag & GP_SPOINT_SELECT) {
1249       return true;
1250     }
1251   }
1252   return false;
1253 }
1254
1255 /* compute center of bounding box */
1256 void BKE_gpencil_centroid_3d(bGPdata *gpd, float r_centroid[3])
1257 {
1258   float min[3], max[3], tot[3];
1259
1260   BKE_gpencil_data_minmax(gpd, min, max);
1261
1262   add_v3_v3v3(tot, min, max);
1263   mul_v3_v3fl(r_centroid, tot, 0.5f);
1264 }
1265
1266 /* create bounding box values */
1267 static void boundbox_gpencil(Object *ob)
1268 {
1269   BoundBox *bb;
1270   bGPdata *gpd;
1271   float min[3], max[3];
1272
1273   if (ob->runtime.bb == NULL) {
1274     ob->runtime.bb = MEM_callocN(sizeof(BoundBox), "GPencil boundbox");
1275   }
1276
1277   bb = ob->runtime.bb;
1278   gpd = ob->data;
1279
1280   if (!BKE_gpencil_data_minmax(gpd, min, max)) {
1281     min[0] = min[1] = min[2] = -1.0f;
1282     max[0] = max[1] = max[2] = 1.0f;
1283   }
1284
1285   BKE_boundbox_init_from_minmax(bb, min, max);
1286
1287   bb->flag &= ~BOUNDBOX_DIRTY;
1288 }
1289
1290 /* get bounding box */
1291 BoundBox *BKE_gpencil_boundbox_get(Object *ob)
1292 {
1293   if (ELEM(NULL, ob, ob->data)) {
1294     return NULL;
1295   }
1296
1297   bGPdata *gpd = (bGPdata *)ob->data;
1298   if ((ob->runtime.bb) && ((gpd->flag & GP_DATA_CACHE_IS_DIRTY) == 0)) {
1299     return ob->runtime.bb;
1300   }
1301
1302   boundbox_gpencil(ob);
1303
1304   return ob->runtime.bb;
1305 }
1306
1307 /* ************************************************** */
1308 /* Apply Transforms */
1309
1310 void BKE_gpencil_transform(bGPdata *gpd, float mat[4][4])
1311 {
1312   if (gpd == NULL) {
1313     return;
1314   }
1315
1316   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1317     /* FIXME: For now, we just skip parented layers.
1318      * Otherwise, we have to update each frame to find
1319      * the current parent position/effects.
1320      */
1321     if (gpl->parent) {
1322       continue;
1323     }
1324
1325     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1326       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1327         bGPDspoint *pt;
1328         int i;
1329
1330         for (pt = gps->points, i = 0; i < gps->totpoints; pt++, i++) {
1331           mul_m4_v3(mat, &pt->x);
1332         }
1333
1334         /* TODO: Do we need to do this? distortion may mean we need to re-triangulate */
1335         gps->flag |= GP_STROKE_RECALC_GEOMETRY;
1336         gps->tot_triangles = 0;
1337       }
1338     }
1339   }
1340 }
1341
1342 /* ************************************************** */
1343 /* GP Object - Vertex Groups */
1344
1345 /* remove a vertex group */
1346 void BKE_gpencil_vgroup_remove(Object *ob, bDeformGroup *defgroup)
1347 {
1348   bGPdata *gpd = ob->data;
1349   MDeformVert *dvert = NULL;
1350   const int def_nr = BLI_findindex(&ob->defbase, defgroup);
1351
1352   /* Remove points data */
1353   if (gpd) {
1354     for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1355       for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1356         for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1357           if (gps->dvert != NULL) {
1358             for (int i = 0; i < gps->totpoints; i++) {
1359               dvert = &gps->dvert[i];
1360               MDeformWeight *dw = defvert_find_index(dvert, def_nr);
1361               if (dw != NULL) {
1362                 defvert_remove_group(dvert, dw);
1363               }
1364               else {
1365                 /* reorganize weights in other strokes */
1366                 for (int g = 0; g < gps->dvert->totweight; g++) {
1367                   dw = &dvert->dw[g];
1368                   if ((dw != NULL) && (dw->def_nr > def_nr)) {
1369                     dw->def_nr--;
1370                   }
1371                 }
1372               }
1373             }
1374           }
1375         }
1376       }
1377     }
1378   }
1379
1380   /* Remove the group */
1381   BLI_freelinkN(&ob->defbase, defgroup);
1382   DEG_id_tag_update(&gpd->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY);
1383 }
1384
1385 void BKE_gpencil_dvert_ensure(bGPDstroke *gps)
1386 {
1387   if (gps->dvert == NULL) {
1388     gps->dvert = MEM_callocN(sizeof(MDeformVert) * gps->totpoints, "gp_stroke_weights");
1389   }
1390 }
1391
1392 /* ************************************************** */
1393
1394 /**
1395  * Apply smooth to stroke point
1396  * \param gps: Stroke to smooth
1397  * \param i: Point index
1398  * \param inf: Amount of smoothing to apply
1399  */
1400 bool BKE_gpencil_smooth_stroke(bGPDstroke *gps, int i, float inf)
1401 {
1402   bGPDspoint *pt = &gps->points[i];
1403   // float pressure = 0.0f;
1404   float sco[3] = {0.0f};
1405
1406   /* Do nothing if not enough points to smooth out */
1407   if (gps->totpoints <= 2) {
1408     return false;
1409   }
1410
1411   /* Only affect endpoints by a fraction of the normal strength,
1412    * to prevent the stroke from shrinking too much
1413    */
1414   if ((i == 0) || (i == gps->totpoints - 1)) {
1415     inf *= 0.1f;
1416   }
1417
1418   /* Compute smoothed coordinate by taking the ones nearby */
1419   /* XXX: This is potentially slow, and suffers from accumulation error as earlier points are handled before later ones */
1420   {
1421     // XXX: this is hardcoded to look at 2 points on either side of the current one (i.e. 5 items total)
1422     const int steps = 2;
1423     const float average_fac = 1.0f / (float)(steps * 2 + 1);
1424     int step;
1425
1426     /* add the point itself */
1427     madd_v3_v3fl(sco, &pt->x, average_fac);
1428
1429     /* n-steps before/after current point */
1430     // XXX: review how the endpoints are treated by this algorithm
1431     // XXX: falloff measures should also introduce some weighting variations, so that further-out points get less weight
1432     for (step = 1; step <= steps; step++) {
1433       bGPDspoint *pt1, *pt2;
1434       int before = i - step;
1435       int after = i + step;
1436
1437       CLAMP_MIN(before, 0);
1438       CLAMP_MAX(after, gps->totpoints - 1);
1439
1440       pt1 = &gps->points[before];
1441       pt2 = &gps->points[after];
1442
1443       /* add both these points to the average-sum (s += p[i]/n) */
1444       madd_v3_v3fl(sco, &pt1->x, average_fac);
1445       madd_v3_v3fl(sco, &pt2->x, average_fac);
1446     }
1447   }
1448
1449   /* Based on influence factor, blend between original and optimal smoothed coordinate */
1450   interp_v3_v3v3(&pt->x, &pt->x, sco, inf);
1451
1452   return true;
1453 }
1454
1455 /**
1456  * Apply smooth for strength to stroke point */
1457 bool BKE_gpencil_smooth_stroke_strength(bGPDstroke *gps, int point_index, float influence)
1458 {
1459   bGPDspoint *ptb = &gps->points[point_index];
1460
1461   /* Do nothing if not enough points */
1462   if (gps->totpoints <= 2) {
1463     return false;
1464   }
1465
1466   /* Compute theoretical optimal value using distances */
1467   bGPDspoint *pta, *ptc;
1468   int before = point_index - 1;
1469   int after = point_index + 1;
1470
1471   CLAMP_MIN(before, 0);
1472   CLAMP_MAX(after, gps->totpoints - 1);
1473
1474   pta = &gps->points[before];
1475   ptc = &gps->points[after];
1476
1477   /* the optimal value is the corresponding to the interpolation of the strength
1478    * at the distance of point b
1479    */
1480   float fac = line_point_factor_v3(&ptb->x, &pta->x, &ptc->x);
1481   /* sometimes the factor can be wrong due stroke geometry, so use middle point */
1482   if ((fac < 0.0f) || (fac > 1.0f)) {
1483     fac = 0.5f;
1484   }
1485   const float optimal = (1.0f - fac) * pta->strength + fac * ptc->strength;
1486
1487   /* Based on influence factor, blend between original and optimal */
1488   ptb->strength = (1.0f - influence) * ptb->strength + influence * optimal;
1489
1490   return true;
1491 }
1492
1493 /**
1494  * Apply smooth for thickness to stroke point (use pressure) */
1495 bool BKE_gpencil_smooth_stroke_thickness(bGPDstroke *gps, int point_index, float influence)
1496 {
1497   bGPDspoint *ptb = &gps->points[point_index];
1498
1499   /* Do nothing if not enough points */
1500   if ((gps->totpoints <= 2) || (point_index < 1)) {
1501     return false;
1502   }
1503
1504   /* Compute theoretical optimal value using distances */
1505   bGPDspoint *pta, *ptc;
1506   int before = point_index - 1;
1507   int after = point_index + 1;
1508
1509   CLAMP_MIN(before, 0);
1510   CLAMP_MAX(after, gps->totpoints - 1);
1511
1512   pta = &gps->points[before];
1513   ptc = &gps->points[after];
1514
1515   /* the optimal value is the corresponding to the interpolation of the pressure
1516    * at the distance of point b
1517    */
1518   float fac = line_point_factor_v3(&ptb->x, &pta->x, &ptc->x);
1519   /* sometimes the factor can be wrong due stroke geometry, so use middle point */
1520   if ((fac < 0.0f) || (fac > 1.0f)) {
1521     fac = 0.5f;
1522   }
1523   float optimal = interpf(ptc->pressure, pta->pressure, fac);
1524
1525   /* Based on influence factor, blend between original and optimal */
1526   ptb->pressure = interpf(optimal, ptb->pressure, influence);
1527
1528   return true;
1529 }
1530
1531 /**
1532  * Apply smooth for UV rotation to stroke point (use pressure).
1533  */
1534 bool BKE_gpencil_smooth_stroke_uv(bGPDstroke *gps, int point_index, float influence)
1535 {
1536   bGPDspoint *ptb = &gps->points[point_index];
1537
1538   /* Do nothing if not enough points */
1539   if (gps->totpoints <= 2) {
1540     return false;
1541   }
1542
1543   /* Compute theoretical optimal value */
1544   bGPDspoint *pta, *ptc;
1545   int before = point_index - 1;
1546   int after = point_index + 1;
1547
1548   CLAMP_MIN(before, 0);
1549   CLAMP_MAX(after, gps->totpoints - 1);
1550
1551   pta = &gps->points[before];
1552   ptc = &gps->points[after];
1553
1554   /* the optimal value is the corresponding to the interpolation of the pressure
1555    * at the distance of point b
1556    */
1557   float fac = line_point_factor_v3(&ptb->x, &pta->x, &ptc->x);
1558   /* sometimes the factor can be wrong due stroke geometry, so use middle point */
1559   if ((fac < 0.0f) || (fac > 1.0f)) {
1560     fac = 0.5f;
1561   }
1562   float optimal = interpf(ptc->uv_rot, pta->uv_rot, fac);
1563
1564   /* Based on influence factor, blend between original and optimal */
1565   ptb->uv_rot = interpf(optimal, ptb->uv_rot, influence);
1566   CLAMP(ptb->uv_rot, -M_PI_2, M_PI_2);
1567
1568   return true;
1569 }
1570
1571 /**
1572  * Get range of selected frames in layer.
1573  * Always the active frame is considered as selected, so if no more selected the range
1574  * will be equal to the current active frame.
1575  * \param gpl: Layer
1576  * \param r_initframe: Number of first selected frame
1577  * \param r_endframe: Number of last selected frame
1578  */
1579 void BKE_gpencil_get_range_selected(bGPDlayer *gpl, int *r_initframe, int *r_endframe)
1580 {
1581   *r_initframe = gpl->actframe->framenum;
1582   *r_endframe = gpl->actframe->framenum;
1583
1584   for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1585     if (gpf->flag & GP_FRAME_SELECT) {
1586       if (gpf->framenum < *r_initframe) {
1587         *r_initframe = gpf->framenum;
1588       }
1589       if (gpf->framenum > *r_endframe) {
1590         *r_endframe = gpf->framenum;
1591       }
1592     }
1593   }
1594 }
1595
1596 /**
1597  * Get Falloff factor base on frame range
1598  * \param gpf: Frame
1599  * \param actnum: Number of active frame in layer
1600  * \param f_init: Number of first selected frame
1601  * \param f_end: Number of last selected frame
1602  * \param cur_falloff: Curve with falloff factors
1603  */
1604 float BKE_gpencil_multiframe_falloff_calc(
1605     bGPDframe *gpf, int actnum, int f_init, int f_end, CurveMapping *cur_falloff)
1606 {
1607   float fnum = 0.5f; /* default mid curve */
1608   float value;
1609
1610   /* check curve is available */
1611   if (cur_falloff == NULL) {
1612     return 1.0f;
1613   }
1614
1615   /* frames to the right of the active frame */
1616   if (gpf->framenum < actnum) {
1617     fnum = (float)(gpf->framenum - f_init) / (actnum - f_init);
1618     fnum *= 0.5f;
1619     value = curvemapping_evaluateF(cur_falloff, 0, fnum);
1620   }
1621   /* frames to the left of the active frame */
1622   else if (gpf->framenum > actnum) {
1623     fnum = (float)(gpf->framenum - actnum) / (f_end - actnum);
1624     fnum *= 0.5f;
1625     value = curvemapping_evaluateF(cur_falloff, 0, fnum + 0.5f);
1626   }
1627   else {
1628     value = 1.0f;
1629   }
1630
1631   return value;
1632 }
1633
1634 /* remove strokes using a material */
1635 void BKE_gpencil_material_index_remove(bGPdata *gpd, int index)
1636 {
1637   bGPDstroke *gps, *gpsn;
1638
1639   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1640     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1641       for (gps = gpf->strokes.first; gps; gps = gpsn) {
1642         gpsn = gps->next;
1643         if (gps->mat_nr == index) {
1644           if (gps->points) {
1645             MEM_freeN(gps->points);
1646           }
1647           if (gps->dvert) {
1648             BKE_gpencil_free_stroke_weights(gps);
1649             MEM_freeN(gps->dvert);
1650           }
1651           if (gps->triangles) {
1652             MEM_freeN(gps->triangles);
1653           }
1654           BLI_freelinkN(&gpf->strokes, gps);
1655         }
1656         else {
1657           /* reassign strokes */
1658           if (gps->mat_nr > index) {
1659             gps->mat_nr--;
1660           }
1661         }
1662       }
1663     }
1664   }
1665 }
1666
1667 void BKE_gpencil_material_remap(struct bGPdata *gpd,
1668                                 const unsigned int *remap,
1669                                 unsigned int remap_len)
1670 {
1671   const short remap_len_short = (short)remap_len;
1672
1673 #define MAT_NR_REMAP(n) \
1674   if (n < remap_len_short) { \
1675     BLI_assert(n >= 0 && remap[n] < remap_len_short); \
1676     n = remap[n]; \
1677   } \
1678   ((void)0)
1679
1680   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1681     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1682       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1683         /* reassign strokes */
1684         MAT_NR_REMAP(gps->mat_nr);
1685       }
1686     }
1687   }
1688
1689 #undef MAT_NR_REMAP
1690 }
1691
1692 /* statistics functions */
1693 void BKE_gpencil_stats_update(bGPdata *gpd)
1694 {
1695   gpd->totlayer = 0;
1696   gpd->totframe = 0;
1697   gpd->totstroke = 0;
1698   gpd->totpoint = 0;
1699
1700   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1701     gpd->totlayer++;
1702     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1703       gpd->totframe++;
1704       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1705         gpd->totstroke++;
1706         gpd->totpoint += gps->totpoints;
1707       }
1708     }
1709   }
1710 }
1711
1712 /* get material index (0-based like mat_nr not actcol) */
1713 int BKE_gpencil_object_material_get_index(Object *ob, Material *ma)
1714 {
1715   short *totcol = give_totcolp(ob);
1716   Material *read_ma = NULL;
1717   for (short i = 0; i < *totcol; i++) {
1718     read_ma = give_current_material(ob, i + 1);
1719     if (ma == read_ma) {
1720       return i;
1721     }
1722   }
1723
1724   return -1;
1725 }
1726
1727 /* Get points of stroke always flat to view not affected by camera view or view position */
1728 void BKE_gpencil_stroke_2d_flat(const bGPDspoint *points,
1729                                 int totpoints,
1730                                 float (*points2d)[2],
1731                                 int *r_direction)
1732 {
1733   BLI_assert(totpoints >= 2);
1734
1735   const bGPDspoint *pt0 = &points[0];
1736   const bGPDspoint *pt1 = &points[1];
1737   const bGPDspoint *pt3 = &points[(int)(totpoints * 0.75)];
1738
1739   float locx[3];
1740   float locy[3];
1741   float loc3[3];
1742   float normal[3];
1743
1744   /* local X axis (p0 -> p1) */
1745   sub_v3_v3v3(locx, &pt1->x, &pt0->x);
1746
1747   /* point vector at 3/4 */
1748   float v3[3];
1749   if (totpoints == 2) {
1750     mul_v3_v3fl(v3, &pt3->x, 0.001f);
1751   }
1752   else {
1753     copy_v3_v3(v3, &pt3->x);
1754   }
1755
1756   sub_v3_v3v3(loc3, v3, &pt0->x);
1757
1758   /* vector orthogonal to polygon plane */
1759   cross_v3_v3v3(normal, locx, loc3);
1760
1761   /* local Y axis (cross to normal/x axis) */
1762   cross_v3_v3v3(locy, normal, locx);
1763
1764   /* Normalize vectors */
1765   normalize_v3(locx);
1766   normalize_v3(locy);
1767
1768   /* Get all points in local space */
1769   for (int i = 0; i < totpoints; i++) {
1770     const bGPDspoint *pt = &points[i];
1771     float loc[3];
1772
1773     /* Get local space using first point as origin */
1774     sub_v3_v3v3(loc, &pt->x, &pt0->x);
1775
1776     points2d[i][0] = dot_v3v3(loc, locx);
1777     points2d[i][1] = dot_v3v3(loc, locy);
1778   }
1779
1780   /* Concave (-1), Convex (1), or Autodetect (0)? */
1781   *r_direction = (int)locy[2];
1782 }
1783
1784 /* Get points of stroke always flat to view not affected by camera view or view position
1785  * using another stroke as reference
1786  */
1787 void BKE_gpencil_stroke_2d_flat_ref(const bGPDspoint *ref_points,
1788                                     int ref_totpoints,
1789                                     const bGPDspoint *points,
1790                                     int totpoints,
1791                                     float (*points2d)[2],
1792                                     const float scale,
1793                                     int *r_direction)
1794 {
1795   BLI_assert(totpoints >= 2);
1796
1797   const bGPDspoint *pt0 = &ref_points[0];
1798   const bGPDspoint *pt1 = &ref_points[1];
1799   const bGPDspoint *pt3 = &ref_points[(int)(ref_totpoints * 0.75)];
1800
1801   float locx[3];
1802   float locy[3];
1803   float loc3[3];
1804   float normal[3];
1805
1806   /* local X axis (p0 -> p1) */
1807   sub_v3_v3v3(locx, &pt1->x, &pt0->x);
1808
1809   /* point vector at 3/4 */
1810   float v3[3];
1811   if (totpoints == 2) {
1812     mul_v3_v3fl(v3, &pt3->x, 0.001f);
1813   }
1814   else {
1815     copy_v3_v3(v3, &pt3->x);
1816   }
1817
1818   sub_v3_v3v3(loc3, v3, &pt0->x);
1819
1820   /* vector orthogonal to polygon plane */
1821   cross_v3_v3v3(normal, locx, loc3);
1822
1823   /* local Y axis (cross to normal/x axis) */
1824   cross_v3_v3v3(locy, normal, locx);
1825
1826   /* Normalize vectors */
1827   normalize_v3(locx);
1828   normalize_v3(locy);
1829
1830   /* Get all points in local space */
1831   for (int i = 0; i < totpoints; i++) {
1832     const bGPDspoint *pt = &points[i];
1833     float loc[3];
1834     float v1[3];
1835     float vn[3] = {0.0f, 0.0f, 0.0f};
1836
1837     /* apply scale to extremes of the stroke to get better collision detection
1838      * the scale is divided to get more control in the UI parameter
1839      */
1840     /* first point */
1841     if (i == 0) {
1842       const bGPDspoint *pt_next = &points[i + 1];
1843       sub_v3_v3v3(vn, &pt->x, &pt_next->x);
1844       normalize_v3(vn);
1845       mul_v3_fl(vn, scale / 10.0f);
1846       add_v3_v3v3(v1, &pt->x, vn);
1847     }
1848     /* last point */
1849     else if (i == totpoints - 1) {
1850       const bGPDspoint *pt_prev = &points[i - 1];
1851       sub_v3_v3v3(vn, &pt->x, &pt_prev->x);
1852       normalize_v3(vn);
1853       mul_v3_fl(vn, scale / 10.0f);
1854       add_v3_v3v3(v1, &pt->x, vn);
1855     }
1856     else {
1857       copy_v3_v3(v1, &pt->x);
1858     }
1859
1860     /* Get local space using first point as origin (ref stroke) */
1861     sub_v3_v3v3(loc, v1, &pt0->x);
1862
1863     points2d[i][0] = dot_v3v3(loc, locx);
1864     points2d[i][1] = dot_v3v3(loc, locy);
1865   }
1866
1867   /* Concave (-1), Convex (1), or Autodetect (0)? */
1868   *r_direction = (int)locy[2];
1869 }
1870
1871 /**
1872  * Trim stroke to the first intersection or loop
1873  * \param gps: Stroke data
1874  */
1875 bool BKE_gpencil_trim_stroke(bGPDstroke *gps)
1876 {
1877   if (gps->totpoints < 4) {
1878     return false;
1879   }
1880   bool intersect = false;
1881   int start, end;
1882   float point[3];
1883   /* loop segments from start until we have an intersection */
1884   for (int i = 0; i < gps->totpoints - 2; i++) {
1885     start = i;
1886     bGPDspoint *a = &gps->points[start];
1887     bGPDspoint *b = &gps->points[start + 1];
1888     for (int j = start + 2; j < gps->totpoints - 1; j++) {
1889       end = j + 1;
1890       bGPDspoint *c = &gps->points[j];
1891       bGPDspoint *d = &gps->points[end];
1892       float pointb[3];
1893       /* get intersection */
1894       if (isect_line_line_v3(&a->x, &b->x, &c->x, &d->x, point, pointb)) {
1895         if (len_v3(point) > 0.0f) {
1896           float closest[3];
1897           /* check intersection is on both lines */
1898           float lambda = closest_to_line_v3(closest, point, &a->x, &b->x);
1899           if ((lambda <= 0.0f) || (lambda >= 1.0f)) {
1900             continue;
1901           }
1902           lambda = closest_to_line_v3(closest, point, &c->x, &d->x);
1903           if ((lambda <= 0.0f) || (lambda >= 1.0f)) {
1904             continue;
1905           }
1906           else {
1907             intersect = true;
1908             break;
1909           }
1910         }
1911       }
1912     }
1913     if (intersect) {
1914       break;
1915     }
1916   }
1917
1918   /* trim unwanted points */
1919   if (intersect) {
1920
1921     /* save points */
1922     bGPDspoint *old_points = MEM_dupallocN(gps->points);
1923     MDeformVert *old_dvert = NULL;
1924     MDeformVert *dvert_src = NULL;
1925
1926     if (gps->dvert != NULL) {
1927       old_dvert = MEM_dupallocN(gps->dvert);
1928     }
1929
1930     /* resize gps */
1931     int newtot = end - start + 1;
1932
1933     gps->points = MEM_recallocN(gps->points, sizeof(*gps->points) * newtot);
1934     if (gps->dvert != NULL) {
1935       gps->dvert = MEM_recallocN(gps->dvert, sizeof(*gps->dvert) * newtot);
1936     }
1937
1938     for (int i = 0; i < newtot; i++) {
1939       int idx = start + i;
1940       bGPDspoint *pt_src = &old_points[idx];
1941       bGPDspoint *pt_new = &gps->points[i];
1942       memcpy(pt_new, pt_src, sizeof(bGPDspoint));
1943       if (gps->dvert != NULL) {
1944         dvert_src = &old_dvert[idx];
1945         MDeformVert *dvert = &gps->dvert[i];
1946         memcpy(dvert, dvert_src, sizeof(MDeformVert));
1947         if (dvert_src->dw) {
1948           memcpy(dvert->dw, dvert_src->dw, sizeof(MDeformWeight));
1949         }
1950       }
1951       if (idx == start || idx == end) {
1952         copy_v3_v3(&pt_new->x, point);
1953       }
1954     }
1955
1956     gps->flag |= GP_STROKE_RECALC_GEOMETRY;
1957     gps->tot_triangles = 0;
1958     gps->totpoints = newtot;
1959
1960     MEM_SAFE_FREE(old_points);
1961     MEM_SAFE_FREE(old_dvert);
1962   }
1963   return intersect;
1964 }