OFFSET uses a single preselected object (#1870)

* OFFSET uses a single preselected object (#1610)

With exactly one offsettable object selected before OFFSET, take it and go
to the side prompt instead of asking to select an object again; a multiple
selection keeps the select-object loop. AutoCAD ignores preselection here,
but this is the requested behaviour for users coming from other tools.

* docs: document the functions touched by #1610
This commit is contained in:
Nicholas Gower
2026-10-24 01:50:34 -04:00
committed by GitHub
parent b9d59c64ab
commit 4f282b30cc
2 changed files with 118 additions and 1 deletions
+32 -1
View File
@@ -564,6 +564,21 @@ impl Interactive for StretchM {
}
}
/// Whether OFFSET can work on this kind of object at all.
fn offsettable(k: &EntityKind) -> bool {
matches!(
k,
EntityKind::Line(_)
| EntityKind::Circle(_)
| EntityKind::Arc(_)
| EntityKind::Ellipse(_)
| EntityKind::LwPolyline(_)
| EntityKind::Spline(_)
| EntityKind::XLine(_)
| EntityKind::Ray(_)
)
}
/// Offset an entity by `dist` towards `side`. Returns the new geometry.
pub(crate) fn offset_kind(k: &EntityKind, dist: f64, side: Vec2) -> Option<EntityKind> {
match k {
@@ -2239,8 +2254,24 @@ impl Interactive for OffsetM {
fn name(&self) -> &'static str {
"OFFSET"
}
/// Starts OFFSET, keeping a single preselected offsettable object (issue #1610) so the prompt
/// sequence goes distance then side instead of asking for the object again; any other
/// selection is cleared and the object loop asks for it. With PICKFIRST off the selection is
/// likewise ignored and cleared.
fn begin(&mut self, s: &mut Session) -> Result<Step> {
s.set_selection(Vec::new());
// Exactly one offsettable object selected before the command is taken at once, so only the
// side is asked for; the object loop stays for the ones after it (issue #1610). A multiple
// selection is left for the select prompt, as AutoCAD does.
let pre = s.selection();
if s.settings.pickfirst
&& let [h] = pre[..]
&& s.doc()?.entity(h).is_some_and(|e| offsettable(&e.kind))
{
self.picked = Some(h);
s.set_selection(vec![h]);
} else {
s.set_selection(Vec::new());
}
let (erase, current) = offset_options(s);
s.echo(format!(
"Current settings: Erase source={} Layer={} OFFSETGAPTYPE=0",
@@ -0,0 +1,86 @@
//! OFFSET uses a single object selected before the command (issue #1610): drawing a rectangle,
//! selecting it and starting OFFSET used to ask for the object again. Now the preselected object
//! goes straight to the side prompt; a multiple selection still asks which object to offset.
use cadcraft_engine::Session;
use cadcraft_engine::doc::{EntityKind, Handle};
use serde_json::json;
/// Every line as ((ax, ay), (bx, by)), sorted by the first y.
fn lines(s: &Session) -> Vec<((f64, f64), (f64, f64))> {
let mut v: Vec<_> = s
.doc()
.unwrap()
.model
.iter()
.filter_map(|e| if let EntityKind::Line(l) = &e.kind { Some(((l.a.x, l.a.y), (l.b.x, l.b.y))) } else { None })
.collect();
v.sort_by(|a, b| a.0.1.total_cmp(&b.0.1).then(a.0.0.total_cmp(&b.0.0)));
v
}
/// A session with two horizontal lines at y=0 and y=5 and their handles in drawing order.
fn two_lines() -> (Session, Vec<Handle>) {
let mut s = Session::new();
s.script("LINE 0,0 10,0\n\nLINE 0,5 10,5\n\n").unwrap();
let hs: Vec<_> = s.doc().unwrap().model.iter().map(|e| e.handle).collect();
(s, hs)
}
/// The message of the current prompt, or an empty string when no command is running.
fn prompt(s: &Session) -> String {
s.current_prompt().map(|p| p.message.clone()).unwrap_or_default()
}
/// Guards #1610: one preselected line is remembered on start, so after the distance only the side
/// point is asked for and the offset copy lands on that side; the object loop still runs afterwards.
#[test]
fn one_preselected_object_goes_straight_to_the_side_prompt() {
let (mut s, hs) = two_lines();
s.set_selection(vec![hs[0]]);
s.cmdline("OFFSET").unwrap();
// The distance still comes first (as without a selection)...
assert!(prompt(&s).contains("Specify offset distance"), "{}", s.prompt_text());
s.cmdline("2").unwrap();
// ...then the preselected line is taken and only the side is asked for.
assert!(prompt(&s).contains("Specify point on side to offset"), "{}", s.prompt_text());
s.cmdline("5,1").unwrap();
assert_eq!(lines(&s), vec![((0.0, 0.0), (10.0, 0.0)), ((0.0, 2.0), (10.0, 2.0)), ((0.0, 5.0), (10.0, 5.0))]);
// The command keeps its object loop for further objects.
assert!(prompt(&s).contains("Select object to offset"), "{}", s.prompt_text());
s.cmdline("").unwrap();
assert!(s.running.is_none());
}
/// Guards that a multiple preselection is not silently reduced: OFFSET still asks which one object
/// to offset, then offsets only the one picked, as AutoCAD does.
#[test]
fn two_preselected_objects_still_ask_to_select_one() {
let (mut s, hs) = two_lines();
s.set_selection(hs);
s.cmdline("OFFSET").unwrap();
s.cmdline("2").unwrap();
assert!(prompt(&s).contains("Select object to offset"), "{}", s.prompt_text());
s.cmdline("5,0").unwrap();
assert!(prompt(&s).contains("Specify point on side to offset"), "{}", s.prompt_text());
s.cmdline("5,2").unwrap();
assert_eq!(lines(&s), vec![((0.0, 0.0), (10.0, 0.0)), ((0.0, 2.0), (10.0, 2.0)), ((0.0, 5.0), (10.0, 5.0))]);
assert!(prompt(&s).contains("Select object to offset"), "{}", s.prompt_text());
s.cmdline("").unwrap();
assert!(s.running.is_none());
}
/// Guards that a preselected object OFFSET cannot offset (here a text entity) is cleared, so the
/// command falls back to asking for the object instead of jumping to the side prompt.
#[test]
fn one_preselected_non_offsettable_object_still_asks_to_select() {
let mut s = Session::new();
s.execute("text", &json!({ "at": [0, 0], "text": "NOTE", "height": 2 })).unwrap();
let h = s.doc().unwrap().model.iter().next().unwrap().handle;
s.set_selection(vec![h]);
s.cmdline("OFFSET").unwrap();
s.cmdline("2").unwrap();
assert!(prompt(&s).contains("Select object to offset"), "{}", s.prompt_text());
s.cmdline("").unwrap();
assert!(s.running.is_none());
}