Skip to content

Free, open-source 3D sculpting for Linux, macOS and Windows: dense meshes, remeshing, painting, built-in AI (image/text to 3D), Send to Unreal, game-ready LODs, Gaussian splats and OpenUSD.

6.1 KB
Raw Blame
# The Classic sculpting keys (docs/guide/quick-tour.md): U / I / O at the cursor, Smooth's own Intensity, the classic brush
# letters, L, V, Space QuickMenu, the mask keys (Ctrl+A, Ctrl+Shift+A, Ctrl+I, Ctrl+H), Ctrl+click to blur and
# Ctrl+Alt+click to sharpen the mask, Ctrl+W, Ctrl+Shift+click on a partly hidden mesh, Shift-constrained
# straight strokes, Shift+click / release Shift / drag to roll, and the classic / SculptForge input styles.
run ui_look look=classic layout=classic        # written for the Classic look and the classic palette bar and shelves
run new_sphere subdivisions=5
# New installs start with the SculptForge keys; this script is about the classic ones.
expect_value input_style == 1
input_style classic
expect_value input_style == 0

# --- U / I / O: Intensity, Colour intensity and Falloff at the cursor (typed  0-100) ---
mouse_move 0.5 0.5
key u
expect_text Intensity 50
key 2
key 5
key enter
expect_value z_intensity == 25
key i
expect_text Colour intensity 100
shot rgb-popup
key escape
expect_value rgb_intensity == 100
key o
expect_text Falloff 0
key minus
key 6
key 0
key enter
expect_value focal_shift == -60
mouse_move 0.5 0.5
shot focal-hard-ring
key o
key 6
key 0
key enter
expect_value focal_shift == 60
mouse_move 0.5 0.5
shot focal-soft-ring
key o
key 0
key enter
expect_value focal_shift == 0

# Smooth keeps its own Intensity: with Shift held, U shows and sets Smooth's value.
hold shift
key u
expect_text Smooth Intensity 50
key 8
key 0
key enter
hold none
expect_value smooth_intensity == 80
expect_value z_intensity == 25

# The Draw palette shows the new sliders, with Ctrl-hover help.
click "Draw##palette.draw"
expect_text Colour intensity 100
expect_text Falloff 0
hold ctrl
hover "##focalshift"
expect_help "soft point"
hold none
shot draw-palette

# --- the classic brush letters: B C B Clay Block, B D S Sharp Crease, B M V Move, B I N Inflate, B S T Standard ---
key b
key c
shot picker-c
key b
expect_value brush_type == 9
key b
key d
key s
expect_value brush_type == 8
key b
key m
key v
expect_value brush_type == 3
key b
key i
key n
expect_value brush_type == 4
key b
key s
key t
expect_value brush_type == 0
# In the classic the number keys don't pick brushes.
key 3
expect_value brush_type == 0

# --- L: Steady Stroke (LazyMouse) on and off, with any stroke type; V: swap the main and secondary colour ---
key l
expect_value steady_stroke == 1
key l
expect_value steady_stroke == 0
remember paint_r red0
key v
expect_value paint_r != $red0
key v
expect_value paint_r == $red0

# --- Space: the QuickMenu under the cursor (a tap keeps it open; Esc closes) ---
mouse_move 0.5 0.5
key space
expect_value quickmenu_open == 1
expect "##qm_drawsize"
expect_text Falloff 0
shot quickmenu
key escape
expect_value quickmenu_open == 0

# --- The mask keys ---
key ctrl+a
expect_value masked > 5000
key ctrl+shift+a
expect_value masked == 0
key ctrl+i
expect_value masked > 5000
expect_value show_mask == 1
key ctrl+h
expect_value show_mask == 0
key ctrl+h
expect_value show_mask == 1
key ctrl+shift+a

# --- Ctrl+click on the model blurs the mask, Ctrl+Alt+click sharpens it; a Ctrl+drag still paints ---
hold ctrl
stroke 0.2 0.55 0.8 0.55   # a little off-centre: on a centred band, blurring can leave the masked count unchanged
hold none
expect_value masked > 100
# (Partly masked vertices: a blur always makes more of them, a sharpen fewer. The count above 0.5 can stay the same.)
remember mask_soft painted
hold ctrl
drag_path 0.5 0.3 0.5 0.3
hold none
expect_value mask_soft > $painted
remember mask_soft blurred
shot mask-blurred
hold ctrl+alt
drag_path 0.5 0.3 0.5 0.3
hold none
expect_value mask_soft < $blurred
shot mask-sharpened

# --- Ctrl+W: the masked part becomes a face group and the mask is cleared ---
remember groups g0
key ctrl+w
expect_value groups > $g0
expect_value masked == 0
expect_value show_facegroups == 1
shot group-masked

# classic: Ctrl+drag on the background with nothing masked does nothing (SculptForge's zoom is a preference).
remember camera_distance d0
hold ctrl
drag 0.12 0.3 0.12 0.7
hold none
expect_value camera_distance == $d0

# --- Visibility: Ctrl+Shift+click on a partly hidden mesh hides the group clicked ---
# Hide the top with Ctrl+Shift+Alt+drag, then Ctrl+Shift+click the equator band (the new group).
hold ctrl+shift+alt
drag_path -0.2 -0.05 1.2 0.2
hold none
expect_value hidden > 0
remember hidden h1
hold ctrl+shift
drag_path 0.5 0.5 0.5 0.5
hold none
expect_value hidden > $h1
shot group-hidden
# A Ctrl+Shift rectangle dragged around nothing (on the background) reverses the visibility.
remember hidden h2
hold ctrl+shift
drag_path 1.3 0.1 1.6 0.4
hold none
expect_value hidden != $h2
shot visibility-reversed
hold ctrl+shift
drag_path 1.5 0.5 1.5 0.5
hold none
expect_value hidden == 0

# --- Shift pressed after a stroke starts: a straight line, snapped to 45 degrees ---
key ctrl+shift+a
drag_path 0.25 0.6 0.3 0.6 keep
remember last_dab_y y0
hold shift
mouse_move 0.5 0.66
mouse_move 0.7 0.55
mouse_move 0.75 0.62
expect_value last_dab_y == $y0
expect_value last_dab_x > 0
release
hold none
shot straight-line

# --- Shift+click the background, let go of Shift, drag: roll the view about its axis ---
key f
expect_value camera_roll == 0
hold shift
drag_path 1.5 0.2 1.5 0.2 keep
hold none
mouse_move 1.5 0.8
mouse_move 1.4 1.0
release
expect_value camera_roll != 0
shot rolled
key f

# --- Preferences > Input: the SculptForge style brings back 1-0 brushes, I = Falloff (#117), Ctrl+drag zoom ---
click "Preferences##palette.preferences"
click "Input##preferences.input"
hold ctrl
hover "SculptForge##input.style_sculptforge"
expect_help "1-9 and 0"
hold none
shot preferences-input
click "SculptForge##input.style_sculptforge"
expect_value input_style == 1
key 3
expect_value brush_type == 2
key i
expect_text Falloff
key escape
key u
# 3 picked Smooth, so U shows its own value.
expect_text Smooth Intensity 80
key escape
remember camera_distance d1
hold ctrl
drag 0.12 0.3 0.12 0.7
hold none
# The SculptForge style keeps its own direction: dragging down zooms out.
expect_value camera_distance > $d1
key f
click "Preferences##palette.preferences"
click "Classic sculpting keys##input.style_classic"
expect_value input_style == 0
key 1
expect_value brush_type == 2