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