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