Mesh Remap: Face Corner Data: Do not use large epsilon values to create bvhtrees.
[blender.git] / source / blender / blenkernel / BKE_gpencil.h
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) 2008, Blender Foundation
19  * This is a new part of Blender
20  *
21  * Contributor(s): Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BKE_GPENCIL_H__
27 #define __BKE_GPENCIL_H__
28
29 /** \file BKE_gpencil.h
30  *  \ingroup bke
31  *  \author Joshua Leung
32  */
33
34 struct ToolSettings;
35 struct ListBase;
36 struct bGPdata;
37 struct bGPDlayer;
38 struct bGPDframe;
39 struct bGPDstroke;
40 struct bGPDpalette;
41 struct bGPDpalettecolor;
42 struct Main;
43
44 /* ------------ Grease-Pencil API ------------------ */
45
46 void BKE_gpencil_free_stroke(struct bGPDstroke *gps);
47 bool BKE_gpencil_free_strokes(struct bGPDframe *gpf);
48 void BKE_gpencil_free_frames(struct bGPDlayer *gpl);
49 void BKE_gpencil_free_layers(struct ListBase *list);
50 void BKE_gpencil_free_brushes(struct ListBase *list);
51 void BKE_gpencil_free_palettes(struct ListBase *list);
52 void BKE_gpencil_free(struct bGPdata *gpd, bool free_palettes);
53
54 void BKE_gpencil_stroke_sync_selection(struct bGPDstroke *gps);
55
56 struct bGPDframe *BKE_gpencil_frame_addnew(struct bGPDlayer *gpl, int cframe);
57 struct bGPDframe *BKE_gpencil_frame_addcopy(struct bGPDlayer *gpl, int cframe);
58 struct bGPDlayer *BKE_gpencil_layer_addnew(struct bGPdata *gpd, const char *name, bool setactive);
59 struct bGPdata   *BKE_gpencil_data_addnew(const char name[]);
60
61 struct bGPDframe *BKE_gpencil_frame_duplicate(const struct bGPDframe *gpf_src);
62 struct bGPDlayer *BKE_gpencil_layer_duplicate(const struct bGPDlayer *gpl_src);
63 void BKE_gpencil_copy_data(struct Main *bmain, struct bGPdata *gpd_dst, const struct bGPdata *gpd_src, const int flag);
64 struct bGPdata   *BKE_gpencil_data_duplicate(struct Main *bmain, const struct bGPdata *gpd, bool internal_copy);
65
66 void BKE_gpencil_make_local(struct Main *bmain, struct bGPdata *gpd, const bool lib_local);
67
68 void BKE_gpencil_frame_delete_laststroke(struct bGPDlayer *gpl, struct bGPDframe *gpf);
69
70 struct bGPDpalette *BKE_gpencil_palette_addnew(struct bGPdata *gpd, const char *name, bool setactive);
71 struct bGPDpalette *BKE_gpencil_palette_duplicate(const struct bGPDpalette *palette_src);
72 struct bGPDpalettecolor *BKE_gpencil_palettecolor_addnew(struct bGPDpalette *palette, const char *name, bool setactive);
73
74 struct bGPDbrush *BKE_gpencil_brush_addnew(struct ToolSettings *ts, const char *name, bool setactive);
75 struct bGPDbrush *BKE_gpencil_brush_duplicate(const struct bGPDbrush *brush_src);
76 void BKE_gpencil_brush_init_presets(struct ToolSettings *ts);
77
78
79 /* Stroke and Fill - Alpha Visibility Threshold */
80 #define GPENCIL_ALPHA_OPACITY_THRESH 0.001f
81 #define GPENCIL_STRENGTH_MIN 0.003f
82
83 bool gpencil_layer_is_editable(const struct bGPDlayer *gpl);
84
85 /* How gpencil_layer_getframe() should behave when there
86  * is no existing GP-Frame on the frame requested.
87  */
88 typedef enum eGP_GetFrame_Mode {
89         /* Use the preceeding gp-frame (i.e. don't add anything) */
90         GP_GETFRAME_USE_PREV  = 0,
91         
92         /* Add a new empty/blank frame */
93         GP_GETFRAME_ADD_NEW   = 1,
94         /* Make a copy of the active frame */
95         GP_GETFRAME_ADD_COPY  = 2
96 } eGP_GetFrame_Mode;
97
98 struct bGPDframe *BKE_gpencil_layer_getframe(struct bGPDlayer *gpl, int cframe, eGP_GetFrame_Mode addnew);
99 struct bGPDframe *BKE_gpencil_layer_find_frame(struct bGPDlayer *gpl, int cframe);
100 bool BKE_gpencil_layer_delframe(struct bGPDlayer *gpl, struct bGPDframe *gpf);
101
102 struct bGPDlayer *BKE_gpencil_layer_getactive(struct bGPdata *gpd);
103 void BKE_gpencil_layer_setactive(struct bGPdata *gpd, struct bGPDlayer *active);
104 void BKE_gpencil_layer_delete(struct bGPdata *gpd, struct bGPDlayer *gpl);
105
106 struct bGPDbrush *BKE_gpencil_brush_getactive(struct ToolSettings *ts);
107 void BKE_gpencil_brush_setactive(struct ToolSettings *ts, struct bGPDbrush *active);
108 void BKE_gpencil_brush_delete(struct ToolSettings *ts, struct bGPDbrush *brush);
109
110 struct bGPDpalette *BKE_gpencil_palette_getactive(struct bGPdata *gpd);
111 void BKE_gpencil_palette_setactive(struct bGPdata *gpd, struct bGPDpalette *active);
112 void BKE_gpencil_palette_delete(struct bGPdata *gpd, struct bGPDpalette *palette);
113 void BKE_gpencil_palette_change_strokes(struct bGPdata *gpd);
114
115 struct bGPDpalettecolor *BKE_gpencil_palettecolor_getactive(struct bGPDpalette *palette);
116 void BKE_gpencil_palettecolor_setactive(struct bGPDpalette *palette, struct bGPDpalettecolor *active);
117 void BKE_gpencil_palettecolor_delete(struct bGPDpalette *palette, struct bGPDpalettecolor *palcolor);
118 struct bGPDpalettecolor *BKE_gpencil_palettecolor_getbyname(struct bGPDpalette *palette, char *name);
119 void BKE_gpencil_palettecolor_changename(struct bGPdata *gpd, char *oldname, const char *newname);
120 void BKE_gpencil_palettecolor_delete_strokes(struct bGPdata *gpd, char *name);
121
122 #endif /*  __BKE_GPENCIL_H__ */