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