This commit is contained in:
1 parent
d1a56f77cc
commit
0e7aed40f1
21 files changed
+1253
-19
No files matched your search
@@ -55,6 +55,7 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
|
||||
| [0038](adr/0038-non-blocking-native-dialog-broker.md) | Worker-owned native waits with one-shot main-thread workflow completion |
|
||||
| [0039](adr/0039-inline-height-grid-terrain-foundation.md) | Inline authored height grids with deterministic runtime-only chunk hydration |
|
||||
| [0040](adr/0040-terrain-material-layer-weights.md) | Four-channel terrain material layers, compact normalized weights, and raster transport |
|
||||
| [0041](adr/0041-transactional-editor-physics-placement.md) | Paused editor physics ownership and transactional gravity placement |
|
||||
|
||||
## Editor framework
|
||||
|
||||
@@ -82,9 +83,11 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
|
||||
| [editor/collaborative-file-safety.md](editor/collaborative-file-safety.md) | Guarded authored writes, compact Git/read-only status, conflict recovery, and ownership providers |
|
||||
| [editor/native-dialogs.md](editor/native-dialogs.md) | Non-blocking native dialog acquisition and main-thread result application |
|
||||
| [editor/terrain.md](editor/terrain.md) | Terrain schema, inspector workflow, chunk hydration, collision, and follow-on boundaries |
|
||||
| [editor/physics-placement.md](editor/physics-placement.md) | Transactional gravity placement, diagnostics, isolation, and undo workflow |
|
||||
| [editor/evaluations/material-renderer-foundation/](editor/evaluations/material-renderer-foundation/) | Live screenshots and acceptance results for the renderer/material/component foundation |
|
||||
| [editor/evaluations/terrain-sculpt-tools/](editor/evaluations/terrain-sculpt-tools/) | Live screenshot and acceptance results for modal terrain sculpt tools |
|
||||
| [editor/evaluations/terrain-material-layers/](editor/evaluations/terrain-material-layers/) | Live screenshot and acceptance results for terrain material assignment, blending, painting, and history |
|
||||
| [editor/evaluations/physics-placement/](editor/evaluations/physics-placement/) | Live screenshot and acceptance results for physics settling, cancel, commit, undo, and redo |
|
||||
| [editor/evaluations/navigation-authoring/](editor/evaluations/navigation-authoring/) | Live screenshots and acceptance results for navigation authoring and runtime parity |
|
||||
| [editor/evaluations/production-readiness/](editor/evaluations/production-readiness/) | Current versioned production gate, evidence matrix, candidate commands, soak protocol, and independent sign-off requirements |
|
||||
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
# ADR 0041: Transactional Editor Physics Placement
|
||||
|
||||
## Status
|
||||
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
|
||||
The editor and game share one Bevy world and one Avian physics instance. Authored rigid
|
||||
bodies are hydrated in Edit mode so collider visualization and queries remain available,
|
||||
but advancing the shared simulation while editing mutates scene transforms outside history.
|
||||
A physics-placement tool must use the real runtime colliders while preventing unrelated
|
||||
dynamic bodies, PIE state, or authored physics settings from changing.
|
||||
|
||||
Running a second physics world would duplicate hydration, imported-mesh collider cooking,
|
||||
and hierarchy mapping. Advancing the existing world without isolation would make placement
|
||||
dependent on every other movable body in the scene and would violate cancel safety.
|
||||
|
||||
## Decision
|
||||
|
||||
The editor owns Avian's `Time<Physics>` clock:
|
||||
|
||||
- normal Edit mode and paused Play mode keep physics paused;
|
||||
- active Play mode unpauses physics;
|
||||
- paused Play single-step advances the physics clock by one fixed tick;
|
||||
- the placement tool advances bounded 120 Hz steps while Edit mode remains paused.
|
||||
|
||||
Physics placement is a transactional preview in the shared world. It snapshots the selected
|
||||
bodies' local transforms and runtime motion components, temporarily makes them dynamic, and
|
||||
temporarily makes every other movable rigid body static. Static bodies and all colliders stay
|
||||
in the same world, preserving production collision fidelity. Commit restores every temporary
|
||||
runtime override and writes only the final local transforms through one grouped history
|
||||
command. Cancel restores the full snapshot and writes no history.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Edit mode no longer permits authored dynamic bodies to drift outside undo history.
|
||||
- Placement uses the exact hydrated collider geometry used by PIE and the standalone game.
|
||||
- Kinematic and dynamic non-selected bodies behave as fixed collision surfaces during the
|
||||
preview; simulating interacting piles is deliberately outside this tool's contract.
|
||||
- A placement session cannot cross the Edit/Play boundary and is cancelled on mode exit.
|
||||
- Future editor physics previews should reuse this clock ownership and transactional-session
|
||||
model instead of introducing independent ad hoc simulation loops.
|
||||
|
||||
@@ -26,6 +26,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| [collaborative-file-safety.md](collaborative-file-safety.md) | Exact authored-file revisions, Git/read-only status, conflict recovery, and optional ownership providers |
|
||||
| [native-dialogs.md](native-dialogs.md) | Non-blocking file/folder/confirmation acquisition and main-thread result application |
|
||||
| [terrain.md](terrain.md) | Inline height-grid terrain, chunk hydration, collision, inspector workflow, and fixtures |
|
||||
| [physics-placement.md](physics-placement.md) | Transactional gravity placement, prerequisites, isolation, commit/cancel, and undo |
|
||||
| [evaluations/](evaluations/) | Acceptance evidence records and native Gitea attachment publishing policy |
|
||||
| [evaluations/material-renderer-foundation/](evaluations/material-renderer-foundation/) | Live screenshots and verification record for the renderer/material/component foundation |
|
||||
| [evaluations/material-library-targeted-drop/](evaluations/material-library-targeted-drop/) | Live screenshot and verification record for the docked Material Library and exact reversible surface drops |
|
||||
@@ -34,6 +35,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| [evaluations/terrain-foundation/](evaluations/terrain-foundation/) | Live screenshot and verification record for height-grid terrain schema and chunk hydration |
|
||||
| [evaluations/terrain-sculpt-tools/](evaluations/terrain-sculpt-tools/) | Live screenshot and verification record for modal sculpt controls, footprint, and stroke history |
|
||||
| [evaluations/terrain-material-layers/](evaluations/terrain-material-layers/) | Live screenshot and verification record for blended layers, assignment, painting, and history |
|
||||
| [evaluations/physics-placement/](evaluations/physics-placement/) | Live screenshot and verification record for multi-prop settling, cancel, commit, undo, and redo |
|
||||
| [evaluations/navigation-authoring/](evaluations/navigation-authoring/) | Live screenshots and verification record for navigation authoring and runtime parity |
|
||||
| [evaluations/production-readiness/](evaluations/production-readiness/) | Current #50 release-candidate matrix and required clean-checkout, soak, performance, limitation, and independent-signoff evidence |
|
||||
|
||||
@@ -44,6 +46,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| `lib.rs` / `EditorPluginGroup` | Ordered plugin bundle, lib/bin split | ADR 0008, architecture.md |
|
||||
| `shared::components::BrushDesc` / `shared::hydration::brushes` | Persisted brush authoring data and generated runtime mesh hydration | brushes.md, ADR 0021 |
|
||||
| `shared::components::TerrainDesc` / `shared::hydration::terrain` / `blacksite_surface` | Persisted height/layer grids, generated chunks, and raster blending | terrain.md, ADR 0039, ADR 0040 |
|
||||
| `viewport/physics_placement.rs` / `play/state.rs` | Paused Edit physics and transactional gravity placement | physics-placement.md, ADR 0041 |
|
||||
| `scene/` | Level I/O, tabs, composition materialization, schema, viewport render-target setup | architecture.md, multi-scene-composition.md, ADR 0026 |
|
||||
| `viewport/` | Camera, selection, gizmos, render views | architecture.md |
|
||||
| `play/` | PIE session, editor mode state | architecture.md |
|
||||
|
||||
@@ -24,6 +24,7 @@ Native-only dependencies (`rfd`, BRP HTTP) stay in `editor`. `settings`, `shared
|
||||
| `ProjectSettingsPlugin` | Load `assets/project.ron`, emit changes, sync `SimTuning` |
|
||||
| `ProjectIoPlugin` | User prefs, workspace metadata, window title inputs |
|
||||
| `EditorStatePlugin` | `EditorMode` (Edit/Play), `PlayPossession`, camera/input gating |
|
||||
| `PhysicsPlacementPlugin` | Paused Edit physics plus isolated transactional gravity placement |
|
||||
| `ViewportPlugin` | Grid, focus, bookmarks, snap settings |
|
||||
| `EditorCameraPlugin` | Fly camera; FX applied via `render_view` + `viewport_camera` sync |
|
||||
| `ActorIconsPlugin` | Selectable actor root billboard icons |
|
||||
@@ -181,11 +182,19 @@ stateDiagram-v2
|
||||
|----------|---------|-------------------|-----------------|
|
||||
| `SimEnabled` | false | true | true |
|
||||
| `GameInputEnabled` | false | true | false |
|
||||
| `Time<Physics>` | paused | running | running |
|
||||
| Editor camera active | true | false | true |
|
||||
| Player camera active | false | true | false |
|
||||
|
||||
On play enter/exit the editor snapshots **player sim state only** (transform, velocity, jump timers). Authored scene entities are not rolled back so in-play edits persist when stopping PIE.
|
||||
|
||||
Paused Play also pauses `Time<Physics>`; **F7** advances that clock by exactly one 64 Hz sim tick.
|
||||
Edit mode keeps the clock paused. `viewport/physics_placement.rs` may advance bounded 120 Hz
|
||||
preview steps while selected bodies are temporarily dynamic and every other movable body is
|
||||
temporarily static. Commit records only final local transforms through grouped history; cancel and
|
||||
the Edit-to-Play boundary restore the complete runtime snapshot. See
|
||||
[physics-placement.md](physics-placement.md) and [ADR 0041](../adr/0041-transactional-editor-physics-placement.md).
|
||||
|
||||
## Scene authoring flow
|
||||
|
||||
1. User edits entities with `LevelObject` + reflectable components from `shared`.
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# Physics Placement Evaluation
|
||||
|
||||
Date: 2026-07-12
|
||||
|
||||

|
||||
|
||||
The native Wayland editor is shown with the committed
|
||||
`assets/levels/physics_placement_showcase.scn.ron` fixture. Placement Prop A, B, and C were
|
||||
multi-selected and released from three different heights through the hand/down-arrow action in the
|
||||
existing horizontal viewport toolbar.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- All three props used the hydrated Avian cuboid colliders and settled on Placement Floor after
|
||||
1.5 simulated seconds.
|
||||
- During preview the HUD reported selection count, simulated time, and Settled state; transform
|
||||
gizmos and viewport picking did not compete with the modal tool.
|
||||
- Escape restored every starting transform and left history empty.
|
||||
- A second run committed with Enter as exactly one `Undo: Move Selection` entry.
|
||||
- Ctrl+Z restored all three elevated starting transforms; Ctrl+Y restored the settled transforms.
|
||||
- Opening the fixture immediately after the terrain showcase no longer panicked on a stale
|
||||
generated terrain-material binding; the scene-switch regression is covered in
|
||||
`blacksite_surface`.
|
||||
- The runtime log contained no physics-placement, scene-load, render-pipeline, or GPU validation
|
||||
error after the stale-binding fix.
|
||||
|
||||
Packaged-runtime tests remain intentionally deferred by project-owner request.
|
||||
|
||||
Binary file not shown.
@@ -31,8 +31,8 @@ another commit, a dirty worktree, or an older package do not transfer to the can
|
||||
| ID | Requirement | State | Current evidence and gap |
|
||||
|----|-------------|-------|--------------------------|
|
||||
| G1 | Project create/open/resume, scene authoring, autosave/recovery, hierarchy, prefab, and asset integrity pass | Partial | Project/recovery/session/multi-scene/prefab implementations are documented in [project launcher](../../project-launcher.md), [session recovery](../../session-recovery.md), [multi-scene composition](../../multi-scene-composition.md), and [prefab authoring](../../prefab-authoring.md). Collaborative file safety `#49` and non-blocking native dialogs `#52` passed live acceptance. Candidate-specific end-to-end reruns remain. |
|
||||
| G2 | Brush, material, terrain, physics placement, animation, audio, navigation, PIE, and build/package samples pass | Fail | Animation, audio, navigation, Material Library, targeted material drops, and build foundations are implemented. Renderer foundation `#51` remains open on deformed Solari geometry; terrain `#22`-`#24`, physics placement `#25`, and brush acceptance `#37` remain incomplete. Packaged testing is owner-deferred. |
|
||||
| G3 | Undo/redo/cancel invariants and helper cleanup cover every production mutation path | Partial | The reusable harness and current tool coverage are documented in [operator regression testing](../../operator-regression-testing.md). Gitea `#33` remains open for terrain-stroke and physics-settle fixtures after those tools exist. |
|
||||
| G2 | Brush, material, terrain, physics placement, animation, audio, navigation, PIE, and build/package samples pass | Fail | Animation, audio, navigation, Material Library, targeted material drops, terrain `#22`-`#24`, physics placement `#25`, and build foundations are implemented with source/live fixtures. Renderer foundation `#51` and brush acceptance `#37` remain incomplete. Packaged testing is owner-deferred. |
|
||||
| G3 | Undo/redo/cancel invariants and helper cleanup cover every production mutation path | Partial | The reusable harness and current tool coverage are documented in [operator regression testing](../../operator-regression-testing.md). Terrain stroke and physics settle/cancel/undo fixtures now exist; Gitea `#33` remains open for full mutation-path coverage. |
|
||||
| G4 | Representative project completes an eight-hour soak without unbounded memory/target growth or unrecoverable failure | Missing | No candidate soak log, resource timeline, failure ledger, or target-growth measurement exists. |
|
||||
| G5 | Cold start, scene open/save, asset refresh, common manipulation, and package-build budgets are documented and measured | Missing | Gitea `#34` is open; no ratified budgets or candidate measurement record exists. |
|
||||
| G6 | Headless content validation and CI are green from a clean checkout | Missing | [CI configuration](../../../../.github/workflows/ci.yml) exists and local source/headless checks have passed during feature work, but no clean-checkout candidate run is linked. The current Gitea server does not expose an Actions run endpoint for this repository. |
|
||||
@@ -58,7 +58,7 @@ another commit, a dirty worktree, or an older package do not transfer to the can
|
||||
| Brush blockout/edit/CSG | Implemented foundation; `#37` open | Not signed off |
|
||||
| Material catalog and assignment | Material Library and exact targeted drops accepted; `#51` open only on deformed Solari geometry | Not rerun as one candidate |
|
||||
| Terrain authoring | `#22`-`#24` open | Blocked |
|
||||
| Physics placement | `#25` open | Blocked |
|
||||
| Physics placement | `#25` source/live acceptance complete | Pass; packaged-runtime acceptance owner-deferred |
|
||||
| Animation | Implemented | Not rerun |
|
||||
| Audio | Implemented | Not rerun |
|
||||
| Navigation | Implemented | Not rerun |
|
||||
|
||||
@@ -88,6 +88,11 @@ handle in place. Standard and custom Surface changes therefore propagate to ever
|
||||
or skinned renderer slot without reloading geometry, joints, or the current animation pose. Invalid
|
||||
Surface edits retain the last-good evaluator generation and emit diagnostics.
|
||||
|
||||
Renderer and terrain material bindings target generated draw entities. Scene switches may remove
|
||||
those entities between binding discovery and deferred command application, so binding replacement
|
||||
uses fallible entity commands and treats that stale-target race as normal lifecycle cleanup rather
|
||||
than an editor-fatal error.
|
||||
|
||||
## Custom Surface evaluators
|
||||
|
||||
A custom shader schema may reference evaluator WGSL. Evaluators return material properties through
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# Physics Placement
|
||||
|
||||
The Physics Placement tool releases selected authored props into the same Avian collision world
|
||||
used by Play mode. It is intended for arranging loose objects on floors, terrain, brushes, and
|
||||
other hydrated colliders without hand-tuning every final transform.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Select one or more mutable level objects. Each object needs an enabled **Rigid Body** and an
|
||||
enabled, non-trigger **Collider** component.
|
||||
2. Press the hand/down-arrow button in the existing horizontal Scene viewport toolbar.
|
||||
3. The selected props become dynamic and fall under gravity. The viewport HUD reports simulation
|
||||
time and whether the group is still moving, settled, or stopped at the preview limit.
|
||||
4. Press the check button to commit the current transforms, or **Escape** / the X button to cancel.
|
||||
**Enter** commits after the group has settled.
|
||||
|
||||
Commit creates one `Move Selection` undo entry for the whole group. Cancel restores the exact
|
||||
pre-placement local transforms and runtime motion components and creates no history entry.
|
||||
|
||||
## Isolation And Diagnostics
|
||||
|
||||
Normal Edit mode keeps Avian physics paused, so authored dynamic bodies cannot drift outside
|
||||
history. During placement, every non-selected dynamic or kinematic body is temporarily treated as
|
||||
a static collision surface. The tool restores those bodies exactly when the preview ends. Entering
|
||||
Play mode cancels an active placement preview.
|
||||
|
||||
The start action is non-destructive when prerequisites are missing. The viewport and status strip
|
||||
identify locked/linked selections, missing or disabled rigid bodies, missing/trigger colliders, and
|
||||
colliders that are still cooking. A ten-second simulated-time limit stops unstable previews while
|
||||
leaving explicit commit and cancel available.
|
||||
|
||||
`assets/levels/physics_placement_showcase.scn.ron` is the committed acceptance fixture. Select
|
||||
**Placement Prop A**, **B**, and **C** together, start physics placement, and verify that the three
|
||||
different shapes settle on **Placement Floor** as one commit/cancel transaction.
|
||||
|
||||
The clock and transaction boundary are specified by
|
||||
[ADR 0041](../adr/0041-transactional-editor-physics-placement.md).
|
||||
@@ -57,6 +57,7 @@ Phased work for the in-process editor (`crates/editor`). Status reflects the cur
|
||||
| Clean game-view overlay | Done | `G` hides editor chrome, grid, visualizers, proxies, gizmos, and selection outlines |
|
||||
| Tab cycle overlapping picks | Done | `ViewportPickStack` + Tab in viewport |
|
||||
| Multi-viewport | Scaffolded | Primary viewport state is separated from render ownership; secondary viewports remain future work |
|
||||
| Physics placement | Done | Existing horizontal toolbar action; real Avian settling, prerequisite diagnostics, exact cancel, grouped undo, and isolated non-selected bodies |
|
||||
|
||||
## Phase 2b — Advanced rendering
|
||||
|
||||
|
||||
Reference in new issue
Block a user