brep_render/engine_state.rs
1//! [`EngineState`] — the windowing-agnostic viewer state machine the host UI
2//! programs against (R3): scene + camera + controls + settings + emphasis, plus
3//! the whole event/command/query surface (run-history feed, pointer/wheel
4//! ingestion, camera commands, picking, world→screen, visibility). No GPU, no
5//! canvas — the wasm `Engine` and the winit desktop shell both wrap this; it is
6//! fully unit-testable on native.
7//!
8//! Everything crosses the R3 boundary as plain JSON/scalars: the host never holds a
9//! renderer object, only names, ids, and JSON.
10
11use crate::controls::ArcballControls;
12use crate::history::History;
13use crate::pick::{self, PickOptions};
14use crate::scene::RenderScene;
15use crate::style::{Emphasis, RenderSettings};
16use crate::view::ViewCamera;
17use crate::widgets::{gizmo_camera, WidgetOverlay, WidgetRegistry};
18use brep_kernel::HistoryRequest;
19use std::collections::HashMap;
20
21/// One DIALOG row's hover state — which panel lit it, the row's own TEXT, and
22/// what that text resolved to in the scene.
23///
24/// The row text is the memo key rather than the candidate's name because the two
25/// differ whenever the derived-face fallback fires (a fillet's `Edges` row reads
26/// `A|B[0]` while the face it lights is `F1:BLEND:A|B[0]` — see
27/// [`EngineState::hover_entity_by_name`]). An unresolvable row memoizes as
28/// `candidate: None`, so a held hover over a name the scene does not carry scans
29/// the scene ONCE, not once per frame.
30#[derive(Clone)]
31pub(crate) struct DialogHover {
32 /// Which panel set it (`"history"`, `"constraints"`, `"pmi"`, `"refsel"`) —
33 /// [`EngineState::dialog_hover_end`] acts only for the owner that set it, so a
34 /// pane that never hovered a row cannot end another pane's hover.
35 pub(crate) owner: &'static str,
36 /// The row's TEXT, exactly as the dialog listed it.
37 pub(crate) row: String,
38 /// What it resolved to, or `None` for a row the scene does not carry.
39 pub(crate) candidate: Option<pick::PickCandidate>,
40}
41
42pub struct EngineState {
43 pub scene: RenderScene,
44 /// Display-only assembly surroundings in the active work part frame. Never picked or saved.
45 pub context_scene: RenderScene,
46 /// The Work part CONTEXT face clicked / hovered ([`Self::context_hit_at`]):
47 /// kept apart from [`Self::emphasis`], so no selection consumer (feature
48 /// prefill, references, plugins, metadata) ever sees a name the part's own
49 /// kernel cannot resolve.
50 pub(crate) context_selected: Option<crate::pick::PickCandidate>,
51 pub(crate) context_hovered: Option<crate::pick::PickCandidate>,
52 /// Ghosts (context solids) lit WHOLE by a running instructions occurrence
53 /// pick whose names they are (`sync_ref_select_emphasis`): every face of
54 /// each goes into the context highlight. Cleared when the pick ends.
55 pub(crate) context_pick_lit: Vec<String>,
56 /// How the context is shown: kept across context rebuilds and Work parts.
57 pub(crate) context_display: crate::engine_state::context_pick::ContextDisplay,
58 pub camera: ViewCamera,
59 pub controls: ArcballControls,
60 pub settings: RenderSettings,
61 pub emphasis: Emphasis,
62 /// In-scene overlay widgets: datums/dimensions/curves, transform
63 /// gizmo, ViewCube — fed as JSON, drawn by the render core's overlay pass.
64 pub widgets: WidgetRegistry,
65 /// The engine-owned editable model recipe (ordered features + rollback
66 /// index) — the SINGLE source of truth for the model. The UI never keeps its
67 /// own copy; it mutates/reads this through the `history_*` / feature methods.
68 pub history: History,
69 interference_sessions: std::collections::BTreeMap<String, interference::InterferenceCursor>,
70 interference_sequence: u64,
71 illustration_snapshot: Option<illustration::IllustrationSnapshot>,
72 geometry_diagnostics: std::collections::BTreeMap<String, serde_json::Value>,
73 /// A single feature staged by [`EngineState::stage_feature_begin`] whose
74 /// run has not landed yet (an agent's write; `batch.rs`).
75 staged_feature: Option<batch::StagedFeature>,
76 /// `History::busy_refused` already reported to the user.
77 busy_refused_seen: u64,
78 /// The build report (`{featureErrors, unresolved, displayErrors}`) of the
79 /// last history run, so the UI can show it without re-running.
80 history_report: String,
81 /// The Properties-panel metadata store: user attributes keyed by OBJECT NAME
82 /// (solid / face / edge kernel name), NOT feature id — so a record survives
83 /// feature edits as long as the object's name persists. Persisted with the
84 /// model (a top-level `metadata` field in the history document); see the
85 /// [`crate::metadata`] module for the store + the object-info/measurement API.
86 pub metadata: crate::metadata::MetadataStore,
87 /// Derived preview data stays outside the recipe and undo history: the
88 /// document's own picture at a history edit serial (opened with it, or the
89 /// last one a save rendered), and the last picture a save produced by key.
90 document_thumbnail: std::cell::RefCell<Option<(u64, serde_json::Value)>>,
91 thumbnail_cache: std::cell::RefCell<Option<(Vec<u64>, serde_json::Value)>>,
92 /// Bumped whenever settings change so the renderer re-derives per-solid
93 /// base styles (a cheap key, not a per-frame diff).
94 pub settings_generation: u64,
95 /// The engine sets this whenever the camera/scene/emphasis changed; the
96 /// presentation shell renders only when it is set (R22 on-demand render —
97 /// the OrthoCameraIdle matrix-compare analogue, made explicit).
98 pub dirty: bool,
99 /// The modal reference-selection state (the ref-select widget). `Some` while
100 /// the user is picking references for a feature-dialog field; `None`
101 /// otherwise. The picked-name list here is the SINGLE source of truth while
102 /// active (the UI reads it back; the viewport appends to it on a pick).
103 pub ref_select: Option<RefSelectState>,
104 /// A finished REPLACE REPAIR pick `(mate, old ref, picked name)` waiting
105 /// for the replace dialog, which owns the remap (nested components
106 /// included) — see [`RefSelectTarget::ReplaceRepair`].
107 pub(crate) replace_repair_pick: Option<(String, String, String)>,
108 /// Which entity KINDS a plain viewport click may select (the selection
109 /// filter, mirroring the earlier `SelectionFilter.allowedSelectionTypes`). `select_top_at`
110 /// consults it via `pick_filtered`; see the appended `SelectionFilter` impl
111 /// block near the end of this file for the state + honoring logic.
112 pub selection_filter: SelectionFilter,
113 /// The transform-controls gizmo controller: which feature (if any) has the
114 /// move/rotate gizmo armed (via the in-viewport center-sphere toggle), plus the
115 /// in-flight handle drag. All the arm/drag/apply logic lives in the appended
116 /// transform-gizmo impl block near the end of this file.
117 pub transform_gizmo: TransformArm,
118 /// The COMPONENT Move gizmo controller (assemblies §8.5): which ACOMP
119 /// instance has the bbox-center move/rotate gizmo armed, the translate/
120 /// rotate cycle mode, and the commit-on-release drag. Exclusive with
121 /// `transform_gizmo` (shared widget slot). See `component_move.rs`.
122 pub component_move: ComponentMoveArm,
123 /// The active engine-native sketch edit (`Some` while in sketch mode). Holds
124 /// the live [`crate::sketch::SketchSession`] plus the pre-entry camera + roll
125 /// to restore on exit. All the enter/exit/new logic lives in the appended
126 /// sketch-mode impl block at the END of this file.
127 sketch_edit: Option<SketchEdit>,
128 /// The active engine-native 3D SKETCH edit (`Some` while in 3D sketch
129 /// mode): the live [`crate::sketch3d::Sketch3dSession`] plus the pre-entry
130 /// camera + roll. See `sketch3d_mode.rs`.
131 sketch3d_edit: Option<Sketch3dEdit>,
132 /// The `world_per_pixel` the 3D sketch overlay was last baked at (its
133 /// working-plane and reference-plane squares are pixel-sized); `0.0` =
134 /// not in 3D sketch mode.
135 pub(crate) sketch3d_overlay_wpp: f64,
136 /// Sketch-mode camera lock. When true (the default on every sketch entry), the
137 /// camera is held flat-on to the sketch plane and an empty drag only PANS —
138 /// no orbit. Toggling it back on re-faces the camera to the plane. Meaningful
139 /// only while `sketch_edit` is `Some`. See the sketch-mode impl block.
140 sketch_camera_locked: bool,
141 /// Set for ONE frame when the sketch entity-LIST panel hovers a row (it calls
142 /// [`sketch_hover_entity`](Self::sketch_hover_entity)). The viewport, which
143 /// draws AFTER the panel and would otherwise `sketch_clear_hover` because the
144 /// pointer is off the viewport, consumes this flag via
145 /// [`take_sketch_list_hover`](Self::take_sketch_list_hover) and keeps the
146 /// panel-set hover so list→canvas highlight survives the frame.
147 sketch_list_hover_active: bool,
148 /// Transient user-facing notices (e.g. a sketch solve that failed after an
149 /// edit). The shell drains them each frame via [`take_notices`](Self::take_notices)
150 /// into a toast overlay; the engine only queues. Replaces the swallowed
151 /// `eprintln!` on the interactive re-solve paths.
152 notices: Vec<String>,
153 /// Notices that are NOT errors — a warning, or a success such as "Updated 2
154 /// part(s)" — with their severity, queued by
155 /// [`push_notice_as`](Self::push_notice_as). Beside [`Self::notices`] rather
156 /// than in it, so every existing `push_notice` stays an error unchanged.
157 graded_notices: Vec<(NoticeSeverity, String)>,
158 /// Committed-sketch visibility: the feature ids whose persistent committed-sketch
159 /// overlay is HIDDEN (its Scene-tree checkbox off). Absent = visible. See the
160 /// committed-sketch impl block appended at the END of this file.
161 hidden_sketches: std::collections::HashSet<String>,
162 /// The committed-sketch feature ids whose overlay groups were fed on the LAST
163 /// [`refresh_committed_sketches`](Self::refresh_committed_sketches), so an id that
164 /// is no longer shown (rolled back, deleted, hidden, or became the active edit)
165 /// can have its now-stale groups cleared.
166 shown_sketch_ids: Vec<String>,
167 /// The board bodies fed on the LAST
168 /// [`refresh_board_geometry`](Self::refresh_board_geometry), in stack order,
169 /// so a body this build did not produce can be swept out of the scene.
170 /// Parallels [`shown_sketch_ids`].
171 shown_board_ids: Vec<String>,
172 /// The eCAD board those bodies were built from — the rebuild test. A
173 /// SCHEMATIC edit rewrites the whole `pcb` block with the same board inside
174 /// it, and this is what makes that edit free.
175 board_built_from: Option<brep_ecad_core::board::Board>,
176 /// The pin-to-net map those bodies' NET COLOURS were built from. The board
177 /// alone does not decide them — a copper island carries the net of the pads
178 /// it touches, and which net a pad carries is the SCHEMATIC's answer — so
179 /// this is the second half of the rebuild test. Empty for a board with no
180 /// placements, which can carry no net at all.
181 board_pin_nets: std::collections::BTreeMap<(brep_ecad_core::Uuid, String), String>,
182 /// What that build cost, for the Scene tree and the tests.
183 board_build: board_geometry::BoardBuild,
184 /// The built bodies themselves, KEPT across runs. The scene reconcile drops
185 /// every derived body, so without this a dense board would be re-meshed on
186 /// every history run; a clone of these is what goes back in instead.
187 board_displays: Vec<crate::scene::SolidDisplay>,
188 /// The named plane FRAMES the last history run resolved `(frame name, frame)`.
189 /// Stored so [`refresh_construction_datums`](Self::refresh_construction_datums)
190 /// (and datum selection) can display/pick the construction datum/plane frames
191 /// without re-running. Filled from the run's
192 /// [`crate::pipeline::SceneBuildReport::frames`]; the D/P filter is applied at
193 /// display time (a frame name maps to its producing feature TYPE via the
194 /// history). See the appended construction-datum impl block at the END.
195 construction_frames: Vec<(String, brep_kernel::Frame)>,
196 /// The solved sketch PROFILES the last history run produced `(sketch id,
197 /// profile)`. Stored so [`refresh_committed_sketches`](Self::refresh_committed_sketches)
198 /// can synthesize each committed sketch's SHEET SOLID (planar face + named
199 /// boundary edges + corner vertices) without re-running. Filled from the run's
200 /// [`crate::pipeline::SceneBuildReport::profiles`]; rollback / active-edit /
201 /// visibility gating is applied at display time.
202 sketch_profiles: Vec<(String, brep_kernel::SketchProfile)>,
203 /// The named PATH chains the last history run produced `(path name, curves)`.
204 /// Stored alongside [`sketch_profiles`](Self::sketch_profiles) so
205 /// [`refresh_committed_sketches`](Self::refresh_committed_sketches) can draw the
206 /// sketch geometry no closed profile covers: a sketch's OPEN chain publishes no
207 /// profile, so the sheet builder had nothing to draw it from and an open sketch
208 /// was invisible in 3D. Filled from the run's
209 /// [`crate::pipeline::SceneBuildReport::paths`]; the per-segment `{id}:G{gid}`
210 /// entries are the display input (the whole-chain `{id}` entry duplicates them
211 /// and `{id}:REF:{source}` is projected reference geometry).
212 sketch_paths: Vec<(String, Vec<brep_kernel::NurbsCurve>)>,
213 /// The named world POINTS the last history run produced `(point name, point)`.
214 /// Stored alongside [`sketch_paths`](Self::sketch_paths) so
215 /// [`refresh_committed_sketches`](Self::refresh_committed_sketches) can draw the
216 /// sketch points no segment covers: a points-only sketch (a hole-placement
217 /// sketch) publishes no profile and no path, so it had nothing to draw from
218 /// and was invisible in 3D. Filled from the run's
219 /// [`crate::pipeline::SceneBuildReport::points`]; the per-point `{id}:P{pid}`
220 /// entries are the display input (construction points are skipped at draw
221 /// time, like construction geometry).
222 sketch_points: Vec<(String, brep_kernel::ScenePoint)>,
223 /// The named axis LINES the last history run produced `(axis name, line)`.
224 /// Stored so the feature-dimension angle gizmo can resolve a revolve `axis`
225 /// reference to a world line without re-running. Filled from the run's
226 /// [`crate::pipeline::SceneBuildReport::axes`].
227 sketch_axes: Vec<(String, brep_kernel::Axis)>,
228 /// The wire-harness routing report of the last APPLIED run (`None` before
229 /// the first run). Filled from [`crate::pipeline::SceneBuildReport::wire_harness`];
230 /// the harness panel reads it, the committed-curve display reads the port
231 /// kinds off it. See the appended wire-harness impl block.
232 wire_harness_report: Option<brep_kernel::WireHarnessReport>,
233 /// The PORTS tail's report of the last APPLIED run (`None` before the first
234 /// run, and for a document that declares no `ports` block). Filled from
235 /// [`crate::pipeline::SceneBuildReport::ports`]; the Qualify panel reads it,
236 /// and it is the only place the tail's refused names and unresolved
237 /// references surface, the tail not being a feature.
238 ports_report: Option<brep_kernel::PortsReport>,
239 /// The PMI tail's report of the last APPLIED run (`pmi_ops.rs`).
240 pub(crate) pmi_report: Option<brep_kernel::PmiReport>,
241 /// The ACTIVE PMI view (engine memory, never persisted): its camera,
242 /// display state and explode poses are applied; its annotations drawn.
243 pub(crate) pmi_active_view: Option<String>,
244 /// The annotation whose form the PMI panel shows (engine memory). Never
245 /// assign `Some` here: go through [`EngineState::open_pmi_annotation`], the
246 /// one place that counts the open.
247 pub(crate) pmi_open_annotation: Option<String>,
248 /// The VIEW whose form the PMI panel shows (engine memory) — exclusive
249 /// with [`Self::pmi_open_annotation`], since the pane shows one dialog.
250 /// Never assign `Some` here: go through [`EngineState::open_pmi_view`].
251 pub(crate) pmi_open_view: Option<String>,
252 /// The annotation SELECTED in the PMI tree or by its viewport label: the
253 /// tree row's highlight and the label's accent. Cleared with the selection
254 /// (Esc / Clear / a click on empty space); read through
255 /// [`EngineState::pmi_selected_annotation`], which prunes a stale id.
256 pub(crate) pmi_selected_annotation: Option<String>,
257 /// The VIEW selected in the PMI tree — its row's highlight. Selecting a
258 /// view never ACTIVATES it (a double click does); exclusive with
259 /// [`Self::pmi_selected_annotation`], since the tree selects one row.
260 /// Read through [`EngineState::pmi_selected_view`], which prunes a stale id.
261 pub(crate) pmi_selected_view: Option<String>,
262 /// How many times a PMI dialog — an annotation's or a view's — has been
263 /// OPENED: monotonic, never reset, closes do not count. The app's dialog
264 /// door keys on it beside the subject so a re-open of the dialog that is
265 /// ALREADY open is still one open event (a viewport label double click on the
266 /// annotation whose form is up, which a user makes precisely because they
267 /// are on another tab).
268 pub(crate) pmi_dialog_opens: u64,
269 /// The modeling camera / visibility / wireframe remembered on entering
270 /// the PMI workbench, restored when a view deactivates or the workbench
271 /// is left.
272 pub(crate) pmi_modeling: Option<pmi_ops::PmiModelingSnapshot>,
273 /// The un-exploded displays of the solids the active view's explode
274 /// annotations posed, for an exact restore.
275 pub(crate) pmi_explode_originals: std::collections::HashMap<String, crate::scene::SolidDisplay>,
276 /// How far the active view's explode steps are shown, and any Explode /
277 /// Collapse animation (`exploded_ops`). Display state, never saved.
278 pub(crate) explode_playback: exploded_ops::ExplodePlayback,
279 /// The motion study being played or scrubbed and its bake
280 /// (`simulation_play`). Display state, never saved.
281 pub(crate) simulation_play: Option<simulation_play::SimulationPlayback>,
282 /// Solids the active view's section removes whole: hidden (no copy, no
283 /// re-upload) rather than clipped, and shown again on restore.
284 pub(crate) pmi_section_hidden: Vec<String>,
285 /// Bumped when an un-posed original's `visible` changes (a user or view
286 /// hide while the active view poses or sections that solid): sheets
287 /// draw from the originals, so their cache key carries it.
288 pub(crate) pmi_unposed_visibility: u64,
289 /// The `pmi` block parsed, keyed by the history revision it was parsed
290 /// at ([`Self::pmi_state_shared`]): every write to the saved document,
291 /// undo and redo included, moves that revision.
292 pub(crate) pmi_state_cache: std::cell::RefCell<Option<(u64, std::rc::Rc<brep_kernel::PmiState>)>>,
293 /// A balloon whose dragged bubble could not be re-projected yet because
294 /// the scene did not hold its occurrence's exact solids: re-derived when
295 /// the topology reply lands (`pmi_refresh_stale_balloon`).
296 pub(crate) pmi_balloon_stale: Option<String>,
297 /// `(world_per_pixel, view direction)` the PMI overlay was last baked at.
298 pub(crate) pmi_overlay_key: Option<(f64, [f64; 3])>,
299 pub(crate) pmi_hovered: Option<String>,
300 pub(crate) pmi_label_hover_active: bool,
301 /// The sheet the sheet viewport shows (engine memory, never persisted).
302 /// `None` = the 3D view (`sheet_ops.rs`).
303 pub(crate) sheet_open: Option<String>,
304 /// The sheet or placed view whose form the Sheets pane shows. Never assign
305 /// `Some` here: go through [`EngineState::open_sheet_object`], the one
306 /// place that counts the open.
307 pub(crate) sheet_open_object: Option<String>,
308 /// How many times a sheet object's form has been OPENED — the sheet half
309 /// of the same counter as [`Self::pmi_dialog_opens`], read by the
310 /// app's dialog door so a re-open of the object already open still counts.
311 pub(crate) sheet_object_opens: u64,
312 /// The placed view, sheet dimension or ordinate set SELECTED in the Sheets
313 /// tree or on the paper: the tree row's highlight and the object's accent
314 /// on the sheet. Cleared with the selection; read through
315 /// [`EngineState::sheet_selected_object`], which prunes a stale id.
316 pub(crate) sheet_selected_object: Option<String>,
317 /// The last projected sheet, kept until the model or the block moves: a
318 /// sheet is a hidden-line pass over the whole model and must never run
319 /// per frame.
320 pub(crate) sheet_cache: Option<sheet_ops::SheetCache>,
321 /// The sheet's exact passes on the runner and waiting for it.
322 pub(crate) sheet_lines: sheet_ops::SheetLinesWork,
323 /// The open document's name, as the shell means it (the tab, the file, the
324 /// root PRODUCT of a STEP export). Engine memory, never persisted: the
325 /// document does not carry its own name, the SHELL owns it, and it is here
326 /// because a drawing sheet's TITLE BLOCK prints it. Set every frame by the
327 /// app from the active tab (a no-op when unchanged).
328 pub(crate) document_name: String,
329 /// What the spline-anchor cage overlay was last fed for — `(spline id,
330 /// selected anchor, applied run generation)` — so the per-frame refresh
331 /// the history panel makes while an SP form is open is a no-op until one
332 /// of those moves. See `spline_edit.rs`.
333 spline_overlay_key: Option<(String, Option<usize>, u64)>,
334 /// The CAM workbench's generation queue and results (`cam_ops.rs`).
335 pub cam: cam_ops::CamGeneration,
336 /// Whether the ports placed components carry (`ACOMP1:PORT1`) draw their
337 /// sheets. The app sets it from the active workbench — one that shows the
338 /// Wire Harness panel; a document's own PORT features always draw.
339 component_ports_visible: bool,
340 /// The spline whose anchor editor is open (fed by the history panel with
341 /// the cage overlay), so a viewport click on one of its anchor dots selects
342 /// that anchor; the index of the last such pick, until the panel takes it.
343 spline_edit_feature: Option<String>,
344 spline_anchor_picked: Option<usize>,
345 /// The NURBS solid whose control-cage editor is open (fed by the history
346 /// panel with the cage overlay) and what that overlay was last fed for —
347 /// `(feature id, selected points, applied run generation)`. The selection
348 /// itself is the transform gizmo's (`TransformArm::cage`). See
349 /// `cage_edit.rs`.
350 cage_edit_feature: Option<String>,
351 cage_overlay_key: Option<(String, Vec<usize>, u64)>,
352 /// Construction datum/plane visibility: the frame NAMES whose datum plane is
353 /// HIDDEN (its Scene-tree checkbox off). Absent = visible. Mirrors
354 /// [`hidden_sketches`].
355 hidden_datums: std::collections::HashSet<String>,
356 /// The datum frame NAMES fed to the widget on the LAST
357 /// [`refresh_construction_datums`](Self::refresh_construction_datums). The datum
358 /// feed REPLACES its set wholesale each call, so this is a bookkeeping mirror of
359 /// what is currently shown (parallels [`shown_sketch_ids`]).
360 shown_datum_names: Vec<String>,
361 /// The history-run seam (M2a of the off-thread runner). Owns the scene-free
362 /// runner + its delta baseline (`name → last-emitted handle`) ACROSS reruns:
363 /// [`rerun_history`](Self::rerun_history) SUBMITS a run tagged with
364 /// [`run_generation`](Self::run_generation), and [`pump`](Self::pump) drains
365 /// the completed reply and [`apply_run_output`](Self::apply_run_output)s its
366 /// delta to [`Self::scene`]. The [`InlineRunner`](crate::runner::InlineRunner)
367 /// default runs synchronously (submit → immediate poll, byte-identical to the
368 /// old in-place reconcile); a background thread/worker impl slots in behind the
369 /// same trait in M2b/M3. Reset on a document switch
370 /// ([`set_history_json`](Self::set_history_json)) so a new model rebuilds fully.
371 pub(crate) runner: Box<dyn crate::runner::HistoryRunner>,
372 plugins: plugins::Plugins,
373 /// Monotonic run counter: bumped each time [`rerun_history`](Self::rerun_history)
374 /// SUBMITS a run, and stamped onto the reply so a stale reply (a newer run that
375 /// finished first) can be dropped. `run_generation != applied_generation` means
376 /// a run is in flight (always equal for the synchronous Inline runner).
377 run_generation: u64,
378 /// The generation of the last reply [`pump`](Self::pump) APPLIED — the high-water
379 /// mark that gates stale replies.
380 applied_generation: u64,
381 /// The latest [`crate::runner::RunProgress`] of the run in flight (a
382 /// background runner posts one before each feature it executes), or
383 /// `None` when nothing is running. Names what the spinner is waiting on.
384 run_progress: Option<crate::runner::RunProgress>,
385 /// The feature the last CANCELLED run was executing (`Some("")` when the
386 /// run was cancelled before any progress arrived), cleared by the next
387 /// submit. The history header shows it until the model is rebuilt.
388 cancelled_run: Option<String>,
389 /// A TRANSIENT expressions source the runs evaluate instead of the
390 /// document's own (the family table's row preview). Never written into
391 /// the history: not saved, not undone, not dirty. See
392 /// [`Self::set_expression_preview`].
393 expression_preview: Option<ExpressionPreview>,
394 /// How many run replies came back from the runner (applied or dropped as
395 /// stale). A run the runner coalesced away never replies, so this counts
396 /// the runs actually EXECUTED.
397 runs_replied: u64,
398 /// Displays shipped by replies [`pump`](Self::pump) DROPPED as superseded,
399 /// by solid name, latest wins. A background runner executes every run it
400 /// is handed and its delta baseline (`name → last-emitted handle`) advances
401 /// on each, so a later reply can say "unchanged, keep yours" about a
402 /// display that only ever travelled in a dropped reply (the reporter's
403 /// arrow-head drag: the frame that built the new radius was superseded by
404 /// the still-pointer frames that replayed its handle). The keep is served
405 /// from here when the scene's display is not the handle it names. Cleared
406 /// with the runner's baseline (document switch, cancel) and whenever a
407 /// fresh display for the name is applied.
408 superseded_displays: HashMap<String, crate::scene::SolidDisplay>,
409 /// A pending one-shot "frame the scene once the in-flight run lands" request.
410 /// Import / Open SUBMIT an async run (native [`ThreadRunner`], wasm worker) and
411 /// want to `zoom_to_fit` the RESULT — but the scene is still empty when they
412 /// return, so an immediate fit frames nothing (bbox empty → no-op). Instead they
413 /// set this flag and [`pump`](Self::pump) performs the fit on the first apply that
414 /// leaves the run no longer pending. Under the synchronous Inline runner the run
415 /// applies inside the submitting call's own `pump`, so the fit is still immediate.
416 pending_fit: bool,
417 /// The instructions wizard waits for the run that places the wrapper:
418 /// its step views read the solids that run makes. [`pump`](Self::pump)
419 /// runs it once no run is pending.
420 instructions_wizard_pending: bool,
421 /// A re-target folded new steps in: their views wait for the run that
422 /// builds the new revision's solids, like the wizard's.
423 instructions_views_pending: bool,
424 /// The in-app player's insertion motion: the shown step's arrowed parts
425 /// moving home ([`instructions_ops::Insertion`]).
426 pub(crate) instructions_insertion: Option<instructions_ops::Insertion>,
427 /// EAGER provenance `name → creating-feature id` for the current resident
428 /// solids, shipped with each run ([`crate::pipeline::RunOutput::provenance`]) and
429 /// replaced wholesale in [`apply_run_output`](Self::apply_run_output). Answers
430 /// `creating_feature` + the Info tab's `creatingFeature` WITHOUT a cold
431 /// `execute_history` — the freeze side-door once the run lives off-thread.
432 pub(crate) provenance: std::collections::HashMap<String, String>,
433 /// EAGER ENTITY ORIGIN `face/edge NAME → ORIGINATING feature id` (FIRST writer in
434 /// timeline order), shipped with each run
435 /// ([`crate::pipeline::RunOutput::entity_origin`]) and replaced wholesale in
436 /// [`apply_run_output`](Self::apply_run_output). Unlike `provenance` (the SOLID's
437 /// LAST writer) this is the feature that gave the face/edge its NAME — the answer
438 /// `creating_feature` returns for a face/edge (the "Edit owning feature" action +
439 /// the Info tab's `creatingFeature`), so it rolls to the entity's origin, not the
440 /// owning solid's last producer.
441 pub(crate) entity_origin: std::collections::HashMap<String, String>,
442 /// Object-info MEASUREMENT cache `name → merged object-info JSON`, filled by
443 /// [`pump_queries`](crate::metadata) from the runner's replies and served every
444 /// frame a selection persists (so `object_info_json` fires ONE query per
445 /// selection, not one per frame). Invalidated on any geometry change
446 /// (`apply_run_output`) or metadata edit (`set_metadata_attribute`).
447 pub(crate) info_cache: std::collections::HashMap<String, String>,
448 /// In-flight measurement queries `id → object NAME` — the key needed to MERGE a
449 /// reply back into the info cache (inject `name` + `creatingFeature`, the latter
450 /// now resolved by the entity name itself). Cleared alongside `info_cache` on a
451 /// geometry change so a stale reply is dropped rather than caching a superseded
452 /// measurement.
453 pub(crate) pending_query: std::collections::HashMap<u64, String>,
454 /// Monotonic measurement-query id (pairs a [`crate::runner::MeasureReply`] back
455 /// with its `pending_query` entry).
456 pub(crate) next_query_id: u64,
457 /// Off-thread mesh reconstructions awaiting a runner reply.
458 pub(crate) pending_mesh_imports: std::collections::HashMap<u64, MeshImportDestination>,
459 pub(crate) mesh_preview_results: std::collections::VecDeque<crate::runner::MeshImportReply>,
460 /// Monotonic id for pairing mesh import replies with submissions.
461 pub(crate) next_mesh_import_id: u64,
462 /// Topology requests in flight (see [`crate::runner::TopologyRequest`]).
463 pub(crate) pending_topology: std::collections::HashSet<u64>,
464 /// Every resident handle asked for since the last applied run, answered or
465 /// not: a handle the runner could not clone is not asked for again until a
466 /// run brings new handles.
467 pub(crate) topology_asked: std::collections::HashSet<u32>,
468 /// Monotonic id for pairing topology replies with requests.
469 pub(crate) next_topology_id: u64,
470 /// The run's ASSEMBLY tail as the runner read it
471 /// ([`crate::pipeline::AssemblySync`]) — the constraint state, statuses, DOF
472 /// and overlay rows every assembly panel reads, adopted from the reply of the
473 /// last applied run. `None` for a componentless document. This is what
474 /// replaced the second, main-side `execute_history`: see `assembly_ops`.
475 pub(crate) assembly_sync: Option<crate::pipeline::AssemblySync>,
476 /// The scene's assembly COMPONENT records (deterministic id order), adopted
477 /// from [`Self::assembly_sync`] — the Assembly Structure tree's source.
478 /// Empty for componentless documents.
479 pub(crate) assembly_components: Vec<crate::pipeline::ComponentSnapshot>,
480 /// The [`Self::applied_generation`] the main-side kernel assembly SESSION was
481 /// last installed for (`None` = never). Only a constraint MUTATION needs one
482 /// — its solve runs against the resident geometry of the thread that asks —
483 /// so only `ensure_assembly_session` sets this. See `assembly_ops`.
484 pub(crate) assembly_session_generation: Option<u64>,
485 /// The kernel's session serial when this document's session was put in
486 /// place: the kernel session is one per thread, shared by every open
487 /// document, so a moved serial means another one replaced it.
488 pub(crate) assembly_session_serial: u64,
489 /// Take the runner's session copy instead of replaying (tests switch it
490 /// off to compare the two lanes), and how often each lane served.
491 pub(crate) session_transfer: bool,
492 pub(crate) session_imports: u64,
493 pub(crate) session_replays: u64,
494 /// A component replace whose run has not landed yet (see
495 /// `replace_component`), and the last finished replace's report.
496 pub(crate) replace_pending: Option<replace_component::PendingReplace>,
497 pub(crate) last_replace_report: Option<serde_json::Value>,
498 /// Every output name the last applied run CONSUMED
499 /// ([`crate::pipeline::RunOutput::consumed`]) — what the committed-sketch
500 /// refresh hides a consumed sketch by, and what it used to re-execute the
501 /// whole history on the UI thread to learn.
502 pub(crate) consumed_names: std::collections::HashSet<String>,
503 /// Re-entrancy guard for the parts-library resync in [`Self::pump`] (a
504 /// refused run re-runs, and `rerun_history` pumps).
505 pub(crate) library_resync: bool,
506 /// A run just RELEASED a sketch's edge links whose edges it could not
507 /// resolve (see [`Self::release_unresolved_sketch_links`]): the history
508 /// changed under the applied report, so [`Self::pump`] re-runs it once and
509 /// the report stops naming edges the sketch no longer lists.
510 pub(crate) sketch_links_released: bool,
511 /// The assembly-constraint viewport overlays — the cached
512 /// [`crate::constraint_overlays::ConstraintOverlay`] records the engine last
513 /// built from the kernel session (`assembly_overlay_json` + state), the source
514 /// of the drawn leader/arrow group, the label feed, and the grabbable-handle
515 /// hit regions. Refreshed after every history apply and every constraint
516 /// mutation; see the appended assembly-overlay impl block.
517 pub(crate) constraint_overlays: Vec<crate::constraint_overlays::ConstraintOverlay>,
518 /// A live GRAB on a constraint's distance-arrow / angle-arc handle (`Some`
519 /// between `constraint_drag_begin` and `constraint_drag_release`): the drag
520 /// previews the value locally and COMMITS on release via
521 /// `assembly_update_constraint_json` (which auto-solves).
522 pub(crate) constraint_drag: Option<ConstraintDrag>,
523 /// The `world_per_pixel` the constraint overlay buffers were last baked at
524 /// (screen-constant arc/rod sizing): `ensure_constraint_overlay_current`
525 /// re-bakes when the camera zoom moves it materially. `0.0` = never baked.
526 constraint_overlay_wpp: f64,
527 /// What the free-motion glyph group was last baked from (component,
528 /// its freedom row, centre), and at which `world_per_pixel`.
529 freedom_glyph_key: Option<String>,
530 freedom_glyph_wpp: f64,
531 /// The `world_per_pixel` the FEATURE-DIMENSION gizmo group
532 /// (`feature-dim-leaders`) was last baked at. The leaders' rod/cone/origin
533 /// sphere — and the angular arc's whole world RADIUS — are
534 /// `pixels × world_per_pixel`, so a zoom makes the drawn gizmo stale;
535 /// `ensure_feature_dimension_overlay_current` re-bakes on a material move.
536 /// `0.0` = nothing baked (gizmo disarmed / not in dimension mode).
537 /// See `feature_dims`.
538 pub(crate) feature_dim_overlay_wpp: f64,
539 /// The `world_per_pixel` the live SKETCH overlay groups (geometry, points,
540 /// preview, `sketch-dim-leaders`, `sketch-constraint-glyphs`) were last baked
541 /// at — construction dashes, dimension arrowheads and constraint glyphs are
542 /// all screen-constant. `ensure_sketch_overlay_current` re-bakes on a material
543 /// zoom. `0.0` = nothing baked (not in sketch mode). See `sketch_input`.
544 pub(crate) sketch_overlay_wpp: f64,
545 /// The constraint id whose referenced ELEMENTS the panel/label hover is
546 /// currently highlighting (dedupe key so a held hover doesn't re-bump the
547 /// emphasis generation every frame).
548 constraint_hovered: Option<String>,
549 /// Set for ONE frame when a constraint LABEL hover applied the element
550 /// highlight; the viewport's modeling hover branch consumes it (mirrors
551 /// [`Self::take_sketch_list_hover`]) so the scene hover doesn't clobber it.
552 constraint_label_hover_active: bool,
553 /// The SCENE-TREE row the pointer is over, as the pick candidate its hover
554 /// lit (the row→viewport highlight). Kept so
555 /// [`scene_tree_hover_end`](Self::scene_tree_hover_end) clears ONLY a hover
556 /// the tree itself set — never one the viewport lit in the meantime — and as
557 /// the dedupe key that keeps a held row hover from re-bumping the emphasis
558 /// generation every frame. See `scene_query.rs`.
559 scene_tree_hovered: Option<pick::PickCandidate>,
560 /// Set for ONE frame while a Scene-tree row is hovered; the viewport's
561 /// modeling hover branch consumes it via
562 /// [`take_scene_tree_hover`](Self::take_scene_tree_hover) and skips the
563 /// pointer-off-viewport `clear_hover` (mirrors
564 /// [`Self::take_sketch_list_hover`]) so the row-set highlight survives.
565 scene_tree_hover_active: bool,
566 /// The DIALOG row the pointer is over — a feature form's reference line, its
567 /// read-only `Outputs` line, or the reference picker card's picked-name line
568 /// (the row→viewport highlight, the twin of the Scene tree's above). Its OWN
569 /// slot, not the tree's: History, Constraints, PMI and the Scene tree can all
570 /// be on screen at once in a split dock, and a shared slot would let the pane
571 /// that draws second end the hover the pane that drew first had just set. See
572 /// [`DialogHover`] for what it memoizes and `scene_query.rs` for the API.
573 dialog_hovered: Option<DialogHover>,
574 /// Set for ONE frame while a dialog row is hovered; the viewport's modeling
575 /// hover branch consumes it via [`take_dialog_hover`](Self::take_dialog_hover)
576 /// and skips the pointer-off-viewport `clear_hover` (mirrors
577 /// [`Self::take_scene_tree_hover`]) so the row-set highlight survives.
578 dialog_hover_active: bool,
579 /// The constraint SELECTED via its viewport label chip (`Some` = selected):
580 /// drives the chip's selected accent, the context bar's Delete-constraint
581 /// action, and clears with the selection (Esc / Clear / delete). Read
582 /// through [`Self::selected_constraint`], which prunes a stale id.
583 selected_constraint: Option<String>,
584 /// The feature SELECTED in the history tree, beside the geometry selection
585 /// that selecting it made. It stays selected only while that geometry
586 /// selection is unchanged — a viewport pick, Esc or Clear replaces the
587 /// geometry and so deselects the feature. Read through
588 /// [`Self::selected_feature`].
589 selected_feature: Option<(String, selection_ux::FeatureSelection)>,
590 /// How many times a constraint's dialog has been OPENED through
591 /// [`Self::assembly_set_constraint_open`] — the constraint half of the same
592 /// counter as [`Self::pmi_dialog_opens`], read by the app's dialog door
593 /// so a re-open of the constraint already open still counts. The flag
594 /// itself lives in the kernel (it is part of the saved document), so this
595 /// counts the OPENS this engine performed, not the flag's history.
596 pub(crate) constraint_opens: u64,
597 /// The STEP product structure a [`Self::probe_step_assembly`] parsed, held
598 /// until the import dialog's button decides its fate: consumed by
599 /// [`Self::import_probed_step_assembly`], dropped by
600 /// [`Self::discard_probed_step_assembly`] (Cancel), by the next probe, or by
601 /// a document switch. The ONE parse of a structured STEP import lives here —
602 /// the dialog needs the counts BEFORE the user chooses, and re-parsing
603 /// multi-MB Part-21 text on the way back would double the most expensive step
604 /// of the import. See `model_io`'s import block.
605 pub(crate) pending_step_assembly: Option<brep_kernel::StepAssembly>,
606 /// STEP probes submitted to the runner and not yet answered (their ids).
607 pub(crate) pending_step_probes: std::collections::HashSet<u64>,
608 /// Answered probes awaiting [`Self::take_step_probe`], oldest first.
609 pub(crate) step_probe_results: std::collections::VecDeque<(u64, StepProbeOutcome)>,
610 /// Monotonic id pairing a probe reply with its submission.
611 pub(crate) next_step_probe_id: u64,
612}
613
614/// What a STEP probe found, as the file panel consumes it (see
615/// [`EngineState::submit_step_probe`]).
616#[derive(Debug, Clone, PartialEq)]
617pub enum StepProbeOutcome {
618 /// Product structure: the parsed assembly is stashed for
619 /// [`EngineState::import_probed_step_assembly`]; these are its counts.
620 Structure(model_io::StepAssemblyProbe),
621 /// No structure worth keeping — take the flat lane.
622 Flat,
623 /// The text did not parse as Part 21; the flat lane refuses it with its
624 /// own wording.
625 Failed(String),
626}
627
628/// A live constraint-handle drag: which constraint + which `inputParams` field
629/// (`distance` / `angle`), the params snapshot the commit mutates, and the live
630/// preview value the overlay/label show while dragging.
631#[derive(Debug, Clone)]
632pub struct ConstraintDrag {
633 pub id: String,
634 pub field: &'static str,
635 pub params: serde_json::Value,
636 pub preview: f64,
637}
638
639/// WHO a finished reference-selection commits to: a history FEATURE's params
640/// (the original widget) or an ASSEMBLY CONSTRAINT's `inputParams` (same modal,
641/// different commit lane — see `assembly_ops::begin_ref_select_for_constraint`).
642#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
643pub enum RefSelectTarget {
644 #[default]
645 Feature,
646 AssemblyConstraint,
647 /// ONE SPLINE ANCHOR's port attachment: `path` is unused, the picked name
648 /// must be a PORT feature id (a click on a port's drawn sheet), and Finish
649 /// writes `persistentData.spline.points[index].attachment` (see
650 /// `spline_edit.rs`).
651 SplineAnchor { index: usize },
652 /// A PMI annotation's reference field: `feature_id` is the annotation id;
653 /// Finish writes the picked names into its params through the PMI block
654 /// (`pmi_ops.rs`). Vertex picks are `{solid}@x,y,z` in WORLD coordinates.
655 Pmi,
656 /// ONE CONNECTION POINT's reference field: `feature_id` is the point's
657 /// part-local ADDRESS (`J1.VCC`) — a connection point is data, not a
658 /// feature, so there is no id to carry — and `path` is the block key the
659 /// pick writes (`pointRef` / `directionRef`). Finish writes it through
660 /// `ports_ops::ports_commit_ref`, and NOTHING ROLLS: a point resolves at
661 /// the tail of the run, so the geometry it may name is what is on screen.
662 PortPoint { field: ports_ops::PortRefField },
663 /// A drawing-sheet object's reference field — a dimension's anchors, an
664 /// ordinate set's datum or members, a section's cutting line, a detail's
665 /// centre or rim: `feature_id` is the object id, the picks are ANCHORS
666 /// clicked on the open sheet's paper (`sheet_ops.rs`), and nothing rolls.
667 Sheet,
668 /// A CAM record's reference field (a setup's orientation picks and
669 /// bodies, an operation's targets): `feature_id` is the record id and
670 /// `path` addresses the field from the `cam` block's ROOT, a `#<id>`
671 /// segment selecting the array element with that id
672 /// (`["setups", "#SETUP1", "targets"]`). Finish writes it through
673 /// `cam_ops::cam_commit_refs`, and nothing rolls: CAM references name the
674 /// finished model, which is what is on screen.
675 Cam,
676 /// A manufacturing-instructions step's OCCURRENCE field — an insertion
677 /// arrow's part or a callout's: `feature_id` is the step id and `field`
678 /// says which row. The pick is a SOLID of the placed assembly; Finish
679 /// derives the occurrence (the solid's name without its member) and writes
680 /// it through `instructions_ops::instructions_commit_ref`, one undo step,
681 /// and nothing rolls.
682 Instructions { field: InstructionsRefField },
683 /// A motion-study CLIP's parts field: `feature_id` is the clip id and
684 /// `path` its list field (`["occurrences"]`). Finish writes the picked
685 /// names, as the components that hold them, through
686 /// `simulation_refs::simulation_commit_refs`; nothing rolls.
687 Simulation,
688 /// A REPLACE COMPONENT repair: a held mate's broken reference, re-aimed
689 /// at ONE face or edge picked in the view. `feature_id` is the mate id
690 /// and `path` is `[old reference]`. Finish commits nothing itself: it
691 /// hands `(mate, old ref, pick)` to the replace dialog
692 /// ([`EngineState::take_replace_repair_pick`]), whose repair also
693 /// reaches mates inside nested assemblies; nothing rolls.
694 ReplaceRepair,
695}
696
697/// Which occurrence field of a step a pick fills ([`RefSelectTarget::Instructions`]).
698#[derive(Debug, Clone, Copy, PartialEq, Eq)]
699pub enum InstructionsRefField {
700 /// The part insertion arrow `index` animates (one of the step's own adds).
701 Arrow(usize),
702 /// The part callout `index` points at (any part of the assembly).
703 Callout(usize),
704}
705
706/// The modal state of the reference-selection widget while it is ACTIVE: which
707/// feature-dialog field is being filled, what it accepts, and the running list
708/// of picked kernel names (the source of truth — added by picking in the view,
709/// removed via the per-line X). See the ref-select methods below.
710#[derive(Debug, Clone, Default)]
711pub struct RefSelectState {
712 /// The id of the feature whose param is being edited.
713 pub feature_id: String,
714 /// The JSON path into that feature's `inputParams` the names write to
715 /// (`["targetSolid"]`, `["boolean","targets"]`, `["faceRef"]`, …).
716 pub path: Vec<String>,
717 /// A human label for the modal heading (the field's label).
718 pub label: String,
719 /// The allowed pick kinds (`["SOLID"]`, `["FACE"]`, …) — the type constraint.
720 pub filter: Vec<String>,
721 /// Whether the field takes a LIST of references (else a single one).
722 pub multiple: bool,
723 /// The picked kernel names — the running selection (source of truth).
724 pub names: Vec<String>,
725 /// The rollback step to restore on Finish/Cancel (the edited feature's own
726 /// step): entering the mode rolls to the pre-feature "before" state, so we
727 /// remember where to return.
728 pub restore_index: usize,
729 /// Which surface Finish commits the names to (feature params vs an
730 /// assembly constraint's `inputParams`). Defaults to [`RefSelectTarget::Feature`].
731 pub target: RefSelectTarget,
732 /// How many picks landed since the field was activated (a viewport click,
733 /// a fed name, a sheet anchor). A SINGLE-valued field drawn IN ITS FORM
734 /// finishes on its first pick — the form's consumer has nothing to wait
735 /// for once the one reference is in — and this is what says one landed,
736 /// as opposed to the seed the field opened with.
737 pub picks: usize,
738 /// Whether the field's own form drew the pick this frame. An in-form pick
739 /// has no card of its own, so a form that stops being drawn (its pane
740 /// tabbed away or closed, its subject gone) would strand the pick with
741 /// nothing on screen to end it; the shell finishes a pick nobody claimed.
742 pub claimed: bool,
743 /// The form asked for the pick to finish at the END of this frame rather
744 /// than now: an edit elsewhere on a feature's form while its pick runs.
745 /// Deferred because the viewport pane may draw AFTER the form in the same
746 /// frame and the click that caused the edit (a text field losing focus)
747 /// may itself be the pick — finishing at once would hand that click to
748 /// the ordinary selection instead.
749 pub finish_requested: bool,
750}
751
752impl Default for EngineState {
753 fn default() -> Self {
754 Self {
755 scene: RenderScene::new(),
756 context_scene: RenderScene::new(),
757 context_selected: None,
758 context_hovered: None,
759 context_pick_lit: Vec::new(),
760 context_display: Default::default(),
761 camera: ViewCamera::default(),
762 controls: ArcballControls::new(),
763 settings: RenderSettings::default(),
764 emphasis: Emphasis::default(),
765 widgets: WidgetRegistry::new(),
766 history: History::default(),
767 history_report: String::new(),
768 metadata: crate::metadata::MetadataStore::new(),
769 document_thumbnail: std::cell::RefCell::new(None),
770 thumbnail_cache: std::cell::RefCell::new(None),
771 settings_generation: 1,
772 dirty: true,
773 ref_select: None,
774 replace_repair_pick: None,
775 selection_filter: SelectionFilter::default(),
776 transform_gizmo: TransformArm::default(),
777 component_move: ComponentMoveArm::default(),
778 sketch_edit: None,
779 sketch3d_edit: None,
780 sketch3d_overlay_wpp: 0.0,
781 sketch_camera_locked: true,
782 sketch_list_hover_active: false,
783 notices: Vec::new(),
784 graded_notices: Vec::new(),
785 hidden_sketches: std::collections::HashSet::new(),
786 shown_sketch_ids: Vec::new(),
787 shown_board_ids: Vec::new(),
788 board_built_from: None,
789 board_pin_nets: Default::default(),
790 board_build: board_geometry::BoardBuild::default(),
791 board_displays: Vec::new(),
792 construction_frames: Vec::new(),
793 sketch_profiles: Vec::new(),
794 sketch_paths: Vec::new(),
795 sketch_points: Vec::new(),
796 sketch_axes: Vec::new(),
797 wire_harness_report: None,
798 ports_report: None,
799 sheet_open: None,
800 sheet_open_object: None,
801 sheet_object_opens: 0,
802 sheet_selected_object: None,
803 sheet_cache: None,
804 sheet_lines: Default::default(),
805 document_name: String::new(),
806 pmi_report: None,
807 pmi_active_view: None,
808 pmi_open_annotation: None,
809 pmi_open_view: None,
810 pmi_selected_annotation: None,
811 pmi_selected_view: None,
812 pmi_dialog_opens: 0,
813 pmi_modeling: None,
814 pmi_explode_originals: std::collections::HashMap::new(),
815 explode_playback: Default::default(),
816 simulation_play: None,
817 pmi_section_hidden: Vec::new(),
818 pmi_unposed_visibility: 0,
819 pmi_state_cache: Default::default(),
820 pmi_balloon_stale: None,
821 pmi_overlay_key: None,
822 pmi_hovered: None,
823 pmi_label_hover_active: false,
824 spline_overlay_key: None,
825 cam: cam_ops::CamGeneration::default(),
826 component_ports_visible: false,
827 spline_edit_feature: None,
828 spline_anchor_picked: None,
829 cage_edit_feature: None,
830 cage_overlay_key: None,
831 hidden_datums: std::collections::HashSet::new(),
832 shown_datum_names: Vec::new(),
833 runner: Box::new(crate::runner::InlineRunner::new()),
834 plugins: plugins::Plugins::default(),
835 interference_sessions: Default::default(),
836 interference_sequence: 0,
837 illustration_snapshot: None,
838 geometry_diagnostics: Default::default(),
839 staged_feature: None,
840 busy_refused_seen: 0,
841 run_generation: 0,
842 applied_generation: 0,
843 run_progress: None,
844 cancelled_run: None,
845 expression_preview: None,
846 runs_replied: 0,
847 superseded_displays: HashMap::new(),
848 pending_fit: false,
849 instructions_wizard_pending: false,
850 instructions_views_pending: false,
851 instructions_insertion: None,
852 provenance: std::collections::HashMap::new(),
853 entity_origin: std::collections::HashMap::new(),
854 info_cache: std::collections::HashMap::new(),
855 pending_query: std::collections::HashMap::new(),
856 next_query_id: 0,
857 pending_mesh_imports: std::collections::HashMap::new(),
858 mesh_preview_results: std::collections::VecDeque::new(),
859 next_mesh_import_id: 0,
860 pending_topology: std::collections::HashSet::new(),
861 topology_asked: std::collections::HashSet::new(),
862 next_topology_id: 0,
863 assembly_components: Vec::new(),
864 assembly_sync: None,
865 assembly_session_generation: None,
866 assembly_session_serial: 0,
867 session_transfer: true,
868 session_imports: 0,
869 session_replays: 0,
870 replace_pending: None,
871 last_replace_report: None,
872 consumed_names: std::collections::HashSet::new(),
873 library_resync: false,
874 sketch_links_released: false,
875 constraint_overlays: Vec::new(),
876 constraint_drag: None,
877 constraint_overlay_wpp: 0.0,
878 freedom_glyph_key: None,
879 freedom_glyph_wpp: 0.0,
880 feature_dim_overlay_wpp: 0.0,
881 sketch_overlay_wpp: 0.0,
882 constraint_hovered: None,
883 constraint_label_hover_active: false,
884 scene_tree_hovered: None,
885 scene_tree_hover_active: false,
886 dialog_hovered: None,
887 dialog_hover_active: false,
888 selected_constraint: None,
889 selected_feature: None,
890 constraint_opens: 0,
891 pending_step_assembly: None,
892 pending_step_probes: std::collections::HashSet::new(),
893 step_probe_results: std::collections::VecDeque::new(),
894 next_step_probe_id: 1,
895 }
896 }
897}
898
899impl EngineState {
900 pub fn new() -> Self {
901 Self::default()
902 }
903
904 fn pick_options(&self) -> PickOptions {
905 PickOptions {
906 double_sided: self.settings.pick_double_sided,
907 ..PickOptions::default()
908 }
909 }
910}
911
912/// Has the camera's `world_per_pixel` moved MATERIALLY (>0.5%) away from the
913/// value an overlay group's screen-constant sizing was baked at?
914///
915/// The ONE judgement every camera-keyed overlay re-bake shares
916/// (`ensure_overlays_current` and the per-group ensures it drives), so
917/// "what counts as a zoom" cannot drift between them. `baked == 0.0` means
918/// "never baked" — a state each caller handles itself, so it reads as NOT
919/// stale here. The band is what keeps a quiet frame quiet: float jitter in the
920/// camera never trips it, so there is no per-frame re-bake loop.
921pub(crate) fn overlay_wpp_stale(baked: f64, now: f64) -> bool {
922 baked > 0.0 && (now - baked).abs() > baked * 0.005
923}
924
925// ============================================================================
926// MODULE MAP — engine_state is split into topic children. THIS file is the
927// module root: it keeps the EngineState/RefSelectState structs, Default, the
928// constructor + shared pick_options, the child `mod` declarations, and the
929// re-exports that preserve the original `engine_state::*` public paths.
930// Append new work to the matching child (or add a new child + re-export here).
931// ============================================================================
932
933/// The assembly surface (Wave-3): main-side session sync + component
934/// projection, constraint CRUD with the document fold (pose-authority
935/// contract), the insert-component flow, component fix/select actions, the
936/// constraint flavor of the reference picker, and `document_signature` — the
937/// ONE parts-library `sourceSignature` hash every writer shares.
938mod assembly_ops;
939mod context_pick;
940/// Assembly-constraint viewport overlays: overlay refresh from the kernel
941/// session, the grabbable distance/angle handle pick + drag preview +
942/// `assembly_update_constraint_json` commit, movedSolids re-tessellation, the
943/// drag-path document fold, label feed + element hover, and tests.
944mod assembly_overlay;
945/// Replace component (swap an occurrence's part, keep its mates by name when
946/// the parts share lineage; mark the rest unresolved) — `replace_components`,
947/// the report, repair, and the Save As lineage stamp.
948pub mod replace_component;
949/// BOM export: the `{partName, sourceKey, quantity}` parts list off the
950/// main-side parts library + live component projection, serialized as CSV /
951/// JSON for the file dialog's Export modal.
952mod bom;
953/// Camera & view commands (zoom-to-fit, resize, pointer/wheel ingestion,
954/// projection, standard views, camera state/matrices, world→screen) plus the
955/// widget-overlay feeds (datums/overlay/dimensions/transform JSON), the
956/// ViewCube (incl. `apply_look_direction`), `datum_pick`, the widget
957/// transform-handle hover/pick/drag path, and `dimension_anchors_json`.
958mod camera_widgets;
959/// Committed-sketch persistent overlays: sheet-solid synthesis from stored
960/// profiles (`refresh_committed_sketches`), per-sketch visibility, the
961/// Scene-tree rows + `sketch_entities_json`, and the committed-sketch tests.
962/// The board's 3D bodies (substrate + copper + via barrels), derived from the
963/// document's `pcb` block after every run — see the module notes.
964mod board_geometry;
965mod committed_sketches;
966/// The COMPONENT Move gizmo (assemblies §8.5): translate→rotate→off cycle at
967/// the member-bbox center, fixed-refusal, free-move drag with the pose commit
968/// (and re-solve) on release. See `ComponentMoveArm`.
969mod component_move;
970/// Flip a constraint to its other solution (one undo step, a seeded pose).
971mod assembly_flip;
972/// Assembly COMPONENT read surface: the app-side component projection derived
973/// from the history's ACOMP features + the scene's namespaced solid names
974/// (`component_of_solid` / `component_info` / `component_bbox_center`), and its
975/// tests + shared assembly fixtures.
976mod components;
977/// Construction datum/plane display: frame→feature mapping,
978/// `refresh_construction_datums`, datum visibility + selection + entity rows,
979/// and the construction-datum tests.
980mod construction_datums;
981/// Expressions & configurator surface (`expressions_json`, `set_expressions`,
982/// `configurator_json`, `expression_variables_json`) + parsing helpers + tests.
983mod expressions;
984pub use expressions::ExpressionPreview;
985/// The feature-dimension gizmo (dimension arrows / angle arc / center-sphere
986/// toggle): arm state, `__brep`-style annotation JSON, overlay publishing,
987/// drag + set-value writeback, `FEATURE_DIM_OVERLAY`, fd_* math helpers, tests.
988mod feature_dims;
989/// The assembly interference check: the bbox-prefiltered pairwise
990/// non-destructive INTERSECT sweep over component instances
991/// (`interference_check`), its report types, and the pure pair planner.
992mod interference;
993mod batch;
994mod plugins;
995mod illustration;
996/// History runs & the feature CRUD surface: `run_history_json`, the
997/// runner/pump/apply seam, history JSON accessors, roll/update/add/delete/
998/// reorder, engine undo/redo, `load_model_and_fit`,
999/// and the history-cache rollback tests.
1000mod history_ops;
1001/// Model I/O: `import_step_feature`, `export_step_text`, `export_stl_text`,
1002/// `triangle_normal`, and the io tests.
1003mod model_io;
1004/// Construction PLANES as ordinary pick candidates: the combined
1005/// scene+plane-card candidate list (`pick_candidates_at`), the planes-aware
1006/// single-hit pick (`pick_top_at`), the shared candidate ordering, and the
1007/// plane-pick tests. Read its header for how a plane competes for a pick.
1008mod plane_pick;
1009/// Scene & object queries: `pick_json`/`hover_json`, settings + emphasis +
1010/// visibility + color overrides, `scene_listing_json`, `depth_range_bbox`,
1011/// `scene_entities_json`/select-by-name, mass properties + object info, tests.
1012mod scene_query;
1013/// The selection-filter state + kind gating (`SelectionFilter`,
1014/// `select_filtered_at`, hide-selected) and its tests.
1015mod selection_filter;
1016/// Selection & hover UX: clear/select-top/selection JSON, the modal
1017/// ref-select widget (incl. `set_json_at`), hover/candidate cycling, and the
1018/// live sketch overlay feed (`set_sketch_overlay`/`clear_sketch_overlay`) +
1019/// selection UX tests.
1020mod selection_ux;
1021/// Sketch editing ops appended after dimensions: dimension labels/value/drag,
1022/// sketch undo/redo + diagnostics dump, trim, external edge refs
1023/// (pick/link/reproject), and hand-draw strokes.
1024mod sketch_edit_ops;
1025/// Sketch-mode viewport input: overlay refresh, uv picking, hover/click/drag,
1026/// the draw tools + pending-geometry helpers, and delete-selection.
1027mod sketch_input;
1028/// Sketch mode session: `SketchDrag`/`SketchEdit` state, plane-frame helpers,
1029/// enter/exit/new sketch, and the camera lock.
1030mod sketch_mode;
1031/// 3D sketch mode: `Sketch3dEdit`, enter/exit/new, the cursor-to-3D mapping,
1032/// the draw tools, reference linking, constraint edits and undo.
1033mod sketch3d_mode;
1034pub use sketch3d_mode::{Sketch3dCursorHit, Sketch3dEdit};
1035/// Sketch entity-list panel rows + notices + solver settings
1036/// (`SketchEntityRow`), and the constraint palette/actions
1037/// (`SketchConstraintAction`, add-constraint builders, ground/construction
1038/// toggles, cleanup).
1039mod sketch_panel;
1040/// The transform-controls gizmo: `GizmoMode`/`TransformArm`, arm/drag/apply,
1041/// pose ⇄ params JSON, quaternion helpers (`rotate_euler_xyz_f64`), tests.
1042mod transform_gizmo;
1043/// The wire-harness surface: the document's `wireHarness` block (connection
1044/// add / edit / remove / bundles toggle — checkpointed document edits that
1045/// re-run the history, whose tail routes them), the applied run's routing
1046/// report, the endpoint list, and the panel's hover highlight.
1047mod wire_harness_ops;
1048/// The PORTS surface: the ports tail's report of the last applied run — the
1049/// one place the tail's resolved points, refused names and unresolved
1050/// references reach a caller, the tail not being a feature.
1051mod ports_ops;
1052pub use ports_ops::PortRefField;
1053pub use selection_ux::RefSelectField;
1054// Every harness wire as a BOM line with its cut length (MF QTY), or the reason
1055// the last applied run cannot give one.
1056mod wire_bom;
1057mod pmi_ops;
1058mod pmi_section;
1059// Assembly exploded views: PMI views whose explode rows are ordered steps.
1060mod exploded_ops;
1061pub use exploded_ops::{ExplodePlayback, ExplodeStep, ExplodedView};
1062// Manufacturing instructions: the wrapper assembly, the wizard, step views and the player.
1063mod instructions_ops;
1064pub use instructions_ops::{Insertion, PlayTo};
1065// Motion studies: the simulation block, motors and clips.
1066mod simulation_ops;
1067pub use simulation_ops::MotorMate;
1068// Motion-study playback: bake the frames through the kernel, pose the displays.
1069mod simulation_play;
1070pub use simulation_play::{BakedFrame, SimulationPlayback};
1071// Motion-study player data: the study's frames for the instructions player
1072// template (the offline .html, and what the PLM serves).
1073mod simulation_player;
1074pub use simulation_player::assembly_signature;
1075// A clip's parts picked in the viewport: the reference-selection lane of
1076// the Simulation pane's forms.
1077mod simulation_refs;
1078// A study's published motion on a manufacturing-instructions step.
1079mod instructions_motion;
1080pub use instructions_motion::PublishedMotion;
1081// Their printed PDF, per-step PNG and SVG, and the print settings.
1082mod instructions_export;
1083pub use instructions_export::IMAGE_PX as INSTRUCTIONS_IMAGE_PX;
1084pub use instructions_export::{TOPOLOGY_WAIT, InstructionsPdfExport};
1085pub mod cam_ops;
1086pub use pmi_ops::{pmi_view_params, pmi_view_schema, world_vertex_ref, PmiModelingSnapshot, PmiViewPatch};
1087// Drawing sheets: the `sheets` block, the open sheet and the projection cache.
1088mod sheet_ops;
1089pub(crate) mod pmi_overlay;
1090pub use pmi_overlay::PmiLabel;
1091/// The 3D spline-anchor editor: the resolved anchor list, the value edits
1092/// (position / distances / flip / side / add / remove / reorder / detach),
1093/// the anchor flavour of the transform gizmo, the port-attach flavour of the
1094/// reference picker, and the direction-cage overlay.
1095mod spline_edit;
1096/// The NURBS Solid CONTROL-CAGE editor: the cage's points through the
1097/// kernel's resolver, the multi-point selection that arms the transform
1098/// gizmo at its centroid, the drag write-back, loop insertion, reset and the
1099/// cage overlay.
1100mod cage_edit;
1101
1102// Re-exports preserving the original `engine_state::*` public surface.
1103pub use assembly_ops::{document_signature, nested_fixed_state, ComponentInsert};
1104pub use board_geometry::{
1105 default_color as board_default_color, BoardBuild, BOARD_SOLID_PREFIX, SUBSTRATE_SOLID,
1106 VIAS_SOLID,
1107};
1108pub use bom::{OCCURRENCE_ATTRIBUTES, PART_ATTRIBUTES};
1109pub use component_move::{ComponentMoveArm, TypedMove};
1110pub use components::ComponentInfo;
1111pub use interference::{ClearancePair, InterferencePair, InterferenceReport, INTERFERENCE_OVERLAY_GROUP};
1112pub use model_io::{
1113 EmbeddedOnly, PartSink, StepAssemblyImport, StepAssemblyProbe, StepAssemblyReport,
1114};
1115pub use selection_filter::SelectionFilter;
1116pub use sketch_mode::{SketchDrag, SketchEdit};
1117pub use sketch_panel::{NoticeSeverity, SketchConstraintAction, SketchEntityRow};
1118pub use wire_harness_ops::ConnectionPatch;
1119pub use wire_bom::{WireBomLine, WireLengthState};
1120pub use spline_edit::SplineAnchorRow;
1121pub use cage_edit::{CageArm, CageSelect, CageSummary, CAGE_PICK_RADIUS_PX};
1122pub use transform_gizmo::{GizmoMode, TransformArm};
1123pub(crate) use transform_gizmo::rotate_euler_xyz_f64;
1124
1125
1126
1127
1128
1129
1130/// Reconstruction results either append to a document or remain uncommitted.
1131#[derive(Clone, Copy, PartialEq, Eq)]
1132pub(crate) enum MeshImportDestination {
1133 Document,
1134 Preview,
1135}