Texture painting:
[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 MDisps;
41 struct MeshElemMap;
42 struct GridPaintMask;
43 struct Main;
44 struct MFace;
45 struct MultireModifierData;
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 struct wmOperator;
61
62 enum OverlayFlags;
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 PaintMode {
70         PAINT_SCULPT = 0,
71         PAINT_VERTEX = 1,
72         PAINT_WEIGHT = 2,
73         PAINT_TEXTURE_PROJECTIVE = 3,
74         PAINT_TEXTURE_2D = 4,
75         PAINT_SCULPT_UV = 5,
76         PAINT_INVALID = 6
77 } PaintMode;
78
79 /* overlay invalidation */
80 typedef enum OverlayControlFlags {
81         PAINT_INVALID_OVERLAY_TEXTURE_PRIMARY = 1,
82         PAINT_INVALID_OVERLAY_TEXTURE_SECONDARY = (1 << 2),
83         PAINT_INVALID_OVERLAY_CURVE = (1 << 3),
84         PAINT_OVERLAY_OVERRIDE_CURSOR = (1 << 4),
85         PAINT_OVERLAY_OVERRIDE_PRIMARY = (1 << 5),
86         PAINT_OVERLAY_OVERRIDE_SECONDARY = (1 << 6)
87 } OverlayControlFlags;
88
89 #define PAINT_OVERRIDE_MASK (PAINT_OVERLAY_OVERRIDE_SECONDARY | \
90                                                      PAINT_OVERLAY_OVERRIDE_PRIMARY | \
91                                                      PAINT_OVERLAY_OVERRIDE_CURSOR)
92
93 void BKE_paint_invalidate_overlay_tex(struct Scene *scene, const struct Tex *tex);
94 void BKE_paint_invalidate_cursor_overlay(struct Scene *scene, struct CurveMapping *curve);
95 void BKE_paint_invalidate_overlay_all(void);
96 OverlayControlFlags BKE_paint_get_overlay_flags(void);
97 void BKE_paint_reset_overlay_invalid(OverlayControlFlags flag);
98 void BKE_paint_set_overlay_override(enum OverlayFlags flag);
99
100 /* palettes */
101 void                 BKE_palette_free(struct Palette *palette);
102 struct Palette      *BKE_palette_add(struct Main *bmain, const char *name);
103 struct PaletteColor *BKE_palette_color_add(struct Palette *palette);
104 bool                 BKE_palette_is_empty(const struct Palette *palette);
105 void                 BKE_palette_color_remove(struct Palette *palette, struct PaletteColor *color);
106 void                 BKE_palette_cleanup(struct Palette *palette);
107
108 /* paint curves */
109 struct PaintCurve *BKE_paint_curve_add(struct Main *bmain, const char *name);
110 void BKE_paint_curve_free(struct PaintCurve *pc);
111
112 void BKE_paint_init(struct Paint *p, const char col[3]);
113 void BKE_paint_free(struct Paint *p);
114 void BKE_paint_copy(struct Paint *src, struct Paint *tar);
115
116 struct Paint *BKE_paint_get_active(struct Scene *sce);
117 struct Paint *BKE_paint_get_active_from_context(const struct bContext *C);
118 PaintMode BKE_paintmode_get_active_from_context(const struct bContext *C);
119 struct Brush *BKE_paint_brush(struct Paint *paint);
120 void BKE_paint_brush_set(struct Paint *paint, struct Brush *br);
121 struct Palette *BKE_paint_palette(struct Paint *paint);
122 void BKE_paint_palette_set(struct Paint *p, struct Palette *palette);
123 void BKE_paint_curve_set(struct Brush *br, struct PaintCurve *pc);
124
125 void BKE_paint_data_warning(struct ReportList *reports, bool uvs, bool mat, bool tex, bool stencil);
126 bool BKE_paint_proj_mesh_data_check(struct Scene *scene, struct Object *ob, bool *uvs, bool *mat, bool *tex, bool *stencil);
127
128 /* testing face select mode
129  * Texture paint could be removed since selected faces are not used
130  * however hiding faces is useful */
131 bool BKE_paint_select_face_test(struct Object *ob);
132 bool BKE_paint_select_vert_test(struct Object *ob);
133 bool BKE_paint_select_elem_test(struct Object *ob);
134
135 /* partial visibility */
136 bool paint_is_face_hidden(const struct MFace *f, const struct MVert *mvert);
137 bool paint_is_grid_face_hidden(const unsigned int *grid_hidden,
138                                int gridsize, int x, int y);
139 bool paint_is_bmesh_face_hidden(struct BMFace *f);
140
141 /* paint masks */
142 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
143                             unsigned x, unsigned y);
144
145 /* stroke related */
146 void paint_calculate_rake_rotation(struct UnifiedPaintSettings *ups, const float mouse_pos[2]);
147
148 /* Session data (mode-specific) */
149
150 typedef struct SculptSession {
151         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
152         struct MultiresModifierData *multires; /* Special handling for multires meshes */
153         struct MVert *mvert;
154         struct MPoly *mpoly;
155         struct MLoop *mloop;
156         int totvert, totpoly;
157         float (*face_normals)[3];
158         struct KeyBlock *kb;
159         float *vmask;
160         
161         /* Mesh connectivity */
162         const struct MeshElemMap *pmap;
163
164         /* BMesh for dynamic topology sculpting */
165         struct BMesh *bm;
166         int cd_vert_node_offset;
167         int cd_face_node_offset;
168         bool bm_smooth_shading;
169         /* Undo/redo log for dynamic topology sculpting */
170         struct BMLog *bm_log;
171
172         /* PBVH acceleration structure */
173         struct PBVH *pbvh;
174         bool show_diffuse_color;
175
176         /* Painting on deformed mesh */
177         bool modifiers_active; /* object is deformed with some modifiers */
178         float (*orig_cos)[3]; /* coords of undeformed mesh */
179         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
180         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
181
182         /* Partial redraw */
183         bool partial_redraw;
184         
185         /* Used to cache the render of the active texture */
186         unsigned int texcache_side, *texcache, texcache_actual;
187         struct ImagePool *tex_pool;
188
189         /* Layer brush persistence between strokes */
190         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
191
192         struct SculptStroke *stroke;
193         struct StrokeCache *cache;
194
195         /* last paint/sculpt stroke location */
196         bool last_stroke_valid;
197         float last_stroke[3];
198
199         float average_stroke_accum[3];
200         int average_stroke_counter;
201 } SculptSession;
202
203 void BKE_free_sculptsession(struct Object *ob);
204 void BKE_free_sculptsession_deformMats(struct SculptSession *ss);
205 void BKE_sculptsession_bm_to_me(struct Object *ob, bool reorder);
206 void BKE_sculptsession_bm_to_me_for_render(struct Object *object);
207 void BKE_sculpt_update_mesh_elements(struct Scene *scene, struct Sculpt *sd, struct Object *ob,
208                                      bool need_pmap, bool need_mask);
209 struct MultiresModifierData *BKE_sculpt_multires_active(struct Scene *scene, struct Object *ob);
210 int BKE_sculpt_mask_layers_ensure(struct Object *ob,
211                                   struct MultiresModifierData *mmd);
212
213 enum {
214         SCULPT_MASK_LAYER_CALC_VERT = (1 << 0),
215         SCULPT_MASK_LAYER_CALC_LOOP = (1 << 1)
216 };
217 #endif