user: What is Bpy.Types.Toolsettings and how is it used in Blender Python scripting?

assistant:  surface normal (using the transform orientation as a fallback). DEFAULT Default – Use the current transform orientation. Type : enum in [ 'SURFACE' , 'DEFAULT' ], default 'SURFACE' playhead_snap_distance ¶ Maximum distance for snapping in pixels Type : int in [-inf, inf], default 20 proportional_distance ¶ Display size for proportional editing circle Type : float in [1e-05, 5000], default 1.0 proportional_edit_falloff ¶ Falloff type for proportional editing mode Type : enum in Proportional Falloff Items , default 'SMOOTH' proportional_size ¶ Display size for proportional editing circle Type : float in [1e-05, 5000], default 1.0 sculpt ¶ Type : Sculpt , (readonly) sequencer_tool_settings ¶ Type : SequencerToolSettings , (readonly, never None) show_uv_local_view ¶ Display only faces with the currently displayed image assigned Type : boolean, default False snap_angle_increment_2d ¶ Angle used for rotation increments in 2D editors Type : float in [0, 3.14159], default 0.0872665 snap_angle_increment_2d_precision ¶ Precision angle used for rotation increments in 2D editors Type : float in [0, 3.14159], default 0.0174533 snap_angle_increment_3d ¶ Angle used for rotation increments in 3D editors Type : float in [0, 3.14159], default 0.0872665 snap_angle_increment_3d_precision ¶ Precision angle used for rotation increments in 3D editors Type : float in [0, 3.14159], default 0.0174533 snap_anim_element ¶ Type of element to snap to Type : enum in Snap Animation Element Items , default 'FRAME' snap_elements ¶ Type of element to snap to Type : enum set in Snap Element Items , default { 'INCREMENT' } snap_elements_base ¶ Type of element for the “Snap Base” to snap to INCREMENT Increment – Snap to increments. GRID Grid – Snap to grid. VERTEX Vertex – Snap to vertices. EDGE Edge – Snap to edges. FACE Face – Snap by projecting onto faces. VOLUME Volume – Snap to volume. EDGE_MIDPOINT Edge Center – Snap to the middle of edges. EDGE_PERPENDICULAR Edge Perpendicular – Snap to the nearest point on an edge. Type : enum set in { 'INCREMENT' , 'GRID' , 'VERTEX' , 'EDGE' , 'FACE' , 'VOLUME' , 'EDGE_MIDPOINT' , 'EDGE_PERPENDICULAR' }, default { 'INCREMENT' } snap_elements_individual ¶ Type of element for individual transformed elements to snap to FACE_PROJECT Face Project – Snap by projecting onto faces. FACE_NEAREST Face Nearest – Snap to nearest point on faces. Type : enum set in { 'FACE_PROJECT' , 'FACE_NEAREST' }, default set() snap_elements_tool ¶ The target to use while snapping GEOMETRY Geometry – Snap to all geometry. DEFAULT Default – Use the current snap settings. Type : enum in [ 'GEOMETRY' , 'DEFAULT' ], default 'GEOMETRY' snap_face_nearest_steps ¶ Number of steps to break transformation into for face nearest snapping Type : int in [1, 100], default 1 snap_playhead_element ¶ Type of element to snap to FRAME Frames – Snap to frame increments. SECOND Seconds – Snap to second increments. MARKER Markers – Snap to markers. KEY Keyframes – Snap to keyframes. Strip Strips – Snap to Strips. Type : enum set in { 'FRAME' , 'SECOND' , 'MARKER' , 'KEY' , 'Strip' }, default { 'KEY' , 'Strip' } snap_playhead_frame_step ¶ At which interval to snap to frames Type : int in [1, 32768], default 2 snap_playhead_second_step ¶ At which interval to snap to seconds Type : int in [1, 32768], default 1 snap_target ¶ Which part to snap onto the target Type : enum in Snap Source Items , default 'CLOSEST' snap_uv_element ¶ Type of element to snap to INCREMENT Increment – Snap to increments of grid. GRID Grid – Snap to grid. VERTEX Vertex – Snap to vertices. Type : enum set in { 'INCREMENT' , 'GRID' , 'VERTEX' }, default { 'INCREMENT' } statvis ¶ Type : MeshStatVis , (readonly, never None) transform_pivot_point ¶ Pivot center for rotation/scaling BOUNDING_BOX_CENTER Bounding Box Center – Pivot around bounding box center of selected object(s). CURSOR 3D Cursor – Pivot around the 3D cursor. INDIVIDUAL_ORIGINS Individual Origins – Pivot around each object’s own origin. MEDIAN_POINT Median Point – Pivot around the median point of selected objects. ACTIVE_ELEMENT Active Element – Pivot around active object. Type : enum in [ 'BOUNDING_BOX_CENTER' , 'CURSOR' , 'INDIVIDUAL_ORIGINS' , 'MEDIAN_POINT' , 'ACTIVE_ELEMENT' ], default 'MEDIAN_POINT' use_annotation_project_only_selected ¶ Project the strokes only onto selected objects Type : boolean, default False use_annotation_stroke_endpoints ¶ Only use the first and last parts of the stroke for snapping Type : boolean, default False use_auto_normalize ¶ Ensure all bone-deforming vertex groups add up to 1.0 while weight painting or assigning to vertices Type : boolean, default False use_edge_path_live_unwrap ¶ Changing edge seams recalculates UV unwrap Type : boolean, default False use_gpencil_automerge_strokes ¶ Join the last drawn stroke with previous strokes in the active layer by distance Type : boolean, default False use_gpencil_draw_additive ¶ When creating new frames, the strokes from the previous/active frame are included as the basis for the new one Type : boolean, default False use_gpencil_draw_onback ¶ New strokes are drawn below of all strokes in the layer Type : boolean, default False use_gpencil_project_only_selected ¶ Project the strokes only onto selected objects Type : boolean, default False use_gpencil_select_mask_point ¶ Only sculpt selected stroke points Type : boolean, default False use_gpencil_select_mask_segment ¶ Only sculpt selected stroke points between other strokes Type : boolean, default False use_gpencil_select_mask_stroke ¶ Only sculpt selected strokes Type : boolean, default False use_gpencil_thumbnail_list ¶ Show compact list of colors instead of thumbnails Type : boolean, default True use_gpencil_vertex_select_mask_point ¶ Only paint selected stroke points Type : boolean, default False use_gpencil_vertex_select_mask_segment ¶ Only paint selected stroke points between other strokes Type : boolean, default False use_gpencil_vertex_select_mask_stroke ¶ Only paint selected strokes Type : boolean, default False use_gpencil_weight_data_add ¶ Weight data for new strokes is added according to the current vertex group and weight. If no vertex group selected, weight is not added. Type : boolean, default False use_grease_pencil_multi_frame_editing ¶ Enable multi-frame editing Type : boolean, default False use_keyframe_cycle_aware ¶ For channels with cyclic extrapolation, keyframe insertion is automatically remapped inside the cycle time range, and keeps ends in sync. Curves newly added to actions with a Manual Frame Range and Cyclic Animation are automatically made cyclic. Type : boolean, default False use_keyframe_insert_auto ¶ Automatic keyframe insertion for objects, bones and masks Type : boolean, default True use_keyframe_insert_keyingset ¶ Automatic keyframe insertion using active Keying Set only Type : boolean, default False use_lock_relative ¶ Display bone-deforming groups as if all locked deform groups were deleted, and the remaining ones were re-normalized Type : boolean, default False use_mesh_automerge ¶ Automatically merge vertices moved to the same location Type : boolean, default False use_mesh_automerge_and_split ¶ Automatically split edges and faces Type : boolean, default False use_multipaint ¶ Paint across the weights of all selected bones, maintaining their relative influence Type : boolean, default False use_proportional_action ¶ Proportional editing in action editor Type : boolean, default False use_proportional_connected ¶ Proportional Editing using connected geometry only Type : boolean, default False use_proportional_edit ¶ Proportional edit mode Type : boolean, default False use_proportional_edit_mask ¶ Proportional editing mask mode Type : boolean, default False use_proportional_edit_objects ¶ Proportional editing object mode Type : boolean, default False use_proportional_fcurve ¶ Proportional editing in F-Curve editor Type : boolean, default False use_proportional_projected ¶ Proportional Editing using screen space locations Type : boolean, default False use_record_with_nla ¶ Add a new NLA Track + Strip for every loop/pass made over the animation to allow non-destructive tweaking Type : boolean, default False use_snap ¶ Snap during transform Type : boolean, default False use_snap_align_rotation ¶ Align rotation with the snapping target Type : boolean, default False use_snap_anim ¶ Enable snapping when transforming keyframes Type : boolean, default True use_snap_backface_culling ¶ Exclude back facing geometry from snapping Type : boolean, default False use_snap_driver ¶ Enable snapping when transforming keys in the Driver Editor Type : boolean, default False use_snap_driver_absolute ¶ Snap to full values Type : boolean, default False use_snap_edit ¶ Snap onto non-active objects in edit mode (edit mode only) Type : boolean, default True use_snap_grid_absolute ¶ Absolute grid alignment while translating (based on the pivot center) Type : boolean, default False use_snap_node ¶ Snap Node during transform Type : boolean, default False use_snap_nonedit ¶ Snap onto objects not in edit mode (edit mode only) Type : boolean, default True use_snap_peel_object ¶ Consider objects as whole when finding volume center Type : boolean, default False use_snap_playhead ¶ Snap playhead when scrubbing Type : boolean, default False use_snap_rotate ¶ Rotate is affected by the snapping settings Type : boolean, default False use_snap_scale ¶ Scale is affected by snapping settings Type : boolean, default False use_snap_selectable ¶ Snap only onto objects that are selectable Type : boolean, default False use_snap_self ¶ Snap onto itself only if enabled (edit mode only) Type : boolean, default True use_snap_sequencer ¶ Snap strips during transform Type : boolean, default True use_snap_time_absolute ¶ Absolute time alignment when transforming keyframes Type : boolean, default False use_snap_to_same_target ¶ Snap only to target that source was initially near (“Face Nearest” only) Type : boolean, default False use_snap_translate ¶ Move is affected by snapping settings Type : boolean, default True use_snap_uv ¶ Snap UV during transform Type : boolean, default False use_transform_correct_face_attributes ¶ Correct data such as UVs and color attributes when transforming Type : boolean, default False use_transform_correct_keep_connected ¶ During the Face Attributes correction, merge attributes connected to the same vertex Type : boolean, default False use_transform_data_origin ¶ Transform object origins, while leaving the shape in place Type : boolean, default False use_transform_pivot_point_align ¶ Only transform object locations, without affecting rotation or scaling Type : boolean, default False use_transform_skip_children ¶ Transform the parents, leaving the children in place Type : boolean, default False use_uv_custom_region ¶ Custom defined region Type : boolean, default False use_uv_select_island ¶ Island selection Type : boolean, default False use_uv_select_sync ¶ Keep UV and edit mode mesh selection in sync Type : boolean, default True uv_sculpt ¶ Type : UvSculpt , (readonly) uv_sculpt_all_islands ¶ Brush operates on all islands Type : boolean, default False uv_sculpt_lock_borders ¶ Disable editing of boundary edges Type : boolean, default False uv_select_mode ¶ UV selection and display mode Type : enum in Mesh Select Mode Uv Items , default 'VERTEX' uv_sticky_select_mode ¶ Method for extending UV vertex selection DISABLED Disabled – Sticky vertex selection disabled. SHARED_LOCATION Shared Location – Select UVs that are at the same location and share a mesh vertex. SHARED_VERTEX Shared Vertex – Select UVs that share a mesh vertex, whether or not they are at the same location. Type : enum in [ 'DISABLED' , 'SHARED_LOCATION' , 'SHARED_VERTEX' ], default 'SHARED_LOCATION' vertex_group_subset ¶ Filter Vertex groups for Display ALL All – All Vertex Groups. BONE_DEFORM Deform – Vertex Groups assigned to Deform Bones. OTHER_DEFORM Other – Vertex Groups assigned to non Deform Bones. Type : enum in [ 'ALL' , 'BONE_DEFORM' , 'OTHER_DEFORM' ], default 'ALL' vertex_group_user ¶ Display unweighted vertices NONE None. ACTIVE Active – Show vertices with no weights in the active group. ALL All – Show vertices with no weights in any group. Type : enum in [ 'NONE' , 'ACTIVE' , 'ALL' ], default 'ACTIVE' vertex_group_weight ¶ Weight to assign in vertex groups Type : float in [0, 1], default 1.0 vertex_paint ¶ Type : VertexPaint , (readonly) weight_paint ¶ Type : VertexPaint , (readonly) workspace_tool_type ¶ Action when dragging in the viewport Type : enum in [ 'DEFAULT' , 'FALLBACK' ], default 'FALLBACK' classmethod bl_rna_get_subclass ( id , default = None , / ) ¶ Parameters : id ( str ) – The RNA type identifier. Returns : The RNA type or default when not found. Return type : bpy.types.Struct subclass classmethod bl_rna_get_subclass_py ( id , default = None , / ) ¶ Parameters : id ( str ) – The RNA type identifier. Returns : The class or default when not found. Return type : type Inherited Properties ¶ bpy_struct.id_data Inherited Functions ¶ bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values References ¶ bpy.context.tool_settings Context.tool_settings Scene.tool_settings Next TrackToConstraint(Constraint) Previous Timer(bpy_struct) Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page ToolSettings(bpy_struct) ToolSettings ToolSettings.anim_fix_to_cam_use_loc ToolSettings.anim_fix_to_cam_use_rot ToolSettings.anim_fix_to_cam_use_scale ToolSettings.anim_mirror_bone ToolSettings.anim_mirror_object ToolSettings.anim_relative_object ToolSettings.annotation_stroke_placement_view2d ToolSettings.annotation_stroke_placement_view3d ToolSettings.annotation_thickness ToolSettings.auto_keying_mode ToolSettings.curve_paint_settings ToolSettings.curves_sculpt ToolSettings.custom_bevel_profile_preset ToolSettings.double_threshold ToolSettings.gpencil_interpolate ToolSettings.gpencil_paint ToolSettings.gpencil_sculpt ToolSettings.gpencil_sculpt_paint ToolSettings.gpencil_selectmode_edit ToolSettings.gpencil_stroke_placement_view3d ToolSettings.gpencil_stroke_snap_mode ToolSettings.gpencil_surface_offset ToolSettings.gpencil_vertex_paint ToolSettings.gpencil_weight_paint ToolSettings.image_paint ToolSettings.keyframe_type ToolSettings.lock_markers ToolSettings.lock_object_mode ToolSettings.mesh_select_mode ToolSettings.normal_vector ToolSettings.paint_mode ToolSettings.particle_edit ToolSettings.plane_axis ToolSettings.plane_axis_auto ToolSettings.plane_depth ToolSettings.plane_orientation ToolSettings.playhead_snap_distance ToolSettings.proportional_distance ToolSettings.proportional_edit_falloff ToolSettings.proportional_size ToolSettings.sculpt ToolSettings.sequencer_tool_settings ToolSettings.show_uv_local_view ToolSettings.snap_angle_increment_2d ToolSettings.snap_angle_increment_2d_precision ToolSettings.snap_angle_increment_3d ToolSettings.snap_angle_increment_3d_precision ToolSettings.snap_anim_element ToolSettings.snap_elements ToolSettings.snap_elements_base ToolSettings.snap_elements_individual ToolSettings.snap_elements_tool ToolSettings.snap_face_nearest_steps ToolSettings.snap_playhead_element ToolSettings.snap_playhead_frame_step ToolSettings.snap_playhead_second_step ToolSettings.snap_target ToolSettings.snap_uv_element ToolSettings.statvis ToolSettings.transform_pivot_point ToolSettings.use_annotation_project_only_selected ToolSettings.use_annotation_stroke_endpoints ToolSettings.use_auto_normalize ToolSettings.use_edge_path_live_unwrap ToolSettings.use_gpencil_automerge_strokes ToolSettings.use_gpencil_draw_additive ToolSettings.use_gpencil_draw_onback ToolSettings.use_gpencil_project_only_selected ToolSettings.use_gpencil_select_mask_point ToolSettings.use_gpencil_select_mask_segment ToolSettings.use_gpencil_select_mask_stroke ToolSettings.use_gpencil_thumbnail_list ToolSettings.use_gpencil_vertex_select_mask_point ToolSettings.use_gpencil_vertex_select_mask_segment ToolSettings.use_gpencil_vertex_select_mask_stroke ToolSettings.use_gpencil_weight_data_add ToolSettings.use_grease_pencil_multi_frame_editing ToolSettings.use_keyframe_cycle_aware ToolSettings.use_keyframe_insert_auto ToolSettings.use_keyframe_insert_keyingset ToolSettings.use_lock_relative ToolSettings.use_mesh_automerge ToolSettings.use_mesh_automerge_and_split ToolSettings.use_multipaint ToolSettings.use_proportional_action ToolSettings.use_proportional_connected ToolSettings.use_proportional_edit ToolSettings.use_proportional_edit_mask ToolSettings.use_proportional_edit_objects ToolSettings.use_proportional_fcurve ToolSettings.use_proportional_projected ToolSettings.use_record_with_nla ToolSettings.use_snap ToolSettings.use_snap_align_rotation ToolSettings.use_snap_anim ToolSettings.use_snap_backface_culling ToolSettings.use_snap_driver ToolSettings.use_snap_driver_absolute ToolSettings.use_snap_edit ToolSettings.use_snap_grid_absolute ToolSettings.use_snap_node ToolSettings.use_snap_nonedit ToolSettings.use_snap_peel_object ToolSettings.use_snap_playhead ToolSettings.use_snap_rotate ToolSettings.use_snap_scale ToolSettings.use_snap_selectable ToolSettings.use_snap_self ToolSettings.use_snap_sequencer ToolSettings.use_snap_time_absolute ToolSettings.use_snap_to_same_target ToolSettings.use_snap_translate ToolSettings.use_snap_uv ToolSettings.use_transform_correct_face_attributes ToolSettings.u