Sculpt: split generic part of image paint undo system into separate
[blender-staging.git] / source / blender / editors / sculpt_paint / paint_intern.h
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef ED_PAINT_INTERN_H
30 #define ED_PAINT_INTERN_H
31
32 struct bContext;
33 struct Scene;
34 struct Object;
35 struct Mesh;
36 struct PaintStroke;
37 struct PointerRNA;
38 struct ViewContext;
39 struct wmEvent;
40 struct wmOperator;
41 struct wmOperatorType;
42 struct ARegion;
43 struct VPaint;
44 struct ListBase;
45
46 /* paint_stroke.c */
47 typedef int (*StrokeGetLocation)(struct bContext *C, struct PaintStroke *stroke, float location[3], float mouse[2]);
48 typedef int (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
49 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
50 typedef void (*StrokeDone)(struct bContext *C, struct PaintStroke *stroke);
51
52 struct PaintStroke *paint_stroke_new(struct bContext *C,
53                                      StrokeGetLocation get_location, StrokeTestStart test_start,
54                                      StrokeUpdateStep update_step, StrokeDone done);
55 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
56 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
57 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
58 void *paint_stroke_mode_data(struct PaintStroke *stroke);
59 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
60 int paint_poll(struct bContext *C);
61 void paint_cursor_start(struct bContext *C, int (*poll)(struct bContext *C));
62
63 /* paint_vertex.c */
64 int weight_paint_poll(struct bContext *C);
65 int vertex_paint_poll(struct bContext *C);
66 int vertex_paint_mode_poll(struct bContext *C);
67
68 void vpaint_fill(struct Object *ob, unsigned int paintcol);
69 void wpaint_fill(struct VPaint *wp, struct Object *ob, float paintweight);
70
71 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
72 void PAINT_OT_weight_paint_radial_control(struct wmOperatorType *ot);
73 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
74 void PAINT_OT_weight_set(struct wmOperatorType *ot);
75
76 void PAINT_OT_vertex_paint_radial_control(struct wmOperatorType *ot);
77 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
78 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
79
80 unsigned int vpaint_get_current_col(struct VPaint *vp);
81
82 /* paint_image.c */
83 int image_texture_paint_poll(struct bContext *C);
84
85 void PAINT_OT_image_paint(struct wmOperatorType *ot);
86 void PAINT_OT_image_paint_radial_control(struct wmOperatorType *ot);
87 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
88 void PAINT_OT_sample_color(struct wmOperatorType *ot);
89 void PAINT_OT_clone_cursor_set(struct wmOperatorType *ot);
90 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
91 void PAINT_OT_texture_paint_radial_control(struct wmOperatorType *ot);
92
93 /* paint_utils.c */
94 int imapaint_pick_face(struct ViewContext *vc, struct Mesh *me, int *mval, unsigned int *index);
95 void imapaint_pick_uv(struct Scene *scene, struct Object *ob, struct Mesh *mesh, unsigned int faceindex, int *xy, float *uv);
96
97 void paint_sample_color(struct Scene *scene, struct ARegion *ar, int x, int y);
98 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
99
100 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
101 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
102 void PAINT_OT_face_deselect_all(struct wmOperatorType *ot);
103
104 int facemask_paint_poll(struct bContext *C);
105
106 /* paint_undo.c */
107 typedef void (*UndoRestoreCb)(struct bContext *C, struct ListBase *lb);
108 typedef void (*UndoFreeCb)(struct ListBase *lb);
109
110 void undo_paint_push_begin(int type, char *name, UndoRestoreCb restore, UndoFreeCb free);
111 struct ListBase *undo_paint_push_get_list(int type);
112 void undo_paint_push_count_alloc(int type, int size);
113 void undo_paint_push_end(int type);
114
115 #endif /* ED_PAINT_INTERN_H */
116