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