Code cleanup: use r_ prefix for return args
[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 MFace;
44 struct MultireModifierData;
45 struct MVert;
46 struct Object;
47 struct Paint;
48 struct PBVH;
49 struct Scene;
50 struct StrokeCache;
51 struct Tex;
52 struct ImagePool;
53 struct UnifiedPaintSettings;
54
55 enum OverlayFlags;
56
57 extern const char PAINT_CURSOR_SCULPT[3];
58 extern const char PAINT_CURSOR_VERTEX_PAINT[3];
59 extern const char PAINT_CURSOR_WEIGHT_PAINT[3];
60 extern const char PAINT_CURSOR_TEXTURE_PAINT[3];
61
62 typedef enum PaintMode {
63         PAINT_SCULPT = 0,
64         PAINT_VERTEX = 1,
65         PAINT_WEIGHT = 2,
66         PAINT_TEXTURE_PROJECTIVE = 3,
67         PAINT_TEXTURE_2D = 4,
68         PAINT_SCULPT_UV = 5,
69         PAINT_INVALID = 6
70 } PaintMode;
71
72 /* overlay invalidation */
73 typedef enum OverlayControlFlags {
74         PAINT_INVALID_OVERLAY_TEXTURE_PRIMARY = 1,
75         PAINT_INVALID_OVERLAY_TEXTURE_SECONDARY = (1 << 2),
76         PAINT_INVALID_OVERLAY_CURVE = (1 << 3),
77         PAINT_OVERLAY_OVERRIDE_CURSOR = (1 << 4),
78         PAINT_OVERLAY_OVERRIDE_PRIMARY = (1 << 5),
79         PAINT_OVERLAY_OVERRIDE_SECONDARY = (1 << 6)
80 } OverlayControlFlags;
81
82 #define PAINT_OVERRIDE_MASK (PAINT_OVERLAY_OVERRIDE_SECONDARY | \
83                                                      PAINT_OVERLAY_OVERRIDE_PRIMARY | \
84                                                      PAINT_OVERLAY_OVERRIDE_CURSOR)
85
86 void BKE_paint_invalidate_overlay_tex(struct Scene *scene, const struct Tex *tex);
87 void BKE_paint_invalidate_cursor_overlay(struct Scene *scene, struct CurveMapping *curve);
88 void BKE_paint_invalidate_overlay_all(void);
89 OverlayControlFlags BKE_paint_get_overlay_flags(void);
90 void BKE_paint_reset_overlay_invalid(OverlayControlFlags flag);
91 void BKE_paint_set_overlay_override(enum OverlayFlags flag);
92
93 void BKE_paint_init(struct Paint *p, const char col[3]);
94 void BKE_paint_free(struct Paint *p);
95 void BKE_paint_copy(struct Paint *src, struct Paint *tar);
96
97 struct Paint *BKE_paint_get_active(struct Scene *sce);
98 struct Paint *BKE_paint_get_active_from_context(const struct bContext *C);
99 PaintMode BKE_paintmode_get_active_from_context(const struct bContext *C);
100 struct Brush *BKE_paint_brush(struct Paint *paint);
101 void BKE_paint_brush_set(struct Paint *paint, struct Brush *br);
102
103 /* testing face select mode
104  * Texture paint could be removed since selected faces are not used
105  * however hiding faces is useful */
106 bool BKE_paint_select_face_test(struct Object *ob);
107 bool BKE_paint_select_vert_test(struct Object *ob);
108 bool BKE_paint_select_elem_test(struct Object *ob);
109
110 /* partial visibility */
111 bool paint_is_face_hidden(const struct MFace *f, const struct MVert *mvert);
112 bool paint_is_grid_face_hidden(const unsigned int *grid_hidden,
113                                int gridsize, int x, int y);
114 bool paint_is_bmesh_face_hidden(struct BMFace *f);
115
116 /* paint masks */
117 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
118                             unsigned x, unsigned y);
119 void paint_calculate_rake_rotation(struct UnifiedPaintSettings *ups, const float mouse_pos[2]);
120 /* Session data (mode-specific) */
121
122 typedef struct SculptSession {
123         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
124         struct MultiresModifierData *multires; /* Special handling for multires meshes */
125         struct MVert *mvert;
126         struct MPoly *mpoly;
127         struct MLoop *mloop;
128         int totvert, totpoly;
129         float *face_normals;
130         struct KeyBlock *kb;
131         float *vmask;
132         
133         /* Mesh connectivity */
134         const struct MeshElemMap *pmap;
135
136         /* BMesh for dynamic topology sculpting */
137         struct BMesh *bm;
138         int bm_smooth_shading;
139         /* Undo/redo log for dynamic topology sculpting */
140         struct BMLog *bm_log;
141
142         /* PBVH acceleration structure */
143         struct PBVH *pbvh;
144         bool show_diffuse_color;
145
146         /* Paiting on deformed mesh */
147         int modifiers_active; /* object is deformed with some modifiers */
148         float (*orig_cos)[3]; /* coords of undeformed mesh */
149         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
150         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
151
152         /* Partial redraw */
153         int partial_redraw;
154         
155         /* Used to cache the render of the active texture */
156         unsigned int texcache_side, *texcache, texcache_actual;
157         struct ImagePool *tex_pool;
158
159         /* Layer brush persistence between strokes */
160         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
161
162         struct SculptStroke *stroke;
163         struct StrokeCache *cache;
164
165         /* last paint/sculpt stroke location */
166         int last_stroke_valid;
167         float last_stroke[3];
168
169         float average_stroke_accum[3];
170         int average_stroke_counter;
171 } SculptSession;
172
173 void free_sculptsession(struct Object *ob);
174 void free_sculptsession_deformMats(struct SculptSession *ss);
175 void sculptsession_bm_to_me(struct Object *ob, int reorder);
176 void sculptsession_bm_to_me_for_render(struct Object *object);
177 #endif