Skip to content

Latest commit

 

History

History
110 lines (108 loc) · 13.8 KB

code-structure.md

File metadata and controls

110 lines (108 loc) · 13.8 KB

Code structure

Where the code of each feature lives. architecture.md describes the crate graph and the layer rules.

File Purpose
crates/openecraft-i18n Languages and UI translations (one folder per area under src/catalog/: English, German, French, Spanish in required.tsv, 16 further languages in <code>.tsv; examples/tidy.rs places and sorts the entries)
crates/openecraft-fonts Bundled Chinese, Japanese and Korean fonts (Noto Sans subsets, OFL; regenerated by subset.py) and their fallback order
crates/openecraft-core Headless project model shared by the editor and the command line: pages, devices, netlist, checks, reports, export
crates/openecraft-parts Shared library: part model, function templates, CSV/JSON, catalog, EPLAN product groups, server API types, data portal (faceted search, lifecycle, update check), 3D math
crates/openecraft-step STEP, IGES and Parasolid import: B-rep models tessellated into part meshes (uses monstertruck; Parasolid parsed by parasolid-core)
crates/openecraft-edz EDZ import (EPLAN Data Portal archives): parts with connection points and mounting holes, pictures and macros (7-Zip with sevenz-rust2)
crates/openecraft-jt JT writer and reader for triangle meshes (JT 8.1 layout, own implementation)
crates/openecraft-xt Parasolid XT writer: triangle meshes as faceted solid and sheet bodies (transmit text, schema V13, own implementation)
crates/openecraft-client Requests to the parts and project servers and to Autodesk Vault (Vault Data API, uploads and check-ins, item lookup) and decoding of their answers, shared by the applications and the command line; wrapper of the EPLAN Data Portal API (eplan)
crates/openecraft-ui Shared egui library: part editor and previews, parts server client, data portal browser, file dialogs
crates/openecraft-view Read-only views of a project shared by the editor's navigator and the project server's web page: pages by structure, devices and their places, page icons, ProjectView
crates/openecraft-web What the web pages of the parts server and the project server share: sign-in, texts and requests (common.js), the administration of roles, grants and directories (access.js), styles, logo, WebTexts
crates/openecraft-shell The shell of the editor as tables: commands, ribbon, panes, workspaces, keys, mouse gestures, state colours (no UI code)
crates/openecraft-session The open project of an application: undo history, analysis with the checks and reports of the plugins, device index, saved state
crates/openecraft-canvas The drawing views of the editor (page editor, panel layout in 2D and 3D), shared by the editor and the website
crates/openecraft-api Extension API: plugins with commands, checks, reports and exports for all front ends; external plugins over JSON
parts-server/ openecraft-parts-server: data portal server (REST API, SQLite or JSON storage, users, web page)
project-server/ openecraft-project-server: shared projects with page locks for several users
cli/ openecraft-cli: command line and MCP server; one tool list (src/tools/) for both
parts-manager/ openecraft-parts-manager: standalone parts server maintenance (desktop + web)
website/ openecraft-website: the website of the project; src/studio.rs the project of its live demos and the functions the page calls, src/views.rs the canvases, src/texts.rs the texts of the page (website.md)
crates/openecraft-core/src/model.rs Project data model (pages, symbols, wires, parts) and page layout constants
crates/openecraft-core/src/symbols.rs Built-in symbol libraries (IEC, NFPA, GB / GOST / JIS, fluid power, P&ID, single-line, black boxes)
crates/openecraft-core/src/symlib.rs User symbols: registry, editing helpers, library files
crates/openecraft-core/src/forms.rs Title blocks (placeholders) and report forms
crates/openecraft-core/src/production.rs Panel production: drilling pattern, door cutouts, NC export, wire end treatment, clearances
crates/openecraft-core/src/harness.rs Wire harnesses: wires, connectors, bundle diameter, end treatment; harness/topology.rs: 3D topology
crates/openecraft-core/src/kbl.rs KBL export (VDA 4964, KBL 2.4 SR-1)
crates/openecraft-core/src/harness_export.rs Harness interface: JSON, wire processing list, bundle in 3D
crates/openecraft-core/src/translation.rs Project texts in several languages: dictionary, translated output, CSV
crates/openecraft-core/src/wiring.rs Wiring assistant: checklist order, wired / problem marks, progress, CSV
crates/openecraft-core/src/mounting.rs Mounting assistant: mounting order, mounted / problem marks, progress, CSV
crates/openecraft-core/src/integration.rs Integration layer: neutral fields, connectors (ERP, PDM, PLM, ECAD, MCAD, procurement, wiring machine), profiles, import preview, conflicts, exchange log
crates/openecraft-core/src/fluid.rs Hoses and pipes between fluid ports: media, defaults, configuration, fluid netlist (port and line kinds), tube routing, tubing, checks
crates/openecraft-core/src/electrofluid.rs Fluid device groups and the links between fluid and electrical devices: cross references, checks, synchronization
crates/openecraft-core/src/process.rs Pre-planning: PCT loops, P&ID instruments, engineering status
crates/openecraft-core/src/preplanning.rs Pre-planning: segments, planned devices, templates, power budget, page generation, CSV / Excel
crates/openecraft-core/src/singleline.rs Single-line / multi-line engineering: device status, checks, transformation in both directions
crates/openecraft-core/src/netlist.rs Connectivity analysis (nets / potentials, junctions)
crates/openecraft-core/src/index.rs Device and cross-reference index
crates/openecraft-core/src/reports.rs Reports and project check
crates/openecraft-core/src/render.rs Backend independent page renderer (used by canvas and SVG)
crates/openecraft-canvas/src/editor.rs Interactive canvas (tools, hit testing, pan/zoom)
openecraft/src/frame_stats.rs Frame time and frames per second for the title bar
crates/openecraft-canvas/src/jobs.rs Exports and imports on another thread, their results taken every frame
crates/openecraft-core/src/ops.rs Editing operations (placement defaults, move, rotate, paste, cable cores, page structure, …)
crates/openecraft-core/src/structure.rs Structure identifiers: parse / complete / shorten tags (=A1+CAB1-K1)
crates/openecraft-core/src/potentials.rs Potential definitions, presets, automatic wire colour and cross-section
crates/openecraft-core/src/climate.rs Enclosure climate (IEC/TR 60890): power loss, surface, cooling and heating
crates/openecraft-core/src/sizing.rs Electrical sizing: current-carrying capacity behind protective devices (fuse links set the rating of fuse switches), sizing of the wires behind them, voltage drop
crates/openecraft-core/src/electrical.rs Supply, installation conditions, circuits of the mains
crates/openecraft-core/src/protection.rs Protective devices: characteristics, time-current bands, let-through energy
crates/openecraft-core/src/shortcircuit.rs Short-circuit currents, disconnection, withstand, selectivity
crates/openecraft-core/src/loads.rs Load calculation, diversity, phase balance, power supply budgets
crates/openecraft-core/src/emc.rs EMC checks of the cables
crates/openecraft-core/src/safety.rs Safety functions and performance level (ISO 13849-1)
crates/openecraft-core/src/rules.rs Rule libraries, customer rule sets, limits and verification
crates/openecraft-core/src/tables.rs Editing devices, connections and terminals in tables, CSV round trip
crates/openecraft-core/src/config.rs Configurator: options, rules, page generation from macros
crates/openecraft-core/src/wirenum.rs Wire numbers per connection and automatic numbering
crates/openecraft-core/src/macros.rs Window / page macros, placeholders and value sets
crates/openecraft-core/src/pdf_comments.rs Import of PDF comments (annotations) into the review layer; minimal PDF object reader
crates/openecraft-core/src/marking.rs Device, terminal, wire and cable markers, labeling schemes, marking CSV / Excel
crates/openecraft-core/src/strips.rs Terminal strips: order, renumbering, jumpers, spare terminals, part per terminal, strip layout with accessories, jumper parts
crates/openecraft-core/src/plugs.rs Plugs: pin order, both sides of each pin, pin count of the parts, placement check
crates/openecraft-core/src/plc.rs PLC points, addressing, symbol table export / import
crates/openecraft-core/src/revision.rs Revisions: page snapshots, change detection, revision names, approval workflow
crates/openecraft-core/src/compare.rs Baselines, project comparison and taking differences over
crates/openecraft-core/src/review.rs Comments, redline / greenline markup, approvals, change requests (merged without locks)
crates/openecraft-core/src/pdf.rs / dxf.rs PDF and DXF export (through the render::Draw trait)
crates/openecraft-core/src/dxf_import.rs DXF import as a schematic page
crates/openecraft-core/src/dwg.rs DWG export and import (converted from / to DXF with acadrust)
crates/openecraft-core/src/export3d.rs 3D scene of the panel layout, glTF, STEP, IGES, IFC, JT and Parasolid export
crates/openecraft-parts/src/ifc.rs IFC import of part models (small STEP physical file reader)
crates/openecraft-parts/src/bmecat.rs BMEcat catalog import with ETIM / eCl@ss features (small XML reader in xml.rs)
crates/openecraft-parts/src/bundled.rs Manufacturer catalogs shipped with OpenECraft (catalogs/<id>.json): installed by the parts server, used by the example projects
openecraft/src/app/engineering.rs Windows for macros, terminal strips and PLC overview
openecraft/src/app/revisions_ui.rs Revisions window with the approval workflow
openecraft/src/app/compare_ui.rs, openecraft/src/app/review_ui.rs, openecraft/src/app/requests_ui.rs Compare and baselines, review tab and tools, change requests
openecraft/src/app/symbol_editor.rs / openecraft/src/app/forms_ui.rs Symbol editor and forms (title block / report form) windows
openecraft/src/app/harness_ui.rs Harness window
openecraft/src/app/languages_ui.rs Project languages window: dictionary, export per language
openecraft/src/app/process_ui.rs Hose properties and the fluid and process window (hoses, fluid netlist, device groups, electro-fluid links, PCT loops)
openecraft/src/app/singleline_ui.rs Single-line / multi-line window: device status and the transformations
openecraft/src/app/integration_ui.rs Enterprise integration window: export, import preview, profiles, linked data, log
openecraft/src/wiring_ui.rs Wiring assistant workspace: checklist, current wire, 3D view, progress
openecraft/src/mounting_ui.rs Mounting assistant: checklist in mounting order, current item, 3D view, progress
crates/openecraft-core/src/panel.rs Panel layout model, device sizes, rail snapping, collisions, duct routing
crates/openecraft-core/src/panel/lineup.rs Line-ups: enclosures bayed side by side and the cable passages between them
crates/openecraft-core/src/panel/buildings.rs Buildings: levels and the rooms on them, shafts and the ways through them, links between buildings, their check
crates/openecraft-core/src/panel/rooms.rs Rooms: floor plan outline and its walls, cabinets standing in them, rails, ducts and wall-mounted devices on walls and ceiling, wall penetrations and where they lead, building entries, their checks
crates/openecraft-core/src/panel/rack.rs 19-inch racks: rack units, 19-inch parts snapped onto whole units, their mounting rails and checks
crates/openecraft-canvas/src/panel_ui/plan.rs Floor plan of a room: drawing and moving walls, placing cabinets
crates/openecraft-core/src/routing3d.rs 3D routing of wires, cables and tubes: rules, routing paths and reservations, grid search, bundles, shields, frozen routes
crates/openecraft-core/src/collab.rs Shared projects: API types, lock targets and the merge rules of the project server
crates/openecraft-canvas/src/panel_ui.rs Panel layout workspace: navigator, 2D editor, properties; panel_ui/view3d.rs the 3D view (panel_ui/scene3d.rs what it shows, kept between frames; panel_ui/gpu3d.rs drawn by the graphics card), panel_ui/routing_ui.rs the 3D routing (paths, reservations, rules, frozen routes)
crates/openecraft-core/src/parts.rs Parts database, function templates, project parts, CSV import/export
openecraft/src/parts_ui.rs Parts management window, part selection dialog, parts server panel, data portal window
openecraft/src/remote.rs, openecraft/src/app/remote_ui.rs Project server client, window and shared editing (locks, merging); rules in crates/openecraft-core/src/collab.rs
openecraft/src/startup.rs Settings › On startup and the source of the open project (local file, server project, local copy of one) shown in the status bar and the tooltip of Save
openecraft/src/vault.rs, openecraft/src/app/vault_ui.rs Autodesk Vault client and window: browsing, imports, uploads and check-ins, item links; requests in crates/openecraft-client/src/vault.rs
openecraft/src/app.rs Application UI (menus, panels, dialogs); the windows in openecraft/src/app/*_ui.rs (cables, tables, PLC, plugs, potentials, structure, pages, …)
crates/openecraft-core/src/svg.rs SVG / print export
openecraft/src/io.rs File kinds of the editor (dialogs are in openecraft-ui)