Cleanup: multistatement-macros warning
[blender.git] / source / blender / makesdna / DNA_brush_types.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) 2005 Blender Foundation.
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  */
27
28 /** \file DNA_brush_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_BRUSH_TYPES_H__
33 #define __DNA_BRUSH_TYPES_H__
34
35
36 #include "DNA_ID.h"
37 #include "DNA_texture_types.h" /* for MTex */
38 #include "DNA_curve_types.h"
39
40 //#ifndef MAX_MTEX // XXX Not used?
41 //#define MAX_MTEX      18
42 //#endif
43
44 struct CurveMapping;
45 struct MTex;
46 struct Image;
47
48 typedef struct BrushClone {
49         struct Image *image;    /* image for clone tool */
50         float offset[2];        /* offset of clone image from canvas */
51         float alpha, pad;       /* transparency for drawing of clone image */
52 } BrushClone;
53
54 typedef struct Brush {
55         ID id;
56
57         struct BrushClone clone;
58         struct CurveMapping *curve; /* falloff curve */
59         struct MTex mtex;
60         struct MTex mask_mtex;
61
62         struct Brush *toggle_brush;
63
64         struct ImBuf *icon_imbuf;
65         PreviewImage *preview;
66         struct ColorBand *gradient;     /* color gradient */
67         struct PaintCurve *paint_curve;
68
69         char icon_filepath[1024]; /* 1024 = FILE_MAX */
70
71         float normal_weight;
72         float rake_factor;  /* rake actual data (not texture), used for sculpt */
73
74         short blend;        /* blend mode */
75         short ob_mode;      /* & with ob->mode to see if the brush is compatible, use for display only. */
76         float weight;       /* brush weight */
77         int size;           /* brush diameter */
78         int flag;           /* general purpose flag */
79         int mask_pressure;  /* pressure influence for mask */
80         float jitter;       /* jitter the position of the brush */
81         int jitter_absolute;    /* absolute jitter in pixels */
82         int overlay_flags;
83         int spacing;        /* spacing of paint operations */
84         int smooth_stroke_radius;   /* turning radius (in pixels) for smooth stroke */
85         float smooth_stroke_factor; /* higher values limit fast changes in the stroke direction */
86         float rate;         /* paint operations / second (airbrush) */
87
88         float rgb[3];           /* color */
89         float alpha;            /* opacity */
90
91         float secondary_rgb[3]; /* background color */
92
93         int sculpt_plane;       /* the direction of movement for sculpt vertices */
94
95         float plane_offset;     /* offset for plane brushes (clay, flatten, fill, scrape) */
96
97         int gradient_spacing;
98         int gradient_stroke_mode; /* source for stroke color gradient application */
99         int gradient_fill_mode;   /* source for fill tool color gradient application */
100
101         char sculpt_tool;       /* active sculpt tool */
102         char vertexpaint_tool;  /* active vertex/weight paint blend mode (poorly named) */
103         char imagepaint_tool;   /* active image paint tool */
104         char mask_tool;         /* enum BrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK */
105
106         float autosmooth_factor;
107
108         float crease_pinch_factor;
109
110         float plane_trim;
111         float height;           /* affectable height of brush (layer height for layer tool, i.e.) */
112
113         float texture_sample_bias;
114
115         /* overlay */
116         int texture_overlay_alpha;
117         int mask_overlay_alpha;
118         int cursor_overlay_alpha;
119
120         float unprojected_radius;
121
122         /* soften/sharpen */
123         float sharp_threshold;
124         int blur_kernel_radius;
125         int blur_mode;
126
127         /* fill tool */
128         float fill_threshold;
129
130         float add_col[3];
131         float sub_col[3];
132
133         float stencil_pos[2];
134         float stencil_dimension[2];
135
136         float mask_stencil_pos[2];
137         float mask_stencil_dimension[2];
138 } Brush;
139
140 typedef struct PaletteColor {
141         struct PaletteColor *next, *prev;
142         /* two values, one to store rgb, other to store values for sculpt/weight */
143         float rgb[3];
144         float value;
145 } PaletteColor;
146
147 typedef struct Palette {
148         ID id;
149
150         /* pointer to individual colours */
151         ListBase colors;
152
153         int active_color;
154         int pad;
155 } Palette;
156
157 typedef struct PaintCurvePoint {
158         BezTriple bez; /* bezier handle */
159         float pressure; /* pressure on that point */
160 } PaintCurvePoint;
161
162 typedef struct PaintCurve {
163         ID id;
164         PaintCurvePoint *points; /* points of curve */
165         int tot_points;
166         int add_index; /* index where next point will be added */
167 } PaintCurve;
168
169 /* Brush.gradient_source */
170 typedef enum BrushGradientSourceStroke {
171         BRUSH_GRADIENT_PRESSURE = 0, /* gradient from pressure */
172         BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
173         BRUSH_GRADIENT_SPACING_CLAMP = 2 /* gradient from spacing */
174 } BrushGradientSourceStroke;
175
176 typedef enum BrushGradientSourceFill {
177         BRUSH_GRADIENT_LINEAR = 0, /* gradient from pressure */
178         BRUSH_GRADIENT_RADIAL = 1 /* gradient from spacing */
179 } BrushGradientSourceFill;
180
181 /* Brush.flag */
182 typedef enum BrushFlags {
183         BRUSH_AIRBRUSH = (1 << 0),
184 //      BRUSH_TORUS = (1 << 1), deprecated, use paint->symmetry_flags & PAINT_TILE_*
185         BRUSH_ALPHA_PRESSURE = (1 << 2),
186         BRUSH_SIZE_PRESSURE = (1 << 3),
187         BRUSH_JITTER_PRESSURE = (1 << 4),
188         BRUSH_SPACING_PRESSURE = (1 << 5),
189         BRUSH_UNUSED = (1 << 6),
190 //      BRUSH_RAKE = (1 << 7), deprecated, use brush_angle_mode
191         BRUSH_ANCHORED = (1 << 8),
192         BRUSH_DIR_IN = (1 << 9),
193         BRUSH_SPACE = (1 << 10),
194         BRUSH_SMOOTH_STROKE = (1 << 11),
195         BRUSH_PERSISTENT = (1 << 12),
196         BRUSH_ACCUMULATE = (1 << 13),
197         BRUSH_LOCK_ALPHA = (1 << 14),
198         BRUSH_ORIGINAL_NORMAL = (1 << 15),
199         BRUSH_OFFSET_PRESSURE = (1 << 16),
200         BRUSH_SPACE_ATTEN = (1 << 18),
201         BRUSH_ADAPTIVE_SPACE = (1 << 19),
202         BRUSH_LOCK_SIZE = (1 << 20),
203         BRUSH_USE_GRADIENT = (1 << 21),
204         BRUSH_EDGE_TO_EDGE = (1 << 22),
205         BRUSH_DRAG_DOT = (1 << 23),
206         BRUSH_INVERSE_SMOOTH_PRESSURE = (1 << 24),
207 //      BRUSH_RANDOM_ROTATION = (1 << 25), deprecated, use brush_angle_mode
208         BRUSH_PLANE_TRIM = (1 << 26),
209         BRUSH_FRONTFACE = (1 << 27),
210         BRUSH_CUSTOM_ICON = (1 << 28),
211         BRUSH_LINE = (1 << 29),
212         BRUSH_ABSOLUTE_JITTER = (1 << 30),
213         BRUSH_CURVE = (1 << 31)
214 } BrushFlags;
215
216 typedef enum {
217         BRUSH_MASK_PRESSURE_RAMP = (1 << 1),
218         BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2)
219 } BrushMaskPressureFlags;
220
221 /* Brush.overlay_flags */
222 typedef enum OverlayFlags {
223         BRUSH_OVERLAY_CURSOR = (1),
224         BRUSH_OVERLAY_PRIMARY = (1 << 1),
225         BRUSH_OVERLAY_SECONDARY = (1 << 2),
226         BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE = (1 << 3),
227         BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE = (1 << 4),
228         BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE = (1 << 5)
229 } OverlayFlags;
230
231 #define BRUSH_OVERLAY_OVERRIDE_MASK (BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | \
232                                                                          BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
233                                                                          BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
234
235 /* Brush.sculpt_tool */
236 typedef enum BrushSculptTool {
237         SCULPT_TOOL_DRAW = 1,
238         SCULPT_TOOL_SMOOTH = 2,
239         SCULPT_TOOL_PINCH = 3,
240         SCULPT_TOOL_INFLATE = 4,
241         SCULPT_TOOL_GRAB = 5,
242         SCULPT_TOOL_LAYER = 6,
243         SCULPT_TOOL_FLATTEN = 7,
244         SCULPT_TOOL_CLAY = 8,
245         SCULPT_TOOL_FILL = 9,
246         SCULPT_TOOL_SCRAPE = 10,
247         SCULPT_TOOL_NUDGE = 11,
248         SCULPT_TOOL_THUMB = 12,
249         SCULPT_TOOL_SNAKE_HOOK = 13,
250         SCULPT_TOOL_ROTATE = 14,
251         SCULPT_TOOL_SIMPLIFY = 15,
252         SCULPT_TOOL_CREASE = 16,
253         SCULPT_TOOL_BLOB = 17,
254         SCULPT_TOOL_CLAY_STRIPS = 18,
255         SCULPT_TOOL_MASK = 19
256 } BrushSculptTool;
257
258 /** When #BRUSH_ACCUMULATE is used */
259 #define SCULPT_TOOL_HAS_ACCUMULATE(t) ELEM(t, \
260         SCULPT_TOOL_DRAW, \
261         SCULPT_TOOL_CREASE, \
262         SCULPT_TOOL_BLOB, \
263         SCULPT_TOOL_LAYER, \
264         SCULPT_TOOL_INFLATE, \
265         SCULPT_TOOL_CLAY, \
266         SCULPT_TOOL_CLAY_STRIPS, \
267         SCULPT_TOOL_ROTATE, \
268         SCULPT_TOOL_FLATTEN \
269         )
270
271 #define SCULPT_TOOL_HAS_NORMAL_WEIGHT(t) ELEM(t, \
272         SCULPT_TOOL_GRAB, \
273         SCULPT_TOOL_SNAKE_HOOK \
274         )
275
276 #define SCULPT_TOOL_HAS_RAKE(t) ELEM(t, \
277         SCULPT_TOOL_SNAKE_HOOK \
278         )
279
280 #define SCULPT_TOOL_HAS_DYNTOPO(t) (ELEM(t, \
281         /* These brushes, as currently coded, cannot support dynamic topology */ \
282         SCULPT_TOOL_GRAB, \
283         SCULPT_TOOL_ROTATE, \
284         SCULPT_TOOL_THUMB, \
285         SCULPT_TOOL_LAYER, \
286         \
287         /* These brushes could handle dynamic topology, but user feedback indicates it's better not to */ \
288         SCULPT_TOOL_SMOOTH, \
289         SCULPT_TOOL_MASK \
290         ) == 0)
291
292 /* ImagePaintSettings.tool */
293 typedef enum BrushImagePaintTool {
294         PAINT_TOOL_DRAW = 0,
295         PAINT_TOOL_SOFTEN = 1,
296         PAINT_TOOL_SMEAR = 2,
297         PAINT_TOOL_CLONE = 3,
298         PAINT_TOOL_FILL = 4,
299         PAINT_TOOL_MASK = 5
300 } BrushImagePaintTool;
301
302 /* direction that the brush displaces along */
303 enum {
304         SCULPT_DISP_DIR_AREA = 0,
305         SCULPT_DISP_DIR_VIEW = 1,
306         SCULPT_DISP_DIR_X = 2,
307         SCULPT_DISP_DIR_Y = 3,
308         SCULPT_DISP_DIR_Z = 4
309 };
310
311 enum {
312         PAINT_BLEND_MIX = 0,
313         PAINT_BLEND_ADD = 1,
314         PAINT_BLEND_SUB = 2,
315         PAINT_BLEND_MUL = 3,
316         PAINT_BLEND_BLUR = 4,
317         PAINT_BLEND_LIGHTEN = 5,
318         PAINT_BLEND_DARKEN = 6
319 };
320
321 typedef enum {
322         BRUSH_MASK_DRAW = 0,
323         BRUSH_MASK_SMOOTH = 1
324 } BrushMaskTool;
325
326 /* blur kernel types, Brush.blur_mode */
327 typedef enum BlurKernelType {
328         KERNEL_GAUSSIAN,
329         KERNEL_BOX
330 } BlurKernelType;
331
332 #define MAX_BRUSH_PIXEL_RADIUS 500
333
334 #endif  /* __DNA_BRUSH_TYPES_H__ */