svn merge ^/trunk/blender -r43436:43443
[blender.git] / source / blender / blenkernel / BKE_brush.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * General operations for brushes.
27  */
28
29 #ifndef BKE_BRUSH_H
30 #define BKE_BRUSH_H
31
32 /** \file BKE_brush.h
33  *  \ingroup bke
34  */
35
36 struct ID;
37 struct Brush;
38 struct ImBuf;
39 struct Scene;
40 struct wmOperator;
41 // enum CurveMappingPreset;
42
43 /* datablock functions */
44 struct Brush *add_brush(const char *name);
45 struct Brush *copy_brush(struct Brush *brush);
46 void make_local_brush(struct Brush *brush);
47 void free_brush(struct Brush *brush);
48
49 void brush_reset_sculpt(struct Brush *brush);
50
51 /* image icon function */
52 struct ImBuf *get_brush_icon(struct Brush *brush);
53
54 /* brush library operations used by different paint panels */
55 int brush_delete(struct Brush **current_brush);
56 int brush_texture_set_nr(struct Brush *brush, int nr);
57 int brush_texture_delete(struct Brush *brush);
58 int brush_clone_image_set_nr(struct Brush *brush, int nr);
59 int brush_clone_image_delete(struct Brush *brush);
60
61 /* jitter */
62 void brush_jitter_pos(const struct Scene *scene, struct Brush *brush,
63                                           float *pos, float *jitterpos);
64
65 /* brush curve */
66 void brush_curve_preset(struct Brush *b, /*enum CurveMappingPreset*/int preset);
67 float brush_curve_strength_clamp(struct Brush *br, float p, const float len);
68 float brush_curve_strength(struct Brush *br, float p, const float len); /* used for sculpt */
69
70 /* sampling */
71 void brush_sample_tex(const struct Scene *scene, struct Brush *brush, const float xy[2], float rgba[4], const int thread);
72 void brush_imbuf_new(const struct Scene *scene, struct Brush *brush, short flt, short texfalloff, int size,
73         struct ImBuf **imbuf, int use_color_correction);
74
75 /* painting */
76 struct BrushPainter;
77 typedef struct BrushPainter BrushPainter;
78 typedef int (*BrushFunc)(void *user, struct ImBuf *ibuf, float *lastpos, float *pos);
79
80 BrushPainter *brush_painter_new(struct Scene *scene, struct Brush *brush);
81 void brush_painter_require_imbuf(BrushPainter *painter, short flt,
82         short texonly, int size);
83 int brush_painter_paint(BrushPainter *painter, BrushFunc func, float *pos,
84         double time, float pressure, void *user, int use_color_correction);
85 void brush_painter_break_stroke(BrushPainter *painter);
86 void brush_painter_free(BrushPainter *painter);
87
88 /* texture */
89 unsigned int *brush_gen_texture_cache(struct Brush *br, int half_side);
90
91 /* radial control */
92 struct ImBuf *brush_gen_radial_control_imbuf(struct Brush *br);
93
94 /* unified strength and size */
95
96 int  brush_size(const struct Scene *scene, struct Brush *brush);
97 void brush_set_size(struct Scene *scene, struct Brush *brush, int value);
98
99 float brush_unprojected_radius(const struct Scene *scene, struct Brush *brush);
100 void  brush_set_unprojected_radius(struct Scene *scene, struct Brush *brush, float value);
101
102 float brush_alpha(const struct Scene *scene, struct Brush *brush);
103
104 int  brush_use_locked_size(const struct Scene *scene, struct Brush *brush);
105 int  brush_use_alpha_pressure(const struct Scene *scene, struct Brush *brush);
106 int  brush_use_size_pressure(const struct Scene *scene, struct Brush *brush);
107
108 /* scale unprojected radius to reflect a change in the brush's 2D size */
109 void brush_scale_unprojected_radius(float *unprojected_radius,
110                                                                         int new_brush_size,
111                                                                         int old_brush_size);
112
113 /* scale brush size to reflect a change in the brush's unprojected radius */
114 void brush_scale_size(int *brush_size,
115                                           float new_unprojected_radius,
116                                           float old_unprojected_radius);
117
118 /* debugging only */
119 void brush_debug_print_state(struct Brush *br);
120
121 #endif
122