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