Skip to content

roadmap-progress.md

Latest commit

 

History

History
79 lines (63 loc) · 5.74 KB

roadmap-progress.md

File metadata and controls

79 lines (63 loc) · 5.74 KB

Roadmap Progress Snapshot

Environment note (aligned with 11 Feb 2025 sanity check): The current configure step fails because Qt 6 SDK files are missing, so the highlights below describe code that exists in the repository rather than recently validated binaries. Re-run scripts/bootstrap.py (or provide Qt 6 via CMAKE_PREFIX_PATH) before expecting the workflows to pass.

This document cross-references the current FreeCrafter implementation with the items tracked in ROADMAP.md so contributors can quickly see which roadmap milestones already have code backing them and which ones are still open.

Verification status (aligned with README)

  • python scripts/bootstrap.py now reuses the apt-installed Qt stack at /usr, rebuilds every target, and installs FreeCrafter into dist/bin/ without additional steps.【074f9f†L1-L11】【F:scripts/bootstrap.py†L320-L349】 Packaging work can therefore focus on runtime bundling rather than unblocking the compiler.
  • ctest --test-dir build --output-on-failure runs to completion, but 7/18 suites fail: GPU-dependent tests (render_regression, viewport_depth_range, tool_activation, cursor_overlay, undo_stack_resets) crash without an OpenGL context in this headless environment, and the regression suites for Phase 4 and Phase 6 (phase4_tools, phase6_advanced_tools) still assert on offset/follow-me/surface behaviours.【5df591†L1-L68】【324942†L1-L15】 Roadmap checkboxes therefore remain ☑ for implementation coverage but ⚠️ for verification until these regressions are cleared.

Release Packaging Readiness

  • The Windows release workflow builds the project with CMake, packages it with CPack's NSIS generator, and now uploads any generated installer that matches build/*.exe by enabling globbing on the upload step. This guarantees that a .exe asset is attached to GitHub releases that are triggered from tags. 【F:.github/workflows/release-windows.yml†L46-L53】
  • The root CMakeLists.txt already configures NSIS-specific metadata (display name, Start Menu shortcut, prerequisite installer macro) and enables CPack, so the workflow's cpack -G NSIS invocation produces a Windows installer. 【F:CMakeLists.txt†L44-L64】

Roadmap Alignment Highlights

Phase 1 — Core Shell (implemented)

  • QMainWindow scaffolding: Multi-tab document bar, a persistent OpenGL viewport, toolbar ribbon, and right-side dock panels are fully wired up in MainWindow. 【F:src/MainWindow.cpp†L35-L274】
  • Status bar & measurement widget: Live cursor/selection feedback and the measurement (VCB-style) widget emit committed values for future tool usage. 【F:src/MainWindow.cpp†L276-L294】【F:src/ui/MeasurementWidget.cpp†L7-L34】
  • Hotkey map: Actions for file, view, and tool commands are registered with HotkeyManager and kept in sync with toolbar tooltips. 【F:src/MainWindow.cpp†L296-L348】
  • Viewport placeholder: The OpenGL viewport renders the reference grid, axes, curve/solid previews, and a HUD showing FPS, frame time, and draw calls — matching the roadmap's frame budget HUD milestone. 【F:src/GLViewport.cpp†L57-L199】

Phase 2 — Geometry & Interaction (implemented)

  • Tool state machine: Shared tooling flows from Tool::handle* helpers that arm, activate, and return to idle while wiring Enter/Esc through GLViewport to call Tool::commit()/Tool::cancel(). 【F:src/Tools/Tool.cpp†L5-L159】【F:src/GLViewport.cpp†L1247-L1275】
  • Core toolset: The required select, line, move, rotate, and scale tools are implemented with selection gathering, inference-aware point resolution, drag previews, and measurement overrides. 【F:src/Tools/SmartSelectTool.cpp†L65-L240】【F:src/Tools/LineTool.cpp†L55-L199】【F:src/Tools/MoveTool.cpp†L13-L194】【F:src/Tools/RotateTool.cpp†L55-L216】【F:src/Tools/ScaleTool.cpp†L40-L233】
  • Inference & axis locking: Geometry snaps enumerate endpoints, midpoints, intersections, and face cues, with ToolManager applying sticky locks and X/Y/Z axis constraints for manipulation tools. 【F:src/Interaction/InferenceEngine.cpp†L450-L519】【F:src/Tools/ToolManager.cpp†L182-L466】
  • Visual feedback: Selection renders with distinct colors while the inference overlay shows hover glyphs, dashed direction guides, and axis lock anchors to confirm the active snap. 【F:src/GLViewport.cpp†L352-L420】【F:src/GLViewport.cpp†L935-L1004】

Phase 5 — Object Management (implemented)

  • Groups, hierarchy, and components: Scene::Document creates groups, re-parents nodes, and tracks component definitions/instances so that the outliner tree can be reorganised and instanced content refreshed or made unique on demand. 【F:src/Scene/Document.cpp†L132-L275】
  • Tags, visibility, and isolation: Object tags carry colours, visibility toggles, and isolation stacks while updateVisibility() applies the resulting rules to geometry so hidden items drop out of inference. 【F:src/Scene/Document.cpp†L277-L360】【F:src/Scene/Document.cpp†L640-L704】
  • Scenes & persistence: Scene snapshots capture camera pose, style toggles, tag visibilities, and colour-by-tag state, and can be saved/loaded alongside geometry for round-tripping document state. 【F:src/Scene/Document.cpp†L371-L517】

Upcoming Gaps

  • Phase 3 cursor system: The dynamic cursor/pickbox visuals are the lone holdout from Phase 3 and still need to land so tool states are reflected in the pointer artwork.
  • Later-phase backlog: Phases 8–10 (performance/stability, polish, QA & release) are still tracked as open initiatives with no shipped code yet.
  • Surface painting (Phase 11): Remains a documentation-only plan awaiting engineering capacity.