Blender V4.3
ToolSettings Struct Reference

#include <DNA_scene_types.h>

Public Attributes

VPaintvpaint
 
VPaintwpaint
 
Sculptsculpt
 
UvSculpt uvsculpt
 
GpPaintgp_paint
 
GpVertexPaintgp_vertexpaint
 
GpSculptPaintgp_sculptpaint
 
GpWeightPaintgp_weightpaint
 
CurvesSculptcurves_sculpt
 
float vgroup_weight
 
float doublimit
 
char automerge
 
char object_flag
 
char selectmode
 
char unwrapper
 
char uvcalc_flag
 
char uv_flag
 
char uv_selectmode
 
char uv_sticky
 
float uvcalc_margin
 
int uvcalc_iterations
 
float uvcalc_weight_factor
 
char uvcalc_weight_group [64]
 
short autoik_chainlen
 
char gpencil_flags
 
char gpencil_v3d_align
 
char gpencil_v2d_align
 
char annotate_v3d_align
 
short annotate_thickness
 
float gpencil_surface_offset
 
char gpencil_selectmode_edit
 
char gpencil_selectmode_sculpt
 
char _pad0 [6]
 
struct GP_Sculpt_Settings gp_sculpt
 
struct GP_Interpolate_Settings gp_interpolate
 
struct ImagePaintSettings imapaint
 
struct PaintModeSettings paint_mode
 
struct ParticleEditSettings particle
 
float proportional_size
 
float select_thresh
 
short keying_flag
 
char autokey_mode
 
char keyframe_type
 
char multires_subdiv_type
 
char edge_mode
 
char edge_mode_live_unwrap
 
char transform_pivot_point
 
char transform_flag
 
char snap_node_mode
 
short snap_mode
 
short snap_uv_mode
 
short snap_anim_mode
 
short snap_flag
 
short snap_flag_node
 
short snap_flag_seq
 
short snap_flag_anim
 
short snap_uv_flag
 
char _pad [4]
 
char snap_target
 
char snap_transform_mode_flag
 
short snap_face_nearest_steps
 
char proportional_edit
 
char prop_mode
 
char proportional_objects
 
char proportional_mask
 
char proportional_action
 
char proportional_fcurve
 
char lock_markers
 
char auto_normalize
 
char wpaint_lock_relative
 
char multipaint
 
char weightuser
 
char vgroupsubset
 
char gpencil_selectmode_vertex
 
char uv_sculpt_settings
 
char workspace_tool_type
 
char _pad5 [1]
 
short sculpt_paint_settings DNA_DEPRECATED
 
int sculpt_paint_unified_size DNA_DEPRECATED
 
float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED
 
float sculpt_paint_unified_alpha DNA_DEPRECATED
 
struct UnifiedPaintSettings unified_paint_settings
 
struct CurvePaintSettings curve_paint_settings
 
struct MeshStatVis statvis
 
float normal_vector [3]
 
char _pad6 [4]
 
struct CurveProfilecustom_bevel_profile_preset
 
struct SequencerToolSettingssequencer_tool_settings
 
short snap_mode_tools
 
char plane_axis
 
char plane_depth
 
char plane_orient
 
char use_plane_axis_auto
 
char _pad7 [2]
 
float snap_angle_increment_2d
 
float snap_angle_increment_2d_precision
 
float snap_angle_increment_3d
 
float snap_angle_increment_3d_precision
 

Detailed Description

Definition at line 1564 of file DNA_scene_types.h.

Member Data Documentation

◆ _pad

char ToolSettings::_pad[4]

Definition at line 1698 of file DNA_scene_types.h.

◆ _pad0

char ToolSettings::_pad0[6]

Definition at line 1645 of file DNA_scene_types.h.

◆ _pad5

char ToolSettings::_pad5[1]

Definition at line 1742 of file DNA_scene_types.h.

◆ _pad6

char ToolSettings::_pad6[4]

Definition at line 1762 of file DNA_scene_types.h.

◆ _pad7

char ToolSettings::_pad7[2]

Definition at line 1778 of file DNA_scene_types.h.

◆ annotate_thickness

short ToolSettings::annotate_thickness

Default stroke thickness for annotation strokes.

Definition at line 1636 of file DNA_scene_types.h.

◆ annotate_v3d_align

char ToolSettings::annotate_v3d_align

Stroke placement settings - 3D View.

Definition at line 1634 of file DNA_scene_types.h.

Referenced by annotation_paint_strokeend(), annotation_session_initdata(), annotation_stroke_addpoint(), and annotation_stroke_newfrombuffer().

◆ auto_normalize

◆ autoik_chainlen

short ToolSettings::autoik_chainlen

Runtime only.

Definition at line 1621 of file DNA_scene_types.h.

Referenced by headerTranslation(), and transform_autoik_update().

◆ autokey_mode

char ToolSettings::autokey_mode

Definition at line 1671 of file DNA_scene_types.h.

Referenced by blo_do_versions_250().

◆ automerge

char ToolSettings::automerge

Definition at line 1588 of file DNA_scene_types.h.

Referenced by initTransInfo().

◆ curve_paint_settings

◆ curves_sculpt

◆ custom_bevel_profile_preset

struct CurveProfile* ToolSettings::custom_bevel_profile_preset

Custom Curve Profile for bevel tool: Temporary until there is a proper preset system that stores the profiles or maybe stores entire bevel configurations.

Definition at line 1769 of file DNA_scene_types.h.

Referenced by BKE_toolsettings_copy(), BKE_toolsettings_free(), blo_do_versions_280(), blo_update_defaults_scene(), edbm_bevel_init(), scene_blend_read_data(), and scene_blend_write().

◆ DNA_DEPRECATED [1/4]

short sculpt_paint_settings ToolSettings::DNA_DEPRECATED

XXX: these sculpt_paint_* fields are deprecated, use the unified_paint_settings field instead!

Definition at line 1748 of file DNA_scene_types.h.

◆ DNA_DEPRECATED [2/4]

int sculpt_paint_unified_size ToolSettings::DNA_DEPRECATED

Definition at line 1749 of file DNA_scene_types.h.

◆ DNA_DEPRECATED [3/4]

float sculpt_paint_unified_unprojected_radius ToolSettings::DNA_DEPRECATED

Definition at line 1750 of file DNA_scene_types.h.

◆ DNA_DEPRECATED [4/4]

float sculpt_paint_unified_alpha ToolSettings::DNA_DEPRECATED

Definition at line 1751 of file DNA_scene_types.h.

◆ doublimit

float ToolSettings::doublimit

Remove doubles limit.

Definition at line 1587 of file DNA_scene_types.h.

Referenced by blo_do_versions_pre250(), and special_aftertrans_update__mesh().

◆ edge_mode

char ToolSettings::edge_mode

Edge tagging, store operator settings (no UI access).

Definition at line 1679 of file DNA_scene_types.h.

Referenced by path_select_params_from_op().

◆ edge_mode_live_unwrap

char ToolSettings::edge_mode_live_unwrap

Definition at line 1681 of file DNA_scene_types.h.

◆ gp_interpolate

◆ gp_paint

◆ gp_sculpt

◆ gp_sculptpaint

◆ gp_vertexpaint

◆ gp_weightpaint

◆ gpencil_flags

◆ gpencil_selectmode_edit

◆ gpencil_selectmode_sculpt

◆ gpencil_selectmode_vertex

char ToolSettings::gpencil_selectmode_vertex

◆ gpencil_surface_offset

float ToolSettings::gpencil_surface_offset

Normal offset used when drawing on surfaces.

Definition at line 1639 of file DNA_scene_types.h.

◆ gpencil_v2d_align

char ToolSettings::gpencil_v2d_align

General 2D Editor.

Definition at line 1630 of file DNA_scene_types.h.

Referenced by annotation_session_initdata(), blo_do_versions_270(), and blo_do_versions_300().

◆ gpencil_v3d_align

char ToolSettings::gpencil_v3d_align

◆ imapaint

◆ keyframe_type

◆ keying_flag

short ToolSettings::keying_flag

Defines in DNA_userdef_types.h.

Definition at line 1670 of file DNA_scene_types.h.

◆ lock_markers

char ToolSettings::lock_markers

◆ multipaint

char ToolSettings::multipaint

Paint multiple bones in wpaint.

Definition at line 1729 of file DNA_scene_types.h.

Referenced by blender::draw::drw_mesh_weight_state_extract(), weight_sample_invoke(), and wpaint_stroke_test_start().

◆ multires_subdiv_type

char ToolSettings::multires_subdiv_type

Multi-resolution meshes.

Definition at line 1676 of file DNA_scene_types.h.

◆ normal_vector

float ToolSettings::normal_vector[3]

Normal Editing.

Definition at line 1761 of file DNA_scene_types.h.

◆ object_flag

char ToolSettings::object_flag

◆ paint_mode

◆ particle

◆ plane_axis

char ToolSettings::plane_axis

Definition at line 1774 of file DNA_scene_types.h.

Referenced by v3d_cursor_snap_update(), and view3d_interactive_add_begin().

◆ plane_depth

char ToolSettings::plane_depth

Definition at line 1775 of file DNA_scene_types.h.

Referenced by v3d_cursor_snap_update().

◆ plane_orient

char ToolSettings::plane_orient

Definition at line 1776 of file DNA_scene_types.h.

Referenced by v3d_cursor_snap_update().

◆ prop_mode

char ToolSettings::prop_mode

Definition at line 1711 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_action

char ToolSettings::proportional_action

Proportional edit, action editor.

Definition at line 1717 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_edit

char ToolSettings::proportional_edit

Definition at line 1711 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_fcurve

char ToolSettings::proportional_fcurve

Proportional edit, graph editor.

Definition at line 1719 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_mask

char ToolSettings::proportional_mask

Proportional edit, mask editing.

Definition at line 1715 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_objects

char ToolSettings::proportional_objects

Proportional edit, object mode.

Definition at line 1713 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ proportional_size

float ToolSettings::proportional_size

Transform Proportional Area of Effect.

Definition at line 1663 of file DNA_scene_types.h.

Referenced by saveTransform().

◆ sculpt

Sculpt* ToolSettings::sculpt

Definition at line 1569 of file DNA_scene_types.h.

Referenced by BKE_paint_brushes_set_default_references(), BKE_paint_ensure(), BKE_paint_ensure_from_paintmode(), BKE_paint_get_active(), BKE_paint_get_active_from_paintmode(), BKE_toolsettings_copy(), BKE_toolsettings_free(), blo_do_versions_260(), blo_do_versions_270(), blo_do_versions_280(), blo_update_defaults_scene(), brush_stroke_init(), blender::ed::sculpt_paint::expand::cache_initial_config_set(), blender::ed::sculpt_paint::trim::calculate_depth(), do_version_curvemapping_walker(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_edit_invoke(), blender::ed::sculpt_paint::dyntopo::dyntopo_detail_size_edit_modal(), blender::ed::sculpt_paint::face_set::edit_modify_coordinates(), blender::ed::sculpt_paint::project::gesture_apply_for_symmetry_pass(), blender::ed::sculpt_paint::init_transform(), blender::ed::sculpt_paint::mask::mask_from_boundary_exec(), blender::ed::sculpt_paint::mask::mask_from_cavity_exec(), over_mesh(), OVERLAY_engine_init(), blender::ed::sculpt_paint::paint_cursor_sculpt_session_update_and_init(), blender::ed::sculpt_paint::paint_cursor_update_pixel_radius(), paint_runtime_init(), blender::ed::sculpt_paint::sample_color_invoke(), blender::ed::sculpt_paint::dyntopo::sample_detail_dyntopo(), scene_blend_read_data(), scene_blend_write(), scene_foreach_toolsettings(), blender::ed::sculpt_paint::dyntopo::sculpt_and_constant_or_manual_detail_poll(), blender::ed::sculpt_paint::sculpt_brush_stroke_cancel(), blender::ed::sculpt_paint::sculpt_brush_stroke_invoke(), blender::ed::sculpt_paint::cloth::sculpt_cloth_filter_invoke(), blender::ed::sculpt_paint::cloth::sculpt_cloth_filter_modal(), blender::ed::sculpt_paint::color::sculpt_color_filter_init(), blender::ed::sculpt_paint::dyntopo::sculpt_detail_flood_fill_exec(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_apply(), blender::ed::sculpt_paint::filter::sculpt_mesh_filter_start(), blender::ed::sculpt_paint::sculpt_mode_toggle_exec(), SCULPT_stroke_modifiers_check(), blender::ed::sculpt_paint::stroke_done(), blender::ed::sculpt_paint::stroke_test_start(), stroke_undo_begin(), blender::ed::sculpt_paint::stroke_update_step(), blender::ed::sculpt_paint::symmetrize_exec(), and blender::ed::sculpt_paint::update_modal_transform().

◆ select_thresh

float ToolSettings::select_thresh

Select Group Threshold.

Definition at line 1666 of file DNA_scene_types.h.

Referenced by blo_do_versions_pre250(), edbm_select_similar_exec(), and uv_select_similar_exec().

◆ selectmode

◆ sequencer_tool_settings

struct SequencerToolSettings* ToolSettings::sequencer_tool_settings

◆ snap_angle_increment_2d

float ToolSettings::snap_angle_increment_2d

Rotation Angle snapping amount

Definition at line 1781 of file DNA_scene_types.h.

Referenced by get_snap_angle(), and initSnapAngleIncrements().

◆ snap_angle_increment_2d_precision

float ToolSettings::snap_angle_increment_2d_precision

Definition at line 1782 of file DNA_scene_types.h.

Referenced by get_snap_angle(), and initSnapAngleIncrements().

◆ snap_angle_increment_3d

float ToolSettings::snap_angle_increment_3d

Definition at line 1783 of file DNA_scene_types.h.

Referenced by get_snap_angle(), and initSnapAngleIncrements().

◆ snap_angle_increment_3d_precision

float ToolSettings::snap_angle_increment_3d_precision

Definition at line 1784 of file DNA_scene_types.h.

Referenced by get_snap_angle(), and initSnapAngleIncrements().

◆ snap_anim_mode

short ToolSettings::snap_anim_mode

Definition at line 1691 of file DNA_scene_types.h.

Referenced by snap_mode_from_spacetype().

◆ snap_face_nearest_steps

short ToolSettings::snap_face_nearest_steps

Steps to break transformation into with face nearest snapping.

Definition at line 1709 of file DNA_scene_types.h.

Referenced by blo_do_versions_300(), and initSnapping().

◆ snap_flag

◆ snap_flag_anim

short ToolSettings::snap_flag_anim

Definition at line 1696 of file DNA_scene_types.h.

Referenced by transform_snap_flag_from_spacetype_ptr().

◆ snap_flag_node

short ToolSettings::snap_flag_node

◆ snap_flag_seq

short ToolSettings::snap_flag_seq

◆ snap_mode

◆ snap_mode_tools

short ToolSettings::snap_mode_tools

◆ snap_node_mode

char ToolSettings::snap_node_mode

Snap elements (per space-type), eSnapMode.

Definition at line 1688 of file DNA_scene_types.h.

Referenced by blo_do_versions_300(), snap_mode_from_spacetype(), and snapNode().

◆ snap_target

char ToolSettings::snap_target

Default snap source, eSnapSourceOP. TODO(@gfxcoder): Rename snap_target to snap_source to avoid previous ambiguity of "target" (now, "source" is geometry to be moved and "target" is geometry to which moved geometry is snapped).

Definition at line 1705 of file DNA_scene_types.h.

Referenced by initSnapping().

◆ snap_transform_mode_flag

char ToolSettings::snap_transform_mode_flag

Snap mask for transform modes, eSnapTransformMode.

Definition at line 1707 of file DNA_scene_types.h.

Referenced by transformModeUseSnap().

◆ snap_uv_flag

short ToolSettings::snap_uv_flag

◆ snap_uv_mode

short ToolSettings::snap_uv_mode

Definition at line 1690 of file DNA_scene_types.h.

Referenced by blo_do_versions_300(), and snap_mode_from_spacetype().

◆ statvis

◆ transform_flag

char ToolSettings::transform_flag

◆ transform_pivot_point

char ToolSettings::transform_pivot_point

◆ unified_paint_settings

◆ unwrapper

char ToolSettings::unwrapper

◆ use_plane_axis_auto

char ToolSettings::use_plane_axis_auto

Definition at line 1777 of file DNA_scene_types.h.

Referenced by v3d_cursor_snap_update().

◆ uv_flag

char ToolSettings::uv_flag

Definition at line 1599 of file DNA_scene_types.h.

Referenced by average_islands_scale_exec(), blender::draw::overlay::MeshUVs::begin_sync(), do_lasso_select_mesh_uv(), blender::draw::DRW_mesh_batch_cache_create_requested(), ED_uvedit_select_mode_get(), ED_uvedit_select_sync_flush(), ED_uvedit_selectmode_clean(), ED_uvedit_selectmode_flush(), edbm_select_mode_invoke(), blender::draw::extract_edituv_face_dots(), blender::draw::extract_edituv_lines(), blender::draw::extract_edituv_lines_subdiv(), blender::draw::extract_edituv_points(), blender::draw::extract_edituv_points_subdiv(), blender::draw::extract_edituv_tris(), blender::draw::extract_edituv_tris_subdiv(), image_main_region_listener(), minimize_stretch_exit(), minimize_stretch_iteration(), OVERLAY_edit_uv_cache_init(), OVERLAY_edit_uv_init(), stitch_exit(), stitch_init(), stitch_init_all(), stitch_invoke(), uv_box_select_exec(), uv_circle_select_exec(), uv_hide_exec(), uv_mark_seam_exec(), uv_mouse_select_loop_generic_multi(), uv_mouse_select_multi(), uv_pin_exec(), uv_remove_doubles_to_selected(), uv_reveal_exec(), uv_select_all_perform(), uv_select_edgering(), uv_select_flush_from_loop_edge_flag(), uv_select_flush_from_tag_face(), uv_select_flush_from_tag_loop(), uv_select_invert(), uv_select_linked_internal(), uv_select_mode_invoke(), uv_select_more_less(), uv_select_pinned_exec(), uv_select_similar_exec(), uv_select_similar_type_itemf(), uv_select_split_exec(), uv_select_tag_update_for_object(), uv_shortest_path_pick_ex(), uv_shortest_path_pick_invoke(), uv_snap_selection_exec(), uv_weld_align(), uvedit_deselect_flush(), uvedit_edge_select_disable(), uvedit_edge_select_enable(), uvedit_edge_select_set_with_sticky(), uvedit_edge_select_test_ex(), uvedit_face_select_disable(), uvedit_face_select_enable(), uvedit_face_select_set_with_sticky(), uvedit_face_select_test_ex(), uvedit_face_visible_test_ex(), uvedit_select_flush(), uvedit_select_is_any_selected(), uvedit_uv_select_disable(), uvedit_uv_select_enable(), uvedit_uv_select_set_with_sticky(), and uvedit_uv_select_test_ex().

◆ uv_sculpt_settings

char ToolSettings::uv_sculpt_settings

Definition at line 1738 of file DNA_scene_types.h.

Referenced by uv_sculpt_stroke_init().

◆ uv_selectmode

◆ uv_sticky

◆ uvcalc_flag

◆ uvcalc_iterations

int ToolSettings::uvcalc_iterations

◆ uvcalc_margin

float ToolSettings::uvcalc_margin

Definition at line 1603 of file DNA_scene_types.h.

Referenced by unwrap_options_sync_toolsettings().

◆ uvcalc_weight_factor

float ToolSettings::uvcalc_weight_factor

◆ uvcalc_weight_group

char ToolSettings::uvcalc_weight_group[64]

Regarding having a single vertex group for all meshes. In most cases there is no expectation for the names used for vertex groups. UV weights is a fairly specific feature for unwrapping and in this case users are expected to use the name uv_importance. While we could support setting a different group per mesh (similar to the active group). This isn't all that useful in practice, so use a "default" name instead. This approach may be reworked after gathering feedback from users.

Definition at line 1617 of file DNA_scene_types.h.

Referenced by unwrap_options_get(), unwrap_options_sync_toolsettings(), and UV_OT_unwrap().

◆ uvsculpt

UvSculpt ToolSettings::uvsculpt

◆ vgroup_weight

float ToolSettings::vgroup_weight

Vertex group weight - used only for editmode, not weight paint.

Definition at line 1584 of file DNA_scene_types.h.

Referenced by blo_do_versions_250(), blo_do_versions_260(), and blender::ed::object::vertex_group_assign_exec().

◆ vgroupsubset

char ToolSettings::vgroupsubset

◆ vpaint

◆ weightuser

char ToolSettings::weightuser

Definition at line 1730 of file DNA_scene_types.h.

Referenced by blender::draw::drw_mesh_weight_state_extract().

◆ workspace_tool_type

char ToolSettings::workspace_tool_type

Definition at line 1740 of file DNA_scene_types.h.

Referenced by WIDGETGROUP_tool_generic_refresh().

◆ wpaint

◆ wpaint_lock_relative

char ToolSettings::wpaint_lock_relative

Present weights as if all locked vertex groups were deleted, and the remaining deform groups normalized.

Definition at line 1727 of file DNA_scene_types.h.

Referenced by blender::draw::drw_mesh_weight_state_extract(), weight_sample_invoke(), and wpaint_stroke_test_start().


The documentation for this struct was generated from the following file: