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