Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_paint.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) 2009 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_PAINT_H__
29 #define __BKE_PAINT_H__
30
31 /** \file BKE_paint.h
32  *  \ingroup bke
33  */
34
35 struct bContext;
36 struct bToolRef;
37 struct BMesh;
38 struct BMFace;
39 struct Brush;
40 struct CurveMapping;
41 struct EnumPropertyItem;
42 struct MeshElemMap;
43 struct GridPaintMask;
44 struct Main;
45 struct Mesh;
46 struct MLoop;
47 struct MLoopTri;
48 struct MFace;
49 struct MVert;
50 struct Object;
51 struct Paint;
52 struct PaintCurve;
53 struct Palette;
54 struct PaletteColor;
55 struct PBVH;
56 struct ReportList;
57 struct Scene;
58 struct ViewLayer;
59 struct Sculpt;
60 struct StrokeCache;
61 struct SubdivCCG;
62 struct Tex;
63 struct ImagePool;
64 struct UnifiedPaintSettings;
65 struct Depsgraph;
66 struct ToolSettings;
67
68 enum eOverlayFlags;
69
70 #include "DNA_object_enums.h"
71
72 extern const char PAINT_CURSOR_SCULPT[3];
73 extern const char PAINT_CURSOR_VERTEX_PAINT[3];
74 extern const char PAINT_CURSOR_WEIGHT_PAINT[3];
75 extern const char PAINT_CURSOR_TEXTURE_PAINT[3];
76
77 typedef enum ePaintMode {
78         PAINT_MODE_SCULPT = 0,
79         /** Vertex color. */
80         PAINT_MODE_VERTEX = 1,
81         PAINT_MODE_WEIGHT = 2,
82         /** 3D view (projection painting). */
83         PAINT_MODE_TEXTURE_3D = 3,
84         /** Image space (2D painting). */
85         PAINT_MODE_TEXTURE_2D = 4,
86         PAINT_MODE_SCULPT_UV = 5,
87         PAINT_MODE_GPENCIL = 6,
88
89         /** Keep last. */
90         PAINT_MODE_INVALID = 7,
91 } ePaintMode;
92
93 #define PAINT_MODE_HAS_BRUSH(mode) !ELEM(mode, PAINT_MODE_SCULPT_UV)
94
95 /* overlay invalidation */
96 typedef enum eOverlayControlFlags {
97         PAINT_OVERLAY_INVALID_TEXTURE_PRIMARY = 1,
98         PAINT_OVERLAY_INVALID_TEXTURE_SECONDARY = (1 << 2),
99         PAINT_OVERLAY_INVALID_CURVE = (1 << 3),
100         PAINT_OVERLAY_OVERRIDE_CURSOR = (1 << 4),
101         PAINT_OVERLAY_OVERRIDE_PRIMARY = (1 << 5),
102         PAINT_OVERLAY_OVERRIDE_SECONDARY = (1 << 6)
103 } eOverlayControlFlags;
104
105 #define PAINT_OVERRIDE_MASK \
106         (PAINT_OVERLAY_OVERRIDE_SECONDARY | \
107          PAINT_OVERLAY_OVERRIDE_PRIMARY | \
108          PAINT_OVERLAY_OVERRIDE_CURSOR)
109
110 void BKE_paint_invalidate_overlay_tex(struct Scene *scene, struct ViewLayer *view_layer, const struct Tex *tex);
111 void BKE_paint_invalidate_cursor_overlay(struct Scene *scene, struct ViewLayer *view_layer, struct CurveMapping *curve);
112 void BKE_paint_invalidate_overlay_all(void);
113 eOverlayControlFlags BKE_paint_get_overlay_flags(void);
114 void BKE_paint_reset_overlay_invalid(eOverlayControlFlags flag);
115 void BKE_paint_set_overlay_override(enum eOverlayFlags flag);
116
117 /* palettes */
118 void                 BKE_palette_init(struct Palette *palette);
119 void                 BKE_palette_free(struct Palette *palette);
120 struct Palette      *BKE_palette_add(struct Main *bmain, const char *name);
121 void BKE_palette_copy_data(
122         struct Main *bmain, struct Palette *palette_dst, const struct Palette *palette_src, const int flag);
123 struct Palette      *BKE_palette_copy(struct Main *bmain, const struct Palette *palette);
124 void                 BKE_palette_make_local(struct Main *bmain, struct Palette *palette, const bool lib_local);
125 struct PaletteColor *BKE_palette_color_add(struct Palette *palette);
126 bool                 BKE_palette_is_empty(const struct Palette *palette);
127 void                 BKE_palette_color_remove(struct Palette *palette, struct PaletteColor *color);
128 void                 BKE_palette_clear(struct Palette *palette);
129
130 /* paint curves */
131 struct PaintCurve *BKE_paint_curve_add(struct Main *bmain, const char *name);
132 void BKE_paint_curve_free(struct PaintCurve *pc);
133 void BKE_paint_curve_copy_data(
134         struct Main *bmain, struct PaintCurve *pc_dst, const struct PaintCurve *pc_src, const int flag);
135 struct PaintCurve *BKE_paint_curve_copy(struct Main *bmain, const struct PaintCurve *pc);
136 void               BKE_paint_curve_make_local(struct Main *bmain, struct PaintCurve *pc, const bool lib_local);
137
138 bool BKE_paint_ensure(const struct ToolSettings *ts, struct Paint **r_paint);
139 void BKE_paint_init(struct Main *bmain, struct Scene *sce, ePaintMode mode, const char col[3]);
140 void BKE_paint_free(struct Paint *p);
141 void BKE_paint_copy(struct Paint *src, struct Paint *tar, const int flag);
142
143 void BKE_paint_runtime_init(const struct ToolSettings *ts, struct Paint *paint);
144
145 void BKE_paint_cavity_curve_preset(struct Paint *p, int preset);
146
147 eObjectMode BKE_paint_object_mode_from_paintmode(ePaintMode mode);
148 struct Paint *BKE_paint_get_active_from_paintmode(struct Scene *sce, ePaintMode mode);
149 const struct EnumPropertyItem *BKE_paint_get_tool_enum_from_paintmode(ePaintMode mode);
150 const char *BKE_paint_get_tool_prop_id_from_paintmode(ePaintMode mode);
151 uint BKE_paint_get_brush_tool_offset_from_paintmode(const ePaintMode mode);
152 struct Paint *BKE_paint_get_active(struct Scene *sce, struct ViewLayer *view_layer);
153 struct Paint *BKE_paint_get_active_from_context(const struct bContext *C);
154 ePaintMode BKE_paintmode_get_active_from_context(const struct bContext *C);
155 ePaintMode BKE_paintmode_get_from_tool(const struct bToolRef *tref);
156 struct Brush *BKE_paint_brush(struct Paint *paint);
157 void BKE_paint_brush_set(struct Paint *paint, struct Brush *br);
158 struct Palette *BKE_paint_palette(struct Paint *paint);
159 void BKE_paint_palette_set(struct Paint *p, struct Palette *palette);
160 void BKE_paint_curve_set(struct Brush *br, struct PaintCurve *pc);
161 void BKE_paint_curve_clamp_endpoint_add_index(struct PaintCurve *pc, const int add_index);
162
163 void BKE_paint_data_warning(struct ReportList *reports, bool uvs, bool mat, bool tex, bool stencil);
164 bool BKE_paint_proj_mesh_data_check(struct Scene *scene, struct Object *ob, bool *uvs, bool *mat, bool *tex, bool *stencil);
165
166 /* testing face select mode
167  * Texture paint could be removed since selected faces are not used
168  * however hiding faces is useful */
169 bool BKE_paint_select_face_test(struct Object *ob);
170 bool BKE_paint_select_vert_test(struct Object *ob);
171 bool BKE_paint_select_elem_test(struct Object *ob);
172
173 /* partial visibility */
174 bool paint_is_face_hidden(const struct MLoopTri *lt, const struct MVert *mvert, const struct MLoop *mloop);
175 bool paint_is_grid_face_hidden(const unsigned int *grid_hidden,
176                                int gridsize, int x, int y);
177 bool paint_is_bmesh_face_hidden(struct BMFace *f);
178
179 /* paint masks */
180 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
181                             unsigned x, unsigned y);
182
183 /* stroke related */
184 bool paint_calculate_rake_rotation(struct UnifiedPaintSettings *ups, struct Brush *brush, const float mouse_pos[2]);
185 void paint_update_brush_rake_rotation(struct UnifiedPaintSettings *ups, struct Brush *brush, float rotation);
186
187 void BKE_paint_stroke_get_average(struct Scene *scene, struct Object *ob, float stroke[3]);
188
189
190 /* Tool slot API. */
191 void BKE_paint_toolslots_init_from_main(struct Main *bmain);
192 void BKE_paint_toolslots_len_ensure(struct Paint *paint, int len);
193 void BKE_paint_toolslots_brush_update_ex(struct Paint *paint, struct Brush *brush);
194 void BKE_paint_toolslots_brush_update(struct Paint *paint);
195 void BKE_paint_toolslots_brush_validate(struct Main *bmain, struct Paint *paint);
196 struct Brush *BKE_paint_toolslots_brush_get(struct Paint *paint, int slot_index);
197
198 /* Used for both vertex color and weight paint */
199 struct SculptVertexPaintGeomMap {
200         int *vert_map_mem;
201         struct MeshElemMap *vert_to_loop;
202         int *poly_map_mem;
203         struct MeshElemMap *vert_to_poly;
204 };
205
206 /* Session data (mode-specific) */
207
208 typedef struct SculptSession {
209         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
210         struct MultiresModifierData *multires; /* Special handling for multires meshes */
211         struct MVert *mvert;
212         struct MPoly *mpoly;
213         struct MLoop *mloop;
214         int totvert, totpoly;
215         struct KeyBlock *kb;
216         float *vmask;
217
218         /* Mesh connectivity */
219         struct MeshElemMap *pmap;
220         int *pmap_mem;
221
222         /* BMesh for dynamic topology sculpting */
223         struct BMesh *bm;
224         int cd_vert_node_offset;
225         int cd_face_node_offset;
226         bool bm_smooth_shading;
227         /* Undo/redo log for dynamic topology sculpting */
228         struct BMLog *bm_log;
229
230         /* Limit surface/grids. */
231         struct SubdivCCG *subdiv_ccg;
232
233         /* PBVH acceleration structure */
234         struct PBVH *pbvh;
235         bool show_diffuse_color;
236         bool show_mask;
237
238         /* Painting on deformed mesh */
239         bool modifiers_active; /* object is deformed with some modifiers */
240         float (*orig_cos)[3]; /* coords of undeformed mesh */
241         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
242         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
243
244         /* Partial redraw */
245         bool partial_redraw;
246
247         /* Used to cache the render of the active texture */
248         unsigned int texcache_side, *texcache, texcache_actual;
249         struct ImagePool *tex_pool;
250
251         /* Layer brush persistence between strokes */
252         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
253
254         struct StrokeCache *cache;
255
256         union {
257                 struct {
258                         struct SculptVertexPaintGeomMap gmap;
259
260                         /* For non-airbrush painting to re-apply from the original (MLoop aligned). */
261                         unsigned int *previous_color;
262                 } vpaint;
263
264                 struct {
265                         struct SculptVertexPaintGeomMap gmap;
266                         /* Keep track of how much each vertex has been painted (non-airbrush only). */
267                         float *alpha_weight;
268
269                         /* Needed to continuously re-apply over the same weights (BRUSH_ACCUMULATE disabled).
270                          * Lazy initialize as needed (flag is set to 1 to tag it as uninitialized). */
271                         struct MDeformVert *dvert_prev;
272                 } wpaint;
273
274                 /* TODO: identify sculpt-only fields */
275                 // struct { ... } sculpt;
276         } mode;
277         int mode_type;
278
279         /* This flag prevents PBVH from being freed when creating the vp_handle for texture paint. */
280         bool building_vp_handle;
281 } SculptSession;
282
283 void BKE_sculptsession_free(struct Object *ob);
284 void BKE_sculptsession_free_deformMats(struct SculptSession *ss);
285 void BKE_sculptsession_free_vwpaint_data(struct SculptSession *ss);
286 void BKE_sculptsession_bm_to_me(struct Object *ob, bool reorder);
287 void BKE_sculptsession_bm_to_me_for_render(struct Object *object);
288 void BKE_sculpt_update_mesh_elements(
289         struct Depsgraph *depsgraph, struct Scene *scene, struct Sculpt *sd, struct Object *ob,
290         bool need_pmap, bool need_mask);
291 struct MultiresModifierData *BKE_sculpt_multires_active(struct Scene *scene, struct Object *ob);
292 int BKE_sculpt_mask_layers_ensure(struct Object *ob,
293                                   struct MultiresModifierData *mmd);
294 void BKE_sculpt_toolsettings_data_ensure(struct Scene *scene);
295
296 struct PBVH *BKE_sculpt_object_pbvh_ensure(struct Depsgraph *depsgraph, struct Object *ob);
297
298 enum {
299         SCULPT_MASK_LAYER_CALC_VERT = (1 << 0),
300         SCULPT_MASK_LAYER_CALC_LOOP = (1 << 1)
301 };
302 #endif