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