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