DNA_brush_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2005 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_brush_enums.h"
#include "DNA_curve_types.h"
#include "DNA_defs.h"
#include "DNA_texture_types.h" /* for MTex */
 
struct CurveMapping;
struct Image;
struct MTex;
struct Material;
 
typedef struct BrushGpencilSettings {
  float draw_smoothfac;
  float fill_factor;
  float draw_strength;
  float draw_jitter;
  float draw_angle;
  float draw_angle_factor;
  float draw_random_press;
  float draw_random_strength;
  short draw_smoothlvl;
  short draw_subdivide;
  short fill_layer_mode;
  short fill_direction;

  float fill_threshold;
  char _pad2[2];
  /* Type of caps: eGPDstroke_Caps. */
  int8_t caps_type;
  char _pad[1];
 
  int flag2;

  int fill_simplylvl;
  int fill_draw_mode;
  int fill_extend_mode;

  int input_samples;
  float uv_random;
  int brush_type DNA_DEPRECATED;
  int eraser_mode;
  float active_smooth;
  float era_strength_f;
  float era_thickness_f;
  int flag;

  float hardness;
  float aspect_ratio[2];
  float simplify_f;

  float vertex_factor;
  int vertex_mode;

  int sculpt_flag;
  int sculpt_mode_flag;
  short preset_type;
  short brush_draw_mode;

  float random_hue;
  float random_saturation;
  float random_value;
 
  int color_jitter_flag;
  char _pad1[4];

  float fill_extend_fac;
  int dilate_pixels;
 
  struct CurveMapping *curve_sensitivity;
  struct CurveMapping *curve_strength;
  struct CurveMapping *curve_jitter;
  struct CurveMapping *curve_rand_pressure;
  struct CurveMapping *curve_rand_strength;
  struct CurveMapping *curve_rand_uv;
  struct CurveMapping *curve_rand_hue;
  struct CurveMapping *curve_rand_saturation;
  struct CurveMapping *curve_rand_value;

  float outline_fac;
  float simplify_px;
 
  /* optional link of material to replace default in context */
  struct Material *material;
  struct Material *material_alt;
} BrushGpencilSettings;
 
typedef struct BrushCurvesSculptSettings {
  int add_amount;
  int points_per_curve;
  /* eBrushCurvesSculptFlag. */
  uint32_t flag;
  float minimum_length;
  float curve_length;
  float minimum_distance;
  float curve_radius;
  int density_add_attempts;
  uint8_t density_mode;
  char _pad[7];
  struct CurveMapping *curve_parameter_falloff;
} BrushCurvesSculptSettings;

#define AUTOMASKING_BOUNDARY_EDGES_MAX_PROPAGATION_STEPS 20
typedef struct Brush {
#ifdef __cplusplus
  DNA_DEFINE_CXX_METHODS(Brush)
  static constexpr ID_Type id_type = ID_BR;
#endif
 
  ID id;

  struct CurveMapping *curve;
  struct MTex mtex;
  struct MTex mask_mtex;
 
  /* TODO (Sean): To be removed in 5.0 */
  struct Brush *toggle_brush DNA_DEPRECATED;
 
  struct ImBuf *icon_imbuf;
  PreviewImage *preview;
  struct ColorBand *gradient;
  struct PaintCurve *paint_curve;
 
  char icon_filepath[/*FILE_MAX*/ 1024];
 
  float normal_weight;
  float rake_factor;

  short blend;
  short ob_mode;
  float weight;
  int size;
  int flag;
  int flag2;
  int sampling_flag;

  int input_samples;

  int mask_pressure;
  float jitter;
  int jitter_absolute;
  int overlay_flags;
  int spacing;
  int smooth_stroke_radius;
  float smooth_stroke_factor;
  float rate;

  float rgb[3];
  int color_jitter_flag;
  float hsv_jitter[3];

  struct CurveMapping *curve_rand_hue;
  struct CurveMapping *curve_rand_saturation;
  struct CurveMapping *curve_rand_value;

  float alpha;
  float hardness;
  float flow;
  float wet_mix;
  float wet_persistence;
  float density;
  int paint_flags;

  /* Factor that controls the shape of the brush tip by rounding the corners of a square. */
  /* 0.0 value produces a square, 1.0 produces a circle. */
  float tip_roundness;
  float tip_scale_x;

  float secondary_rgb[3];

  float dash_ratio;
  int dash_samples;

  int sculpt_plane;

  float plane_offset;
 
  int gradient_spacing;
  char gradient_stroke_mode;
  char gradient_fill_mode;

  char has_unsaved_changes;

  char falloff_shape;
  float falloff_angle;

  char sculpt_brush_type;
  char vertex_brush_type;
  char weight_brush_type;
  char image_brush_type;
  char mask_tool;
  char gpencil_brush_type;
  char gpencil_vertex_brush_type;
  char gpencil_sculpt_brush_type;
  char gpencil_weight_brush_type;
  char curves_sculpt_brush_type;
  char _pad1[10];
 
  float autosmooth_factor;
 
  float tilt_strength_factor;
 
  float topology_rake_factor;
 
  float crease_pinch_factor;
 
  float normal_radius_factor;
  float area_radius_factor;
  float wet_paint_radius_factor;
 
  float plane_trim;
  float height;
 
  /* Plane Brush */
  float plane_height;
  float plane_depth;
  float stabilize_normal;
  float stabilize_plane;
  int plane_inversion_mode;
 
  float texture_sample_bias;
 
  int curve_preset;
 
  /* Maximum distance to search fake neighbors from a vertex. */
  float disconnected_distance_max;
 
  int deform_target;
 
  /* automasking */
  int automasking_flags;
  int automasking_boundary_edges_propagation_steps;
 
  float automasking_start_normal_limit;
  float automasking_start_normal_falloff;
  float automasking_view_normal_limit;
  float automasking_view_normal_falloff;
 
  int elastic_deform_type;
  float elastic_deform_volume_preservation;
 
  /* snake hook */
  int snake_hook_deform_type;
 
  /* pose */
  int pose_deform_type;
  float pose_offset;
  int pose_smooth_iterations;
  int pose_ik_segments;
  int pose_origin_type;
 
  /* boundary */
  int boundary_deform_type;
  int boundary_falloff_type;
  float boundary_offset;
 
  /* cloth */
  int cloth_deform_type;
  int cloth_force_falloff_type;
  int cloth_simulation_area_type;
 
  float cloth_mass;
  float cloth_damping;
 
  float cloth_sim_limit;
  float cloth_sim_falloff;
 
  float cloth_constraint_softbody_strength;
 
  /* smooth */
  int smooth_deform_type;
  float surface_smooth_shape_preservation;
  float surface_smooth_current_vertex;
  int surface_smooth_iterations;
 
  /* multiplane scrape */
  float multiplane_scrape_angle;
 
  /* smear */
  int smear_deform_type;
 
  /* slide/relax */
  int slide_deform_type;
 
  /* overlay */
  int texture_overlay_alpha;
  int mask_overlay_alpha;
  int cursor_overlay_alpha;
 
  float unprojected_radius;
 
  /* soften/sharpen */
  float sharp_threshold;
  int blur_kernel_radius;
  int blur_mode;
 
  /* fill tool */
  float fill_threshold;
 
  float add_col[4];
  float sub_col[4];
 
  float stencil_pos[2];
  float stencil_dimension[2];
 
  float mask_stencil_pos[2];
  float mask_stencil_dimension[2];
 
  struct BrushGpencilSettings *gpencil_settings;
  struct BrushCurvesSculptSettings *curves_sculpt_settings;
 
  int automasking_cavity_blur_steps;
  float automasking_cavity_factor;
 
  struct CurveMapping *automasking_cavity_curve;
} Brush;
 
/* Struct to hold palette colors for sorting. */
typedef struct tPaletteColorHSV {
  float rgb[3];
  float value;
  float h;
  float s;
  float v;
} tPaletteColorHSV;
 
typedef struct PaletteColor {
  struct PaletteColor *next, *prev;
  /* two values, one to store rgb, other to store values for sculpt/weight */
  float rgb[3];
  float value;
} PaletteColor;
 
typedef struct Palette {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_PAL;
#endif
 
  ID id;

  ListBase colors;
 
  int active_color;
  char _pad[4];
} Palette;
 
typedef struct PaintCurvePoint {
  BezTriple bez;
  float pressure;
} PaintCurvePoint;
 
typedef struct PaintCurve {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_PC;
#endif
 
  ID id;
  PaintCurvePoint *points;
  int tot_points;
  int add_index;
} PaintCurve;