Editor and Viewer requirements
Defines authoring, inspection, visualization, plotting, diagnostics, requirements navigation, and recorded-state playback.
Section relationships
| ID | Name | Priority | Requirement | Verification |
|---|---|---|---|---|
| UI-001 | Optional UI | MVP | The Editor and Viewer SHALL be optional for headless execution and SHALL not own authoritative simulation state. | Test |
| UI-002 | Project browser | MVP | The UI SHALL display projects, robots, worlds, experiments, runs, and referenced assets in a navigable hierarchy. | Demonstration |
| UI-003 | Three-dimensional viewport | MVP | The UI SHALL display visual geometry, transforms, cameras, and robot motion for the reference projects. | Demonstration |
| UI-004 | Entity selection | MVP | A user SHALL be able to select a visible or hierarchical entity and inspect its canonical identity and properties. | Demonstration |
| UI-005 | Unit-aware property display | MVP | Every displayed physical numeric property SHALL show its unit and preserve canonical meaning during display-unit conversion. | Test |
| UI-006 | Simulation controls | MVP | The UI SHALL provide run, pause, single-step, reset, stop, and playback controls with current virtual time and execution mode. | Demonstration |
| UI-007 | Time and performance display | MVP | The UI SHALL display virtual time, wall time, real-time factor, frame rate, and selected subsystem timings. | Demonstration |
| UI-008 | Debug geometry | Beta | The UI SHALL visualize selected collision shapes, contact points and normals, joint frames, centers of mass, inertia orientation, sensor frames, and force vectors. | Demonstration |
| UI-009 | Diagnostic panel | MVP | Compile and runtime diagnostics SHALL be filterable by severity and SHALL navigate to the responsible object where possible. | Demonstration |
| UI-010 | Telemetry plot | Beta | The UI SHALL plot selected scalar time-series channels with units and aligned virtual time. | Demonstration |
| UI-011 | Run comparison view | Beta | The UI SHALL compare selected metrics and time-series data from at least two runs. | Demonstration |
| UI-012 | Fidelity card view | Beta | The UI SHALL display the pre-run fidelity preview and completed-run fidelity card. | Demonstration |
| UI-013 | Conversion report view | Beta | The UI SHALL display import and export losses grouped by source asset and severity. | Demonstration |
| UI-014 | Environment visualization | Beta | The UI SHALL visualize selected wind, precipitation, visibility, wetness, temperature, and terrain-material fields without affecting simulation state. | Demonstration |
| UI-015 | Interactive transform editing | Beta | A user SHALL be able to edit permitted transforms with snapping, numeric input, frames, units, and validation. | Demonstration |
| UI-016 | Experiment editor | Beta | A user SHALL be able to edit parameter sweeps, distributions, seeds, stop conditions, metrics, and execution settings graphically. | Demonstration |
| UI-017 | Device connection view | Beta | The UI SHALL visualize and validate power, signal, controller, and physical device-port connections. | Demonstration |
| UI-018 | Undo and redo | Beta | Authoring changes SHALL support bounded undo and redo without changing completed run artifacts. | Test |
| UI-019 | Read-only live inspection | Beta | A user SHALL be able to inspect selected committed state while running without mutating the simulation. | Test |
| UI-020 | Playback separation | MVP | Recorded-State Playback SHALL not require, invoke, or advance any simulation solver or backend. | Test |
| UI-021 | User-selectable unit conversion | MVP | A user SHALL be able to convert a displayed physical quantity among documented dimensionally compatible SI and non-SI engineering units without changing its canonical SI meaning. | Demonstration |
| UI-022 | Robot bring-up workbench | Beta | The UI SHALL combine the canonical hierarchy, readiness report, conversion diagnostics, frames, inertial properties, joint limits and drives, collision geometry, device connections, and sensor fields of view into a navigable robot bring-up view. | Demonstration |
| UI-023 | Synthetic-data authoring and preview | Beta | The UI SHALL let a user configure labels and capture products and preview aligned sensor output and ground-truth annotations without changing authoritative simulation state. | Demonstration |
| UI-024 | Motion-planning inspection | Beta | The UI SHALL display a planning request's start and goal states, constraints, collision environment, returned candidate trajectories, feasibility status, and diagnostics before the user selects a trajectory for execution. | Demonstration |
| UI-025 | Frame-history inspector | Beta | A user SHALL be able to query and display the transform chain, source identities, authority, and update times between two supported frames at a selected virtual time. | Demonstration |
Change rationale (UI-020): The previous wording protected only the original mechanics backend. The canonical definition of Recorded-State Playback excludes rerunning any solver, so UI-020 now applies that separation consistently to every simulation solver and backend.
Change rationale (UI-021): MODEL-002 establishes canonical SI storage and UI-005 preserves canonical meaning during display conversion, but neither explicitly guarantees that a user can select and perform a compatible unit conversion. UI-021 makes that interaction mandatory.
Change rationale (UI-022–UI-025): These views turn the new Beta contracts into inspectable engineering workflows. They reuse authoritative compiler, sensor, planner, and frame data rather than creating UI-owned simulation semantics.
Generated from the canonical specification. Edit section metadata or prose in docs/requirements.md; the website rebuilds this page and its relationships automatically.