d48753590bbd43056b96494f8284605fc3884ce6
[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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BKE_BRUSH_H__
22 #define __BKE_BRUSH_H__
23
24 /** \file BKE_brush.h
25  *  \ingroup bke
26  *
27  * General operations for brushes.
28  */
29
30 struct ID;
31 struct Brush;
32 struct ImBuf;
33 struct ImagePool;
34 struct Main;
35 struct rctf;
36 struct Scene;
37 struct wmOperator;
38 // enum CurveMappingPreset;
39
40
41 /* globals for brush execution */
42 void BKE_brush_system_init(void);
43 void BKE_brush_system_exit(void);
44
45 /* datablock functions */
46 struct Brush *BKE_brush_add(struct Main *bmain, const char *name);
47 struct Brush *BKE_brush_copy(struct Brush *brush);
48 void BKE_brush_make_local(struct Brush *brush);
49 void BKE_brush_free(struct Brush *brush);
50
51 void BKE_brush_sculpt_reset(struct Brush *brush);
52
53 /* image icon function */
54 struct ImBuf *get_brush_icon(struct Brush *brush);
55
56 /* brush library operations used by different paint panels */
57 int BKE_brush_texture_set_nr(struct Brush *brush, int nr);
58 int BKE_brush_texture_delete(struct Brush *brush);
59 int BKE_brush_clone_image_set_nr(struct Brush *brush, int nr);
60 int BKE_brush_clone_image_delete(struct Brush *brush);
61
62 /* jitter */
63 void BKE_brush_jitter_pos(const struct Scene *scene, struct Brush *brush,
64                           const float pos[2], float jitterpos[2]);
65 void BKE_brush_randomize_texture_coordinates(struct UnifiedPaintSettings *ups, bool mask);
66
67 /* brush curve */
68 void BKE_brush_curve_preset(struct Brush *b, int preset);
69 float BKE_brush_curve_strength_clamp(struct Brush *br, float p, const float len);
70 float BKE_brush_curve_strength(struct Brush *br, float p, const float len); /* used for sculpt */
71
72 /* sampling */
73 float BKE_brush_sample_tex_3D(const Scene *scene, struct Brush *br, const float point[3],
74                               float rgba[4], const int thread, struct ImagePool *pool);
75 float BKE_brush_sample_masktex(const Scene *scene, struct Brush *br, const float point[2],
76                                const int thread, struct ImagePool *pool);
77
78 /* texture */
79 unsigned int *BKE_brush_gen_texture_cache(struct Brush *br, int half_side, bool use_secondary);
80
81 /* radial control */
82 struct ImBuf *BKE_brush_gen_radial_control_imbuf(struct Brush *br, bool secondary);
83
84 /* unified strength size and color */
85
86 float *BKE_brush_color_get(const struct Scene *scene, struct Brush *brush);
87 float *BKE_brush_secondary_color_get(const struct Scene *scene, struct Brush *brush);
88 void BKE_brush_color_set(struct Scene *scene, struct Brush *brush, const float color[3]);
89
90 int  BKE_brush_size_get(const struct Scene *scene, struct Brush *brush);
91 void BKE_brush_size_set(struct Scene *scene, struct Brush *brush, int value);
92
93 float BKE_brush_unprojected_radius_get(const struct Scene *scene, struct Brush *brush);
94 void  BKE_brush_unprojected_radius_set(struct Scene *scene, struct Brush *brush, float value);
95
96 float BKE_brush_alpha_get(const struct Scene *scene, struct Brush *brush);
97 void BKE_brush_alpha_set(Scene *scene, struct Brush *brush, float alpha);
98 float BKE_brush_weight_get(const Scene *scene, struct Brush *brush);
99 void BKE_brush_weight_set(const Scene *scene, struct Brush *brush, float value);
100
101 int  BKE_brush_use_locked_size(const struct Scene *scene, struct Brush *brush);
102 int  BKE_brush_use_alpha_pressure(const struct Scene *scene, struct Brush *brush);
103 int  BKE_brush_use_size_pressure(const struct Scene *scene, struct Brush *brush);
104
105 /* scale unprojected radius to reflect a change in the brush's 2D size */
106 void BKE_brush_scale_unprojected_radius(float *unprojected_radius,
107                                         int new_brush_size,
108                                         int old_brush_size);
109
110 /* scale brush size to reflect a change in the brush's unprojected radius */
111 void BKE_brush_scale_size(int *BKE_brush_size_get,
112                           float new_unprojected_radius,
113                           float old_unprojected_radius);
114
115 /* debugging only */
116 void BKE_brush_debug_print_state(struct Brush *br);
117
118 #endif
119