UI: Tweak Sequencer Sidebar panels
[blender.git] / source / blender / makesdna / DNA_brush_types.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  * The Original Code is Copyright (C) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_BRUSH_TYPES_H__
25 #define __DNA_BRUSH_TYPES_H__
26
27 #include "DNA_ID.h"
28 #include "DNA_texture_types.h" /* for MTex */
29 #include "DNA_curve_types.h"
30
31 //#ifndef MAX_MTEX // XXX Not used?
32 //#define MAX_MTEX  18
33 //#endif
34
35 struct CurveMapping;
36 struct Image;
37 struct MTex;
38 struct Material;
39
40 typedef struct BrushClone {
41   /** Image for clone tool. */
42   struct Image *image;
43   /** Offset of clone image from canvas. */
44   float offset[2];
45   /** Transparency for drawing of clone image. */
46   float alpha;
47   char _pad[4];
48 } BrushClone;
49
50 typedef struct BrushGpencilSettings {
51   /** Amount of smoothing to apply to newly created strokes. */
52   float draw_smoothfac;
53   /** Amount of sensitivity to apply to newly created strokes. */
54   float draw_sensitivity;
55   /** Amount of alpha strength to apply to newly created strokes. */
56   float draw_strength;
57   /** Amount of jitter to apply to newly created strokes. */
58   float draw_jitter;
59   /** Angle when the brush has full thickness. */
60   float draw_angle;
61   /** Factor to apply when angle change (only 90 degrees). */
62   float draw_angle_factor;
63   /** Factor of randomness for pressure. */
64   float draw_random_press;
65   /** Factor of strength for strength. */
66   float draw_random_strength;
67   /** Factor of randomness for subdivision. */
68   float draw_random_sub;
69   /** Number of times to apply smooth factor to new strokes. */
70   short draw_smoothlvl;
71   /** Number of times to subdivide new strokes. */
72   short draw_subdivide;
73   short _pad;
74
75   /** Number of times to apply thickness smooth factor to new strokes. */
76   short thick_smoothlvl;
77   /** Amount of thickness smoothing to apply to newly created strokes. */
78   float thick_smoothfac;
79
80   /** Factor for transparency. */
81   float fill_threshold;
82   /** Number of pixel to consider the leak is too small (x 2). */
83   short fill_leak;
84   /** Fill zoom factor */
85   short fill_factor;
86   char _pad_1[4];
87
88   /** Number of simplify steps. */
89   int fill_simplylvl;
90   /** Type of control lines drawing mode. */
91   int fill_draw_mode;
92   /** Icon identifier. */
93   int icon_id;
94
95   /** Maximum distance before generate new point for very fast mouse movements. */
96   int input_samples;
97   /** Random factor for UV rotation. */
98   float uv_random;
99   /** Moved to 'Brush.gpencil_tool'. */
100   int brush_type DNA_DEPRECATED;
101   /** Soft, hard or stroke. */
102   int eraser_mode;
103   /** Smooth while drawing factor. */
104   float active_smooth;
105   /** Factor to apply to strength for soft eraser. */
106   float era_strength_f;
107   /** Factor to apply to thickness for soft eraser. */
108   float era_thickness_f;
109   /** Internal grease pencil drawing flags. */
110   int flag;
111
112   /** gradient control along y for color */
113   float gradient_f;
114   /** factor xy of shape for dots gradients */
115   float gradient_s[2];
116   char _pad_2[4];
117
118   struct CurveMapping *curve_sensitivity;
119   struct CurveMapping *curve_strength;
120   struct CurveMapping *curve_jitter;
121
122   /* optional link of material to replace default in context */
123   /** Material. */
124   struct Material *material;
125 } BrushGpencilSettings;
126
127 /* BrushGpencilSettings->gp_flag */
128 typedef enum eGPDbrush_Flag {
129   /* brush use pressure */
130   GP_BRUSH_USE_PRESSURE = (1 << 0),
131   /* brush use pressure for alpha factor */
132   GP_BRUSH_USE_STENGTH_PRESSURE = (1 << 1),
133   /* brush use pressure for alpha factor */
134   GP_BRUSH_USE_JITTER_PRESSURE = (1 << 2),
135   /* enable screen cursor */
136   GP_BRUSH_ENABLE_CURSOR = (1 << 5),
137   /* fill hide transparent */
138   GP_BRUSH_FILL_HIDE = (1 << 6),
139   /* show fill help lines */
140   GP_BRUSH_FILL_SHOW_HELPLINES = (1 << 7),
141   /* lazy mouse */
142   GP_BRUSH_STABILIZE_MOUSE = (1 << 8),
143   /* lazy mouse override (internal only) */
144   GP_BRUSH_STABILIZE_MOUSE_TEMP = (1 << 9),
145   /* default eraser brush for quick switch */
146   GP_BRUSH_DEFAULT_ERASER = (1 << 10),
147   /* settings group */
148   GP_BRUSH_GROUP_SETTINGS = (1 << 11),
149   /* Random settings group */
150   GP_BRUSH_GROUP_RANDOM = (1 << 12),
151   /* Keep material assigned to brush */
152   GP_BRUSH_MATERIAL_PINNED = (1 << 13),
153   /* Do not show fill color while drawing (no lasso mode) */
154   GP_BRUSH_DISSABLE_LASSO = (1 << 14),
155   /* Do not erase strokes oLcluded */
156   GP_BRUSH_OCCLUDE_ERASER = (1 << 15),
157   /* Post process trim stroke */
158   GP_BRUSH_TRIM_STROKE = (1 << 16),
159 } eGPDbrush_Flag;
160
161 /* BrushGpencilSettings->gp_fill_draw_mode */
162 typedef enum eGP_FillDrawModes {
163   GP_FILL_DMODE_BOTH = 0,
164   GP_FILL_DMODE_STROKE = 1,
165   GP_FILL_DMODE_CONTROL = 2,
166 } eGP_FillDrawModes;
167
168 /* BrushGpencilSettings->gp_eraser_mode */
169 typedef enum eGP_BrushEraserMode {
170   GP_BRUSH_ERASER_SOFT = 0,
171   GP_BRUSH_ERASER_HARD = 1,
172   GP_BRUSH_ERASER_STROKE = 2,
173 } eGP_BrushEraserMode;
174
175 /* BrushGpencilSettings default brush icons */
176 typedef enum eGP_BrushIcons {
177   GP_BRUSH_ICON_PENCIL = 1,
178   GP_BRUSH_ICON_PEN = 2,
179   GP_BRUSH_ICON_INK = 3,
180   GP_BRUSH_ICON_INKNOISE = 4,
181   GP_BRUSH_ICON_BLOCK = 5,
182   GP_BRUSH_ICON_MARKER = 6,
183   GP_BRUSH_ICON_FILL = 7,
184   GP_BRUSH_ICON_ERASE_SOFT = 8,
185   GP_BRUSH_ICON_ERASE_HARD = 9,
186   GP_BRUSH_ICON_ERASE_STROKE = 10,
187 } eGP_BrushIcons;
188
189 typedef struct Brush {
190   ID id;
191
192   struct BrushClone clone;
193   /** Falloff curve. */
194   struct CurveMapping *curve;
195   struct MTex mtex;
196   struct MTex mask_mtex;
197
198   struct Brush *toggle_brush;
199
200   struct ImBuf *icon_imbuf;
201   PreviewImage *preview;
202   /** Color gradient. */
203   struct ColorBand *gradient;
204   struct PaintCurve *paint_curve;
205
206   /** 1024 = FILE_MAX. */
207   char icon_filepath[1024];
208
209   float normal_weight;
210   /** Rake actual data (not texture), used for sculpt. */
211   float rake_factor;
212
213   /** Blend mode. */
214   short blend;
215   /** #eObjectMode: to see if the brush is compatible, use for display only. */
216   short ob_mode;
217   /** Brush weight. */
218   float weight;
219   /** Brush diameter. */
220   int size;
221   /** General purpose flag. */
222   int flag;
223   /** Pressure influence for mask. */
224   int mask_pressure;
225   /** Jitter the position of the brush. */
226   float jitter;
227   /** Absolute jitter in pixels. */
228   int jitter_absolute;
229   int overlay_flags;
230   /** Spacing of paint operations. */
231   int spacing;
232   /** Turning radius (in pixels) for smooth stroke. */
233   int smooth_stroke_radius;
234   /** Higher values limit fast changes in the stroke direction. */
235   float smooth_stroke_factor;
236   /** Paint operations / second (airbrush). */
237   float rate;
238
239   /** Color. */
240   float rgb[3];
241   /** Opacity. */
242   float alpha;
243
244   /** Background color. */
245   float secondary_rgb[3];
246
247   /** The direction of movement for sculpt vertices. */
248   int sculpt_plane;
249
250   /** Offset for plane brushes (clay, flatten, fill, scrape). */
251   float plane_offset;
252
253   int gradient_spacing;
254   /** Source for stroke color gradient application. */
255   char gradient_stroke_mode;
256   /** Source for fill tool color gradient application. */
257   char gradient_fill_mode;
258
259   char _pad;
260   /** Projection shape (sphere, circle). */
261   char falloff_shape;
262   float falloff_angle;
263
264   /** Active sculpt tool. */
265   char sculpt_tool;
266   /** Active sculpt tool. */
267   char uv_sculpt_tool;
268   /** Active vertex paint. */
269   char vertexpaint_tool;
270   /** Active weight paint. */
271   char weightpaint_tool;
272   /** Active image paint tool. */
273   char imagepaint_tool;
274   /** Enum eBrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK. */
275   char mask_tool;
276   /** Active grease pencil tool. */
277   char gpencil_tool;
278   char _pad0[1];
279
280   float autosmooth_factor;
281
282   float topology_rake_factor;
283
284   float crease_pinch_factor;
285
286   float plane_trim;
287   /** Affectable height of brush (layer height for layer tool, i.e.). */
288   float height;
289
290   float texture_sample_bias;
291
292   /* overlay */
293   int texture_overlay_alpha;
294   int mask_overlay_alpha;
295   int cursor_overlay_alpha;
296
297   float unprojected_radius;
298
299   /* soften/sharpen */
300   float sharp_threshold;
301   int blur_kernel_radius;
302   int blur_mode;
303
304   /* fill tool */
305   float fill_threshold;
306
307   float add_col[3];
308   float sub_col[3];
309
310   float stencil_pos[2];
311   float stencil_dimension[2];
312
313   float mask_stencil_pos[2];
314   float mask_stencil_dimension[2];
315
316   struct BrushGpencilSettings *gpencil_settings;
317
318 } Brush;
319 typedef struct PaletteColor {
320   struct PaletteColor *next, *prev;
321   /* two values, one to store rgb, other to store values for sculpt/weight */
322   float rgb[3];
323   float value;
324 } PaletteColor;
325
326 typedef struct Palette {
327   ID id;
328
329   /** Pointer to individual colors. */
330   ListBase colors;
331
332   int active_color;
333   char _pad[4];
334 } Palette;
335
336 typedef struct PaintCurvePoint {
337   /** Bezier handle. */
338   BezTriple bez;
339   /** Pressure on that point. */
340   float pressure;
341 } PaintCurvePoint;
342
343 typedef struct PaintCurve {
344   ID id;
345   /** Points of curve. */
346   PaintCurvePoint *points;
347   int tot_points;
348   /** Index where next point will be added. */
349   int add_index;
350 } PaintCurve;
351
352 /* Brush.gradient_source */
353 typedef enum eBrushGradientSourceStroke {
354   BRUSH_GRADIENT_PRESSURE = 0,       /* gradient from pressure */
355   BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
356   BRUSH_GRADIENT_SPACING_CLAMP = 2,  /* gradient from spacing */
357 } eBrushGradientSourceStroke;
358
359 typedef enum eBrushGradientSourceFill {
360   BRUSH_GRADIENT_LINEAR = 0, /* gradient from pressure */
361   BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
362 } eBrushGradientSourceFill;
363
364 /* Brush.flag */
365 typedef enum eBrushFlags {
366   BRUSH_AIRBRUSH = (1 << 0),
367   BRUSH_FLAG_UNUSED_1 = (1 << 1), /* cleared */
368   BRUSH_ALPHA_PRESSURE = (1 << 2),
369   BRUSH_SIZE_PRESSURE = (1 << 3),
370   BRUSH_JITTER_PRESSURE = (1 << 4),
371   BRUSH_SPACING_PRESSURE = (1 << 5),
372   BRUSH_FLAG_UNUSED_6 = (1 << 6), /* cleared */
373   BRUSH_FLAG_UNUSED_7 = (1 << 7), /* cleared */
374   BRUSH_ANCHORED = (1 << 8),
375   BRUSH_DIR_IN = (1 << 9),
376   BRUSH_SPACE = (1 << 10),
377   BRUSH_SMOOTH_STROKE = (1 << 11),
378   BRUSH_PERSISTENT = (1 << 12),
379   BRUSH_ACCUMULATE = (1 << 13),
380   BRUSH_LOCK_ALPHA = (1 << 14),
381   BRUSH_ORIGINAL_NORMAL = (1 << 15),
382   BRUSH_OFFSET_PRESSURE = (1 << 16),
383   BRUSH_FLAG_UNUSED_17 = (1 << 17), /* cleared */
384   BRUSH_SPACE_ATTEN = (1 << 18),
385   BRUSH_ADAPTIVE_SPACE = (1 << 19),
386   BRUSH_LOCK_SIZE = (1 << 20),
387   BRUSH_USE_GRADIENT = (1 << 21),
388   BRUSH_EDGE_TO_EDGE = (1 << 22),
389   BRUSH_DRAG_DOT = (1 << 23),
390   BRUSH_INVERSE_SMOOTH_PRESSURE = (1 << 24),
391   BRUSH_FRONTFACE_FALLOFF = (1 << 25),
392   BRUSH_PLANE_TRIM = (1 << 26),
393   BRUSH_FRONTFACE = (1 << 27),
394   BRUSH_CUSTOM_ICON = (1 << 28),
395   BRUSH_LINE = (1 << 29),
396   BRUSH_ABSOLUTE_JITTER = (1 << 30),
397   BRUSH_CURVE = (1u << 31),
398 } eBrushFlags;
399
400 typedef enum {
401   BRUSH_MASK_PRESSURE_RAMP = (1 << 1),
402   BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2),
403 } BrushMaskPressureFlags;
404
405 /* Brush.overlay_flags */
406 typedef enum eOverlayFlags {
407   BRUSH_OVERLAY_CURSOR = (1),
408   BRUSH_OVERLAY_PRIMARY = (1 << 1),
409   BRUSH_OVERLAY_SECONDARY = (1 << 2),
410   BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE = (1 << 3),
411   BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE = (1 << 4),
412   BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE = (1 << 5),
413 } eOverlayFlags;
414
415 #define BRUSH_OVERLAY_OVERRIDE_MASK \
416   (BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
417    BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
418
419 /* Brush.sculpt_tool */
420 typedef enum eBrushSculptTool {
421   SCULPT_TOOL_DRAW = 1,
422   SCULPT_TOOL_SMOOTH = 2,
423   SCULPT_TOOL_PINCH = 3,
424   SCULPT_TOOL_INFLATE = 4,
425   SCULPT_TOOL_GRAB = 5,
426   SCULPT_TOOL_LAYER = 6,
427   SCULPT_TOOL_FLATTEN = 7,
428   SCULPT_TOOL_CLAY = 8,
429   SCULPT_TOOL_FILL = 9,
430   SCULPT_TOOL_SCRAPE = 10,
431   SCULPT_TOOL_NUDGE = 11,
432   SCULPT_TOOL_THUMB = 12,
433   SCULPT_TOOL_SNAKE_HOOK = 13,
434   SCULPT_TOOL_ROTATE = 14,
435   SCULPT_TOOL_SIMPLIFY = 15,
436   SCULPT_TOOL_CREASE = 16,
437   SCULPT_TOOL_BLOB = 17,
438   SCULPT_TOOL_CLAY_STRIPS = 18,
439   SCULPT_TOOL_MASK = 19,
440 } eBrushSculptTool;
441
442 /* Brush.uv_sculpt_tool */
443 typedef enum eBrushUVSculptTool {
444   UV_SCULPT_TOOL_GRAB = 0,
445   UV_SCULPT_TOOL_RELAX = 1,
446   UV_SCULPT_TOOL_PINCH = 2,
447 } eBrushUVSculptTool;
448
449 /** When #BRUSH_ACCUMULATE is used */
450 #define SCULPT_TOOL_HAS_ACCUMULATE(t) \
451   ELEM(t, \
452        SCULPT_TOOL_DRAW, \
453        SCULPT_TOOL_CREASE, \
454        SCULPT_TOOL_BLOB, \
455        SCULPT_TOOL_LAYER, \
456        SCULPT_TOOL_INFLATE, \
457        SCULPT_TOOL_CLAY, \
458        SCULPT_TOOL_CLAY_STRIPS, \
459        SCULPT_TOOL_ROTATE, \
460        SCULPT_TOOL_FLATTEN)
461
462 #define SCULPT_TOOL_HAS_NORMAL_WEIGHT(t) ELEM(t, SCULPT_TOOL_GRAB, SCULPT_TOOL_SNAKE_HOOK)
463
464 #define SCULPT_TOOL_HAS_RAKE(t) ELEM(t, SCULPT_TOOL_SNAKE_HOOK)
465
466 #define SCULPT_TOOL_HAS_DYNTOPO(t) \
467   (ELEM(t, /* These brushes, as currently coded, cannot support dynamic topology */ \
468         SCULPT_TOOL_GRAB, \
469         SCULPT_TOOL_ROTATE, \
470         SCULPT_TOOL_THUMB, \
471         SCULPT_TOOL_LAYER, \
472 \
473         /* These brushes could handle dynamic topology, \
474          * but user feedback indicates it's better not to */ \
475         SCULPT_TOOL_SMOOTH, \
476         SCULPT_TOOL_MASK) == 0)
477
478 #define SCULPT_TOOL_HAS_TOPOLOGY_RAKE(t) \
479   (ELEM(t, /* These brushes, as currently coded, cannot support topology rake. */ \
480         SCULPT_TOOL_GRAB, \
481         SCULPT_TOOL_ROTATE, \
482         SCULPT_TOOL_THUMB, \
483         SCULPT_TOOL_MASK) == 0)
484
485 /* ImagePaintSettings.tool */
486 typedef enum eBrushImagePaintTool {
487   PAINT_TOOL_DRAW = 0,
488   PAINT_TOOL_SOFTEN = 1,
489   PAINT_TOOL_SMEAR = 2,
490   PAINT_TOOL_CLONE = 3,
491   PAINT_TOOL_FILL = 4,
492   PAINT_TOOL_MASK = 5,
493 } eBrushImagePaintTool;
494
495 typedef enum eBrushVertexPaintTool {
496   VPAINT_TOOL_DRAW = 0,
497   VPAINT_TOOL_BLUR = 1,
498   VPAINT_TOOL_AVERAGE = 2,
499   VPAINT_TOOL_SMEAR = 3,
500 } eBrushVertexPaintTool;
501
502 typedef enum eBrushWeightPaintTool {
503   WPAINT_TOOL_DRAW = 0,
504   WPAINT_TOOL_BLUR = 1,
505   WPAINT_TOOL_AVERAGE = 2,
506   WPAINT_TOOL_SMEAR = 3,
507 } eBrushWeightPaintTool;
508
509 /* BrushGpencilSettings->brush type */
510 typedef enum eBrushGPaintTool {
511   GPAINT_TOOL_DRAW = 0,
512   GPAINT_TOOL_FILL = 1,
513   GPAINT_TOOL_ERASE = 2,
514 } eBrushGPaintTool;
515
516 /* direction that the brush displaces along */
517 enum {
518   SCULPT_DISP_DIR_AREA = 0,
519   SCULPT_DISP_DIR_VIEW = 1,
520   SCULPT_DISP_DIR_X = 2,
521   SCULPT_DISP_DIR_Y = 3,
522   SCULPT_DISP_DIR_Z = 4,
523 };
524
525 typedef enum {
526   BRUSH_MASK_DRAW = 0,
527   BRUSH_MASK_SMOOTH = 1,
528 } BrushMaskTool;
529
530 /* blur kernel types, Brush.blur_mode */
531 typedef enum eBlurKernelType {
532   KERNEL_GAUSSIAN,
533   KERNEL_BOX,
534 } eBlurKernelType;
535
536 /* Brush.falloff_shape */
537 enum {
538   PAINT_FALLOFF_SHAPE_SPHERE = 0,
539   PAINT_FALLOFF_SHAPE_TUBE = 1,
540 };
541
542 #define MAX_BRUSH_PIXEL_RADIUS 500
543 #define GP_MAX_BRUSH_PIXEL_RADIUS 1000
544
545 #endif /* __DNA_BRUSH_TYPES_H__ */