Skip to main content

Crate ferrocad_gpui

Crate ferrocad_gpui 

Source
Expand description

FerroCAD shell: the reusable bite-gpui application shell.

Boots an embedded CPython interpreter, wires the FreeCAD facade, and opens the bite-gpui window (model inspector, property editor, Python console).

The base application lives in the ferrocad crate and calls run. A redistribution, such as FerroCAD: Architecture, is a thin binary that calls run_with with its own HostConfig. The engine is reached through the public FreeCAD Python API, exactly like a workbench (see docs/architecture.md and docs/architecture/repackaging.md).

Re-exports§

pub use commands::CommandInfo;
pub use commands::CommandOutcome;
pub use commands::Surface;
pub use contributions::Contributions;
pub use contributions::GizmoFactory;
pub use contributions::ManipulatorFactory;
pub use contributions::translate_gizmo;
pub use dev_tools::DevTools;
pub use dialog::DialogField;
pub use dialog::DialogSpec;
pub use display::DisplaySync;
pub use display::StageMesh;
pub use headless::RenderReport;
pub use headless::StlReport;
pub use headless::render as render_headless;
pub use headless::run as run_headless;
pub use selection::SelectionItem;
pub use shell::Shell;
pub use shell::ShellModel;
pub use shortcuts::Accelerator;
pub use view::ProjectionName;
pub use view::ViewRequest;
pub use view::ViewState;
pub use view::WorkplaneAction;

Modules§

chrome
Viewport chrome primitives (P0.6): split buttons, anchored popovers, the floating control pill, the action dock and the Dev Tools command list.
commands
The workbench command bridge (A0/A1).
contributions
The workbench contributions an edition makes to the shell.
dev_tools
The Dev Tools window (P0.5).
dialog
Dialog specs and value validation (A3).
display
Document shapes → the viewport’s stage: the host’s display half.
forms
Q3a: render ferrocad_ui forms as gpui elements and host a form dialog. Q3a: render a ferrocad_ui::Form as gpui elements.
headless
Headless edition rendering (--render out.png): model → stage → PNG. Headless edition rendering.
interop
Zero-copy viewport presentation through gpui’s wgpu window renderer. Zero-copy viewport presentation through gpui’s window renderer.
manipulators
The JSON wire form of a mod-declared handle.
python
Embedded-CPython bridge for the app shell.
selection
The shell’s selection: what the user picked, and the facade’s snapshot (A2).
shell
The app-shell view (S1).
shortcuts
Keyboard accelerators for workbench commands (A4).
view
View requests and the shell’s presentation state (A5, extended in G5).

Structs§

HostConfig
Per-edition configuration.

Functions§

check_init
Run Shell::boot and return without opening a window.
run
Run the base application (the general FerroCAD edition).
run_with
Run the application with an edition’s configuration.
zero_copy_presenter
A zero-copy viewport presenter for this build and platform, if one is available.