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