style cleanup
[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 MDisps;
40 struct MeshElemMap;
41 struct GridPaintMask;
42 struct MFace;
43 struct MultireModifierData;
44 struct MVert;
45 struct Object;
46 struct Paint;
47 struct PBVH;
48 struct Scene;
49 struct StrokeCache;
50 struct ImagePool;
51
52 extern const char PAINT_CURSOR_SCULPT[3];
53 extern const char PAINT_CURSOR_VERTEX_PAINT[3];
54 extern const char PAINT_CURSOR_WEIGHT_PAINT[3];
55 extern const char PAINT_CURSOR_TEXTURE_PAINT[3];
56
57 typedef enum PaintMode {
58         PAINT_SCULPT,
59         PAINT_VERTEX,
60         PAINT_WEIGHT,
61         PAINT_TEXTURE_PROJECTIVE,
62         PAINT_TEXTURE_2D,
63         PAINT_SCULPT_UV,
64         PAINT_INVALID
65 } PaintMode;
66
67 void BKE_paint_init(struct Paint *p, const char col[3]);
68 void BKE_paint_free(struct Paint *p);
69 void BKE_paint_copy(struct Paint *src, struct Paint *tar);
70
71 /* TODO, give these BKE_ prefix too */
72 struct Paint *paint_get_active(struct Scene *sce);
73 struct Paint *paint_get_active_from_context(const struct bContext *C);
74 PaintMode paintmode_get_active_from_context(const struct bContext *C);
75 struct Brush *paint_brush(struct Paint *paint);
76 void paint_brush_set(struct Paint *paint, struct Brush *br);
77
78 /* testing face select mode
79  * Texture paint could be removed since selected faces are not used
80  * however hiding faces is useful */
81 int paint_facesel_test(struct Object *ob);
82 int paint_vertsel_test(struct Object *ob);
83
84 /* partial visibility */
85 int paint_is_face_hidden(const struct MFace *f, const struct MVert *mvert);
86 int paint_is_grid_face_hidden(const unsigned int *grid_hidden,
87                               int gridsize, int x, int y);
88 int paint_is_bmesh_face_hidden(struct BMFace *f);
89
90 /* paint masks */
91 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
92                             unsigned x, unsigned y);
93
94 /* Session data (mode-specific) */
95
96 typedef struct SculptSession {
97         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
98         struct MultiresModifierData *multires; /* Special handling for multires meshes */
99         struct MVert *mvert;
100         struct MPoly *mpoly;
101         struct MLoop *mloop;
102         int totvert, totpoly;
103         float *face_normals;
104         struct KeyBlock *kb;
105         float *vmask;
106         
107         /* Mesh connectivity */
108         const struct MeshElemMap *pmap;
109
110         /* BMesh for dynamic topology sculpting */
111         struct BMesh *bm;
112         int bm_smooth_shading;
113         /* Undo/redo log for dynamic topology sculpting */
114         struct BMLog *bm_log;
115
116         /* PBVH acceleration structure */
117         struct PBVH *pbvh;
118         int show_diffuse_color;
119
120         /* Paiting on deformed mesh */
121         int modifiers_active; /* object is deformed with some modifiers */
122         float (*orig_cos)[3]; /* coords of undeformed mesh */
123         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
124         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
125
126         /* Partial redraw */
127         int partial_redraw;
128         
129         /* Used to cache the render of the active texture */
130         unsigned int texcache_side, *texcache, texcache_actual;
131         struct ImagePool *tex_pool;
132
133         /* Layer brush persistence between strokes */
134         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
135
136         struct SculptStroke *stroke;
137         struct StrokeCache *cache;
138
139         /* last paint/sculpt stroke location */
140         int last_stroke_valid;
141         float last_stroke[3];
142 } SculptSession;
143
144 void free_sculptsession(struct Object *ob);
145 void free_sculptsession_deformMats(struct SculptSession *ss);
146 void sculptsession_bm_to_me(struct Object *ob, int reorder);
147
148 #endif