Sculpt: Pose Brush Scale/Transform deform mode
[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_curve_types.h"
29 #include "DNA_texture_types.h" /* for MTex */
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   char _pad2[4];
54   /** Amount of alpha strength to apply to newly created strokes. */
55   float draw_strength;
56   /** Amount of jitter to apply to newly created strokes. */
57   float draw_jitter;
58   /** Angle when the brush has full thickness. */
59   float draw_angle;
60   /** Factor to apply when angle change (only 90 degrees). */
61   float draw_angle_factor;
62   /** Factor of randomness for pressure. */
63   float draw_random_press;
64   /** Factor of strength for strength. */
65   float draw_random_strength;
66   /** Number of times to apply smooth factor to new strokes. */
67   short draw_smoothlvl;
68   /** Number of times to subdivide new strokes. */
69   short draw_subdivide;
70   char _pad[4];
71
72   /** Factor for transparency. */
73   float fill_threshold;
74   /** Number of pixel to consider the leak is too small (x 2). */
75   short fill_leak;
76   /** Fill zoom factor */
77   short fill_factor;
78   int flag2;
79
80   /** Number of simplify steps. */
81   int fill_simplylvl;
82   /** Type of control lines drawing mode. */
83   int fill_draw_mode;
84   /** Icon identifier. */
85   int icon_id;
86
87   /** Maximum distance before generate new point for very fast mouse movements. */
88   int input_samples;
89   /** Random factor for UV rotation. */
90   float uv_random;
91   /** Moved to 'Brush.gpencil_tool'. */
92   int brush_type DNA_DEPRECATED;
93   /** Soft, hard or stroke. */
94   int eraser_mode;
95   /** Smooth while drawing factor. */
96   float active_smooth;
97   /** Factor to apply to strength for soft eraser. */
98   float era_strength_f;
99   /** Factor to apply to thickness for soft eraser. */
100   float era_thickness_f;
101   /** Internal grease pencil drawing flags. */
102   int flag;
103
104   /** gradient control along y for color */
105   float hardeness;
106   /** factor xy of shape for dots gradients */
107   float aspect_ratio[2];
108   /** Simplify adaptive factor */
109   float simplify_f;
110
111   /** Mix colorfactor */
112   float vertex_factor;
113   int vertex_mode;
114
115   /** eGP_Sculpt_Flag. */
116   int sculpt_flag;
117   /** eGP_Sculpt_Mode_Flag. */
118   int sculpt_mode_flag;
119   /** Preset type (used to reset brushes - internal). */
120   short preset_type;
121   char _pad3[2];
122
123   /** Randomness for Hue. */
124   float random_hue;
125   /** Randomness for Saturation. */
126   float random_saturation;
127   /** Randomness for Value. */
128   float random_value;
129
130   struct CurveMapping *curve_sensitivity;
131   struct CurveMapping *curve_strength;
132   struct CurveMapping *curve_jitter;
133   struct CurveMapping *curve_rand_pressure;
134   struct CurveMapping *curve_rand_strength;
135   struct CurveMapping *curve_rand_uv;
136   struct CurveMapping *curve_rand_hue;
137   struct CurveMapping *curve_rand_saturation;
138   struct CurveMapping *curve_rand_value;
139
140   /* optional link of material to replace default in context */
141   /** Material. */
142   struct Material *material;
143 } BrushGpencilSettings;
144
145 /* BrushGpencilSettings->preset_type.
146  * Use a range for each group and not continuous values.*/
147 typedef enum eGPBrush_Presets {
148   GP_BRUSH_PRESET_UNKNOWN = 0,
149
150   /* Draw 1-99. */
151   GP_BRUSH_PRESET_AIRBRUSH = 1,
152   GP_BRUSH_PRESET_INK_PEN = 2,
153   GP_BRUSH_PRESET_INK_PEN_ROUGH = 3,
154   GP_BRUSH_PRESET_MARKER_BOLD = 4,
155   GP_BRUSH_PRESET_MARKER_CHISEL = 5,
156   GP_BRUSH_PRESET_PEN = 6,
157   GP_BRUSH_PRESET_PENCIL_SOFT = 7,
158   GP_BRUSH_PRESET_PENCIL = 8,
159   GP_BRUSH_PRESET_FILL_AREA = 9,
160   GP_BRUSH_PRESET_ERASER_SOFT = 10,
161   GP_BRUSH_PRESET_ERASER_HARD = 11,
162   GP_BRUSH_PRESET_ERASER_POINT = 12,
163   GP_BRUSH_PRESET_ERASER_STROKE = 13,
164   GP_BRUSH_PRESET_TINT = 14,
165
166   /* Vertex Paint 100-199. */
167   GP_BRUSH_PRESET_VERTEX_DRAW = 100,
168   GP_BRUSH_PRESET_VERTEX_BLUR = 101,
169   GP_BRUSH_PRESET_VERTEX_AVERAGE = 102,
170   GP_BRUSH_PRESET_VERTEX_SMEAR = 103,
171   GP_BRUSH_PRESET_VERTEX_REPLACE = 104,
172
173   /* Sculpt 200-299. */
174   GP_BRUSH_PRESET_SMOOTH_STROKE = 200,
175   GP_BRUSH_PRESET_STRENGTH_STROKE = 201,
176   GP_BRUSH_PRESET_THICKNESS_STROKE = 202,
177   GP_BRUSH_PRESET_GRAB_STROKE = 203,
178   GP_BRUSH_PRESET_PUSH_STROKE = 204,
179   GP_BRUSH_PRESET_TWIST_STROKE = 205,
180   GP_BRUSH_PRESET_PINCH_STROKE = 206,
181   GP_BRUSH_PRESET_RANDOMIZE_STROKE = 207,
182   GP_BRUSH_PRESET_CLONE_STROKE = 208,
183
184   /* Weight Paint 300-399. */
185   GP_BRUSH_PRESET_DRAW_WEIGHT = 300,
186 } eGPBrush_Presets;
187
188 /* BrushGpencilSettings->gp_flag */
189 typedef enum eGPDbrush_Flag {
190   /* brush use pressure */
191   GP_BRUSH_USE_PRESSURE = (1 << 0),
192   /* brush use pressure for alpha factor */
193   GP_BRUSH_USE_STENGTH_PRESSURE = (1 << 1),
194   /* brush use pressure for alpha factor */
195   GP_BRUSH_USE_JITTER_PRESSURE = (1 << 2),
196   /* fill hide transparent */
197   GP_BRUSH_FILL_HIDE = (1 << 6),
198   /* show fill help lines */
199   GP_BRUSH_FILL_SHOW_HELPLINES = (1 << 7),
200   /* lazy mouse */
201   GP_BRUSH_STABILIZE_MOUSE = (1 << 8),
202   /* lazy mouse override (internal only) */
203   GP_BRUSH_STABILIZE_MOUSE_TEMP = (1 << 9),
204   /* default eraser brush for quick switch */
205   GP_BRUSH_DEFAULT_ERASER = (1 << 10),
206   /* settings group */
207   GP_BRUSH_GROUP_SETTINGS = (1 << 11),
208   /* Random settings group */
209   GP_BRUSH_GROUP_RANDOM = (1 << 12),
210   /* Keep material assigned to brush */
211   GP_BRUSH_MATERIAL_PINNED = (1 << 13),
212   /* Do not show fill color while drawing (no lasso mode) */
213   GP_BRUSH_DISSABLE_LASSO = (1 << 14),
214   /* Do not erase strokes oLcluded */
215   GP_BRUSH_OCCLUDE_ERASER = (1 << 15),
216   /* Post process trim stroke */
217   GP_BRUSH_TRIM_STROKE = (1 << 16),
218 } eGPDbrush_Flag;
219
220 typedef enum eGPDbrush_Flag2 {
221   /* Brush use random Hue at stroke level */
222   GP_BRUSH_USE_HUE_AT_STROKE = (1 << 0),
223   /* Brush use random Saturation at stroke level */
224   GP_BRUSH_USE_SAT_AT_STROKE = (1 << 1),
225   /* Brush use random Value at stroke level */
226   GP_BRUSH_USE_VAL_AT_STROKE = (1 << 2),
227   /* Brush use random Pressure at stroke level */
228   GP_BRUSH_USE_PRESS_AT_STROKE = (1 << 3),
229   /* Brush use random Strength at stroke level */
230   GP_BRUSH_USE_STRENGTH_AT_STROKE = (1 << 4),
231   /* Brush use random UV at stroke level */
232   GP_BRUSH_USE_UV_AT_STROKE = (1 << 5),
233   /* Brush use Hue random pressure */
234   GP_BRUSH_USE_HUE_RAND_PRESS = (1 << 6),
235   /* Brush use Saturation random pressure */
236   GP_BRUSH_USE_SAT_RAND_PRESS = (1 << 7),
237   /* Brush use Value random pressure */
238   GP_BRUSH_USE_VAL_RAND_PRESS = (1 << 8),
239   /* Brush use Pressure random pressure */
240   GP_BRUSH_USE_PRESSURE_RAND_PRESS = (1 << 9),
241   /* Brush use Strength random pressure */
242   GP_BRUSH_USE_STRENGTH_RAND_PRESS = (1 << 10),
243   /* Brush use UV random pressure */
244   GP_BRUSH_USE_UV_RAND_PRESS = (1 << 11),
245 } eGPDbrush_Flag2;
246
247 /* BrushGpencilSettings->gp_fill_draw_mode */
248 typedef enum eGP_FillDrawModes {
249   GP_FILL_DMODE_BOTH = 0,
250   GP_FILL_DMODE_STROKE = 1,
251   GP_FILL_DMODE_CONTROL = 2,
252 } eGP_FillDrawModes;
253
254 /* BrushGpencilSettings->gp_eraser_mode */
255 typedef enum eGP_BrushEraserMode {
256   GP_BRUSH_ERASER_SOFT = 0,
257   GP_BRUSH_ERASER_HARD = 1,
258   GP_BRUSH_ERASER_STROKE = 2,
259 } eGP_BrushEraserMode;
260
261 /* BrushGpencilSettings default brush icons */
262 typedef enum eGP_BrushIcons {
263   GP_BRUSH_ICON_PENCIL = 1,
264   GP_BRUSH_ICON_PEN = 2,
265   GP_BRUSH_ICON_INK = 3,
266   GP_BRUSH_ICON_INKNOISE = 4,
267   GP_BRUSH_ICON_BLOCK = 5,
268   GP_BRUSH_ICON_MARKER = 6,
269   GP_BRUSH_ICON_FILL = 7,
270   GP_BRUSH_ICON_ERASE_SOFT = 8,
271   GP_BRUSH_ICON_ERASE_HARD = 9,
272   GP_BRUSH_ICON_ERASE_STROKE = 10,
273   GP_BRUSH_ICON_AIRBRUSH = 11,
274   GP_BRUSH_ICON_CHISEL = 12,
275   GP_BRUSH_ICON_TINT = 13,
276   GP_BRUSH_ICON_VERTEX_DRAW = 14,
277   GP_BRUSH_ICON_VERTEX_BLUR = 15,
278   GP_BRUSH_ICON_VERTEX_AVERAGE = 16,
279   GP_BRUSH_ICON_VERTEX_SMEAR = 17,
280   GP_BRUSH_ICON_VERTEX_REPLACE = 18,
281   GP_BRUSH_ICON_GPBRUSH_SMOOTH = 19,
282   GP_BRUSH_ICON_GPBRUSH_THICKNESS = 20,
283   GP_BRUSH_ICON_GPBRUSH_STRENGTH = 21,
284   GP_BRUSH_ICON_GPBRUSH_RANDOMIZE = 22,
285   GP_BRUSH_ICON_GPBRUSH_GRAB = 23,
286   GP_BRUSH_ICON_GPBRUSH_PUSH = 24,
287   GP_BRUSH_ICON_GPBRUSH_TWIST = 25,
288   GP_BRUSH_ICON_GPBRUSH_PINCH = 26,
289   GP_BRUSH_ICON_GPBRUSH_CLONE = 27,
290   GP_BRUSH_ICON_GPBRUSH_WEIGHT = 28,
291 } eGP_BrushIcons;
292
293 typedef enum eBrushCurvePreset {
294   BRUSH_CURVE_CUSTOM = 0,
295   BRUSH_CURVE_SMOOTH = 1,
296   BRUSH_CURVE_SPHERE = 2,
297   BRUSH_CURVE_ROOT = 3,
298   BRUSH_CURVE_SHARP = 4,
299   BRUSH_CURVE_LIN = 5,
300   BRUSH_CURVE_POW4 = 6,
301   BRUSH_CURVE_INVSQUARE = 7,
302   BRUSH_CURVE_CONSTANT = 8,
303   BRUSH_CURVE_SMOOTHER = 9,
304 } eBrushCurvePreset;
305
306 typedef enum eBrushElasticDeformType {
307   BRUSH_ELASTIC_DEFORM_GRAB = 0,
308   BRUSH_ELASTIC_DEFORM_GRAB_BISCALE = 1,
309   BRUSH_ELASTIC_DEFORM_GRAB_TRISCALE = 2,
310   BRUSH_ELASTIC_DEFORM_SCALE = 3,
311   BRUSH_ELASTIC_DEFORM_TWIST = 4,
312 } eBrushElasticDeformType;
313
314 typedef enum eBrushClothDeformType {
315   BRUSH_CLOTH_DEFORM_DRAG = 0,
316   BRUSH_CLOTH_DEFORM_PUSH = 1,
317   BRUSH_CLOTH_DEFORM_GRAB = 2,
318   BRUSH_CLOTH_DEFORM_PINCH_POINT = 3,
319   BRUSH_CLOTH_DEFORM_PINCH_PERPENDICULAR = 4,
320   BRUSH_CLOTH_DEFORM_INFLATE = 5,
321   BRUSH_CLOTH_DEFORM_EXPAND = 6,
322 } eBrushClothDeformType;
323
324 typedef enum eBrushSmoothDeformType {
325   BRUSH_SMOOTH_DEFORM_LAPLACIAN = 0,
326   BRUSH_SMOOTH_DEFORM_SURFACE = 1,
327 } eBrushSmoothDeformType;
328
329 typedef enum eBrushClothForceFalloffType {
330   BRUSH_CLOTH_FORCE_FALLOFF_RADIAL = 0,
331   BRUSH_CLOTH_FORCE_FALLOFF_PLANE = 1,
332 } eBrushClothForceFalloffType;
333
334 typedef enum eBrushPoseDeformType {
335   BRUSH_POSE_DEFORM_ROTATE_TWIST = 0,
336   BRUSH_POSE_DEFORM_SCALE_TRASLATE = 1,
337 } eBrushPoseDeformType;
338
339 typedef enum eBrushPoseOriginType {
340   BRUSH_POSE_ORIGIN_TOPOLOGY = 0,
341   BRUSH_POSE_ORIGIN_FACE_SETS = 1,
342 } eBrushPoseOriginType;
343
344 /* Gpencilsettings.Vertex_mode */
345 typedef enum eGp_Vertex_Mode {
346   /* Affect to Stroke only. */
347   GPPAINT_MODE_STROKE = 0,
348   /* Affect to Fill only. */
349   GPPAINT_MODE_FILL = 1,
350   /* Affect to both. */
351   GPPAINT_MODE_BOTH = 2,
352 } eGp_Vertex_Mode;
353
354 /* sculpt_flag */
355 typedef enum eGP_Sculpt_Flag {
356   /* invert the effect of the brush */
357   GP_SCULPT_FLAG_INVERT = (1 << 0),
358   /* smooth brush affects pressure values as well */
359   GP_SCULPT_FLAG_SMOOTH_PRESSURE = (1 << 2),
360   /* temporary invert action */
361   GP_SCULPT_FLAG_TMP_INVERT = (1 << 3),
362 } eGP_Sculpt_Flag;
363
364 /* sculpt_mode_flag */
365 typedef enum eGP_Sculpt_Mode_Flag {
366   /* apply brush to position */
367   GP_SCULPT_FLAGMODE_APPLY_POSITION = (1 << 0),
368   /* apply brush to strength */
369   GP_SCULPT_FLAGMODE_APPLY_STRENGTH = (1 << 1),
370   /* apply brush to thickness */
371   GP_SCULPT_FLAGMODE_APPLY_THICKNESS = (1 << 2),
372   /* apply brush to uv data */
373   GP_SCULPT_FLAGMODE_APPLY_UV = (1 << 3),
374 } eGP_Sculpt_Mode_Flag;
375
376 typedef enum eAutomasking_flag {
377   BRUSH_AUTOMASKING_TOPOLOGY = (1 << 0),
378   BRUSH_AUTOMASKING_FACE_SETS = (1 << 1),
379   BRUSH_AUTOMASKING_BOUNDARY_EDGES = (1 << 2),
380   BRUSH_AUTOMASKING_BOUNDARY_FACE_SETS = (1 << 3),
381 } eAutomasking_flag;
382
383 typedef struct Brush {
384   ID id;
385
386   struct BrushClone clone;
387   /** Falloff curve. */
388   struct CurveMapping *curve;
389   struct MTex mtex;
390   struct MTex mask_mtex;
391
392   struct Brush *toggle_brush;
393
394   struct ImBuf *icon_imbuf;
395   PreviewImage *preview;
396   /** Color gradient. */
397   struct ColorBand *gradient;
398   struct PaintCurve *paint_curve;
399
400   /** 1024 = FILE_MAX. */
401   char icon_filepath[1024];
402
403   float normal_weight;
404   /** Rake actual data (not texture), used for sculpt. */
405   float rake_factor;
406
407   /** Blend mode. */
408   short blend;
409   /** #eObjectMode: to see if the brush is compatible, use for display only. */
410   short ob_mode;
411   /** Brush weight. */
412   float weight;
413   /** Brush diameter. */
414   int size;
415   /** General purpose flags. */
416   int flag;
417   int flag2;
418   int sampling_flag;
419
420   /** Pressure influence for mask. */
421   int mask_pressure;
422   /** Jitter the position of the brush. */
423   float jitter;
424   /** Absolute jitter in pixels. */
425   int jitter_absolute;
426   int overlay_flags;
427   /** Spacing of paint operations. */
428   int spacing;
429   /** Turning radius (in pixels) for smooth stroke. */
430   int smooth_stroke_radius;
431   /** Higher values limit fast changes in the stroke direction. */
432   float smooth_stroke_factor;
433   /** Paint operations / second (airbrush). */
434   float rate;
435
436   /** Color. */
437   float rgb[3];
438   /** Opacity. */
439   float alpha;
440
441   /** Background color. */
442   float secondary_rgb[3];
443
444   /** Rate */
445   float dash_ratio;
446   int dash_samples;
447
448   /** The direction of movement for sculpt vertices. */
449   int sculpt_plane;
450
451   /** Offset for plane brushes (clay, flatten, fill, scrape). */
452   float plane_offset;
453
454   int gradient_spacing;
455   /** Source for stroke color gradient application. */
456   char gradient_stroke_mode;
457   /** Source for fill tool color gradient application. */
458   char gradient_fill_mode;
459
460   char _pad0[1];
461
462   /** Projection shape (sphere, circle). */
463   char falloff_shape;
464   float falloff_angle;
465
466   /** Active sculpt tool. */
467   char sculpt_tool;
468   /** Active sculpt tool. */
469   char uv_sculpt_tool;
470   /** Active vertex paint. */
471   char vertexpaint_tool;
472   /** Active weight paint. */
473   char weightpaint_tool;
474   /** Active image paint tool. */
475   char imagepaint_tool;
476   /** Enum eBrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK. */
477   char mask_tool;
478   /** Active grease pencil tool. */
479   char gpencil_tool;
480   /** Active grease pencil vertex tool. */
481   char gpencil_vertex_tool;
482   /** Active grease pencil sculpt tool. */
483   char gpencil_sculpt_tool;
484   /** Active grease pencil weight tool. */
485   char gpencil_weight_tool;
486   char _pad1[2];
487
488   float autosmooth_factor;
489
490   float topology_rake_factor;
491
492   float crease_pinch_factor;
493
494   float normal_radius_factor;
495   float area_radius_factor;
496
497   float plane_trim;
498   /** Affectable height of brush (layer height for layer tool, i.e.). */
499   float height;
500
501   float texture_sample_bias;
502
503   int curve_preset;
504   float hardness;
505
506   /* automasking */
507   int automasking_flags;
508   int automasking_boundary_edges_propagation_steps;
509
510   /* Factor that controls the shape of the brush tip by rounding the corners of a square. */
511   /* 0.0 value produces a square, 1.0 produces a circle. */
512   float tip_roundness;
513
514   int elastic_deform_type;
515   float elastic_deform_volume_preservation;
516
517   /* pose */
518   int pose_deform_type;
519   float pose_offset;
520   int pose_smooth_iterations;
521   int pose_ik_segments;
522   int pose_origin_type;
523
524   /* cloth */
525   int cloth_deform_type;
526   int cloth_force_falloff_type;
527
528   float cloth_mass;
529   float cloth_damping;
530
531   float cloth_sim_limit;
532   float cloth_sim_falloff;
533
534   /* smooth */
535   int smooth_deform_type;
536   float surface_smooth_shape_preservation;
537   float surface_smooth_current_vertex;
538   int surface_smooth_iterations;
539
540   /* multiplane scrape */
541   float multiplane_scrape_angle;
542
543   /* overlay */
544   int texture_overlay_alpha;
545   int mask_overlay_alpha;
546   int cursor_overlay_alpha;
547
548   float unprojected_radius;
549
550   /* soften/sharpen */
551   float sharp_threshold;
552   int blur_kernel_radius;
553   int blur_mode;
554
555   /* fill tool */
556   float fill_threshold;
557
558   float add_col[4];
559   float sub_col[4];
560
561   float stencil_pos[2];
562   float stencil_dimension[2];
563
564   float mask_stencil_pos[2];
565   float mask_stencil_dimension[2];
566
567   struct BrushGpencilSettings *gpencil_settings;
568
569 } Brush;
570
571 /* Struct to hold palette colors for sorting. */
572 typedef struct tPaletteColorHSV {
573   float rgb[3];
574   float value;
575   float h;
576   float s;
577   float v;
578 } tPaletteColorHSV;
579
580 typedef struct PaletteColor {
581   struct PaletteColor *next, *prev;
582   /* two values, one to store rgb, other to store values for sculpt/weight */
583   float rgb[3];
584   float value;
585 } PaletteColor;
586
587 typedef struct Palette {
588   ID id;
589
590   /** Pointer to individual colors. */
591   ListBase colors;
592
593   int active_color;
594   char _pad[4];
595 } Palette;
596
597 typedef struct PaintCurvePoint {
598   /** Bezier handle. */
599   BezTriple bez;
600   /** Pressure on that point. */
601   float pressure;
602 } PaintCurvePoint;
603
604 typedef struct PaintCurve {
605   ID id;
606   /** Points of curve. */
607   PaintCurvePoint *points;
608   int tot_points;
609   /** Index where next point will be added. */
610   int add_index;
611 } PaintCurve;
612
613 /* Brush.gradient_source */
614 typedef enum eBrushGradientSourceStroke {
615   BRUSH_GRADIENT_PRESSURE = 0,       /* gradient from pressure */
616   BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
617   BRUSH_GRADIENT_SPACING_CLAMP = 2,  /* gradient from spacing */
618 } eBrushGradientSourceStroke;
619
620 typedef enum eBrushGradientSourceFill {
621   BRUSH_GRADIENT_LINEAR = 0, /* gradient from pressure */
622   BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
623 } eBrushGradientSourceFill;
624
625 /* Brush.flag */
626 typedef enum eBrushFlags {
627   BRUSH_AIRBRUSH = (1 << 0),
628   BRUSH_INVERT_TO_SCRAPE_FILL = (1 << 1),
629   BRUSH_ALPHA_PRESSURE = (1 << 2),
630   BRUSH_SIZE_PRESSURE = (1 << 3),
631   BRUSH_JITTER_PRESSURE = (1 << 4),
632   BRUSH_SPACING_PRESSURE = (1 << 5),
633   BRUSH_ORIGINAL_PLANE = (1 << 6),
634   BRUSH_GRAB_ACTIVE_VERTEX = (1 << 7),
635   BRUSH_ANCHORED = (1 << 8),
636   BRUSH_DIR_IN = (1 << 9),
637   BRUSH_SPACE = (1 << 10),
638   BRUSH_SMOOTH_STROKE = (1 << 11),
639   BRUSH_PERSISTENT = (1 << 12),
640   BRUSH_ACCUMULATE = (1 << 13),
641   BRUSH_LOCK_ALPHA = (1 << 14),
642   BRUSH_ORIGINAL_NORMAL = (1 << 15),
643   BRUSH_OFFSET_PRESSURE = (1 << 16),
644   BRUSH_SCENE_SPACING = (1 << 17),
645   BRUSH_SPACE_ATTEN = (1 << 18),
646   BRUSH_ADAPTIVE_SPACE = (1 << 19),
647   BRUSH_LOCK_SIZE = (1 << 20),
648   BRUSH_USE_GRADIENT = (1 << 21),
649   BRUSH_EDGE_TO_EDGE = (1 << 22),
650   BRUSH_DRAG_DOT = (1 << 23),
651   BRUSH_INVERSE_SMOOTH_PRESSURE = (1 << 24),
652   BRUSH_FRONTFACE_FALLOFF = (1 << 25),
653   BRUSH_PLANE_TRIM = (1 << 26),
654   BRUSH_FRONTFACE = (1 << 27),
655   BRUSH_CUSTOM_ICON = (1 << 28),
656   BRUSH_LINE = (1 << 29),
657   BRUSH_ABSOLUTE_JITTER = (1 << 30),
658   BRUSH_CURVE = (1u << 31),
659 } eBrushFlags;
660
661 /* Brush.sampling_flag */
662 typedef enum eBrushSamplingFlags {
663   BRUSH_PAINT_ANTIALIASING = (1 << 0),
664 } eBrushSamplingFlags;
665
666 /* Brush.flag2 */
667 typedef enum eBrushFlags2 {
668   BRUSH_MULTIPLANE_SCRAPE_DYNAMIC = (1 << 0),
669   BRUSH_MULTIPLANE_SCRAPE_PLANES_PREVIEW = (1 << 1),
670   BRUSH_POSE_IK_ANCHORED = (1 << 2),
671 } eBrushFlags2;
672
673 typedef enum {
674   BRUSH_MASK_PRESSURE_RAMP = (1 << 1),
675   BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2),
676 } BrushMaskPressureFlags;
677
678 /* Brush.overlay_flags */
679 typedef enum eOverlayFlags {
680   BRUSH_OVERLAY_CURSOR = (1),
681   BRUSH_OVERLAY_PRIMARY = (1 << 1),
682   BRUSH_OVERLAY_SECONDARY = (1 << 2),
683   BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE = (1 << 3),
684   BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE = (1 << 4),
685   BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE = (1 << 5),
686 } eOverlayFlags;
687
688 #define BRUSH_OVERLAY_OVERRIDE_MASK \
689   (BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
690    BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
691
692 /* Brush.sculpt_tool */
693 typedef enum eBrushSculptTool {
694   SCULPT_TOOL_DRAW = 1,
695   SCULPT_TOOL_SMOOTH = 2,
696   SCULPT_TOOL_PINCH = 3,
697   SCULPT_TOOL_INFLATE = 4,
698   SCULPT_TOOL_GRAB = 5,
699   SCULPT_TOOL_LAYER = 6,
700   SCULPT_TOOL_FLATTEN = 7,
701   SCULPT_TOOL_CLAY = 8,
702   SCULPT_TOOL_FILL = 9,
703   SCULPT_TOOL_SCRAPE = 10,
704   SCULPT_TOOL_NUDGE = 11,
705   SCULPT_TOOL_THUMB = 12,
706   SCULPT_TOOL_SNAKE_HOOK = 13,
707   SCULPT_TOOL_ROTATE = 14,
708   SCULPT_TOOL_SIMPLIFY = 15,
709   SCULPT_TOOL_CREASE = 16,
710   SCULPT_TOOL_BLOB = 17,
711   SCULPT_TOOL_CLAY_STRIPS = 18,
712   SCULPT_TOOL_MASK = 19,
713   SCULPT_TOOL_DRAW_SHARP = 20,
714   SCULPT_TOOL_ELASTIC_DEFORM = 21,
715   SCULPT_TOOL_POSE = 22,
716   SCULPT_TOOL_MULTIPLANE_SCRAPE = 23,
717   SCULPT_TOOL_SLIDE_RELAX = 24,
718   SCULPT_TOOL_CLAY_THUMB = 25,
719   SCULPT_TOOL_CLOTH = 26,
720   SCULPT_TOOL_DRAW_FACE_SETS = 27,
721 } eBrushSculptTool;
722
723 /* Brush.uv_sculpt_tool */
724 typedef enum eBrushUVSculptTool {
725   UV_SCULPT_TOOL_GRAB = 0,
726   UV_SCULPT_TOOL_RELAX = 1,
727   UV_SCULPT_TOOL_PINCH = 2,
728 } eBrushUVSculptTool;
729
730 /** When #BRUSH_ACCUMULATE is used */
731 #define SCULPT_TOOL_HAS_ACCUMULATE(t) \
732   ELEM(t, \
733        SCULPT_TOOL_DRAW, \
734        SCULPT_TOOL_DRAW_SHARP, \
735        SCULPT_TOOL_SLIDE_RELAX, \
736        SCULPT_TOOL_CREASE, \
737        SCULPT_TOOL_BLOB, \
738        SCULPT_TOOL_INFLATE, \
739        SCULPT_TOOL_CLAY, \
740        SCULPT_TOOL_CLAY_STRIPS, \
741        SCULPT_TOOL_CLAY_THUMB, \
742        SCULPT_TOOL_ROTATE, \
743        SCULPT_TOOL_SCRAPE, \
744        SCULPT_TOOL_FLATTEN)
745
746 #define SCULPT_TOOL_HAS_NORMAL_WEIGHT(t) \
747   ELEM(t, SCULPT_TOOL_GRAB, SCULPT_TOOL_SNAKE_HOOK, SCULPT_TOOL_ELASTIC_DEFORM)
748
749 #define SCULPT_TOOL_HAS_RAKE(t) ELEM(t, SCULPT_TOOL_SNAKE_HOOK)
750
751 #define SCULPT_TOOL_HAS_DYNTOPO(t) \
752   (ELEM(t, /* These brushes, as currently coded, cannot support dynamic topology */ \
753         SCULPT_TOOL_GRAB, \
754         SCULPT_TOOL_ROTATE, \
755         SCULPT_TOOL_CLOTH, \
756         SCULPT_TOOL_THUMB, \
757         SCULPT_TOOL_LAYER, \
758         SCULPT_TOOL_DRAW_SHARP, \
759         SCULPT_TOOL_SLIDE_RELAX, \
760         SCULPT_TOOL_ELASTIC_DEFORM, \
761         SCULPT_TOOL_POSE, \
762         SCULPT_TOOL_DRAW_FACE_SETS, \
763 \
764         /* These brushes could handle dynamic topology, \ \
765          * but user feedback indicates it's better not to */ \
766         SCULPT_TOOL_SMOOTH, \
767         SCULPT_TOOL_MASK) == 0)
768
769 #define SCULPT_TOOL_HAS_TOPOLOGY_RAKE(t) \
770   (ELEM(t, /* These brushes, as currently coded, cannot support topology rake. */ \
771         SCULPT_TOOL_GRAB, \
772         SCULPT_TOOL_ROTATE, \
773         SCULPT_TOOL_THUMB, \
774         SCULPT_TOOL_DRAW_SHARP, \
775         SCULPT_TOOL_SLIDE_RELAX, \
776         SCULPT_TOOL_MASK) == 0)
777
778 /* ImagePaintSettings.tool */
779 typedef enum eBrushImagePaintTool {
780   PAINT_TOOL_DRAW = 0,
781   PAINT_TOOL_SOFTEN = 1,
782   PAINT_TOOL_SMEAR = 2,
783   PAINT_TOOL_CLONE = 3,
784   PAINT_TOOL_FILL = 4,
785   PAINT_TOOL_MASK = 5,
786 } eBrushImagePaintTool;
787
788 typedef enum eBrushVertexPaintTool {
789   VPAINT_TOOL_DRAW = 0,
790   VPAINT_TOOL_BLUR = 1,
791   VPAINT_TOOL_AVERAGE = 2,
792   VPAINT_TOOL_SMEAR = 3,
793 } eBrushVertexPaintTool;
794
795 typedef enum eBrushWeightPaintTool {
796   WPAINT_TOOL_DRAW = 0,
797   WPAINT_TOOL_BLUR = 1,
798   WPAINT_TOOL_AVERAGE = 2,
799   WPAINT_TOOL_SMEAR = 3,
800 } eBrushWeightPaintTool;
801
802 /* BrushGpencilSettings->brush type */
803 typedef enum eBrushGPaintTool {
804   GPAINT_TOOL_DRAW = 0,
805   GPAINT_TOOL_FILL = 1,
806   GPAINT_TOOL_ERASE = 2,
807   GPAINT_TOOL_TINT = 3,
808 } eBrushGPaintTool;
809
810 /* BrushGpencilSettings->brush type */
811 typedef enum eBrushGPVertexTool {
812   GPVERTEX_TOOL_DRAW = 0,
813   GPVERTEX_TOOL_BLUR = 1,
814   GPVERTEX_TOOL_AVERAGE = 2,
815   GPVERTEX_TOOL_TINT = 3,
816   GPVERTEX_TOOL_SMEAR = 4,
817   GPVERTEX_TOOL_REPLACE = 5,
818 } eBrushGPVertexTool;
819
820 /* BrushGpencilSettings->brush type */
821 typedef enum eBrushGPSculptTool {
822   GPSCULPT_TOOL_SMOOTH = 0,
823   GPSCULPT_TOOL_THICKNESS = 1,
824   GPSCULPT_TOOL_STRENGTH = 2,
825   GPSCULPT_TOOL_GRAB = 3,
826   GPSCULPT_TOOL_PUSH = 4,
827   GPSCULPT_TOOL_TWIST = 5,
828   GPSCULPT_TOOL_PINCH = 6,
829   GPSCULPT_TOOL_RANDOMIZE = 7,
830   GPSCULPT_TOOL_CLONE = 8,
831 } eBrushGPSculptTool;
832
833 /* BrushGpencilSettings->brush type */
834 typedef enum eBrushGPWeightTool {
835   GPWEIGHT_TOOL_DRAW = 0,
836 } eBrushGPWeightTool;
837
838 /* direction that the brush displaces along */
839 enum {
840   SCULPT_DISP_DIR_AREA = 0,
841   SCULPT_DISP_DIR_VIEW = 1,
842   SCULPT_DISP_DIR_X = 2,
843   SCULPT_DISP_DIR_Y = 3,
844   SCULPT_DISP_DIR_Z = 4,
845 };
846
847 typedef enum {
848   BRUSH_MASK_DRAW = 0,
849   BRUSH_MASK_SMOOTH = 1,
850 } BrushMaskTool;
851
852 /* blur kernel types, Brush.blur_mode */
853 typedef enum eBlurKernelType {
854   KERNEL_GAUSSIAN = 0,
855   KERNEL_BOX = 1,
856 } eBlurKernelType;
857
858 /* Brush.falloff_shape */
859 enum {
860   PAINT_FALLOFF_SHAPE_SPHERE = 0,
861   PAINT_FALLOFF_SHAPE_TUBE = 1,
862 };
863
864 #define MAX_BRUSH_PIXEL_RADIUS 500
865 #define GP_MAX_BRUSH_PIXEL_RADIUS 1000
866
867 #endif /* __DNA_BRUSH_TYPES_H__ */