Struct BrepApp 

pub struct BrepApp { /* private fields */ }

Implementations

impl BrepApp

pub fn automation(&self) -> &Arc<AutomationQueue>

The automation queue a host submits commands to.

pub fn open_path_from_command_line(&mut self, path: &Path)

Open a .nbrep file named on the command line — brep-app model.nbrep, which is also what a desktop file association hands us (Exec=… %f).

The path goes through the same FileDialog::open_document door as File>Open, so the document keeps the full path as its identity and a later plain Save writes back to the file the user double-clicked, rather than to a copy in the app’s own models directory. A path that does not parse leaves the status line saying so and the seed document in place — a bad argument must not cost the user a window.

Native only: called once, before the first frame.

pub fn view_rect(&self) -> Option<Rect>

The 3D viewport rect of the last frame, in egui points.

pub fn docs_engine(&self) -> &EngineState

The active document’s engine.

pub fn open_mesh_preview( &mut self, name: String, bytes: Vec<u8>, ) -> Result<(), String>

Open the mesh import preview for the file name (.stl or .3mf) against the active document — what activating it in the Import explorer does. The preview replaces the shell until it is accepted or cancelled.

pub fn mesh_preview_open(&self) -> bool

Whether the mesh import preview is open.

pub fn viewport_engine(&self) -> &EngineState

The engine the 3D viewport is drawing: the mesh import preview’s own while it is open (it replaces the shell), else the active document’s. What a pointer script’s locate must project through.

pub fn new(cc: &CreationContext<'_>) -> Result<Self, String>

pub fn new_with( cc: &CreationContext<'_>, opts: AppOptions, ) -> Result<Self, String>

Build the app with host-supplied options: an isolated store (a host MUST pass one) and whether to start on the seed model.

pub fn start_update_check(&mut self, ctx: &Context)

Start the desktop update check (crate::update). Called by the desktop binary’s main only.

pub fn start_report_followup(&mut self, ctx: &Context)

Remember submitted problem reports and check them for resolution (crate::report_followup). Called by the desktop main and the web entry point only.

pub fn start_spin(&mut self, frames: u32, step: (f64, f64))

Arm a measured camera spin: frames pointer steps of step logical px each, starting at the centre of the 3D viewport. Replaces any spin in flight. See Spin.

pub fn spinning(&self) -> bool

Is a measured spin still running?

pub fn service_automation(&mut self, ctx: &Context) -> bool

Application-command dispatch without a frame (the desktop loop’s service step; see automation::queue): the PLM/store tasks that answered, the queue’s frame-free head, the background runs it started, and the notices they raised. Draws nothing. Returns whether work it must keep servicing is still in flight.

pub fn state_blob_json(&mut self, name: &str, ctx: &Context) -> Option<String>

One plain-state blob by name, built from the app’s data now. None for a name that is not one of STATE_BLOBS (a layout blob, which only a drawn pass publishes).

pub fn set_settings_window_open(&mut self, open: bool)

Open or close the floating Settings window — the toolbar gear’s flag, reachable from the automation layer (settings_window).

pub fn set_part_properties_window_open(&mut self, open: bool)

Open or close the floating Part Properties window — the toolbar tag button’s flag, reachable from the automation layer (part_properties_window).

pub fn set_info_window_open(&mut self, open: bool)

Open or close the floating Info window — the toolbar info button’s flag, reachable from the automation layer (info_window).

pub fn set_script_host(&mut self, host: Box<dyn ScriptHost>)

What this session is running on. The app’s ONE record of it: the Info window draws it, a problem report carries it, the diagnostics command returns it and the MCP banner names its adapter — all from here. Where the JavaScript editor’s Run sends a program (a host’s own script runner; the desktop app installs its server’s on its own).

pub fn diagnostics(&self) -> &Diagnostics

pub fn begin_bug_report(&mut self, ctx: &Context)

Begin the in-app problem report: the same call the Submit Bug button makes, and for the same reason it makes it THIS frame — request captures the current frame before its own dialog exists.

pub fn show_pane(&mut self, kind: PaneKind)

Bring a built-in dock pane to the front (show_pane).

pub fn update_components( &mut self, run: bool, ) -> Result<(usize, Vec<String>, usize), String>

The parts-library staleness check and its refresh — the Constraints header’s “Update components (N)” button, reachable as the component_update command. Returns (outdated, missing, refreshed); run is skipped when nothing is outdated.

pub fn zoom_to_fit(&mut self)

Frame what the central tile is actually DRAWING: the OPEN SHEET’s paper when a sheet is open, the 3D scene otherwise.

This is where the fit branch lives, and it is here rather than in the toolbar because the two halves sit in different places — the 3D fit is an engine camera op (EngineState::zoom_to_fit) while the sheet’s pan/zoom is viewport-transient state, refitted by clearing the marker the sheet paint compares against. One method, so the toolbar’s Zoom-to-fit button and the zoom_to_fit command can never mean different things — and so the paper needs no Fit button of its own.

The toolbar draws BEFORE the dock in ui, so a fit requested from the button lands on this very frame.

pub fn dispatch_workbench_button(&mut self, id: &str) -> bool

Run what a WORKBENCH TOOLBAR button does, by its WorkbenchButton::id.

Split out of ui so a toolbar click and the workbench_button command run the SAME arms: the workbench registry declares a button, this dispatches it, and the automation surface owns no second copy of the list. Returns whether the id was known.

Trait Implementations

impl App for BrepApp

fn raw_input_hook(&mut self, ctx: &Context, raw_input: &mut RawInput)

Phase 1 of the automation frame (§4.4): queued input commands become egui events; a screenshot that landed completes its reply. Called by every eframe runner before ui; the headless host calls it itself.

fn ui(&mut self, ui: &mut Ui, _frame: &mut Frame)

Called each time the UI needs repainting, which may be many times per second.

fn logic(&mut self, ctx: &Context, frame: &mut Frame)

Called once before each call to Self::ui, and additionally also called when the UI is hidden, but egui::Context::request_repaint was called.

fn save(&mut self, _storage: &mut dyn Storage)

Called on shutdown, and perhaps at regular intervals. Allows you to save state.

fn on_exit(&mut self)

Called once on shutdown, after Self::save.

fn auto_save_interval(&self) -> Duration

Time between automatic calls to Self::save

fn clear_color(&self, _visuals: &Visuals) -> [f32; 4]

Background color values for the app, e.g. what is sent to gl.clearColor.

fn persist_egui_memory(&self) -> bool

Controls whether or not the egui memory (window positions etc) will be persisted (only if the “persistence” feature is enabled).