Pass EvaluationContext argument everywhere
[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 MeshElemMap;
41 struct GridPaintMask;
42 struct Main;
43 struct MLoop;
44 struct MLoopTri;
45 struct MFace;
46 struct MVert;
47 struct Object;
48 struct Paint;
49 struct PaintCurve;
50 struct Palette;
51 struct PaletteColor;
52 struct PBVH;
53 struct ReportList;
54 struct Scene;
55 struct SceneLayer;
56 struct Sculpt;
57 struct StrokeCache;
58 struct Tex;
59 struct ImagePool;
60 struct UnifiedPaintSettings;
61 struct EvaluationContext;
62
63 enum OverlayFlags;
64
65 extern const char PAINT_CURSOR_SCULPT[3];
66 extern const char PAINT_CURSOR_VERTEX_PAINT[3];
67 extern const char PAINT_CURSOR_WEIGHT_PAINT[3];
68 extern const char PAINT_CURSOR_TEXTURE_PAINT[3];
69
70 typedef enum PaintMode {
71         ePaintSculpt = 0,
72         ePaintVertex = 1,
73         ePaintWeight = 2,
74         ePaintTextureProjective = 3,
75         ePaintTexture2D = 4,
76         ePaintSculptUV = 5,
77         ePaintInvalid = 6
78 } PaintMode;
79
80 /* overlay invalidation */
81 typedef enum OverlayControlFlags {
82         PAINT_INVALID_OVERLAY_TEXTURE_PRIMARY = 1,
83         PAINT_INVALID_OVERLAY_TEXTURE_SECONDARY = (1 << 2),
84         PAINT_INVALID_OVERLAY_CURVE = (1 << 3),
85         PAINT_OVERLAY_OVERRIDE_CURSOR = (1 << 4),
86         PAINT_OVERLAY_OVERRIDE_PRIMARY = (1 << 5),
87         PAINT_OVERLAY_OVERRIDE_SECONDARY = (1 << 6)
88 } OverlayControlFlags;
89
90 #define PAINT_OVERRIDE_MASK (PAINT_OVERLAY_OVERRIDE_SECONDARY | \
91                                                      PAINT_OVERLAY_OVERRIDE_PRIMARY | \
92                                                      PAINT_OVERLAY_OVERRIDE_CURSOR)
93
94 void BKE_paint_invalidate_overlay_tex(struct Scene *scene, struct SceneLayer *sl, const struct Tex *tex);
95 void BKE_paint_invalidate_cursor_overlay(struct Scene *scene, struct SceneLayer *sl, struct CurveMapping *curve);
96 void BKE_paint_invalidate_overlay_all(void);
97 OverlayControlFlags BKE_paint_get_overlay_flags(void);
98 void BKE_paint_reset_overlay_invalid(OverlayControlFlags flag);
99 void BKE_paint_set_overlay_override(enum OverlayFlags flag);
100
101 /* palettes */
102 void                 BKE_palette_free(struct Palette *palette);
103 struct Palette      *BKE_palette_add(struct Main *bmain, const char *name);
104 struct Palette      *BKE_palette_copy(struct Main *bmain, const struct Palette *palette);
105 void                 BKE_palette_make_local(struct Main *bmain, struct Palette *palette, const bool lib_local);
106 struct PaletteColor *BKE_palette_color_add(struct Palette *palette);
107 bool                 BKE_palette_is_empty(const struct Palette *palette);
108 void                 BKE_palette_color_remove(struct Palette *palette, struct PaletteColor *color);
109 void                 BKE_palette_clear(struct Palette *palette);
110
111 /* paint curves */
112 struct PaintCurve *BKE_paint_curve_add(struct Main *bmain, const char *name);
113 void BKE_paint_curve_free(struct PaintCurve *pc);
114 struct PaintCurve *BKE_paint_curve_copy(struct Main *bmain, const struct PaintCurve *pc);
115 void               BKE_paint_curve_make_local(struct Main *bmain, struct PaintCurve *pc, const bool lib_local);
116
117 void BKE_paint_init(struct Scene *sce, PaintMode mode, const char col[3]);
118 void BKE_paint_free(struct Paint *p);
119 void BKE_paint_copy(struct Paint *src, struct Paint *tar);
120
121 void BKE_paint_cavity_curve_preset(struct Paint *p, int preset);
122
123 short BKE_paint_object_mode_from_paint_mode(PaintMode mode);
124 struct Paint *BKE_paint_get_active_from_paintmode(struct Scene *sce, PaintMode mode);
125 struct Paint *BKE_paint_get_active(struct Scene *sce, struct SceneLayer *sl);
126 struct Paint *BKE_paint_get_active_from_context(const struct bContext *C);
127 PaintMode BKE_paintmode_get_active_from_context(const struct bContext *C);
128 struct Brush *BKE_paint_brush(struct Paint *paint);
129 void BKE_paint_brush_set(struct Paint *paint, struct Brush *br);
130 struct Palette *BKE_paint_palette(struct Paint *paint);
131 void BKE_paint_palette_set(struct Paint *p, struct Palette *palette);
132 void BKE_paint_curve_set(struct Brush *br, struct PaintCurve *pc);
133 void BKE_paint_curve_clamp_endpoint_add_index(struct PaintCurve *pc, const int add_index);
134
135 void BKE_paint_data_warning(struct ReportList *reports, bool uvs, bool mat, bool tex, bool stencil);
136 bool BKE_paint_proj_mesh_data_check(struct Scene *scene, struct Object *ob, bool *uvs, bool *mat, bool *tex, bool *stencil);
137
138 /* testing face select mode
139  * Texture paint could be removed since selected faces are not used
140  * however hiding faces is useful */
141 bool BKE_paint_select_face_test(struct Object *ob);
142 bool BKE_paint_select_vert_test(struct Object *ob);
143 bool BKE_paint_select_elem_test(struct Object *ob);
144
145 /* partial visibility */
146 bool paint_is_face_hidden(const struct MLoopTri *lt, const struct MVert *mvert, const struct MLoop *mloop);
147 bool paint_is_grid_face_hidden(const unsigned int *grid_hidden,
148                                int gridsize, int x, int y);
149 bool paint_is_bmesh_face_hidden(struct BMFace *f);
150
151 /* paint masks */
152 float paint_grid_paint_mask(const struct GridPaintMask *gpm, unsigned level,
153                             unsigned x, unsigned y);
154
155 /* stroke related */
156 void paint_calculate_rake_rotation(struct UnifiedPaintSettings *ups, struct Brush *brush, const float mouse_pos[2]);
157 void paint_update_brush_rake_rotation(struct UnifiedPaintSettings *ups, struct Brush *brush, float rotation);
158
159 void BKE_paint_stroke_get_average(struct Scene *scene, struct Object *ob, float stroke[3]);
160
161 /* Session data (mode-specific) */
162
163 typedef struct SculptSession {
164         /* Mesh data (not copied) can come either directly from a Mesh, or from a MultiresDM */
165         struct MultiresModifierData *multires; /* Special handling for multires meshes */
166         struct MVert *mvert;
167         struct MPoly *mpoly;
168         struct MLoop *mloop;
169         int totvert, totpoly;
170         struct KeyBlock *kb;
171         float *vmask;
172         
173         /* Mesh connectivity */
174         const struct MeshElemMap *pmap;
175
176         /* BMesh for dynamic topology sculpting */
177         struct BMesh *bm;
178         int cd_vert_node_offset;
179         int cd_face_node_offset;
180         bool bm_smooth_shading;
181         /* Undo/redo log for dynamic topology sculpting */
182         struct BMLog *bm_log;
183
184         /* PBVH acceleration structure */
185         struct PBVH *pbvh;
186         bool show_diffuse_color;
187
188         /* Painting on deformed mesh */
189         bool modifiers_active; /* object is deformed with some modifiers */
190         float (*orig_cos)[3]; /* coords of undeformed mesh */
191         float (*deform_cos)[3]; /* coords of deformed mesh but without stroke displacement */
192         float (*deform_imats)[3][3]; /* crazyspace deformation matrices */
193
194         /* Partial redraw */
195         bool partial_redraw;
196         
197         /* Used to cache the render of the active texture */
198         unsigned int texcache_side, *texcache, texcache_actual;
199         struct ImagePool *tex_pool;
200
201         /* Layer brush persistence between strokes */
202         float (*layer_co)[3]; /* Copy of the mesh vertices' locations */
203
204         struct SculptStroke *stroke;
205         struct StrokeCache *cache;
206 } SculptSession;
207
208 void BKE_sculptsession_free(struct Object *ob);
209 void BKE_sculptsession_free_deformMats(struct SculptSession *ss);
210 void BKE_sculptsession_bm_to_me(struct Object *ob, bool reorder);
211 void BKE_sculptsession_bm_to_me_for_render(struct Object *object);
212 void BKE_sculpt_update_mesh_elements(struct EvaluationContext *eval_ctx, struct Scene *scene, struct Sculpt *sd, struct Object *ob,
213                                      bool need_pmap, bool need_mask);
214 struct MultiresModifierData *BKE_sculpt_multires_active(struct Scene *scene, struct Object *ob);
215 int BKE_sculpt_mask_layers_ensure(struct Object *ob,
216                                   struct MultiresModifierData *mmd);
217
218 enum {
219         SCULPT_MASK_LAYER_CALC_VERT = (1 << 0),
220         SCULPT_MASK_LAYER_CALC_LOOP = (1 << 1)
221 };
222 #endif