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