doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_brush.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BKE_BRUSH_H__
18 #define __BKE_BRUSH_H__
19
20 /** \file
21  * \ingroup bke
22  *
23  * General operations for brushes.
24  */
25
26 enum eCurveMappingPreset;
27 struct Brush;
28 struct ImBuf;
29 struct ImagePool;
30 struct Main;
31 struct Material;
32 struct Paint;
33 struct Scene;
34 struct ToolSettings;
35 struct UnifiedPaintSettings;
36 struct bContext;
37
38 // enum eCurveMappingPreset;
39
40 #include "DNA_object_enums.h"
41
42 /* globals for brush execution */
43 void BKE_brush_system_init(void);
44 void BKE_brush_system_exit(void);
45
46 /* datablock functions */
47 void BKE_brush_init(struct Brush *brush);
48 struct Brush *BKE_brush_add(struct Main *bmain, const char *name, const eObjectMode ob_mode);
49 struct Brush *BKE_brush_add_gpencil(struct Main *bmain, struct ToolSettings *ts, const char *name);
50 void BKE_brush_init_gpencil_settings(struct Brush *brush);
51 struct Brush *BKE_brush_first_search(struct Main *bmain, const eObjectMode ob_mode);
52 void BKE_brush_copy_data(struct Main *bmain, struct Brush *brush_dst, const struct Brush *brush_src, const int flag);
53 struct Brush *BKE_brush_copy(struct Main *bmain, const struct Brush *brush);
54 void BKE_brush_make_local(struct Main *bmain, struct Brush *brush, const bool lib_local);
55 void BKE_brush_free(struct Brush *brush);
56
57 void BKE_brush_sculpt_reset(struct Brush *brush);
58 void BKE_brush_gpencil_presets(struct bContext *C);
59 void BKE_brush_update_material(struct Main *bmain, struct Material *ma, struct Brush *exclude_brush);
60
61 /* image icon function */
62 struct ImBuf *get_brush_icon(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, enum eCurveMappingPreset preset);
72 float BKE_brush_curve_strength_clamped(struct Brush *br, float p, const float len);
73 float BKE_brush_curve_strength(const struct Brush *br, float p, const float len);
74
75 /* sampling */
76 float BKE_brush_sample_tex_3d(
77         const struct Scene *scene, const 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 bool BKE_brush_use_locked_size(const struct Scene *scene, const struct Brush *brush);
107 bool BKE_brush_use_alpha_pressure(const struct Scene *scene, const struct Brush *brush);
108 bool BKE_brush_use_size_pressure(const struct Scene *scene, const struct Brush *brush);
109
110 bool BKE_brush_sculpt_has_secondary_color(const struct Brush *brush);
111
112 /* scale unprojected radius to reflect a change in the brush's 2D size */
113 void BKE_brush_scale_unprojected_radius(
114         float *unprojected_radius,
115         int new_brush_size,
116         int old_brush_size);
117
118 /* scale brush size to reflect a change in the brush's unprojected radius */
119 void BKE_brush_scale_size(
120         int *r_brush_size,
121         float new_unprojected_radius,
122         float old_unprojected_radius);
123
124 /* Accessors */
125 #define BKE_brush_tool_get(brush, p) \
126         (CHECK_TYPE_ANY(brush, struct Brush *, const struct Brush *), \
127          *(const char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset))
128 #define BKE_brush_tool_set(brush, p, tool) { \
129         CHECK_TYPE_ANY(brush, struct Brush *); \
130         *(char *)POINTER_OFFSET(brush, (p)->runtime.tool_offset) = tool; } ((void)0)
131
132 /* debugging only */
133 void BKE_brush_debug_print_state(struct Brush *br);
134
135 #endif