Base refactor 3/4
[blender.git] / source / blender / editors / gpencil / gpencil_utils.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2014, Blender Foundation
19  *
20  * Contributor(s): Joshua Leung, Antonio Vazquez
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/editors/gpencil/gpencil_utils.c
26  *  \ingroup edgpencil
27  */
28
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include <stddef.h>
33 #include <math.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BLI_math.h"
38 #include "BLI_blenlib.h"
39 #include "BLI_utildefines.h"
40 #include "BLT_translation.h"
41 #include "BLI_rand.h"
42
43 #include "DNA_gpencil_types.h"
44 #include "DNA_object_types.h"
45 #include "DNA_scene_types.h"
46 #include "DNA_screen_types.h"
47 #include "DNA_space_types.h"
48 #include "DNA_view3d_types.h"
49
50 #include "BKE_context.h"
51 #include "BKE_gpencil.h"
52 #include "BKE_tracking.h"
53 #include "BKE_action.h"
54
55 #include "WM_api.h"
56
57 #include "RNA_access.h"
58 #include "RNA_define.h"
59 #include "RNA_enum_types.h"
60
61 #include "UI_resources.h"
62 #include "UI_view2d.h"
63
64 #include "ED_gpencil.h"
65 #include "ED_clip.h"
66 #include "ED_view3d.h"
67
68 #include "gpencil_intern.h"
69
70 /* ******************************************************** */
71 /* Context Wrangling... */
72
73 /* Get pointer to active Grease Pencil datablock, and an RNA-pointer to trace back to whatever owns it,
74  * when context info is not available.
75  */
76 bGPdata **ED_gpencil_data_get_pointers_direct(ID *screen_id, Scene *scene, ScrArea *sa, Object *ob, PointerRNA *ptr)
77 {
78         /* if there's an active area, check if the particular editor may
79          * have defined any special Grease Pencil context for editing...
80          */
81         if (sa) {
82                 SpaceLink *sl = sa->spacedata.first;
83                 
84                 switch (sa->spacetype) {
85                         case SPACE_VIEW3D: /* 3D-View */
86                         {
87                                 BLI_assert(scene && ELEM(scene->toolsettings->gpencil_src,
88                                                          GP_TOOL_SOURCE_SCENE, GP_TOOL_SOURCE_OBJECT));
89                                 
90                                 if (scene->toolsettings->gpencil_src == GP_TOOL_SOURCE_OBJECT) {
91                                         /* legacy behaviour for usage with old addons requiring object-linked to objects */
92                                         
93                                         /* just in case no active/selected object... */
94                                         if (ob && (ob->flag & SELECT)) {
95                                                 /* for now, as long as there's an object, default to using that in 3D-View */
96                                                 if (ptr) RNA_id_pointer_create(&ob->id, ptr);
97                                                 return &ob->gpd;
98                                         }
99                                         /* else: defaults to scene... */
100                                 }
101                                 else {
102                                         if (ptr) RNA_id_pointer_create(&scene->id, ptr);
103                                         return &scene->gpd;
104                                 }
105                                 break;
106                         }
107                         case SPACE_NODE: /* Nodes Editor */
108                         {
109                                 SpaceNode *snode = (SpaceNode *)sl;
110                                 
111                                 /* return the GP data for the active node block/node */
112                                 if (snode && snode->nodetree) {
113                                         /* for now, as long as there's an active node tree, default to using that in the Nodes Editor */
114                                         if (ptr) RNA_id_pointer_create(&snode->nodetree->id, ptr);
115                                         return &snode->nodetree->gpd;
116                                 }
117                                 
118                                 /* even when there is no node-tree, don't allow this to flow to scene */
119                                 return NULL;
120                         }
121                         case SPACE_SEQ: /* Sequencer */
122                         {
123                                 SpaceSeq *sseq = (SpaceSeq *)sl;
124                         
125                                 /* for now, Grease Pencil data is associated with the space (actually preview region only) */
126                                 /* XXX our convention for everything else is to link to data though... */
127                                 if (ptr) RNA_pointer_create(screen_id, &RNA_SpaceSequenceEditor, sseq, ptr);
128                                 return &sseq->gpd;
129                         }
130                         case SPACE_IMAGE: /* Image/UV Editor */
131                         {
132                                 SpaceImage *sima = (SpaceImage *)sl;
133                                 
134                                 /* for now, Grease Pencil data is associated with the space... */
135                                 /* XXX our convention for everything else is to link to data though... */
136                                 if (ptr) RNA_pointer_create(screen_id, &RNA_SpaceImageEditor, sima, ptr);
137                                 return &sima->gpd;
138                         }
139                         case SPACE_CLIP: /* Nodes Editor */
140                         {
141                                 SpaceClip *sc = (SpaceClip *)sl;
142                                 MovieClip *clip = ED_space_clip_get_clip(sc);
143                                 
144                                 if (clip) {
145                                         if (sc->gpencil_src == SC_GPENCIL_SRC_TRACK) {
146                                                 MovieTrackingTrack *track = BKE_tracking_track_get_active(&clip->tracking);
147                                                 
148                                                 if (!track)
149                                                         return NULL;
150                                                 
151                                                 if (ptr)
152                                                         RNA_pointer_create(&clip->id, &RNA_MovieTrackingTrack, track, ptr);
153                                                 
154                                                 return &track->gpd;
155                                         }
156                                         else {
157                                                 if (ptr)
158                                                         RNA_id_pointer_create(&clip->id, ptr);
159                                                 
160                                                 return &clip->gpd;
161                                         }
162                                 }
163                                 break;
164                         }
165                         default: /* unsupported space */
166                                 return NULL;
167                 }
168         }
169         
170         /* just fall back on the scene's GP data */
171         if (ptr) RNA_id_pointer_create((ID *)scene, ptr);
172         return (scene) ? &scene->gpd : NULL;
173 }
174
175 /* Get pointer to active Grease Pencil datablock, and an RNA-pointer to trace back to whatever owns it */
176 bGPdata **ED_gpencil_data_get_pointers(const bContext *C, PointerRNA *ptr)
177 {
178         ID *screen_id = (ID *)CTX_wm_screen(C);
179         Scene *scene = CTX_data_scene(C);
180         ScrArea *sa = CTX_wm_area(C);
181         Object *ob = CTX_data_active_object(C);
182         
183         return ED_gpencil_data_get_pointers_direct(screen_id, scene, sa, ob, ptr);
184 }
185
186 /* -------------------------------------------------------- */
187
188 /* Get the active Grease Pencil datablock, when context is not available */
189 bGPdata *ED_gpencil_data_get_active_direct(ID *screen_id, Scene *scene, ScrArea *sa, Object *ob)
190 {
191         bGPdata **gpd_ptr = ED_gpencil_data_get_pointers_direct(screen_id, scene, sa, ob, NULL);
192         return (gpd_ptr) ? *(gpd_ptr) : NULL;
193 }
194
195 /* Get the active Grease Pencil datablock */
196 bGPdata *ED_gpencil_data_get_active(const bContext *C)
197 {
198         bGPdata **gpd_ptr = ED_gpencil_data_get_pointers(C, NULL);
199         return (gpd_ptr) ? *(gpd_ptr) : NULL;
200 }
201
202 /* -------------------------------------------------------- */
203
204 // XXX: this should be removed... We really shouldn't duplicate logic like this!
205 bGPdata *ED_gpencil_data_get_active_v3d(Scene *scene, View3D *v3d)
206 {
207         BaseLegacy *base = scene->basact;
208         bGPdata *gpd = NULL;
209         /* We have to make sure active object is actually visible and selected, else we must use default scene gpd,
210          * to be consistent with ED_gpencil_data_get_active's behavior.
211          */
212         
213         if (base && TESTBASE(v3d, base)) {
214                 gpd = base->object->gpd;
215         }
216         return gpd ? gpd : scene->gpd;
217 }
218
219 /* ******************************************************** */
220 /* Keyframe Indicator Checks */
221
222 /* Check whether there's an active GP keyframe on the current frame */
223 bool ED_gpencil_has_keyframe_v3d(Scene *scene, Object *ob, int cfra)
224 {
225         /* just check both for now... */
226         // XXX: this could get confusing (e.g. if only on the object, but other places don't show this)
227         if (scene->gpd) {
228                 bGPDlayer *gpl = BKE_gpencil_layer_getactive(scene->gpd);
229                 if (gpl) {
230                         if (gpl->actframe) {
231                                 // XXX: assumes that frame has been fetched already
232                                 return (gpl->actframe->framenum == cfra);
233                         }
234                         else {
235                                 /* XXX: disabled as could be too much of a penalty */
236                                 /* return BKE_gpencil_layer_find_frame(gpl, cfra); */
237                         }
238                 }
239         }
240         
241         if (ob && ob->gpd) {
242                 bGPDlayer *gpl = BKE_gpencil_layer_getactive(ob->gpd);
243                 if (gpl) {
244                         if (gpl->actframe) {
245                                 // XXX: assumes that frame has been fetched already
246                                 return (gpl->actframe->framenum == cfra);
247                         }
248                         else {
249                                 /* XXX: disabled as could be too much of a penalty */
250                                 /* return BKE_gpencil_layer_find_frame(gpl, cfra); */
251                         }
252                 }
253         }
254         
255         return false;
256 }
257
258 /* ******************************************************** */
259 /* Poll Callbacks */
260
261 /* poll callback for adding data/layers - special */
262 int gp_add_poll(bContext *C)
263 {
264         /* the base line we have is that we have somewhere to add Grease Pencil data */
265         return ED_gpencil_data_get_pointers(C, NULL) != NULL;
266 }
267
268 /* poll callback for checking if there is an active layer */
269 int gp_active_layer_poll(bContext *C)
270 {
271         bGPdata *gpd = ED_gpencil_data_get_active(C);
272         bGPDlayer *gpl = BKE_gpencil_layer_getactive(gpd);
273         
274         return (gpl != NULL);
275 }
276
277 /* poll callback for checking if there is an active brush */
278 int gp_active_brush_poll(bContext *C)
279 {
280         ToolSettings *ts = CTX_data_tool_settings(C);
281         bGPDbrush *brush = BKE_gpencil_brush_getactive(ts);
282
283         return (brush != NULL);
284 }
285
286 /* poll callback for checking if there is an active palette */
287 int gp_active_palette_poll(bContext *C)
288 {
289         bGPdata *gpd = ED_gpencil_data_get_active(C);
290         bGPDpalette *palette = BKE_gpencil_palette_getactive(gpd);
291
292         return (palette != NULL);
293 }
294
295 /* poll callback for checking if there is an active palette color */
296 int gp_active_palettecolor_poll(bContext *C)
297 {
298         bGPdata *gpd = ED_gpencil_data_get_active(C);
299         bGPDpalette *palette = BKE_gpencil_palette_getactive(gpd);
300         bGPDpalettecolor *palcolor = BKE_gpencil_palettecolor_getactive(palette);
301
302         return (palcolor != NULL);
303 }
304
305 /* ******************************************************** */
306 /* Dynamic Enums of GP Layers */
307 /* NOTE: These include an option to create a new layer and use that... */
308
309 /* Just existing layers */
310 EnumPropertyItem *ED_gpencil_layers_enum_itemf(bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop), bool *r_free)
311 {
312         bGPdata *gpd = CTX_data_gpencil_data(C);
313         bGPDlayer *gpl;
314         EnumPropertyItem *item = NULL, item_tmp = {0};
315         int totitem = 0;
316         int i = 0;
317         
318         if (ELEM(NULL, C, gpd)) {
319                 return DummyRNA_DEFAULT_items;
320         }
321         
322         /* Existing layers */
323         for (gpl = gpd->layers.first; gpl; gpl = gpl->next, i++) {
324                 item_tmp.identifier = gpl->info;
325                 item_tmp.name = gpl->info;
326                 item_tmp.value = i;
327                 
328                 if (gpl->flag & GP_LAYER_ACTIVE)
329                         item_tmp.icon = ICON_GREASEPENCIL;
330                 else 
331                         item_tmp.icon = ICON_NONE;
332                 
333                 RNA_enum_item_add(&item, &totitem, &item_tmp);
334         }
335         
336         RNA_enum_item_end(&item, &totitem);
337         *r_free = true;
338
339         return item;
340 }
341
342 /* Existing + Option to add/use new layer */
343 EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf(bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop), bool *r_free)
344 {
345         bGPdata *gpd = CTX_data_gpencil_data(C);
346         bGPDlayer *gpl;
347         EnumPropertyItem *item = NULL, item_tmp = {0};
348         int totitem = 0;
349         int i = 0;
350         
351         if (ELEM(NULL, C, gpd)) {
352                 return DummyRNA_DEFAULT_items;
353         }
354         
355         /* Create new layer */
356         /* TODO: have some way of specifying that we don't want this? */
357         {
358                 /* active Keying Set */
359                 item_tmp.identifier = "__CREATE__";
360                 item_tmp.name = "New Layer";
361                 item_tmp.value = -1;
362                 item_tmp.icon = ICON_ZOOMIN;
363                 RNA_enum_item_add(&item, &totitem, &item_tmp);
364                 
365                 /* separator */
366                 RNA_enum_item_add_separator(&item, &totitem);
367         }
368         
369         /* Existing layers */
370         for (gpl = gpd->layers.first, i = 0; gpl; gpl = gpl->next, i++) {
371                 item_tmp.identifier = gpl->info;
372                 item_tmp.name = gpl->info;
373                 item_tmp.value = i;
374                 
375                 if (gpl->flag & GP_LAYER_ACTIVE)
376                         item_tmp.icon = ICON_GREASEPENCIL;
377                 else 
378                         item_tmp.icon = ICON_NONE;
379                 
380                 RNA_enum_item_add(&item, &totitem, &item_tmp);
381         }
382         
383         RNA_enum_item_end(&item, &totitem);
384         *r_free = true;
385
386         return item;
387 }
388
389
390
391 /* ******************************************************** */
392 /* Brush Tool Core */
393
394 /* Check if part of stroke occurs within last segment drawn by eraser */
395 bool gp_stroke_inside_circle(const int mval[2], const int UNUSED(mvalo[2]),
396                              int rad, int x0, int y0, int x1, int y1)
397 {
398         /* simple within-radius check for now */
399         const float mval_fl[2]     = {mval[0], mval[1]};
400         const float screen_co_a[2] = {x0, y0};
401         const float screen_co_b[2] = {x1, y1};
402         
403         if (edge_inside_circle(mval_fl, rad, screen_co_a, screen_co_b)) {
404                 return true;
405         }
406         
407         /* not inside */
408         return false;
409 }
410
411 /* ******************************************************** */
412 /* Stroke Validity Testing */
413
414 /* Check whether given stroke can be edited given the supplied context */
415 // XXX: do we need additional flags for screenspace vs dataspace?
416 bool ED_gpencil_stroke_can_use_direct(const ScrArea *sa, const bGPDstroke *gps)
417 {
418         /* sanity check */
419         if (ELEM(NULL, sa, gps))
420                 return false;
421
422         /* filter stroke types by flags + spacetype */
423         if (gps->flag & GP_STROKE_3DSPACE) {
424                 /* 3D strokes - only in 3D view */
425                 return (sa->spacetype == SPACE_VIEW3D);
426         }
427         else if (gps->flag & GP_STROKE_2DIMAGE) {
428                 /* Special "image" strokes - only in Image Editor */
429                 return (sa->spacetype == SPACE_IMAGE);
430         }
431         else if (gps->flag & GP_STROKE_2DSPACE) {
432                 /* 2D strokes (dataspace) - for any 2D view (i.e. everything other than 3D view) */
433                 return (sa->spacetype != SPACE_VIEW3D);
434         }
435         else {
436                 /* view aligned - anything goes */
437                 return true;
438         }
439 }
440
441 /* Check whether given stroke can be edited in the current context */
442 bool ED_gpencil_stroke_can_use(const bContext *C, const bGPDstroke *gps)
443 {
444         ScrArea *sa = CTX_wm_area(C);
445         return ED_gpencil_stroke_can_use_direct(sa, gps);
446 }
447
448 /* Check whether given stroke can be edited for the current color */
449 bool ED_gpencil_stroke_color_use(const bGPDlayer *gpl, const bGPDstroke *gps)
450 {
451         /* check if the color is editable */
452         bGPDpalettecolor *palcolor = gps->palcolor;
453         if (palcolor != NULL) {
454                 if (palcolor->flag & PC_COLOR_HIDE)
455                         return false;
456                 if (((gpl->flag & GP_LAYER_UNLOCK_COLOR) == 0) && (palcolor->flag & PC_COLOR_LOCKED))
457                         return false;
458         }
459         
460         return true;
461 }
462
463 /* Get palette color or create a new one */
464 bGPDpalettecolor *ED_gpencil_stroke_getcolor(bGPdata *gpd, bGPDstroke *gps)
465 {
466         bGPDpalette *palette;
467         bGPDpalettecolor *palcolor;
468
469         if ((gps->palcolor != NULL) && ((gps->flag & GP_STROKE_RECALC_COLOR) == 0))
470                 return gps->palcolor;
471
472         /* get palette */
473         palette = BKE_gpencil_palette_getactive(gpd);
474         if (palette == NULL) {
475                 palette = BKE_gpencil_palette_addnew(gpd, DATA_("GP_Palette"), true);
476         }
477         /* get color */
478         palcolor = BKE_gpencil_palettecolor_getbyname(palette, gps->colorname);
479         if (palcolor == NULL) {
480                 if (gps->palcolor == NULL) {
481                         palcolor = BKE_gpencil_palettecolor_addnew(palette, DATA_("Color"), true);
482                         /* set to a different color */
483                         ARRAY_SET_ITEMS(palcolor->color, 1.0f, 0.0f, 1.0f, 0.9f);
484                 }
485                 else {
486                         palcolor = BKE_gpencil_palettecolor_addnew(palette, gps->colorname, true);
487                         /* set old color and attributes */
488                         bGPDpalettecolor *gpscolor = gps->palcolor;
489                         copy_v4_v4(palcolor->color, gpscolor->color);
490                         copy_v4_v4(palcolor->fill, gpscolor->fill);
491                         palcolor->flag = gpscolor->flag;
492                 }
493         }
494
495         /* clear flag and set pointer */
496         gps->flag &= ~GP_STROKE_RECALC_COLOR;
497         gps->palcolor = palcolor;
498
499         return palcolor;
500 }
501
502 /* ******************************************************** */
503 /* Space Conversion */
504
505 /* Init handling for space-conversion function (from passed-in parameters) */
506 void gp_point_conversion_init(bContext *C, GP_SpaceConversion *r_gsc)
507 {
508         ScrArea *sa = CTX_wm_area(C);
509         ARegion *ar = CTX_wm_region(C);
510         
511         /* zero out the storage (just in case) */
512         memset(r_gsc, 0, sizeof(GP_SpaceConversion));
513         unit_m4(r_gsc->mat);
514         
515         /* store settings */
516         r_gsc->sa = sa;
517         r_gsc->ar = ar;
518         r_gsc->v2d = &ar->v2d;
519         
520         /* init region-specific stuff */
521         if (sa->spacetype == SPACE_VIEW3D) {
522                 wmWindow *win = CTX_wm_window(C);
523                 Scene *scene = CTX_data_scene(C);
524                 View3D *v3d = (View3D *)CTX_wm_space_data(C);
525                 RegionView3D *rv3d = ar->regiondata;
526                 
527                 /* init 3d depth buffers */
528                 view3d_operator_needs_opengl(C);
529                 
530                 view3d_region_operator_needs_opengl(win, ar);
531                 ED_view3d_autodist_init(scene, ar, v3d, 0);
532                 
533                 /* for camera view set the subrect */
534                 if (rv3d->persp == RV3D_CAMOB) {
535                         ED_view3d_calc_camera_border(scene, ar, v3d, rv3d, &r_gsc->subrect_data, true); /* no shift */
536                         r_gsc->subrect = &r_gsc->subrect_data;
537                 }
538         }
539 }
540
541 /* convert point to parent space */
542 void gp_point_to_parent_space(bGPDspoint *pt, float diff_mat[4][4], bGPDspoint *r_pt) 
543 {
544         float fpt[3];
545
546         mul_v3_m4v3(fpt, diff_mat, &pt->x);
547         copy_v3_v3(&r_pt->x, fpt);
548 }
549
550 /* Change position relative to parent object */
551 void gp_apply_parent(bGPDlayer *gpl, bGPDstroke *gps)
552 {
553         bGPDspoint *pt;
554         int i;
555
556         /* undo matrix */
557         float diff_mat[4][4];
558         float inverse_diff_mat[4][4];
559         float fpt[3];
560
561         ED_gpencil_parent_location(gpl, diff_mat);
562         invert_m4_m4(inverse_diff_mat, diff_mat);
563
564         for (i = 0; i < gps->totpoints; i++) {
565                 pt = &gps->points[i];
566                 mul_v3_m4v3(fpt, inverse_diff_mat, &pt->x);
567                 copy_v3_v3(&pt->x, fpt);
568         }
569 }
570
571 /* Change point position relative to parent object */
572 void gp_apply_parent_point(bGPDlayer *gpl, bGPDspoint *pt)
573 {
574         /* undo matrix */
575         float diff_mat[4][4];
576         float inverse_diff_mat[4][4];
577         float fpt[3];
578
579         ED_gpencil_parent_location(gpl, diff_mat);
580         invert_m4_m4(inverse_diff_mat, diff_mat);
581
582         mul_v3_m4v3(fpt, inverse_diff_mat, &pt->x);
583         copy_v3_v3(&pt->x, fpt);
584 }
585
586 /* Convert Grease Pencil points to screen-space values
587  * WARNING: This assumes that the caller has already checked whether the stroke in question can be drawn
588  */
589 void gp_point_to_xy(GP_SpaceConversion *gsc, bGPDstroke *gps, bGPDspoint *pt,
590                     int *r_x, int *r_y)
591 {
592         ARegion *ar = gsc->ar;
593         View2D *v2d = gsc->v2d;
594         rctf *subrect = gsc->subrect;
595         int xyval[2];
596         
597         /* sanity checks */
598         BLI_assert(!(gps->flag & GP_STROKE_3DSPACE) || (gsc->sa->spacetype == SPACE_VIEW3D));
599         BLI_assert(!(gps->flag & GP_STROKE_2DSPACE) || (gsc->sa->spacetype != SPACE_VIEW3D));
600         
601         
602         if (gps->flag & GP_STROKE_3DSPACE) {
603                 if (ED_view3d_project_int_global(ar, &pt->x, xyval, V3D_PROJ_TEST_NOP) == V3D_PROJ_RET_OK) {
604                         *r_x = xyval[0];
605                         *r_y = xyval[1];
606                 }
607                 else {
608                         *r_x = V2D_IS_CLIPPED;
609                         *r_y = V2D_IS_CLIPPED;
610                 }
611         }
612         else if (gps->flag & GP_STROKE_2DSPACE) {
613                 float vec[3] = {pt->x, pt->y, 0.0f};
614                 mul_m4_v3(gsc->mat, vec);
615                 UI_view2d_view_to_region_clip(v2d, vec[0], vec[1], r_x, r_y);
616         }
617         else {
618                 if (subrect == NULL) {
619                         /* normal 3D view (or view space) */
620                         *r_x = (int)(pt->x / 100 * ar->winx);
621                         *r_y = (int)(pt->y / 100 * ar->winy);
622                 }
623                 else {
624                         /* camera view, use subrect */
625                         *r_x = (int)((pt->x / 100) * BLI_rctf_size_x(subrect)) + subrect->xmin;
626                         *r_y = (int)((pt->y / 100) * BLI_rctf_size_y(subrect)) + subrect->ymin;
627                 }
628         }
629 }
630
631 /* Convert Grease Pencil points to screen-space values (as floats)
632  * WARNING: This assumes that the caller has already checked whether the stroke in question can be drawn
633  */
634 void gp_point_to_xy_fl(GP_SpaceConversion *gsc, bGPDstroke *gps, bGPDspoint *pt,
635                        float *r_x, float *r_y)
636 {
637         ARegion *ar = gsc->ar;
638         View2D *v2d = gsc->v2d;
639         rctf *subrect = gsc->subrect;
640         float xyval[2];
641         
642         /* sanity checks */
643         BLI_assert(!(gps->flag & GP_STROKE_3DSPACE) || (gsc->sa->spacetype == SPACE_VIEW3D));
644         BLI_assert(!(gps->flag & GP_STROKE_2DSPACE) || (gsc->sa->spacetype != SPACE_VIEW3D));
645         
646         
647         if (gps->flag & GP_STROKE_3DSPACE) {
648                 if (ED_view3d_project_float_global(ar, &pt->x, xyval, V3D_PROJ_TEST_NOP) == V3D_PROJ_RET_OK) {
649                         *r_x = xyval[0];
650                         *r_y = xyval[1];
651                 }
652                 else {
653                         *r_x = 0.0f;
654                         *r_y = 0.0f;
655                 }
656         }
657         else if (gps->flag & GP_STROKE_2DSPACE) {
658                 float vec[3] = {pt->x, pt->y, 0.0f};
659                 int t_x, t_y;
660                 
661                 mul_m4_v3(gsc->mat, vec);
662                 UI_view2d_view_to_region_clip(v2d, vec[0], vec[1], &t_x, &t_y);
663                 
664                 if ((t_x == t_y) && (t_x == V2D_IS_CLIPPED)) {
665                         /* XXX: Or should we just always use the values as-is? */
666                         *r_x = 0.0f;
667                         *r_y = 0.0f;
668                 }
669                 else {
670                         *r_x = (float)t_x;
671                         *r_y = (float)t_y;
672                 }
673         }
674         else {
675                 if (subrect == NULL) {
676                         /* normal 3D view (or view space) */
677                         *r_x = (pt->x / 100.0f * ar->winx);
678                         *r_y = (pt->y / 100.0f * ar->winy);
679                 }
680                 else {
681                         /* camera view, use subrect */
682                         *r_x = ((pt->x / 100.0f) * BLI_rctf_size_x(subrect)) + subrect->xmin;
683                         *r_y = ((pt->y / 100.0f) * BLI_rctf_size_y(subrect)) + subrect->ymin;
684                 }
685         }
686 }
687
688 /**
689  * Project screenspace coordinates to 3D-space
690  *
691  * \note We include this as a utility function, since the standard method
692  * involves quite a few steps, which are invariably always the same
693  * for all GPencil operations. So, it's nicer to just centralize these.
694  *
695  * \warning Assumes that it is getting called in a 3D view only.
696  */
697 bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, Scene *scene, const float screen_co[2], float r_out[3])
698 {
699         View3D *v3d = gsc->sa->spacedata.first;
700         RegionView3D *rv3d = gsc->ar->regiondata;
701         float *rvec = ED_view3d_cursor3d_get(scene, v3d);
702         float ref[3] = {rvec[0], rvec[1], rvec[2]};
703         float zfac = ED_view3d_calc_zfac(rv3d, rvec, NULL);
704         
705         float mval_f[2], mval_prj[2];
706         float dvec[3];
707         
708         copy_v2_v2(mval_f, screen_co);
709         
710         if (ED_view3d_project_float_global(gsc->ar, ref, mval_prj, V3D_PROJ_TEST_NOP) == V3D_PROJ_RET_OK) {
711                 sub_v2_v2v2(mval_f, mval_prj, mval_f);
712                 ED_view3d_win_to_delta(gsc->ar, mval_f, dvec, zfac);
713                 sub_v3_v3v3(r_out, rvec, dvec);
714                 
715                 return true;
716         }
717         else {
718                 zero_v3(r_out);
719                 
720                 return false;
721         }
722 }
723
724 /**
725  * Apply smooth to stroke point 
726  * \param gps              Stroke to smooth
727  * \param i                Point index
728  * \param inf              Amount of smoothing to apply
729  * \param affect_pressure  Apply smoothing to pressure values too?
730  */
731 bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure)
732 {
733         bGPDspoint *pt = &gps->points[i];
734         float pressure = 0.0f;
735         float sco[3] = {0.0f};
736         
737         /* Do nothing if not enough points to smooth out */
738         if (gps->totpoints <= 2) {
739                 return false;
740         }
741         
742         /* Only affect endpoints by a fraction of the normal strength,
743          * to prevent the stroke from shrinking too much
744          */
745         if ((i == 0) || (i == gps->totpoints - 1)) {
746                 inf *= 0.1f;
747         }
748         
749         /* Compute smoothed coordinate by taking the ones nearby */
750         /* XXX: This is potentially slow, and suffers from accumulation error as earlier points are handled before later ones */
751         {
752                 // XXX: this is hardcoded to look at 2 points on either side of the current one (i.e. 5 items total)
753                 const int   steps = 2;
754                 const float average_fac = 1.0f / (float)(steps * 2 + 1);
755                 int step;
756                 
757                 /* add the point itself */
758                 madd_v3_v3fl(sco, &pt->x, average_fac);
759                 
760                 if (affect_pressure) {
761                         pressure += pt->pressure * average_fac;
762                 }
763                 
764                 /* n-steps before/after current point */
765                 // XXX: review how the endpoints are treated by this algorithm
766                 // XXX: falloff measures should also introduce some weighting variations, so that further-out points get less weight
767                 for (step = 1; step <= steps; step++) {
768                         bGPDspoint *pt1, *pt2;
769                         int before = i - step;
770                         int after = i + step;
771                         
772                         CLAMP_MIN(before, 0);
773                         CLAMP_MAX(after, gps->totpoints - 1);
774                         
775                         pt1 = &gps->points[before];
776                         pt2 = &gps->points[after];
777                         
778                         /* add both these points to the average-sum (s += p[i]/n) */
779                         madd_v3_v3fl(sco, &pt1->x, average_fac);
780                         madd_v3_v3fl(sco, &pt2->x, average_fac);
781                         
782 #if 0
783                         /* XXX: Disabled because get weird result */
784                         /* do pressure too? */
785                         if (affect_pressure) {
786                                 pressure += pt1->pressure * average_fac;
787                                 pressure += pt2->pressure * average_fac;
788                         }
789 #endif
790                 }
791         }
792         
793         /* Based on influence factor, blend between original and optimal smoothed coordinate */
794         interp_v3_v3v3(&pt->x, &pt->x, sco, inf);
795         
796 #if 0
797         /* XXX: Disabled because get weird result */
798         if (affect_pressure) {
799                 pt->pressure = pressure;
800         }
801 #endif
802         
803         return true;
804 }
805
806 /**
807 * Apply smooth for strength to stroke point
808 * \param gps              Stroke to smooth
809 * \param i                Point index
810 * \param inf              Amount of smoothing to apply
811 */
812 bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf)
813 {
814         bGPDspoint *ptb = &gps->points[i];
815
816         /* Do nothing if not enough points */
817         if (gps->totpoints <= 2) {
818                 return false;
819         }
820
821         /* Compute theoretical optimal value using distances */
822         bGPDspoint *pta, *ptc;
823         int before = i - 1;
824         int after = i + 1;
825
826         CLAMP_MIN(before, 0);
827         CLAMP_MAX(after, gps->totpoints - 1);
828
829         pta = &gps->points[before];
830         ptc = &gps->points[after];
831
832         /* the optimal value is the corresponding to the interpolation of the strength
833         *  at the distance of point b
834         */
835         const float fac = line_point_factor_v3(&ptb->x, &pta->x, &ptc->x);
836         const float optimal = (1.0f - fac) * pta->strength + fac * ptc->strength;
837
838         /* Based on influence factor, blend between original and optimal */
839         ptb->strength = (1.0f - inf) * ptb->strength + inf * optimal;
840
841         return true;
842 }
843
844 /**
845 * Apply smooth for thickness to stroke point (use pressure)
846 * \param gps              Stroke to smooth
847 * \param i                Point index
848 * \param inf              Amount of smoothing to apply
849 */
850 bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf)
851 {
852         bGPDspoint *ptb = &gps->points[i];
853
854         /* Do nothing if not enough points */
855         if (gps->totpoints <= 2) {
856                 return false;
857         }
858
859         /* Compute theoretical optimal value using distances */
860         bGPDspoint *pta, *ptc;
861         int before = i - 1;
862         int after = i + 1;
863
864         CLAMP_MIN(before, 0);
865         CLAMP_MAX(after, gps->totpoints - 1);
866
867         pta = &gps->points[before];
868         ptc = &gps->points[after];
869
870         /* the optimal value is the corresponding to the interpolation of the pressure
871         *  at the distance of point b
872         */
873         float fac = line_point_factor_v3(&ptb->x, &pta->x, &ptc->x);
874         float optimal = (1.0f - fac) * pta->pressure + fac * ptc->pressure;
875
876         /* Based on influence factor, blend between original and optimal */
877         ptb->pressure = (1.0f - inf) * ptb->pressure + inf * optimal;
878
879         return true;
880 }
881
882 /**
883  * Subdivide a stroke once, by adding a point half way between each pair of existing points
884  * \param gps           Stroke data
885  * \param new_totpoints Total number of points (after subdividing)
886  */
887 void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints)
888 {
889         /* Move points towards end of enlarged points array to leave space for new points */
890         int y = 1;
891         for (int i = gps->totpoints - 1; i > 0; i--) {
892                 gps->points[new_totpoints - y] = gps->points[i];
893                 y += 2;
894         }
895         
896         /* Create interpolated points */
897         for (int i = 0; i < new_totpoints - 1; i += 2) {
898                 bGPDspoint *prev  = &gps->points[i];
899                 bGPDspoint *pt    = &gps->points[i + 1];
900                 bGPDspoint *next  = &gps->points[i + 2];
901                 
902                 /* Interpolate all values */
903                 interp_v3_v3v3(&pt->x, &prev->x, &next->x, 0.5f);
904                 
905                 pt->pressure = interpf(prev->pressure, next->pressure, 0.5f);
906                 pt->strength = interpf(prev->strength, next->strength, 0.5f);
907                 CLAMP(pt->strength, GPENCIL_STRENGTH_MIN, 1.0f);
908                 pt->time = interpf(prev->time, next->time, 0.5f);
909         }
910         
911         /* Update to new total number of points */
912         gps->totpoints = new_totpoints;
913 }
914
915 /**
916  * Add randomness to stroke
917  * \param gps           Stroke data
918  * \param brush         Brush data
919  */
920 void gp_randomize_stroke(bGPDstroke *gps, bGPDbrush *brush)
921 {
922         bGPDspoint *pt1, *pt2, *pt3;
923         float v1[3];
924         float v2[3];
925         if (gps->totpoints < 3) {
926                 return;
927         }
928
929         /* get two vectors using 3 points */
930         pt1 = &gps->points[0];
931         pt2 = &gps->points[1];
932         pt3 = &gps->points[(int)(gps->totpoints * 0.75)];
933
934         sub_v3_v3v3(v1, &pt2->x, &pt1->x);
935         sub_v3_v3v3(v2, &pt3->x, &pt2->x);
936         normalize_v3(v1);
937         normalize_v3(v2);
938
939         /* get normal vector to plane created by two vectors */
940         float normal[3];
941         cross_v3_v3v3(normal, v1, v2);
942         normalize_v3(normal);
943         
944         /* get orthogonal vector to plane to rotate random effect */
945         float ortho[3];
946         cross_v3_v3v3(ortho, v1, normal);
947         normalize_v3(ortho);
948         
949         /* Read all points and apply shift vector (first and last point not modified) */
950         for (int i = 1; i < gps->totpoints - 1; ++i) {
951                 bGPDspoint *pt = &gps->points[i];
952                 /* get vector with shift (apply a division because random is too sensitive */
953                 const float fac = BLI_frand() * (brush->draw_random_sub / 10.0f);
954                 float svec[3];
955                 copy_v3_v3(svec, ortho);
956                 if (BLI_frand() > 0.5f) {
957                         mul_v3_fl(svec, -fac);
958                 }
959                 else {
960                         mul_v3_fl(svec, fac);
961                 }
962
963                 /* apply shift */
964                 add_v3_v3(&pt->x, svec);
965         }
966
967 }
968 /* calculate difference matrix */
969 void ED_gpencil_parent_location(bGPDlayer *gpl, float diff_mat[4][4])
970 {
971         Object *ob = gpl->parent;
972
973         if (ob == NULL) {
974                 unit_m4(diff_mat);
975                 return;
976         }
977         else {
978                 if ((gpl->partype == PAROBJECT) || (gpl->partype == PARSKEL)) {
979                         mul_m4_m4m4(diff_mat, ob->obmat, gpl->inverse);
980                         return;
981                 }
982                 else if (gpl->partype == PARBONE) {
983                         bPoseChannel *pchan = BKE_pose_channel_find_name(ob->pose, gpl->parsubstr);
984                         if (pchan) {
985                                 float tmp_mat[4][4];
986                                 mul_m4_m4m4(tmp_mat, ob->obmat, pchan->pose_mat);
987                                 mul_m4_m4m4(diff_mat, tmp_mat, gpl->inverse);
988                         }
989                         else {
990                                 mul_m4_m4m4(diff_mat, ob->obmat, gpl->inverse); /* if bone not found use object (armature) */
991                         }
992                         return;
993                 }
994                 else {
995                         unit_m4(diff_mat); /* not defined type */
996                 }
997         }
998 }
999
1000 /* reset parent matrix for all layers */
1001 void ED_gpencil_reset_layers_parent(bGPdata *gpd)
1002 {
1003         bGPDspoint *pt;
1004         int i;
1005         float diff_mat[4][4];
1006         float cur_mat[4][4];
1007
1008         for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1009                 if (gpl->parent != NULL) {
1010                         /* calculate new matrix */
1011                         if ((gpl->partype == PAROBJECT) || (gpl->partype == PARSKEL)) {
1012                                 invert_m4_m4(cur_mat, gpl->parent->obmat);
1013                         }
1014                         else if (gpl->partype == PARBONE) {
1015                                 bPoseChannel *pchan = BKE_pose_channel_find_name(gpl->parent->pose, gpl->parsubstr);
1016                                 if (pchan) {
1017                                         float tmp_mat[4][4];
1018                                         mul_m4_m4m4(tmp_mat, gpl->parent->obmat, pchan->pose_mat);
1019                                         invert_m4_m4(cur_mat, tmp_mat);
1020                                 }
1021                         }
1022
1023                         /* only redo if any change */
1024                         if (!equals_m4m4(gpl->inverse, cur_mat)) {
1025                                 /* first apply current transformation to all strokes */
1026                                 ED_gpencil_parent_location(gpl, diff_mat);
1027                                 for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
1028                                         for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
1029                                                 for (i = 0, pt = gps->points; i < gps->totpoints; i++, pt++) {
1030                                                         mul_m4_v3(diff_mat, &pt->x);
1031                                                 }
1032                                         }
1033                                 }
1034                                 /* set new parent matrix */
1035                                 copy_m4_m4(gpl->inverse, cur_mat);
1036                         }
1037                 }
1038         }
1039 }
1040 /* ******************************************************** */
1041 bool ED_gpencil_stroke_minmax(
1042         const bGPDstroke *gps, const bool use_select,
1043         float r_min[3], float r_max[3])
1044 {
1045         const bGPDspoint *pt;
1046         int i;
1047         bool changed = false;
1048
1049         for (i = 0, pt = gps->points; i < gps->totpoints; i++, pt++) {
1050                 if ((use_select == false) || (pt->flag & GP_SPOINT_SELECT)) {;
1051                         minmax_v3v3_v3(r_min, r_max, &pt->x);
1052                         changed = true;
1053                 }
1054         }
1055         return changed;
1056 }
1057
1058 /* Dynamic Enums of GP Brushes */
1059 EnumPropertyItem *ED_gpencil_brushes_enum_itemf(
1060         bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
1061         bool *r_free)
1062 {
1063         ToolSettings *ts = CTX_data_tool_settings(C);
1064         bGPDbrush *brush;
1065         EnumPropertyItem *item = NULL, item_tmp = { 0 };
1066         int totitem = 0;
1067         int i = 0;
1068
1069         if (ELEM(NULL, C, ts)) {
1070                 return DummyRNA_DEFAULT_items;
1071         }
1072
1073         /* Existing brushes */
1074         for (brush = ts->gp_brushes.first; brush; brush = brush->next, i++) {
1075                 item_tmp.identifier = brush->info;
1076                 item_tmp.name = brush->info;
1077                 item_tmp.value = i;
1078
1079                 if (brush->flag & GP_BRUSH_ACTIVE)
1080                         item_tmp.icon = ICON_BRUSH_DATA;
1081                 else
1082                         item_tmp.icon = ICON_NONE;
1083
1084                 RNA_enum_item_add(&item, &totitem, &item_tmp);
1085         }
1086
1087         RNA_enum_item_end(&item, &totitem);
1088         *r_free = true;
1089
1090         return item;
1091 }
1092
1093 /* Dynamic Enums of GP Palettes */
1094 EnumPropertyItem *ED_gpencil_palettes_enum_itemf(
1095         bContext *C, PointerRNA *UNUSED(ptr), PropertyRNA *UNUSED(prop),
1096         bool *r_free)
1097 {
1098         bGPdata *gpd = CTX_data_gpencil_data(C);
1099         bGPDpalette *palette;
1100         EnumPropertyItem *item = NULL, item_tmp = { 0 };
1101         int totitem = 0;
1102         int i = 0;
1103
1104         if (ELEM(NULL, C, gpd)) {
1105                 return DummyRNA_DEFAULT_items;
1106         }
1107
1108         /* Existing palettes */
1109         for (palette = gpd->palettes.first; palette; palette = palette->next, i++) {
1110                 item_tmp.identifier = palette->info;
1111                 item_tmp.name = palette->info;
1112                 item_tmp.value = i;
1113
1114                 if (palette->flag & PL_PALETTE_ACTIVE)
1115                         item_tmp.icon = ICON_COLOR;
1116                 else
1117                         item_tmp.icon = ICON_NONE;
1118
1119                 RNA_enum_item_add(&item, &totitem, &item_tmp);
1120         }
1121
1122         RNA_enum_item_end(&item, &totitem);
1123         *r_free = true;
1124
1125         return item;
1126 }
1127 /* ******************************************************** */