Cleanup: unused functions
[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 enum eCurveMappingPreset;
31 struct Brush;
32 struct ImBuf;
33 struct ImagePool;
34 struct Main;
35 struct Scene;
36 struct UnifiedPaintSettings;
37 // enum eCurveMappingPreset;
38
39 #include "DNA_object_enums.h"
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 void BKE_brush_init(struct Brush *brush);
47 struct Brush *BKE_brush_add(struct Main *bmain, const char *name, const eObjectMode ob_mode);
48 struct Brush *BKE_brush_first_search(struct Main *bmain, const eObjectMode ob_mode);
49 void BKE_brush_copy_data(struct Main *bmain, struct Brush *brush_dst, const struct Brush *brush_src, const int flag);
50 struct Brush *BKE_brush_copy(struct Main *bmain, const struct Brush *brush);
51 void BKE_brush_make_local(struct Main *bmain, struct Brush *brush, const bool lib_local);
52 void BKE_brush_unlink(struct Main *bmain, struct Brush *brush);
53 void BKE_brush_free(struct Brush *brush);
54
55 void BKE_brush_sculpt_reset(struct Brush *brush);
56
57 /* image icon function */
58 struct ImBuf *get_brush_icon(struct Brush *brush);
59
60 /* jitter */
61 void BKE_brush_jitter_pos(
62         const struct Scene *scene, struct Brush *brush,
63         const float pos[2], float jitterpos[2]);
64 void BKE_brush_randomize_texture_coords(struct UnifiedPaintSettings *ups, bool mask);
65
66 /* brush curve */
67 void BKE_brush_curve_preset(struct Brush *b, enum eCurveMappingPreset preset);
68 float BKE_brush_curve_strength_clamped(struct Brush *br, float p, const float len);
69 float BKE_brush_curve_strength(const struct Brush *br, float p, const float len);
70
71 /* sampling */
72 float BKE_brush_sample_tex_3D(
73         const struct Scene *scene, const struct Brush *br, const float point[3],
74         float rgba[4], const int thread, struct ImagePool *pool);
75 float BKE_brush_sample_masktex(
76         const struct Scene *scene, struct Brush *br, const float point[2],
77         const int thread, struct ImagePool *pool);
78
79 /* texture */
80 unsigned int *BKE_brush_gen_texture_cache(struct Brush *br, int half_side, bool use_secondary);
81
82 /* radial control */
83 struct ImBuf *BKE_brush_gen_radial_control_imbuf(struct Brush *br, bool secondary);
84
85 /* unified strength size and color */
86
87 const float *BKE_brush_color_get(const struct Scene *scene, const struct Brush *brush);
88 const float *BKE_brush_secondary_color_get(const struct Scene *scene, const struct Brush *brush);
89 void BKE_brush_color_set(struct Scene *scene, struct Brush *brush, const float color[3]);
90
91 int  BKE_brush_size_get(const struct Scene *scene, const struct Brush *brush);
92 void BKE_brush_size_set(struct Scene *scene, struct Brush *brush, int value);
93
94 float BKE_brush_unprojected_radius_get(const struct Scene *scene, const struct Brush *brush);
95 void  BKE_brush_unprojected_radius_set(struct Scene *scene, struct Brush *brush, float value);
96
97 float BKE_brush_alpha_get(const struct Scene *scene, const struct Brush *brush);
98 void BKE_brush_alpha_set(struct Scene *scene, struct Brush *brush, float alpha);
99 float BKE_brush_weight_get(const struct Scene *scene, const struct Brush *brush);
100 void BKE_brush_weight_set(const struct Scene *scene, struct Brush *brush, float value);
101
102 bool BKE_brush_use_locked_size(const struct Scene *scene, const struct Brush *brush);
103 bool BKE_brush_use_alpha_pressure(const struct Scene *scene, const struct Brush *brush);
104 bool BKE_brush_use_size_pressure(const struct Scene *scene, const struct Brush *brush);
105
106 bool BKE_brush_sculpt_has_secondary_color(const struct Brush *brush);
107
108 /* scale unprojected radius to reflect a change in the brush's 2D size */
109 void BKE_brush_scale_unprojected_radius(
110         float *unprojected_radius,
111         int new_brush_size,
112         int old_brush_size);
113
114 /* scale brush size to reflect a change in the brush's unprojected radius */
115 void BKE_brush_scale_size(
116         int *r_brush_size,
117         float new_unprojected_radius,
118         float old_unprojected_radius);
119
120 /* debugging only */
121 void BKE_brush_debug_print_state(struct Brush *br);
122
123 #endif
124