ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / BKE_gpencil.h
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 #ifndef __BKE_GPENCIL_H__
21 #define __BKE_GPENCIL_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 struct ArrayGpencilModifierData;
28 struct BoundBox;
29 struct Brush;
30 struct CurveMapping;
31 struct Depsgraph;
32 struct GpencilModifierData;
33 struct LatticeGpencilModifierData;
34 struct ListBase;
35 struct Main;
36 struct Material;
37 struct Object;
38 struct SimplifyGpencilModifierData;
39 struct ToolSettings;
40 struct bDeformGroup;
41 struct bGPDframe;
42 struct bGPDlayer;
43 struct bGPDpalette;
44 struct bGPDpalettecolor;
45 struct bGPDspoint;
46 struct bGPDstroke;
47 struct bGPdata;
48
49 struct MDeformVert;
50 struct MDeformWeight;
51
52 /* ------------ Grease-Pencil API ------------------ */
53
54 void BKE_gpencil_free_point_weights(struct MDeformVert *dvert);
55 void BKE_gpencil_free_stroke_weights(struct bGPDstroke *gps);
56 void BKE_gpencil_free_stroke(struct bGPDstroke *gps);
57 bool BKE_gpencil_free_strokes(struct bGPDframe *gpf);
58 void BKE_gpencil_free_frames(struct bGPDlayer *gpl);
59 void BKE_gpencil_free_layers(struct ListBase *list);
60 bool BKE_gpencil_free_frame_runtime_data(struct bGPDframe *derived_gpf);
61 void BKE_gpencil_free(struct bGPdata *gpd, bool free_all);
62
63 void BKE_gpencil_batch_cache_dirty_tag(struct bGPdata *gpd);
64 void BKE_gpencil_batch_cache_free(struct bGPdata *gpd);
65
66 void BKE_gpencil_stroke_sync_selection(struct bGPDstroke *gps);
67
68 struct bGPDframe *BKE_gpencil_frame_addnew(struct bGPDlayer *gpl, int cframe);
69 struct bGPDframe *BKE_gpencil_frame_addcopy(struct bGPDlayer *gpl, int cframe);
70 struct bGPDlayer *BKE_gpencil_layer_addnew(struct bGPdata *gpd, const char *name, bool setactive);
71 struct bGPdata *BKE_gpencil_data_addnew(struct Main *bmain, const char name[]);
72
73 struct bGPDframe *BKE_gpencil_frame_duplicate(const struct bGPDframe *gpf_src);
74 struct bGPDlayer *BKE_gpencil_layer_duplicate(const struct bGPDlayer *gpl_src);
75 void BKE_gpencil_frame_copy_strokes(struct bGPDframe *gpf_src, struct bGPDframe *gpf_dst);
76 struct bGPDstroke *BKE_gpencil_stroke_duplicate(struct bGPDstroke *gps_src);
77
78 void BKE_gpencil_copy_data(struct bGPdata *gpd_dst, const struct bGPdata *gpd_src, const int flag);
79 struct bGPdata *BKE_gpencil_copy(struct Main *bmain, const struct bGPdata *gpd);
80 struct bGPdata *BKE_gpencil_data_duplicate(struct Main *bmain,
81                                            const struct bGPdata *gpd,
82                                            bool internal_copy);
83
84 void BKE_gpencil_make_local(struct Main *bmain, struct bGPdata *gpd, const bool lib_local);
85
86 void BKE_gpencil_frame_delete_laststroke(struct bGPDlayer *gpl, struct bGPDframe *gpf);
87
88 /* materials */
89 void BKE_gpencil_material_index_remove(struct bGPdata *gpd, int index);
90 void BKE_gpencil_material_remap(struct bGPdata *gpd,
91                                 const unsigned int *remap,
92                                 unsigned int remap_len);
93
94 /* statistics functions */
95 void BKE_gpencil_stats_update(struct bGPdata *gpd);
96
97 /* Utilities for creating and populating GP strokes */
98 /* - Number of values defining each point in the built-in data
99  *   buffers for primitives (e.g. 2D Monkey)
100  */
101 #define GP_PRIM_DATABUF_SIZE 5
102
103 void BKE_gpencil_stroke_add_points(struct bGPDstroke *gps,
104                                    const float *array,
105                                    const int totpoints,
106                                    const float mat[4][4]);
107
108 struct bGPDstroke *BKE_gpencil_add_stroke(struct bGPDframe *gpf,
109                                           int mat_idx,
110                                           int totpoints,
111                                           short thickness);
112
113 /* Stroke and Fill - Alpha Visibility Threshold */
114 #define GPENCIL_ALPHA_OPACITY_THRESH 0.001f
115 #define GPENCIL_STRENGTH_MIN 0.003f
116
117 bool gpencil_layer_is_editable(const struct bGPDlayer *gpl);
118
119 /* How gpencil_layer_getframe() should behave when there
120  * is no existing GP-Frame on the frame requested.
121  */
122 typedef enum eGP_GetFrame_Mode {
123   /* Use the preceding gp-frame (i.e. don't add anything) */
124   GP_GETFRAME_USE_PREV = 0,
125
126   /* Add a new empty/blank frame */
127   GP_GETFRAME_ADD_NEW = 1,
128   /* Make a copy of the active frame */
129   GP_GETFRAME_ADD_COPY = 2,
130 } eGP_GetFrame_Mode;
131
132 struct bGPDframe *BKE_gpencil_layer_getframe(struct bGPDlayer *gpl,
133                                              int cframe,
134                                              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 /* Brush */
143 struct Material *BKE_gpencil_brush_material_get(struct Brush *brush);
144 void BKE_gpencil_brush_material_set(struct Brush *brush, struct Material *material);
145
146 /* Object */
147 struct Material *BKE_gpencil_object_material_ensure_active(struct Main *bmain, struct Object *ob);
148 struct Material *BKE_gpencil_object_material_ensure_from_brush(struct Main *bmain,
149                                                                struct Object *ob,
150                                                                struct Brush *brush);
151 int BKE_gpencil_object_material_ensure(struct Main *bmain,
152                                        struct Object *ob,
153                                        struct Material *material);
154
155 struct Material *BKE_gpencil_object_material_new(struct Main *bmain,
156                                                  struct Object *ob,
157                                                  const char *name,
158                                                  int *r_index);
159
160 int BKE_gpencil_object_material_get_index(struct Object *ob, struct Material *ma);
161
162 struct Material *BKE_gpencil_object_material_get_from_brush(struct Object *ob,
163                                                             struct Brush *brush);
164 int BKE_gpencil_object_material_get_index_from_brush(struct Object *ob, struct Brush *brush);
165
166 struct Material *BKE_gpencil_object_material_ensure_from_active_input_toolsettings(
167     struct Main *bmain, struct Object *ob, struct ToolSettings *ts);
168 struct Material *BKE_gpencil_object_material_ensure_from_active_input_brush(struct Main *bmain,
169                                                                             struct Object *ob,
170                                                                             struct Brush *brush);
171 struct Material *BKE_gpencil_object_material_ensure_from_active_input_material(struct Main *bmain,
172                                                                                struct Object *ob);
173
174 /* object boundbox */
175 bool BKE_gpencil_data_minmax(const struct bGPdata *gpd, float r_min[3], float r_max[3]);
176 bool BKE_gpencil_stroke_minmax(const struct bGPDstroke *gps,
177                                const bool use_select,
178                                float r_min[3],
179                                float r_max[3]);
180 bool BKE_gpencil_stroke_select_check(const struct bGPDstroke *gps);
181
182 struct BoundBox *BKE_gpencil_boundbox_get(struct Object *ob);
183 void BKE_gpencil_centroid_3d(struct bGPdata *gpd, float r_centroid[3]);
184
185 /* vertex groups */
186 void BKE_gpencil_dvert_ensure(struct bGPDstroke *gps);
187 void BKE_gpencil_vgroup_remove(struct Object *ob, struct bDeformGroup *defgroup);
188 void BKE_gpencil_stroke_weights_duplicate(struct bGPDstroke *gps_src, struct bGPDstroke *gps_dst);
189
190 /* GPencil geometry evaluation */
191 void BKE_gpencil_eval_geometry(struct Depsgraph *depsgraph, struct bGPdata *gpd);
192
193 /* stroke geometry utilities */
194 void BKE_gpencil_stroke_normal(const struct bGPDstroke *gps, float r_normal[3]);
195 void BKE_gpencil_simplify_stroke(struct bGPDstroke *gps, float factor);
196 void BKE_gpencil_simplify_fixed(struct bGPDstroke *gps);
197 void BKE_gpencil_subdivide(struct bGPDstroke *gps, int level, int flag);
198 bool BKE_gpencil_trim_stroke(struct bGPDstroke *gps);
199
200 void BKE_gpencil_stroke_2d_flat(const struct bGPDspoint *points,
201                                 int totpoints,
202                                 float (*points2d)[2],
203                                 int *r_direction);
204 void BKE_gpencil_stroke_2d_flat_ref(const struct bGPDspoint *ref_points,
205                                     int ref_totpoints,
206                                     const struct bGPDspoint *points,
207                                     int totpoints,
208                                     float (*points2d)[2],
209                                     const float scale,
210                                     int *r_direction);
211
212 void BKE_gpencil_transform(struct bGPdata *gpd, float mat[4][4]);
213
214 bool BKE_gpencil_smooth_stroke(struct bGPDstroke *gps, int i, float inf);
215 bool BKE_gpencil_smooth_stroke_strength(struct bGPDstroke *gps, int point_index, float influence);
216 bool BKE_gpencil_smooth_stroke_thickness(struct bGPDstroke *gps, int point_index, float influence);
217 bool BKE_gpencil_smooth_stroke_uv(struct bGPDstroke *gps, int point_index, float influence);
218
219 void BKE_gpencil_get_range_selected(struct bGPDlayer *gpl, int *r_initframe, int *r_endframe);
220 float BKE_gpencil_multiframe_falloff_calc(
221     struct bGPDframe *gpf, int actnum, int f_init, int f_end, struct CurveMapping *cur_falloff);
222
223 extern void (*BKE_gpencil_batch_cache_dirty_tag_cb)(struct bGPdata *gpd);
224 extern void (*BKE_gpencil_batch_cache_free_cb)(struct bGPdata *gpd);
225
226 #endif /*  __BKE_GPENCIL_H__ */