BREP_app 0.4.0

The BREP CAD application: an eframe (egui + wgpu) host that draws the brep-render 3D engine into an egui frame — native + wasm from one codebase.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! The automation layer — the one command channel the app exposes to a host
//! (`brep-mcp` headless / window, or a dial-in adapter). Design record:
//! `docs/developer/mcp-automation-build-spec.md` §3–§6 and Appendix A.
//!
//! Three registries live here; the engine's feature catalogue is the fourth:
//! - [`command`] — every command registers a [`CommandSpec`] (name, group,
//!   doc, derived argument/result schemas, frame phase, annotations, handler)
//!   in its module's `COMMANDS` static; [`command::registry`] gathers them.
//!   A host reads the registry and generates its tool list; nothing lists
//!   commands by hand.
//! - [`registry`] — the state registry: the JSON blobs the app publishes each
//!   frame (`__brep*`), with a doc string and, where the blob is typed, a
//!   schema. Always compiled; on wasm it also mirrors to `window.*`.
//! - [`hit_keys`] — the widget hit-key docs each panel registers beside its
//!   hit-rect publisher.
//!
//! [`queue::AutomationQueue`] is the channel: a host submits an [`command::Envelope`]
//! and gets a [`command::Reply`]; the app drains the queue at three fixed
//! points in the frame (§4.4) — `raw_input_hook` for input, the top of `ui`
//! for mutations, the bottom of `ui` after the registry is rebuilt for reads.
pub mod hit_keys;
pub(crate) mod hit_rects;
pub mod registry;

/// Where the toolbar's Help button points: the generated help site `brep-docs`
/// writes next to the served page. Declared here — outside the `automation`
/// feature gate — so the button and the `help_open` command that presses it
/// without a pointer read ONE literal.
pub const HELP_URL: &str = "help/index.html";

#[cfg(feature = "automation")]
pub mod command;
#[cfg(feature = "automation")]
pub mod pointer;
#[cfg(feature = "automation")]
pub mod queue;

#[cfg(feature = "automation")]
mod cmd_assembly;
#[cfg(feature = "automation")]
mod cmd_camera;
#[cfg(feature = "automation")]
pub mod cmd_capture;
#[cfg(feature = "automation")]
mod cmd_document;
#[cfg(feature = "automation")]
mod cmd_frame;
#[cfg(feature = "automation")]
mod cmd_history;
#[cfg(feature = "automation")]
mod cmd_input;
#[cfg(feature = "automation")]
mod cmd_metadata;
#[cfg(feature = "automation")]
mod cmd_pmi;
#[cfg(feature = "automation")]
mod cmd_scene;
#[cfg(feature = "automation")]
mod cmd_settings;
#[cfg(feature = "automation")]
mod cmd_shell;
#[cfg(feature = "automation")]
mod cmd_state;
#[cfg(feature = "automation")]
mod cmd_wire_harness;

/// How a host builds the app. `store: None` = the default store (the user's
/// own config directory); a host MUST pass an isolated store (spec §8).
/// `seed: false` starts on an empty document instead of the seed model.
pub struct AppOptions {
    pub store: Option<Box<dyn crate::store::ModelStore>>,
    pub seed: bool,
}

impl Default for AppOptions {
    fn default() -> Self {
        Self { store: None, seed: true }
    }
}