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