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