Texpaint refactor complete!
[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 ListBase;
41 struct Mesh;
42 struct Object;
43 struct PaintStroke;
44 struct PointerRNA;
45 struct rcti;
46 struct Scene;
47 struct RegionView3D;
48 struct VPaint;
49 struct ViewContext;
50 struct wmEvent;
51 struct wmOperator;
52 struct wmOperatorType;
53 struct ImagePaintState;
54 enum PaintMode;
55
56 /* paint_stroke.c */
57 typedef int (*StrokeGetLocation)(struct bContext *C, float location[3], const float mouse[2]);
58 typedef int (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, const float mouse[2]);
59 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
60 typedef void (*StrokeDone)(const struct bContext *C, struct PaintStroke *stroke);
61
62 struct PaintStroke *paint_stroke_new(struct bContext *C,
63                                      StrokeGetLocation get_location, StrokeTestStart test_start,
64                                      StrokeUpdateStep update_step, StrokeDone done, int event_type);
65 void paint_stroke_data_free(struct wmOperator *op);
66
67 bool paint_space_stroke_enabled(struct Brush *br);
68 bool paint_supports_dynamic_size(struct Brush *br);
69 bool paint_supports_jitter(enum PaintMode mode);
70
71 struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf);
72 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
73 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
74 int paint_stroke_cancel(struct bContext *C, struct wmOperator *op);
75 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
76 void *paint_stroke_mode_data(struct PaintStroke *stroke);
77 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
78 int paint_poll(struct bContext *C);
79 void paint_cursor_start(struct bContext *C, int (*poll)(struct bContext *C));
80
81 /* paint_vertex.c */
82 int weight_paint_poll(struct bContext *C);
83 int weight_paint_mode_poll(struct bContext *C);
84 int vertex_paint_poll(struct bContext *C);
85 int vertex_paint_mode_poll(struct bContext *C);
86
87 void vpaint_fill(struct Object *ob, unsigned int paintcol);
88 void wpaint_fill(struct VPaint *wp, struct Object *ob, float paintweight);
89
90 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
91 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
92 void PAINT_OT_weight_set(struct wmOperatorType *ot);
93 void PAINT_OT_weight_from_bones(struct wmOperatorType *ot);
94 void PAINT_OT_weight_sample(struct wmOperatorType *ot);
95 void PAINT_OT_weight_sample_group(struct wmOperatorType *ot);
96
97 enum {
98         WPAINT_GRADIENT_TYPE_LINEAR,
99         WPAINT_GRADIENT_TYPE_RADIAL
100 };
101 void PAINT_OT_weight_gradient(struct wmOperatorType *ot);
102
103 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
104 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
105
106 unsigned int vpaint_get_current_col(struct VPaint *vp);
107
108 /* paint_image.c */
109 typedef struct ImagePaintPartialRedraw {
110         int x1, y1, x2, y2;  /* XXX, could use 'rcti' */
111         int enabled;
112 } ImagePaintPartialRedraw;
113
114 #define IMAPAINT_TILE_BITS          6
115 #define IMAPAINT_TILE_SIZE          (1 << IMAPAINT_TILE_BITS)
116 #define IMAPAINT_TILE_NUMBER(size)  (((size) + IMAPAINT_TILE_SIZE - 1) >> IMAPAINT_TILE_BITS)
117
118 #define IMAPAINT_CHAR_TO_FLOAT(c) ((c) / 255.0f)
119
120 int image_texture_paint_poll(struct bContext *C);
121 void *image_undo_push_tile(struct Image *ima, struct ImBuf *ibuf, struct ImBuf **tmpibuf, int x_tile, int y_tile);
122 void image_undo_restore(struct bContext *C, struct ListBase *lb);
123 void image_undo_free(struct ListBase *lb);
124 void imapaint_image_update(struct SpaceImage *sima, struct Image *image, struct ImBuf *ibuf, short texpaint);
125 struct ImagePaintPartialRedraw *get_imapaintpartial(void);
126 void set_imapaintpartial(struct ImagePaintPartialRedraw * ippr);
127 void imapaint_clear_partial_redraw(void);
128 void imapaint_dirty_region(struct Image *ima, struct ImBuf *ibuf, int x, int y, int w, int h);
129 void *paint_2d_new_stroke(struct bContext *, struct wmOperator *);
130 void paint_2d_redraw(const bContext *C, void *ps, int final);
131 void paint_2d_stroke_done(void *ps);
132 int paint_2d_stroke(void *ps, const int prev_mval[2], const int mval[2], int eraser);
133 void *paint_proj_new_stroke(struct bContext *C, struct Object *ob, int mouse[2]);
134 int paint_proj_stroke(void *ps, const int prevmval_i[2], const int mval_i[2]);
135 void paint_proj_stroke_done(void *ps);
136 void paint_brush_init_tex(struct Brush *brush);
137 void paint_brush_exit_tex(struct Brush *brush);
138
139 void PAINT_OT_image_paint(struct wmOperatorType *ot);
140 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
141 void PAINT_OT_sample_color(struct wmOperatorType *ot);
142 void PAINT_OT_clone_cursor_set(struct wmOperatorType *ot);
143 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
144 void PAINT_OT_project_image(struct wmOperatorType *ot);
145 void PAINT_OT_image_from_view(struct wmOperatorType *ot);
146
147 /* new texture painting */
148 void PAINT_OT_image_paint(struct wmOperatorType *ot);
149
150 /* uv sculpting */
151 int uv_sculpt_poll(struct bContext *C);
152
153 void SCULPT_OT_uv_sculpt_stroke(struct wmOperatorType *ot);
154
155 /* paint_utils.c */
156
157 /* Convert the object-space axis-aligned bounding box (expressed as
158  * its minimum and maximum corners) into a screen-space rectangle,
159  * returns zero if the result is empty */
160 int paint_convert_bb_to_rect(struct rcti *rect,
161                              const float bb_min[3],
162                              const float bb_max[3],
163                              const struct ARegion *ar,
164                              struct RegionView3D *rv3d,
165                              struct Object *ob);
166
167 /* Get four planes in object-space that describe the projection of
168  * screen_rect from screen into object-space (essentially converting a
169  * 2D screens-space bounding box into four 3D planes) */
170 void paint_calc_redraw_planes(float planes[4][4],
171                               const struct ARegion *ar,
172                               struct RegionView3D *rv3d,
173                               struct Object *ob,
174                               const struct rcti *screen_rect);
175
176 void projectf(struct bglMats *mats, const float v[3], float p[2]);
177 float paint_calc_object_space_radius(struct ViewContext *vc, const float center[3], float pixel_radius);
178 float paint_get_tex_pixel(struct Brush *br, float u, float v, struct ImagePool *pool);
179 int imapaint_pick_face(struct ViewContext *vc, const int mval[2], unsigned int *index, unsigned int totface);
180 void imapaint_pick_uv(struct Scene *scene, struct Object *ob, unsigned int faceindex, const int xy[2], float uv[2]);
181 void brush_drawcursor_texpaint_uvsculpt(struct bContext *C, int x, int y, void *customdata);
182
183 void paint_sample_color(const struct bContext *C, struct ARegion *ar, int x, int y);
184 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
185
186 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
187 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
188 void PAINT_OT_face_select_all(struct wmOperatorType *ot);
189 void PAINT_OT_face_select_hide(struct wmOperatorType *ot);
190 void PAINT_OT_face_select_reveal(struct wmOperatorType *ot);
191
192 void PAINT_OT_vert_select_all(struct wmOperatorType *ot);
193 int vert_paint_poll(struct bContext *C);
194 int mask_paint_poll(struct bContext *C);
195
196 int facemask_paint_poll(struct bContext *C);
197
198 /* stroke operator */
199 typedef enum BrushStrokeMode {
200         BRUSH_STROKE_NORMAL,
201         BRUSH_STROKE_INVERT,
202         BRUSH_STROKE_SMOOTH,
203 } BrushStrokeMode;
204
205 /* paint_undo.c */
206 typedef void (*UndoRestoreCb)(struct bContext *C, struct ListBase *lb);
207 typedef void (*UndoFreeCb)(struct ListBase *lb);
208
209 void undo_paint_push_begin(int type, const char *name, UndoRestoreCb restore, UndoFreeCb free);
210 struct ListBase *undo_paint_push_get_list(int type);
211 void undo_paint_push_count_alloc(int type, int size);
212 void undo_paint_push_end(int type);
213
214 /* paint_hide.c */
215
216 typedef enum {
217         PARTIALVIS_HIDE,
218         PARTIALVIS_SHOW
219 } PartialVisAction;
220
221 typedef enum {
222         PARTIALVIS_INSIDE,
223         PARTIALVIS_OUTSIDE,
224         PARTIALVIS_ALL,
225         PARTIALVIS_MASKED
226 } PartialVisArea;
227
228 void PAINT_OT_hide_show(struct wmOperatorType *ot);
229
230 /* paint_mask.c */
231
232 typedef enum {
233         PAINT_MASK_FLOOD_VALUE,
234         PAINT_MASK_INVERT
235 } PaintMaskFloodMode;
236
237 void PAINT_OT_mask_flood_fill(struct wmOperatorType *ot);
238
239 #endif /* __PAINT_INTERN_H__ */