Merge branch 'master' into blender2.8
[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 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 PaintCurve;
47 struct PointerRNA;
48 struct rcti;
49 struct Scene;
50 struct RegionView3D;
51 struct VPaint;
52 struct ViewContext;
53 struct wmEvent;
54 struct wmOperator;
55 struct wmOperatorType;
56 struct wmWindowManager;
57 struct DMCoNo;
58 struct UndoStep;
59 enum ePaintMode;
60
61 /* paint_stroke.c */
62 typedef bool (*StrokeGetLocation)(struct bContext *C, float location[3], const float mouse[2]);
63 typedef bool (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, const float mouse[2]);
64 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
65 typedef void (*StrokeRedraw)(const struct bContext *C, struct PaintStroke *stroke, bool final);
66 typedef void (*StrokeDone)(const struct bContext *C, struct PaintStroke *stroke);
67
68 struct PaintStroke *paint_stroke_new(
69         struct bContext *C, struct wmOperator *op,
70         StrokeGetLocation get_location, StrokeTestStart test_start,
71         StrokeUpdateStep update_step, StrokeRedraw redraw,
72         StrokeDone done, int event_type);
73 void paint_stroke_data_free(struct wmOperator *op);
74
75 bool paint_space_stroke_enabled(struct Brush *br, enum ePaintMode mode);
76 bool paint_supports_dynamic_size(struct Brush *br, enum ePaintMode mode);
77 bool paint_supports_dynamic_tex_coords(struct Brush *br, enum ePaintMode mode);
78 bool paint_supports_smooth_stroke(struct Brush *br, enum ePaintMode mode);
79 bool paint_supports_texture(enum ePaintMode mode);
80 bool paint_supports_jitter(enum ePaintMode mode);
81
82 struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf);
83 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
84 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
85 void paint_stroke_cancel(struct bContext *C, struct wmOperator *op);
86 bool paint_stroke_flipped(struct PaintStroke *stroke);
87 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
88 void *paint_stroke_mode_data(struct PaintStroke *stroke);
89 float paint_stroke_distance_get(struct PaintStroke *stroke);
90 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
91 bool paint_poll(struct bContext *C);
92 void paint_cursor_start(struct bContext *C, bool (*poll)(struct bContext *C));
93 void paint_cursor_start_explicit(struct Paint *p, struct wmWindowManager *wm, bool (*poll)(struct bContext *C));
94 void paint_cursor_delete_textures(void);
95
96 /* paint_vertex.c */
97 bool weight_paint_poll(struct bContext *C);
98 bool weight_paint_poll_ignore_tool(bContext *C);
99 bool weight_paint_mode_poll(struct bContext *C);
100 bool vertex_paint_poll(struct bContext *C);
101 bool vertex_paint_poll_ignore_tool(struct bContext *C);
102 bool vertex_paint_mode_poll(struct bContext *C);
103
104 typedef void (*VPaintTransform_Callback)(const float col[3], const void *user_data, float r_col[3]);
105
106 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
107 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
108 void PAINT_OT_weight_set(struct wmOperatorType *ot);
109
110 enum {
111         WPAINT_GRADIENT_TYPE_LINEAR,
112         WPAINT_GRADIENT_TYPE_RADIAL
113 };
114 void PAINT_OT_weight_gradient(struct wmOperatorType *ot);
115
116 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
117 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
118
119 unsigned int vpaint_get_current_col(struct Scene *scene, struct VPaint *vp);
120
121 /* paint_vertex_color_utils.c */
122 unsigned int ED_vpaint_blend_tool(
123         const int tool, const uint col,
124         const uint paintcol, const int alpha_i);
125 bool ED_vpaint_color_transform(
126         struct Object *ob, VPaintTransform_Callback vpaint_tx_fn, const void *user_data);
127
128 /* paint_vertex_weight_utils.c */
129 float ED_wpaint_blend_tool(
130         const int tool,
131         const float weight,
132         const float paintval, const float alpha);
133 /* Utility for tools to ensure vertex groups exist before they begin. */
134 enum eWPaintFlag {
135         WPAINT_ENSURE_MIRROR = (1 << 0),
136 };
137 struct WPaintVGroupIndex {
138         int active;
139         int mirror;
140 };
141 bool ED_wpaint_ensure_data(
142         struct bContext *C, struct ReportList *reports,
143         enum eWPaintFlag flag, struct WPaintVGroupIndex *vgroup_index);
144 int ED_wpaint_mirror_vgroup_ensure(struct Object *ob, const int vgroup_active);
145
146 /* paint_vertex_color_ops.c */
147 void PAINT_OT_vertex_color_set(struct wmOperatorType *ot);
148 void PAINT_OT_vertex_color_from_weight(struct wmOperatorType *ot);
149 void PAINT_OT_vertex_color_smooth(struct wmOperatorType *ot);
150 void PAINT_OT_vertex_color_brightness_contrast(struct wmOperatorType *ot);
151 void PAINT_OT_vertex_color_hsv(struct wmOperatorType *ot);
152 void PAINT_OT_vertex_color_invert(struct wmOperatorType *ot);
153 void PAINT_OT_vertex_color_levels(struct wmOperatorType *ot);
154
155 /* paint_vertex_weight_ops.c */
156 void PAINT_OT_weight_from_bones(struct wmOperatorType *ot);
157 void PAINT_OT_weight_sample(struct wmOperatorType *ot);
158 void PAINT_OT_weight_sample_group(struct wmOperatorType *ot);
159
160 /* paint_vertex_proj.c */
161 struct VertProjHandle;
162 struct VertProjHandle *ED_vpaint_proj_handle_create(
163         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob,
164         struct DMCoNo **r_vcosnos);
165 void  ED_vpaint_proj_handle_update(
166         struct Depsgraph *depsgraph, struct VertProjHandle *vp_handle,
167         /* runtime vars */
168         struct ARegion *ar, const float mval_fl[2]);
169 void  ED_vpaint_proj_handle_free(
170         struct VertProjHandle *vp_handle);
171
172
173 /* paint_image.c */
174 typedef struct ImagePaintPartialRedraw {
175         int x1, y1, x2, y2;  /* XXX, could use 'rcti' */
176         int enabled;
177 } ImagePaintPartialRedraw;
178
179 #define IMAPAINT_TILE_BITS          6
180 #define IMAPAINT_TILE_SIZE          (1 << IMAPAINT_TILE_BITS)
181 #define IMAPAINT_TILE_NUMBER(size)  (((size) + IMAPAINT_TILE_SIZE - 1) >> IMAPAINT_TILE_BITS)
182
183 bool image_texture_paint_poll(struct bContext *C);
184 void imapaint_image_update(struct SpaceImage *sima, struct Image *image, struct ImBuf *ibuf, short texpaint);
185 struct ImagePaintPartialRedraw *get_imapaintpartial(void);
186 void set_imapaintpartial(struct ImagePaintPartialRedraw *ippr);
187 void imapaint_region_tiles(struct ImBuf *ibuf, int x, int y, int w, int h, int *tx, int *ty, int *tw, int *th);
188 int get_imapaint_zoom(struct bContext *C, float *zoomx, float *zoomy);
189 void *paint_2d_new_stroke(struct bContext *, struct wmOperator *, int mode);
190 void paint_2d_redraw(const struct bContext *C, void *ps, bool final);
191 void paint_2d_stroke_done(void *ps);
192 void paint_2d_stroke(
193         void *ps, const float prev_mval[2], const float mval[2],
194         const bool eraser, float pressure, float distance, float size);
195 void paint_2d_bucket_fill(
196         const struct bContext *C, const float color[3], struct Brush *br, const float mouse_init[2], void *ps);
197 void paint_2d_gradient_fill(
198         const struct bContext *C, struct Brush *br, const float mouse_init[2], const float mouse_final[2], void *ps);
199 void *paint_proj_new_stroke(
200         struct bContext *C, struct Object *ob, const float mouse[2], int mode);
201 void paint_proj_stroke(
202         const struct bContext *C, void *ps, const float prevmval_i[2], const float mval_i[2],
203         const bool eraser, float pressure, float distance, float size);
204 void paint_proj_redraw(const struct bContext *C, void *pps, bool final);
205 void paint_proj_stroke_done(void *ps);
206
207 void paint_brush_color_get(
208         struct Scene *scene, struct Brush *br,
209         bool color_correction, bool invert, float distance, float pressure, float color[3],
210         struct ColorManagedDisplay *display);
211 bool paint_use_opacity_masking(struct Brush *brush);
212 void paint_brush_init_tex(struct Brush *brush);
213 void paint_brush_exit_tex(struct Brush *brush);
214
215 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
216 void PAINT_OT_sample_color(struct wmOperatorType *ot);
217 void PAINT_OT_brush_colors_flip(struct wmOperatorType *ot);
218 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
219 void PAINT_OT_project_image(struct wmOperatorType *ot);
220 void PAINT_OT_image_from_view(struct wmOperatorType *ot);
221 void PAINT_OT_add_texture_paint_slot(struct wmOperatorType *ot);
222 void PAINT_OT_image_paint(struct wmOperatorType *ot);
223 void PAINT_OT_add_simple_uvs(struct wmOperatorType *ot);
224
225 /* paint_image_undo.c */
226 void *image_undo_find_tile(
227         ListBase *undo_tiles,
228         struct Image *ima, struct ImBuf *ibuf, int x_tile, int y_tile,
229         unsigned short **mask, bool validate);
230 void *image_undo_push_tile(
231         ListBase *undo_tiles,
232         struct Image *ima, struct ImBuf *ibuf, struct ImBuf **tmpibuf, int x_tile, int y_tile,
233         unsigned short **, bool **valid, bool proj, bool find_prev);
234 void image_undo_remove_masks(void);
235 void image_undo_init_locks(void);
236 void image_undo_end_locks(void);
237
238 struct ListBase *ED_image_undosys_step_get_tiles(struct UndoStep *us_p);
239 struct ListBase *ED_image_undo_get_tiles(void);
240
241 /* sculpt_uv.c */
242 bool uv_sculpt_poll(struct bContext *C);
243 bool uv_sculpt_keymap_poll(struct bContext *C);
244
245 void SCULPT_OT_uv_sculpt_stroke(struct wmOperatorType *ot);
246
247 /* paint_utils.c */
248
249 /* Convert the object-space axis-aligned bounding box (expressed as
250  * its minimum and maximum corners) into a screen-space rectangle,
251  * returns zero if the result is empty */
252 bool paint_convert_bb_to_rect(
253         struct rcti *rect,
254         const float bb_min[3],
255         const float bb_max[3],
256         const struct ARegion *ar,
257         struct RegionView3D *rv3d,
258         struct Object *ob);
259
260 /* Get four planes in object-space that describe the projection of
261  * screen_rect from screen into object-space (essentially converting a
262  * 2D screens-space bounding box into four 3D planes) */
263 void paint_calc_redraw_planes(
264         float planes[4][4],
265         const struct ARegion *ar,
266         struct Object *ob,
267         const struct rcti *screen_rect);
268
269 float paint_calc_object_space_radius(struct ViewContext *vc, const float center[3], float pixel_radius);
270 float paint_get_tex_pixel(const struct MTex *mtex, float u, float v, struct ImagePool *pool, int thread);
271 void paint_get_tex_pixel_col(
272         const struct MTex *mtex, float u, float v, float rgba[4],
273         struct ImagePool *pool, int thread, bool convert, struct ColorSpace *colorspace);
274
275 void paint_sample_color(struct bContext *C, struct ARegion *ar, int x, int y, bool texpaint_proj, bool palette);
276
277 void paint_stroke_operator_properties(struct wmOperatorType *ot);
278
279 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
280
281 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
282 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
283 void PAINT_OT_face_select_all(struct wmOperatorType *ot);
284 void PAINT_OT_face_select_hide(struct wmOperatorType *ot);
285 void PAINT_OT_face_select_reveal(struct wmOperatorType *ot);
286
287 void PAINT_OT_vert_select_all(struct wmOperatorType *ot);
288 void PAINT_OT_vert_select_ungrouped(struct wmOperatorType *ot);
289
290 bool vert_paint_poll(struct bContext *C);
291 bool mask_paint_poll(struct bContext *C);
292 bool paint_curve_poll(struct bContext *C);
293
294 bool facemask_paint_poll(struct bContext *C);
295 void flip_v3_v3(float out[3], const float in[3], const char symm);
296 void flip_qt_qt(float out[3], const float in[3], const char symm);
297
298 /* stroke operator */
299 typedef enum BrushStrokeMode {
300         BRUSH_STROKE_NORMAL,
301         BRUSH_STROKE_INVERT,
302         BRUSH_STROKE_SMOOTH
303 } BrushStrokeMode;
304
305 /* paint_ops.c */
306 typedef enum {
307         RC_COLOR    = 1,
308         RC_ROTATION = 2,
309         RC_ZOOM     = 4,
310         RC_WEIGHT   = 8,
311         RC_SECONDARY_ROTATION = 16,
312         RC_COLOR_OVERRIDE = 32,
313 } RCFlags;
314
315 void set_brush_rc_props(
316         struct PointerRNA *ptr, const char *paint, const char *prop, const char *secondary_prop,
317         RCFlags flags);
318
319 /* paint_hide.c */
320
321 typedef enum {
322         PARTIALVIS_HIDE,
323         PARTIALVIS_SHOW
324 } PartialVisAction;
325
326 typedef enum {
327         PARTIALVIS_INSIDE,
328         PARTIALVIS_OUTSIDE,
329         PARTIALVIS_ALL,
330         PARTIALVIS_MASKED
331 } PartialVisArea;
332
333 void PAINT_OT_hide_show(struct wmOperatorType *ot);
334
335 /* paint_mask.c */
336
337 typedef enum {
338         PAINT_MASK_FLOOD_VALUE,
339         PAINT_MASK_FLOOD_VALUE_INVERSE,
340         PAINT_MASK_INVERT
341 } PaintMaskFloodMode;
342
343 void PAINT_OT_mask_flood_fill(struct wmOperatorType *ot);
344 void PAINT_OT_mask_lasso_gesture(struct wmOperatorType *ot);
345
346 /* paint_curve.c */
347 void PAINTCURVE_OT_new(struct wmOperatorType *ot);
348 void PAINTCURVE_OT_add_point(struct wmOperatorType *ot);
349 void PAINTCURVE_OT_delete_point(struct wmOperatorType *ot);
350 void PAINTCURVE_OT_select(struct wmOperatorType *ot);
351 void PAINTCURVE_OT_slide(struct wmOperatorType *ot);
352 void PAINTCURVE_OT_draw(struct wmOperatorType *ot);
353 void PAINTCURVE_OT_cursor(struct wmOperatorType *ot);
354
355 /* paint_curve_undo.c */
356 void ED_paintcurve_undo_push(struct bContext *C, struct wmOperator *op, struct PaintCurve *pc);
357
358 /* image painting blur kernel */
359 typedef struct {
360         float *wdata; /* actual kernel */
361         int side; /* kernel side */
362         int side_squared; /* data side */
363         int pixel_len; /* pixels around center that kernel is wide */
364 } BlurKernel;
365
366 enum eBlurKernelType;
367 /* can be extended to other blur kernels later */
368 BlurKernel *paint_new_blur_kernel(struct Brush *br, bool proj);
369 void paint_delete_blur_kernel(BlurKernel *);
370
371 /* paint curve defines */
372 #define PAINT_CURVE_NUM_SEGMENTS 40
373
374 #endif /* __PAINT_INTERN_H__ */