Merge pull request #13035 from ljkx/feat/pen-rubber-band

feat(ui): the Pen's gear has a Rubber Band check item, off by default (#12900)
This commit is contained in:
David Mann authored and GitHub committed 2026-11-11 02:49:37 +01:00
commit 2be87e4463
6 files changed
+162 -1

No files matched your search

+5
View File
@@ -130,6 +130,10 @@ pub struct ToolOptions {
/// on one of its anchors deletes it (#4144).
#[serde(default = "yes")]
pub pen_auto_add_delete: bool,
/// Pen › gear › Rubber Band: while drawing, preview the next segment from the last anchor to
/// the pointer. Off by default, as in Photoshop (#12900).
#[serde(default)]
pub pen_rubber_band: bool,
/// Marquee options bar: "normal" | "fixedRatio" | "fixedSize", with the ratio or size.
#[serde(default = "default_marquee_style")]
pub marquee_style: String,
@@ -507,6 +511,7 @@ impl Default for ToolOptions {
arrow_concavity: 0.0,
curve_fit: default_curve_fit(),
pen_auto_add_delete: true,
pen_rubber_band: false,
marquee_style: default_marquee_style(),
marquee_width: 1.0,
marquee_height: 1.0,
+1 -1
View File
@@ -241,7 +241,7 @@ pub fn option_keys(tool: Tool) -> &'static [&'static str] {
Tool::Dodge | Tool::Burn => reset!(tone_range, exposure, protect_tones),
Tool::Sponge => reset!(sponge_mode, sponge_flow, vibrance),
Tool::Slice => reset!(slice_style, slice_width, slice_height),
Tool::Pen => reset!(vector_mode, pen_path_op, pen_auto_add_delete),
Tool::Pen => reset!(vector_mode, pen_path_op, pen_auto_add_delete, pen_rubber_band),
Tool::CurvaturePen => reset!(vector_mode, pen_path_op),
Tool::FreeformPen => reset!(vector_mode, pen_path_op, curve_fit),
Tool::Line => reset!(
+3
View File
@@ -216,6 +216,9 @@ mod pen_draw_tests;
#[cfg(test)]
mod pen_path_ops_tests;
#[cfg(test)]
mod pen_rubber_band_tests;
#[cfg(test)]
mod paint_tests;
@@ -7,6 +7,16 @@ use super::{GradientChoices, LayerContent, PaintChange, PhotocraftApp, Tokens, T
// ---------------------------------------------------------------------------------------------
// Options bars
/// The Pen's gear, before Auto Add/Delete as in Photoshop: a popup with the Rubber Band check
/// item, off by default and saved with the tool options (#12900).
fn pen_gear(o: &mut crate::state::ToolOptions, ui: &mut egui::Ui) {
let gear = crate::icons::button_with_icon_size(ui, "settings", 28.0, 20.0, false, tl!("Set additional pen and path options"));
egui::Popup::menu(&gear).close_behavior(egui::PopupCloseBehavior::CloseOnClickOutside).show(|ui| {
ui.set_min_width(140.0);
ui.checkbox(&mut o.pen_rubber_band, tl!("Rubber Band"));
});
}
/// Options bar for vector tools; false for other tools.
pub fn options_bar(app: &mut PhotocraftApp, ui: &mut egui::Ui, tool: Tool) -> bool {
if !(is_shape_tool(tool)
@@ -74,6 +84,7 @@ pub fn options_bar(app: &mut PhotocraftApp, ui: &mut egui::Ui, tool: Tool) -> bo
let o = &mut app.ui.tool_options;
if tool == Tool::Pen {
crate::widgets::vline(ui, 22.0);
pen_gear(o, ui);
crate::widgets::checkbox(ui, &mut o.pen_auto_add_delete, tl!("Auto Add/Delete"));
}
let enter = crate::shortcuts::pretty("Enter");
@@ -129,6 +129,12 @@ pub(crate) fn selected_saved_path_index(app: &PhotocraftApp) -> Option<(usize, P
/// Work path / active shape path / selected saved path outlines, anchors, and the pen path in
/// progress.
/// Whether the path being drawn previews its next segment up to the pointer. The Pen only does
/// with its gear's Rubber Band on (#12900); the other pens' paths keep their preview.
fn rubber_band_shown(app: &PhotocraftApp, tool: Tool, pen: &super::PenPath) -> bool {
tool != Tool::Pen || pen.curvature || app.ui.tool_options.pen_rubber_band
}
pub fn draw_overlay(app: &PhotocraftApp, painter: &egui::Painter, xf: &ViewXform, doc: &Document) {
let tool = app.ui.tool;
let accent = Tokens::get(painter.ctx()).accent;
@@ -237,6 +243,7 @@ pub fn draw_overlay(app: &PhotocraftApp, painter: &egui::Painter, xf: &ViewXform
&& !pen.dragging
&& pen.moving.is_none()
&& !auto
&& rubber_band_shown(app, tool, pen)
{
if pen.curvature && pen.knots.len() >= 2 {
// The Curvature Pen previews the curve the next click makes through the pointer.
@@ -0,0 +1,135 @@
//! #12900: the Pen's gear holds a Rubber Band check item, off by default as in Photoshop. Off,
//! nothing is drawn from the last anchor to the pointer while a path is drawn; on, the preview
//! line is. The setting is a tool option: saved, reset by Reset Tool, reported by `ui.inspect`.
use egui::Pos2;
use egui_kittest::kittest::Queryable;
use serde_json::json;
use super::PenPath;
use super::add_anchor_options_bar_tests::harness;
use crate::PhotocraftApp;
use crate::canvas::ViewXform;
use crate::control::{ControlRequest, Outcome, handle};
use crate::state::{Tool, ToolOptions};
const GEAR: &str = "Set additional pen and path options";
const RUBBER_BAND: &str = "Rubber Band";
/// A 200x200 document with a two-anchor path being drawn by `tool` and the pointer away from it.
fn drawing(tool: Tool) -> PhotocraftApp {
let mut app = PhotocraftApp::new(photocraft_engine::Session::new(), crate::Services::default());
app.session.execute("file.new", json!({"width": 200, "height": 200})).unwrap();
app.sync_views();
app.ui.tool = tool;
app.ui.pen = Some(PenPath { knots: vec![[[20.0, 20.0]; 3], [[120.0, 30.0]; 3]], ..Default::default() });
app.hover_doc = Some([60.0, 150.0]);
app
}
/// The dashes the vector overlay draws: the preview from the last anchor to the pointer is the
/// only dashed line of a path being drawn.
fn dashes(app: &PhotocraftApp) -> usize {
let xf = ViewXform {
rect: egui::Rect::from_min_size(Pos2::ZERO, egui::vec2(200., 200.)),
zoom: 1.0,
center: [100., 100.],
flip: false,
rotation: 0.,
aspect: 1.,
};
let doc = app.session.active().unwrap().doc.clone();
let ctx = egui::Context::default();
let mut out = ctx.run_ui(Default::default(), |ui| super::draw_overlay(app, ui.painter(), &xf, &doc));
out.textures_delta.clear();
let mut stack: Vec<egui::Shape> = out.shapes.into_iter().map(|s| s.shape).collect();
let mut n = 0;
while let Some(shape) = stack.pop() {
match shape {
egui::Shape::Vec(v) => stack.extend(v),
egui::Shape::LineSegment { .. } => n += 1,
_ => {}
}
}
n
}
#[test]
fn off_by_default_the_pen_draws_no_line_to_the_pointer() {
let mut app = drawing(Tool::Pen);
assert!(!app.ui.tool_options.pen_rubber_band, "off by default, as in Photoshop");
assert_eq!(dashes(&app), 0, "no preview line");
app.ui.tool_options.pen_rubber_band = true;
assert!(dashes(&app) > 5, "Rubber Band on: the dashed preview line");
app.ui.tool_options.pen_rubber_band = false;
assert_eq!(dashes(&app), 0);
}
#[test]
fn the_other_pens_keep_their_preview() {
// The Curvature Pen's preview is #12756; a path of another pen is not the Pen's to hide.
let mut app = drawing(Tool::CurvaturePen);
if let Some(pen) = app.ui.pen.as_mut() {
pen.curvature = true;
}
assert!(dashes(&app) > 5, "Curvature Pen");
assert!(dashes(&drawing(Tool::FreeformPen)) > 5, "Freeform Pen");
}
#[test]
fn gear_popup_has_the_rubber_band_check_item() {
let mut h = harness(Tool::Pen);
assert!(h.query_by_label(RUBBER_BAND).is_none(), "only in the gear's popup");
let gear = h.get_by_label(GEAR).rect();
let auto = h.get_by_label("Auto Add/Delete").rect();
assert!(gear.right() <= auto.left() && (gear.center().y - auto.center().y).abs() < 4.0, "the gear sits before Auto Add/Delete: {gear:?} {auto:?}");
h.get_by_label(GEAR).click();
h.run_steps(4);
h.get_by_label(RUBBER_BAND).click();
h.run_steps(4);
assert!(h.state().ui.tool_options.pen_rubber_band, "the check item turns the option on");
h.get_by_label(RUBBER_BAND).click();
h.run_steps(4);
assert!(!h.state().ui.tool_options.pen_rubber_band, "and off again");
}
#[test]
fn only_the_pen_has_the_gear() {
for tool in [Tool::FreeformPen, Tool::CurvaturePen, Tool::AddAnchorPoint] {
assert!(harness(tool).query_by_label(GEAR).is_none(), "{tool:?}");
}
}
#[test]
fn the_setting_is_saved_inspected_and_reset() {
// Saved with the tool options; a save from before the option reads as off.
let mut v = serde_json::to_value(ToolOptions::default()).unwrap();
assert_eq!(v["pen_rubber_band"], json!(false));
v["pen_rubber_band"] = json!(true);
let on: ToolOptions = serde_json::from_value(v.clone()).unwrap();
assert!(on.pen_rubber_band);
v.as_object_mut().unwrap().remove("pen_rubber_band");
let old: ToolOptions = serde_json::from_value(v).unwrap();
assert!(!old.pen_rubber_band);
let mut app = drawing(Tool::Pen);
let ctx = egui::Context::default();
let inspect = |app: &mut PhotocraftApp| {
let (req, _rx) = ControlRequest::new("ui.inspect", json!({}));
match handle(app, &ctx, &req) {
Outcome::Done(v) => v["result"]["toolOptions"]["pen_rubber_band"].clone(),
_ => panic!("ui.inspect: expected an immediate reply"),
}
};
assert_eq!(inspect(&mut app), json!(false));
app.ui.tool_options.pen_rubber_band = true;
app.ui.tool_options.feather = 12.0;
assert_eq!(inspect(&mut app), json!(true));
// Reset Tool turns it off and leaves another tool's option alone.
crate::menus::invoke(&mut app, &ctx, "tool.reset", json!({})).unwrap();
assert!(!app.ui.tool_options.pen_rubber_band);
assert_eq!(app.ui.tool_options.feather, 12.0);
assert_eq!(inspect(&mut app), json!(false));
}