Sculpt Operators

bpy.ops.sculpt.brush_stroke(stroke=None, mode='NORMAL', ignore_background_click=False)

Sculpt a stroke into the geometry

Parameters:
  • stroke (bpy_prop_collection of OperatorStrokeElement, (optional)) – Stroke
  • mode (enum in ['NORMAL', 'INVERT', 'SMOOTH'], (optional)) –

    Stroke Mode, Action taken when a paint stroke is made

    • NORMAL Normal, Apply brush normally.
    • INVERT Invert, Invert action of brush for duration of stroke.
    • SMOOTH Smooth, Switch brush to smooth mode for duration of stroke.
  • ignore_background_click (boolean, (optional)) – Ignore Background Click, Clicks on the background do not start the stroke
bpy.ops.sculpt.detail_flood_fill()

Flood fill the mesh with the selected detail setting

bpy.ops.sculpt.dynamic_topology_toggle()

Dynamic topology alters the mesh topology while sculpting

bpy.ops.sculpt.optimize()

Recalculate the sculpt BVH to improve performance

bpy.ops.sculpt.sample_detail_size(location=(0, 0))

Sample the mesh detail on clicked point

Parameters:location (int array of 2 items in [0, 32767], (optional)) – Location, Screen Coordinates of sampling
bpy.ops.sculpt.sculptmode_toggle()

Toggle sculpt mode in 3D view

bpy.ops.sculpt.set_detail_size()

Set the mesh detail (either relative or constant one, depending on current dyntopo mode)

bpy.ops.sculpt.set_persistent_base()

Reset the copy of the mesh that is being sculpted on

bpy.ops.sculpt.symmetrize()

Symmetrize the topology modifications

bpy.ops.sculpt.uv_sculpt_stroke(mode='NORMAL')

Sculpt UVs using a brush

Parameters:mode (enum in ['NORMAL', 'INVERT', 'RELAX'], (optional)) –

Mode, Stroke Mode

  • NORMAL Normal, Apply brush normally.
  • INVERT Invert, Invert action of brush for duration of stroke.
  • RELAX Relax, Switch brush to relax mode for duration of stroke.