From e8cb20ac38cf68fd2ebf1af0b1164b5cabeabc83 Mon Sep 17 00:00:00 2001 From: Hermes Agent Date: Mon, 25 May 2026 01:29:40 -0400 Subject: [PATCH] docs: mark legacy exports out of scope --- docs/knowledgebase/architecture-notes.md | 2 +- docs/knowledgebase/feature-inventory.md | 10 ++++++---- docs/knowledgebase/ui-panel-map.md | 4 ++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/knowledgebase/architecture-notes.md b/docs/knowledgebase/architecture-notes.md index 84afc36..1339dfc 100644 --- a/docs/knowledgebase/architecture-notes.md +++ b/docs/knowledgebase/architecture-notes.md @@ -35,4 +35,4 @@ Start simple, then split into crates when module boundaries stabilize. ## Compatibility strategy -OpenVistaPro should preserve workflow concepts first. Direct compatibility with old file formats can be added later only when it can be done cleanly and legally. +OpenVistaPro should preserve workflow concepts first. Direct legacy file compatibility is out of scope for the current clean-room pipeline; the supported export surfaces are project-owned `.ovp.toml` scenes and PNG renders. Any future compatibility work needs a separately reviewed plan. diff --git a/docs/knowledgebase/feature-inventory.md b/docs/knowledgebase/feature-inventory.md index f32a3a5..8dae398 100644 --- a/docs/knowledgebase/feature-inventory.md +++ b/docs/knowledgebase/feature-inventory.md @@ -5,18 +5,20 @@ This is a normalized reconciliation of the VistaPro manuals, MakePath guide, scr Status counts by normalized feature family: - Implemented: 12 - Partial: 5 -- Planned: 3 +- Planned: 2 +- Not planned: 1 Notes: - “Implemented” means the current codebase has a working, tested slice for that family. - “Partial” means the codebase covers part of the family but not the full manual-described workflow. - “Planned” means the family is still absent or only mentioned as roadmap context. +- “Not planned” means the family is intentionally out of scope for the current clean-room pipeline. ## Normalized feature families | Feature family | Manual / reference evidence | OpenVistaPro status | Implementation evidence | Gap / next step | |---|---|---|---|---| -| Terrain sources and compatibility boundary | VistaPro 2 manual: Load Landscape / Save Landscape; VistaPro 3 manual: Load, Save, Exp/Imp menus and DEM/PCX/Targa24 references. | Partial | `src/import.rs`, `src/cli.rs` (`supported_importers()`), `README.md` importer status. | OpenVistaPro intentionally keeps the clean internal model separate and does not claim legacy VistaPro format compatibility. | +| Terrain sources and compatibility boundary | VistaPro 2 manual: Load Landscape / Save Landscape; VistaPro 3 manual: Load, Save, Exp/Imp menus and DEM/PCX/Targa24 references. | Partial | `src/import.rs`, `src/cli.rs` (`supported_importers()`), `README.md` importer status. | OpenVistaPro intentionally keeps the clean internal model separate and only claims open/synthetic importers plus project-owned exports. Legacy VistaPro format compatibility remains out of scope unless it gets a separately reviewed clean-room plan. | | Project-owned plain-text heightfields (`ovp-text`) | Clean-room project fixture format, not part of the legacy manuals; used to model the import boundary safely. | Implemented | `src/import.rs` (`import_ovp_text`), tests in `src/import.rs`, fixture in `tests/fixtures/open/`. | No gap for the MVP slice; this is the project-owned test/import path. | | SRTM / HGT terrain import | VistaPro manuals describe loading DEM-like landscape data; the open equivalent is the SRTM/HGT family. | Implemented | `src/import.rs` (`import_hgt` behind `hgt`), `README.md`, tests in `src/import.rs`. | Still only the open SRTM slice; broader compatibility formats remain separate. | | GeoTIFF terrain import | Modern open terrain source, not a legacy VistaPro format. | Implemented | `src/import/geotiff.rs` behind `import-geotiff`, tests in that module. | Deliberately narrow subset: tiny synthetic single-band raster support only. | @@ -35,8 +37,8 @@ Notes: | Script execution and animation frames | MakePath guide says scripts should render full animations and VistaPro can run scripts from the Script menu. | Implemented | `src/script_exec.rs` (`run_script` / `run_script_source`), `src/cli.rs` (`script run`), `src/app.rs` script controls, `src/app_state.rs`, tests in `src/script_exec.rs`. | The executor now runs preset/import/render slices; animation-frame sequencing is still a future extension. | | MakePath-style path generation and motion models | MakePath guide describes spline nodes, previewing a path, and vehicle models (jet, glider, dune buggy, motorcycle, helicopter, cruise missile, custom). | Implemented | `src/path.rs`, `src/app_state.rs` (`make_path`), `src/app.rs` path controls, tests in `src/path.rs` and `src/app_state.rs`. | Core camera-path generation is now present; editable nodes, vehicle-specific motion models, and script export remain future expansion points. | | UI shell, menus, dialogs, and numeric gadgets | VistaPro screenshots/manuals show dense menus, dialogs, map tools, and numeric gadgets. | Partial | `src/app.rs`, `src/app_state.rs`, `src/ui_shell.rs`, `src/bin/openvistapro_app.rs`, plus the `app` feature shell tests. | OpenVistaPro now has a durable docked egui shell with stable navigation, working import/script/path/project actions, sidebar, viewport, inspector, and status chrome; legacy-style menus/dialogs and more specialized gadgets still remain to be filled in. | -| Legacy image / landscape export formats | VistaPro manuals mention saving rendered images and landscapes in formats like IFF/IFF24/RGB and DEM/binary landscape files. | Planned | Current output is PNG plus project-owned `.ovp.toml` scenes. | Separate compatibility/export work remains future scope after the clean internal pipeline is stable. | +| Legacy image / landscape export formats | VistaPro manuals mention saving rendered images and landscapes in formats like IFF/IFF24/RGB and DEM/binary landscape files. | Not planned | Current output is PNG plus project-owned `.ovp.toml` scenes. | Direct compatibility with legacy VistaPro export formats stays out of scope for the clean-room project; if it is ever reconsidered, it should come back through a separately reviewed investigation. | ## Current reconciliation summary -OpenVistaPro already covers the core clean-room pipeline: terrain grids, open importers, scene state, preview/final rendering, quality-profile tradeoffs, project-owned scene files, script execution, MakePath-style path generation, editable color-map thresholds/bands, and scene-level vertical exaggeration. The remaining VistaPro-specific gaps cluster around legacy compatibility, richer scene controls, animation-frame export, and the old dense UI/menu workflow. +OpenVistaPro already covers the core clean-room pipeline: terrain grids, open importers, scene state, preview/final rendering, quality-profile tradeoffs, project-owned scene files, script execution, MakePath-style path generation, editable color-map thresholds/bands, and scene-level vertical exaggeration. The remaining VistaPro-specific gaps cluster around richer scene controls, animation-frame export, and the old dense UI/menu workflow; direct legacy export-format compatibility is intentionally not part of the current scope. diff --git a/docs/knowledgebase/ui-panel-map.md b/docs/knowledgebase/ui-panel-map.md index 1a42f70..9636ab6 100644 --- a/docs/knowledgebase/ui-panel-map.md +++ b/docs/knowledgebase/ui-panel-map.md @@ -13,7 +13,7 @@ This is a normalized modern shell map derived from the VistaPro manuals, screens | Scripts / paths | Script menu, Run Script, MakePath path tools, animation-frame workflows | Right dock or modal workflow | Partial | Script parsing/execution and MakePath-style path generation now run end-to-end in the backend; the shell surfaces a script editor, Run Script, and Make Path controls, but animation-frame export and richer path editing are still future work. | | File / project actions | New/Open/Save landscape, scene load/save, export commands | Top bar / file menu | Partial | The shell now shows scene-file status and working New/Open/Save controls; legacy menu chrome and export dialogs are still missing. | | Status / feedback | Coordinate readouts, render state, file path, progress, messages | Bottom status bar | Present | The shell now has a bottom status bar driven by `AppData::ui_snapshot()`. | -| Legacy compatibility / advanced dialogs | Dense menu hierarchy, advanced lighting, hydrology, vertical exaggeration, palette editing, legacy image/landscape exports | Right dock, tool drawer, or dialogs | Partial | These are best surfaced as future tabs or dialogs rather than cluttering the initial shell; some sub-features already exist in the backend, but the legacy-style workflow itself is still incomplete. | +| Legacy compatibility / advanced dialogs | Dense menu hierarchy, advanced lighting, hydrology, vertical exaggeration, palette editing, legacy image/landscape exports | Right dock, tool drawer, or dialogs | Partial | These are best surfaced as future tabs or dialogs rather than cluttering the initial shell; some sub-features already exist in the backend, but direct legacy export compatibility is intentionally out of scope for now. | ## Recommended shell structure @@ -47,4 +47,4 @@ That layout preserves the VistaPro workflow while making room for modern discove - No dedicated scripts/paths editor surface beyond the current MVP controls. - Palette import/export and legacy texture loading remain open. - Hydrology still lacks routed-water simulation and drainage maps. -- Legacy export and compatibility dialogs remain future work. +- Legacy export and compatibility dialogs are intentionally out of scope for now. -- 2.39.5