doxygen: add newline after \file
[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, const struct bGPdata *gpd, bool internal_copy);
81
82 void BKE_gpencil_make_local(struct Main *bmain, struct bGPdata *gpd, const bool lib_local);
83
84 void BKE_gpencil_frame_delete_laststroke(struct bGPDlayer *gpl, struct bGPDframe *gpf);
85
86 /* materials */
87 void BKE_gpencil_material_index_remove(struct bGPdata *gpd, int index);
88 void BKE_gpencil_material_remap(struct bGPdata *gpd, const unsigned int *remap, unsigned int remap_len);
89 int BKE_gpencil_get_material_index(struct Object *ob, struct Material *ma);
90
91 /* statistics functions */
92 void BKE_gpencil_stats_update(struct bGPdata *gpd);
93
94 /* Utilities for creating and populating GP strokes */
95 /* - Number of values defining each point in the built-in data
96  *   buffers for primitives (e.g. 2D Monkey)
97  */
98 #define GP_PRIM_DATABUF_SIZE  5
99
100 void BKE_gpencil_stroke_add_points(
101         struct bGPDstroke *gps,
102         const float *array, const int totpoints,
103         const float mat[4][4]);
104
105 struct bGPDstroke *BKE_gpencil_add_stroke(struct bGPDframe *gpf, int mat_idx, int totpoints, short thickness);
106
107 /* Stroke and Fill - Alpha Visibility Threshold */
108 #define GPENCIL_ALPHA_OPACITY_THRESH 0.001f
109 #define GPENCIL_STRENGTH_MIN 0.003f
110
111 bool gpencil_layer_is_editable(const struct bGPDlayer *gpl);
112
113 /* How gpencil_layer_getframe() should behave when there
114  * is no existing GP-Frame on the frame requested.
115  */
116 typedef enum eGP_GetFrame_Mode {
117         /* Use the preceding gp-frame (i.e. don't add anything) */
118         GP_GETFRAME_USE_PREV  = 0,
119
120         /* Add a new empty/blank frame */
121         GP_GETFRAME_ADD_NEW   = 1,
122         /* Make a copy of the active frame */
123         GP_GETFRAME_ADD_COPY  = 2,
124 } eGP_GetFrame_Mode;
125
126 struct bGPDframe *BKE_gpencil_layer_getframe(struct bGPDlayer *gpl, int cframe, eGP_GetFrame_Mode addnew);
127 struct bGPDframe *BKE_gpencil_layer_find_frame(struct bGPDlayer *gpl, int cframe);
128 bool BKE_gpencil_layer_delframe(struct bGPDlayer *gpl, struct bGPDframe *gpf);
129
130 struct bGPDlayer *BKE_gpencil_layer_getactive(struct bGPdata *gpd);
131 void BKE_gpencil_layer_setactive(struct bGPdata *gpd, struct bGPDlayer *active);
132 void BKE_gpencil_layer_delete(struct bGPdata *gpd, struct bGPDlayer *gpl);
133
134 struct Material *BKE_gpencil_get_material_from_brush(struct Brush *brush);
135 struct Material *BKE_gpencil_material_ensure(struct Main *bmain, struct Object *ob);
136
137 /* object boundbox */
138 bool BKE_gpencil_data_minmax(
139         struct Object *ob, const struct bGPdata *gpd,
140         float r_min[3], float r_max[3]);
141 bool BKE_gpencil_stroke_minmax(
142         const struct bGPDstroke *gps, const bool use_select,
143         float r_min[3], float r_max[3]);
144 bool BKE_gpencil_stroke_select_check(
145         const struct bGPDstroke *gps);
146
147 struct BoundBox *BKE_gpencil_boundbox_get(struct Object *ob);
148 void BKE_gpencil_centroid_3d(struct bGPdata *gpd, float r_centroid[3]);
149
150 /* vertex groups */
151 void BKE_gpencil_dvert_ensure(struct bGPDstroke *gps);
152 void BKE_gpencil_vgroup_remove(struct Object *ob, struct bDeformGroup *defgroup);
153 void BKE_gpencil_stroke_weights_duplicate(struct bGPDstroke *gps_src, struct bGPDstroke *gps_dst);
154
155 /* GPencil geometry evaluation */
156 void BKE_gpencil_eval_geometry(struct Depsgraph *depsgraph, struct bGPdata *gpd);
157
158 /* stroke geometry utilities */
159 void BKE_gpencil_stroke_normal(const struct bGPDstroke *gps, float r_normal[3]);
160 void BKE_gpencil_simplify_stroke(struct bGPDstroke *gps, float factor);
161 void BKE_gpencil_simplify_fixed(struct bGPDstroke *gps);
162 void BKE_gpencil_subdivide(struct bGPDstroke *gps, int level, int flag);
163
164 void BKE_gpencil_stroke_2d_flat(
165         const struct bGPDspoint *points, int totpoints, float(*points2d)[2], int *r_direction);
166 void BKE_gpencil_stroke_2d_flat_ref(
167         const struct bGPDspoint *ref_points, int ref_totpoints,
168         const struct bGPDspoint *points, int totpoints,
169         float(*points2d)[2], const float scale, int *r_direction);
170
171 void BKE_gpencil_transform(struct bGPdata *gpd, float mat[4][4]);
172
173 bool BKE_gpencil_smooth_stroke(struct bGPDstroke *gps, int i, float inf);
174 bool BKE_gpencil_smooth_stroke_strength(struct bGPDstroke *gps, int point_index, float influence);
175 bool BKE_gpencil_smooth_stroke_thickness(struct bGPDstroke *gps, int point_index, float influence);
176 bool BKE_gpencil_smooth_stroke_uv(struct bGPDstroke *gps, int point_index, float influence);
177
178 void BKE_gpencil_get_range_selected(struct bGPDlayer *gpl, int *r_initframe, int *r_endframe);
179 float BKE_gpencil_multiframe_falloff_calc(struct bGPDframe *gpf, int actnum, int f_init, int f_end, struct CurveMapping *cur_falloff);
180
181 #endif /*  __BKE_GPENCIL_H__ */