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