tint non-active mask layers grey
[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 Brush;
37 struct MDisps;
38 struct MeshElemMap;
39 struct GridPaintMask;
40 struct MFace;
41 struct MultireModifierData;
42 struct MVert;
43 struct Object;
44 struct Paint;
45 struct PBVH;
46 struct Scene;
47 struct StrokeCache;
48
49 extern const char PAINT_CURSOR_SCULPT[3];
50 extern const char PAINT_CURSOR_VERTEX_PAINT[3];
51 extern const char PAINT_CURSOR_WEIGHT_PAINT[3];
52 extern const char PAINT_CURSOR_TEXTURE_PAINT[3];
53
54 void paint_init(struct Paint *p, const char col[3]);
55 void free_paint(struct Paint *p);
56 void copy_paint(struct Paint *src, struct Paint *tar);
57
58 struct Paint *paint_get_active(struct Scene *sce);
59 struct Paint *paint_get_active_from_context(const struct bContext *C);
60 struct Brush *paint_brush(struct Paint *paint);
61 void paint_brush_set(struct Paint *paint, struct Brush *br);
62
63 /* testing face select mode
64  * Texture paint could be removed since selected faces are not used
65  * however hiding faces is useful */
66 int paint_facesel_test(struct Object *ob);
67 int paint_vertsel_test(struct Object *ob);
68
69 /* partial visibility */
70 int paint_is_face_hidden(const struct MFace *f, const struct MVert *mvert);
71 int paint_is_grid_face_hidden(const unsigned int *grid_hidden,
72                               int gridsize, int x, int y);
73
74 /* paint masks */
75 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
76                             unsigned x, unsigned y);
77
78 /* Session data (mode-specific) */
79
80 typedef struct SculptSession {
81         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
82         struct MultiresModifierData *multires; /* Special handling for multires meshes */
83         struct MVert *mvert;
84         struct MPoly *mpoly;
85         struct MLoop *mloop;
86         int totvert, totpoly;
87         float *face_normals;
88         struct KeyBlock *kb;
89         float *vmask;
90         
91         /* Mesh connectivity */
92         const struct MeshElemMap *pmap;
93
94         /* PBVH acceleration structure */
95         struct PBVH *pbvh;
96
97         /* Paiting on deformed mesh */
98         int modifiers_active; /* object is deformed with some modifiers */
99         float (*orig_cos)[3]; /* coords of undeformed mesh */
100         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
101         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
102
103         /* Partial redraw */
104         int partial_redraw;
105         
106         /* Used to cache the render of the active texture */
107         unsigned int texcache_side, *texcache, texcache_actual;
108
109         /* Layer brush persistence between strokes */
110         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
111
112         struct SculptStroke *stroke;
113         struct StrokeCache *cache;
114
115         /* last paint/sculpt stroke location */
116         int last_stroke_valid;
117         float last_stroke[3];
118 } SculptSession;
119
120 void free_sculptsession(struct Object *ob);
121 void free_sculptsession_deformMats(struct SculptSession *ss);
122
123 #endif