91f0525d4f36e69907164094e220eeeccafa555d
[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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * General operations for brushes.
27  */
28
29 #ifndef __BKE_BRUSH_H__
30 #define __BKE_BRUSH_H__
31
32 /** \file BKE_brush.h
33  *  \ingroup bke
34  */
35
36 struct ID;
37 struct Brush;
38 struct ImBuf;
39 struct ImagePool;
40 struct Scene;
41 struct wmOperator;
42 // enum CurveMappingPreset;
43
44 /* datablock functions */
45 struct Brush *BKE_brush_add(const char *name);
46 struct Brush *BKE_brush_copy(struct Brush *brush);
47 void BKE_brush_make_local(struct Brush *brush);
48 void BKE_brush_free(struct Brush *brush);
49
50 void BKE_brush_sculpt_reset(struct Brush *brush);
51
52 /* image icon function */
53 struct ImBuf *get_brush_icon(struct Brush *brush);
54
55 /* brush library operations used by different paint panels */
56 int BKE_brush_texture_set_nr(struct Brush *brush, int nr);
57 int BKE_brush_texture_delete(struct Brush *brush);
58 int BKE_brush_clone_image_set_nr(struct Brush *brush, int nr);
59 int BKE_brush_clone_image_delete(struct Brush *brush);
60
61 /* jitter */
62 void BKE_brush_jitter_pos(const struct Scene *scene, struct Brush *brush,
63                           const float pos[2], float jitterpos[2]);
64
65 /* brush curve */
66 void BKE_brush_curve_preset(struct Brush *b, /*enum CurveMappingPreset*/ int preset);
67 float BKE_brush_curve_strength_clamp(struct Brush *br, float p, const float len);
68 float BKE_brush_curve_strength(struct Brush *br, float p, const float len); /* used for sculpt */
69
70 /* sampling */
71 void BKE_brush_sample_tex(const struct Scene *scene, struct Brush *brush, const float sampleco[3], float rgba[4], const int thread, struct ImagePool *pool);
72 void BKE_brush_sample_tex_2D(const struct Scene *scene, struct Brush *brush, const float xy[2], float rgba[4], const int thread);
73 void BKE_brush_imbuf_new(const struct Scene *scene, struct Brush *brush, short flt, short texfalloff, int size,
74                          struct ImBuf **imbuf, int use_color_correction);
75
76 /* painting */
77 struct BrushPainter;
78 typedef struct BrushPainter BrushPainter;
79 typedef int (*BrushFunc)(void *user, struct ImBuf *ibuf, const float lastpos[2], const float pos[2]);
80
81 BrushPainter *BKE_brush_painter_new(struct Scene *scene, struct Brush *brush);
82 void BKE_brush_painter_require_imbuf(BrushPainter *painter, short flt,
83                                      short texonly, int size);
84 int BKE_brush_painter_paint(BrushPainter *painter, BrushFunc func, const float pos[2],
85                             double time, float pressure, void *user, int use_color_correction);
86 void BKE_brush_painter_break_stroke(BrushPainter *painter);
87 void BKE_brush_painter_free(BrushPainter *painter);
88
89 /* texture */
90 unsigned int *BKE_brush_gen_texture_cache(struct Brush *br, int half_side);
91
92 /* radial control */
93 struct ImBuf *BKE_brush_gen_radial_control_imbuf(struct Brush *br);
94
95 /* unified strength and size */
96
97 int  BKE_brush_size_get(const struct Scene *scene, struct Brush *brush);
98 void BKE_brush_size_set(struct Scene *scene, struct Brush *brush, int value);
99
100 float BKE_brush_unprojected_radius_get(const struct Scene *scene, struct Brush *brush);
101 void  BKE_brush_unprojected_radius_set(struct Scene *scene, struct Brush *brush, float value);
102
103 float BKE_brush_alpha_get(const struct Scene *scene, struct Brush *brush);
104 void BKE_brush_alpha_set(Scene *scene, struct Brush *brush, float alpha);
105 float BKE_brush_weight_get(const Scene *scene, struct Brush *brush);
106 void BKE_brush_weight_set(const Scene *scene, struct Brush *brush, float value);
107
108 int  BKE_brush_use_locked_size(const struct Scene *scene, struct Brush *brush);
109 int  BKE_brush_use_alpha_pressure(const struct Scene *scene, struct Brush *brush);
110 int  BKE_brush_use_size_pressure(const struct Scene *scene, 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(float *unprojected_radius,
114                                         int new_brush_size,
115                                         int old_brush_size);
116
117 /* scale brush size to reflect a change in the brush's unprojected radius */
118 void BKE_brush_scale_size(int *BKE_brush_size_get,
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