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