c143c2a442aeedf278a1f06f65978d7a09fdb994
[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 eBrushPoseOriginType {
335   BRUSH_POSE_ORIGIN_TOPOLOGY = 0,
336   BRUSH_POSE_ORIGIN_FACE_SETS = 1,
337 } eBrushPoseOriginType;
338
339 /* Gpencilsettings.Vertex_mode */
340 typedef enum eGp_Vertex_Mode {
341   /* Affect to Stroke only. */
342   GPPAINT_MODE_STROKE = 0,
343   /* Affect to Fill only. */
344   GPPAINT_MODE_FILL = 1,
345   /* Affect to both. */
346   GPPAINT_MODE_BOTH = 2,
347 } eGp_Vertex_Mode;
348
349 /* sculpt_flag */
350 typedef enum eGP_Sculpt_Flag {
351   /* invert the effect of the brush */
352   GP_SCULPT_FLAG_INVERT = (1 << 0),
353   /* smooth brush affects pressure values as well */
354   GP_SCULPT_FLAG_SMOOTH_PRESSURE = (1 << 2),
355   /* temporary invert action */
356   GP_SCULPT_FLAG_TMP_INVERT = (1 << 3),
357 } eGP_Sculpt_Flag;
358
359 /* sculpt_mode_flag */
360 typedef enum eGP_Sculpt_Mode_Flag {
361   /* apply brush to position */
362   GP_SCULPT_FLAGMODE_APPLY_POSITION = (1 << 0),
363   /* apply brush to strength */
364   GP_SCULPT_FLAGMODE_APPLY_STRENGTH = (1 << 1),
365   /* apply brush to thickness */
366   GP_SCULPT_FLAGMODE_APPLY_THICKNESS = (1 << 2),
367   /* apply brush to uv data */
368   GP_SCULPT_FLAGMODE_APPLY_UV = (1 << 3),
369 } eGP_Sculpt_Mode_Flag;
370
371 typedef enum eAutomasking_flag {
372   BRUSH_AUTOMASKING_TOPOLOGY = (1 << 0),
373   BRUSH_AUTOMASKING_FACE_SETS = (1 << 1),
374   BRUSH_AUTOMASKING_BOUNDARY_EDGES = (1 << 2),
375   BRUSH_AUTOMASKING_BOUNDARY_FACE_SETS = (1 << 3),
376 } eAutomasking_flag;
377
378 typedef struct Brush {
379   ID id;
380
381   struct BrushClone clone;
382   /** Falloff curve. */
383   struct CurveMapping *curve;
384   struct MTex mtex;
385   struct MTex mask_mtex;
386
387   struct Brush *toggle_brush;
388
389   struct ImBuf *icon_imbuf;
390   PreviewImage *preview;
391   /** Color gradient. */
392   struct ColorBand *gradient;
393   struct PaintCurve *paint_curve;
394
395   /** 1024 = FILE_MAX. */
396   char icon_filepath[1024];
397
398   float normal_weight;
399   /** Rake actual data (not texture), used for sculpt. */
400   float rake_factor;
401
402   /** Blend mode. */
403   short blend;
404   /** #eObjectMode: to see if the brush is compatible, use for display only. */
405   short ob_mode;
406   /** Brush weight. */
407   float weight;
408   /** Brush diameter. */
409   int size;
410   /** General purpose flags. */
411   int flag;
412   int flag2;
413   int sampling_flag;
414
415   /** Pressure influence for mask. */
416   int mask_pressure;
417   /** Jitter the position of the brush. */
418   float jitter;
419   /** Absolute jitter in pixels. */
420   int jitter_absolute;
421   int overlay_flags;
422   /** Spacing of paint operations. */
423   int spacing;
424   /** Turning radius (in pixels) for smooth stroke. */
425   int smooth_stroke_radius;
426   /** Higher values limit fast changes in the stroke direction. */
427   float smooth_stroke_factor;
428   /** Paint operations / second (airbrush). */
429   float rate;
430
431   /** Color. */
432   float rgb[3];
433   /** Opacity. */
434   float alpha;
435
436   /** Background color. */
437   float secondary_rgb[3];
438
439   /** Rate */
440   float dash_ratio;
441   int dash_samples;
442
443   /** The direction of movement for sculpt vertices. */
444   int sculpt_plane;
445
446   /** Offset for plane brushes (clay, flatten, fill, scrape). */
447   float plane_offset;
448
449   int gradient_spacing;
450   /** Source for stroke color gradient application. */
451   char gradient_stroke_mode;
452   /** Source for fill tool color gradient application. */
453   char gradient_fill_mode;
454
455   char _pad0[1];
456
457   /** Projection shape (sphere, circle). */
458   char falloff_shape;
459   float falloff_angle;
460
461   /** Active sculpt tool. */
462   char sculpt_tool;
463   /** Active sculpt tool. */
464   char uv_sculpt_tool;
465   /** Active vertex paint. */
466   char vertexpaint_tool;
467   /** Active weight paint. */
468   char weightpaint_tool;
469   /** Active image paint tool. */
470   char imagepaint_tool;
471   /** Enum eBrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK. */
472   char mask_tool;
473   /** Active grease pencil tool. */
474   char gpencil_tool;
475   /** Active grease pencil vertex tool. */
476   char gpencil_vertex_tool;
477   /** Active grease pencil sculpt tool. */
478   char gpencil_sculpt_tool;
479   /** Active grease pencil weight tool. */
480   char gpencil_weight_tool;
481   char _pad1[6];
482
483   float autosmooth_factor;
484
485   float topology_rake_factor;
486
487   float crease_pinch_factor;
488
489   float normal_radius_factor;
490   float area_radius_factor;
491
492   float plane_trim;
493   /** Affectable height of brush (layer height for layer tool, i.e.). */
494   float height;
495
496   float texture_sample_bias;
497
498   int curve_preset;
499   float hardness;
500
501   /* automasking */
502   int automasking_flags;
503   int automasking_boundary_edges_propagation_steps;
504
505   /* Factor that controls the shape of the brush tip by rounding the corners of a square. */
506   /* 0.0 value produces a square, 1.0 produces a circle. */
507   float tip_roundness;
508
509   int elastic_deform_type;
510   float elastic_deform_volume_preservation;
511
512   /* pose */
513   float pose_offset;
514   int pose_smooth_iterations;
515   int pose_ik_segments;
516   int pose_origin_type;
517
518   /* cloth */
519   int cloth_deform_type;
520   int cloth_force_falloff_type;
521
522   float cloth_mass;
523   float cloth_damping;
524
525   float cloth_sim_limit;
526   float cloth_sim_falloff;
527
528   /* smooth */
529   int smooth_deform_type;
530   float surface_smooth_shape_preservation;
531   float surface_smooth_current_vertex;
532   int surface_smooth_iterations;
533
534   /* multiplane scrape */
535   float multiplane_scrape_angle;
536
537   /* overlay */
538   int texture_overlay_alpha;
539   int mask_overlay_alpha;
540   int cursor_overlay_alpha;
541
542   float unprojected_radius;
543
544   /* soften/sharpen */
545   float sharp_threshold;
546   int blur_kernel_radius;
547   int blur_mode;
548
549   /* fill tool */
550   float fill_threshold;
551
552   float add_col[4];
553   float sub_col[4];
554
555   float stencil_pos[2];
556   float stencil_dimension[2];
557
558   float mask_stencil_pos[2];
559   float mask_stencil_dimension[2];
560
561   struct BrushGpencilSettings *gpencil_settings;
562
563 } Brush;
564
565 /* Struct to hold palette colors for sorting. */
566 typedef struct tPaletteColorHSV {
567   float rgb[3];
568   float value;
569   float h;
570   float s;
571   float v;
572 } tPaletteColorHSV;
573
574 typedef struct PaletteColor {
575   struct PaletteColor *next, *prev;
576   /* two values, one to store rgb, other to store values for sculpt/weight */
577   float rgb[3];
578   float value;
579 } PaletteColor;
580
581 typedef struct Palette {
582   ID id;
583
584   /** Pointer to individual colors. */
585   ListBase colors;
586
587   int active_color;
588   char _pad[4];
589 } Palette;
590
591 typedef struct PaintCurvePoint {
592   /** Bezier handle. */
593   BezTriple bez;
594   /** Pressure on that point. */
595   float pressure;
596 } PaintCurvePoint;
597
598 typedef struct PaintCurve {
599   ID id;
600   /** Points of curve. */
601   PaintCurvePoint *points;
602   int tot_points;
603   /** Index where next point will be added. */
604   int add_index;
605 } PaintCurve;
606
607 /* Brush.gradient_source */
608 typedef enum eBrushGradientSourceStroke {
609   BRUSH_GRADIENT_PRESSURE = 0,       /* gradient from pressure */
610   BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
611   BRUSH_GRADIENT_SPACING_CLAMP = 2,  /* gradient from spacing */
612 } eBrushGradientSourceStroke;
613
614 typedef enum eBrushGradientSourceFill {
615   BRUSH_GRADIENT_LINEAR = 0, /* gradient from pressure */
616   BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
617 } eBrushGradientSourceFill;
618
619 /* Brush.flag */
620 typedef enum eBrushFlags {
621   BRUSH_AIRBRUSH = (1 << 0),
622   BRUSH_INVERT_TO_SCRAPE_FILL = (1 << 1),
623   BRUSH_ALPHA_PRESSURE = (1 << 2),
624   BRUSH_SIZE_PRESSURE = (1 << 3),
625   BRUSH_JITTER_PRESSURE = (1 << 4),
626   BRUSH_SPACING_PRESSURE = (1 << 5),
627   BRUSH_ORIGINAL_PLANE = (1 << 6),
628   BRUSH_GRAB_ACTIVE_VERTEX = (1 << 7),
629   BRUSH_ANCHORED = (1 << 8),
630   BRUSH_DIR_IN = (1 << 9),
631   BRUSH_SPACE = (1 << 10),
632   BRUSH_SMOOTH_STROKE = (1 << 11),
633   BRUSH_PERSISTENT = (1 << 12),
634   BRUSH_ACCUMULATE = (1 << 13),
635   BRUSH_LOCK_ALPHA = (1 << 14),
636   BRUSH_ORIGINAL_NORMAL = (1 << 15),
637   BRUSH_OFFSET_PRESSURE = (1 << 16),
638   BRUSH_SCENE_SPACING = (1 << 17),
639   BRUSH_SPACE_ATTEN = (1 << 18),
640   BRUSH_ADAPTIVE_SPACE = (1 << 19),
641   BRUSH_LOCK_SIZE = (1 << 20),
642   BRUSH_USE_GRADIENT = (1 << 21),
643   BRUSH_EDGE_TO_EDGE = (1 << 22),
644   BRUSH_DRAG_DOT = (1 << 23),
645   BRUSH_INVERSE_SMOOTH_PRESSURE = (1 << 24),
646   BRUSH_FRONTFACE_FALLOFF = (1 << 25),
647   BRUSH_PLANE_TRIM = (1 << 26),
648   BRUSH_FRONTFACE = (1 << 27),
649   BRUSH_CUSTOM_ICON = (1 << 28),
650   BRUSH_LINE = (1 << 29),
651   BRUSH_ABSOLUTE_JITTER = (1 << 30),
652   BRUSH_CURVE = (1u << 31),
653 } eBrushFlags;
654
655 /* Brush.sampling_flag */
656 typedef enum eBrushSamplingFlags {
657   BRUSH_PAINT_ANTIALIASING = (1 << 0),
658 } eBrushSamplingFlags;
659
660 /* Brush.flag2 */
661 typedef enum eBrushFlags2 {
662   BRUSH_MULTIPLANE_SCRAPE_DYNAMIC = (1 << 0),
663   BRUSH_MULTIPLANE_SCRAPE_PLANES_PREVIEW = (1 << 1),
664   BRUSH_POSE_IK_ANCHORED = (1 << 2),
665 } eBrushFlags2;
666
667 typedef enum {
668   BRUSH_MASK_PRESSURE_RAMP = (1 << 1),
669   BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2),
670 } BrushMaskPressureFlags;
671
672 /* Brush.overlay_flags */
673 typedef enum eOverlayFlags {
674   BRUSH_OVERLAY_CURSOR = (1),
675   BRUSH_OVERLAY_PRIMARY = (1 << 1),
676   BRUSH_OVERLAY_SECONDARY = (1 << 2),
677   BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE = (1 << 3),
678   BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE = (1 << 4),
679   BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE = (1 << 5),
680 } eOverlayFlags;
681
682 #define BRUSH_OVERLAY_OVERRIDE_MASK \
683   (BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
684    BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
685
686 /* Brush.sculpt_tool */
687 typedef enum eBrushSculptTool {
688   SCULPT_TOOL_DRAW = 1,
689   SCULPT_TOOL_SMOOTH = 2,
690   SCULPT_TOOL_PINCH = 3,
691   SCULPT_TOOL_INFLATE = 4,
692   SCULPT_TOOL_GRAB = 5,
693   SCULPT_TOOL_LAYER = 6,
694   SCULPT_TOOL_FLATTEN = 7,
695   SCULPT_TOOL_CLAY = 8,
696   SCULPT_TOOL_FILL = 9,
697   SCULPT_TOOL_SCRAPE = 10,
698   SCULPT_TOOL_NUDGE = 11,
699   SCULPT_TOOL_THUMB = 12,
700   SCULPT_TOOL_SNAKE_HOOK = 13,
701   SCULPT_TOOL_ROTATE = 14,
702   SCULPT_TOOL_SIMPLIFY = 15,
703   SCULPT_TOOL_CREASE = 16,
704   SCULPT_TOOL_BLOB = 17,
705   SCULPT_TOOL_CLAY_STRIPS = 18,
706   SCULPT_TOOL_MASK = 19,
707   SCULPT_TOOL_DRAW_SHARP = 20,
708   SCULPT_TOOL_ELASTIC_DEFORM = 21,
709   SCULPT_TOOL_POSE = 22,
710   SCULPT_TOOL_MULTIPLANE_SCRAPE = 23,
711   SCULPT_TOOL_SLIDE_RELAX = 24,
712   SCULPT_TOOL_CLAY_THUMB = 25,
713   SCULPT_TOOL_CLOTH = 26,
714   SCULPT_TOOL_DRAW_FACE_SETS = 27,
715 } eBrushSculptTool;
716
717 /* Brush.uv_sculpt_tool */
718 typedef enum eBrushUVSculptTool {
719   UV_SCULPT_TOOL_GRAB = 0,
720   UV_SCULPT_TOOL_RELAX = 1,
721   UV_SCULPT_TOOL_PINCH = 2,
722 } eBrushUVSculptTool;
723
724 /** When #BRUSH_ACCUMULATE is used */
725 #define SCULPT_TOOL_HAS_ACCUMULATE(t) \
726   ELEM(t, \
727        SCULPT_TOOL_DRAW, \
728        SCULPT_TOOL_DRAW_SHARP, \
729        SCULPT_TOOL_SLIDE_RELAX, \
730        SCULPT_TOOL_CREASE, \
731        SCULPT_TOOL_BLOB, \
732        SCULPT_TOOL_INFLATE, \
733        SCULPT_TOOL_CLAY, \
734        SCULPT_TOOL_CLAY_STRIPS, \
735        SCULPT_TOOL_CLAY_THUMB, \
736        SCULPT_TOOL_ROTATE, \
737        SCULPT_TOOL_SCRAPE, \
738        SCULPT_TOOL_FLATTEN)
739
740 #define SCULPT_TOOL_HAS_NORMAL_WEIGHT(t) \
741   ELEM(t, SCULPT_TOOL_GRAB, SCULPT_TOOL_SNAKE_HOOK, SCULPT_TOOL_ELASTIC_DEFORM)
742
743 #define SCULPT_TOOL_HAS_RAKE(t) ELEM(t, SCULPT_TOOL_SNAKE_HOOK)
744
745 #define SCULPT_TOOL_HAS_DYNTOPO(t) \
746   (ELEM(t, /* These brushes, as currently coded, cannot support dynamic topology */ \
747         SCULPT_TOOL_GRAB, \
748         SCULPT_TOOL_ROTATE, \
749         SCULPT_TOOL_CLOTH, \
750         SCULPT_TOOL_THUMB, \
751         SCULPT_TOOL_LAYER, \
752         SCULPT_TOOL_DRAW_SHARP, \
753         SCULPT_TOOL_SLIDE_RELAX, \
754         SCULPT_TOOL_ELASTIC_DEFORM, \
755         SCULPT_TOOL_POSE, \
756         SCULPT_TOOL_DRAW_FACE_SETS, \
757 \
758         /* These brushes could handle dynamic topology, \ \
759          * but user feedback indicates it's better not to */ \
760         SCULPT_TOOL_SMOOTH, \
761         SCULPT_TOOL_MASK) == 0)
762
763 #define SCULPT_TOOL_HAS_TOPOLOGY_RAKE(t) \
764   (ELEM(t, /* These brushes, as currently coded, cannot support topology rake. */ \
765         SCULPT_TOOL_GRAB, \
766         SCULPT_TOOL_ROTATE, \
767         SCULPT_TOOL_THUMB, \
768         SCULPT_TOOL_DRAW_SHARP, \
769         SCULPT_TOOL_SLIDE_RELAX, \
770         SCULPT_TOOL_MASK) == 0)
771
772 /* ImagePaintSettings.tool */
773 typedef enum eBrushImagePaintTool {
774   PAINT_TOOL_DRAW = 0,
775   PAINT_TOOL_SOFTEN = 1,
776   PAINT_TOOL_SMEAR = 2,
777   PAINT_TOOL_CLONE = 3,
778   PAINT_TOOL_FILL = 4,
779   PAINT_TOOL_MASK = 5,
780 } eBrushImagePaintTool;
781
782 typedef enum eBrushVertexPaintTool {
783   VPAINT_TOOL_DRAW = 0,
784   VPAINT_TOOL_BLUR = 1,
785   VPAINT_TOOL_AVERAGE = 2,
786   VPAINT_TOOL_SMEAR = 3,
787 } eBrushVertexPaintTool;
788
789 typedef enum eBrushWeightPaintTool {
790   WPAINT_TOOL_DRAW = 0,
791   WPAINT_TOOL_BLUR = 1,
792   WPAINT_TOOL_AVERAGE = 2,
793   WPAINT_TOOL_SMEAR = 3,
794 } eBrushWeightPaintTool;
795
796 /* BrushGpencilSettings->brush type */
797 typedef enum eBrushGPaintTool {
798   GPAINT_TOOL_DRAW = 0,
799   GPAINT_TOOL_FILL = 1,
800   GPAINT_TOOL_ERASE = 2,
801   GPAINT_TOOL_TINT = 3,
802 } eBrushGPaintTool;
803
804 /* BrushGpencilSettings->brush type */
805 typedef enum eBrushGPVertexTool {
806   GPVERTEX_TOOL_DRAW = 0,
807   GPVERTEX_TOOL_BLUR = 1,
808   GPVERTEX_TOOL_AVERAGE = 2,
809   GPVERTEX_TOOL_TINT = 3,
810   GPVERTEX_TOOL_SMEAR = 4,
811   GPVERTEX_TOOL_REPLACE = 5,
812 } eBrushGPVertexTool;
813
814 /* BrushGpencilSettings->brush type */
815 typedef enum eBrushGPSculptTool {
816   GPSCULPT_TOOL_SMOOTH = 0,
817   GPSCULPT_TOOL_THICKNESS = 1,
818   GPSCULPT_TOOL_STRENGTH = 2,
819   GPSCULPT_TOOL_GRAB = 3,
820   GPSCULPT_TOOL_PUSH = 4,
821   GPSCULPT_TOOL_TWIST = 5,
822   GPSCULPT_TOOL_PINCH = 6,
823   GPSCULPT_TOOL_RANDOMIZE = 7,
824   GPSCULPT_TOOL_CLONE = 8,
825 } eBrushGPSculptTool;
826
827 /* BrushGpencilSettings->brush type */
828 typedef enum eBrushGPWeightTool {
829   GPWEIGHT_TOOL_DRAW = 0,
830 } eBrushGPWeightTool;
831
832 /* direction that the brush displaces along */
833 enum {
834   SCULPT_DISP_DIR_AREA = 0,
835   SCULPT_DISP_DIR_VIEW = 1,
836   SCULPT_DISP_DIR_X = 2,
837   SCULPT_DISP_DIR_Y = 3,
838   SCULPT_DISP_DIR_Z = 4,
839 };
840
841 typedef enum {
842   BRUSH_MASK_DRAW = 0,
843   BRUSH_MASK_SMOOTH = 1,
844 } BrushMaskTool;
845
846 /* blur kernel types, Brush.blur_mode */
847 typedef enum eBlurKernelType {
848   KERNEL_GAUSSIAN = 0,
849   KERNEL_BOX = 1,
850 } eBlurKernelType;
851
852 /* Brush.falloff_shape */
853 enum {
854   PAINT_FALLOFF_SHAPE_SPHERE = 0,
855   PAINT_FALLOFF_SHAPE_TUBE = 1,
856 };
857
858 #define MAX_BRUSH_PIXEL_RADIUS 500
859 #define GP_MAX_BRUSH_PIXEL_RADIUS 1000
860
861 #endif /* __DNA_BRUSH_TYPES_H__ */