user: How do I use Bpy.Ops.Sculpt in Blender? Include parameters, examples, warnings and best practices.

assistant: int array of 2 items in [ 0 , 32767 ] , ( optional ) ) – Location, Screen coordinates of sampling mode (enum in [ 'DYNTOPO' , 'VOXEL' ], (optional)) – Detail Mode, Target sculpting workflow that is going to use the sampled size DYNTOPO Dyntopo – Sample dyntopo detail. VOXEL Voxel – Sample mesh voxel size. bpy.ops.sculpt. sculptmode_toggle ( ) ¶ Toggle sculpt mode in 3D view bpy.ops.sculpt. set_persistent_base ( ) ¶ Reset the copy of the mesh that is being sculpted on bpy.ops.sculpt. set_pivot_position ( * , mode = 'UNMASKED' , mouse_x = 0.0 , mouse_y = 0.0 ) ¶ Sets the sculpt transform pivot position Parameters : mode (enum in [ 'ORIGIN' , 'UNMASKED' , 'BORDER' , 'ACTIVE' , 'SURFACE' ], (optional)) – Mode ORIGIN Origin – Sets the pivot to the origin of the sculpt. UNMASKED Unmasked – Sets the pivot position to the average position of the unmasked vertices. BORDER Mask Border – Sets the pivot position to the center of the border of the mask. ACTIVE Active Vertex – Sets the pivot position to the active vertex position. SURFACE Surface – Sets the pivot position to the surface under the cursor. mouse_x ( float in [ 0 , inf ] , ( optional ) ) – Mouse Position X, Position of the mouse used for “Surface” and “Active Vertex” mode mouse_y ( float in [ 0 , inf ] , ( optional ) ) – Mouse Position Y, Position of the mouse used for “Surface” and “Active Vertex” mode bpy.ops.sculpt. symmetrize ( * , merge_tolerance = 0.0005 ) ¶ Symmetrize the topology modifications Parameters : merge_tolerance ( float in [ 0 , inf ] , ( optional ) ) – Merge Distance, Distance within which symmetrical vertices are merged bpy.ops.sculpt. trim_box_gesture ( * , xmin = 0 , xmax = 0 , ymin = 0 , ymax = 0 , wait_for_input = True , use_front_faces_only = False , location = (0, 0) , trim_mode = 'DIFFERENCE' , use_cursor_depth = False , trim_orientation = 'VIEW' , trim_extrude_mode = 'FIXED' , trim_solver = 'MANIFOLD' ) ¶ Execute a boolean operation on the mesh and a rectangle defined by the cursor Parameters : xmin ( int in [ -inf , inf ] , ( optional ) ) – X Min xmax ( int in [ -inf , inf ] , ( optional ) ) – X Max ymin ( int in [ -inf , inf ] , ( optional ) ) – Y Min ymax ( int in [ -inf , inf ] , ( optional ) ) – Y Max wait_for_input ( boolean , ( optional ) ) – Wait for Input use_front_faces_only ( boolean , ( optional ) ) – Front Faces Only, Affect only faces facing towards the view location ( int array of 2 items in [ -inf , inf ] , ( optional ) ) – Location, Mouse location trim_mode (enum in [ 'DIFFERENCE' , 'UNION' , 'JOIN' ], (optional)) – Trim Mode DIFFERENCE Difference – Use a difference boolean operation. UNION Union – Use a union boolean operation. JOIN Join – Join the new mesh as separate geometry, without performing any boolean operation. use_cursor_depth ( boolean , ( optional ) ) – Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape trim_orientation (enum in [ 'VIEW' , 'SURFACE' ], (optional)) – Shape Orientation VIEW View – Use the view to orientate the trimming shape. SURFACE Surface – Use the surface normal to orientate the trimming shape. trim_extrude_mode (enum in [ 'PROJECT' , 'FIXED' ], (optional)) – Extrude Mode PROJECT Project – Align trim geometry with the perspective of the current view for a tapered shape. FIXED Fixed – Align trim geometry orthogonally for a shape with 90 degree angles. trim_solver (enum in [ 'EXACT' , 'FLOAT' , 'MANIFOLD' ], (optional)) – Solver EXACT Exact – Slower solver with the best results for coplanar faces. FLOAT Float – Simple solver with good performance, without support for overlapping geometry. MANIFOLD Manifold – Fastest solver that works only on manifold meshes but gives better results. bpy.ops.sculpt. trim_lasso_gesture ( * , path = None , use_smooth_stroke = False , smooth_stroke_factor = 0.75 , smooth_stroke_radius = 35 , use_front_faces_only = False , location = (0, 0) , trim_mode = 'DIFFERENCE' , use_cursor_depth = False , trim_orientation = 'VIEW' , trim_extrude_mode = 'FIXED' , trim_solver = 'MANIFOLD' ) ¶ Execute a boolean operation on the mesh and a shape defined by the cursor Parameters : path ( bpy_prop_collection of OperatorMousePath , (optional)) – Path use_smooth_stroke ( boolean , ( optional ) ) – Stabilize Stroke, Selection lags behind mouse and follows a smoother path smooth_stroke_factor ( float in [ 0.5 , 0.99 ] , ( optional ) ) – Smooth Stroke Factor, Higher values gives a smoother stroke smooth_stroke_radius ( int in [ 10 , 200 ] , ( optional ) ) – Smooth Stroke Radius, Minimum distance from last point before selection continues use_front_faces_only ( boolean , ( optional ) ) – Front Faces Only, Affect only faces facing towards the view location ( int array of 2 items in [ -inf , inf ] , ( optional ) ) – Location, Mouse location trim_mode (enum in [ 'DIFFERENCE' , 'UNION' , 'JOIN' ], (optional)) – Trim Mode DIFFERENCE Difference – Use a difference boolean operation. UNION Union – Use a union boolean operation. JOIN Join – Join the new mesh as separate geometry, without performing any boolean operation. use_cursor_depth ( boolean , ( optional ) ) – Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape trim_orientation (enum in [ 'VIEW' , 'SURFACE' ], (optional)) – Shape Orientation VIEW View – Use the view to orientate the trimming shape. SURFACE Surface – Use the surface normal to orientate the trimming shape. trim_extrude_mode (enum in [ 'PROJECT' , 'FIXED' ], (optional)) – Extrude Mode PROJECT Project – Align trim geometry with the perspective of the current view for a tapered shape. FIXED Fixed – Align trim geometry orthogonally for a shape with 90 degree angles. trim_solver (enum in [ 'EXACT' , 'FLOAT' , 'MANIFOLD' ], (optional)) – Solver EXACT Exact – Slower solver with the best results for coplanar faces. FLOAT Float – Simple solver with good performance, without support for overlapping geometry. MANIFOLD Manifold – Fastest solver that works only on manifold meshes but gives better results. bpy.ops.sculpt. trim_line_gesture ( * , xstart = 0 , xend = 0 , ystart = 0 , yend = 0 , flip = False , cursor = 5 , use_front_faces_only = False , use_limit_to_segment = False , location = (0, 0) , trim_mode = 'DIFFERENCE' , use_cursor_depth = False , trim_orientation = 'VIEW' , trim_extrude_mode = 'FIXED' , trim_solver = 'MANIFOLD' ) ¶ Remove a portion of the mesh on one side of a line Parameters : xstart ( int in [ -inf , inf ] , ( optional ) ) – X Start xend ( int in [ -inf , inf ] , ( optional ) ) – X End ystart ( int in [ -inf , inf ] , ( optional ) ) – Y Start yend ( int in [ -inf , inf ] , ( optional ) ) – Y End flip ( boolean , ( optional ) ) – Flip cursor ( int in [ 0 , inf ] , ( optional ) ) – Cursor, Mouse cursor style to use during the modal operator use_front_faces_only ( boolean , ( optional ) ) – Front Faces Only, Affect only faces facing towards the view use_limit_to_segment ( boolean , ( optional ) ) – Limit to Segment, Apply the gesture action only to the area that is contained within the segment without extending its effect to the entire line location ( int array of 2 items in [ -inf , inf ] , ( optional ) ) – Location, Mouse location trim_mode (enum in [ 'DIFFERENCE' , 'UNION' , 'JOIN' ], (optional)) – Trim Mode DIFFERENCE Difference – Use a difference boolean operation. UNION Union – Use a union boolean operation. JOIN Join – Join the new mesh as separate geometry, without performing any boolean operation. use_cursor_depth ( boolean , ( optional ) ) – Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape trim_orientation (enum in [ 'VIEW' , 'SURFACE' ], (optional)) – Shape Orientation VIEW View – Use the view to orientate the trimming shape. SURFACE Surface – Use the surface normal to orientate the trimming shape. trim_extrude_mode (enum in [ 'PROJECT' , 'FIXED' ], (optional)) – Extrude Mode PROJECT Project – Align trim geometry with the perspective of the current view for a tapered shape. FIXED Fixed – Align trim geometry orthogonally for a shape with 90 degree angles. trim_solver (enum in [ 'EXACT' , 'FLOAT' , 'MANIFOLD' ], (optional)) – Solver EXACT Exact – Slower solver with the best results for coplanar faces. FLOAT Float – Simple solver with good performance, without support for overlapping geometry. MANIFOLD Manifold – Fastest solver that works only on manifold meshes but gives better results. bpy.ops.sculpt. trim_polyline_gesture ( * , path = None , use_front_faces_only = False , location = (0, 0) , trim_mode = 'DIFFERENCE' , use_cursor_depth = False , trim_orientation = 'VIEW' , trim_extrude_mode = 'FIXED' , trim_solver = 'MANIFOLD' ) ¶ Execute a boolean operation on the mesh and a polygonal shape defined by the cursor Parameters : path ( bpy_prop_collection of OperatorMousePath , (optional)) – Path use_front_faces_only ( boolean , ( optional ) ) – Front Faces Only, Affect only faces facing towards the view location ( int array of 2 items in [ -inf , inf ] , ( optional ) ) – Location, Mouse location trim_mode (enum in [ 'DIFFERENCE' , 'UNION' , 'JOIN' ], (optional)) – Trim Mode DIFFERENCE Difference – Use a difference boolean operation. UNION Union – Use a union boolean operation. JOIN Join – Join the new mesh as separate geometry, without performing any boolean operation. use_cursor_depth ( boolean , ( optional ) ) – Use Cursor for Depth, Use cursor location and radius for the dimensions and position of the trimming shape trim_orientation (enum in [ 'VIEW' , 'SURFACE' ], (optional)) – Shape Orientation VIEW View – Use the view to orientate the trimming shape. SURFACE Surface – Use the surface normal to orientate the trimming shape. trim_extrude_mode (enum in [ 'PROJECT' , 'FIXED' ], (optional)) – Extrude Mode PROJECT Project – Align trim geometry with the perspective of the current view for a tapered shape. FIXED Fixed – Align trim geometry orthogonally for a shape with 90 degree angles. trim_solver (enum in [ 'EXACT' , 'FLOAT' , 'MANIFOLD' ], (optional)) – Solver EXACT Exact – Slower solver with the best results for coplanar faces. FLOAT Float – Simple solver with good performance, without support for overlapping geometry. MANIFOLD Manifold – Fastest solver that works only on manifold meshes but gives better results. bpy.ops.sculpt. uv_sculpt_grab ( * , use_invert = False ) ¶ Grab UVs Parameters : use_invert ( boolean , ( optional ) ) – Invert, Invert action for the duration of the stroke bpy.ops.sculpt. uv_sculpt_pinch ( * , use_invert = False ) ¶ Pinch UVs Parameters : use_invert ( boolean , ( optional ) ) – Invert, Invert action for the duration of the stroke bpy.ops.sculpt. uv_sculpt_relax ( * , use_invert = False , relax_method = 'LAPLACIAN' ) ¶ Relax UVs Parameters : use_invert ( boolean , ( optional ) ) – Invert, Invert action for the duration of the stroke relax_method (enum in [ 'LAPLACIAN' , 'HC' , 'COTAN' ], (optional)) – Relax Method, Algorithm used for UV relaxation LAPLACIAN Laplacian – Use Laplacian method for relaxation. HC HC – Use HC method for relaxation. COTAN Geometry – Use Geometry (cotangent) relaxation, making UVs follow the underlying 3D geometry. Next Sculpt Curves Operators Previous Script Operators Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Sculpt Operators brush_stroke() cloth_filter() color_filter() detail_flood_fill() dynamic_topology_toggle() dyntopo_detail_size_edit() expand() face_set_box_gesture() face_set_change_visibility() face_set_edit() face_set_extract() face_set_lasso_gesture() face_set_line_gesture() face_set_polyline_gesture() face_sets_create() face_sets_init() face_sets_randomize_colors() mask_by_color() mask_filter() mask_from_boundary() mask_from_cavity() mask_init() mesh_filter() optimize() paint_mask_extract() paint_mask_slice() project_line_gesture() sample_color() sample_detail_size() sculptmode_toggle() set_persistent_base() set_pivot_position() symmetrize() trim_box_gesture() trim_lasso_gesture() trim_line_gesture() trim_polyline_gesture() uv_sculpt_grab() uv_sculpt_pinch() uv_sculpt_relax()