Texture painting:
[blender.git] / source / blender / editors / sculpt_paint / paint_intern.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/sculpt_paint/paint_intern.h
28  *  \ingroup edsculpt
29  */
30
31
32 #ifndef __PAINT_INTERN_H__
33 #define __PAINT_INTERN_H__
34
35 struct ARegion;
36 struct bContext;
37 struct bglMats;
38 struct Brush;
39 struct ImagePool;
40 struct ColorSpace;
41 struct ColorManagedDisplay;
42 struct ListBase;
43 struct Material;
44 struct Mesh;
45 struct MTex;
46 struct Object;
47 struct PaintStroke;
48 struct Paint;
49 struct PointerRNA;
50 struct rcti;
51 struct Scene;
52 struct RegionView3D;
53 struct VPaint;
54 struct ViewContext;
55 struct wmEvent;
56 struct wmOperator;
57 struct wmOperatorType;
58 struct ImagePaintState;
59 struct wmWindowManager;
60 struct DMCoNo;
61 enum PaintMode;
62
63 /* paint_stroke.c */
64 typedef bool (*StrokeGetLocation)(struct bContext *C, float location[3], const float mouse[2]);
65 typedef bool (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, const float mouse[2]);
66 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
67 typedef void (*StrokeRedraw)(const struct bContext *C, struct PaintStroke *stroke, bool final);
68 typedef void (*StrokeDone)(const struct bContext *C, struct PaintStroke *stroke);
69
70 struct PaintStroke *paint_stroke_new(struct bContext *C, struct wmOperator *op,
71                                      StrokeGetLocation get_location, StrokeTestStart test_start,
72                                      StrokeUpdateStep update_step, StrokeRedraw redraw,
73                                      StrokeDone done, int event_type);
74 void paint_stroke_data_free(struct wmOperator *op);
75
76 bool paint_space_stroke_enabled(struct Brush *br, enum PaintMode mode);
77 bool paint_supports_dynamic_size(struct Brush *br, enum PaintMode mode);
78 bool paint_supports_dynamic_tex_coords(struct Brush *br, enum PaintMode mode);
79 bool paint_supports_smooth_stroke(struct Brush *br, enum PaintMode mode);
80 bool paint_supports_texture(enum PaintMode mode);
81 bool paint_supports_jitter(enum PaintMode mode);
82
83 struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf);
84 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
85 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
86 void paint_stroke_cancel(struct bContext *C, struct wmOperator *op);
87 bool paint_stroke_flipped(struct PaintStroke *stroke);
88 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
89 void *paint_stroke_mode_data(struct PaintStroke *stroke);
90 float paint_stroke_distance_get(struct PaintStroke *stroke);
91 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
92 int paint_poll(struct bContext *C);
93 void paint_cursor_start(struct bContext *C, int (*poll)(struct bContext *C));
94 void paint_cursor_start_explicit(struct Paint *p, struct wmWindowManager *wm, int (*poll)(struct bContext *C));
95 void paint_cursor_delete_textures(void);
96
97 /* paint_vertex.c */
98 int weight_paint_poll(struct bContext *C);
99 int weight_paint_mode_poll(struct bContext *C);
100 int vertex_paint_poll(struct bContext *C);
101 int vertex_paint_mode_poll(struct bContext *C);
102
103 bool ED_vpaint_fill(struct Object *ob, unsigned int paintcol);
104 bool ED_wpaint_fill(struct VPaint *wp, struct Object *ob, float paintweight);
105
106 bool ED_vpaint_smooth(struct Object *ob);
107
108 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
109 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
110 void PAINT_OT_weight_set(struct wmOperatorType *ot);
111 void PAINT_OT_weight_from_bones(struct wmOperatorType *ot);
112 void PAINT_OT_weight_sample(struct wmOperatorType *ot);
113 void PAINT_OT_weight_sample_group(struct wmOperatorType *ot);
114
115 enum {
116         WPAINT_GRADIENT_TYPE_LINEAR,
117         WPAINT_GRADIENT_TYPE_RADIAL
118 };
119 void PAINT_OT_weight_gradient(struct wmOperatorType *ot);
120
121 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
122 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
123
124 unsigned int vpaint_get_current_col(struct Scene *scene, struct VPaint *vp);
125
126
127 /* paint_vertex_proj.c */
128 struct VertProjHandle;
129 struct VertProjHandle *ED_vpaint_proj_handle_create(
130         struct Scene *scene, struct Object *ob,
131         struct DMCoNo **r_vcosnos);
132 void  ED_vpaint_proj_handle_update(
133         struct VertProjHandle *vp_handle,
134         /* runtime vars */
135         struct ARegion *ar, const float mval_fl[2]);
136 void  ED_vpaint_proj_handle_free(
137         struct VertProjHandle *vp_handle);
138
139
140 /* paint_image.c */
141 typedef struct ImagePaintPartialRedraw {
142         int x1, y1, x2, y2;  /* XXX, could use 'rcti' */
143         int enabled;
144 } ImagePaintPartialRedraw;
145
146 #define IMAPAINT_TILE_BITS          6
147 #define IMAPAINT_TILE_SIZE          (1 << IMAPAINT_TILE_BITS)
148 #define IMAPAINT_TILE_NUMBER(size)  (((size) + IMAPAINT_TILE_SIZE - 1) >> IMAPAINT_TILE_BITS)
149
150 int image_texture_paint_poll(struct bContext *C);
151 void *image_undo_find_tile(struct Image *ima, struct ImBuf *ibuf, int x_tile, int y_tile, unsigned short **mask, bool validate);
152 void *image_undo_push_tile(struct Image *ima, struct ImBuf *ibuf, struct ImBuf **tmpibuf, int x_tile, int y_tile,  unsigned short **, bool **valid, bool proj);
153 void image_undo_remove_masks(void);
154 void image_undo_init_locks(void);
155 void image_undo_end_locks(void);
156
157 void imapaint_image_update(struct SpaceImage *sima, struct Image *image, struct ImBuf *ibuf, short texpaint);
158 struct ImagePaintPartialRedraw *get_imapaintpartial(void);
159 void set_imapaintpartial(struct ImagePaintPartialRedraw *ippr);
160 void imapaint_region_tiles(struct ImBuf *ibuf, int x, int y, int w, int h, int *tx, int *ty, int *tw, int *th);
161 int get_imapaint_zoom(struct bContext *C, float *zoomx, float *zoomy);
162 void *paint_2d_new_stroke(struct bContext *, struct wmOperator *, int mode);
163 void paint_2d_redraw(const bContext *C, void *ps, bool final);
164 void paint_2d_stroke_done(void *ps);
165 void paint_2d_stroke(void *ps, const float prev_mval[2], const float mval[2], const bool eraser, float pressure, float distance, float size);
166 void paint_2d_bucket_fill(const struct bContext *C, const float color[3], struct Brush *br, const float mouse_init[2], void *ps);
167 void paint_2d_gradient_fill (const struct bContext *C, struct Brush *br, const float mouse_init[2], const float mouse_final[2], void *ps);
168 void *paint_proj_new_stroke(struct bContext *C, struct Object *ob, const float mouse[2], int mode);
169 void paint_proj_stroke(const struct bContext *C, void *ps, const float prevmval_i[2], const float mval_i[2], const bool eraser, float pressure, float distance, float size);
170 void paint_proj_redraw(const struct bContext *C, void *pps, bool final);
171 void paint_proj_stroke_done(void *ps);
172
173 void paint_brush_color_get(struct Scene *scene, struct Brush *br, bool color_correction, bool invert, float distance, float pressure, float color[3], struct ColorManagedDisplay *display);
174 bool paint_use_opacity_masking(struct Brush *brush);
175 void paint_brush_init_tex(struct Brush *brush);
176 void paint_brush_exit_tex(struct Brush *brush);
177
178 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
179 void PAINT_OT_sample_color(struct wmOperatorType *ot);
180 void PAINT_OT_brush_colors_flip(struct wmOperatorType *ot);
181 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
182 void PAINT_OT_project_image(struct wmOperatorType *ot);
183 void PAINT_OT_image_from_view(struct wmOperatorType *ot);
184 void PAINT_OT_add_texture_paint_slot(struct wmOperatorType *ot);
185 void PAINT_OT_delete_texture_paint_slot(struct wmOperatorType *ot);
186 void PAINT_OT_image_paint(struct wmOperatorType *ot);
187
188 /* uv sculpting */
189 int uv_sculpt_poll(struct bContext *C);
190
191 void SCULPT_OT_uv_sculpt_stroke(struct wmOperatorType *ot);
192
193 /* paint_utils.c */
194
195 /* Convert the object-space axis-aligned bounding box (expressed as
196  * its minimum and maximum corners) into a screen-space rectangle,
197  * returns zero if the result is empty */
198 bool paint_convert_bb_to_rect(struct rcti *rect,
199                               const float bb_min[3],
200                               const float bb_max[3],
201                               const struct ARegion *ar,
202                               struct RegionView3D *rv3d,
203                               struct Object *ob);
204
205 /* Get four planes in object-space that describe the projection of
206  * screen_rect from screen into object-space (essentially converting a
207  * 2D screens-space bounding box into four 3D planes) */
208 void paint_calc_redraw_planes(float planes[4][4],
209                               const struct ARegion *ar,
210                               struct RegionView3D *rv3d,
211                               struct Object *ob,
212                               const struct rcti *screen_rect);
213
214 float paint_calc_object_space_radius(struct ViewContext *vc, const float center[3], float pixel_radius);
215 float paint_get_tex_pixel(struct MTex *mtex, float u, float v, struct ImagePool *pool, int thread);
216 void paint_get_tex_pixel_col(struct MTex *mtex, float u, float v, float rgba[4], struct ImagePool *pool, int thread, bool convert, struct ColorSpace *colorspace);
217
218 void paint_sample_color(bContext *C, struct ARegion *ar, int x, int y, bool texpaint_proj, bool palette);
219
220 void paint_stroke_operator_properties(struct wmOperatorType *ot);
221
222 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
223
224 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
225 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
226 void PAINT_OT_face_select_all(struct wmOperatorType *ot);
227 void PAINT_OT_face_select_hide(struct wmOperatorType *ot);
228 void PAINT_OT_face_select_reveal(struct wmOperatorType *ot);
229
230 void PAINT_OT_vert_select_all(struct wmOperatorType *ot);
231 void PAINT_OT_vert_select_ungrouped(struct wmOperatorType *ot);
232
233 int vert_paint_poll(struct bContext *C);
234 int mask_paint_poll(struct bContext *C);
235 int paint_curve_poll(struct bContext *C);
236
237 int facemask_paint_poll(struct bContext *C);
238 void flip_v3_v3(float out[3], const float in[3], const char symm);
239
240 /* stroke operator */
241 typedef enum BrushStrokeMode {
242         BRUSH_STROKE_NORMAL,
243         BRUSH_STROKE_INVERT,
244         BRUSH_STROKE_SMOOTH
245 } BrushStrokeMode;
246
247 /* paint_undo.c */
248 struct ListBase *undo_paint_push_get_list(int type);
249 void undo_paint_push_count_alloc(int type, int size);
250
251 /* paint_hide.c */
252
253 typedef enum {
254         PARTIALVIS_HIDE,
255         PARTIALVIS_SHOW
256 } PartialVisAction;
257
258 typedef enum {
259         PARTIALVIS_INSIDE,
260         PARTIALVIS_OUTSIDE,
261         PARTIALVIS_ALL,
262         PARTIALVIS_MASKED
263 } PartialVisArea;
264
265 void PAINT_OT_hide_show(struct wmOperatorType *ot);
266
267 /* paint_mask.c */
268
269 typedef enum {
270         PAINT_MASK_FLOOD_VALUE,
271         PAINT_MASK_FLOOD_VALUE_INVERSE,
272         PAINT_MASK_INVERT
273 } PaintMaskFloodMode;
274
275 void PAINT_OT_mask_flood_fill(struct wmOperatorType *ot);
276 void PAINT_OT_mask_lasso_gesture(struct wmOperatorType *ot);
277
278 /* paint_curve.c */
279 void PAINTCURVE_OT_new(struct wmOperatorType *ot);
280 void PAINTCURVE_OT_add_point(struct wmOperatorType *ot);
281 void PAINTCURVE_OT_delete_point(struct wmOperatorType *ot);
282 void PAINTCURVE_OT_select(struct wmOperatorType *ot);
283 void PAINTCURVE_OT_slide(struct wmOperatorType *ot);
284 void PAINTCURVE_OT_draw(struct wmOperatorType *ot);
285 void PAINTCURVE_OT_cursor(struct wmOperatorType *ot);
286
287 /* image painting blur kernel */
288 typedef struct {
289         float *wdata; /* actual kernel */
290         int side; /* kernel side */
291         int side_squared; /* data side */
292         int pixel_len; /* pixels around center that kernel is wide */
293 } BlurKernel;
294
295 enum BlurKernelType;
296 /* can be extended to other blur kernels later */
297 BlurKernel *paint_new_blur_kernel(struct Brush *br, bool proj);
298 void paint_delete_blur_kernel(BlurKernel *);
299
300 /* paint curve defines */
301 #define PAINT_CURVE_NUM_SEGMENTS 40
302
303 #endif /* __PAINT_INTERN_H__ */