Factor out some generic parts of the sculpting PBVH redraw planes code.
[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 ED_PAINT_INTERN_H
33 #define ED_PAINT_INTERN_H
34
35 struct ARegion;
36 struct bContext;
37 struct bglMats;
38 struct Brush;
39 struct ListBase;
40 struct Mesh;
41 struct Object;
42 struct PaintStroke;
43 struct PointerRNA;
44 struct rcti;
45 struct Scene;
46 struct VPaint;
47 struct ViewContext;
48 struct wmEvent;
49 struct wmOperator;
50 struct wmOperatorType;
51
52 /* paint_stroke.c */
53 typedef int (*StrokeGetLocation)(struct bContext *C, struct PaintStroke *stroke, float location[3], float mouse[2]);
54 typedef int (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
55 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
56 typedef void (*StrokeDone)(struct bContext *C, struct PaintStroke *stroke);
57
58 struct PaintStroke *paint_stroke_new(struct bContext *C,
59                                          StrokeGetLocation get_location, StrokeTestStart test_start,
60                                          StrokeUpdateStep update_step, StrokeDone done, int event_type);
61 void paint_stroke_free(struct PaintStroke *stroke);
62
63 int paint_space_stroke_enabled(struct Brush *br);
64
65 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
66 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
67 int paint_stroke_cancel(struct bContext *C, struct wmOperator *op);
68 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
69 void *paint_stroke_mode_data(struct PaintStroke *stroke);
70 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
71 int paint_poll(struct bContext *C);
72 void paint_cursor_start(struct bContext *C, int (*poll)(struct bContext *C));
73
74 /* paint_vertex.c */
75 int weight_paint_poll(struct bContext *C);
76 int weight_paint_mode_poll(struct bContext *C);
77 int vertex_paint_poll(struct bContext *C);
78 int vertex_paint_mode_poll(struct bContext *C);
79
80 void vpaint_fill(struct Object *ob, unsigned int paintcol);
81 void wpaint_fill(struct VPaint *wp, struct Object *ob, float paintweight);
82
83 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
84 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
85 void PAINT_OT_weight_set(struct wmOperatorType *ot);
86 void PAINT_OT_weight_from_bones(struct wmOperatorType *ot);
87 void PAINT_OT_weight_sample(struct wmOperatorType *ot);
88 void PAINT_OT_weight_sample_group(struct wmOperatorType *ot);
89
90 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
91 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
92
93 unsigned int vpaint_get_current_col(struct VPaint *vp);
94
95 /* paint_image.c */
96 int image_texture_paint_poll(struct bContext *C);
97
98 void PAINT_OT_image_paint(struct wmOperatorType *ot);
99 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
100 void PAINT_OT_sample_color(struct wmOperatorType *ot);
101 void PAINT_OT_clone_cursor_set(struct wmOperatorType *ot);
102 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
103 void PAINT_OT_project_image(struct wmOperatorType *ot);
104 void PAINT_OT_image_from_view(struct wmOperatorType *ot);
105
106
107 /* paint_utils.c */
108
109 /* Convert the object-space axis-aligned bounding box (expressed as
110    its minimum and maximum corners) into a screen-space rectangle,
111    returns zero if the result is empty */
112 int paint_convert_bb_to_rect(struct rcti *rect,
113                                                          const float bb_min[3],
114                                                          const float bb_max[3],
115                                                          const struct ARegion *ar,
116                                                          struct RegionView3D *rv3d,
117                                                          struct Object *ob);
118
119 /* Get four planes in object-space that describe the projection of
120    screen_rect from screen into object-space (essentially converting a
121    2D screens-space bounding box into four 3D planes) */
122 void paint_calc_redraw_planes(float planes[4][4],
123                                                           const struct ARegion *ar,
124                                                           struct RegionView3D *rv3d,
125                                                           struct Object *ob,
126                                                           const struct rcti *screen_rect);
127
128 void projectf(struct bglMats *mats, const float v[3], float p[2]);
129 float paint_calc_object_space_radius(struct ViewContext *vc, float center[3], float pixel_radius);
130 float paint_get_tex_pixel(struct Brush* br, float u, float v);
131 int imapaint_pick_face(struct ViewContext *vc, struct Mesh *me, const int mval[2], unsigned int *index);
132 void imapaint_pick_uv(struct Scene *scene, struct Object *ob, unsigned int faceindex, const int xy[2], float uv[2]);
133
134 void paint_sample_color(struct Scene *scene, struct ARegion *ar, int x, int y);
135 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
136
137 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
138 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
139 void PAINT_OT_face_select_all(struct wmOperatorType *ot);
140 void PAINT_OT_face_select_inverse(struct wmOperatorType *ot);
141 void PAINT_OT_face_select_hide(struct wmOperatorType *ot);
142 void PAINT_OT_face_select_reveal(struct wmOperatorType *ot);
143
144 void PAINT_OT_vert_select_all(struct wmOperatorType *ot);
145 void PAINT_OT_vert_select_inverse(struct wmOperatorType *ot);
146 int vert_paint_poll(struct bContext *C);
147 int mask_paint_poll(struct bContext *C);
148
149 int facemask_paint_poll(struct bContext *C);
150
151 /* stroke operator */
152 typedef enum BrushStrokeMode {
153         BRUSH_STROKE_NORMAL,
154         BRUSH_STROKE_INVERT,
155         BRUSH_STROKE_SMOOTH,
156 } BrushStrokeMode;
157
158 /* paint_undo.c */
159 typedef void (*UndoRestoreCb)(struct bContext *C, struct ListBase *lb);
160 typedef void (*UndoFreeCb)(struct ListBase *lb);
161
162 void undo_paint_push_begin(int type, const char *name, UndoRestoreCb restore, UndoFreeCb free);
163 struct ListBase *undo_paint_push_get_list(int type);
164 void undo_paint_push_count_alloc(int type, int size);
165 void undo_paint_push_end(int type);
166
167 #endif /* ED_PAINT_INTERN_H */
168