doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 ARegion;
33 struct bContext;
34 struct bglMats;
35 struct Brush;
36 struct ListBase;
37 struct Mesh;
38 struct Object;
39 struct PaintStroke;
40 struct PointerRNA;
41 struct Scene;
42 struct VPaint;
43 struct ViewContext;
44 struct wmEvent;
45 struct wmOperator;
46 struct wmOperatorType;
47
48 /* paint_stroke.c */
49 typedef int (*StrokeGetLocation)(struct bContext *C, struct PaintStroke *stroke, float location[3], float mouse[2]);
50 typedef int (*StrokeTestStart)(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
51 typedef void (*StrokeUpdateStep)(struct bContext *C, struct PaintStroke *stroke, struct PointerRNA *itemptr);
52 typedef void (*StrokeDone)(struct bContext *C, struct PaintStroke *stroke);
53
54 struct PaintStroke *paint_stroke_new(struct bContext *C,
55                                          StrokeGetLocation get_location, StrokeTestStart test_start,
56                                          StrokeUpdateStep update_step, StrokeDone done);
57 void paint_stroke_free(struct PaintStroke *stroke);
58
59 int paint_space_stroke_enabled(struct Brush *br);
60
61 int paint_stroke_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
62 int paint_stroke_exec(struct bContext *C, struct wmOperator *op);
63 struct ViewContext *paint_stroke_view_context(struct PaintStroke *stroke);
64 void *paint_stroke_mode_data(struct PaintStroke *stroke);
65 void paint_stroke_set_mode_data(struct PaintStroke *stroke, void *mode_data);
66 int paint_poll(struct bContext *C);
67 void paint_cursor_start(struct bContext *C, int (*poll)(struct bContext *C));
68
69 /* paint_vertex.c */
70 int weight_paint_poll(struct bContext *C);
71 int weight_paint_mode_poll(struct bContext *C);
72 int vertex_paint_poll(struct bContext *C);
73 int vertex_paint_mode_poll(struct bContext *C);
74
75 void vpaint_fill(struct Object *ob, unsigned int paintcol);
76 void wpaint_fill(struct VPaint *wp, struct Object *ob, float paintweight);
77
78 void PAINT_OT_weight_paint_toggle(struct wmOperatorType *ot);
79 void PAINT_OT_weight_paint_radial_control(struct wmOperatorType *ot);
80 void PAINT_OT_weight_paint(struct wmOperatorType *ot);
81 void PAINT_OT_weight_set(struct wmOperatorType *ot);
82 void PAINT_OT_weight_from_bones(struct wmOperatorType *ot);
83
84 void PAINT_OT_vertex_paint_radial_control(struct wmOperatorType *ot);
85 void PAINT_OT_vertex_paint_toggle(struct wmOperatorType *ot);
86 void PAINT_OT_vertex_paint(struct wmOperatorType *ot);
87
88 unsigned int vpaint_get_current_col(struct VPaint *vp);
89
90 /* paint_image.c */
91 int image_texture_paint_poll(struct bContext *C);
92
93 void PAINT_OT_image_paint(struct wmOperatorType *ot);
94 void PAINT_OT_image_paint_radial_control(struct wmOperatorType *ot);
95 void PAINT_OT_grab_clone(struct wmOperatorType *ot);
96 void PAINT_OT_sample_color(struct wmOperatorType *ot);
97 void PAINT_OT_clone_cursor_set(struct wmOperatorType *ot);
98 void PAINT_OT_texture_paint_toggle(struct wmOperatorType *ot);
99 void PAINT_OT_texture_paint_radial_control(struct wmOperatorType *ot);
100 void PAINT_OT_project_image(struct wmOperatorType *ot);
101 void PAINT_OT_image_from_view(struct wmOperatorType *ot);
102
103
104 /* paint_utils.c */
105 void projectf(struct bglMats *mats, const float v[3], float p[2]);
106 float paint_calc_object_space_radius(struct ViewContext *vc, float center[3], float pixel_radius);
107 float paint_get_tex_pixel(struct Brush* br, float u, float v);
108 int imapaint_pick_face(struct ViewContext *vc, struct Mesh *me, int *mval, unsigned int *index);
109 void imapaint_pick_uv(struct Scene *scene, struct Object *ob, unsigned int faceindex, int *xy, float *uv);
110
111 void paint_sample_color(struct Scene *scene, struct ARegion *ar, int x, int y);
112 void BRUSH_OT_curve_preset(struct wmOperatorType *ot);
113
114 void PAINT_OT_face_select_linked(struct wmOperatorType *ot);
115 void PAINT_OT_face_select_linked_pick(struct wmOperatorType *ot);
116 void PAINT_OT_face_select_all(struct wmOperatorType *ot);
117
118 int facemask_paint_poll(struct bContext *C);
119
120 /* stroke operator */
121 typedef enum BrushStrokeMode {
122         BRUSH_STROKE_NORMAL,
123         BRUSH_STROKE_INVERT,
124         BRUSH_STROKE_SMOOTH,
125 } BrushStrokeMode;
126
127 /* paint_undo.c */
128 typedef void (*UndoRestoreCb)(struct bContext *C, struct ListBase *lb);
129 typedef void (*UndoFreeCb)(struct ListBase *lb);
130
131 void undo_paint_push_begin(int type, const char *name, UndoRestoreCb restore, UndoFreeCb free);
132 struct ListBase *undo_paint_push_get_list(int type);
133 void undo_paint_push_count_alloc(int type, int size);
134 void undo_paint_push_end(int type);
135
136 #endif /* ED_PAINT_INTERN_H */
137