3b8df66668a7417bb80dcf564b288994e3409a79
[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 CurveMapping;
35 struct Depsgraph;
36 struct GpencilModifierData;
37 struct ToolSettings;
38 struct ListBase;
39 struct bGPdata;
40 struct bGPDlayer;
41 struct bGPDframe;
42 struct bGPDspoint;
43 struct bGPDstroke;
44 struct Material;
45 struct bGPDpalette;
46 struct bGPDpalettecolor;
47 struct Main;
48 struct BoundBox;
49 struct Brush;
50 struct Object;
51 struct bDeformGroup;
52 struct SimplifyGpencilModifierData;
53 struct ArrayGpencilModifierData;
54 struct LatticeGpencilModifierData;
55
56 struct MDeformVert;
57 struct MDeformWeight;
58
59 /* ------------ Grease-Pencil API ------------------ */
60
61 void BKE_gpencil_free_point_weights(struct MDeformVert *dvert);
62 void BKE_gpencil_free_stroke_weights(struct bGPDstroke *gps);
63 void BKE_gpencil_free_stroke(struct bGPDstroke *gps);
64 bool BKE_gpencil_free_strokes(struct bGPDframe *gpf);
65 void BKE_gpencil_free_frames(struct bGPDlayer *gpl);
66 void BKE_gpencil_free_layers(struct ListBase *list);
67 bool BKE_gpencil_free_frame_runtime_data(struct bGPDframe *derived_gpf);
68 void BKE_gpencil_free_derived_frames(struct bGPdata *gpd);
69 void BKE_gpencil_free(struct bGPdata *gpd, bool free_all);
70
71 void BKE_gpencil_batch_cache_dirty_tag(struct bGPdata *gpd);
72 void BKE_gpencil_batch_cache_free(struct bGPdata *gpd);
73
74 void BKE_gpencil_stroke_sync_selection(struct bGPDstroke *gps);
75
76 struct bGPDframe *BKE_gpencil_frame_addnew(struct bGPDlayer *gpl, int cframe);
77 struct bGPDframe *BKE_gpencil_frame_addcopy(struct bGPDlayer *gpl, int cframe);
78 struct bGPDlayer *BKE_gpencil_layer_addnew(struct bGPdata *gpd, const char *name, bool setactive);
79 struct bGPdata   *BKE_gpencil_data_addnew(struct Main *bmain, const char name[]);
80
81 struct bGPDframe *BKE_gpencil_frame_duplicate(const struct bGPDframe *gpf_src);
82 struct bGPDlayer *BKE_gpencil_layer_duplicate(const struct bGPDlayer *gpl_src);
83 void BKE_gpencil_frame_copy_strokes(struct bGPDframe *gpf_src, struct bGPDframe *gpf_dst);
84 struct bGPDstroke *BKE_gpencil_stroke_duplicate(struct bGPDstroke *gps_src);
85
86 void BKE_gpencil_copy_data(struct bGPdata *gpd_dst, const struct bGPdata *gpd_src, const int flag);
87 struct bGPdata   *BKE_gpencil_copy(struct Main *bmain, const struct bGPdata *gpd);
88 struct bGPdata   *BKE_gpencil_data_duplicate(struct Main *bmain, const struct bGPdata *gpd, bool internal_copy);
89
90 void BKE_gpencil_make_local(struct Main *bmain, struct bGPdata *gpd, const bool lib_local);
91
92 void BKE_gpencil_frame_delete_laststroke(struct bGPDlayer *gpl, struct bGPDframe *gpf);
93
94 /* materials */
95 void BKE_gpencil_material_index_remove(struct bGPdata *gpd, int index);
96 void BKE_gpencil_material_remap(struct bGPdata *gpd, const unsigned int *remap, unsigned int remap_len);
97 int BKE_gpencil_get_material_index(struct Object *ob, struct Material *ma);
98
99 /* statistics functions */
100 void BKE_gpencil_stats_update(struct bGPdata *gpd);
101
102 /* Utilities for creating and populating GP strokes */
103 /* - Number of values defining each point in the built-in data
104  *   buffers for primitives (e.g. 2D Monkey)
105  */
106 #define GP_PRIM_DATABUF_SIZE  5
107
108 void BKE_gpencil_stroke_add_points(
109         struct bGPDstroke *gps,
110         const float *array, const int totpoints,
111         const float mat[4][4]);
112
113 struct bGPDstroke *BKE_gpencil_add_stroke(struct bGPDframe *gpf, int mat_idx, int totpoints, short thickness);
114
115 /* Stroke and Fill - Alpha Visibility Threshold */
116 #define GPENCIL_ALPHA_OPACITY_THRESH 0.001f
117 #define GPENCIL_STRENGTH_MIN 0.003f
118
119 bool gpencil_layer_is_editable(const struct bGPDlayer *gpl);
120
121 /* How gpencil_layer_getframe() should behave when there
122  * is no existing GP-Frame on the frame requested.
123  */
124 typedef enum eGP_GetFrame_Mode {
125         /* Use the preceding gp-frame (i.e. don't add anything) */
126         GP_GETFRAME_USE_PREV  = 0,
127
128         /* Add a new empty/blank frame */
129         GP_GETFRAME_ADD_NEW   = 1,
130         /* Make a copy of the active frame */
131         GP_GETFRAME_ADD_COPY  = 2
132 } eGP_GetFrame_Mode;
133
134 struct bGPDframe *BKE_gpencil_layer_getframe(struct bGPDlayer *gpl, int cframe, eGP_GetFrame_Mode addnew);
135 struct bGPDframe *BKE_gpencil_layer_find_frame(struct bGPDlayer *gpl, int cframe);
136 bool BKE_gpencil_layer_delframe(struct bGPDlayer *gpl, struct bGPDframe *gpf);
137
138 struct bGPDlayer *BKE_gpencil_layer_getactive(struct bGPdata *gpd);
139 void BKE_gpencil_layer_setactive(struct bGPdata *gpd, struct bGPDlayer *active);
140 void BKE_gpencil_layer_delete(struct bGPdata *gpd, struct bGPDlayer *gpl);
141
142 struct Material *BKE_gpencil_get_material_from_brush(struct Brush *brush);
143 struct Material *BKE_gpencil_material_ensure(struct Main *bmain, struct Object *ob);
144
145 /* object boundbox */
146 bool BKE_gpencil_data_minmax(
147         struct Object *ob, const struct bGPdata *gpd,
148         float r_min[3], float r_max[3]);
149 bool BKE_gpencil_stroke_minmax(
150         const struct bGPDstroke *gps, const bool use_select,
151         float r_min[3], float r_max[3]);
152 bool BKE_gpencil_stroke_select_check(
153         const struct bGPDstroke *gps);
154
155 struct BoundBox *BKE_gpencil_boundbox_get(struct Object *ob);
156 void BKE_gpencil_centroid_3d(struct bGPdata *gpd, float r_centroid[3]);
157
158 /* vertex groups */
159 void BKE_gpencil_dvert_ensure(struct bGPDstroke *gps);
160 void BKE_gpencil_vgroup_remove(struct Object *ob, struct bDeformGroup *defgroup);
161 void BKE_gpencil_stroke_weights_duplicate(struct bGPDstroke *gps_src, struct bGPDstroke *gps_dst);
162
163 /* GPencil geometry evaluation */
164 void BKE_gpencil_eval_geometry(struct Depsgraph *depsgraph, struct bGPdata *gpd);
165
166 /* stroke geometry utilities */
167 void BKE_gpencil_stroke_normal(const struct bGPDstroke *gps, float r_normal[3]);
168 void BKE_gpencil_simplify_stroke(struct bGPDstroke *gps, float factor);
169 void BKE_gpencil_simplify_fixed(struct bGPDstroke *gps);
170 void BKE_gpencil_subdivide(struct bGPDstroke *gps, int level, int flag);
171
172 void BKE_gpencil_transform(struct bGPdata *gpd, float mat[4][4]);
173
174 bool BKE_gpencil_smooth_stroke(struct bGPDstroke *gps, int i, float inf);
175 bool BKE_gpencil_smooth_stroke_strength(struct bGPDstroke *gps, int point_index, float influence);
176 bool BKE_gpencil_smooth_stroke_thickness(struct bGPDstroke *gps, int point_index, float influence);
177 bool BKE_gpencil_smooth_stroke_uv(struct bGPDstroke *gps, int point_index, float influence);
178
179 void BKE_gpencil_get_range_selected(struct bGPDlayer *gpl, int *r_initframe, int *r_endframe);
180 float BKE_gpencil_multiframe_falloff_calc(struct bGPDframe *gpf, int actnum, int f_init, int f_end, struct CurveMapping *cur_falloff);
181
182 #endif /*  __BKE_GPENCIL_H__ */