Files
OneCAD-Draft/src/scene/reference_only_tests.rs
T
Sebastian d24adc39b5 feat(scene): reference-only entities refuse the edit paths (API v9 host)
Host side of HostApi::set_reference_only: plugin-owned display geometry that
renders and snaps normally but must not be edited or picked by the person at
the screen, while the owning plugin keeps full write access through the host.

- Storage: a human-readable marker value in an XDATA record under the
  host-owned OCS APPID (registered on first use; foreign values survive
  verbatim; stale verbatim DWG EED is dropped on rewrite), so the flag
  round-trips DWG and DXF with the entity and cannot collide with plugin
  APPID namespaces.
- Grips: refresh_selected_grips yields none for a reference-only entity and
  an active grip edit on a newly designated target is cancelled like a
  locked-layer one.
- Picking: a reference-only wire flag extends the snap_only skips in every
  hit test, so a click passes through to the editable entity underneath, and
  box, window, lasso, fence and select-all gathers skip the designation;
  fills, solids and instanced meshes are excluded through the shared
  candidate handle set.
- Write policy: built-in user paths treat a reference-only entity like a
  locked-layer one (Scene::update_entity / update_entities refuse,
  erase_entities skips), while the plugin-owned variants
  (update_entity_plugin / erase_entities_plugin, mirroring the
  remove_entities editor split) and the whole HostSession surface write
  through. The MCP entities read exposes a top-level reference_only boolean
  and set_properties refuses with the reference_only failure code.
- Undo: the entity-write contract - a change joins a plugin-opened push_undo
  scope, a scope-less change is one undo step of its own, refusals and
  idempotent re-marks record nothing.
- Known limit: entities nested inside block instances (the block cache
  rebuilds instance wires without the flag).

Evidence: marking_flags_and_unmarking_clears,
foreign_values_under_the_host_app_id_survive, other_apps_are_untouched,
reference_only_refusals_record_no_undo_step,
reference_only_designation_composes_undo_like_entity_writes,
reference_only_survives_dxf_and_dwg_round_trips,
user_paths_refuse_and_plugin_paths_write_reference_only_entities,
select_all_visible_skips_reference_only_entities,
clicks_pass_through_reference_only_wires,
box_selections_skip_reference_only_wires,
entities_records_expose_the_reference_only_designation.
2026-10-13 12:38:53 +02:00

110 lines
3.4 KiB
Rust

//! Pick-side tests for the reference-only designation (API v9): clicks pass
//! through reference-only wires and box selections skip them.
use crate::scene::model::wire_model::WireModel;
use crate::scene::pick::hit_test;
use crate::scene::Scene;
use codec::Handle;
use glam::{DVec3, Mat4};
use iced::{Point, Rectangle, Size};
/// A view whose world coordinates map one-to-one onto screen coordinates
/// (the convention of `block_base_point_tests::WorldAsScreen`).
struct WorldAsScreen {
view_rot: Mat4,
eye: DVec3,
bounds: Rectangle,
}
impl WorldAsScreen {
fn new(extent: f32) -> Self {
Self {
view_rot: Mat4::from_scale(glam::Vec3::new(2.0 / extent, -2.0 / extent, 1.0)),
eye: DVec3::new(extent as f64 / 2.0, extent as f64 / 2.0, 0.0),
bounds: Rectangle::new(Point::ORIGIN, Size::new(extent, extent)),
}
}
fn at(&self, point: [f64; 3]) -> Point {
Point::new(point[0] as f32, point[1] as f32)
}
}
fn segment_wire(name: &str, from: [f64; 3], to: [f64; 3], reference_only: bool) -> WireModel {
WireModel {
name: name.to_owned(),
points: vec![
[from[0] as f32, from[1] as f32, from[2] as f32],
[to[0] as f32, to[1] as f32, to[2] as f32],
],
reference_only,
..WireModel::default()
}
}
fn click_at(point: [f64; 3], view: &WorldAsScreen, wires: &[WireModel]) -> Option<Handle> {
hit_test::click_hit(
view.at(point),
wires,
view.view_rot,
view.eye,
view.bounds,
false,
8.0,
&rustc_hash::FxHashMap::default(),
)
.and_then(Scene::handle_from_wire_name)
}
#[test]
fn clicks_pass_through_reference_only_wires() {
let view = WorldAsScreen::new(100.0);
let editable = segment_wire("1", [25.0, 25.0, 0.0], [75.0, 25.0, 0.0], false);
let reference = segment_wire("2", [25.0, 30.0, 0.0], [75.0, 30.0, 0.0], true);
let wires = [editable, reference];
// A click sitting exactly on the reference-only wire passes through to
// the editable wire 5 px away (inside the 8 px aperture).
assert_eq!(
click_at([50.0, 30.0, 0.0], &view, &wires),
Some(Handle::new(1)),
"a click on reference-only geometry must resolve to the entity underneath"
);
assert_eq!(
click_at([50.0, 25.0, 0.0], &view, &wires),
Some(Handle::new(1))
);
// With only the reference-only wire under the cursor the click misses.
let reference_only = [wires[1].clone()];
assert_eq!(click_at([50.0, 30.0, 0.0], &view, &reference_only), None);
assert_eq!(click_at([50.0, 25.0, 0.0], &view, &reference_only), None);
}
#[test]
fn box_selections_skip_reference_only_wires() {
let view = WorldAsScreen::new(100.0);
let editable = segment_wire("1", [25.0, 25.0, 0.0], [75.0, 25.0, 0.0], false);
let reference = segment_wire("2", [25.0, 30.0, 0.0], [75.0, 30.0, 0.0], true);
let wires = [editable, reference];
let hits = hit_test::box_hit(
view.at([10.0, 10.0, 0.0]),
view.at([90.0, 50.0, 0.0]),
false,
&wires,
view.view_rot,
view.eye,
view.bounds,
);
let handles: Vec<Handle> = hits
.into_iter()
.filter_map(Scene::handle_from_wire_name)
.collect();
assert_eq!(
handles,
vec![Handle::new(1)],
"a box selection must not pick reference-only geometry"
);
}