Compare commits
13
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a048233fce | ||
|
|
9e23ae731f | ||
|
|
4b33f32357 | ||
|
|
62b538999d | ||
|
|
d52cc2e3b7 | ||
|
|
06010c5922 | ||
|
|
c55f34780f | ||
|
|
1ab3886028 | ||
|
|
9a67a25a15 | ||
|
|
0ce43fc399 | ||
|
|
0e7aed40f1 | ||
|
|
d1a56f77cc | ||
|
|
293811aecd |
No files matched your search
@@ -7,6 +7,7 @@ rustflags = ["-C", "link-arg=-fuse-ld=mold"]
|
||||
[alias]
|
||||
clean-target = "run -p xtask --bin clean-target --"
|
||||
validate-levels = "run -p xtask --features validate-levels --bin validate-levels --"
|
||||
validate-samples = "run -p xtask --features validate-samples --bin validate-samples --"
|
||||
bake-navigation = "run -p xtask --features validate-levels --bin bake-navigation --"
|
||||
package-project = "run -p xtask --features validate-levels --bin package-project --"
|
||||
upgrade-project = "run -p xtask --features validate-levels --bin upgrade-project --"
|
||||
@@ -0,0 +1,31 @@
|
||||
# Collider Authoring Diagnostics - 2026-07-12
|
||||
|
||||
Issue: Gitea #26 (`BS-JD-305`)
|
||||
|
||||
## Outcome
|
||||
|
||||
Collider authoring exposes one consistent health result to the inspector, Collider viewport,
|
||||
Diagnostics panel, and physics placement preflight. Shape changes preserve useful dimensions and
|
||||
remain one typed undo operation.
|
||||
|
||||
## Contract
|
||||
|
||||
- Authored box, sphere, and capsule overlays include actor world scale.
|
||||
- Static mesh colliders show cooked runtime bounds when available.
|
||||
- Green is ready, cyan is a trigger, gray is disabled, amber is warning/stale, and red is invalid
|
||||
or missing.
|
||||
- Invalid dimensions and mesh references block dependent workflows. Missing hydration and
|
||||
colliders over 1,000 meters in world extent are warnings.
|
||||
- Physics placement consumes the same collider-health checks instead of maintaining a separate
|
||||
prerequisite definition.
|
||||
|
||||
## Work
|
||||
|
||||
- [x] Add shared authored/runtime collider diagnostics and focused fixtures.
|
||||
- [x] Add shape/status-aware viewport overlays and selected-collider HUD state.
|
||||
- [x] Add inspector health/repair feedback and dimension-preserving undoable shape switching.
|
||||
- [x] Add scene-wide selectable collider findings to Diagnostics.
|
||||
- [x] Reuse diagnostics in physics placement prerequisites.
|
||||
- [x] Add a committed non-blocking showcase scene and update documentation.
|
||||
- [x] Run source gates and live Wayland acceptance; packaged tests remain skipped by request.
|
||||
- [x] Commit, push, attach native Gitea evidence, close #26, and close M3 when empty.
|
||||
@@ -0,0 +1,66 @@
|
||||
# Editor Sample Regression Pack
|
||||
|
||||
Date: 2026-07-13
|
||||
Issue: BS-JD-501 / Gitea #32
|
||||
Milestone: M5 - Regression, docs, and first-hour UX
|
||||
|
||||
## Goal
|
||||
|
||||
Ship a deterministic five-scene editor regression pack that is easy to open from the editor and
|
||||
that fails headless validation when its catalog, authored data, or referenced assets drift. The pack
|
||||
must cover Brush, Material, Terrain, Physics Placement, and Rendering workflows.
|
||||
|
||||
## Decisions
|
||||
|
||||
- `assets/samples/editor_samples.ron` is the conventional, versioned pack manifest. This remains a
|
||||
QA/editor convention and does not extend `ProjectSettings`.
|
||||
- The manifest is parsed and validated in the `scene` crate. Editor UI and headless tooling consume
|
||||
that one representation.
|
||||
- Every entry has a stable ID, label, area, project-relative `.scn.ron` path, summary, and nonempty
|
||||
operator checks. Manifest order is menu and report order.
|
||||
- Exactly one entry for each required area is release-gated. Scene paths must remain regular files
|
||||
inside `assets/levels/`; traversal, absolute paths, symlink escapes, duplicates, and future schemas
|
||||
are blocking.
|
||||
- Existing accepted terrain, physics-placement, and rendering fixtures remain canonical entries.
|
||||
Add dedicated brush and material scenes under `assets/levels/samples/` and strengthen weak visual
|
||||
anchors in the existing fixtures instead of duplicating them.
|
||||
- `cargo validate-samples --project .` combines pack-specific structure/feature checks with the
|
||||
authoritative `validate_project` report. It verifies stable actor IDs, required area components,
|
||||
authoring-only scene documents, and referenced content.
|
||||
- Terrain descriptors and their shared material layers become first-class project-validation input.
|
||||
Actor-owned invalid descriptors or missing material references are blocking findings.
|
||||
- `File > Open Sample` is backed by a cached project catalog and opens through normal scene-tab I/O.
|
||||
Invalid or unavailable catalogs produce a disabled, actionable row rather than a panic.
|
||||
- CI hydrates Git LFS before content validation and runs both validation commands. Packaged-runtime
|
||||
tests remain deferred by project-owner request.
|
||||
|
||||
## Implementation
|
||||
|
||||
1. Add the manifest schema, deterministic report, safe path resolver, and sample feature checks to
|
||||
`scene::sample_pack`, with malformed/missing/duplicate/path-escape fixture tests.
|
||||
2. Add typed `TerrainDesc` validation and base/layer material dependency collection to authoritative
|
||||
project validation, including owner-attributed tests.
|
||||
3. Add the `validate-samples` xtask binary, Cargo alias, JSON mode, stable console summary, and CI
|
||||
steps. Enable LFS hydration at checkout and verify hydrated objects.
|
||||
4. Add the five-entry manifest, `brush_blockout.scn.ron`, and `material_lab.scn.ron`. Give every
|
||||
sample actor a stable `ActorId`; add visible rendering anchors and distinct physics shapes where
|
||||
the current fixtures are ambiguous.
|
||||
5. Load the catalog after project startup, render `File > Open Sample` in manifest order, and route a
|
||||
selected stable ID through scene I/O. Add unknown-entry and deterministic-row tests.
|
||||
6. Add a no-GPU typed-deserialization test over every manifest scene so unknown Bevy component
|
||||
registrations fail before native QA.
|
||||
7. Document pack contracts, per-scene checks, release commands, and the editor workflow. Update ADR
|
||||
0028, the root README checklist/controls, editor/docs indexes, feature guides, roadmap status,
|
||||
debt audit, and production-readiness evidence.
|
||||
8. Run source gates, open all five samples through the native menu, exercise one representative tool
|
||||
interaction per area, inspect logs, and attach representative native issue images when useful.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- Five manifest entries cover all required areas and open through `File > Open Sample`.
|
||||
- Every entry type-deserializes and has stable actor IDs plus its required authored feature.
|
||||
- `validate-levels` reports terrain material dependencies and has no blocking findings.
|
||||
- `validate-samples` is deterministic, CI-backed, and exits nonzero for pack or project blockers.
|
||||
- Native viewport captures are nonblank, correctly framed, and free of missing-reference, hydration,
|
||||
render, or operator errors.
|
||||
- Documentation gives contributors a single release-use workflow and explains every sample check.
|
||||
@@ -0,0 +1,62 @@
|
||||
# Guarded Shutdown And History Savepoints
|
||||
|
||||
Date: 2026-07-13
|
||||
Issue: BS-PR-709 / Gitea #55
|
||||
Milestone: M7 - Production Readiness
|
||||
|
||||
## Goal
|
||||
|
||||
Route every editor-exit surface through one non-blocking dirty-document decision and make scene
|
||||
dirtiness follow the authored undo timeline. Closing the native window, choosing File > Quit, and
|
||||
requesting an editor exit programmatically must never silently discard dirty scene tabs.
|
||||
|
||||
## Decisions
|
||||
|
||||
- The editor disables Bevy's automatic close-and-exit systems and owns primary-window close
|
||||
requests. A guarded-shutdown resource is the single authority that may emit `AppExit`.
|
||||
- The final dirty-state recheck and `AppExit` authorization run in a dedicated schedule after
|
||||
Bevy's `Last`; session clean-marker persistence runs after that finalizer.
|
||||
- Native window close, File > Quit, and internal editor quit requests enqueue the same shutdown
|
||||
intent. Repeated requests while confirmation or Save As is pending are coalesced.
|
||||
- Clean sessions exit immediately. Dirty sessions use the shared `NativeDialogBroker` and a single
|
||||
Save All / Discard / Cancel decision. Cancel preserves all tabs and live editor state; Discard
|
||||
exits without rewriting authored files; Save All exits only after every dirty tab is saved.
|
||||
- Untitled tabs and other asynchronous Save As work keep shutdown pending until their dialog result
|
||||
is applied on the main thread. Cancellation or any failed write returns the editor to an idle,
|
||||
dirty, recoverable state and does not emit `AppExit`.
|
||||
- Each scene tab retains a canonical authored-content checkpoint established only by a successful
|
||||
load or save. The checkpoint is keyed by stable actor identity, canonical component order, stable
|
||||
parent identity, and scene composition rather than transient Bevy entity numbers.
|
||||
- Push marks the active document dirty. Undo and redo serialize the authoritative authored
|
||||
projection and compare it with that tab's checkpoint, so saving at nonzero history depth,
|
||||
returning to that point, branching, tab switches, and direct non-history mutations remain exact.
|
||||
|
||||
## Implementation
|
||||
|
||||
1. Add per-tab canonical clean checkpoints to scene I/O and reconcile `SceneIo::dirty` after push,
|
||||
undo, redo, save, load, and document switches without persisting Entity-ID-based history stacks.
|
||||
2. Add focused history tests for undo-to-clean, redo-away-from-clean, save at nonzero depth,
|
||||
branching before/after the clean point, and tab isolation.
|
||||
3. Add a guarded-shutdown plugin/resource that intercepts `WindowCloseRequested`, accepts menu and
|
||||
programmatic requests, coordinates non-blocking confirmation/save completion, and emits the only
|
||||
final `AppExit` for the full editor.
|
||||
4. Make Save All report complete, pending, cancelled, or failed explicitly. Resume pending shutdown
|
||||
after untitled Save As completion and preserve the originating tab plus dirty state on failure.
|
||||
5. Add File > Quit and route Switch Project's exit half through the same guard without spawning a
|
||||
replacement process until the dirty-document decision succeeds.
|
||||
6. Update ADR 0023, native-dialog/session-recovery documentation, editor architecture guidance,
|
||||
root README controls/checklist, and production-readiness evidence.
|
||||
7. Run formatting, strict Clippy, workspace tests, and focused headless state-machine tests. Keep
|
||||
packaged tests deferred by project-owner direction.
|
||||
8. Launch the exact editor commit under Hyprland. Exercise Cancel, Discard, Save All, clean close,
|
||||
File > Quit, and the compositor close button; verify the editor remains responsive during native
|
||||
dialogs, no state is lost on cancel/failure, and no process or warning remains after exit.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- Native close, File > Quit, and programmatic editor exit share one guarded implementation.
|
||||
- One or many dirty tabs cannot be lost without explicit Discard; failed or cancelled saves do not
|
||||
exit and preserve the session.
|
||||
- Undoing exactly to the saved state clears the dirty marker; redo or a divergent edit restores it.
|
||||
- Saving at nonzero history depth establishes a new clean point without deleting useful history.
|
||||
- Headless state-machine tests and exact-commit native Linux QA pass with clean logs.
|
||||
@@ -0,0 +1,33 @@
|
||||
# Operator Invariants Completion
|
||||
|
||||
Working plan for Gitea
|
||||
[`#33`](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/33).
|
||||
|
||||
## Status
|
||||
|
||||
Implementation complete. Source and headless gates pass on the publication branch; the final exact
|
||||
commit is recorded in the issue closure comment. Packaged-runtime testing remains deferred by the
|
||||
project owner.
|
||||
|
||||
## Scope
|
||||
|
||||
1. Make registered commands distinguish immediate completion from modal Preview ownership.
|
||||
2. Require stable operator IDs and terminal phases for commit, cancel, block, failure, no-op, and
|
||||
automatic interruption paths.
|
||||
3. Make Group Selection and lighting changes atomic history transactions with repeatable undo/redo.
|
||||
4. Exercise production dispatch/finalizers for assets, material drops, brushes, terrain, physics
|
||||
placement, and transform gizmos through reusable semantic projections.
|
||||
5. Publish the invariant contract, acceptance evidence, and production-gate status without claiming
|
||||
release-candidate acceptance.
|
||||
|
||||
## Verification
|
||||
|
||||
- `cargo test -p editor --lib --no-fail-fast`
|
||||
- `cargo clippy -p editor --lib --tests -- -D warnings`
|
||||
- `cargo fmt --all -- --check`
|
||||
- `cargo test --workspace --all-targets --no-fail-fast`
|
||||
- `cargo clippy --workspace --all-targets -- -D warnings`
|
||||
- `cargo validate-levels --project .`
|
||||
|
||||
Live editor checks cover command-palette modal ownership and the grouped selection/lighting history
|
||||
surface. Packaged tests are deliberately excluded until re-enabled by the project owner.
|
||||
@@ -0,0 +1,36 @@
|
||||
# Physics Placement Tool - 2026-07-12
|
||||
|
||||
Issue: Gitea #25 (`BS-JD-304`)
|
||||
|
||||
## Outcome
|
||||
|
||||
Selected authored props can be released into deterministic Avian gravity, preview their
|
||||
settled transforms in the Scene viewport, and either commit the result as one undoable
|
||||
transform operation or cancel back to the exact pre-placement state.
|
||||
|
||||
## Contract
|
||||
|
||||
- Physics is paused during normal Edit mode and while Play mode is paused.
|
||||
- Placement runs only in Edit mode and owns a transactional physics session.
|
||||
- Selected mutable level objects must have active rigid-body and non-trigger collider
|
||||
authoring. Invalid selections produce a precise, non-destructive diagnostic.
|
||||
- Selected bodies are temporarily dynamic with clean motion state.
|
||||
- Other movable bodies are temporarily static so they remain collision surfaces without
|
||||
advancing unrelated authored state.
|
||||
- Commit restores all temporary runtime overrides and records only changed local transforms
|
||||
as one grouped history command.
|
||||
- Cancel restores transforms and runtime physics state exactly and creates no history entry.
|
||||
- Escape cancels. Enter commits once the session has reached rest. A bounded timeout keeps
|
||||
unstable scenes controllable.
|
||||
|
||||
## Work
|
||||
|
||||
- [x] Establish Edit/Play ownership of `Time<Physics>` and preserve paused single-step PIE.
|
||||
- [x] Implement placement validation, runtime snapshots, deterministic stepping, settling,
|
||||
timeout, commit, and cancel.
|
||||
- [x] Add the placement action and session controls to the existing horizontal viewport
|
||||
toolbar plus a compact status HUD.
|
||||
- [x] Add unit/integration coverage for prerequisites, settling, cancel, commit, and history.
|
||||
- [x] Update editor workflow documentation and implementation checklist.
|
||||
- [x] Run source gates and live Wayland acceptance; packaged tests remain skipped by request.
|
||||
- [x] Commit, push, attach native Gitea evidence, and close #25.
|
||||
@@ -15,12 +15,12 @@ owner requests it again.
|
||||
|
||||
1. Keep one evidence matrix under `docs/editor/evaluations/production-readiness/`; historical H1-H6
|
||||
notes remain context only.
|
||||
2. Close implementation blockers before nominating a candidate: the deformed Solari geometry
|
||||
boundary in `#51`, terrain `#22`-`#24`, physics placement/diagnostics `#25`-`#26`, and their
|
||||
regression fixtures. Collaborative safety `#49`, Material Library/targeted drops `#16`/`#18`,
|
||||
and native-dialog responsiveness `#52` are accepted and integrated.
|
||||
3. Complete the representative regression project, mutation-invariant coverage, performance budgets,
|
||||
and first-hour workflow tracked by `#32`-`#36`.
|
||||
2. Close implementation blockers before nominating a candidate. Renderer foundation `#51`, terrain
|
||||
`#22`-`#24`, physics placement/diagnostics `#25`-`#26`, operator invariants `#33`, collaborative
|
||||
safety `#49`, Material Library/targeted drops `#16`/`#18`, and native-dialog responsiveness `#52`
|
||||
are accepted and integrated.
|
||||
3. Complete the representative regression project, performance budgets, and first-hour workflow
|
||||
tracked by `#32`, `#34`, `#35`, and `#36`.
|
||||
4. Nominate one exact commit, validate it from a clean checkout, and record source/headless results.
|
||||
5. When packaged testing is re-enabled, run the candidate's package/build and packaged-runtime
|
||||
matrix without substituting older artifacts.
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# Renderer Foundation Acceptance Split - 2026-07-12
|
||||
|
||||
Issue: Gitea #51 (`BS-JD-207`)
|
||||
|
||||
## Outcome
|
||||
|
||||
Accept the shipped renderer/material/Surface foundation without claiming two independent future
|
||||
systems. Preserve the existing safe raster/Forward behavior and track each remaining boundary with
|
||||
its own implementation and acceptance contract.
|
||||
|
||||
## Decisions
|
||||
|
||||
- #51 owns stable static/skinned slots, shared Material/Instance assets, Surface ABI parity for
|
||||
eligible geometry, transactional migration, and the honest exclusion of deformed Solari meshes.
|
||||
- #53 owns actual runtime Material Property Block application and promote-to-instance UX. The
|
||||
existing component schema/persistence exclusion is not represented as runtime completion.
|
||||
- #54 owns dynamic post-morph/post-skin buffers and instance BLAS updates. It is a documented P2
|
||||
Solari enhancement, not a raster/Forward production blocker.
|
||||
|
||||
## Work
|
||||
|
||||
- [x] Audit #51 scope and repository evidence against current runtime behavior.
|
||||
- [x] Create focused Gitea follow-ups with independent acceptance criteria.
|
||||
- [x] Correct ADR, material guide, README checklist, evaluation, and production matrix claims.
|
||||
- [x] Run documentation/diff gates, commit, push, and close #51 with exact follow-up links.
|
||||
@@ -0,0 +1,28 @@
|
||||
# Terrain Material Layers And Weight Painting (#24)
|
||||
|
||||
## Scope
|
||||
|
||||
- Persist up to four shared Material/Material Instance references on each `TerrainDesc`.
|
||||
- Store normalized RGBA8 layer weights per height sample with an implicit channel-zero default.
|
||||
- Blend layer albedo, normal, metallic, and roughness in the project-owned raster material path.
|
||||
- Assign, clear, reorder, and tile layers from the Terrain inspector.
|
||||
- Paint or erase one selected layer from the existing horizontal viewport toolbar.
|
||||
- Preserve one reflected history transaction per completed pointer stroke and exact cancel restore.
|
||||
|
||||
## Implementation
|
||||
|
||||
1. Extend the backward-compatible terrain schema with four layer descriptors and compact weights.
|
||||
2. Emit normalized weights as terrain chunk vertex colors and attach a runtime-only material binding.
|
||||
3. Build a terrain-specific `ExtendedMaterial` in `blacksite_surface`; keep invalid references on the visible fallback path with diagnostics.
|
||||
4. Add inspector layer controls and a mutually exclusive modal paint operator beside Sculpt.
|
||||
5. Cover serialization, validation, blend transport, paint normalization, cancel, undo, and redo.
|
||||
6. Update ADR 0040, terrain workflow docs, the implementation checklist, and live evidence.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- Two or more project materials visibly blend on one terrain.
|
||||
- Layer weights remain exactly normalized and survive scene save/load.
|
||||
- Live paint preview follows the sampled terrain surface.
|
||||
- Escape/right-click restores exact pre-stroke weights; release creates one undo entry.
|
||||
- Missing or invalid material references remain visible as fallback and produce clear diagnostics.
|
||||
- Formatting, workspace check/clippy/tests, level validation, and live native-Wayland QA pass.
|
||||
@@ -0,0 +1,25 @@
|
||||
# Terrain Sculpt Tools (#23)
|
||||
|
||||
## Scope
|
||||
|
||||
- Add a modal terrain sculpt operator for raise, lower, flatten, smooth, and deterministic noise.
|
||||
- Keep activation and brush settings in the existing horizontal viewport toolbar.
|
||||
- Track a terrain-local cursor hit and render a world-space brush footprint preview.
|
||||
- Apply live stroke previews while preserving one history entry per completed stroke.
|
||||
- Restore the exact pre-stroke height grid on Escape or right-click.
|
||||
|
||||
## Implementation
|
||||
|
||||
1. Add pure heightfield sampling, ray-hit, falloff, and brush-dab functions with focused tests.
|
||||
2. Add editor-only terrain sculpt state and viewport input/preview systems.
|
||||
3. Commit strokes through the reflected component transaction after restoring the pre-stroke snapshot.
|
||||
4. Add compact terrain controls to the existing viewport toolbar and update operator hints.
|
||||
5. Document controls and validation evidence in the terrain editor guide and root checklist.
|
||||
|
||||
## Acceptance
|
||||
|
||||
- All five modes visibly modify terrain.
|
||||
- The brush ring follows the actual terrain surface.
|
||||
- Escape and right-click cancel without dirtying history.
|
||||
- Mouse release creates exactly one undoable transaction regardless of dab count.
|
||||
- Formatting, editor/shared checks, focused tests, and live editor QA pass.
|
||||
@@ -17,6 +17,11 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
lfs: true
|
||||
|
||||
- name: Verify Git LFS checkout
|
||||
run: git lfs fsck
|
||||
|
||||
- name: Install Linux dependencies
|
||||
run: |
|
||||
@@ -55,6 +60,9 @@ jobs:
|
||||
- name: Validate level scenes
|
||||
run: cargo validate-levels
|
||||
|
||||
- name: Validate editor sample pack
|
||||
run: cargo validate-samples
|
||||
|
||||
- name: Clippy launch feature matrix
|
||||
run: cargo clippy -p editor -p game --bins --features dev,hot-reload -- -D warnings
|
||||
|
||||
|
||||
@@ -27,6 +27,7 @@ cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo clippy -p editor -p game --bins --features dev,hot-reload -- -D warnings
|
||||
cargo test --workspace
|
||||
cargo validate-levels
|
||||
cargo validate-samples
|
||||
cargo bake-navigation --project . --check
|
||||
# Validate one artifact without opening a game window
|
||||
cargo run -p game -- --validate-navigation assets/navigation/generated/navigation_showcase_humanoid.nav.ron
|
||||
@@ -56,8 +57,9 @@ cargo run -p editor --bin project_launcher --features dev
|
||||
```
|
||||
|
||||
The installed **Blacksite Editor** desktop entry also exposes **Open Project Browser** from its
|
||||
desktop action menu. In the editor, **File > Switch Project...** performs a clean shutdown and
|
||||
opens the same browser; choosing a project starts a fresh editor process with that root.
|
||||
desktop action menu. In the editor, **File > Switch Project...** uses the guarded Save All / Discard /
|
||||
Cancel shutdown path before opening the same browser; choosing a project starts a fresh editor
|
||||
process with that root.
|
||||
|
||||
### Hot reload (gameplay iteration)
|
||||
|
||||
@@ -135,7 +137,7 @@ deep-stale variants.
|
||||
| Click empty viewport / `Esc` | Deselect |
|
||||
| `Delete` / `Backspace` | Delete selection |
|
||||
| `Ctrl+D` | Duplicate selection |
|
||||
| `Ctrl+Z` / `Ctrl+Shift+Z` / `Ctrl+Y` | Undo / redo |
|
||||
| `Ctrl+Z` / `Ctrl+Shift+Z` / `Ctrl+Y` | Undo / redo; returning exactly to the last loaded or saved authored state clears that scene tab's dirty marker |
|
||||
| `F2` in Hierarchy | Rename selection |
|
||||
| `W` / `E` / `R` | Translate / rotate / scale gizmo; multi-selection uses one grouped gizmo and undo step |
|
||||
| `X` | Toggle world/local gizmo orientation |
|
||||
@@ -144,6 +146,7 @@ deep-stale variants.
|
||||
| Brush selected: `1` / `2` / `3` / `4` | Vertex / edge / face / clip edit modes |
|
||||
| Brush edit mode: LMB / `Shift+LMB` / `W` / `E` / `R` / `Esc` | Select element / toggle element selection / move / rotate / scale selected brush elements / return to object mode |
|
||||
| Viewport toolbar (sun / brush / box icons) | Shading: Lit, Unlit (albedo), Colliders (mesh off) |
|
||||
| Collider viewport mode | Inspect world-scale box/sphere/capsule overlays and cooked mesh bounds; green/cyan/gray/amber/red identify ready/trigger/disabled/warning/invalid state, with selected health in the lower-left HUD |
|
||||
| Viewport eye/options | Toggle actor root icon categories, adjust icon/gizmo size, and control colliders, lights, spawns, gameplay markers, volumes, prefab/model anchors, and runtime player/camera visualizers |
|
||||
| `Tab` in viewport | Cycle selection through overlapping objects at last click |
|
||||
| Viewport selection/orientation HUD | Identify the primary selection, multi-selection count, overlapping-pick position, camera axes, shading mode, and active render path |
|
||||
@@ -163,7 +166,8 @@ deep-stale variants.
|
||||
| Drag actor between rows / onto Scene Root (Hierarchy, Manual sort) | Reorder siblings / unparent to the root |
|
||||
| Hierarchy lock | Excludes the actor from selection, gizmos, multi-drag, structural drops, and mutating context actions |
|
||||
| Hierarchy context | Group selection, create authored local children below linked prefab roots, remove/reparent generated members through same-layer structural overrides, or unparent |
|
||||
| File menu | New, non-blocking native Open/Save As, recovery restore/keep-copy/discard when available, Import Assets, Export Selection, Save Selection As Prefab (including linked-root variants), Recent Scenes |
|
||||
| File menu | New, non-blocking native Open/Save As, **Open Sample** for the five-area regression pack, recovery restore/keep-copy/discard when available, Import Assets, Export Selection, Save Selection As Prefab (including linked-root variants), Recent Scenes, Switch Project, and Quit |
|
||||
| Window close / **File > Quit** | Clean sessions exit immediately; dirty scene tabs use one non-blocking **Save All / Discard / Cancel** decision, and cancel or failed saves keep the editor open |
|
||||
| Status strip / Asset Details source-state chip | Inspect compact clean, modified, untracked, conflicted, read-only, and optional ownership status; hover for the source path and provider details |
|
||||
| Authored File Not Saved dialog | Resolve an external edit, read-only target, or ownership lock with Reload, Compare Metadata, Save As, or Cancel; the editor never offers force overwrite |
|
||||
| Main toolbar, right side | Switch or close independent scene tabs, create an untitled tab, and manage loaded/locked composed subscenes |
|
||||
@@ -171,6 +175,9 @@ deep-stale variants.
|
||||
| Inspector component card | Collapse with caret, toggle active with status dot, or use triple-dot menu for reset/copy/paste/move/remove actions |
|
||||
| Inspector footer → Add Component | Expands an inline search shelf for registered authoring, rendering, physics, gameplay, and volume components with descriptions, availability hints, and undo |
|
||||
| Inspector footer → Add Component → Terrain | Add a height-grid terrain actor; configure grid scale/chunking/collision in its component card and use Resize Flat only for deliberate grid replacement |
|
||||
| Selected Terrain → viewport mountains tool | Sculpt Raise/Lower/Flatten/Smooth/Noise strokes with a terrain-following footprint; release commits one undo step, while Escape/right-click restores the pre-stroke grid |
|
||||
| Terrain card → Material Layers; selected Terrain → viewport paint tool | Assign up to four shared materials, then Paint/Erase normalized layer weights with live blended preview; release commits one undo step and Escape/right-click restores the pre-stroke map |
|
||||
| Selected physics props → viewport hand/down-arrow tool | Release the selection into real gravity/colliders; check commits one grouped transform edit, while Escape/X restores the exact starting state |
|
||||
| Audio Source / Listener inspector | Assign and audition clips; edit gain, pitch, loop/autoplay, spatial blend, attenuation, bus, listener priority, and ear gap |
|
||||
| Edit → Project Settings… | Edit `assets/project.ron` rendering, audio buses, physics, and input |
|
||||
|
||||
@@ -400,7 +407,13 @@ crates/
|
||||
- [x] Delete, duplicate, rename, and structural/material undo-redo
|
||||
- [x] Native Bevy scene New/Open/Save/Save As with dirty title tracking
|
||||
- [x] First-class height-grid Terrain actor with deterministic generated render/collider chunks, reflected history, validation, and a committed showcase fixture ([ADR 0039](docs/adr/0039-inline-height-grid-terrain-foundation.md), [terrain guide](docs/editor/terrain.md), [Gitea #22](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/22))
|
||||
- [x] Modal terrain Raise/Lower/Flatten/Smooth/Noise sculpting with a terrain-following footprint, deterministic noise, safe cancel restore, and one undo transaction per stroke ([terrain guide](docs/editor/terrain.md), [Gitea #23](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/23))
|
||||
- [x] Four shared terrain Material/Material Instance layers with compact normalized sample weights, blended raster hydration, drag/browse assignment, Paint/Erase preview, exact cancel, and one undo transaction per stroke ([ADR 0040](docs/adr/0040-terrain-material-layer-weights.md), [terrain guide](docs/editor/terrain.md), [Gitea #24](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/24))
|
||||
- [x] Transactional physics placement with real Avian gravity/colliders, paused Edit-mode physics, prerequisite diagnostics, isolated non-selected bodies, exact cancel, and grouped transform undo ([ADR 0041](docs/adr/0041-transactional-editor-physics-placement.md), [workflow guide](docs/editor/physics-placement.md), [Gitea #25](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/25))
|
||||
- [x] Collider authoring health shared by the inspector, Collider viewport, Diagnostics panel, and physics placement, with scaled shape overlays, cooked mesh bounds, missing/stale/invalid/oversized findings, and undoable dimension-preserving shape switching ([collider guide](docs/editor/collider-authoring.md), [Gitea #26](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/26))
|
||||
- [x] Non-blocking native file/folder/confirmation broker across scene, asset, prefab, composition, collaboration, and Project Browser workflows ([ADR 0038](docs/adr/0038-non-blocking-native-dialog-broker.md), [workflow guide](docs/editor/native-dialogs.md), [Gitea #52](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/52))
|
||||
- [x] Guarded native/menu/programmatic editor shutdown with asynchronous multi-tab Save All / Discard / Cancel and canonical per-tab clean checkpoints for exact undo/redo dirtiness ([ADR 0042](docs/adr/0042-guarded-editor-shutdown-and-document-savepoints.md), [Gitea #55](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/55))
|
||||
- [x] Scoped egui action safety for toolbar/navigation spawns, Inspector state, cross-panel selection/tab requests, diagnostics selection, and full-slice selection precedence ([evaluation](docs/editor/evaluations/scoped-ui-actions/), [Gitea #57](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/57))
|
||||
- [x] Asset import, static mesh/prefab placement, texture assignment, and selection export
|
||||
- [x] PIE player-only snapshot/restore (authored `LevelObject` edits persist on stop)
|
||||
- [x] Unified viewport render-to-texture target + Play session bootstrap
|
||||
@@ -409,9 +422,10 @@ crates/
|
||||
- [x] Cursor/VSCode workspace tasks + launch configs
|
||||
- [x] Opaque Wayland window launch defaults + SDR/HDR runtime toggle
|
||||
- [x] CI workflow for format, check, clippy, tests, and binary builds
|
||||
- [x] Deterministic five-area editor sample regression pack with stable actor IDs, **File > Open Sample**, typed scene checks, headless validation, and committed brush/material/terrain/physics/rendering fixtures ([sample guide](docs/editor/sample-regression-pack.md), [Gitea #32](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/32))
|
||||
- [x] ADRs for roadmap architecture and Bevy migration policy
|
||||
- [x] Determinism harness: same inputs over same ticks produce the same state summary/hash
|
||||
- [x] Reusable editor operator harness for commit/cancel/block, helper cleanup, dirty state, grouped undo, and undo/redo round trips
|
||||
- [x] Production operator invariants across palette dispatch, assets/material drops, brush/terrain/physics modal tools, grouping/lighting, and the transform finalizer: stable terminal status, exact cancel/failure rollback, helper cleanup, grouped history, and repeated undo/redo projections ([testing contract](docs/editor/operator-regression-testing.md), [evaluation](docs/editor/evaluations/operator-invariants/), [Gitea #33](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/33))
|
||||
- [x] Verify: `cargo fmt --check` / `cargo check --workspace` / `cargo clippy --workspace` / strict foundation clippy / `cargo test -p sim`
|
||||
- [x] Stable asset registry with UUIDs + import settings in asset browser details
|
||||
- [x] Asset Browser expandable model subasset shelves, independent mesh/material/texture thumbnails, staged import/material details with shader-schema parameters, context actions, and trash-first file removal
|
||||
@@ -439,7 +453,7 @@ crates/
|
||||
- [x] Editor lib/bin split + `EditorPluginGroup`; game EditorPlugin dogfood panel
|
||||
- [x] FBX/glTF model import + normalized static/skinned renderer routing; explicit generic scene-instance load via `bevy_ufbx` / `ModelRef`
|
||||
- [x] Asset browser model thumbnails (unified `assets/thumbnails/` pipeline; `ThumbnailState` cache; FBX via `FbxThumbnailSource`)
|
||||
- [x] Shared Material/Material Instance assets, stable static/skinned renderer material slots, imported-source fallback, orphan preservation, and runtime-only property blocks ([ADR 0035](docs/adr/0035-shared-material-assets-and-renderer-slots.md), [material-system guide](docs/editor/material-system.md))
|
||||
- [x] Shared Material/Material Instance assets, stable static/skinned renderer material slots, imported-source fallback, orphan preservation, and a persistence-excluded property-block schema; runtime block application/promotion remains tracked in [Gitea #53](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/53) ([ADR 0035](docs/adr/0035-shared-material-assets-and-renderer-slots.md), [material-system guide](docs/editor/material-system.md))
|
||||
- [x] Docked Material Library with cross-folder type/usage filters, resolved Material Instance thumbnails, shared guarded editors, and exact reversible viewport Material/Texture drops for renderer slots, primitives, and brush faces ([material-system guide](docs/editor/material-system.md); [Gitea #16](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/16), [Gitea #18](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/18))
|
||||
- [x] Prefab v2 core: shared stable nested override paths, property/component/structural scopes, recursive graph validation, linked-root variants, conflict recovery, transactional source Apply, and undoable unpack/convert ([ADR 0027](docs/adr/0027-stable-prefab-ownership-and-variants.md))
|
||||
- [x] Prefab v2 production acceptance: committed base/nested/variant fixtures pass workspace tests, recursive headless validation, packaged release startup, and live editor placement/inspection regression coverage ([Gitea #43](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/43))
|
||||
@@ -483,7 +497,7 @@ crates/
|
||||
**Unpack Layer** preserves nested links; **Convert to Local** recursively removes them. Current
|
||||
authoring UI coverage and production-acceptance gaps are tracked in
|
||||
[prefab-authoring.md](docs/editor/prefab-authoring.md).
|
||||
- Material and direct-base Material Instance assets live under `assets/materials/`; shader schemas live under `assets/shaders/`. **Window > Material Library** provides cross-folder creation, editing, usage filters, and drag sources. Viewport Material drops target one exact renderer slot, primitive, or brush face and use reversible preview plus one-step history; loose Textures target primitives/brush faces and are rejected on renderer slots. Shared edits propagate through live-updated handles without reloading skinned geometry. Custom Surface evaluators share one constrained ABI between raster and Solari-eligible non-deformed geometry. Dynamic skinned/morph Solari geometry and a persisted property-block authoring workflow remain future work; see the [material-system guide](docs/editor/material-system.md).
|
||||
- Material and direct-base Material Instance assets live under `assets/materials/`; shader schemas live under `assets/shaders/`. **Window > Material Library** provides cross-folder creation, editing, usage filters, and drag sources. Viewport Material drops target one exact renderer slot, primitive, or brush face and use reversible preview plus one-step history; loose Textures target primitives/brush faces and are rejected on renderer slots. Shared edits propagate through live-updated handles without reloading skinned geometry. Custom Surface evaluators share one constrained ABI between raster and Solari-eligible non-deformed geometry. Runtime property-block application/promotion is tracked in [#53](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/53); dynamic skinned/morph Solari geometry is tracked in [#54](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/54). See the [material-system guide](docs/editor/material-system.md).
|
||||
- Per-field reflect undo for all components remains future work; typed `shared` inspectors cover the common authoring path.
|
||||
- The authoring/hydration layer is intentionally small so richer asset workflows (terrain,
|
||||
material graphs, lighting profiles) can be added without changing the scene format foundation.
|
||||
|
||||
@@ -197,6 +197,24 @@
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("78c6850b-5a76-4a4f-b48e-7fb00f6dd1ed"),
|
||||
path: "assets/levels/physics_placement_showcase.scn.ron",
|
||||
label: "physics_placement_showcase.scn",
|
||||
kind_tag: "Level",
|
||||
import_settings: (
|
||||
scale: 1.0,
|
||||
generate_collider: true,
|
||||
lod0_only: true,
|
||||
placement_mode: StaticAsset,
|
||||
hierarchy_mode: SingleActor,
|
||||
material_policy: SourceMaterials,
|
||||
static_mesh_manifest_path: None,
|
||||
animation_manifest_path: None,
|
||||
default_animation_clip_id: None,
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("706e604e-1a63-4e97-b35d-eeb1d88fe3a9"),
|
||||
path: "assets/levels/navigation_authoring_showcase.scn.ron",
|
||||
@@ -233,6 +251,24 @@
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("a7ef65b4-24d6-4c3a-b637-5bb52d8e9a26"),
|
||||
path: "assets/levels/collider_diagnostics_showcase.scn.ron",
|
||||
label: "collider_diagnostics_showcase.scn",
|
||||
kind_tag: "Level",
|
||||
import_settings: (
|
||||
scale: 1.0,
|
||||
generate_collider: true,
|
||||
lod0_only: true,
|
||||
placement_mode: StaticAsset,
|
||||
hierarchy_mode: SingleActor,
|
||||
material_policy: SourceMaterials,
|
||||
static_mesh_manifest_path: None,
|
||||
animation_manifest_path: None,
|
||||
default_animation_clip_id: None,
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("f3dfcd11-aa5b-4fd4-872b-06832b865c99"),
|
||||
path: "assets/levels/audio_authoring_showcase.scn.ron",
|
||||
@@ -251,6 +287,42 @@
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("607864bf-fa77-4f9e-acc9-2c0906d34163"),
|
||||
path: "assets/levels/samples/material_lab.scn.ron",
|
||||
label: "material_lab.scn",
|
||||
kind_tag: "Level",
|
||||
import_settings: (
|
||||
scale: 1.0,
|
||||
generate_collider: true,
|
||||
lod0_only: true,
|
||||
placement_mode: StaticAsset,
|
||||
hierarchy_mode: SingleActor,
|
||||
material_policy: SourceMaterials,
|
||||
static_mesh_manifest_path: None,
|
||||
animation_manifest_path: None,
|
||||
default_animation_clip_id: None,
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("bca13177-afa9-4691-9b40-288059c7a57e"),
|
||||
path: "assets/levels/samples/brush_blockout.scn.ron",
|
||||
label: "brush_blockout.scn",
|
||||
kind_tag: "Level",
|
||||
import_settings: (
|
||||
scale: 1.0,
|
||||
generate_collider: true,
|
||||
lod0_only: true,
|
||||
placement_mode: StaticAsset,
|
||||
hierarchy_mode: SingleActor,
|
||||
material_policy: SourceMaterials,
|
||||
static_mesh_manifest_path: None,
|
||||
animation_manifest_path: None,
|
||||
default_animation_clip_id: None,
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("5a2307d0-48e5-40d3-a5c9-527c0cfd30f4"),
|
||||
path: "assets/levels/editor_scene.scn.ron",
|
||||
@@ -359,6 +431,24 @@
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("e42185de-cda2-4a9e-9df0-df67ccd86123"),
|
||||
path: "assets/samples/editor_samples.ron",
|
||||
label: "editor_samples",
|
||||
kind_tag: "Level",
|
||||
import_settings: (
|
||||
scale: 1.0,
|
||||
generate_collider: true,
|
||||
lod0_only: true,
|
||||
placement_mode: StaticAsset,
|
||||
hierarchy_mode: SingleActor,
|
||||
material_policy: SourceMaterials,
|
||||
static_mesh_manifest_path: None,
|
||||
animation_manifest_path: None,
|
||||
default_animation_clip_id: None,
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
(
|
||||
id: ("04a4e00e-4732-43db-8e99-9cd99b94667b"),
|
||||
path: "assets/animations/generated/113f74df-e39c-41d4-9b5b-e48efe541f7f.animation.ron",
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
(schema_version: 4, resources: {}, entities: {
|
||||
1: (components: {
|
||||
"bevy_ecs::name::Name": "Valid Box Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-4.5, 1.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-box"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (0),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.18, g: 0.62, b: 0.36, a: 1.0),
|
||||
metallic: 0.05, roughness: 0.55,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (1.8, 2.0, 1.8)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true, is_trigger: false,
|
||||
shape: Cuboid(x_length: 1.8, y_length: 2.0, z_length: 1.8),
|
||||
),
|
||||
}),
|
||||
2: (components: {
|
||||
"bevy_ecs::name::Name": "Valid Sphere Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-2.25, 1.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.35, 0.8),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-sphere"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (1),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.16, g: 0.52, b: 0.78, a: 1.0),
|
||||
metallic: 0.08, roughness: 0.42,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Sphere, size: (2.0, 2.0, 2.0)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true, is_trigger: false, shape: Sphere(radius: 1.0),
|
||||
),
|
||||
}),
|
||||
3: (components: {
|
||||
"bevy_ecs::name::Name": "Valid Capsule Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 1.4, 0.0),
|
||||
rotation: (0.0, 0.1950903, 0.0, 0.9807853),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-capsule"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (2),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.58, g: 0.34, b: 0.78, a: 1.0),
|
||||
metallic: 0.06, roughness: 0.48,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (1.4, 2.8, 1.4)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true, is_trigger: false, shape: Capsule(radius: 0.7, height: 2.8),
|
||||
),
|
||||
}),
|
||||
4: (components: {
|
||||
"bevy_ecs::name::Name": "Trigger Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (2.25, 1.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-trigger"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (3),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.12, g: 0.68, b: 0.82, a: 1.0),
|
||||
metallic: 0.03, roughness: 0.4,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Sphere, size: (2.0, 2.0, 2.0)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true, is_trigger: true, shape: Sphere(radius: 1.0),
|
||||
),
|
||||
}),
|
||||
5: (components: {
|
||||
"bevy_ecs::name::Name": "Disabled Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (4.5, 1.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-disabled"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (4),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.38, g: 0.40, b: 0.46, a: 1.0),
|
||||
metallic: 0.02, roughness: 0.68,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (1.8, 2.0, 1.8)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: false, is_trigger: false,
|
||||
shape: Cuboid(x_length: 1.8, y_length: 2.0, z_length: 1.8),
|
||||
),
|
||||
}),
|
||||
6: (components: {
|
||||
"bevy_ecs::name::Name": "Missing Collider",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 1.0, -3.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-missing"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (5),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.78, g: 0.16, b: 0.20, a: 1.0),
|
||||
metallic: 0.02, roughness: 0.58,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0), emissive_intensity: 0.0,
|
||||
base_color_texture: None, emissive_texture: None, normal_map_texture: None,
|
||||
metallic_roughness_texture: None, material_asset_path: None, parameters: [], textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (1.8, 2.0, 1.8)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
}),
|
||||
7: (components: {
|
||||
"bevy_ecs::name::Name": "Collider Showcase Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 8.0, 4.0),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("collider-showcase-sun"),
|
||||
"shared::components::ActorKind": Light,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (6),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::LightDesc": (
|
||||
kind: Directional, color: (r: 1.0, g: 0.95, b: 0.88, a: 1.0),
|
||||
intensity: 100000.0, range: 0.0, shadows: true,
|
||||
inner_angle_deg: 25.0, outer_angle_deg: 35.0,
|
||||
),
|
||||
}),
|
||||
})
|
||||
@@ -0,0 +1,164 @@
|
||||
(schema_version: 4, resources: {}, entities: {
|
||||
1: (components: {
|
||||
"bevy_ecs::name::Name": "Placement Floor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, -0.25, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("physics-placement-floor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (0),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.12, g: 0.14, b: 0.16, a: 1.0),
|
||||
metallic: 0.05,
|
||||
roughness: 0.72,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (14.0, 0.5, 10.0)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true,
|
||||
is_trigger: false,
|
||||
shape: Cuboid(x_length: 14.0, y_length: 0.5, z_length: 10.0),
|
||||
),
|
||||
}),
|
||||
2: (components: {
|
||||
"bevy_ecs::name::Name": "Placement Cuboid",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-2.0, 3.0, 0.0),
|
||||
rotation: (0.1305262, 0.0, 0.0, 0.9914449),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("physics-placement-prop-a"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (1),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.88, g: 0.48, b: 0.12, a: 1.0),
|
||||
metallic: 0.1,
|
||||
roughness: 0.42,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (1.2, 1.2, 1.2)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true,
|
||||
is_trigger: false,
|
||||
shape: Cuboid(x_length: 1.2, y_length: 1.2, z_length: 1.2),
|
||||
),
|
||||
}),
|
||||
3: (components: {
|
||||
"bevy_ecs::name::Name": "Placement Sphere",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 5.0, 0.0),
|
||||
rotation: (0.0, 0.2164396, 0.0, 0.976296),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("physics-placement-prop-b"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (2),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.10, g: 0.58, b: 0.72, a: 1.0),
|
||||
metallic: 0.15,
|
||||
roughness: 0.35,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Sphere, size: (1.6, 1.6, 1.6)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true,
|
||||
is_trigger: false,
|
||||
shape: Sphere(radius: 0.8),
|
||||
),
|
||||
}),
|
||||
4: (components: {
|
||||
"bevy_ecs::name::Name": "Placement Capsule",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (2.0, 7.0, 0.0),
|
||||
rotation: (0.092296, 0.092296, -0.008077, 0.991405),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("physics-placement-prop-c"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (3),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.62, g: 0.24, b: 0.56, a: 1.0),
|
||||
metallic: 0.08,
|
||||
roughness: 0.5,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::Primitive": (shape: Box, size: (0.9, 1.8, 0.9)),
|
||||
"shared::components::RigidBodyDesc": (body: Static),
|
||||
"shared::components::ColliderDesc": (
|
||||
enabled: true,
|
||||
is_trigger: false,
|
||||
shape: Capsule(radius: 0.45, height: 1.8),
|
||||
),
|
||||
}),
|
||||
5: (components: {
|
||||
"bevy_ecs::name::Name": "Placement Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 8.0, 2.0),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("physics-placement-sun"),
|
||||
"shared::components::ActorKind": Light,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (4),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::LightDesc": (
|
||||
kind: Directional,
|
||||
color: (r: 1.0, g: 0.95, b: 0.85, a: 1.0),
|
||||
intensity: 100000.0,
|
||||
range: 0.0,
|
||||
shadows: true,
|
||||
inner_angle_deg: 25.0,
|
||||
outer_angle_deg: 35.0,
|
||||
),
|
||||
}),
|
||||
})
|
||||
@@ -1,68 +1,241 @@
|
||||
(schema_version: 4,resources: {
|
||||
},
|
||||
entities: {
|
||||
4294968001: (components: {
|
||||
"bevy_ecs::name::Name": "Fog Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
(schema_version: 4, resources: {}, entities: {
|
||||
1: (components: {
|
||||
"bevy_ecs::name::Name": "Rendering Lab Floor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (1.0, -0.25, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (6.0, 3.0, 6.0),
|
||||
priority: 0,
|
||||
blend_distance: 2.0,
|
||||
overrides: (
|
||||
fog_density: Some(0.004),
|
||||
fog_color: Some((r: 0.5, g: 0.55, b: 0.65, a: 1.0)),
|
||||
),
|
||||
fullscreen_effect: None,
|
||||
profile: None,
|
||||
label: Some("Foggy courtyard"),
|
||||
"shared::components::ActorId": ("rendering-showcase-floor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (0),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (38.0, 0.5, 12.0)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.12, g: 0.14, b: 0.16, a: 1.0),
|
||||
metallic: 0.05,
|
||||
roughness: 0.72,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
4294968002: (components: {
|
||||
"bevy_ecs::name::Name": "Dark Exposure Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (14.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
}),
|
||||
2: (components: {
|
||||
"bevy_ecs::name::Name": "Vignette Anchor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-12.0, 1.2, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (4.0, 2.5, 4.0),
|
||||
priority: 5,
|
||||
blend_distance: 1.5,
|
||||
overrides: (
|
||||
exposure_ev100: Some(9.5),
|
||||
bloom: Some(false),
|
||||
),
|
||||
fullscreen_effect: None,
|
||||
profile: Some("assets/rendering_profiles/cave_dark.ron"),
|
||||
label: Some("Cave mouth"),
|
||||
"shared::components::ActorId": ("rendering-showcase-vignette-anchor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (1),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Sphere, size: (2.4, 2.4, 2.4)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.82, g: 0.18, b: 0.2, a: 1.0),
|
||||
metallic: 0.08,
|
||||
roughness: 0.38,
|
||||
emissive_color: (r: 1.0, g: 0.2, b: 0.2, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
4294968003: (components: {
|
||||
"bevy_ecs::name::Name": "Vignette FX Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-12.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
}),
|
||||
3: (components: {
|
||||
"bevy_ecs::name::Name": "Fog Anchor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 1.4, 0.0),
|
||||
rotation: (0.0, 0.258819, 0.0, 0.9659258),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (5.0, 2.0, 5.0),
|
||||
priority: 2,
|
||||
blend_distance: 2.0,
|
||||
overrides: (),
|
||||
fullscreen_effect: Some("assets/post_fx/vignette.ron"),
|
||||
profile: None,
|
||||
label: Some("Vignette demo"),
|
||||
"shared::components::ActorId": ("rendering-showcase-fog-anchor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (2),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (2.8, 2.8, 2.8)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.1, g: 0.58, b: 0.72, a: 1.0),
|
||||
metallic: 0.15,
|
||||
roughness: 0.35,
|
||||
emissive_color: (r: 0.1, g: 0.58, b: 0.72, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
},
|
||||
)
|
||||
}),
|
||||
4: (components: {
|
||||
"bevy_ecs::name::Name": "Exposure Anchor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (14.0, 1.3, 0.0),
|
||||
rotation: (0.0, -0.1736482, 0.0, 0.9848078),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-exposure-anchor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (3),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (3.0, 2.6, 3.0)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.92, g: 0.62, b: 0.12, a: 1.0),
|
||||
metallic: 0.12,
|
||||
roughness: 0.32,
|
||||
emissive_color: (r: 1.0, g: 0.65, b: 0.12, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
5: (components: {
|
||||
"bevy_ecs::name::Name": "Emissive Comparison Panel",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 2.6, -4.8),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-emissive-panel"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (4),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (26.0, 1.2, 0.25)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.15, g: 0.22, b: 0.28, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.35,
|
||||
emissive_color: (r: 0.55, g: 0.85, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 2500.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/emissive_panel.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
6: (components: {
|
||||
"bevy_ecs::name::Name": "Fog Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-fog-volume"),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (5),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (6.0, 3.0, 6.0),
|
||||
priority: 0,
|
||||
blend_distance: 2.0,
|
||||
overrides: (
|
||||
fog_density: Some(0.004),
|
||||
fog_color: Some((r: 0.5, g: 0.55, b: 0.65, a: 1.0)),
|
||||
),
|
||||
fullscreen_effect: None,
|
||||
profile: None,
|
||||
label: Some("Foggy courtyard"),
|
||||
),
|
||||
}),
|
||||
7: (components: {
|
||||
"bevy_ecs::name::Name": "Dark Exposure Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (14.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-exposure-volume"),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (6),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (4.0, 2.5, 4.0),
|
||||
priority: 5,
|
||||
blend_distance: 1.5,
|
||||
overrides: (
|
||||
exposure_ev100: Some(9.5),
|
||||
bloom: Some(false),
|
||||
),
|
||||
fullscreen_effect: None,
|
||||
profile: Some("assets/rendering_profiles/cave_dark.ron"),
|
||||
label: Some("Cave mouth"),
|
||||
),
|
||||
}),
|
||||
8: (components: {
|
||||
"bevy_ecs::name::Name": "Vignette FX Volume",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-12.0, 2.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-vignette-volume"),
|
||||
"shared::components::ActorKind": PostProcessVolume,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (7),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::PostProcessVolumeDesc": (
|
||||
half_extents: (5.0, 2.0, 5.0),
|
||||
priority: 2,
|
||||
blend_distance: 2.0,
|
||||
overrides: (),
|
||||
fullscreen_effect: Some("assets/post_fx/vignette.ron"),
|
||||
profile: None,
|
||||
label: Some("Vignette demo"),
|
||||
),
|
||||
}),
|
||||
9: (components: {
|
||||
"bevy_ecs::name::Name": "Rendering Lab Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 10.0, 5.0),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("rendering-showcase-sun"),
|
||||
"shared::components::ActorKind": Light,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (8),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::LightDesc": (
|
||||
kind: Directional,
|
||||
color: (r: 1.0, g: 0.95, b: 0.85, a: 1.0),
|
||||
intensity: 100000.0,
|
||||
range: 0.0,
|
||||
shadows: true,
|
||||
inner_angle_deg: 25.0,
|
||||
outer_angle_deg: 35.0,
|
||||
),
|
||||
}),
|
||||
})
|
||||
@@ -0,0 +1,332 @@
|
||||
(schema_version: 4, resources: {}, entities: {
|
||||
1: (components: {
|
||||
"bevy_ecs::name::Name": "Foundation Brush",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 0.5, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-brush-foundation"),
|
||||
"shared::components::ActorKind": Brush,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (0),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.55, g: 0.54, b: 0.52, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.85,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/concrete.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::BrushDesc": (
|
||||
kind: Additive,
|
||||
faces: [
|
||||
(
|
||||
id: ("face:+x"),
|
||||
plane: (normal: (1.0, 0.0, 0.0), distance: 5.0),
|
||||
vertices: [(5.0, -0.5, -4.0), (5.0, 0.5, -4.0), (5.0, 0.5, 4.0), (5.0, -0.5, 4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-x"),
|
||||
plane: (normal: (-1.0, 0.0, 0.0), distance: 5.0),
|
||||
vertices: [(-5.0, -0.5, 4.0), (-5.0, 0.5, 4.0), (-5.0, 0.5, -4.0), (-5.0, -0.5, -4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+y"),
|
||||
plane: (normal: (0.0, 1.0, 0.0), distance: 0.5),
|
||||
vertices: [(-5.0, 0.5, -4.0), (-5.0, 0.5, 4.0), (5.0, 0.5, 4.0), (5.0, 0.5, -4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-y"),
|
||||
plane: (normal: (0.0, -1.0, 0.0), distance: 0.5),
|
||||
vertices: [(-5.0, -0.5, 4.0), (-5.0, -0.5, -4.0), (5.0, -0.5, -4.0), (5.0, -0.5, 4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+z"),
|
||||
plane: (normal: (0.0, 0.0, 1.0), distance: 4.0),
|
||||
vertices: [(5.0, -0.5, 4.0), (5.0, 0.5, 4.0), (-5.0, 0.5, 4.0), (-5.0, -0.5, 4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-z"),
|
||||
plane: (normal: (0.0, 0.0, -1.0), distance: 4.0),
|
||||
vertices: [(-5.0, -0.5, -4.0), (-5.0, 0.5, -4.0), (5.0, 0.5, -4.0), (5.0, -0.5, -4.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
],
|
||||
cast_shadows: true,
|
||||
receive_shadows: true,
|
||||
),
|
||||
}),
|
||||
2: (components: {
|
||||
"bevy_ecs::name::Name": "Material Face Tower",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-2.5, 3.0, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-brush-material-tower"),
|
||||
"shared::components::ActorKind": Brush,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (1),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.55, g: 0.54, b: 0.52, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.85,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/concrete.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::BrushDesc": (
|
||||
kind: Additive,
|
||||
faces: [
|
||||
(
|
||||
id: ("face:+x"),
|
||||
plane: (normal: (1.0, 0.0, 0.0), distance: 1.25),
|
||||
vertices: [(1.25, -2.0, -1.25), (1.25, 2.0, -1.25), (1.25, 2.0, 1.25), (1.25, -2.0, 1.25)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-x"),
|
||||
plane: (normal: (-1.0, 0.0, 0.0), distance: 1.25),
|
||||
vertices: [(-1.25, -2.0, 1.25), (-1.25, 2.0, 1.25), (-1.25, 2.0, -1.25), (-1.25, -2.0, -1.25)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+y"),
|
||||
plane: (normal: (0.0, 1.0, 0.0), distance: 2.0),
|
||||
vertices: [(-1.25, 2.0, -1.25), (-1.25, 2.0, 1.25), (1.25, 2.0, 1.25), (1.25, 2.0, -1.25)],
|
||||
material: Some((
|
||||
asset_id: "cc2769da-c9a5-4cb3-866a-cc81d0688ee2",
|
||||
sub_asset_id: "material:instance",
|
||||
label: "surface_tint_instance",
|
||||
source_path: Some("assets/materials/surface_tint_instance.ron"),
|
||||
)),
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-y"),
|
||||
plane: (normal: (0.0, -1.0, 0.0), distance: 2.0),
|
||||
vertices: [(-1.25, -2.0, 1.25), (-1.25, -2.0, -1.25), (1.25, -2.0, -1.25), (1.25, -2.0, 1.25)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+z"),
|
||||
plane: (normal: (0.0, 0.0, 1.0), distance: 1.25),
|
||||
vertices: [(1.25, -2.0, 1.25), (1.25, 2.0, 1.25), (-1.25, 2.0, 1.25), (-1.25, -2.0, 1.25)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-z"),
|
||||
plane: (normal: (0.0, 0.0, -1.0), distance: 1.25),
|
||||
vertices: [(-1.25, -2.0, -1.25), (-1.25, 2.0, -1.25), (1.25, 2.0, -1.25), (1.25, -2.0, -1.25)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
],
|
||||
cast_shadows: true,
|
||||
receive_shadows: true,
|
||||
),
|
||||
}),
|
||||
3: (components: {
|
||||
"bevy_ecs::name::Name": "Subtractive Marker",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (2.5, 2.0, 0.0),
|
||||
rotation: (0.0, 0.258819, 0.0, 0.9659258),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-brush-subtractive-marker"),
|
||||
"shared::components::ActorKind": Brush,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (2),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.72, g: 0.14, b: 0.16, a: 1.0),
|
||||
metallic: 0.05,
|
||||
roughness: 0.4,
|
||||
emissive_color: (r: 1.0, g: 0.25, b: 0.2, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: None,
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
"shared::components::BrushDesc": (
|
||||
kind: SubtractiveMarker,
|
||||
faces: [
|
||||
(
|
||||
id: ("face:+x"),
|
||||
plane: (normal: (1.0, 0.0, 0.0), distance: 1.0),
|
||||
vertices: [(1.0, -1.0, -1.0), (1.0, 1.0, -1.0), (1.0, 1.0, 1.0), (1.0, -1.0, 1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-x"),
|
||||
plane: (normal: (-1.0, 0.0, 0.0), distance: 1.0),
|
||||
vertices: [(-1.0, -1.0, 1.0), (-1.0, 1.0, 1.0), (-1.0, 1.0, -1.0), (-1.0, -1.0, -1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+y"),
|
||||
plane: (normal: (0.0, 1.0, 0.0), distance: 1.0),
|
||||
vertices: [(-1.0, 1.0, -1.0), (-1.0, 1.0, 1.0), (1.0, 1.0, 1.0), (1.0, 1.0, -1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-y"),
|
||||
plane: (normal: (0.0, -1.0, 0.0), distance: 1.0),
|
||||
vertices: [(-1.0, -1.0, 1.0), (-1.0, -1.0, -1.0), (1.0, -1.0, -1.0), (1.0, -1.0, 1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:+z"),
|
||||
plane: (normal: (0.0, 0.0, 1.0), distance: 1.0),
|
||||
vertices: [(1.0, -1.0, 1.0), (1.0, 1.0, 1.0), (-1.0, 1.0, 1.0), (-1.0, -1.0, 1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
(
|
||||
id: ("face:-z"),
|
||||
plane: (normal: (0.0, 0.0, -1.0), distance: 1.0),
|
||||
vertices: [(-1.0, -1.0, -1.0), (-1.0, 1.0, -1.0), (1.0, 1.0, -1.0), (1.0, -1.0, -1.0)],
|
||||
material: None,
|
||||
texture: None,
|
||||
uv_offset: (0.0, 0.0),
|
||||
uv_scale: (1.0, 1.0),
|
||||
uv_rotation: 0.0,
|
||||
smoothing_group: 0,
|
||||
),
|
||||
],
|
||||
cast_shadows: true,
|
||||
receive_shadows: true,
|
||||
),
|
||||
}),
|
||||
4: (components: {
|
||||
"bevy_ecs::name::Name": "Brush Lab Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 8.0, 4.0),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-brush-sun"),
|
||||
"shared::components::ActorKind": Light,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (3),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::LightDesc": (
|
||||
kind: Directional,
|
||||
color: (r: 1.0, g: 0.95, b: 0.85, a: 1.0),
|
||||
intensity: 100000.0,
|
||||
range: 0.0,
|
||||
shadows: true,
|
||||
inner_angle_deg: 25.0,
|
||||
outer_angle_deg: 35.0,
|
||||
),
|
||||
}),
|
||||
})
|
||||
@@ -0,0 +1,189 @@
|
||||
(schema_version: 4, resources: {}, entities: {
|
||||
1: (components: {
|
||||
"bevy_ecs::name::Name": "Material Lab Floor",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, -0.2, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-floor"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (0),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (14.0, 0.4, 8.0)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.55, g: 0.54, b: 0.52, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.85,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/concrete.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
2: (components: {
|
||||
"bevy_ecs::name::Name": "Concrete Reference",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (-4.0, 1.0, 0.0),
|
||||
rotation: (0.0, 0.2164396, 0.0, 0.976296),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-concrete"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (1),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (2.0, 2.0, 2.0)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.55, g: 0.54, b: 0.52, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.85,
|
||||
emissive_color: (r: 1.0, g: 1.0, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 0.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/concrete.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
3: (components: {
|
||||
"bevy_ecs::name::Name": "Custom Surface Reference",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 1.2, 0.0),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-custom-surface"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (2),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Sphere, size: (2.4, 2.4, 2.4)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (
|
||||
kind: Custom,
|
||||
schema_path: Some("assets/shaders/surface_tint.shader.ron"),
|
||||
shader_path: Some("assets/shaders/surface_tint.wgsl"),
|
||||
),
|
||||
base_color: (r: 0.12, g: 0.42, b: 0.95, a: 1.0),
|
||||
metallic: 0.15,
|
||||
roughness: 0.28,
|
||||
emissive_color: (r: 0.02, g: 0.08, b: 0.25, a: 1.0),
|
||||
emissive_intensity: 3.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/surface_tint.ron"),
|
||||
parameters: [
|
||||
(name: "tint", value: Color((r: 0.12, g: 0.42, b: 0.95, a: 1.0))),
|
||||
(name: "roughness", value: Float(0.28)),
|
||||
(name: "metallic", value: Float(0.15)),
|
||||
(name: "emissive", value: Color((r: 0.02, g: 0.08, b: 0.25, a: 1.0))),
|
||||
(name: "emissive_intensity", value: Float(3.0)),
|
||||
],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
4: (components: {
|
||||
"bevy_ecs::name::Name": "Material Instance Reference",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (4.0, 1.0, 0.0),
|
||||
rotation: (0.0, -0.1305262, 0.0, 0.9914449),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-instance"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (3),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (2.6, 2.0, 2.6)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (
|
||||
kind: Custom,
|
||||
schema_path: Some("assets/shaders/surface_tint.shader.ron"),
|
||||
shader_path: Some("assets/shaders/surface_tint.wgsl"),
|
||||
),
|
||||
base_color: (r: 0.12, g: 0.42, b: 0.95, a: 1.0),
|
||||
metallic: 0.15,
|
||||
roughness: 0.28,
|
||||
emissive_color: (r: 0.02, g: 0.08, b: 0.25, a: 1.0),
|
||||
emissive_intensity: 3.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/surface_tint_instance.ron"),
|
||||
parameters: [
|
||||
(name: "tint", value: Color((r: 0.12, g: 0.42, b: 0.95, a: 1.0))),
|
||||
(name: "roughness", value: Float(0.28)),
|
||||
(name: "metallic", value: Float(0.15)),
|
||||
(name: "emissive", value: Color((r: 0.02, g: 0.08, b: 0.25, a: 1.0))),
|
||||
(name: "emissive_intensity", value: Float(3.0)),
|
||||
],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
5: (components: {
|
||||
"bevy_ecs::name::Name": "Emissive Reference Panel",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 2.3, -3.6),
|
||||
rotation: (0.0, 0.0, 0.0, 1.0),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-emissive-panel"),
|
||||
"shared::components::ActorKind": StaticMesh,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (4),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::Primitive": (shape: Box, size: (9.0, 3.0, 0.25)),
|
||||
"shared::components::MaterialDesc": (
|
||||
shader: (kind: StandardLit, schema_path: None, shader_path: None),
|
||||
base_color: (r: 0.15, g: 0.22, b: 0.28, a: 1.0),
|
||||
metallic: 0.0,
|
||||
roughness: 0.35,
|
||||
emissive_color: (r: 0.55, g: 0.85, b: 1.0, a: 1.0),
|
||||
emissive_intensity: 2500.0,
|
||||
base_color_texture: None,
|
||||
emissive_texture: None,
|
||||
normal_map_texture: None,
|
||||
metallic_roughness_texture: None,
|
||||
material_asset_path: Some("assets/materials/emissive_panel.ron"),
|
||||
parameters: [],
|
||||
textures: [],
|
||||
),
|
||||
}),
|
||||
6: (components: {
|
||||
"bevy_ecs::name::Name": "Material Lab Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 8.0, 4.0),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("sample-material-sun"),
|
||||
"shared::components::ActorKind": Light,
|
||||
"shared::components::EditorVisibility": (visible: true),
|
||||
"shared::components::HierarchySiblingIndex": (5),
|
||||
"shared::components::LevelObject": (),
|
||||
"shared::components::LightDesc": (
|
||||
kind: Directional,
|
||||
color: (r: 1.0, g: 0.95, b: 0.85, a: 1.0),
|
||||
intensity: 100000.0,
|
||||
range: 0.0,
|
||||
shadows: true,
|
||||
inner_angle_deg: 25.0,
|
||||
outer_angle_deg: 35.0,
|
||||
),
|
||||
}),
|
||||
})
|
||||
@@ -30,6 +30,33 @@
|
||||
label: "surface_tint_instance",
|
||||
source_path: Some("assets/materials/surface_tint_instance.ron"),
|
||||
)),
|
||||
material_layers: [
|
||||
(
|
||||
material: Some((
|
||||
asset_id: "a57f2891-8536-47b8-b476-01c08b36ac43",
|
||||
sub_asset_id: "material:source",
|
||||
label: "Concrete",
|
||||
source_path: Some("assets/materials/concrete.ron"),
|
||||
)),
|
||||
uv_scale: 6.0,
|
||||
),
|
||||
(
|
||||
material: Some((
|
||||
asset_id: "d6cb4151-7124-4237-aaf9-f7f8abd5fb76",
|
||||
sub_asset_id: "material:source",
|
||||
label: "Surface Tint",
|
||||
source_path: Some("assets/materials/surface_tint.ron"),
|
||||
)),
|
||||
uv_scale: 10.0,
|
||||
),
|
||||
],
|
||||
material_weights: [
|
||||
(255, 0, 0, 0), (255, 0, 0, 0), (224, 31, 0, 0), (255, 0, 0, 0), (255, 0, 0, 0),
|
||||
(255, 0, 0, 0), (192, 63, 0, 0), (128, 127, 0, 0), (192, 63, 0, 0), (255, 0, 0, 0),
|
||||
(224, 31, 0, 0), (128, 127, 0, 0), (0, 255, 0, 0), (128, 127, 0, 0), (224, 31, 0, 0),
|
||||
(255, 0, 0, 0), (192, 63, 0, 0), (128, 127, 0, 0), (192, 63, 0, 0), (255, 0, 0, 0),
|
||||
(255, 0, 0, 0), (255, 0, 0, 0), (224, 31, 0, 0), (255, 0, 0, 0), (255, 0, 0, 0),
|
||||
],
|
||||
generate_colliders: true,
|
||||
cast_shadows: true,
|
||||
receive_shadows: true,
|
||||
@@ -39,7 +66,7 @@
|
||||
"bevy_ecs::name::Name": "Terrain Sun",
|
||||
"bevy_transform::components::transform::Transform": (
|
||||
translation: (0.0, 8.0, 0.0),
|
||||
rotation: (0.1691, -0.0670, 0.7244, 0.6648),
|
||||
rotation: (-0.3826834, 0.0, 0.0, 0.9238795),
|
||||
scale: (1.0, 1.0, 1.0),
|
||||
),
|
||||
"shared::components::ActorId": ("terrain-showcase-sun"),
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
(
|
||||
schema_version: 1,
|
||||
samples: [
|
||||
(
|
||||
id: "brush-blockout",
|
||||
label: "Brush Blockout",
|
||||
area: Brush,
|
||||
scene: "assets/levels/samples/brush_blockout.scn.ron",
|
||||
summary: "Convex additive brushes, a subtractive marker, and a shared face material for brush editing and CSG regression checks.",
|
||||
checks: [
|
||||
"valid authored BrushDesc geometry",
|
||||
"shared brush-face material resolution",
|
||||
"object, face, clip, and CSG selection targets",
|
||||
],
|
||||
),
|
||||
(
|
||||
id: "material-lab",
|
||||
label: "Material Lab",
|
||||
area: Material,
|
||||
scene: "assets/levels/samples/material_lab.scn.ron",
|
||||
summary: "A compact look-development stage for shared materials, material instances, custom surfaces, and emissive output.",
|
||||
checks: [
|
||||
"Material and Material Instance dependency resolution",
|
||||
"standard, custom, and emissive surface hydration",
|
||||
"primitive material assignment and targeted drops",
|
||||
],
|
||||
),
|
||||
(
|
||||
id: "terrain-authoring",
|
||||
label: "Terrain Authoring",
|
||||
area: Terrain,
|
||||
scene: "assets/levels/terrain_authoring_showcase.scn.ron",
|
||||
summary: "A deterministic height grid with shared material layers, normalized paint weights, chunks, and collision.",
|
||||
checks: [
|
||||
"TerrainDesc schema and normalized layer weights",
|
||||
"shared terrain material dependency resolution",
|
||||
"sculpt, paint, chunk, and collider hydration",
|
||||
],
|
||||
),
|
||||
(
|
||||
id: "physics-placement",
|
||||
label: "Physics Placement",
|
||||
area: PhysicsPlacement,
|
||||
scene: "assets/levels/physics_placement_showcase.scn.ron",
|
||||
summary: "Three visually distinct collider cases above a static floor for transactional multi-object settling.",
|
||||
checks: [
|
||||
"cuboid, sphere, and capsule collider diversity",
|
||||
"multi-selection settle and grouped history",
|
||||
"static floor collision and cancel restoration",
|
||||
],
|
||||
),
|
||||
(
|
||||
id: "rendering-lab",
|
||||
label: "Rendering Lab",
|
||||
area: Rendering,
|
||||
scene: "assets/levels/rendering_showcase.scn.ron",
|
||||
summary: "Visible comparison anchors for fog, exposure, rendering profiles, fullscreen effects, and emissive lighting.",
|
||||
checks: [
|
||||
"stable post-process volume ownership",
|
||||
"rendering profile and fullscreen effect dependency resolution",
|
||||
"visible fog, exposure, vignette, and emissive comparison anchors",
|
||||
],
|
||||
),
|
||||
],
|
||||
)
|
||||
@@ -0,0 +1,116 @@
|
||||
#import bevy_pbr::{
|
||||
pbr_fragment::pbr_input_from_standard_material,
|
||||
pbr_functions::{alpha_discard, calculate_tbn_mikktspace},
|
||||
}
|
||||
|
||||
#ifdef PREPASS_PIPELINE
|
||||
#import bevy_pbr::{
|
||||
prepass_io::{VertexOutput, FragmentOutput},
|
||||
pbr_deferred_functions::deferred_output,
|
||||
}
|
||||
#else
|
||||
#import bevy_pbr::{
|
||||
forward_io::{VertexOutput, FragmentOutput},
|
||||
pbr_functions::{apply_pbr_lighting, main_pass_post_lighting_processing},
|
||||
}
|
||||
#endif
|
||||
|
||||
struct TerrainLayerUniform {
|
||||
base_colors: array<vec4<f32>, 4>,
|
||||
properties: array<vec4<f32>, 4>,
|
||||
uv_scales: vec4<f32>,
|
||||
base_texture_enabled: vec4<f32>,
|
||||
}
|
||||
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(100) var<uniform> terrain_layers: TerrainLayerUniform;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(101) var base_color0: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(102) var base_sampler0: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(103) var normal0: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(104) var normal_sampler0: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(105) var base_color1: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(106) var base_sampler1: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(107) var normal1: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(108) var normal_sampler1: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(109) var base_color2: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(110) var base_sampler2: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(111) var normal2: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(112) var normal_sampler2: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(113) var base_color3: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(114) var base_sampler3: sampler;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(115) var normal3: texture_2d<f32>;
|
||||
@group(#{MATERIAL_BIND_GROUP}) @binding(116) var normal_sampler3: sampler;
|
||||
|
||||
fn layer_base(index: u32, uv: vec2<f32>) -> vec4<f32> {
|
||||
if index == 0u { return textureSample(base_color0, base_sampler0, uv); }
|
||||
if index == 1u { return textureSample(base_color1, base_sampler1, uv); }
|
||||
if index == 2u { return textureSample(base_color2, base_sampler2, uv); }
|
||||
return textureSample(base_color3, base_sampler3, uv);
|
||||
}
|
||||
|
||||
fn layer_normal(index: u32, uv: vec2<f32>) -> vec3<f32> {
|
||||
var sample = vec3<f32>(0.5, 0.5, 1.0);
|
||||
if index == 0u { sample = textureSample(normal0, normal_sampler0, uv).xyz; }
|
||||
if index == 1u { sample = textureSample(normal1, normal_sampler1, uv).xyz; }
|
||||
if index == 2u { sample = textureSample(normal2, normal_sampler2, uv).xyz; }
|
||||
if index == 3u { sample = textureSample(normal3, normal_sampler3, uv).xyz; }
|
||||
return normalize(sample * 2.0 - 1.0);
|
||||
}
|
||||
|
||||
@fragment
|
||||
fn fragment(in: VertexOutput, @builtin(front_facing) is_front: bool) -> FragmentOutput {
|
||||
var pbr_input = pbr_input_from_standard_material(in, is_front);
|
||||
#ifdef VERTEX_UVS_A
|
||||
let uv = in.uv;
|
||||
#else
|
||||
let uv = vec2<f32>(0.0);
|
||||
#endif
|
||||
#ifdef VERTEX_COLORS
|
||||
var weights = max(in.color, vec4<f32>(0.0));
|
||||
#else
|
||||
var weights = vec4<f32>(1.0, 0.0, 0.0, 0.0);
|
||||
#endif
|
||||
let enabled = vec4<f32>(
|
||||
terrain_layers.properties[0].w,
|
||||
terrain_layers.properties[1].w,
|
||||
terrain_layers.properties[2].w,
|
||||
terrain_layers.properties[3].w,
|
||||
);
|
||||
weights *= enabled;
|
||||
let total = dot(weights, vec4<f32>(1.0));
|
||||
weights = select(vec4<f32>(1.0, 0.0, 0.0, 0.0), weights / total, total > 0.0001);
|
||||
|
||||
var color = vec4<f32>(0.0);
|
||||
var normal_ts = vec3<f32>(0.0);
|
||||
var metallic = 0.0;
|
||||
var roughness = 0.0;
|
||||
for (var index = 0u; index < 4u; index += 1u) {
|
||||
let weight = weights[index];
|
||||
let layer_uv = uv * terrain_layers.uv_scales[index];
|
||||
let base_sample = mix(
|
||||
vec4<f32>(1.0),
|
||||
layer_base(index, layer_uv),
|
||||
terrain_layers.base_texture_enabled[index],
|
||||
);
|
||||
color += base_sample * terrain_layers.base_colors[index] * weight;
|
||||
let normal_enabled = terrain_layers.properties[index].z;
|
||||
normal_ts += mix(vec3<f32>(0.0, 0.0, 1.0), layer_normal(index, layer_uv), normal_enabled) * weight;
|
||||
metallic += terrain_layers.properties[index].x * weight;
|
||||
roughness += terrain_layers.properties[index].y * weight;
|
||||
}
|
||||
pbr_input.material.base_color = alpha_discard(pbr_input.material, color);
|
||||
pbr_input.material.metallic = clamp(metallic, 0.0, 1.0);
|
||||
pbr_input.material.perceptual_roughness = clamp(roughness, 0.001, 1.0);
|
||||
#ifdef VERTEX_TANGENTS
|
||||
let tbn = calculate_tbn_mikktspace(pbr_input.world_normal, in.world_tangent);
|
||||
let n = normalize(normal_ts);
|
||||
pbr_input.N = normalize(n.x * tbn[0] + n.y * tbn[1] + n.z * tbn[2]);
|
||||
#endif
|
||||
#ifdef PREPASS_PIPELINE
|
||||
return deferred_output(in, pbr_input);
|
||||
#else
|
||||
var out: FragmentOutput;
|
||||
out.color = apply_pbr_lighting(pbr_input);
|
||||
out.color = main_pass_post_lighting_processing(pbr_input, out.color);
|
||||
return out;
|
||||
#endif
|
||||
}
|
||||
@@ -6,6 +6,7 @@
|
||||
use std::collections::HashMap;
|
||||
use std::fs;
|
||||
|
||||
use bevy::material::OpaqueRendererMethod;
|
||||
use bevy::mesh::MeshVertexBufferLayoutRef;
|
||||
use bevy::pbr::{
|
||||
ExtendedMaterial, MaterialExtension, MaterialExtensionKey, MaterialExtensionPipeline,
|
||||
@@ -17,15 +18,92 @@ use bevy::render::render_resource::{
|
||||
};
|
||||
use bevy::shader::{Shader, ShaderRef};
|
||||
use shared::{
|
||||
asset_server_path, material_from_desc, HydratedRendererMaterialBinding, MaterialAsset,
|
||||
MaterialInstanceAsset, MaterialParameterValue, MaterialRef, ShaderPropertyType,
|
||||
ShaderSchemaAsset, MATERIAL_INSTANCE_SCHEMA_VERSION,
|
||||
asset_server_path, material_from_desc, HydratedRendererMaterialBinding,
|
||||
HydratedTerrainMaterialBinding, MaterialAsset, MaterialDesc, MaterialInstanceAsset,
|
||||
MaterialParameterValue, MaterialRef, ShaderPropertyType, ShaderSchemaAsset,
|
||||
TerrainMaterialLayer, MATERIAL_INSTANCE_SCHEMA_VERSION, TERRAIN_MATERIAL_LAYER_LIMIT,
|
||||
};
|
||||
|
||||
pub const SURFACE_ABI_VERSION: u32 = 1;
|
||||
pub const SURFACE_PARAMETER_LANES: usize = 16;
|
||||
pub const SURFACE_TEXTURE_SLOTS: usize = 8;
|
||||
pub const DEFAULT_SURFACE_SHADER_PATH: &str = "shaders/blacksite_surface.wgsl";
|
||||
pub const TERRAIN_LAYER_SHADER_PATH: &str = "shaders/terrain_layers.wgsl";
|
||||
|
||||
#[derive(ShaderType, Reflect, Debug, Clone, Copy, PartialEq)]
|
||||
pub struct TerrainLayerUniform {
|
||||
pub base_colors: [Vec4; TERRAIN_MATERIAL_LAYER_LIMIT],
|
||||
/// Metallic, perceptual roughness, normal-map enabled, layer enabled.
|
||||
pub properties: [Vec4; TERRAIN_MATERIAL_LAYER_LIMIT],
|
||||
pub uv_scales: Vec4,
|
||||
pub base_texture_enabled: Vec4,
|
||||
}
|
||||
|
||||
impl Default for TerrainLayerUniform {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
base_colors: [Vec4::ONE; TERRAIN_MATERIAL_LAYER_LIMIT],
|
||||
properties: [Vec4::new(0.0, 0.9, 0.0, 0.0); TERRAIN_MATERIAL_LAYER_LIMIT],
|
||||
uv_scales: Vec4::splat(8.0),
|
||||
base_texture_enabled: Vec4::ZERO,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Asset, AsBindGroup, Reflect, Debug, Clone, Default)]
|
||||
pub struct TerrainLayerExtension {
|
||||
#[uniform(100)]
|
||||
pub uniform: TerrainLayerUniform,
|
||||
#[texture(101)]
|
||||
#[sampler(102)]
|
||||
pub base_color0: Option<Handle<Image>>,
|
||||
#[texture(103)]
|
||||
#[sampler(104)]
|
||||
pub normal0: Option<Handle<Image>>,
|
||||
#[texture(105)]
|
||||
#[sampler(106)]
|
||||
pub base_color1: Option<Handle<Image>>,
|
||||
#[texture(107)]
|
||||
#[sampler(108)]
|
||||
pub normal1: Option<Handle<Image>>,
|
||||
#[texture(109)]
|
||||
#[sampler(110)]
|
||||
pub base_color2: Option<Handle<Image>>,
|
||||
#[texture(111)]
|
||||
#[sampler(112)]
|
||||
pub normal2: Option<Handle<Image>>,
|
||||
#[texture(113)]
|
||||
#[sampler(114)]
|
||||
pub base_color3: Option<Handle<Image>>,
|
||||
#[texture(115)]
|
||||
#[sampler(116)]
|
||||
pub normal3: Option<Handle<Image>>,
|
||||
}
|
||||
|
||||
impl MaterialExtension for TerrainLayerExtension {
|
||||
fn fragment_shader() -> ShaderRef {
|
||||
TERRAIN_LAYER_SHADER_PATH.into()
|
||||
}
|
||||
|
||||
fn deferred_fragment_shader() -> ShaderRef {
|
||||
TERRAIN_LAYER_SHADER_PATH.into()
|
||||
}
|
||||
}
|
||||
|
||||
pub type TerrainLayerMaterial = ExtendedMaterial<StandardMaterial, TerrainLayerExtension>;
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct TerrainLayerCacheEntry {
|
||||
layers: Vec<TerrainMaterialLayer>,
|
||||
handle: Handle<TerrainLayerMaterial>,
|
||||
revision: u64,
|
||||
}
|
||||
|
||||
#[derive(Resource, Default)]
|
||||
struct TerrainLayerMaterialCache(HashMap<Entity, TerrainLayerCacheEntry>);
|
||||
|
||||
type TerrainMaterialBindings<'w, 's> =
|
||||
Query<'w, 's, (Entity, &'static HydratedTerrainMaterialBinding)>;
|
||||
|
||||
#[derive(ShaderType, Reflect, Debug, Clone, Copy, PartialEq)]
|
||||
pub struct SurfaceUniform {
|
||||
@@ -121,10 +199,6 @@ impl MaterialExtension for SurfaceExtension {
|
||||
DEFAULT_SURFACE_SHADER_PATH.into()
|
||||
}
|
||||
|
||||
fn prepass_fragment_shader() -> ShaderRef {
|
||||
DEFAULT_SURFACE_SHADER_PATH.into()
|
||||
}
|
||||
|
||||
fn specialize(
|
||||
_pipeline: &MaterialExtensionPipeline,
|
||||
descriptor: &mut RenderPipelineDescriptor,
|
||||
@@ -179,10 +253,194 @@ pub struct SurfaceMaterialPlugin;
|
||||
impl Plugin for SurfaceMaterialPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.add_plugins(MaterialPlugin::<SurfaceMaterial>::default())
|
||||
.add_plugins(MaterialPlugin::<TerrainLayerMaterial>::default())
|
||||
.init_resource::<SurfaceMaterialCache>()
|
||||
.init_resource::<TerrainLayerMaterialCache>()
|
||||
.init_resource::<SurfaceDiagnostics>()
|
||||
.init_resource::<SurfaceEvaluatorRegistry>()
|
||||
.add_systems(Update, sync_surface_material_bindings);
|
||||
.add_systems(
|
||||
Update,
|
||||
(
|
||||
sync_surface_material_bindings,
|
||||
sync_terrain_layer_material_bindings,
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
fn sync_terrain_layer_material_bindings(
|
||||
mut commands: Commands,
|
||||
asset_server: Res<AssetServer>,
|
||||
mut materials: ResMut<Assets<TerrainLayerMaterial>>,
|
||||
mut cache: ResMut<TerrainLayerMaterialCache>,
|
||||
mut diagnostics: ResMut<SurfaceDiagnostics>,
|
||||
bindings: TerrainMaterialBindings,
|
||||
) {
|
||||
for (entity, binding) in &bindings {
|
||||
if binding.layers.is_empty() {
|
||||
continue;
|
||||
}
|
||||
let revision = terrain_layer_revision(&binding.layers);
|
||||
let cached = cache
|
||||
.0
|
||||
.get(&binding.owner)
|
||||
.filter(|entry| entry.layers == binding.layers && entry.revision == revision)
|
||||
.map(|entry| entry.handle.clone());
|
||||
let handle = cached.unwrap_or_else(|| {
|
||||
let material =
|
||||
build_terrain_layer_material(&asset_server, &binding.layers, &mut diagnostics.0);
|
||||
let handle = cache
|
||||
.0
|
||||
.get(&binding.owner)
|
||||
.map(|entry| entry.handle.clone())
|
||||
.filter(|handle| {
|
||||
materials
|
||||
.get_mut(handle)
|
||||
.map(|mut slot| {
|
||||
*slot = material.clone();
|
||||
})
|
||||
.is_some()
|
||||
})
|
||||
.unwrap_or_else(|| materials.add(material));
|
||||
cache.0.insert(
|
||||
binding.owner,
|
||||
TerrainLayerCacheEntry {
|
||||
layers: binding.layers.clone(),
|
||||
handle: handle.clone(),
|
||||
revision,
|
||||
},
|
||||
);
|
||||
handle
|
||||
});
|
||||
queue_terrain_material_binding(&mut commands, entity, handle);
|
||||
}
|
||||
}
|
||||
|
||||
fn queue_terrain_material_binding(
|
||||
commands: &mut Commands,
|
||||
entity: Entity,
|
||||
handle: Handle<TerrainLayerMaterial>,
|
||||
) {
|
||||
// Generated render entities can be removed by a scene switch after this system's query
|
||||
// but before deferred commands apply. That lifecycle race is expected and must not abort
|
||||
// the editor while opening another scene.
|
||||
commands
|
||||
.entity(entity)
|
||||
.try_remove::<MeshMaterial3d<StandardMaterial>>()
|
||||
.try_insert(MeshMaterial3d(handle));
|
||||
}
|
||||
|
||||
fn terrain_layer_revision(layers: &[TerrainMaterialLayer]) -> u64 {
|
||||
let mut dependencies = layers
|
||||
.iter()
|
||||
.filter_map(|layer| layer.material.as_ref())
|
||||
.filter_map(|reference| reference.source_path.as_deref())
|
||||
.flat_map(|path| material_dependency_paths(path).unwrap_or_else(|_| vec![path.to_string()]))
|
||||
.collect::<Vec<_>>();
|
||||
dependencies.sort();
|
||||
dependencies.dedup();
|
||||
dependency_revision(&dependencies)
|
||||
}
|
||||
|
||||
fn build_terrain_layer_material(
|
||||
asset_server: &AssetServer,
|
||||
layers: &[TerrainMaterialLayer],
|
||||
diagnostics: &mut Vec<String>,
|
||||
) -> TerrainLayerMaterial {
|
||||
let mut extension = TerrainLayerExtension::default();
|
||||
for (index, layer) in layers.iter().take(TERRAIN_MATERIAL_LAYER_LIMIT).enumerate() {
|
||||
extension.uniform.uv_scales[index] = layer.uv_scale;
|
||||
let desc = resolve_terrain_layer(layer, index, diagnostics);
|
||||
let color = desc.base_color.to_color().to_linear();
|
||||
extension.uniform.base_colors[index] =
|
||||
Vec4::new(color.red, color.green, color.blue, color.alpha);
|
||||
extension.uniform.properties[index] = Vec4::new(
|
||||
desc.metallic,
|
||||
desc.roughness,
|
||||
f32::from(desc.normal_map_texture.is_some()),
|
||||
1.0,
|
||||
);
|
||||
extension.uniform.base_texture_enabled[index] =
|
||||
f32::from(desc.base_color_texture.is_some());
|
||||
let base_color = desc
|
||||
.base_color_texture
|
||||
.as_deref()
|
||||
.map(|path| asset_server.load(asset_server_path(path)));
|
||||
let normal = desc
|
||||
.normal_map_texture
|
||||
.as_deref()
|
||||
.map(|path| asset_server.load(asset_server_path(path)));
|
||||
match index {
|
||||
0 => {
|
||||
extension.base_color0 = base_color;
|
||||
extension.normal0 = normal;
|
||||
}
|
||||
1 => {
|
||||
extension.base_color1 = base_color;
|
||||
extension.normal1 = normal;
|
||||
}
|
||||
2 => {
|
||||
extension.base_color2 = base_color;
|
||||
extension.normal2 = normal;
|
||||
}
|
||||
3 => {
|
||||
extension.base_color3 = base_color;
|
||||
extension.normal3 = normal;
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
TerrainLayerMaterial {
|
||||
base: StandardMaterial {
|
||||
base_color: Color::WHITE,
|
||||
perceptual_roughness: 1.0,
|
||||
// Terrain is intentionally absent from the Solari acceleration structure until its
|
||||
// ray-tracing evaluator exists, so keep the layer blend in the raster forward pass.
|
||||
opaque_render_method: OpaqueRendererMethod::Forward,
|
||||
..default()
|
||||
},
|
||||
extension,
|
||||
}
|
||||
}
|
||||
|
||||
fn resolve_terrain_layer(
|
||||
layer: &TerrainMaterialLayer,
|
||||
index: usize,
|
||||
diagnostics: &mut Vec<String>,
|
||||
) -> MaterialDesc {
|
||||
let Some(reference) = layer.material.as_ref() else {
|
||||
diagnostics.push(format!(
|
||||
"terrain material layer {} is unassigned; using visible fallback",
|
||||
index + 1
|
||||
));
|
||||
return terrain_layer_fallback();
|
||||
};
|
||||
let Some(path) = reference.source_path.as_deref() else {
|
||||
diagnostics.push(format!(
|
||||
"terrain material layer {} ({}) has no loadable source path; using visible fallback",
|
||||
index + 1,
|
||||
reference.label
|
||||
));
|
||||
return terrain_layer_fallback();
|
||||
};
|
||||
match shared::load_resolved_material_from_path(path) {
|
||||
Ok((desc, _)) => desc,
|
||||
Err(error) => {
|
||||
diagnostics.push(format!(
|
||||
"terrain material layer {} ({}) could not resolve: {error}; using visible fallback",
|
||||
index + 1,
|
||||
reference.label
|
||||
));
|
||||
terrain_layer_fallback()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn terrain_layer_fallback() -> MaterialDesc {
|
||||
MaterialDesc {
|
||||
base_color: shared::ColorDesc::srgb(0.24, 0.29, 0.25),
|
||||
roughness: 0.92,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -226,8 +484,8 @@ fn sync_surface_material_bindings(
|
||||
{
|
||||
commands
|
||||
.entity(entity)
|
||||
.remove::<MeshMaterial3d<SurfaceMaterial>>()
|
||||
.insert(MeshMaterial3d(handle));
|
||||
.try_remove::<MeshMaterial3d<SurfaceMaterial>>()
|
||||
.try_insert(MeshMaterial3d(handle));
|
||||
}
|
||||
}
|
||||
continue;
|
||||
@@ -297,8 +555,8 @@ fn sync_surface_material_bindings(
|
||||
{
|
||||
commands
|
||||
.entity(entity)
|
||||
.remove::<MeshMaterial3d<SurfaceMaterial>>()
|
||||
.insert(MeshMaterial3d(handle));
|
||||
.try_remove::<MeshMaterial3d<SurfaceMaterial>>()
|
||||
.try_insert(MeshMaterial3d(handle));
|
||||
}
|
||||
continue;
|
||||
}
|
||||
@@ -322,8 +580,8 @@ fn sync_surface_material_bindings(
|
||||
if surface_handle.is_none_or(|current| current.0 != handle) {
|
||||
commands
|
||||
.entity(entity)
|
||||
.remove::<MeshMaterial3d<StandardMaterial>>()
|
||||
.insert(MeshMaterial3d(handle));
|
||||
.try_remove::<MeshMaterial3d<StandardMaterial>>()
|
||||
.try_insert(MeshMaterial3d(handle));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -714,6 +972,21 @@ pub fn compose_surface_shader(evaluator: &str) -> String {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use bevy::ecs::world::CommandQueue;
|
||||
|
||||
#[test]
|
||||
fn stale_generated_terrain_binding_is_nonfatal_during_scene_switch() {
|
||||
let mut world = World::new();
|
||||
let entity = world.spawn_empty().id();
|
||||
let mut queue = CommandQueue::default();
|
||||
let mut commands = Commands::new(&mut queue, &world);
|
||||
queue_terrain_material_binding(&mut commands, entity, Handle::default());
|
||||
|
||||
world.entity_mut(entity).despawn();
|
||||
queue.apply(&mut world);
|
||||
|
||||
assert!(world.get_entity(entity).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rejects_resource_bindings_and_missing_entry() {
|
||||
@@ -759,4 +1032,64 @@ mod tests {
|
||||
assert_eq!(SURFACE_TEXTURE_SLOTS, 8);
|
||||
assert_eq!(std::mem::size_of::<SurfaceUniform>(), 400);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn material_extensions_leave_non_deferred_prepasses_to_standard_material() {
|
||||
assert!(matches!(
|
||||
<SurfaceExtension as MaterialExtension>::prepass_fragment_shader(),
|
||||
ShaderRef::Default
|
||||
));
|
||||
assert!(matches!(
|
||||
<TerrainLayerExtension as MaterialExtension>::prepass_fragment_shader(),
|
||||
ShaderRef::Default
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terrain_layer_builder_packs_project_material_values() {
|
||||
let mut app = App::new();
|
||||
app.add_plugins((MinimalPlugins, AssetPlugin::default()));
|
||||
let asset_server = app.world().resource::<AssetServer>();
|
||||
let materials_root =
|
||||
std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../assets/materials");
|
||||
let layers = [
|
||||
TerrainMaterialLayer {
|
||||
material: Some(
|
||||
shared::EditorAssetRef::new("concrete", "material:source", "Concrete")
|
||||
.with_source_path(
|
||||
materials_root.join("concrete.ron").display().to_string(),
|
||||
),
|
||||
),
|
||||
uv_scale: 6.0,
|
||||
},
|
||||
TerrainMaterialLayer {
|
||||
material: Some(
|
||||
shared::EditorAssetRef::new("tint", "material:source", "Surface Tint")
|
||||
.with_source_path(
|
||||
materials_root
|
||||
.join("surface_tint.ron")
|
||||
.display()
|
||||
.to_string(),
|
||||
),
|
||||
),
|
||||
uv_scale: 10.0,
|
||||
},
|
||||
];
|
||||
let mut diagnostics = Vec::new();
|
||||
let material = build_terrain_layer_material(asset_server, &layers, &mut diagnostics);
|
||||
|
||||
assert!(diagnostics.is_empty(), "{diagnostics:?}");
|
||||
assert_eq!(material.extension.uniform.uv_scales.x, 6.0);
|
||||
assert_eq!(material.extension.uniform.uv_scales.y, 10.0);
|
||||
assert_eq!(material.extension.uniform.properties[0].w, 1.0);
|
||||
assert_eq!(material.extension.uniform.properties[1].w, 1.0);
|
||||
assert_eq!(
|
||||
material.base.opaque_render_method,
|
||||
OpaqueRendererMethod::Forward
|
||||
);
|
||||
assert_ne!(
|
||||
material.extension.uniform.base_colors[0],
|
||||
material.extension.uniform.base_colors[1]
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -469,6 +469,86 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn multi_actor_material_assignment_is_one_undo_group() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let material_path = std::env::temp_dir().join(format!(
|
||||
"blacksite-material-operator-{}.material.ron",
|
||||
uuid::Uuid::new_v4()
|
||||
));
|
||||
let fixture = shared::MaterialAsset {
|
||||
schema_version: shared::MATERIAL_ASSET_SCHEMA_VERSION,
|
||||
label: "Concrete".into(),
|
||||
shader: None,
|
||||
shader_ref: None,
|
||||
render_state: Default::default(),
|
||||
material: MaterialDesc {
|
||||
roughness: 0.85,
|
||||
..Default::default()
|
||||
},
|
||||
};
|
||||
std::fs::write(
|
||||
&material_path,
|
||||
ron::ser::to_string_pretty(&fixture, ron::ser::PrettyConfig::default()).unwrap(),
|
||||
)
|
||||
.unwrap();
|
||||
let material_path = material_path.to_string_lossy().into_owned();
|
||||
world.insert_resource(AssetRegistry {
|
||||
records: vec![AssetRecord {
|
||||
id: AssetId::new(),
|
||||
path: material_path.clone(),
|
||||
label: "Concrete".into(),
|
||||
kind_tag: "Material".into(),
|
||||
import_settings: Default::default(),
|
||||
dependencies: Vec::new(),
|
||||
}],
|
||||
index_dirty: false,
|
||||
});
|
||||
let first = world.spawn((LevelObject, MaterialDesc::default())).id();
|
||||
let second = world.spawn((LevelObject, MaterialDesc::default())).id();
|
||||
let mut selected = SelectedEntities::default();
|
||||
selected.select_replace(first);
|
||||
selected.select_maybe_add(second, true);
|
||||
let asset = EditorAsset {
|
||||
label: "Concrete".to_string(),
|
||||
path: Some(material_path.clone()),
|
||||
folder_path: "assets/materials".to_string(),
|
||||
kind: super::super::EditorAssetKind::Material,
|
||||
};
|
||||
super::super::materials::material_desc_from_asset(&material_path)
|
||||
.expect("committed material fixture should resolve");
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
let read_materials = move |world: &mut World| {
|
||||
[first, second]
|
||||
.into_iter()
|
||||
.map(|entity| {
|
||||
world
|
||||
.get::<MaterialDesc>(entity)
|
||||
.and_then(|material| material.material_asset_path.clone())
|
||||
})
|
||||
.collect::<Vec<_>>()
|
||||
};
|
||||
|
||||
let applied = apply_material_operator(&mut world, asset, &selected);
|
||||
assert!(
|
||||
applied,
|
||||
"material operator failed: {:?}",
|
||||
world.resource::<ActiveOperator>().status
|
||||
);
|
||||
|
||||
harness.assert_committed(&mut world, 1, 0);
|
||||
assert_undo_redo_round_trip(
|
||||
&mut world,
|
||||
vec![None, None],
|
||||
vec![Some(material_path.clone()), Some(material_path.clone())],
|
||||
read_materials,
|
||||
);
|
||||
let _ = std::fs::remove_file(material_path);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_subasset_commit_cancels_without_side_effects() {
|
||||
let mut world = World::new();
|
||||
@@ -533,4 +613,59 @@ mod tests {
|
||||
|
||||
harness.assert_blocked(&mut world);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn material_assignment_without_authored_selection_is_blocked() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
let asset = EditorAsset {
|
||||
label: "Concrete".to_string(),
|
||||
path: Some("assets/materials/concrete.ron".to_string()),
|
||||
folder_path: "assets/materials".to_string(),
|
||||
kind: super::super::EditorAssetKind::Material,
|
||||
};
|
||||
|
||||
assert!(!apply_material_operator(
|
||||
&mut world,
|
||||
asset,
|
||||
&SelectedEntities::default()
|
||||
));
|
||||
|
||||
harness.assert_blocked(&mut world);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn audio_and_animation_assignment_reject_incompatible_actors() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let entity = world.spawn(LevelObject).id();
|
||||
let audio = EditorAsset {
|
||||
label: "Impact".into(),
|
||||
path: Some("assets/audio/impact.ogg".into()),
|
||||
folder_path: "assets/audio".into(),
|
||||
kind: super::super::EditorAssetKind::AudioClip,
|
||||
};
|
||||
let audio_harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
assert!(!assign_audio_clip_operator(&mut world, audio, entity));
|
||||
audio_harness.assert_blocked(&mut world);
|
||||
|
||||
let animation_harness = OperatorInvariantHarness::capture(&mut world);
|
||||
let selection = AssetSelection::SubAsset {
|
||||
parent_path: "assets/models/missing.glb".into(),
|
||||
sub_asset_id: "animation:missing".into(),
|
||||
label: "Missing".into(),
|
||||
kind: super::super::AssetSubAssetKind::AnimationClip,
|
||||
source_path: None,
|
||||
};
|
||||
assert!(!assign_animation_clip_operator(
|
||||
&mut world, selection, entity
|
||||
));
|
||||
animation_harness.assert_blocked(&mut world);
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ use bevy::prelude::*;
|
||||
use bevy_egui::{egui, EguiContexts, EguiPrimaryContextPass};
|
||||
|
||||
use crate::history::group_selection_with_history;
|
||||
use crate::operators::{run_immediate_operator, OperatorAvailability};
|
||||
use crate::operators::{run_operator_action, OperatorAction, OperatorAvailability};
|
||||
use crate::state::{EditorMode, PlayPossession};
|
||||
use crate::ui::helpers::{
|
||||
reset_scene_lighting_to_project_defaults, toggle_play_mode, toggle_play_paused,
|
||||
@@ -27,7 +27,7 @@ pub trait EditorCommand: Send + Sync {
|
||||
fn disabled_reason(&self, _world: &World) -> Option<String> {
|
||||
None
|
||||
}
|
||||
fn execute(&self, world: &mut World);
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String>;
|
||||
}
|
||||
|
||||
#[derive(Resource, Default)]
|
||||
@@ -70,17 +70,20 @@ impl EditorCommandRegistry {
|
||||
.map(|cmd| (cmd.label().to_string(), cmd.disabled_reason(world)))
|
||||
}
|
||||
|
||||
pub fn run(&self, world: &mut World, name: &str) -> bool {
|
||||
if let Some(command) = self.commands.iter().find(|cmd| cmd.name() == name) {
|
||||
command.execute(world);
|
||||
true
|
||||
} else {
|
||||
false
|
||||
}
|
||||
pub fn run(&self, world: &mut World, name: &str) -> Option<Result<OperatorAction, String>> {
|
||||
self.commands
|
||||
.iter()
|
||||
.find(|command| command.name() == name)
|
||||
.map(|command| command.execute(world))
|
||||
}
|
||||
}
|
||||
|
||||
/// Custom inspector body for level objects (game crates register via [`register_actor_inspector_section`]).
|
||||
/// Custom inspector body for level objects (game crates register via
|
||||
/// [`register_actor_inspector_section`]). Synchronous [`Self::ui`] callbacks run while
|
||||
/// [`UiState`] is scoped out of `World`; implementations must not request that resource. Keep
|
||||
/// extension-owned transient state in independently registered resources, use
|
||||
/// [`crate::ui::request_ui_selection`] and [`crate::ui::request_editor_tab`] for host UI changes,
|
||||
/// or defer other cross-panel work through extension-owned commands or events.
|
||||
pub trait ActorInspectorSection: Send + Sync {
|
||||
fn id(&self) -> &str;
|
||||
fn title(&self) -> &str;
|
||||
@@ -191,6 +194,10 @@ pub fn register_editor_plugin(app: &mut App, plugin: Box<dyn EditorPlugin>) {
|
||||
}
|
||||
|
||||
fn register_builtin_commands(mut registry: ResMut<EditorCommandRegistry>) {
|
||||
populate_builtin_commands(&mut registry);
|
||||
}
|
||||
|
||||
fn populate_builtin_commands(registry: &mut EditorCommandRegistry) {
|
||||
registry.register(Box::new(TogglePlayCommand));
|
||||
registry.register(Box::new(TogglePlayPausedCommand));
|
||||
registry.register(Box::new(TogglePossessionCommand));
|
||||
@@ -235,7 +242,7 @@ fn dispatch_editor_command(world: &mut World, name: &str) {
|
||||
let name_for_commit = name.to_string();
|
||||
let name_for_status = name.to_string();
|
||||
let label_for_commit = label.clone();
|
||||
run_immediate_operator(
|
||||
run_operator_action(
|
||||
world,
|
||||
&name_for_status,
|
||||
&label,
|
||||
@@ -244,14 +251,10 @@ fn dispatch_editor_command(world: &mut World, name: &str) {
|
||||
None => OperatorAvailability::Ready,
|
||||
},
|
||||
move |world| {
|
||||
let ran = world.resource_scope(|world, registry: Mut<EditorCommandRegistry>| {
|
||||
let result = world.resource_scope(|world, registry: Mut<EditorCommandRegistry>| {
|
||||
registry.run(world, &name_for_commit)
|
||||
});
|
||||
if ran {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(format!("Unknown editor command: {name_for_commit}"))
|
||||
}
|
||||
result.unwrap_or_else(|| Err(format!("Unknown editor command: {name_for_commit}")))
|
||||
},
|
||||
);
|
||||
|
||||
@@ -269,8 +272,9 @@ impl EditorCommand for TogglePlayCommand {
|
||||
"Toggle Play / Edit"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
toggle_play_mode(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -290,8 +294,9 @@ impl EditorCommand for TogglePlayPausedCommand {
|
||||
.then(|| "Enter Play mode before pausing the simulation".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
toggle_play_paused(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -311,12 +316,13 @@ impl EditorCommand for TogglePossessionCommand {
|
||||
.then(|| "Enter Play mode before toggling possession".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
let next = match *world.resource::<PlayPossession>() {
|
||||
PlayPossession::Possessed => PlayPossession::Ejected,
|
||||
PlayPossession::Ejected => PlayPossession::Possessed,
|
||||
};
|
||||
*world.resource_mut::<PlayPossession>() = next;
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -331,8 +337,9 @@ impl EditorCommand for ResetLightingCommand {
|
||||
"Reset Scene Lighting"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
reset_scene_lighting_to_project_defaults(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -347,13 +354,23 @@ impl EditorCommand for GroupSelectionCommand {
|
||||
"Group Selection"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn disabled_reason(&self, world: &World) -> Option<String> {
|
||||
world
|
||||
.resource::<UiState>()
|
||||
.selected_entities
|
||||
.as_slice()
|
||||
.is_empty()
|
||||
.then(|| "Select at least one actor to group".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
let selected: Vec<Entity> = world
|
||||
.resource::<UiState>()
|
||||
.selected_entities
|
||||
.iter()
|
||||
.collect();
|
||||
group_selection_with_history(world, &selected);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -368,8 +385,9 @@ impl EditorCommand for FocusSelectionCommand {
|
||||
"Focus Selection"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
focus_editor_camera_on_selection(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -384,8 +402,9 @@ impl EditorCommand for ResetSelectionTransformCommand {
|
||||
"Reset Selection Transform"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
reset_selected_transforms(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -405,8 +424,9 @@ impl EditorCommand for DrawBrushCommand {
|
||||
.then(|| "Enter Edit mode before drawing brushes".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
start_draw_brush_tool(world);
|
||||
Ok(OperatorAction::ContinuePreview)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -425,8 +445,9 @@ impl EditorCommand for IntersectBrushesCommand {
|
||||
(selected_brush_count(world) < 2).then(|| "Select at least two brushes".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
intersect_selected_brushes(world);
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
intersect_selected_brushes(world)?;
|
||||
Ok(OperatorAction::ContinuePreview)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -445,8 +466,9 @@ impl EditorCommand for MergeBrushesCommand {
|
||||
(selected_brush_count(world) < 2).then(|| "Select at least two brushes".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
merge_selected_brushes(world);
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
merge_selected_brushes(world)?;
|
||||
Ok(OperatorAction::ContinuePreview)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -465,8 +487,9 @@ impl EditorCommand for SubtractBrushesCommand {
|
||||
(selected_brush_count(world) < 2).then(|| "Select at least two brushes".to_string())
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
subtract_selected_brushes(world);
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
subtract_selected_brushes(world)?;
|
||||
Ok(OperatorAction::ContinuePreview)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -481,8 +504,9 @@ impl EditorCommand for CreatePostProcessVolumeCommand {
|
||||
"Create Post-process Volume"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
crate::rendering_diagnostics::spawn_post_process_volume_at_camera(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -497,9 +521,10 @@ impl EditorCommand for FocusActiveVolumesCommand {
|
||||
"Focus Active Post-process Volumes"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
crate::rendering_diagnostics::select_volumes_at_camera(world);
|
||||
focus_editor_camera_on_selection(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -514,8 +539,9 @@ impl EditorCommand for SelectVolumesAtCameraCommand {
|
||||
"Select Volumes at Camera"
|
||||
}
|
||||
|
||||
fn execute(&self, world: &mut World) {
|
||||
fn execute(&self, world: &mut World) -> Result<OperatorAction, String> {
|
||||
crate::rendering_diagnostics::select_volumes_at_camera(world);
|
||||
Ok(OperatorAction::Commit)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -542,6 +568,7 @@ fn command_palette_ui(
|
||||
}
|
||||
|
||||
let mut open = palette.open;
|
||||
let mut dismiss_requested = false;
|
||||
let palette_width = (ctx.content_rect().width() - 32.0).clamp(320.0, 520.0);
|
||||
egui::Window::new("Command Palette")
|
||||
.open(&mut open)
|
||||
@@ -590,13 +617,11 @@ fn command_palette_ui(
|
||||
if ui.input_mut(|input| input.consume_key(egui::Modifiers::NONE, egui::Key::Enter)) {
|
||||
if let Some(entry) = filtered_entries.get(palette.selected_index) {
|
||||
palette.pending_run = Some(entry.name.clone());
|
||||
palette.open = false;
|
||||
ui.close();
|
||||
dismiss_requested = true;
|
||||
}
|
||||
}
|
||||
if ui.input_mut(|input| input.consume_key(egui::Modifiers::NONE, egui::Key::Escape)) {
|
||||
palette.open = false;
|
||||
ui.close();
|
||||
dismiss_requested = true;
|
||||
}
|
||||
|
||||
ui.separator();
|
||||
@@ -618,17 +643,20 @@ fn command_palette_ui(
|
||||
if response.clicked() {
|
||||
palette.selected_index = index;
|
||||
palette.pending_run = Some(entry.name.clone());
|
||||
palette.open = false;
|
||||
ui.close();
|
||||
dismiss_requested = true;
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
palette.open = open;
|
||||
palette.open = resolve_palette_open(open, dismiss_requested);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn resolve_palette_open(window_open: bool, dismiss_requested: bool) -> bool {
|
||||
window_open && !dismiss_requested
|
||||
}
|
||||
|
||||
fn filtered_command_entries(
|
||||
registry: &EditorCommandRegistry,
|
||||
filter: &str,
|
||||
@@ -671,6 +699,53 @@ fn command_palette_row(entry: &EditorCommandEntry) -> egui::WidgetText {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::{apply_command_redo, apply_command_undo, EditorHistory};
|
||||
use crate::operators::test_harness::OperatorInvariantHarness;
|
||||
use crate::operators::{ActiveOperator, OperatorPhase};
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::selection::{SelectedEntity, ViewportClick};
|
||||
use crate::viewport::brush_tool::BrushToolState;
|
||||
use shared::{
|
||||
ActorKind, AuthoringLightKind, BrushDesc, EditorVisibility, HierarchySiblingIndex,
|
||||
LevelObject, LightDesc,
|
||||
};
|
||||
|
||||
fn command_world() -> World {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<ViewportClick>();
|
||||
world.init_resource::<BrushToolState>();
|
||||
world.init_resource::<crate::viewport::brush_csg::BrushCsgPreview>();
|
||||
world.insert_resource(State::new(EditorMode::Editing));
|
||||
world.insert_resource(UiState::default_layout());
|
||||
let mut registry = EditorCommandRegistry::default();
|
||||
populate_builtin_commands(&mut registry);
|
||||
world.insert_resource(registry);
|
||||
world
|
||||
}
|
||||
|
||||
fn hierarchy_projection(world: &mut World) -> Vec<(String, Option<String>, i32)> {
|
||||
let mut query = world.query_filtered::<(Entity, &Name), With<LevelObject>>();
|
||||
let mut result = query
|
||||
.iter(world)
|
||||
.map(|(entity, name)| {
|
||||
let parent = world
|
||||
.get::<ChildOf>(entity)
|
||||
.and_then(|child| world.get::<Name>(child.parent()))
|
||||
.map(|name| name.as_str().to_string());
|
||||
let sibling_index = world
|
||||
.get::<HierarchySiblingIndex>(entity)
|
||||
.map(|index| index.0)
|
||||
.unwrap_or_default();
|
||||
(name.as_str().to_string(), parent, sibling_index)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
result.sort();
|
||||
result
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn command_filter_matches_human_label_and_stable_id() {
|
||||
@@ -697,4 +772,228 @@ mod tests {
|
||||
assert_eq!(entries[0].name, "play.toggle");
|
||||
assert_eq!(entries[1].name, "scene.reset_lighting");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn command_palette_dismissal_wins_over_stale_window_open_state() {
|
||||
assert!(!resolve_palette_open(true, true));
|
||||
assert!(!resolve_palette_open(false, false));
|
||||
assert!(resolve_palette_open(true, false));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn grouping_dispatch_is_one_history_transaction_and_round_trips() {
|
||||
let mut world = command_world();
|
||||
let first = world
|
||||
.spawn((
|
||||
Name::new("First"),
|
||||
LevelObject,
|
||||
ActorKind::Empty,
|
||||
Transform::from_xyz(1.0, 0.0, 0.0),
|
||||
GlobalTransform::default(),
|
||||
HierarchySiblingIndex(0),
|
||||
EditorVisibility::default(),
|
||||
))
|
||||
.id();
|
||||
let second = world
|
||||
.spawn((
|
||||
Name::new("Second"),
|
||||
LevelObject,
|
||||
ActorKind::Empty,
|
||||
Transform::from_xyz(2.0, 0.0, 0.0),
|
||||
GlobalTransform::default(),
|
||||
HierarchySiblingIndex(1),
|
||||
EditorVisibility::default(),
|
||||
))
|
||||
.id();
|
||||
let unselected = world
|
||||
.spawn((
|
||||
Name::new("Unselected"),
|
||||
LevelObject,
|
||||
ActorKind::Empty,
|
||||
Transform::from_xyz(3.0, 0.0, 0.0),
|
||||
GlobalTransform::default(),
|
||||
HierarchySiblingIndex(2),
|
||||
EditorVisibility::default(),
|
||||
))
|
||||
.id();
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_replace(first);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_maybe_add(second, true);
|
||||
let initial = hierarchy_projection(&mut world);
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "selection.group");
|
||||
|
||||
harness.assert_committed(&mut world, 1, 1);
|
||||
harness.assert_status(&world, "selection.group", OperatorPhase::Committed);
|
||||
let committed = hierarchy_projection(&mut world);
|
||||
assert!(committed
|
||||
.iter()
|
||||
.any(|(name, parent, _)| name == "First" && parent.as_deref() == Some("Group")));
|
||||
assert!(committed
|
||||
.iter()
|
||||
.any(|(name, parent, _)| name == "Second" && parent.as_deref() == Some("Group")));
|
||||
assert_group_has_visibility_hierarchy(&mut world);
|
||||
apply_command_undo(&mut world);
|
||||
assert_eq!(hierarchy_projection(&mut world), initial);
|
||||
apply_command_redo(&mut world);
|
||||
assert_eq!(hierarchy_projection(&mut world), committed);
|
||||
assert_group_has_visibility_hierarchy(&mut world);
|
||||
assert!(world.get::<ChildOf>(unselected).is_none());
|
||||
apply_command_undo(&mut world);
|
||||
assert_eq!(hierarchy_projection(&mut world), initial);
|
||||
apply_command_redo(&mut world);
|
||||
assert_eq!(hierarchy_projection(&mut world), committed);
|
||||
assert!(world.get::<ChildOf>(unselected).is_none());
|
||||
}
|
||||
|
||||
fn assert_group_has_visibility_hierarchy(world: &mut World) {
|
||||
let group = world
|
||||
.query::<(Entity, &Name)>()
|
||||
.iter(world)
|
||||
.find_map(|(entity, name)| (name.as_str() == "Group").then_some(entity))
|
||||
.expect("group command should spawn the group actor");
|
||||
assert!(world.get::<Visibility>(group).is_some());
|
||||
assert!(world.get::<InheritedVisibility>(group).is_some());
|
||||
assert!(world.get::<ViewVisibility>(group).is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reset_lighting_dispatch_is_one_undoable_group() {
|
||||
let mut world = command_world();
|
||||
let point = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
ActorKind::Light,
|
||||
LightDesc {
|
||||
kind: AuthoringLightKind::Point,
|
||||
..Default::default()
|
||||
},
|
||||
))
|
||||
.id();
|
||||
let directional = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
ActorKind::Light,
|
||||
LightDesc {
|
||||
kind: AuthoringLightKind::Directional,
|
||||
..Default::default()
|
||||
},
|
||||
))
|
||||
.id();
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "scene.reset_lighting");
|
||||
|
||||
harness.assert_committed(&mut world, 1, 0);
|
||||
harness.assert_status(&world, "scene.reset_lighting", OperatorPhase::Committed);
|
||||
assert!(world.get::<LightDesc>(point).is_none());
|
||||
assert!(world.get::<LightDesc>(directional).is_none());
|
||||
apply_command_undo(&mut world);
|
||||
assert!(world.get::<LightDesc>(point).is_some());
|
||||
assert!(world.get::<LightDesc>(directional).is_some());
|
||||
apply_command_redo(&mut world);
|
||||
assert!(world.get::<LightDesc>(point).is_none());
|
||||
assert!(world.get::<LightDesc>(directional).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn modal_command_dispatch_retains_preview_ownership() {
|
||||
let mut world = command_world();
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "brush.draw");
|
||||
|
||||
harness.assert_status(&world, "brush.draw", OperatorPhase::Preview);
|
||||
harness.assert_projection_unchanged(&mut world, 0, |world| {
|
||||
world.resource::<EditorHistory>().undo_depth()
|
||||
});
|
||||
assert!(!world.resource::<SceneIo>().dirty);
|
||||
assert!(world.resource::<BrushToolState>().active);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn failed_csg_dispatch_terminates_without_preview_or_history() {
|
||||
let mut world = command_world();
|
||||
let first = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
BrushDesc::cuboid(Vec3::splat(1.0)),
|
||||
Transform::IDENTITY,
|
||||
))
|
||||
.id();
|
||||
let mut invalid = BrushDesc::cuboid(Vec3::splat(1.0));
|
||||
invalid.faces.clear();
|
||||
let second = world
|
||||
.spawn((LevelObject, invalid, Transform::IDENTITY))
|
||||
.id();
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_replace(first);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_maybe_add(second, true);
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "brush.intersect");
|
||||
|
||||
harness.assert_canceled(&mut world);
|
||||
harness.assert_status(&world, "brush.intersect", OperatorPhase::Canceled);
|
||||
assert!(!world.resource::<SceneIo>().dirty);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn csg_dispatch_blocks_read_only_selection_without_history() {
|
||||
let mut world = command_world();
|
||||
let first = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
BrushDesc::cuboid(Vec3::splat(1.0)),
|
||||
Transform::IDENTITY,
|
||||
))
|
||||
.id();
|
||||
let second = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
BrushDesc::cuboid(Vec3::splat(1.0)),
|
||||
Transform::from_xyz(0.5, 0.0, 0.0),
|
||||
))
|
||||
.id();
|
||||
let mut hierarchy = crate::ui::hierarchy_state::HierarchyPanelState::default();
|
||||
hierarchy.locked.insert(second);
|
||||
world.insert_resource(hierarchy);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_replace(first);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_maybe_add(second, true);
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "brush.merge_convex");
|
||||
|
||||
harness.assert_blocked(&mut world);
|
||||
harness.assert_status(&world, "brush.merge_convex", OperatorPhase::Blocked);
|
||||
assert!(!world.resource::<SceneIo>().dirty);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn disabled_command_dispatch_is_a_blocked_no_op() {
|
||||
let mut world = command_world();
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
dispatch_editor_command(&mut world, "selection.group");
|
||||
|
||||
harness.assert_blocked(&mut world);
|
||||
harness.assert_status(&world, "selection.group", OperatorPhase::Blocked);
|
||||
}
|
||||
}
|
||||
@@ -106,6 +106,11 @@ pub struct PrefabEditState {
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
pub enum EditorCommand {
|
||||
GroupSelection {
|
||||
snapshot: EditorEntitySnapshot,
|
||||
group: Option<Entity>,
|
||||
changes: Vec<SiblingChange>,
|
||||
},
|
||||
Spawn {
|
||||
snapshot: EditorEntitySnapshot,
|
||||
entity: Option<Entity>,
|
||||
@@ -152,6 +157,12 @@ pub enum EditorCommand {
|
||||
old: Option<LightDesc>,
|
||||
new: LightDesc,
|
||||
},
|
||||
SetLightGroup {
|
||||
entities: Vec<Entity>,
|
||||
olds: Vec<Option<LightDesc>>,
|
||||
news: Vec<Option<LightDesc>>,
|
||||
label: &'static str,
|
||||
},
|
||||
SetAnimationController {
|
||||
entity: Entity,
|
||||
old: Option<AnimationControllerDesc>,
|
||||
@@ -293,6 +304,7 @@ pub enum EditorCommand {
|
||||
impl EditorCommand {
|
||||
pub fn label(&self) -> &'static str {
|
||||
match self {
|
||||
EditorCommand::GroupSelection { .. } => "Group Selection",
|
||||
EditorCommand::Spawn { .. } => "Spawn",
|
||||
EditorCommand::SpawnMany { .. } => "Spawn Brushes",
|
||||
EditorCommand::Despawn { .. } => "Delete",
|
||||
@@ -303,6 +315,7 @@ impl EditorCommand {
|
||||
EditorCommand::SetMaterialGroup { .. } => "Apply Material to Selection",
|
||||
EditorCommand::SetMaterialOverride { .. } => "Set Material Override",
|
||||
EditorCommand::SetLight { .. } => "Set Light",
|
||||
EditorCommand::SetLightGroup { label, .. } => label,
|
||||
EditorCommand::SetAnimationController { .. } => "Set Animation Controller",
|
||||
EditorCommand::SetAudioSource { .. } => "Set Audio Source",
|
||||
EditorCommand::SetAudioListener { .. } => "Set Audio Listener",
|
||||
|
||||
@@ -17,8 +17,8 @@ use shared::{
|
||||
TriggerVolume, WeaponSpawn,
|
||||
};
|
||||
|
||||
use crate::operators::{ActiveOperator, OperatorPhase, OperatorStatus};
|
||||
use crate::scene_io::{SceneIo, SceneIoRequest};
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::state::scene_tools_active;
|
||||
use crate::ui::hierarchy_ops::{
|
||||
apply_sibling_change, apply_sibling_change_new, hierarchy_drop_violation, next_sibling_index,
|
||||
@@ -197,7 +197,20 @@ fn spawn_snapshot_with_parent(
|
||||
snapshot: &EditorEntitySnapshot,
|
||||
parent: Option<Entity>,
|
||||
) -> Entity {
|
||||
let mut entity_mut = world.spawn((LevelObject, snapshot.actor_kind, snapshot.transform));
|
||||
let visibility = if snapshot.editor_visibility.visible {
|
||||
Visibility::Visible
|
||||
} else {
|
||||
Visibility::Hidden
|
||||
};
|
||||
let mut entity_mut = world.spawn((
|
||||
LevelObject,
|
||||
snapshot.actor_kind,
|
||||
snapshot.transform,
|
||||
snapshot.editor_visibility,
|
||||
visibility,
|
||||
InheritedVisibility::default(),
|
||||
ViewVisibility::default(),
|
||||
));
|
||||
entity_mut.insert(
|
||||
snapshot
|
||||
.actor_id
|
||||
@@ -290,7 +303,6 @@ fn spawn_snapshot_with_parent(
|
||||
entity_mut.insert(link.clone());
|
||||
}
|
||||
entity_mut.insert(HierarchySiblingIndex(snapshot.hierarchy_sibling_index));
|
||||
entity_mut.insert(snapshot.editor_visibility);
|
||||
if let Some(order) = &snapshot.inspector_order {
|
||||
entity_mut.insert(order.clone());
|
||||
}
|
||||
@@ -560,6 +572,40 @@ pub fn set_light_with_history(world: &mut World, entity: Entity, new: LightDesc)
|
||||
push_history(world, EditorCommand::SetLight { entity, old, new });
|
||||
}
|
||||
|
||||
pub fn set_light_group_with_history(
|
||||
world: &mut World,
|
||||
changes: impl IntoIterator<Item = (Entity, Option<LightDesc>)>,
|
||||
label: &'static str,
|
||||
) {
|
||||
let mut entities = Vec::new();
|
||||
let mut olds = Vec::new();
|
||||
let mut news = Vec::new();
|
||||
for (entity, new) in changes {
|
||||
if !is_mutable_level_object(world, entity) {
|
||||
continue;
|
||||
}
|
||||
let old = world.get::<LightDesc>(entity).cloned();
|
||||
if old.is_none() && new.is_none() {
|
||||
continue;
|
||||
}
|
||||
apply_light(world, entity, &new);
|
||||
entities.push(entity);
|
||||
olds.push(old);
|
||||
news.push(new);
|
||||
}
|
||||
if !entities.is_empty() {
|
||||
push_history(
|
||||
world,
|
||||
EditorCommand::SetLightGroup {
|
||||
entities,
|
||||
olds,
|
||||
news,
|
||||
label,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
pub fn set_audio_source_with_history(world: &mut World, entity: Entity, new: AudioSourceDesc) {
|
||||
if !is_mutable_level_object(world, entity) {
|
||||
return;
|
||||
@@ -752,9 +798,13 @@ pub fn apply_brush_csg_with_history(
|
||||
new_transform: Transform,
|
||||
new_brush: BrushDesc,
|
||||
delete_entities: &[Entity],
|
||||
) {
|
||||
if !is_level_object(world, primary) {
|
||||
return;
|
||||
) -> bool {
|
||||
if !is_mutable_level_object(world, primary)
|
||||
|| delete_entities
|
||||
.iter()
|
||||
.any(|entity| !is_mutable_level_object(world, *entity))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
let old_transform = world.get::<Transform>(primary).copied().unwrap_or_default();
|
||||
let old_brush = world.get::<BrushDesc>(primary).cloned();
|
||||
@@ -769,7 +819,7 @@ pub fn apply_brush_csg_with_history(
|
||||
&& old_brush.as_ref() == Some(&new_brush)
|
||||
&& deleted.is_empty()
|
||||
{
|
||||
return;
|
||||
return false;
|
||||
}
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(primary) {
|
||||
entity_mut.insert(new_transform);
|
||||
@@ -790,6 +840,7 @@ pub fn apply_brush_csg_with_history(
|
||||
},
|
||||
);
|
||||
select_one(world, primary);
|
||||
true
|
||||
}
|
||||
|
||||
pub fn set_static_mesh_renderer_with_history(
|
||||
@@ -943,14 +994,16 @@ pub fn group_selection_with_history(world: &mut World, entities: &[Entity]) {
|
||||
children: Vec::new(),
|
||||
};
|
||||
let group = spawn_snapshot(world, &snapshot);
|
||||
let changes = reorder_entities_under_parent(world, &entities, Some(group), i32::MAX);
|
||||
push_history(
|
||||
world,
|
||||
EditorCommand::Spawn {
|
||||
EditorCommand::GroupSelection {
|
||||
snapshot,
|
||||
entity: Some(group),
|
||||
group: Some(group),
|
||||
changes,
|
||||
},
|
||||
);
|
||||
reorder_siblings_with_history(world, &entities, Some(group), i32::MAX);
|
||||
select_one(world, group);
|
||||
}
|
||||
|
||||
pub fn create_empty_child_with_history(world: &mut World, parent: Entity) {
|
||||
@@ -1415,16 +1468,13 @@ pub fn apply_reflected_component(
|
||||
let reflected = TypedReflectDeserializer::new(registration, &type_registry)
|
||||
.deserialize(&mut deserializer)
|
||||
.map_err(|error| error.to_string())?;
|
||||
let exists = reflect_component.reflect(world.entity(entity)).is_some();
|
||||
if exists {
|
||||
reflect_component.apply(world.entity_mut(entity), reflected.as_ref());
|
||||
} else {
|
||||
reflect_component.insert(
|
||||
&mut world.entity_mut(entity),
|
||||
reflected.as_ref(),
|
||||
&type_registry,
|
||||
);
|
||||
}
|
||||
// Reflected `apply` merges list fields and cannot restore a shorter snapshot.
|
||||
// Inserting the captured concrete component replaces the value atomically.
|
||||
reflect_component.insert(
|
||||
&mut world.entity_mut(entity),
|
||||
reflected.as_ref(),
|
||||
&type_registry,
|
||||
);
|
||||
}
|
||||
None => reflect_component.remove(&mut world.entity_mut(entity)),
|
||||
}
|
||||
@@ -1451,16 +1501,11 @@ pub fn apply_reflected_default(
|
||||
.data::<ReflectDefault>()
|
||||
.ok_or_else(|| format!("component `{type_path}` has no reflected Default"))?
|
||||
.default();
|
||||
let exists = reflect_component.reflect(world.entity(entity)).is_some();
|
||||
if exists {
|
||||
reflect_component.apply(world.entity_mut(entity), default.as_ref());
|
||||
} else {
|
||||
reflect_component.insert(
|
||||
&mut world.entity_mut(entity),
|
||||
default.as_ref(),
|
||||
&type_registry,
|
||||
);
|
||||
}
|
||||
reflect_component.insert(
|
||||
&mut world.entity_mut(entity),
|
||||
default.as_ref(),
|
||||
&type_registry,
|
||||
);
|
||||
Ok(())
|
||||
})
|
||||
}
|
||||
@@ -1585,7 +1630,7 @@ pub fn apply_command_undo(world: &mut World) {
|
||||
undo_command(world, &mut command);
|
||||
world.resource_mut::<EditorHistory>().push_redo(command);
|
||||
world.resource_mut::<EditorHistory>().set_redo_status(label);
|
||||
mark_dirty(world);
|
||||
crate::scene_io::reconcile_active_dirty_with_checkpoint(world);
|
||||
}
|
||||
|
||||
pub fn apply_command_redo(world: &mut World) {
|
||||
@@ -1606,7 +1651,7 @@ pub fn apply_command_redo(world: &mut World) {
|
||||
redo_command(world, &mut command);
|
||||
world.resource_mut::<EditorHistory>().push_undo(command);
|
||||
world.resource_mut::<EditorHistory>().set_undo_status(label);
|
||||
mark_dirty(world);
|
||||
crate::scene_io::reconcile_active_dirty_with_checkpoint(world);
|
||||
}
|
||||
|
||||
fn prepare_prefab_source_history(
|
||||
@@ -1645,6 +1690,13 @@ fn prepare_prefab_source_history(
|
||||
|
||||
fn undo_command(world: &mut World, command: &mut EditorCommand) {
|
||||
match command {
|
||||
EditorCommand::GroupSelection { group, changes, .. } => {
|
||||
for change in changes.iter().rev() {
|
||||
apply_sibling_change(world, change);
|
||||
}
|
||||
despawn_entity(world, *group);
|
||||
clear_selection(world);
|
||||
}
|
||||
EditorCommand::Spawn { entity, .. } => {
|
||||
despawn_entity(world, entity.take());
|
||||
clear_selection(world);
|
||||
@@ -1690,6 +1742,11 @@ fn undo_command(world: &mut World, command: &mut EditorCommand) {
|
||||
EditorCommand::SetLight { entity, old, .. } => {
|
||||
apply_light(world, *entity, old);
|
||||
}
|
||||
EditorCommand::SetLightGroup { entities, olds, .. } => {
|
||||
for (entity, old) in entities.iter().zip(olds.iter()) {
|
||||
apply_light(world, *entity, old);
|
||||
}
|
||||
}
|
||||
EditorCommand::SetAnimationController { entity, old, .. } => {
|
||||
apply_animation_controller(world, *entity, old);
|
||||
}
|
||||
@@ -1826,6 +1883,25 @@ fn undo_command(world: &mut World, command: &mut EditorCommand) {
|
||||
|
||||
fn redo_command(world: &mut World, command: &mut EditorCommand) {
|
||||
match command {
|
||||
EditorCommand::GroupSelection {
|
||||
snapshot,
|
||||
group,
|
||||
changes,
|
||||
} => {
|
||||
let previous_group = *group;
|
||||
let spawned = spawn_snapshot(world, snapshot);
|
||||
*group = Some(spawned);
|
||||
for change in changes.iter_mut() {
|
||||
if Some(change.entity) == previous_group {
|
||||
change.entity = spawned;
|
||||
}
|
||||
if change.new_parent == previous_group {
|
||||
change.new_parent = Some(spawned);
|
||||
}
|
||||
apply_sibling_change_new(world, change);
|
||||
}
|
||||
select_one(world, spawned);
|
||||
}
|
||||
EditorCommand::Spawn { snapshot, entity } => {
|
||||
let spawned = spawn_snapshot(world, snapshot);
|
||||
*entity = Some(spawned);
|
||||
@@ -1889,6 +1965,11 @@ fn redo_command(world: &mut World, command: &mut EditorCommand) {
|
||||
entity_mut.insert(new.clone());
|
||||
}
|
||||
}
|
||||
EditorCommand::SetLightGroup { entities, news, .. } => {
|
||||
for (entity, new) in entities.iter().zip(news.iter()) {
|
||||
apply_light(world, *entity, new);
|
||||
}
|
||||
}
|
||||
EditorCommand::SetAnimationController { entity, new, .. } => {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(*entity) {
|
||||
entity_mut.insert(new.clone());
|
||||
@@ -2622,25 +2703,41 @@ fn capture_gizmo_transform_edits(world: &mut World) {
|
||||
let start_group =
|
||||
active.map(|(entity, transform)| selected_transforms(world, &selection, entity, transform));
|
||||
|
||||
let mut started_edit = false;
|
||||
let (finished_edit, live_edit) = {
|
||||
let mut tracker = world.resource_mut::<TransformEditTracker>();
|
||||
if tracker.active.is_none() {
|
||||
if let (Some((entity, transform)), Some(group)) = (active, start_group) {
|
||||
tracker.active = Some((entity, transform, group));
|
||||
return;
|
||||
started_edit = true;
|
||||
}
|
||||
}
|
||||
match tracker.active.take() {
|
||||
Some((primary, old, group)) if active.is_none() => (Some((primary, old, group)), None),
|
||||
Some(state) if active.is_some() => {
|
||||
let live = Some(state.clone());
|
||||
tracker.active = Some(state);
|
||||
(None, live)
|
||||
if started_edit {
|
||||
(None, None)
|
||||
} else {
|
||||
match tracker.active.take() {
|
||||
Some((primary, old, group)) if active.is_none() => {
|
||||
(Some((primary, old, group)), None)
|
||||
}
|
||||
Some(state) if active.is_some() => {
|
||||
let live = Some(state.clone());
|
||||
tracker.active = Some(state);
|
||||
(None, live)
|
||||
}
|
||||
_ => (None, None),
|
||||
}
|
||||
_ => (None, None),
|
||||
}
|
||||
};
|
||||
|
||||
if started_edit {
|
||||
set_transform_operator_status(
|
||||
world,
|
||||
OperatorPhase::Preview,
|
||||
"Transform gizmo drag in progress",
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
if let Some((primary, old_primary, group)) = live_edit {
|
||||
let Some(new_primary) = world.get::<Transform>(primary).copied() else {
|
||||
return;
|
||||
@@ -2653,14 +2750,50 @@ fn capture_gizmo_transform_edits(world: &mut World) {
|
||||
|
||||
if let Some((primary, old_primary, group)) = finished_edit {
|
||||
let Some(new_primary) = world.get::<Transform>(primary).copied() else {
|
||||
for (entity, old) in group {
|
||||
if let Some(mut transform) = world.get_mut::<Transform>(entity) {
|
||||
*transform = old;
|
||||
}
|
||||
}
|
||||
set_transform_operator_status(
|
||||
world,
|
||||
OperatorPhase::Canceled,
|
||||
"Transform target disappeared; surviving previews restored",
|
||||
);
|
||||
return;
|
||||
};
|
||||
let undo_depth = world.resource::<EditorHistory>().undo_depth();
|
||||
if group.len() <= 1 {
|
||||
set_transform_with_history(world, primary, old_primary, new_primary);
|
||||
return;
|
||||
} else {
|
||||
let changes = transform_group_changes(old_primary, new_primary, group);
|
||||
set_transform_group_with_history(world, changes);
|
||||
}
|
||||
let changes = transform_group_changes(old_primary, new_primary, group);
|
||||
set_transform_group_with_history(world, changes);
|
||||
if world.resource::<EditorHistory>().undo_depth() > undo_depth {
|
||||
set_transform_operator_status(
|
||||
world,
|
||||
OperatorPhase::Committed,
|
||||
"Transform gizmo edit committed",
|
||||
);
|
||||
} else {
|
||||
set_transform_operator_status(
|
||||
world,
|
||||
OperatorPhase::Canceled,
|
||||
"Transform gizmo edit made no changes",
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn set_transform_operator_status(world: &mut World, phase: OperatorPhase, hint: impl Into<String>) {
|
||||
if let Some(mut active) = world.get_resource_mut::<ActiveOperator>() {
|
||||
active.status = Some(OperatorStatus {
|
||||
id: "transform.gizmo".to_string(),
|
||||
label: "Transform Gizmo".to_string(),
|
||||
phase,
|
||||
hint: hint.into(),
|
||||
warnings: Vec::new(),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2738,32 +2871,15 @@ fn despawn_entity(world: &mut World, entity: Option<Entity>) {
|
||||
}
|
||||
|
||||
fn select_one(world: &mut World, entity: Entity) {
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
ui_state.selected_entities.clear();
|
||||
ui_state.selected_entities.select_replace(entity);
|
||||
}
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(entity);
|
||||
crate::ui::request_ui_selection(world, &[entity]);
|
||||
}
|
||||
|
||||
fn select_many(world: &mut World, entities: &[Entity]) {
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
ui_state.selected_entities.clear();
|
||||
for (index, entity) in entities.iter().enumerate() {
|
||||
if index == 0 {
|
||||
ui_state.selected_entities.select_replace(*entity);
|
||||
} else {
|
||||
ui_state.selected_entities.select_maybe_add(*entity, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
world.resource_mut::<SelectedEntity>().0 = entities.first().copied();
|
||||
crate::ui::request_ui_selection(world, entities);
|
||||
}
|
||||
|
||||
pub fn clear_selection(world: &mut World) {
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
ui_state.selected_entities.clear();
|
||||
}
|
||||
world.resource_mut::<SelectedEntity>().0 = None;
|
||||
crate::ui::request_ui_selection(world, &[]);
|
||||
}
|
||||
|
||||
pub fn is_level_object(world: &World, entity: Entity) -> bool {
|
||||
@@ -2804,7 +2920,29 @@ pub(crate) fn material_eq(a: &MaterialDesc, b: &MaterialDesc) -> bool {
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use crate::operators::{ActiveOperator, OperatorPhase, OperatorStatus};
|
||||
use crate::operators::{ActiveOperator, OperatorPhase};
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::PendingUiSelection;
|
||||
|
||||
#[test]
|
||||
fn history_select_many_queues_exact_selection_while_ui_state_is_scoped_out() {
|
||||
let first = Entity::from_bits(1);
|
||||
let second = Entity::from_bits(2);
|
||||
let mut world = World::new();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<PendingUiSelection>();
|
||||
world.insert_resource(UiState::default_layout());
|
||||
|
||||
world.resource_scope::<UiState, _>(|world, _ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
select_many(world, &[first, second]);
|
||||
assert_eq!(
|
||||
world.resource::<PendingUiSelection>().0.as_deref(),
|
||||
Some([first, second].as_slice())
|
||||
);
|
||||
assert_eq!(world.resource::<SelectedEntity>().0, Some(first));
|
||||
});
|
||||
}
|
||||
|
||||
#[derive(Component, Reflect, Default, Debug, Clone, PartialEq)]
|
||||
#[reflect(Component, Default)]
|
||||
@@ -3082,6 +3220,7 @@ mod tests {
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<TransformEditTracker>();
|
||||
let first = world.spawn((LevelObject, Transform::default())).id();
|
||||
let second = world
|
||||
.spawn((
|
||||
@@ -3093,30 +3232,19 @@ mod tests {
|
||||
let committed = vec![Vec3::Z, Vec3::new(2.0, 0.0, 1.0)];
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
set_transform_group_with_history(
|
||||
&mut world,
|
||||
[
|
||||
(
|
||||
first,
|
||||
Transform::default(),
|
||||
Transform::from_translation(committed[0]),
|
||||
),
|
||||
(
|
||||
second,
|
||||
Transform::from_translation(initial[1]),
|
||||
Transform::from_translation(committed[1]),
|
||||
),
|
||||
world.resource_mut::<TransformEditTracker>().active = Some((
|
||||
first,
|
||||
Transform::default(),
|
||||
vec![
|
||||
(first, Transform::default()),
|
||||
(second, Transform::from_translation(initial[1])),
|
||||
],
|
||||
);
|
||||
world.resource_mut::<ActiveOperator>().status = Some(OperatorStatus {
|
||||
id: "transform.gizmo".to_string(),
|
||||
label: "Transform Gizmo".to_string(),
|
||||
phase: OperatorPhase::Committed,
|
||||
hint: "Committed multi-selection drag".to_string(),
|
||||
warnings: Vec::new(),
|
||||
});
|
||||
));
|
||||
*world.get_mut::<Transform>(first).unwrap() = Transform::from_translation(committed[0]);
|
||||
capture_gizmo_transform_edits(&mut world);
|
||||
|
||||
harness.assert_committed(&mut world, 1, 0);
|
||||
harness.assert_status(&world, "transform.gizmo", OperatorPhase::Committed);
|
||||
assert_undo_redo_round_trip(&mut world, initial, committed, |world| {
|
||||
[first, second]
|
||||
.into_iter()
|
||||
@@ -3125,6 +3253,63 @@ mod tests {
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_op_transform_release_terminates_preview_without_history() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<TransformEditTracker>();
|
||||
let transform = Transform::from_xyz(1.0, 2.0, 3.0);
|
||||
let entity = world.spawn((LevelObject, transform)).id();
|
||||
world.resource_mut::<TransformEditTracker>().active =
|
||||
Some((entity, transform, vec![(entity, transform)]));
|
||||
set_transform_operator_status(
|
||||
&mut world,
|
||||
OperatorPhase::Preview,
|
||||
"Transform gizmo drag in progress",
|
||||
);
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
capture_gizmo_transform_edits(&mut world);
|
||||
|
||||
harness.assert_canceled(&mut world);
|
||||
harness.assert_status(&world, "transform.gizmo", OperatorPhase::Canceled);
|
||||
assert_eq!(world.get::<Transform>(entity), Some(&transform));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_primary_transform_rolls_back_surviving_preview_targets() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<TransformEditTracker>();
|
||||
let primary_old = Transform::from_xyz(1.0, 0.0, 0.0);
|
||||
let survivor_old = Transform::from_xyz(2.0, 0.0, 0.0);
|
||||
let primary = world.spawn((LevelObject, primary_old)).id();
|
||||
let survivor = world.spawn((LevelObject, survivor_old)).id();
|
||||
world.resource_mut::<TransformEditTracker>().active = Some((
|
||||
primary,
|
||||
primary_old,
|
||||
vec![(primary, primary_old), (survivor, survivor_old)],
|
||||
));
|
||||
*world.get_mut::<Transform>(survivor).unwrap() = Transform::from_xyz(8.0, 0.0, 0.0);
|
||||
world.despawn(primary);
|
||||
set_transform_operator_status(
|
||||
&mut world,
|
||||
OperatorPhase::Preview,
|
||||
"Transform gizmo drag in progress",
|
||||
);
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
|
||||
capture_gizmo_transform_edits(&mut world);
|
||||
|
||||
harness.assert_canceled(&mut world);
|
||||
harness.assert_status(&world, "transform.gizmo", OperatorPhase::Canceled);
|
||||
assert_eq!(world.get::<Transform>(survivor), Some(&survivor_old));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unpack_prefab_is_one_undoable_history_command() {
|
||||
let mut world = World::new();
|
||||
|
||||
@@ -27,8 +27,10 @@ pub use project::diagnostics_bundle;
|
||||
pub use project::launcher;
|
||||
pub use project::native_dialog;
|
||||
pub use project::project_io;
|
||||
pub use project::samples;
|
||||
pub use project::session;
|
||||
pub use project::settings_ui;
|
||||
pub use project::shutdown;
|
||||
pub use scene::scene_io;
|
||||
pub use scene::scene_schema;
|
||||
pub use scene::scene_view;
|
||||
@@ -39,10 +41,13 @@ pub use viewport::brush_tool;
|
||||
pub use viewport::camera;
|
||||
pub use viewport::gizmos;
|
||||
pub use viewport::material_drop;
|
||||
pub use viewport::physics_placement;
|
||||
pub use viewport::render_view;
|
||||
pub use viewport::rendering_diagnostics;
|
||||
pub use viewport::selection;
|
||||
pub use viewport::selection_outline;
|
||||
pub use viewport::terrain_paint;
|
||||
pub use viewport::terrain_sculpt;
|
||||
pub use viewport::visualizers;
|
||||
|
||||
use bevy::app::PluginGroupBuilder;
|
||||
@@ -66,10 +71,13 @@ use history::EditorHistoryPlugin;
|
||||
use infra::EditorInfraPlugin;
|
||||
use material_drop::MaterialDropPlugin;
|
||||
use operators::OperatorPlugin;
|
||||
use physics_placement::PhysicsPlacementPlugin;
|
||||
use play::audio_preview::AudioPreviewPlugin;
|
||||
use play::PlaySessionPlugin;
|
||||
use project::collaboration::CollaborationPlugin;
|
||||
use project::native_dialog::NativeDialogPlugin;
|
||||
use project::samples::SampleCatalogPlugin;
|
||||
use project::shutdown::ShutdownPlugin;
|
||||
use project_io::ProjectIoPlugin;
|
||||
use render_view::RenderViewPlugin;
|
||||
use scene_io::SceneIoPlugin;
|
||||
@@ -79,6 +87,8 @@ use selection_outline::SelectionOutlinePlugin;
|
||||
use session::EditorSessionPlugin;
|
||||
use settings_ui::SettingsUiPlugin;
|
||||
use state::EditorStatePlugin;
|
||||
use terrain_paint::TerrainPaintPlugin;
|
||||
use terrain_sculpt::TerrainSculptPlugin;
|
||||
use ui::EditorUiPlugin;
|
||||
use viewport::ViewportPlugin;
|
||||
use visualizers::EditorVisualizersPlugin;
|
||||
@@ -92,7 +102,9 @@ impl PluginGroup for EditorPluginGroup {
|
||||
let group = PluginGroupBuilder::start::<Self>()
|
||||
.add(EditorInfraPlugin)
|
||||
.add(ProjectIoPlugin)
|
||||
.add(SampleCatalogPlugin)
|
||||
.add(NativeDialogPlugin)
|
||||
.add(ShutdownPlugin)
|
||||
.add(scene_schema::SceneSchemaPlugin)
|
||||
.add(net_editor::NetEditorPlugin)
|
||||
.add(AssetDbPlugin)
|
||||
@@ -109,10 +121,13 @@ impl PluginGroup for EditorPluginGroup {
|
||||
.add(BrushCsgPlugin)
|
||||
.add(BrushEditPlugin)
|
||||
.add(BrushToolPlugin)
|
||||
.add(TerrainSculptPlugin)
|
||||
.add(TerrainPaintPlugin)
|
||||
.add(EditorCameraPlugin)
|
||||
.add(AudioPreviewPlugin)
|
||||
.add(ActorIconsPlugin)
|
||||
.add(MaterialDropPlugin)
|
||||
.add(PhysicsPlacementPlugin)
|
||||
.add(EditorSelectionPlugin)
|
||||
.add(SelectionOutlinePlugin)
|
||||
.add(EditorGizmoPlugin)
|
||||
@@ -131,7 +146,7 @@ impl PluginGroup for EditorPluginGroup {
|
||||
|
||||
/// Shared Bevy app wiring for the in-process editor (game sim + egui shell).
|
||||
pub fn configure_editor_app(app: &mut App) {
|
||||
app.add_plugins(launch::default_plugins("Bevy FPS Editor"))
|
||||
app.add_plugins(launch::editor_plugins("Bevy FPS Editor"))
|
||||
.insert_resource(GameInputEnabled(false))
|
||||
.insert_resource(GameInputFocused(false))
|
||||
.insert_resource(SimEnabled(false))
|
||||
|
||||
@@ -59,6 +59,12 @@ pub enum OperatorAvailability {
|
||||
Disabled(String),
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum OperatorAction {
|
||||
Commit,
|
||||
ContinuePreview,
|
||||
}
|
||||
|
||||
pub trait EditorOperator {
|
||||
fn id(&self) -> &str;
|
||||
fn label(&self) -> &str;
|
||||
@@ -221,6 +227,51 @@ pub fn run_immediate_operator(
|
||||
run_operator(world, &mut operator)
|
||||
}
|
||||
|
||||
/// Runs an editor command that may either complete immediately or hand ownership to a modal tool.
|
||||
/// Modal starters retain the preview status installed by their production entry point.
|
||||
pub fn run_operator_action(
|
||||
world: &mut World,
|
||||
id: &str,
|
||||
label: &str,
|
||||
availability: OperatorAvailability,
|
||||
action: impl FnOnce(&mut World) -> Result<OperatorAction, String>,
|
||||
) -> bool {
|
||||
if let OperatorAvailability::Disabled(reason) = availability {
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorStatus::new(id, label, OperatorPhase::Blocked, reason),
|
||||
);
|
||||
return false;
|
||||
}
|
||||
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorStatus::new(id, label, OperatorPhase::Preview, "Starting"),
|
||||
);
|
||||
match action(world) {
|
||||
Ok(OperatorAction::Commit) => {
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorStatus::new(
|
||||
id,
|
||||
label,
|
||||
OperatorPhase::Committed,
|
||||
format!("Completed {label}"),
|
||||
),
|
||||
);
|
||||
true
|
||||
}
|
||||
Ok(OperatorAction::ContinuePreview) => true,
|
||||
Err(error) => {
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorStatus::new(id, label, OperatorPhase::Canceled, error),
|
||||
);
|
||||
false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn set_operator_status(world: &mut World, status: OperatorStatus) {
|
||||
if let Some(mut active) = world.get_resource_mut::<ActiveOperator>() {
|
||||
active.status = Some(status);
|
||||
@@ -355,6 +406,52 @@ mod tests {
|
||||
harness.assert_no_helpers::<PreviewHelper>(&mut world);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn preview_failure_runs_cancel_and_cleans_helpers() {
|
||||
struct PreviewFailure(CounterOperator);
|
||||
|
||||
impl EditorOperator for PreviewFailure {
|
||||
fn id(&self) -> &str {
|
||||
self.0.id()
|
||||
}
|
||||
|
||||
fn label(&self) -> &str {
|
||||
self.0.label()
|
||||
}
|
||||
|
||||
fn begin(&mut self, world: &mut World) -> Result<(), String> {
|
||||
self.0.begin(world)
|
||||
}
|
||||
|
||||
fn preview(&mut self, world: &mut World) -> Result<(), String> {
|
||||
self.0.preview(world)?;
|
||||
Err("preview failed".to_string())
|
||||
}
|
||||
|
||||
fn commit(&mut self, _world: &mut World) -> Result<(), String> {
|
||||
panic!("commit must not run after preview failure")
|
||||
}
|
||||
|
||||
fn cancel(&mut self, world: &mut World) {
|
||||
self.0.cancel(world);
|
||||
}
|
||||
}
|
||||
|
||||
let mut world = test_world();
|
||||
let harness = OperatorInvariantHarness::capture(&mut world);
|
||||
let mut operator = PreviewFailure(CounterOperator {
|
||||
before: 0,
|
||||
helper: None,
|
||||
});
|
||||
|
||||
assert!(!run_operator(&mut world, &mut operator));
|
||||
|
||||
harness.assert_canceled(&mut world);
|
||||
harness.assert_status(&world, "test.counter", OperatorPhase::Canceled);
|
||||
harness.assert_no_helpers::<PreviewHelper>(&mut world);
|
||||
assert_eq!(world.resource::<Counter>().0, 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn blocked_operator_never_begins_or_mutates_world() {
|
||||
let mut world = test_world();
|
||||
|
||||
@@ -47,6 +47,12 @@ impl OperatorInvariantHarness {
|
||||
world.resource::<SceneIo>().dirty,
|
||||
"a committed authored mutation must mark the scene dirty"
|
||||
);
|
||||
} else {
|
||||
assert_eq!(
|
||||
world.resource::<SceneIo>().dirty,
|
||||
self.dirty,
|
||||
"a committed non-authoring operator must preserve the prior dirty state"
|
||||
);
|
||||
}
|
||||
assert_eq!(
|
||||
authored_count(world) as isize,
|
||||
@@ -93,6 +99,39 @@ impl OperatorInvariantHarness {
|
||||
);
|
||||
}
|
||||
|
||||
pub(crate) fn assert_status(
|
||||
&self,
|
||||
world: &World,
|
||||
expected_id: &str,
|
||||
expected_phase: OperatorPhase,
|
||||
) {
|
||||
let status = world
|
||||
.resource::<ActiveOperator>()
|
||||
.status
|
||||
.as_ref()
|
||||
.expect("operator must retain an inspectable lifecycle status");
|
||||
assert_eq!(status.id, expected_id, "operator reported the wrong id");
|
||||
assert_eq!(
|
||||
status.phase, expected_phase,
|
||||
"operator reported the wrong phase"
|
||||
);
|
||||
}
|
||||
|
||||
pub(crate) fn assert_projection_unchanged<T>(
|
||||
&self,
|
||||
world: &mut World,
|
||||
expected: T,
|
||||
mut read: impl FnMut(&mut World) -> T,
|
||||
) where
|
||||
T: Debug + PartialEq,
|
||||
{
|
||||
assert_eq!(
|
||||
read(world),
|
||||
expected,
|
||||
"operator changed authored state without a committed history transaction"
|
||||
);
|
||||
}
|
||||
|
||||
fn assert_phase(&self, world: &World, expected: OperatorPhase) {
|
||||
let phase = world
|
||||
.resource::<ActiveOperator>()
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
use std::time::Duration;
|
||||
|
||||
use avian3d::prelude::{Physics, PhysicsTime};
|
||||
use bevy::prelude::*;
|
||||
use bevy::window::{CursorGrabMode, CursorOptions, PrimaryWindow};
|
||||
use bevy_egui::PrimaryEguiContext;
|
||||
use game::player::PlayerCamera;
|
||||
use game::{GameInputEnabled, GameInputFocused, SimEnabled};
|
||||
use protocol::PlayerInputIntent;
|
||||
use protocol::{PlayerInputIntent, SIM_TICK_RATE_HZ};
|
||||
use sim::{Crouching, Grounded, JumpState, Player, PlayerVelocity};
|
||||
|
||||
use crate::camera::EditorCamera;
|
||||
@@ -195,6 +198,7 @@ pub(crate) fn sync_mode_resources_and_cameras(
|
||||
mut step: ResMut<PlayStepOnce>,
|
||||
mut input_enabled: ResMut<GameInputEnabled>,
|
||||
mut sim_enabled: ResMut<SimEnabled>,
|
||||
mut physics_time: ResMut<Time<Physics>>,
|
||||
mut editor_cameras: Query<&mut Camera, With<EditorCamera>>,
|
||||
mut player_cameras: Query<&mut Camera, (With<PlayerCamera>, Without<EditorCamera>)>,
|
||||
mut egui_cameras: Query<
|
||||
@@ -212,9 +216,11 @@ pub(crate) fn sync_mode_resources_and_cameras(
|
||||
let ejected = playing && *possession == PlayPossession::Ejected;
|
||||
let possessed = playing && *possession == PlayPossession::Possessed;
|
||||
|
||||
sim_enabled.0 = playing && (!paused.0 || step.0);
|
||||
let stepping = step.0;
|
||||
sim_enabled.0 = playing && (!paused.0 || stepping);
|
||||
input_enabled.0 = possessed && !paused.0;
|
||||
if step.0 {
|
||||
sync_editor_physics_clock(&mut physics_time, playing, paused.0, stepping);
|
||||
if stepping {
|
||||
step.0 = false;
|
||||
}
|
||||
|
||||
@@ -240,6 +246,22 @@ pub(crate) fn sync_mode_resources_and_cameras(
|
||||
}
|
||||
}
|
||||
|
||||
fn sync_editor_physics_clock(
|
||||
physics_time: &mut Time<Physics>,
|
||||
playing: bool,
|
||||
paused: bool,
|
||||
stepping: bool,
|
||||
) {
|
||||
if playing && !paused {
|
||||
physics_time.unpause();
|
||||
return;
|
||||
}
|
||||
physics_time.pause();
|
||||
if playing && stepping {
|
||||
physics_time.advance_by(Duration::from_secs_f64(1.0 / SIM_TICK_RATE_HZ as f64));
|
||||
}
|
||||
}
|
||||
|
||||
fn sync_play_input_focus(
|
||||
mode: Res<State<EditorMode>>,
|
||||
possession: Res<PlayPossession>,
|
||||
@@ -414,3 +436,29 @@ pub fn toggle_play_possession_world(world: &mut World) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn editor_physics_clock_tracks_edit_play_pause_and_single_step() {
|
||||
let mut time = Time::<Physics>::default();
|
||||
|
||||
sync_editor_physics_clock(&mut time, false, false, false);
|
||||
assert!(time.is_paused());
|
||||
|
||||
sync_editor_physics_clock(&mut time, true, false, false);
|
||||
assert!(!time.is_paused());
|
||||
|
||||
sync_editor_physics_clock(&mut time, true, true, false);
|
||||
assert!(time.is_paused());
|
||||
|
||||
sync_editor_physics_clock(&mut time, true, true, true);
|
||||
assert!(time.is_paused());
|
||||
assert_eq!(
|
||||
time.delta(),
|
||||
Duration::from_secs_f64(1.0 / SIM_TICK_RATE_HZ as f64)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -5,5 +5,7 @@ pub mod diagnostics_bundle;
|
||||
pub mod launcher;
|
||||
pub mod native_dialog;
|
||||
pub mod project_io;
|
||||
pub mod samples;
|
||||
pub mod session;
|
||||
pub mod settings_ui;
|
||||
pub mod shutdown;
|
||||
@@ -0,0 +1,208 @@
|
||||
//! Cached project sample catalog used by editor scene-opening UI.
|
||||
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use bevy::prelude::*;
|
||||
use scene::sample_pack::{
|
||||
validate_editor_sample_pack, EditorSampleEntry, EDITOR_SAMPLE_MANIFEST_PATH,
|
||||
};
|
||||
|
||||
use super::project_io::ProjectWorkspace;
|
||||
|
||||
const VALIDATION_HINT: &str = "Run `cargo validate-samples --project .` for details.";
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct SampleCatalogEntry {
|
||||
pub id: String,
|
||||
pub label: String,
|
||||
pub scene_path: PathBuf,
|
||||
pub project_relative_scene: String,
|
||||
pub summary: String,
|
||||
pub checks: Vec<String>,
|
||||
}
|
||||
|
||||
impl SampleCatalogEntry {
|
||||
pub fn hover_text(&self) -> String {
|
||||
let mut lines = vec![self.summary.clone()];
|
||||
if !self.checks.is_empty() {
|
||||
lines.push(format!("Checks: {}", self.checks.join(", ")));
|
||||
}
|
||||
lines.push(self.project_relative_scene.clone());
|
||||
lines.join("\n")
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Resource, Debug, Clone)]
|
||||
pub struct SampleCatalog {
|
||||
entries: Vec<SampleCatalogEntry>,
|
||||
unavailable_reason: Option<String>,
|
||||
}
|
||||
|
||||
impl Default for SampleCatalog {
|
||||
fn default() -> Self {
|
||||
Self::unavailable("Sample catalog is loading")
|
||||
}
|
||||
}
|
||||
|
||||
impl SampleCatalog {
|
||||
pub fn entries(&self) -> &[SampleCatalogEntry] {
|
||||
&self.entries
|
||||
}
|
||||
|
||||
pub fn entry(&self, stable_id: &str) -> Option<&SampleCatalogEntry> {
|
||||
self.unavailable_reason
|
||||
.is_none()
|
||||
.then(|| self.entries.iter().find(|entry| entry.id == stable_id))
|
||||
.flatten()
|
||||
}
|
||||
|
||||
pub fn unavailable_reason(&self) -> Option<&str> {
|
||||
self.unavailable_reason.as_deref()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn available_entries(entries: Vec<SampleCatalogEntry>) -> Self {
|
||||
Self {
|
||||
entries,
|
||||
unavailable_reason: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn available(samples: Vec<EditorSampleEntry>) -> Self {
|
||||
Self {
|
||||
entries: samples.into_iter().map(catalog_entry).collect(),
|
||||
unavailable_reason: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn unavailable(reason: impl Into<String>) -> Self {
|
||||
Self {
|
||||
entries: Vec::new(),
|
||||
unavailable_reason: Some(reason.into()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn catalog_entry(entry: EditorSampleEntry) -> SampleCatalogEntry {
|
||||
SampleCatalogEntry {
|
||||
id: entry.id,
|
||||
label: entry.label,
|
||||
scene_path: PathBuf::from(&entry.scene),
|
||||
project_relative_scene: entry.scene,
|
||||
summary: entry.summary,
|
||||
checks: entry.checks,
|
||||
}
|
||||
}
|
||||
|
||||
fn load_catalog(project_root: &Path) -> SampleCatalog {
|
||||
let validation = validate_editor_sample_pack(project_root);
|
||||
if !validation.is_release_ready() {
|
||||
let first_error = validation
|
||||
.report
|
||||
.findings
|
||||
.iter()
|
||||
.find(|finding| finding.severity == scene::ValidationSeverity::Error)
|
||||
.map(|finding| finding.message.as_str())
|
||||
.unwrap_or("sample pack validation failed");
|
||||
return SampleCatalog::unavailable(format!(
|
||||
"Sample manifest `{EDITOR_SAMPLE_MANIFEST_PATH}` is invalid: {first_error}\n{VALIDATION_HINT}"
|
||||
));
|
||||
}
|
||||
if validation.samples.is_empty() {
|
||||
return SampleCatalog::unavailable(format!(
|
||||
"Sample manifest contains no scenes.\n{VALIDATION_HINT}"
|
||||
));
|
||||
}
|
||||
SampleCatalog::available(validation.samples)
|
||||
}
|
||||
|
||||
fn load_sample_catalog(world: &mut World) {
|
||||
let project_root = PathBuf::from(&world.resource::<ProjectWorkspace>().root);
|
||||
world.insert_resource(load_catalog(&project_root));
|
||||
}
|
||||
|
||||
pub struct SampleCatalogPlugin;
|
||||
|
||||
impl Plugin for SampleCatalogPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.init_resource::<SampleCatalog>()
|
||||
.add_systems(Startup, load_sample_catalog);
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use scene::sample_pack::EditorSampleArea;
|
||||
|
||||
fn sample(id: &str, label: &str, scene: &str) -> EditorSampleEntry {
|
||||
EditorSampleEntry {
|
||||
id: id.into(),
|
||||
label: label.into(),
|
||||
area: EditorSampleArea::Brush,
|
||||
scene: scene.into(),
|
||||
summary: format!("Summary for {label}"),
|
||||
checks: vec!["selection".into(), "undo".into()],
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn available_catalog_preserves_manifest_order_and_resolves_paths() {
|
||||
let catalog = SampleCatalog::available(vec![
|
||||
sample(
|
||||
"terrain",
|
||||
"Terrain",
|
||||
"assets/levels/samples/terrain.scn.ron",
|
||||
),
|
||||
sample("brush", "Brush", "assets/levels/samples/brush.scn.ron"),
|
||||
]);
|
||||
|
||||
assert_eq!(
|
||||
catalog
|
||||
.entries()
|
||||
.iter()
|
||||
.map(|entry| entry.id.as_str())
|
||||
.collect::<Vec<_>>(),
|
||||
vec!["terrain", "brush"]
|
||||
);
|
||||
assert_eq!(
|
||||
catalog.entry("brush").unwrap().scene_path,
|
||||
PathBuf::from("assets/levels/samples/brush.scn.ron")
|
||||
);
|
||||
let hover = catalog.entry("brush").unwrap().hover_text();
|
||||
assert!(hover.contains("Summary for Brush"));
|
||||
assert!(hover.contains("Checks: selection, undo"));
|
||||
assert!(hover.contains("assets/levels/samples/brush.scn.ron"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unavailable_catalog_never_resolves_entries() {
|
||||
let catalog = SampleCatalog {
|
||||
entries: vec![catalog_entry(sample(
|
||||
"brush",
|
||||
"Brush",
|
||||
"assets/levels/samples/brush.scn.ron",
|
||||
))],
|
||||
unavailable_reason: Some("manifest invalid".into()),
|
||||
};
|
||||
|
||||
assert!(catalog.entry("brush").is_none());
|
||||
assert_eq!(catalog.unavailable_reason(), Some("manifest invalid"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_manifest_reports_repair_command() {
|
||||
let root = std::env::temp_dir().join(format!(
|
||||
"blacksite-missing-sample-catalog-{}",
|
||||
uuid::Uuid::new_v4()
|
||||
));
|
||||
std::fs::create_dir_all(&root).unwrap();
|
||||
|
||||
let catalog = load_catalog(&root);
|
||||
|
||||
let reason = catalog.unavailable_reason().unwrap();
|
||||
assert!(reason.contains(EDITOR_SAMPLE_MANIFEST_PATH));
|
||||
assert!(reason.contains("cargo validate-samples --project ."));
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,7 @@ use crate::project_io::{ProjectWorkspace, UserPreferences};
|
||||
use crate::scene::recovery::{atomic_write, default_state_root};
|
||||
use crate::scene_io::{SceneIo, SceneIoRequest};
|
||||
use crate::settings_ui::ProjectSettingsPanel;
|
||||
use crate::shutdown::ShutdownCoordinator;
|
||||
use crate::ui::{BrushDiagnosticsPanel, DiagnosticsPanel};
|
||||
use crate::viewport::rendering_diagnostics::RenderingDiagnosticsPanel;
|
||||
use crate::viewport::CameraBookmarks;
|
||||
@@ -109,8 +110,8 @@ impl Plugin for EditorSessionPlugin {
|
||||
.add_systems(Startup, initialize_session)
|
||||
.add_systems(Update, persist_running_session)
|
||||
.add_systems(
|
||||
Last,
|
||||
persist_clean_session_on_exit.after(bevy::window::ExitSystems),
|
||||
crate::shutdown::EditorShutdownFinalize,
|
||||
persist_clean_session_on_exit.after(crate::shutdown::finalize_authorized_shutdown),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -311,6 +312,7 @@ fn persist_running_session(world: &mut World) {
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn persist_clean_session_on_exit(
|
||||
mut exits: MessageReader<AppExit>,
|
||||
shutdown: Option<Res<ShutdownCoordinator>>,
|
||||
scene_io: Res<SceneIo>,
|
||||
workspace: Res<ProjectWorkspace>,
|
||||
prefs: Res<UserPreferences>,
|
||||
@@ -323,6 +325,10 @@ fn persist_clean_session_on_exit(
|
||||
if exits.read().next().is_none() {
|
||||
return;
|
||||
}
|
||||
if !shutdown.is_some_and(|shutdown| shutdown.authorized_exit_sent()) {
|
||||
warn!("Ignoring an unauthorized AppExit for clean-session persistence");
|
||||
return;
|
||||
}
|
||||
let Some(path) = session_path() else {
|
||||
return;
|
||||
};
|
||||
|
||||
@@ -0,0 +1,752 @@
|
||||
//! Guarded editor shutdown and the handoff to scene persistence.
|
||||
|
||||
use bevy::app::{AppExit, MainScheduleOrder};
|
||||
use bevy::ecs::schedule::ScheduleLabel;
|
||||
use bevy::prelude::*;
|
||||
use bevy::window::{PrimaryWindow, WindowCloseRequested};
|
||||
|
||||
use crate::native_dialog::NativeDialogBroker;
|
||||
use crate::scene_io::SceneIo;
|
||||
|
||||
const SAVE_ALL_LABEL: &str = "Save All";
|
||||
const DISCARD_LABEL: &str = "Discard";
|
||||
const CANCEL_LABEL: &str = "Cancel";
|
||||
|
||||
/// The user or editor surface that initiated a guarded shutdown.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum ShutdownSource {
|
||||
NativeWindow,
|
||||
FileMenu,
|
||||
Programmatic,
|
||||
SwitchProject,
|
||||
}
|
||||
|
||||
/// Observable state of the single editor shutdown flow.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
||||
pub enum ShutdownIntent {
|
||||
#[default]
|
||||
Idle,
|
||||
WaitingForBroker {
|
||||
source: ShutdownSource,
|
||||
},
|
||||
Confirming {
|
||||
source: ShutdownSource,
|
||||
},
|
||||
Saving {
|
||||
source: ShutdownSource,
|
||||
},
|
||||
Authorized {
|
||||
source: ShutdownSource,
|
||||
require_clean_scenes: bool,
|
||||
},
|
||||
ExitSent {
|
||||
source: ShutdownSource,
|
||||
},
|
||||
}
|
||||
|
||||
impl ShutdownIntent {
|
||||
pub fn source(self) -> Option<ShutdownSource> {
|
||||
match self {
|
||||
Self::Idle => None,
|
||||
Self::WaitingForBroker { source }
|
||||
| Self::Confirming { source }
|
||||
| Self::Saving { source }
|
||||
| Self::Authorized { source, .. }
|
||||
| Self::ExitSent { source } => Some(source),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Coordinates all editor exit requests so only an authorized flow emits [`AppExit`].
|
||||
#[derive(Resource, Debug, Default)]
|
||||
pub struct ShutdownCoordinator {
|
||||
intent: ShutdownIntent,
|
||||
coalesced_requests: u32,
|
||||
last_blocker: Option<String>,
|
||||
}
|
||||
|
||||
impl ShutdownCoordinator {
|
||||
pub fn intent(&self) -> ShutdownIntent {
|
||||
self.intent
|
||||
}
|
||||
|
||||
pub fn coalesced_requests(&self) -> u32 {
|
||||
self.coalesced_requests
|
||||
}
|
||||
|
||||
pub fn last_blocker(&self) -> Option<&str> {
|
||||
self.last_blocker.as_deref()
|
||||
}
|
||||
|
||||
pub fn authorized_exit_sent(&self) -> bool {
|
||||
matches!(self.intent, ShutdownIntent::ExitSent { .. })
|
||||
}
|
||||
|
||||
/// Queue a shutdown if no shutdown flow is already active.
|
||||
///
|
||||
/// Repeated window, menu, or programmatic requests are coalesced until the
|
||||
/// current flow is cancelled, fails to save, or sends the authorized exit.
|
||||
pub fn request(&mut self, source: ShutdownSource) -> bool {
|
||||
if self.intent != ShutdownIntent::Idle {
|
||||
self.coalesced_requests = self.coalesced_requests.saturating_add(1);
|
||||
return false;
|
||||
}
|
||||
self.intent = ShutdownIntent::WaitingForBroker { source };
|
||||
self.coalesced_requests = 0;
|
||||
self.last_blocker = None;
|
||||
true
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
pub(crate) fn set_intent_for_test(&mut self, intent: ShutdownIntent) {
|
||||
self.intent = intent;
|
||||
}
|
||||
}
|
||||
|
||||
/// Emitted once when the guarded dialog chooses `Save All`.
|
||||
///
|
||||
/// Scene persistence owns the actual save sequence and must finish it with
|
||||
/// [`complete_shutdown_save`].
|
||||
#[derive(Message, Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct ShutdownSaveAllRequested {
|
||||
pub source: ShutdownSource,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub enum ShutdownSaveOutcome {
|
||||
Saved,
|
||||
Cancelled,
|
||||
Failed(String),
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum ShutdownDecision {
|
||||
SaveAll,
|
||||
Discard,
|
||||
Cancel,
|
||||
}
|
||||
|
||||
/// Runs after Bevy's `Last` schedule so no editor authoring system can mutate
|
||||
/// a document after the final dirty-state check in the same frame.
|
||||
#[derive(ScheduleLabel, Debug, Clone, PartialEq, Eq, Hash)]
|
||||
pub struct EditorShutdownFinalize;
|
||||
|
||||
/// Queue a guarded shutdown from an exclusive-world UI or workflow callback.
|
||||
pub fn request_editor_shutdown(world: &mut World, source: ShutdownSource) -> bool {
|
||||
world
|
||||
.get_resource_mut::<ShutdownCoordinator>()
|
||||
.is_some_and(|mut coordinator| coordinator.request(source))
|
||||
}
|
||||
|
||||
/// Queue a project-browser handoff through the same dirty-document guard as editor exit.
|
||||
pub fn request_project_switch(world: &mut World) -> bool {
|
||||
request_editor_shutdown(world, ShutdownSource::SwitchProject)
|
||||
}
|
||||
|
||||
/// Resolve the dirty-scene confirmation through the shared coordinator.
|
||||
pub fn resolve_shutdown_decision(world: &mut World, decision: ShutdownDecision) -> bool {
|
||||
let (save_request, status) = {
|
||||
let Some(mut coordinator) = world.get_resource_mut::<ShutdownCoordinator>() else {
|
||||
return false;
|
||||
};
|
||||
let ShutdownIntent::Confirming { source } = coordinator.intent else {
|
||||
return false;
|
||||
};
|
||||
match decision {
|
||||
ShutdownDecision::SaveAll => {
|
||||
coordinator.intent = ShutdownIntent::Saving { source };
|
||||
(
|
||||
Some(source),
|
||||
Some("Saving all modified scene tabs before shutdown"),
|
||||
)
|
||||
}
|
||||
ShutdownDecision::Discard => {
|
||||
coordinator.intent = ShutdownIntent::Authorized {
|
||||
source,
|
||||
require_clean_scenes: false,
|
||||
};
|
||||
(None, None)
|
||||
}
|
||||
ShutdownDecision::Cancel => {
|
||||
coordinator.intent = ShutdownIntent::Idle;
|
||||
(
|
||||
None,
|
||||
Some("Shutdown cancelled; unsaved scene tabs retained"),
|
||||
)
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
if let Some(status) = status {
|
||||
if let Some(mut scene_io) = world.get_resource_mut::<SceneIo>() {
|
||||
scene_io.set_status(status);
|
||||
}
|
||||
}
|
||||
if let Some(source) = save_request {
|
||||
world.write_message(ShutdownSaveAllRequested { source });
|
||||
}
|
||||
true
|
||||
}
|
||||
|
||||
/// Finish the save-all handoff. A reported success is authorized only after
|
||||
/// every scene tab is observably clean.
|
||||
pub fn complete_shutdown_save(world: &mut World, outcome: ShutdownSaveOutcome) -> bool {
|
||||
let scenes_are_clean = !scene_has_unsaved_changes(world);
|
||||
let Some(mut coordinator) = world.get_resource_mut::<ShutdownCoordinator>() else {
|
||||
return false;
|
||||
};
|
||||
let ShutdownIntent::Saving { source } = coordinator.intent else {
|
||||
return false;
|
||||
};
|
||||
|
||||
match outcome {
|
||||
ShutdownSaveOutcome::Saved if scenes_are_clean => {
|
||||
coordinator.intent = ShutdownIntent::Authorized {
|
||||
source,
|
||||
require_clean_scenes: true,
|
||||
};
|
||||
coordinator.last_blocker = None;
|
||||
true
|
||||
}
|
||||
ShutdownSaveOutcome::Saved => {
|
||||
coordinator.intent = ShutdownIntent::Idle;
|
||||
coordinator.last_blocker =
|
||||
Some("Save All completed while unsaved scene tabs remain".into());
|
||||
false
|
||||
}
|
||||
ShutdownSaveOutcome::Cancelled => {
|
||||
coordinator.intent = ShutdownIntent::Idle;
|
||||
coordinator.last_blocker = None;
|
||||
false
|
||||
}
|
||||
ShutdownSaveOutcome::Failed(error) => {
|
||||
coordinator.intent = ShutdownIntent::Idle;
|
||||
coordinator.last_blocker = Some(error);
|
||||
false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub struct ShutdownPlugin;
|
||||
|
||||
impl Plugin for ShutdownPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.init_schedule(EditorShutdownFinalize);
|
||||
app.world_mut()
|
||||
.resource_mut::<MainScheduleOrder>()
|
||||
.insert_after(Last, EditorShutdownFinalize);
|
||||
app.init_resource::<ShutdownCoordinator>()
|
||||
.add_message::<ShutdownSaveAllRequested>()
|
||||
.add_systems(
|
||||
Update,
|
||||
(capture_native_close_requests, drive_shutdown).chain(),
|
||||
)
|
||||
.add_systems(EditorShutdownFinalize, finalize_authorized_shutdown);
|
||||
}
|
||||
}
|
||||
|
||||
fn capture_native_close_requests(
|
||||
mut commands: Commands,
|
||||
mut close_requests: MessageReader<WindowCloseRequested>,
|
||||
primary_window: Query<Entity, With<PrimaryWindow>>,
|
||||
mut coordinator: ResMut<ShutdownCoordinator>,
|
||||
) {
|
||||
let Ok(primary_window) = primary_window.single() else {
|
||||
return;
|
||||
};
|
||||
for request in close_requests.read() {
|
||||
if request.window == primary_window {
|
||||
coordinator.request(ShutdownSource::NativeWindow);
|
||||
} else {
|
||||
commands.entity(request.window).despawn();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn drive_shutdown(world: &mut World) {
|
||||
let intent = world.resource::<ShutdownCoordinator>().intent;
|
||||
match intent {
|
||||
ShutdownIntent::Idle
|
||||
| ShutdownIntent::Confirming { .. }
|
||||
| ShutdownIntent::Saving { .. }
|
||||
| ShutdownIntent::ExitSent { .. } => {}
|
||||
ShutdownIntent::WaitingForBroker { source } => {
|
||||
let unsaved_count = unsaved_scene_count(world);
|
||||
if unsaved_count == 0 {
|
||||
world.resource_mut::<ShutdownCoordinator>().intent = ShutdownIntent::Authorized {
|
||||
source,
|
||||
require_clean_scenes: true,
|
||||
};
|
||||
return;
|
||||
}
|
||||
if world.resource::<NativeDialogBroker>().is_pending() {
|
||||
return;
|
||||
}
|
||||
|
||||
let action = if source == ShutdownSource::SwitchProject {
|
||||
"switching projects"
|
||||
} else {
|
||||
"quitting"
|
||||
};
|
||||
let description = if unsaved_count == 1 {
|
||||
format!("One scene tab has unsaved changes. Save it before {action}?")
|
||||
} else {
|
||||
format!(
|
||||
"{unsaved_count} scene tabs have unsaved changes. Save all before {action}?"
|
||||
)
|
||||
};
|
||||
let title = if source == ShutdownSource::SwitchProject {
|
||||
"Switch Project"
|
||||
} else {
|
||||
"Quit Blacksite Editor"
|
||||
};
|
||||
let request = world.resource::<NativeDialogBroker>().request(
|
||||
move || {
|
||||
rfd::MessageDialog::new()
|
||||
.set_title(title)
|
||||
.set_description(description)
|
||||
.set_level(rfd::MessageLevel::Warning)
|
||||
.set_buttons(rfd::MessageButtons::YesNoCancelCustom(
|
||||
SAVE_ALL_LABEL.into(),
|
||||
DISCARD_LABEL.into(),
|
||||
CANCEL_LABEL.into(),
|
||||
))
|
||||
.show()
|
||||
},
|
||||
|world, result| {
|
||||
resolve_shutdown_decision(world, decision_from_dialog(result));
|
||||
},
|
||||
);
|
||||
if request.is_ok() {
|
||||
world.resource_mut::<ShutdownCoordinator>().intent =
|
||||
ShutdownIntent::Confirming { source };
|
||||
}
|
||||
}
|
||||
ShutdownIntent::Authorized { .. } => {}
|
||||
}
|
||||
}
|
||||
|
||||
/// Final dirty-state recheck after editor UI and authoring schedules have completed.
|
||||
pub(crate) fn finalize_authorized_shutdown(world: &mut World) {
|
||||
let (source, require_clean_scenes) = {
|
||||
let coordinator = world.resource::<ShutdownCoordinator>();
|
||||
let ShutdownIntent::Authorized {
|
||||
source,
|
||||
require_clean_scenes,
|
||||
} = coordinator.intent
|
||||
else {
|
||||
return;
|
||||
};
|
||||
(source, require_clean_scenes)
|
||||
};
|
||||
if require_clean_scenes && scene_has_unsaved_changes(world) {
|
||||
world.resource_mut::<ShutdownCoordinator>().intent =
|
||||
ShutdownIntent::WaitingForBroker { source };
|
||||
return;
|
||||
}
|
||||
if source == ShutdownSource::SwitchProject {
|
||||
if let Err(error) = crate::launcher::spawn_project_launcher_process() {
|
||||
let message = format!("Switch project failed: {error}");
|
||||
{
|
||||
let mut coordinator = world.resource_mut::<ShutdownCoordinator>();
|
||||
coordinator.intent = ShutdownIntent::Idle;
|
||||
coordinator.last_blocker = Some(message.clone());
|
||||
}
|
||||
if let Some(mut scene_io) = world.get_resource_mut::<SceneIo>() {
|
||||
scene_io.set_status(message);
|
||||
}
|
||||
return;
|
||||
}
|
||||
}
|
||||
world.resource_mut::<ShutdownCoordinator>().intent = ShutdownIntent::ExitSent { source };
|
||||
debug!(?source, "Editor shutdown authorized");
|
||||
world.write_message(AppExit::Success);
|
||||
}
|
||||
|
||||
fn scene_has_unsaved_changes(world: &World) -> bool {
|
||||
world
|
||||
.get_resource::<SceneIo>()
|
||||
.is_some_and(SceneIo::has_unsaved_tabs)
|
||||
}
|
||||
|
||||
fn unsaved_scene_count(world: &World) -> usize {
|
||||
let Some(scene_io) = world.get_resource::<SceneIo>() else {
|
||||
return 0;
|
||||
};
|
||||
let tab_count = scene_io.tabs.iter().filter(|tab| tab.dirty).count();
|
||||
if scene_io.dirty
|
||||
&& scene_io
|
||||
.tabs
|
||||
.get(scene_io.active_tab)
|
||||
.is_none_or(|tab| !tab.dirty)
|
||||
{
|
||||
tab_count + 1
|
||||
} else {
|
||||
tab_count
|
||||
}
|
||||
}
|
||||
|
||||
fn decision_from_dialog(result: rfd::MessageDialogResult) -> ShutdownDecision {
|
||||
match result {
|
||||
rfd::MessageDialogResult::Custom(label) if label == SAVE_ALL_LABEL => {
|
||||
ShutdownDecision::SaveAll
|
||||
}
|
||||
rfd::MessageDialogResult::Custom(label) if label == DISCARD_LABEL => {
|
||||
ShutdownDecision::Discard
|
||||
}
|
||||
rfd::MessageDialogResult::Yes => ShutdownDecision::SaveAll,
|
||||
rfd::MessageDialogResult::No => ShutdownDecision::Discard,
|
||||
_ => ShutdownDecision::Cancel,
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::sync::mpsc;
|
||||
|
||||
use bevy::ecs::message::MessageCursor;
|
||||
|
||||
use super::*;
|
||||
use crate::native_dialog::NativeDialogPlugin;
|
||||
|
||||
fn confirming_world() -> World {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<Messages<ShutdownSaveAllRequested>>();
|
||||
world.insert_resource(ShutdownCoordinator {
|
||||
intent: ShutdownIntent::Confirming {
|
||||
source: ShutdownSource::FileMenu,
|
||||
},
|
||||
..default()
|
||||
});
|
||||
world
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn repeated_requests_are_coalesced_behind_the_first_source() {
|
||||
let mut coordinator = ShutdownCoordinator::default();
|
||||
|
||||
assert!(coordinator.request(ShutdownSource::NativeWindow));
|
||||
assert!(!coordinator.request(ShutdownSource::FileMenu));
|
||||
assert_eq!(coordinator.coalesced_requests(), 1);
|
||||
assert_eq!(
|
||||
coordinator.intent(),
|
||||
ShutdownIntent::WaitingForBroker {
|
||||
source: ShutdownSource::NativeWindow
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cancel_returns_to_idle_and_discard_authorizes_exit() {
|
||||
let mut cancel_world = confirming_world();
|
||||
assert!(resolve_shutdown_decision(
|
||||
&mut cancel_world,
|
||||
ShutdownDecision::Cancel
|
||||
));
|
||||
assert_eq!(
|
||||
cancel_world.resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::Idle
|
||||
);
|
||||
|
||||
let mut discard_world = confirming_world();
|
||||
assert!(resolve_shutdown_decision(
|
||||
&mut discard_world,
|
||||
ShutdownDecision::Discard
|
||||
));
|
||||
assert_eq!(
|
||||
discard_world.resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::Authorized {
|
||||
source: ShutdownSource::FileMenu,
|
||||
require_clean_scenes: false,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn dirty_cancel_preserves_the_session_and_discard_emits_one_exit() {
|
||||
let mut app = App::new();
|
||||
app.add_message::<AppExit>()
|
||||
.init_resource::<SceneIo>()
|
||||
.init_resource::<ShutdownCoordinator>();
|
||||
app.world_mut().resource_mut::<SceneIo>().mark_dirty();
|
||||
app.world_mut()
|
||||
.resource_mut::<ShutdownCoordinator>()
|
||||
.set_intent_for_test(ShutdownIntent::Confirming {
|
||||
source: ShutdownSource::Programmatic,
|
||||
});
|
||||
|
||||
assert!(resolve_shutdown_decision(
|
||||
app.world_mut(),
|
||||
ShutdownDecision::Cancel
|
||||
));
|
||||
drive_shutdown(app.world_mut());
|
||||
finalize_authorized_shutdown(app.world_mut());
|
||||
assert_eq!(app.should_exit(), None);
|
||||
assert!(app.world().resource::<SceneIo>().has_unsaved_tabs());
|
||||
|
||||
app.world_mut()
|
||||
.resource_mut::<ShutdownCoordinator>()
|
||||
.set_intent_for_test(ShutdownIntent::Confirming {
|
||||
source: ShutdownSource::Programmatic,
|
||||
});
|
||||
assert!(resolve_shutdown_decision(
|
||||
app.world_mut(),
|
||||
ShutdownDecision::Discard
|
||||
));
|
||||
drive_shutdown(app.world_mut());
|
||||
finalize_authorized_shutdown(app.world_mut());
|
||||
assert_eq!(app.should_exit(), Some(AppExit::Success));
|
||||
assert!(app.world().resource::<SceneIo>().has_unsaved_tabs());
|
||||
assert!(app
|
||||
.world()
|
||||
.resource::<ShutdownCoordinator>()
|
||||
.authorized_exit_sent());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn file_menu_and_programmatic_clean_exit_use_the_same_coordinator_path() {
|
||||
for source in [ShutdownSource::FileMenu, ShutdownSource::Programmatic] {
|
||||
let mut app = App::new();
|
||||
app.add_message::<AppExit>()
|
||||
.init_resource::<SceneIo>()
|
||||
.init_resource::<ShutdownCoordinator>()
|
||||
.init_resource::<NativeDialogBroker>();
|
||||
|
||||
assert!(request_editor_shutdown(app.world_mut(), source));
|
||||
drive_shutdown(app.world_mut());
|
||||
finalize_authorized_shutdown(app.world_mut());
|
||||
|
||||
assert_eq!(app.should_exit(), Some(AppExit::Success));
|
||||
assert_eq!(
|
||||
app.world().resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::ExitSent { source }
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_all_emits_one_persistence_handoff() {
|
||||
let mut world = confirming_world();
|
||||
let mut cursor = MessageCursor::<ShutdownSaveAllRequested>::default();
|
||||
|
||||
assert!(resolve_shutdown_decision(
|
||||
&mut world,
|
||||
ShutdownDecision::SaveAll
|
||||
));
|
||||
assert!(!resolve_shutdown_decision(
|
||||
&mut world,
|
||||
ShutdownDecision::SaveAll
|
||||
));
|
||||
|
||||
let messages = world.resource::<Messages<ShutdownSaveAllRequested>>();
|
||||
let requests: Vec<_> = cursor.read(messages).copied().collect();
|
||||
assert_eq!(
|
||||
requests,
|
||||
vec![ShutdownSaveAllRequested {
|
||||
source: ShutdownSource::FileMenu
|
||||
}]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clean_native_close_emits_the_authorized_exit() {
|
||||
let mut app = App::new();
|
||||
app.add_message::<WindowCloseRequested>()
|
||||
.add_plugins((NativeDialogPlugin, ShutdownPlugin))
|
||||
.init_resource::<SceneIo>();
|
||||
let window = app.world_mut().spawn(PrimaryWindow).id();
|
||||
app.world_mut()
|
||||
.write_message(WindowCloseRequested { window });
|
||||
|
||||
app.update();
|
||||
|
||||
assert_eq!(app.should_exit(), Some(AppExit::Success));
|
||||
assert_eq!(
|
||||
app.world().resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::ExitSent {
|
||||
source: ShutdownSource::NativeWindow
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn secondary_window_close_does_not_request_editor_shutdown() {
|
||||
let mut app = App::new();
|
||||
app.add_message::<WindowCloseRequested>()
|
||||
.add_plugins((NativeDialogPlugin, ShutdownPlugin))
|
||||
.init_resource::<SceneIo>();
|
||||
app.world_mut().spawn(PrimaryWindow);
|
||||
let secondary = app.world_mut().spawn_empty().id();
|
||||
app.world_mut()
|
||||
.write_message(WindowCloseRequested { window: secondary });
|
||||
|
||||
app.update();
|
||||
|
||||
assert_eq!(app.should_exit(), None);
|
||||
assert_eq!(
|
||||
app.world().resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::Idle
|
||||
);
|
||||
assert!(app.world().get_entity(secondary).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn occupied_dialog_broker_keeps_shutdown_waiting() {
|
||||
let mut app = App::new();
|
||||
app.add_message::<WindowCloseRequested>()
|
||||
.add_plugins((NativeDialogPlugin, ShutdownPlugin))
|
||||
.init_resource::<SceneIo>();
|
||||
app.world_mut().resource_mut::<SceneIo>().mark_dirty();
|
||||
let (release_sender, release_receiver) = mpsc::channel();
|
||||
app.world()
|
||||
.resource::<NativeDialogBroker>()
|
||||
.request(
|
||||
move || release_receiver.recv().expect("release sender dropped"),
|
||||
|_, _: ()| {},
|
||||
)
|
||||
.unwrap();
|
||||
assert!(request_editor_shutdown(
|
||||
app.world_mut(),
|
||||
ShutdownSource::Programmatic
|
||||
));
|
||||
|
||||
app.update();
|
||||
|
||||
assert_eq!(
|
||||
app.world().resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::WaitingForBroker {
|
||||
source: ShutdownSource::Programmatic
|
||||
}
|
||||
);
|
||||
release_sender.send(()).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn successful_save_requires_every_scene_tab_to_be_clean() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.insert_resource(ShutdownCoordinator {
|
||||
intent: ShutdownIntent::Saving {
|
||||
source: ShutdownSource::Programmatic,
|
||||
},
|
||||
..default()
|
||||
});
|
||||
|
||||
assert!(complete_shutdown_save(
|
||||
&mut world,
|
||||
ShutdownSaveOutcome::Saved
|
||||
));
|
||||
assert_eq!(
|
||||
world.resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::Authorized {
|
||||
source: ShutdownSource::Programmatic,
|
||||
require_clean_scenes: true,
|
||||
}
|
||||
);
|
||||
|
||||
world.resource_mut::<SceneIo>().mark_dirty();
|
||||
world.resource_mut::<ShutdownCoordinator>().intent = ShutdownIntent::Saving {
|
||||
source: ShutdownSource::Programmatic,
|
||||
};
|
||||
assert!(!complete_shutdown_save(
|
||||
&mut world,
|
||||
ShutdownSaveOutcome::Saved
|
||||
));
|
||||
assert_eq!(
|
||||
world.resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::Idle
|
||||
);
|
||||
assert!(world
|
||||
.resource::<ShutdownCoordinator>()
|
||||
.last_blocker()
|
||||
.is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_new_edit_after_save_reopens_the_guard_instead_of_exiting() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<Messages<AppExit>>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.insert_resource(ShutdownCoordinator {
|
||||
intent: ShutdownIntent::Authorized {
|
||||
source: ShutdownSource::Programmatic,
|
||||
require_clean_scenes: true,
|
||||
},
|
||||
..default()
|
||||
});
|
||||
world.resource_mut::<SceneIo>().mark_dirty();
|
||||
|
||||
finalize_authorized_shutdown(&mut world);
|
||||
|
||||
assert_eq!(
|
||||
world.resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::WaitingForBroker {
|
||||
source: ShutdownSource::Programmatic
|
||||
}
|
||||
);
|
||||
let messages = world.resource::<Messages<AppExit>>();
|
||||
assert_eq!(
|
||||
MessageCursor::<AppExit>::default().read(messages).count(),
|
||||
0
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn last_schedule_edit_is_seen_before_final_exit_authorization() {
|
||||
let mut app = App::new();
|
||||
app.add_message::<WindowCloseRequested>()
|
||||
.add_plugins((NativeDialogPlugin, ShutdownPlugin))
|
||||
.init_resource::<SceneIo>()
|
||||
.add_systems(Last, |mut scene_io: ResMut<SceneIo>| {
|
||||
scene_io.mark_dirty();
|
||||
});
|
||||
assert!(request_editor_shutdown(
|
||||
app.world_mut(),
|
||||
ShutdownSource::Programmatic
|
||||
));
|
||||
|
||||
app.update();
|
||||
|
||||
assert_eq!(app.should_exit(), None);
|
||||
assert!(app.world().resource::<SceneIo>().has_unsaved_tabs());
|
||||
assert_eq!(
|
||||
app.world().resource::<ShutdownCoordinator>().intent(),
|
||||
ShutdownIntent::WaitingForBroker {
|
||||
source: ShutdownSource::Programmatic
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn custom_dialog_labels_map_to_shutdown_decisions() {
|
||||
assert_eq!(
|
||||
decision_from_dialog(rfd::MessageDialogResult::Custom(SAVE_ALL_LABEL.into())),
|
||||
ShutdownDecision::SaveAll
|
||||
);
|
||||
assert_eq!(
|
||||
decision_from_dialog(rfd::MessageDialogResult::Custom(DISCARD_LABEL.into())),
|
||||
ShutdownDecision::Discard
|
||||
);
|
||||
assert_eq!(
|
||||
decision_from_dialog(rfd::MessageDialogResult::Custom(CANCEL_LABEL.into())),
|
||||
ShutdownDecision::Cancel
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_the_final_coordinator_state_authorizes_clean_session_persistence() {
|
||||
let mut coordinator = ShutdownCoordinator::default();
|
||||
assert!(!coordinator.authorized_exit_sent());
|
||||
|
||||
coordinator.intent = ShutdownIntent::Authorized {
|
||||
source: ShutdownSource::Programmatic,
|
||||
require_clean_scenes: true,
|
||||
};
|
||||
assert!(!coordinator.authorized_exit_sent());
|
||||
|
||||
coordinator.intent = ShutdownIntent::ExitSent {
|
||||
source: ShutdownSource::Programmatic,
|
||||
};
|
||||
assert!(coordinator.authorized_exit_sent());
|
||||
}
|
||||
}
|
||||
+1360
-118
File diff suppressed because it is too large.
Load diff
@@ -47,6 +47,11 @@ pub struct EditorComponentRegistry {
|
||||
inspectors: HashMap<&'static str, ComponentInspectorFn>,
|
||||
}
|
||||
|
||||
/// Synchronous inspector callbacks run while [`crate::ui::UiState`] is scoped out of `World`.
|
||||
/// They must not request that resource. Keep extension-owned transient state in independently
|
||||
/// registered resources, use [`crate::ui::request_ui_selection`] and
|
||||
/// [`crate::ui::request_editor_tab`] for host UI changes, or defer other cross-panel work through
|
||||
/// extension-owned commands or events.
|
||||
pub type ComponentInspectorFn = fn(&mut World, &mut egui::Ui, Entity);
|
||||
|
||||
impl EditorComponentRegistry {
|
||||
|
||||
@@ -13,8 +13,9 @@ use crate::history::set_brush_with_history;
|
||||
use crate::history::EditorHistory;
|
||||
use crate::project_io::ProjectWorkspace;
|
||||
use crate::scene_io::{SceneIo, SceneIoEventSeverity};
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::UiState;
|
||||
use crate::viewport::collider_diagnostics::{
|
||||
ColliderDiagnosticSeverity, ColliderDiagnosticsState, ColliderOverlayStatus,
|
||||
};
|
||||
|
||||
#[derive(Resource, Default)]
|
||||
pub struct DiagnosticsPanel {
|
||||
@@ -120,11 +121,7 @@ pub fn diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
.iter(world)
|
||||
.find_map(|(entity, id)| (id.0 == actor_id).then_some(entity))
|
||||
{
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(entity);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_replace(entity);
|
||||
request_diagnostic_selection(world, entity);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -138,6 +135,9 @@ pub fn diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
}
|
||||
}
|
||||
|
||||
ui.separator();
|
||||
collider_diagnostics_ui(world, ui);
|
||||
|
||||
ui.separator();
|
||||
ui.horizontal(|ui| {
|
||||
ui.strong("Support bundle");
|
||||
@@ -193,6 +193,69 @@ pub fn diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
ui.small("BRP is enabled on the editor for external tooling.");
|
||||
}
|
||||
|
||||
fn collider_diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
let Some(state) = world.get_resource::<ColliderDiagnosticsState>() else {
|
||||
return;
|
||||
};
|
||||
let mut rows = state.entries.values().cloned().collect::<Vec<_>>();
|
||||
rows.sort_by(|left, right| left.actor_name.cmp(&right.actor_name));
|
||||
let valid = state.valid_actors;
|
||||
let disabled = state.disabled_actors;
|
||||
let warnings = state.warning_actors;
|
||||
let errors = state.error_actors;
|
||||
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
ui.strong("Collider health");
|
||||
ui.colored_label(
|
||||
egui::Color32::from_rgb(125, 210, 145),
|
||||
format!("{valid} ready"),
|
||||
);
|
||||
if disabled > 0 {
|
||||
ui.colored_label(
|
||||
egui::Color32::from_rgb(143, 151, 163),
|
||||
format!("{disabled} disabled"),
|
||||
);
|
||||
}
|
||||
if warnings > 0 {
|
||||
ui.colored_label(
|
||||
egui::Color32::from_rgb(242, 173, 72),
|
||||
format!("{warnings} warning"),
|
||||
);
|
||||
}
|
||||
if errors > 0 {
|
||||
ui.colored_label(
|
||||
egui::Color32::from_rgb(244, 91, 99),
|
||||
format!("{errors} invalid"),
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
for row in rows.into_iter().filter(|row| {
|
||||
matches!(
|
||||
row.overlay_status,
|
||||
ColliderOverlayStatus::Warning | ColliderOverlayStatus::Error
|
||||
)
|
||||
}) {
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
let color = match row.overlay_status {
|
||||
ColliderOverlayStatus::Error => egui::Color32::from_rgb(244, 91, 99),
|
||||
_ => egui::Color32::from_rgb(242, 173, 72),
|
||||
};
|
||||
ui.colored_label(color, row.shape_label);
|
||||
ui.label(&row.actor_name);
|
||||
if ui.small_button("Select").clicked() {
|
||||
request_diagnostic_selection(world, row.entity);
|
||||
}
|
||||
});
|
||||
for diagnostic in &row.diagnostics {
|
||||
if diagnostic.severity == ColliderDiagnosticSeverity::Info {
|
||||
continue;
|
||||
}
|
||||
ui.small(format!("{}: {}", diagnostic.code, diagnostic.message));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn brush_diagnostics_window(world: &mut World, ctx: &egui::Context, open: &mut bool) {
|
||||
if !*open {
|
||||
return;
|
||||
@@ -231,11 +294,7 @@ fn brush_diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
ui.colored_label(color, row.status_label());
|
||||
ui.label(row.name.as_str());
|
||||
if ui.button("Select").clicked() {
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(row.entity);
|
||||
world
|
||||
.resource_mut::<UiState>()
|
||||
.selected_entities
|
||||
.select_replace(row.entity);
|
||||
request_diagnostic_selection(world, row.entity);
|
||||
}
|
||||
if ui
|
||||
.add_enabled(row.error_count > 0, egui::Button::new("Reset Cube"))
|
||||
@@ -250,6 +309,10 @@ fn brush_diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
}
|
||||
}
|
||||
|
||||
fn request_diagnostic_selection(world: &mut World, entity: Entity) {
|
||||
crate::ui::request_ui_selection(world, &[entity]);
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct BrushDiagnosticRow {
|
||||
entity: Entity,
|
||||
@@ -324,3 +387,37 @@ pub fn diagnostics_window(world: &mut World, ctx: &egui::Context, open: &mut boo
|
||||
diagnostics_ui(world, ui);
|
||||
});
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::{PendingUiSelection, UiState};
|
||||
|
||||
#[test]
|
||||
fn diagnostic_selection_reconciles_while_ui_state_is_scoped_out() {
|
||||
let before = Entity::from_bits(1);
|
||||
let requested = Entity::from_bits(2);
|
||||
let mut world = World::new();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<PendingUiSelection>();
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(before);
|
||||
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.selected_entities.select_replace(before);
|
||||
world.insert_resource(ui_state);
|
||||
|
||||
world.resource_scope::<UiState, _>(|world, mut ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
request_diagnostic_selection(world, requested);
|
||||
let pending = world.resource_mut::<PendingUiSelection>().0.take();
|
||||
super::super::reconcile_operator_selection(
|
||||
&mut ui_state.selected_entities,
|
||||
&[before],
|
||||
world.resource::<SelectedEntity>().0,
|
||||
pending.as_deref(),
|
||||
);
|
||||
assert_eq!(ui_state.selected_entities.as_slice(), &[requested]);
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,10 @@ use sim::Player;
|
||||
use crate::assets::{snapshot_for_asset, EditorAsset, EditorAssetKind};
|
||||
use crate::camera::EditorCamera;
|
||||
use crate::gizmos::{EditorGizmoMode, EditorGizmoSpace};
|
||||
use crate::history::{set_material_group_with_history, spawn_with_history, EditorEntitySnapshot};
|
||||
use crate::history::{
|
||||
set_light_group_with_history, set_material_group_with_history, spawn_with_history,
|
||||
EditorEntitySnapshot,
|
||||
};
|
||||
use crate::play::default_player_spawn;
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::viewport::{recall_camera_bookmark, save_camera_bookmark, CameraBookmarks};
|
||||
@@ -191,37 +194,23 @@ pub fn ensure_player_spawn_for_edit(world: &mut World) -> Entity {
|
||||
|
||||
/// Removes all authored [`LightDesc`] so project sun/ambient drive outdoor lighting.
|
||||
pub fn reset_scene_lighting_to_project_defaults(world: &mut World) {
|
||||
let mut query = world.query_filtered::<Entity, With<LevelObject>>();
|
||||
let with_lights: Vec<Entity> = query
|
||||
let mut query = world.query_filtered::<(Entity, &LightDesc), With<LevelObject>>();
|
||||
let changes = query
|
||||
.iter(world)
|
||||
.filter(|entity| world.get::<LightDesc>(*entity).is_some())
|
||||
.collect();
|
||||
for entity in with_lights {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.remove::<LightDesc>();
|
||||
}
|
||||
}
|
||||
world
|
||||
.resource_mut::<crate::scene_io::SceneIo>()
|
||||
.mark_dirty();
|
||||
.map(|(entity, _)| (entity, None))
|
||||
.collect::<Vec<_>>();
|
||||
set_light_group_with_history(world, changes, "Reset Scene Lighting");
|
||||
}
|
||||
|
||||
/// Removes authored directional lights so [`ProjectSun`] drives outdoor lighting.
|
||||
pub fn use_project_sun(world: &mut World) {
|
||||
let mut query = world.query_filtered::<(Entity, &LightDesc), With<LevelObject>>();
|
||||
let directionals: Vec<Entity> = query
|
||||
let changes = query
|
||||
.iter(world)
|
||||
.filter(|(_, light)| matches!(light.kind, AuthoringLightKind::Directional))
|
||||
.map(|(e, _)| e)
|
||||
.collect();
|
||||
for entity in directionals {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.remove::<LightDesc>();
|
||||
}
|
||||
}
|
||||
world
|
||||
.resource_mut::<crate::scene_io::SceneIo>()
|
||||
.mark_dirty();
|
||||
.map(|(entity, _)| (entity, None))
|
||||
.collect::<Vec<_>>();
|
||||
set_light_group_with_history(world, changes, "Use Project Sun");
|
||||
}
|
||||
|
||||
pub fn create_scene_sun_override_from_project_settings(world: &mut World) -> Entity {
|
||||
|
||||
@@ -37,20 +37,21 @@ use crate::history::{
|
||||
set_primitive_with_history, set_rigid_body_with_history, set_static_mesh_renderer_with_history,
|
||||
EditorEntitySnapshot,
|
||||
};
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::theme::{
|
||||
panel_heading, BORDER, ELEVATED_BG, PANEL_BG_DARK, SELECTION_BG_MUTED, TEXT_DIM, TEXT_MUTED,
|
||||
WIDGET_BG,
|
||||
};
|
||||
use crate::ui::widgets::{icon_button_small, phosphor_icon, phosphor_icon_text};
|
||||
use crate::viewport::brush_edit::{BrushElementKey, BrushElementSelection};
|
||||
use crate::viewport::collider_diagnostics::{
|
||||
diagnose_collider, ColliderDiagnosticSeverity, ColliderOverlayStatus,
|
||||
};
|
||||
|
||||
use super::component_registry::{
|
||||
EditorComponentCategory, EditorComponentDescriptor, EditorComponentRegistry,
|
||||
};
|
||||
use super::dock_tabs::open_and_focus_tab;
|
||||
use super::helpers::create_scene_sun_override_from_project_settings;
|
||||
use super::{EditorTab, UiState};
|
||||
use super::EditorTab;
|
||||
use crate::assets::asset_db::{find_asset_by_path, AssetRegistry};
|
||||
use crate::assets::static_mesh::{
|
||||
load_static_mesh_manifest, material_id_from_label, part_id_from_label,
|
||||
@@ -132,6 +133,7 @@ pub(crate) struct InspectorPanelState {
|
||||
add_component_scroll_selected: bool,
|
||||
add_component_selected_index: usize,
|
||||
add_component_target: Option<Entity>,
|
||||
collapsed_components: HashSet<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
@@ -273,13 +275,9 @@ pub(crate) fn component_card_context(
|
||||
state_key,
|
||||
);
|
||||
let collapsed = world
|
||||
.get_resource::<UiState>()
|
||||
.map(|state| {
|
||||
state
|
||||
.inspector_collapsed_components
|
||||
.contains(&component_card_key(world, entity, options.type_name))
|
||||
})
|
||||
.unwrap_or(false);
|
||||
.resource::<InspectorPanelState>()
|
||||
.collapsed_components
|
||||
.contains(&component_card_key(world, entity, options.type_name));
|
||||
let pasteable = options.copyable
|
||||
&& world
|
||||
.get_resource::<InspectorClipboard>()
|
||||
@@ -323,12 +321,11 @@ fn apply_component_card_response_for_type(
|
||||
) {
|
||||
if let Some(collapsed) = response.collapsed {
|
||||
let key = component_card_key(world, entity, type_name);
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
if collapsed {
|
||||
ui_state.inspector_collapsed_components.insert(key);
|
||||
} else {
|
||||
ui_state.inspector_collapsed_components.remove(&key);
|
||||
}
|
||||
let mut panel_state = world.resource_mut::<InspectorPanelState>();
|
||||
if collapsed {
|
||||
panel_state.collapsed_components.insert(key);
|
||||
} else {
|
||||
panel_state.collapsed_components.remove(&key);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2359,18 +2356,15 @@ fn locate_asset_ref(
|
||||
return;
|
||||
};
|
||||
|
||||
reveal_asset_in_browser(world, &candidate.folder_path, &candidate.selection);
|
||||
}
|
||||
|
||||
fn reveal_asset_in_browser(world: &mut World, folder_path: &str, selection: &AssetSelection) {
|
||||
if let Some(mut assets) = world.get_resource_mut::<EditorAssets>() {
|
||||
assets.current_folder = candidate.folder_path.clone();
|
||||
assets.select(candidate.selection.clone());
|
||||
}
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
let panel_nodes = ui_state.panel_nodes;
|
||||
open_and_focus_tab(
|
||||
&mut ui_state.dock_state,
|
||||
EditorTab::AssetBrowser,
|
||||
&panel_nodes,
|
||||
);
|
||||
assets.current_folder = folder_path.to_string();
|
||||
assets.select(selection.clone());
|
||||
}
|
||||
super::request_editor_tab(world, EditorTab::AssetBrowser);
|
||||
}
|
||||
|
||||
fn skinned_mesh_renderer_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
@@ -3496,12 +3490,23 @@ fn brush_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
}
|
||||
|
||||
fn terrain_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
let material_candidates = brush_face_material_ref_candidates(world);
|
||||
let dragging_selection = world
|
||||
.get_resource::<EditorAssets>()
|
||||
.and_then(|assets| assets.dragging_selection().cloned());
|
||||
let material_drop_candidate = dragging_selection.as_ref().and_then(|selection| {
|
||||
asset_ref_candidate_from_selection(world, selection, AssetRefCandidateKind::Material)
|
||||
});
|
||||
let Some(mut terrain) = world.get::<TerrainDesc>(entity).cloned() else {
|
||||
return;
|
||||
};
|
||||
let original = terrain.clone();
|
||||
let mut changed = false;
|
||||
let mut requested_resolution = terrain.resolution;
|
||||
let mut remove_layer = None;
|
||||
let mut swap_layers = None;
|
||||
let mut locate_layer = None;
|
||||
let mut accepted_drop = false;
|
||||
let card = component_card_context(
|
||||
world,
|
||||
entity,
|
||||
@@ -3526,6 +3531,7 @@ fn terrain_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
let replacement = TerrainDesc::flat(requested_resolution);
|
||||
terrain.resolution = replacement.resolution;
|
||||
terrain.heights = replacement.heights;
|
||||
terrain.material_weights.clear();
|
||||
terrain.chunk_quads = terrain.chunk_quads.min(terrain.resolution - 1).max(1);
|
||||
changed = true;
|
||||
}
|
||||
@@ -3573,16 +3579,132 @@ fn terrain_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
.changed();
|
||||
});
|
||||
});
|
||||
property_row(ui, "Base Material", |ui| {
|
||||
ui.label(
|
||||
terrain
|
||||
.base_material
|
||||
.as_ref()
|
||||
.map(|material| material.label.as_str())
|
||||
.filter(|label| !label.is_empty())
|
||||
.unwrap_or("Terrain fallback"),
|
||||
);
|
||||
ui.add_space(6.0);
|
||||
ui.separator();
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(egui::RichText::new("Material Layers").strong());
|
||||
ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| {
|
||||
if ui
|
||||
.add_enabled(
|
||||
terrain.material_layers.len() < shared::TERRAIN_MATERIAL_LAYER_LIMIT,
|
||||
egui::Button::new(phosphor_icon(icons::PLUS, 16.0)),
|
||||
)
|
||||
.on_hover_text("Add a terrain blend channel")
|
||||
.clicked()
|
||||
{
|
||||
let material = if terrain.material_layers.is_empty() {
|
||||
terrain.base_material.take()
|
||||
} else {
|
||||
None
|
||||
};
|
||||
terrain.material_layers.push(shared::TerrainMaterialLayer {
|
||||
material,
|
||||
..Default::default()
|
||||
});
|
||||
changed = true;
|
||||
}
|
||||
});
|
||||
});
|
||||
if terrain.material_layers.is_empty() {
|
||||
ui.label(
|
||||
egui::RichText::new(
|
||||
terrain
|
||||
.base_material
|
||||
.as_ref()
|
||||
.map(|material| format!("Legacy base: {}", material.label))
|
||||
.unwrap_or_else(|| "No layers assigned; visible terrain fallback".into()),
|
||||
)
|
||||
.color(TEXT_DIM)
|
||||
.small(),
|
||||
);
|
||||
}
|
||||
for index in 0..terrain.material_layers.len() {
|
||||
ui.add_space(4.0);
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(
|
||||
egui::RichText::new(format!("Layer {}", index + 1))
|
||||
.strong()
|
||||
.color(if index == 0 {
|
||||
SELECTION_BG_MUTED
|
||||
} else {
|
||||
TEXT_DIM
|
||||
}),
|
||||
);
|
||||
ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| {
|
||||
if icon_button_small(ui, icons::TRASH, "Remove layer").clicked() {
|
||||
remove_layer = Some(index);
|
||||
}
|
||||
if ui
|
||||
.add_enabled(
|
||||
index + 1 < terrain.material_layers.len(),
|
||||
egui::Button::new(phosphor_icon(icons::ARROW_DOWN, 15.0)).frame(false),
|
||||
)
|
||||
.on_hover_text("Move layer down")
|
||||
.clicked()
|
||||
{
|
||||
swap_layers = Some((index, index + 1));
|
||||
}
|
||||
if ui
|
||||
.add_enabled(
|
||||
index > 0,
|
||||
egui::Button::new(phosphor_icon(icons::ARROW_UP, 15.0)).frame(false),
|
||||
)
|
||||
.on_hover_text("Move layer up")
|
||||
.clicked()
|
||||
{
|
||||
swap_layers = Some((index, index - 1));
|
||||
}
|
||||
});
|
||||
});
|
||||
let response = asset_selector_row(
|
||||
ui,
|
||||
"Material",
|
||||
icons::PALETTE,
|
||||
terrain.material_layers[index].material.as_ref(),
|
||||
None,
|
||||
true,
|
||||
&material_candidates,
|
||||
material_drop_candidate.as_ref(),
|
||||
);
|
||||
if let Some(selected) = response.selected {
|
||||
terrain.material_layers[index].material = Some(selected);
|
||||
changed = true;
|
||||
}
|
||||
if response.clear {
|
||||
terrain.material_layers[index].material = None;
|
||||
changed = true;
|
||||
}
|
||||
if response.locate {
|
||||
locate_layer = Some(index);
|
||||
}
|
||||
accepted_drop |= response.accepted_drop;
|
||||
property_row(ui, "UV Tiling", |ui| {
|
||||
changed |= ui
|
||||
.add(
|
||||
egui::DragValue::new(&mut terrain.material_layers[index].uv_scale)
|
||||
.range(0.01..=1024.0)
|
||||
.speed(0.1)
|
||||
.suffix("×"),
|
||||
)
|
||||
.changed();
|
||||
});
|
||||
if !terrain.material_weights.is_empty() {
|
||||
let covered = terrain
|
||||
.material_weights
|
||||
.iter()
|
||||
.filter(|weights| weights[index] > 0)
|
||||
.count();
|
||||
ui.label(
|
||||
egui::RichText::new(format!(
|
||||
"{} / {} samples carry this layer",
|
||||
covered,
|
||||
terrain.material_weights.len()
|
||||
))
|
||||
.color(TEXT_DIM)
|
||||
.small(),
|
||||
);
|
||||
}
|
||||
}
|
||||
match terrain.validate() {
|
||||
Ok(()) => {
|
||||
ui.label(
|
||||
@@ -3602,6 +3724,31 @@ fn terrain_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
});
|
||||
apply_component_card_response(world, entity, card_response);
|
||||
|
||||
if let Some(index) = remove_layer {
|
||||
remove_terrain_material_layer(&mut terrain, index);
|
||||
changed = true;
|
||||
}
|
||||
if let Some((a, b)) = swap_layers {
|
||||
terrain.material_layers.swap(a, b);
|
||||
for weights in &mut terrain.material_weights {
|
||||
weights.swap(a, b);
|
||||
}
|
||||
changed = true;
|
||||
}
|
||||
if let Some(index) = locate_layer {
|
||||
locate_asset_ref(
|
||||
world,
|
||||
terrain
|
||||
.material_layers
|
||||
.get(index)
|
||||
.and_then(|layer| layer.material.as_ref()),
|
||||
&material_candidates,
|
||||
);
|
||||
}
|
||||
if accepted_drop {
|
||||
clear_asset_drag(world);
|
||||
}
|
||||
|
||||
if changed && terrain != original {
|
||||
let _ = reflected_component_transaction(
|
||||
world,
|
||||
@@ -3617,6 +3764,50 @@ fn terrain_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
}
|
||||
}
|
||||
|
||||
fn remove_terrain_material_layer(terrain: &mut TerrainDesc, index: usize) {
|
||||
if index >= terrain.material_layers.len() {
|
||||
return;
|
||||
}
|
||||
terrain.material_layers.remove(index);
|
||||
if terrain.material_layers.is_empty() {
|
||||
terrain.material_weights.clear();
|
||||
return;
|
||||
}
|
||||
for weights in &mut terrain.material_weights {
|
||||
for channel in index..3 {
|
||||
weights[channel] = weights[channel + 1];
|
||||
}
|
||||
weights[3] = 0;
|
||||
normalize_terrain_weights(weights, terrain.material_layers.len());
|
||||
}
|
||||
}
|
||||
|
||||
fn normalize_terrain_weights(weights: &mut [u8; 4], layer_count: usize) {
|
||||
for weight in weights.iter_mut().skip(layer_count) {
|
||||
*weight = 0;
|
||||
}
|
||||
let sum: u16 = weights
|
||||
.iter()
|
||||
.take(layer_count)
|
||||
.copied()
|
||||
.map(u16::from)
|
||||
.sum();
|
||||
if sum == 0 {
|
||||
*weights = [255, 0, 0, 0];
|
||||
return;
|
||||
}
|
||||
let source = *weights;
|
||||
let mut assigned = 0_u16;
|
||||
for index in 0..layer_count {
|
||||
weights[index] = ((u16::from(source[index]) * 255) / sum) as u8;
|
||||
assigned += u16::from(weights[index]);
|
||||
}
|
||||
let largest = (0..layer_count)
|
||||
.max_by_key(|index| source[*index])
|
||||
.unwrap_or(0);
|
||||
weights[largest] = weights[largest].saturating_add((255 - assigned) as u8);
|
||||
}
|
||||
|
||||
fn brush_validation_ui(ui: &mut egui::Ui, brush: &BrushDesc) {
|
||||
let report = validate_brush(brush);
|
||||
if report.diagnostics.is_empty() {
|
||||
@@ -4016,6 +4207,7 @@ fn rigid_body_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
|
||||
fn collider_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
let mesh_candidates = static_mesh_asset_ref_candidates(world, AssetRefCandidateKind::Mesh);
|
||||
let diagnostic_entry = diagnose_collider(world, entity);
|
||||
let Some(mut collider) = world.get::<ColliderDesc>(entity).cloned() else {
|
||||
return;
|
||||
};
|
||||
@@ -4038,13 +4230,60 @@ fn collider_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
ComponentCardOptions::removable(COMPONENT_COLLIDER_DESC, "Collider", icons::SELECTION),
|
||||
);
|
||||
let card_response = component_card(ui, &card, |ui| {
|
||||
if let Some(entry) = diagnostic_entry.as_ref() {
|
||||
let (label, color) = match entry.overlay_status {
|
||||
ColliderOverlayStatus::Valid => ("Ready", egui::Color32::from_rgb(112, 210, 144)),
|
||||
ColliderOverlayStatus::Trigger => {
|
||||
("Trigger", egui::Color32::from_rgb(86, 195, 235))
|
||||
}
|
||||
ColliderOverlayStatus::Disabled => {
|
||||
("Disabled", egui::Color32::from_rgb(143, 151, 163))
|
||||
}
|
||||
ColliderOverlayStatus::Warning => {
|
||||
("Warning", egui::Color32::from_rgb(242, 173, 72))
|
||||
}
|
||||
ColliderOverlayStatus::Error => ("Invalid", egui::Color32::from_rgb(244, 91, 99)),
|
||||
};
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
ui.colored_label(color, egui::RichText::new(label).strong());
|
||||
ui.label(egui::RichText::new(entry.shape_label).color(TEXT_DIM));
|
||||
if entry.runtime_ready {
|
||||
ui.label(egui::RichText::new("Hydrated").color(TEXT_MUTED).small());
|
||||
}
|
||||
});
|
||||
for diagnostic in &entry.diagnostics {
|
||||
let color = match diagnostic.severity {
|
||||
ColliderDiagnosticSeverity::Info => TEXT_MUTED,
|
||||
ColliderDiagnosticSeverity::Warning => egui::Color32::from_rgb(242, 173, 72),
|
||||
ColliderDiagnosticSeverity::Error => egui::Color32::from_rgb(244, 91, 99),
|
||||
};
|
||||
ui.label(
|
||||
egui::RichText::new(&diagnostic.message)
|
||||
.color(color)
|
||||
.small(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(&diagnostic.repair)
|
||||
.color(TEXT_MUTED)
|
||||
.small(),
|
||||
);
|
||||
}
|
||||
if entry.highest_severity() == Some(ColliderDiagnosticSeverity::Error)
|
||||
&& ui.small_button("Reset shape").clicked()
|
||||
{
|
||||
collider.shape = ColliderShapeDesc::default();
|
||||
collider.enabled = true;
|
||||
changed = true;
|
||||
}
|
||||
ui.add_space(2.0);
|
||||
}
|
||||
property_row(ui, "Mode", |ui| {
|
||||
changed |= ui.checkbox(&mut collider.enabled, "Enabled").changed();
|
||||
changed |= ui.checkbox(&mut collider.is_trigger, "Trigger").changed();
|
||||
});
|
||||
property_row(ui, "Shape", |ui| {
|
||||
let mut shape_kind = collider_shape_kind(&collider.shape);
|
||||
egui::ComboBox::from_id_salt("collider_shape_kind")
|
||||
egui::ComboBox::from_id_salt(("collider_shape_kind", entity))
|
||||
.selected_text(shape_kind)
|
||||
.show_ui(ui, |ui| {
|
||||
for label in ["Box", "Sphere", "Capsule", "Static Mesh"] {
|
||||
@@ -4054,15 +4293,8 @@ fn collider_editor_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
}
|
||||
});
|
||||
if shape_kind != collider_shape_kind(&collider.shape) {
|
||||
collider.shape = match shape_kind {
|
||||
"Sphere" => ColliderShapeDesc::Sphere { radius: 0.5 },
|
||||
"Capsule" => ColliderShapeDesc::Capsule {
|
||||
radius: 0.5,
|
||||
height: 1.0,
|
||||
},
|
||||
"Static Mesh" => ColliderShapeDesc::static_mesh(renderer_meshes.clone()),
|
||||
_ => ColliderShapeDesc::default(),
|
||||
};
|
||||
collider.shape =
|
||||
convert_collider_shape(&collider.shape, shape_kind, renderer_meshes.clone());
|
||||
changed = true;
|
||||
}
|
||||
});
|
||||
@@ -4130,12 +4362,48 @@ fn collider_shape_kind(shape: &ColliderShapeDesc) -> &'static str {
|
||||
}
|
||||
}
|
||||
|
||||
fn convert_collider_shape(
|
||||
previous: &ColliderShapeDesc,
|
||||
shape_kind: &str,
|
||||
renderer_meshes: Vec<EditorAssetRef>,
|
||||
) -> ColliderShapeDesc {
|
||||
let dimensions = match previous {
|
||||
ColliderShapeDesc::Cuboid {
|
||||
x_length,
|
||||
y_length,
|
||||
z_length,
|
||||
} => Vec3::new(*x_length, *y_length, *z_length),
|
||||
ColliderShapeDesc::Sphere { radius } => Vec3::splat(*radius * 2.0),
|
||||
ColliderShapeDesc::Capsule { radius, height } => {
|
||||
Vec3::new(*radius * 2.0, *height, *radius * 2.0)
|
||||
}
|
||||
ColliderShapeDesc::StaticMesh { .. } => Vec3::ONE,
|
||||
}
|
||||
.max(Vec3::splat(0.001));
|
||||
|
||||
match shape_kind {
|
||||
"Sphere" => ColliderShapeDesc::Sphere {
|
||||
radius: dimensions.max_element() * 0.5,
|
||||
},
|
||||
"Capsule" => ColliderShapeDesc::Capsule {
|
||||
radius: dimensions.x.max(dimensions.z) * 0.5,
|
||||
height: dimensions.y,
|
||||
},
|
||||
"Static Mesh" => ColliderShapeDesc::static_mesh(renderer_meshes),
|
||||
_ => ColliderShapeDesc::Cuboid {
|
||||
x_length: dimensions.x,
|
||||
y_length: dimensions.y,
|
||||
z_length: dimensions.z,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
fn dimension_drag(ui: &mut egui::Ui, label: &str, value: &mut f32) -> bool {
|
||||
property_row(ui, label, |ui| {
|
||||
ui.add_sized(
|
||||
[fit_width(ui, 72.0, 120.0), 20.0],
|
||||
egui::DragValue::new(value)
|
||||
.range(0.0..=10_000.0)
|
||||
.range(0.001..=10_000.0)
|
||||
.speed(0.05)
|
||||
.min_decimals(2)
|
||||
.max_decimals(3),
|
||||
@@ -4348,10 +4616,7 @@ pub fn project_sun_ui(world: &mut World, ui: &mut egui::Ui, entity: Entity) {
|
||||
|
||||
if create_override {
|
||||
let sun = create_scene_sun_override_from_project_settings(world);
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(sun);
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<crate::ui::UiState>() {
|
||||
ui_state.selected_entities.select_replace(sun);
|
||||
}
|
||||
crate::ui::request_ui_selection(world, &[sun]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4604,18 +4869,7 @@ fn locate_texture_asset(
|
||||
return;
|
||||
};
|
||||
|
||||
if let Some(mut assets) = world.get_resource_mut::<EditorAssets>() {
|
||||
assets.current_folder = candidate.folder_path.clone();
|
||||
assets.select(candidate.selection.clone());
|
||||
}
|
||||
if let Some(mut ui_state) = world.get_resource_mut::<UiState>() {
|
||||
let panel_nodes = ui_state.panel_nodes;
|
||||
open_and_focus_tab(
|
||||
&mut ui_state.dock_state,
|
||||
EditorTab::AssetBrowser,
|
||||
&panel_nodes,
|
||||
);
|
||||
}
|
||||
reveal_asset_in_browser(world, &candidate.folder_path, &candidate.selection);
|
||||
}
|
||||
|
||||
fn option_string_ui(ui: &mut egui::Ui, label: &str, value: &mut Option<String>) -> bool {
|
||||
@@ -4642,3 +4896,104 @@ fn option_string_ui(ui: &mut egui::Ui, label: &str, value: &mut Option<String>)
|
||||
};
|
||||
changed
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod collider_inspector_tests {
|
||||
use super::*;
|
||||
use crate::history::{apply_command_undo, EditorHistory};
|
||||
use crate::ui::{DockTabRequest, UiState};
|
||||
|
||||
#[test]
|
||||
fn component_collapse_persists_while_ui_state_is_scoped_out() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<EditorComponentRegistry>();
|
||||
world.init_resource::<InspectorPanelState>();
|
||||
let entity = world
|
||||
.spawn((ActorId::new("collapsed-component"), Transform::IDENTITY))
|
||||
.id();
|
||||
world.insert_resource(UiState::default_layout());
|
||||
|
||||
world.resource_scope::<UiState, _>(|world, _ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
apply_component_card_response(
|
||||
world,
|
||||
entity,
|
||||
ComponentCardResponse {
|
||||
type_name: COMPONENT_TRANSFORM,
|
||||
collapsed: Some(true),
|
||||
..Default::default()
|
||||
},
|
||||
);
|
||||
let context = component_card_context(
|
||||
world,
|
||||
entity,
|
||||
ComponentCardOptions::fixed(COMPONENT_TRANSFORM, "Transform", icons::CUBE),
|
||||
);
|
||||
assert!(context.collapsed);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn locate_texture_requests_asset_browser_while_ui_state_is_scoped_out() {
|
||||
let path = "assets/textures/scoped-locate.png";
|
||||
let folder = "assets/textures";
|
||||
let selection = AssetSelection::File(path.to_string());
|
||||
let mut world = World::new();
|
||||
world.insert_resource(EditorAssets {
|
||||
folders: Vec::new(),
|
||||
assets: vec![EditorAsset {
|
||||
label: "Scoped Locate".into(),
|
||||
path: Some(path.into()),
|
||||
folder_path: folder.into(),
|
||||
kind: EditorAssetKind::Texture,
|
||||
}],
|
||||
current_folder: crate::assets::ASSETS_ROOT.into(),
|
||||
selected: None,
|
||||
dragging: None,
|
||||
status: String::new(),
|
||||
});
|
||||
world.init_resource::<DockTabRequest>();
|
||||
world.insert_resource(UiState::default_layout());
|
||||
let candidate = TextureAssetCandidate {
|
||||
label: "Scoped Locate".into(),
|
||||
path: path.into(),
|
||||
folder_path: folder.into(),
|
||||
selection: selection.clone(),
|
||||
texture_id: None,
|
||||
};
|
||||
|
||||
world.resource_scope::<UiState, _>(|world, _ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
locate_texture_asset(world, Some(path), &[candidate]);
|
||||
});
|
||||
|
||||
let assets = world.resource::<EditorAssets>();
|
||||
assert_eq!(assets.current_folder, folder);
|
||||
assert_eq!(assets.selected.as_ref(), Some(&selection));
|
||||
assert_eq!(
|
||||
world.resource::<DockTabRequest>().0,
|
||||
Some(EditorTab::AssetBrowser)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn shape_switch_preserves_dimensions_and_is_one_undoable_edit() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<EditorHistory>();
|
||||
let original = ColliderDesc::static_cuboid(Vec3::new(2.0, 4.0, 6.0));
|
||||
let entity = world.spawn((LevelObject, original.clone())).id();
|
||||
|
||||
let sphere = ColliderDesc {
|
||||
shape: convert_collider_shape(&original.shape, "Sphere", Vec::new()),
|
||||
..original.clone()
|
||||
};
|
||||
assert_eq!(sphere.shape, ColliderShapeDesc::Sphere { radius: 3.0 });
|
||||
|
||||
set_collider_with_history(&mut world, entity, sphere.clone());
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 1);
|
||||
assert_eq!(world.get::<ColliderDesc>(entity), Some(&sphere));
|
||||
|
||||
apply_command_undo(&mut world);
|
||||
assert_eq!(world.get::<ColliderDesc>(entity), Some(&original));
|
||||
}
|
||||
}
|
||||
@@ -6,8 +6,10 @@ use bevy_inspector_egui::bevy_inspector::hierarchy::SelectedEntities;
|
||||
use egui_dock::DockState;
|
||||
|
||||
use crate::history::{apply_command_redo, apply_command_undo, EditorHistory};
|
||||
use crate::project::samples::{SampleCatalog, SampleCatalogEntry};
|
||||
use crate::scene_io::{SceneIo, SceneIoRequest};
|
||||
use crate::settings_ui::{open_project_settings_panel, ProjectSettingsPanel};
|
||||
use crate::shutdown::{request_editor_shutdown, ShutdownSource};
|
||||
use crate::state::{EditorMode, PlayPaused};
|
||||
|
||||
use super::diagnostics::{BrushDiagnosticsPanel, DiagnosticsPanel};
|
||||
@@ -19,12 +21,26 @@ use super::layout::reset_and_save_layout;
|
||||
use super::widgets::menu_item;
|
||||
use super::EditorTab;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
enum SampleMenuModel {
|
||||
Available(Vec<SampleCatalogEntry>),
|
||||
Unavailable(String),
|
||||
}
|
||||
|
||||
fn sample_menu_model(catalog: &SampleCatalog) -> SampleMenuModel {
|
||||
match catalog.unavailable_reason() {
|
||||
Some(reason) => SampleMenuModel::Unavailable(reason.to_string()),
|
||||
None => SampleMenuModel::Available(catalog.entries().to_vec()),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn top_menu_bar(
|
||||
world: &mut World,
|
||||
root_ui: &mut egui::Ui,
|
||||
selected: &SelectedEntities,
|
||||
dock_state: &mut DockState<EditorTab>,
|
||||
panel_nodes: &mut PanelNodes,
|
||||
viewport_rect: egui::Rect,
|
||||
) {
|
||||
egui::Panel::top("editor_menu_bar").show_inside(root_ui, |ui| {
|
||||
egui::MenuBar::new().ui(ui, |ui| {
|
||||
@@ -37,6 +53,25 @@ pub fn top_menu_bar(
|
||||
world.resource_mut::<SceneIo>().request = Some(SceneIoRequest::Open);
|
||||
ui.close();
|
||||
}
|
||||
let sample_menu = sample_menu_model(world.resource::<SampleCatalog>());
|
||||
ui.menu_button("Open Sample", |ui| match sample_menu {
|
||||
SampleMenuModel::Available(entries) => {
|
||||
for entry in entries {
|
||||
if menu_item(ui, &entry.label, None, true)
|
||||
.on_hover_text(entry.hover_text())
|
||||
.clicked()
|
||||
{
|
||||
world.resource_mut::<SceneIo>().request =
|
||||
Some(SceneIoRequest::OpenSample(entry.id));
|
||||
ui.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
SampleMenuModel::Unavailable(reason) => {
|
||||
menu_item(ui, "Sample pack unavailable", None, false)
|
||||
.on_disabled_hover_text(reason);
|
||||
}
|
||||
});
|
||||
if menu_item(ui, "Save", Some("Ctrl+S"), true).clicked() {
|
||||
world.resource_mut::<SceneIo>().request = Some(SceneIoRequest::Save);
|
||||
ui.close();
|
||||
@@ -115,6 +150,11 @@ pub fn top_menu_bar(
|
||||
}
|
||||
});
|
||||
}
|
||||
ui.separator();
|
||||
if menu_item(ui, "Quit", None, true).clicked() {
|
||||
request_editor_shutdown(world, ShutdownSource::FileMenu);
|
||||
ui.close();
|
||||
}
|
||||
});
|
||||
|
||||
ui.menu_button("Edit", |ui| {
|
||||
@@ -170,7 +210,7 @@ pub fn top_menu_bar(
|
||||
("Create Link", NavigationActorType::Link),
|
||||
] {
|
||||
if menu_item(ui, label, None, true).clicked() {
|
||||
spawn_navigation_actor(world, actor_type);
|
||||
spawn_navigation_actor(world, actor_type, viewport_rect);
|
||||
ui.close();
|
||||
}
|
||||
}
|
||||
@@ -287,3 +327,50 @@ pub fn top_menu_bar(
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::path::PathBuf;
|
||||
|
||||
use super::*;
|
||||
|
||||
fn entry(id: &str, label: &str) -> SampleCatalogEntry {
|
||||
SampleCatalogEntry {
|
||||
id: id.into(),
|
||||
label: label.into(),
|
||||
scene_path: PathBuf::from(format!("assets/levels/samples/{id}.scn.ron")),
|
||||
project_relative_scene: format!("assets/levels/samples/{id}.scn.ron"),
|
||||
summary: format!("{label} summary"),
|
||||
checks: vec![format!("{label} check")],
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sample_menu_preserves_catalog_order_and_hover_details() {
|
||||
let catalog = SampleCatalog::available_entries(vec![
|
||||
entry("material", "Material Lab"),
|
||||
entry("terrain", "Terrain Sculpt"),
|
||||
]);
|
||||
|
||||
let SampleMenuModel::Available(rows) = sample_menu_model(&catalog) else {
|
||||
panic!("valid catalog must produce actionable menu rows");
|
||||
};
|
||||
|
||||
assert_eq!(
|
||||
rows.iter().map(|row| row.id.as_str()).collect::<Vec<_>>(),
|
||||
vec!["material", "terrain"]
|
||||
);
|
||||
assert!(rows[0].hover_text().contains("Material Lab summary"));
|
||||
assert!(rows[0].hover_text().contains("Material Lab check"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unavailable_catalog_produces_one_disabled_explanation() {
|
||||
let catalog = SampleCatalog::default();
|
||||
|
||||
assert_eq!(
|
||||
sample_menu_model(&catalog),
|
||||
SampleMenuModel::Unavailable("Sample catalog is loading".into())
|
||||
);
|
||||
}
|
||||
}
|
||||
+131
-14
@@ -26,8 +26,6 @@ mod toolbar;
|
||||
mod viewport_chrome;
|
||||
mod widgets;
|
||||
|
||||
use std::collections::HashSet;
|
||||
|
||||
use bevy::prelude::*;
|
||||
use bevy::window::{CursorGrabMode, CursorOptions, PrimaryWindow};
|
||||
use bevy_egui::{egui, EguiContext, EguiPrimaryContextPass, PrimaryEguiContext};
|
||||
@@ -71,7 +69,6 @@ pub struct UiState {
|
||||
pub selected_entities: SelectedEntities,
|
||||
pub renaming_entity: Option<Entity>,
|
||||
pub rename_buffer: String,
|
||||
pub(crate) inspector_collapsed_components: HashSet<String>,
|
||||
pub(crate) panel_nodes: PanelNodes,
|
||||
last_mode_tab: Option<EditorMode>,
|
||||
}
|
||||
@@ -79,6 +76,56 @@ pub struct UiState {
|
||||
#[derive(Resource, Default)]
|
||||
struct DockTabRequest(Option<EditorTab>);
|
||||
|
||||
#[derive(Resource, Default, Debug)]
|
||||
pub(crate) struct PendingUiSelection(pub(crate) Option<Vec<Entity>>);
|
||||
|
||||
fn replace_selected_entities(selected: &mut SelectedEntities, entities: &[Entity]) {
|
||||
selected.clear();
|
||||
for (index, entity) in entities.iter().enumerate() {
|
||||
if index == 0 {
|
||||
selected.select_replace(*entity);
|
||||
} else {
|
||||
selected.select_maybe_add(*entity, true);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Requests an editor selection change from synchronous UI or extension callbacks.
|
||||
///
|
||||
/// Returns `false` when the editor selection resources are not installed. A normally configured
|
||||
/// editor provides them through [`crate::EditorPluginGroup`].
|
||||
pub fn request_ui_selection(world: &mut World, entities: &[Entity]) -> bool {
|
||||
{
|
||||
let Some(mut selected) = world.get_resource_mut::<SelectedEntity>() else {
|
||||
return false;
|
||||
};
|
||||
selected.0 = entities.first().copied();
|
||||
}
|
||||
if world.contains_resource::<UiState>() {
|
||||
{
|
||||
let mut ui_state = world.resource_mut::<UiState>();
|
||||
replace_selected_entities(&mut ui_state.selected_entities, entities);
|
||||
}
|
||||
if let Some(mut pending) = world.get_resource_mut::<PendingUiSelection>() {
|
||||
pending.0 = None;
|
||||
}
|
||||
} else if let Some(mut pending) = world.get_resource_mut::<PendingUiSelection>() {
|
||||
pending.0 = Some(entities.to_vec());
|
||||
}
|
||||
true
|
||||
}
|
||||
|
||||
/// Requests that an editor tab be opened and focused after the current synchronous UI pass.
|
||||
///
|
||||
/// Returns `false` when [`EditorUiPlugin`] is not installed.
|
||||
pub fn request_editor_tab(world: &mut World, tab: EditorTab) -> bool {
|
||||
let Some(mut request) = world.get_resource_mut::<DockTabRequest>() else {
|
||||
return false;
|
||||
};
|
||||
request.0 = Some(tab);
|
||||
true
|
||||
}
|
||||
|
||||
pub fn egui_captures_keyboard(ctx: &egui::Context) -> bool {
|
||||
ctx.egui_wants_keyboard_input()
|
||||
}
|
||||
@@ -126,7 +173,6 @@ impl UiState {
|
||||
selected_entities: SelectedEntities::default(),
|
||||
renaming_entity: None,
|
||||
rename_buffer: String::new(),
|
||||
inspector_collapsed_components: HashSet::new(),
|
||||
panel_nodes,
|
||||
last_mode_tab: None,
|
||||
}
|
||||
@@ -138,7 +184,7 @@ impl UiState {
|
||||
)]
|
||||
fn ui(&mut self, world: &mut World, ctx: &mut egui::Context, dt: f32) {
|
||||
apply_editor_theme(ctx);
|
||||
let selected_before_ui = world.resource::<SelectedEntity>().0;
|
||||
let selected_before_ui: Vec<Entity> = self.selected_entities.iter().collect();
|
||||
|
||||
let mode = *world.resource::<State<EditorMode>>().get();
|
||||
if self.last_mode_tab != Some(mode) {
|
||||
@@ -169,9 +215,15 @@ impl UiState {
|
||||
&self.selected_entities,
|
||||
&mut self.dock_state,
|
||||
&mut self.panel_nodes,
|
||||
self.viewport_rect,
|
||||
);
|
||||
|
||||
editor_toolbar_panel(world, root_ui, &mut self.selected_entities);
|
||||
editor_toolbar_panel(
|
||||
world,
|
||||
root_ui,
|
||||
&mut self.selected_entities,
|
||||
self.viewport_rect,
|
||||
);
|
||||
status_bar_ui(world, root_ui, &self.selected_entities, mode);
|
||||
|
||||
let mut viewer = TabViewer {
|
||||
@@ -233,11 +285,13 @@ impl UiState {
|
||||
world.resource_mut::<ViewportUiState>().shortcuts_open = true;
|
||||
}
|
||||
|
||||
let pending_selection = world.resource_mut::<PendingUiSelection>().0.take();
|
||||
let requested_selection = world.resource::<SelectedEntity>().0;
|
||||
reconcile_operator_selection(
|
||||
&mut self.selected_entities,
|
||||
selected_before_ui,
|
||||
&selected_before_ui,
|
||||
requested_selection,
|
||||
pending_selection.as_deref(),
|
||||
);
|
||||
let selected = self.selected_entities.as_slice().first().copied();
|
||||
world.resource_mut::<SelectedEntity>().0 = selected;
|
||||
@@ -246,16 +300,24 @@ impl UiState {
|
||||
|
||||
fn reconcile_operator_selection(
|
||||
selected_entities: &mut SelectedEntities,
|
||||
selected_before_ui: Option<Entity>,
|
||||
selected_before_ui: &[Entity],
|
||||
requested_selection: Option<Entity>,
|
||||
pending_selection: Option<&[Entity]>,
|
||||
) {
|
||||
let selected_after_ui = selected_entities.as_slice().first().copied();
|
||||
if requested_selection == selected_before_ui || selected_after_ui != selected_before_ui {
|
||||
if selected_entities.as_slice() != selected_before_ui {
|
||||
return;
|
||||
}
|
||||
if let Some(entities) = pending_selection {
|
||||
replace_selected_entities(selected_entities, entities);
|
||||
return;
|
||||
}
|
||||
if requested_selection == selected_before_ui.first().copied() {
|
||||
return;
|
||||
}
|
||||
selected_entities.clear();
|
||||
if let Some(entity) = requested_selection {
|
||||
selected_entities.select_replace(entity);
|
||||
replace_selected_entities(selected_entities, &[entity]);
|
||||
} else {
|
||||
selected_entities.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -310,6 +372,7 @@ impl Plugin for EditorUiPlugin {
|
||||
.init_resource::<material_library::MaterialLibraryState>()
|
||||
.init_resource::<material_library::MaterialLibraryCatalog>()
|
||||
.init_resource::<DockTabRequest>()
|
||||
.init_resource::<PendingUiSelection>()
|
||||
.init_resource::<inspector::InspectorClipboard>()
|
||||
.init_resource::<inspector::InspectorPanelState>()
|
||||
.init_resource::<animation_inspector::AnimationInspectorState>()
|
||||
@@ -476,7 +539,7 @@ mod tests {
|
||||
let mut selected = SelectedEntities::default();
|
||||
selected.select_replace(before);
|
||||
|
||||
reconcile_operator_selection(&mut selected, Some(before), Some(spawned));
|
||||
reconcile_operator_selection(&mut selected, &[before], Some(spawned), None);
|
||||
|
||||
assert_eq!(selected.as_slice(), &[spawned]);
|
||||
}
|
||||
@@ -489,8 +552,62 @@ mod tests {
|
||||
let mut selected = SelectedEntities::default();
|
||||
selected.select_replace(clicked);
|
||||
|
||||
reconcile_operator_selection(&mut selected, Some(before), Some(requested));
|
||||
reconcile_operator_selection(
|
||||
&mut selected,
|
||||
&[before],
|
||||
Some(requested),
|
||||
Some(&[requested, Entity::from_bits(4)]),
|
||||
);
|
||||
|
||||
assert_eq!(selected.as_slice(), &[clicked]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn direct_ui_secondary_selection_change_beats_pending_operator_selection() {
|
||||
let a = Entity::from_bits(1);
|
||||
let b = Entity::from_bits(2);
|
||||
let c = Entity::from_bits(3);
|
||||
let d = Entity::from_bits(4);
|
||||
let e = Entity::from_bits(5);
|
||||
let mut selected = SelectedEntities::default();
|
||||
selected.select_replace(a);
|
||||
selected.select_maybe_add(c, true);
|
||||
|
||||
reconcile_operator_selection(&mut selected, &[a, b], Some(d), Some(&[d, e]));
|
||||
|
||||
assert_eq!(selected.as_slice(), &[a, c]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn menu_scope_multi_selection_request_preserves_all_entities() {
|
||||
let before = Entity::from_bits(1);
|
||||
let first_duplicate = Entity::from_bits(2);
|
||||
let second_duplicate = Entity::from_bits(3);
|
||||
let mut world = World::new();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<PendingUiSelection>();
|
||||
world.resource_mut::<SelectedEntity>().0 = Some(before);
|
||||
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.selected_entities.select_replace(before);
|
||||
world.insert_resource(ui_state);
|
||||
|
||||
world.resource_scope::<UiState, _>(|world, mut ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
request_ui_selection(world, &[first_duplicate, second_duplicate]);
|
||||
|
||||
let pending = world.resource_mut::<PendingUiSelection>().0.take();
|
||||
reconcile_operator_selection(
|
||||
&mut ui_state.selected_entities,
|
||||
&[before],
|
||||
world.resource::<SelectedEntity>().0,
|
||||
pending.as_deref(),
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
ui_state.selected_entities.as_slice(),
|
||||
&[first_duplicate, second_duplicate]
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -858,10 +858,16 @@ pub enum NavigationActorType {
|
||||
Link,
|
||||
}
|
||||
|
||||
pub fn spawn_navigation_actor(world: &mut World, actor_type: NavigationActorType) -> Entity {
|
||||
let rect = world.resource::<crate::ui::UiState>().viewport_rect;
|
||||
pub fn spawn_navigation_actor(
|
||||
world: &mut World,
|
||||
actor_type: NavigationActorType,
|
||||
viewport_rect: egui::Rect,
|
||||
) -> Entity {
|
||||
let settings = world.resource::<ViewportSettings>().clone();
|
||||
let translation = snap_translation(editor_spawn_ground_position(world, rect), &settings);
|
||||
let translation = snap_translation(
|
||||
editor_spawn_ground_position(world, viewport_rect),
|
||||
&settings,
|
||||
);
|
||||
let (name, bounds, obstacle, area, link) = match actor_type {
|
||||
NavigationActorType::Bounds => (
|
||||
"Navigation Bounds",
|
||||
@@ -1019,8 +1025,49 @@ pub fn sync_navigation_state(world: &mut World) {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::EditorHistory;
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::{PendingUiSelection, UiState};
|
||||
use scene::navigation::NavigationGeometryInput;
|
||||
use shared::{ActorKind, LevelObject};
|
||||
|
||||
#[test]
|
||||
fn navigation_spawn_works_while_ui_state_is_scoped_out_of_world() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<PendingUiSelection>();
|
||||
world.init_resource::<ViewportSettings>();
|
||||
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.viewport_rect =
|
||||
egui::Rect::from_min_size(egui::pos2(100.0, 80.0), egui::vec2(1280.0, 720.0));
|
||||
world.insert_resource(ui_state);
|
||||
|
||||
let entity = world.resource_scope::<UiState, _>(|world, mut ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
let entity =
|
||||
spawn_navigation_actor(world, NavigationActorType::Bounds, ui_state.viewport_rect);
|
||||
let pending = world.resource_mut::<PendingUiSelection>().0.take();
|
||||
super::super::reconcile_operator_selection(
|
||||
&mut ui_state.selected_entities,
|
||||
&[],
|
||||
world.resource::<SelectedEntity>().0,
|
||||
pending.as_deref(),
|
||||
);
|
||||
assert_eq!(ui_state.selected_entities.as_slice(), &[entity]);
|
||||
entity
|
||||
});
|
||||
|
||||
assert!(world.contains_resource::<UiState>());
|
||||
assert!(world.get::<LevelObject>(entity).is_some());
|
||||
assert!(world.get::<NavigationBounds>(entity).is_some());
|
||||
assert_eq!(world.get::<ActorKind>(entity), Some(&ActorKind::Navigation));
|
||||
assert_eq!(world.resource::<SelectedEntity>().0, Some(entity));
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn world_affine_uses_current_authored_parent_chain() {
|
||||
|
||||
@@ -8,7 +8,6 @@ use egui_phosphor_icons::icons;
|
||||
use crate::history::spawn_with_history;
|
||||
use crate::scene_io::{SceneIo, SceneIoRequest};
|
||||
use crate::state::{EditorMode, PlayPaused, PlayPossession};
|
||||
use crate::ui::UiState;
|
||||
use crate::viewport::brush_tool::start_draw_brush_tool;
|
||||
use crate::viewport::{editor_spawn_ground_position, snap_translation, ViewportSettings};
|
||||
use shared::PrimitiveShape;
|
||||
@@ -30,15 +29,21 @@ pub fn editor_toolbar_panel(
|
||||
world: &mut World,
|
||||
root_ui: &mut egui::Ui,
|
||||
selected: &mut SelectedEntities,
|
||||
viewport_rect: egui::Rect,
|
||||
) {
|
||||
egui::Panel::top("editor_toolbar")
|
||||
.exact_size(TOOLBAR_HEIGHT)
|
||||
.show_inside(root_ui, |ui| {
|
||||
toolbar_ui(world, ui, selected);
|
||||
toolbar_ui(world, ui, selected, viewport_rect);
|
||||
});
|
||||
}
|
||||
|
||||
pub fn toolbar_ui(world: &mut World, ui: &mut egui::Ui, selected: &mut SelectedEntities) {
|
||||
pub fn toolbar_ui(
|
||||
world: &mut World,
|
||||
ui: &mut egui::Ui,
|
||||
selected: &mut SelectedEntities,
|
||||
viewport_rect: egui::Rect,
|
||||
) {
|
||||
let (toolbar_rect, _) = ui.allocate_exact_size(
|
||||
egui::vec2(ui.available_width(), TOOLBAR_HEIGHT - 2.0),
|
||||
egui::Sense::hover(),
|
||||
@@ -65,7 +70,7 @@ pub fn toolbar_ui(world: &mut World, ui: &mut egui::Ui, selected: &mut SelectedE
|
||||
.layout(egui::Layout::left_to_right(egui::Align::Center)),
|
||||
);
|
||||
left_ui.spacing_mut().item_spacing.x = 6.0;
|
||||
left_toolbar(world, &mut left_ui);
|
||||
left_toolbar(world, &mut left_ui, viewport_rect);
|
||||
|
||||
let mut transport_ui = ui.new_child(
|
||||
egui::UiBuilder::new()
|
||||
@@ -100,7 +105,7 @@ pub fn toolbar_ui(world: &mut World, ui: &mut egui::Ui, selected: &mut SelectedE
|
||||
);
|
||||
}
|
||||
|
||||
fn left_toolbar(world: &mut World, ui: &mut egui::Ui) {
|
||||
fn left_toolbar(world: &mut World, ui: &mut egui::Ui, viewport_rect: egui::Rect) {
|
||||
brand_mark_frame().show(ui, |ui| {
|
||||
ui.set_min_width(118.0);
|
||||
ui.set_min_height(30.0);
|
||||
@@ -126,16 +131,16 @@ fn left_toolbar(world: &mut World, ui: &mut egui::Ui) {
|
||||
toolbar_group_frame().show(ui, |ui| {
|
||||
panel_toolbar_row(ui, |ui| {
|
||||
if icon_button(ui, icons::CUBE, "Spawn cube").clicked() {
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Box, "Cube");
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Box, "Cube", viewport_rect);
|
||||
}
|
||||
if icon_button(ui, icons::MOUNTAINS, "Spawn ramp").clicked() {
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Ramp, "Ramp");
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Ramp, "Ramp", viewport_rect);
|
||||
}
|
||||
if icon_button(ui, icons::SPHERE, "Spawn sphere").clicked() {
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Sphere, "Sphere");
|
||||
spawn_primitive_at_camera(world, PrimitiveShape::Sphere, "Sphere", viewport_rect);
|
||||
}
|
||||
if icon_button(ui, icons::LIGHTBULB, "Spawn point light").clicked() {
|
||||
let pos = camera_ground_spawn(world);
|
||||
let pos = camera_ground_spawn(world, viewport_rect);
|
||||
spawn_with_history(world, light_snapshot("Point Light", pos));
|
||||
}
|
||||
if icon_button(ui, icons::PENCIL_SIMPLE_LINE, "Draw brush (B)").clicked() {
|
||||
@@ -157,6 +162,7 @@ fn left_toolbar(world: &mut World, ui: &mut egui::Ui) {
|
||||
super::navigation_inspector::spawn_navigation_actor(
|
||||
world,
|
||||
super::navigation_inspector::NavigationActorType::Bounds,
|
||||
viewport_rect,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -232,14 +238,68 @@ fn transport_controls(world: &mut World, ui: &mut egui::Ui) {
|
||||
}
|
||||
}
|
||||
|
||||
fn camera_ground_spawn(world: &mut World) -> Vec3 {
|
||||
let rect = world.resource::<UiState>().viewport_rect;
|
||||
fn camera_ground_spawn(world: &mut World, viewport_rect: egui::Rect) -> Vec3 {
|
||||
let settings = world.resource::<ViewportSettings>().clone();
|
||||
let pos = editor_spawn_ground_position(world, rect);
|
||||
let pos = editor_spawn_ground_position(world, viewport_rect);
|
||||
snap_translation(pos, &settings)
|
||||
}
|
||||
|
||||
fn spawn_primitive_at_camera(world: &mut World, shape: PrimitiveShape, name: &str) {
|
||||
let pos = camera_ground_spawn(world);
|
||||
spawn_with_history(world, primitive_snapshot(name, shape, pos));
|
||||
fn spawn_primitive_at_camera(
|
||||
world: &mut World,
|
||||
shape: PrimitiveShape,
|
||||
name: &str,
|
||||
viewport_rect: egui::Rect,
|
||||
) -> Entity {
|
||||
let pos = camera_ground_spawn(world, viewport_rect);
|
||||
spawn_with_history(world, primitive_snapshot(name, shape, pos))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::EditorHistory;
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::ui::{PendingUiSelection, UiState};
|
||||
use shared::{LevelObject, Primitive};
|
||||
|
||||
#[test]
|
||||
fn primitive_spawn_works_while_ui_state_is_scoped_out_of_world() {
|
||||
let mut world = World::new();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<SelectedEntity>();
|
||||
world.init_resource::<PendingUiSelection>();
|
||||
world.init_resource::<ViewportSettings>();
|
||||
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.viewport_rect =
|
||||
egui::Rect::from_min_size(egui::pos2(100.0, 80.0), egui::vec2(1280.0, 720.0));
|
||||
world.insert_resource(ui_state);
|
||||
|
||||
let entity = world.resource_scope::<UiState, _>(|world, mut ui_state| {
|
||||
assert!(!world.contains_resource::<UiState>());
|
||||
let entity = spawn_primitive_at_camera(
|
||||
world,
|
||||
PrimitiveShape::Box,
|
||||
"Cube",
|
||||
ui_state.viewport_rect,
|
||||
);
|
||||
let pending = world.resource_mut::<PendingUiSelection>().0.take();
|
||||
super::super::reconcile_operator_selection(
|
||||
&mut ui_state.selected_entities,
|
||||
&[],
|
||||
world.resource::<SelectedEntity>().0,
|
||||
pending.as_deref(),
|
||||
);
|
||||
assert_eq!(ui_state.selected_entities.as_slice(), &[entity]);
|
||||
entity
|
||||
});
|
||||
|
||||
assert!(world.contains_resource::<UiState>());
|
||||
assert!(world.get::<LevelObject>(entity).is_some());
|
||||
assert!(world.get::<Primitive>(entity).is_some());
|
||||
assert_eq!(world.resource::<SelectedEntity>().0, Some(entity));
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 1);
|
||||
}
|
||||
}
|
||||
@@ -15,11 +15,17 @@ use crate::assets::{AssetSelection, AssetSubAssetKind, EditorAssets};
|
||||
use crate::camera::EditorCamera;
|
||||
use crate::gizmos::{EditorGizmoMode, EditorGizmoSpace};
|
||||
use crate::render_target::ViewportRenderTarget;
|
||||
use crate::selection::{ViewportClick, ViewportPickStack};
|
||||
use crate::selection::{SelectedEntity, ViewportClick, ViewportPickStack};
|
||||
use crate::state::PlayPossession;
|
||||
use crate::viewport::actor_icons::ActorIconSettings;
|
||||
use crate::viewport::brush_edit::{BrushEditMode, BrushElementSelection};
|
||||
use crate::viewport::brush_tool::{BrushToolPhase, BrushToolState};
|
||||
use crate::viewport::physics_placement::{
|
||||
begin_physics_placement, request_physics_placement, PhysicsPlacementPhase,
|
||||
PhysicsPlacementRequest, PhysicsPlacementState,
|
||||
};
|
||||
use crate::viewport::terrain_paint::{TerrainPaintMode, TerrainPaintState};
|
||||
use crate::viewport::terrain_sculpt::{TerrainSculptMode, TerrainSculptState};
|
||||
use crate::viewport::{
|
||||
material_drop::is_surface_asset_selection, snap_translation, viewport_ground_position,
|
||||
EditorViewportMode, MaterialDropState, ViewportDisplayMode, ViewportSettings,
|
||||
@@ -41,6 +47,7 @@ use super::widgets::{
|
||||
pub struct ViewportUiState {
|
||||
pub options_open: bool,
|
||||
pub shortcuts_open: bool,
|
||||
pub toolbar_rect: Option<egui::Rect>,
|
||||
}
|
||||
|
||||
const VIEWPORT_TOOLTIP: &str = "RMB + WASD/QE: fly | MMB: pan | Scroll: dolly\nW/E/R: gizmo | X: world/local | F: focus | G: game view | Ctrl+G: grid\nTab: cycle overlapping picks | Play/Pause/Stop: main toolbar (F5 / F6)";
|
||||
@@ -143,9 +150,12 @@ pub fn viewport_tab_ui(
|
||||
return;
|
||||
}
|
||||
|
||||
scene_view_overlay_toolbar(world, ui.ctx(), rect);
|
||||
scene_view_overlay_toolbar(world, ui.ctx(), rect, selected_entities);
|
||||
scene_view_selection_hud(world, ui.ctx(), rect, selected_entities);
|
||||
scene_view_brush_draw_hints(world, ui.ctx(), rect);
|
||||
scene_view_terrain_sculpt_hints(world, ui.ctx(), rect);
|
||||
scene_view_terrain_paint_hints(world, ui.ctx(), rect);
|
||||
scene_view_physics_placement_hud(world, ui.ctx(), rect);
|
||||
scene_view_render_badge(world, ui.ctx(), rect);
|
||||
scene_view_brush_mode_badge(world, ui.ctx(), rect);
|
||||
scene_view_volume_hud(world, ui.ctx(), rect);
|
||||
@@ -190,16 +200,54 @@ fn scene_view_render_badge(world: &World, ctx: &egui::Context, scene_rect: egui:
|
||||
});
|
||||
|
||||
if mode == EditorViewportMode::Collider {
|
||||
let health =
|
||||
world.get_resource::<crate::viewport::collider_diagnostics::ColliderDiagnosticsState>();
|
||||
let selected_entry = world
|
||||
.get_resource::<SelectedEntity>()
|
||||
.and_then(|selected| selected.0)
|
||||
.and_then(|entity| health.and_then(|health| health.entry(entity)));
|
||||
egui::Area::new(egui::Id::new("scene_view_collider_warning"))
|
||||
.fixed_pos(scene_rect.left_bottom() + egui::vec2(8.0, -28.0))
|
||||
.interactable(false)
|
||||
.show(ctx, |ui| {
|
||||
overlay_chip_frame().show(ui, |ui| {
|
||||
ui.label(
|
||||
egui::RichText::new("Collider view / meshes hidden")
|
||||
.color(WARNING)
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
ui.label(
|
||||
egui::RichText::new("Collider View")
|
||||
.color(WARNING)
|
||||
.strong()
|
||||
.small(),
|
||||
);
|
||||
if let Some(health) = health {
|
||||
ui.label(
|
||||
egui::RichText::new(format!(
|
||||
"{} ready {} disabled {} warning {} invalid",
|
||||
health.valid_actors,
|
||||
health.disabled_actors,
|
||||
health.warning_actors,
|
||||
health.error_actors
|
||||
))
|
||||
.color(TEXT_MUTED)
|
||||
.small(),
|
||||
);
|
||||
}
|
||||
});
|
||||
if let Some(entry) = selected_entry {
|
||||
ui.label(
|
||||
egui::RichText::new(format!(
|
||||
"{} / {} / {}",
|
||||
entry.actor_name,
|
||||
entry.shape_label,
|
||||
if entry.runtime_ready {
|
||||
"hydrated"
|
||||
} else {
|
||||
"not hydrated"
|
||||
}
|
||||
))
|
||||
.color(SELECTION)
|
||||
.small(),
|
||||
);
|
||||
);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -304,6 +352,94 @@ fn scene_view_brush_draw_hints(world: &World, ctx: &egui::Context, scene_rect: e
|
||||
});
|
||||
}
|
||||
|
||||
fn scene_view_terrain_sculpt_hints(world: &World, ctx: &egui::Context, scene_rect: egui::Rect) {
|
||||
let Some(tool) = world.get_resource::<TerrainSculptState>() else {
|
||||
return;
|
||||
};
|
||||
if !tool.active {
|
||||
return;
|
||||
}
|
||||
egui::Area::new(egui::Id::new("scene_view_terrain_sculpt_hints"))
|
||||
.fixed_pos(scene_rect.left_top() + egui::vec2(8.0, 52.0))
|
||||
.interactable(false)
|
||||
.show(ctx, |ui| {
|
||||
overlay_chip_frame().show(ui, |ui| {
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(
|
||||
egui::RichText::new(format!("Terrain {}", tool.mode.label()))
|
||||
.color(SELECTION)
|
||||
.strong(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(format!("R {:.1}m", tool.radius))
|
||||
.color(TEXT_DIM)
|
||||
.monospace()
|
||||
.small(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(format!("S {:.2}m", tool.strength))
|
||||
.color(SUCCESS)
|
||||
.monospace()
|
||||
.small(),
|
||||
);
|
||||
});
|
||||
ui.add_space(4.0);
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
key_hint(ui, "LMB Drag", "Sculpt");
|
||||
key_hint(ui, "Esc", "Cancel stroke / close");
|
||||
key_hint(ui, "RMB", "Cancel stroke / close");
|
||||
key_hint(ui, "Ctrl+Z", "Undo stroke");
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn scene_view_terrain_paint_hints(world: &World, ctx: &egui::Context, scene_rect: egui::Rect) {
|
||||
let Some(tool) = world.get_resource::<TerrainPaintState>() else {
|
||||
return;
|
||||
};
|
||||
if !tool.active {
|
||||
return;
|
||||
}
|
||||
egui::Area::new(egui::Id::new("scene_view_terrain_paint_hints"))
|
||||
.fixed_pos(scene_rect.left_top() + egui::vec2(8.0, 52.0))
|
||||
.interactable(false)
|
||||
.show(ctx, |ui| {
|
||||
overlay_chip_frame().show(ui, |ui| {
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(
|
||||
egui::RichText::new(format!(
|
||||
"Terrain {} • Layer {}",
|
||||
tool.mode.label(),
|
||||
tool.active_layer + 1
|
||||
))
|
||||
.color(SELECTION)
|
||||
.strong(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(format!("R {:.1}m", tool.radius))
|
||||
.color(TEXT_DIM)
|
||||
.monospace()
|
||||
.small(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(format!("S {:.0}%", tool.strength * 100.0))
|
||||
.color(SUCCESS)
|
||||
.monospace()
|
||||
.small(),
|
||||
);
|
||||
});
|
||||
ui.add_space(4.0);
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
key_hint(ui, "LMB Drag", tool.mode.label());
|
||||
key_hint(ui, "Esc", "Cancel stroke / close");
|
||||
key_hint(ui, "RMB", "Cancel stroke / close");
|
||||
key_hint(ui, "Ctrl+Z", "Undo stroke");
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn key_hint(ui: &mut egui::Ui, key: &str, label: &str) {
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(
|
||||
@@ -489,11 +625,38 @@ fn scene_view_volume_hud(world: &World, ctx: &egui::Context, scene_rect: egui::R
|
||||
});
|
||||
}
|
||||
|
||||
fn scene_view_overlay_toolbar(world: &mut World, ctx: &egui::Context, scene_rect: egui::Rect) {
|
||||
fn scene_view_overlay_toolbar(
|
||||
world: &mut World,
|
||||
ctx: &egui::Context,
|
||||
scene_rect: egui::Rect,
|
||||
selected_entities: &SelectedEntities,
|
||||
) {
|
||||
let mut options_open = world.resource::<ViewportUiState>().options_open;
|
||||
let mut shortcuts_open = world.resource::<ViewportUiState>().shortcuts_open;
|
||||
let terrain_selected = world
|
||||
.resource::<crate::selection::SelectedEntity>()
|
||||
.0
|
||||
.filter(|entity| world.get::<shared::TerrainDesc>(*entity).is_some());
|
||||
let terrain_layer_labels = terrain_selected
|
||||
.and_then(|entity| world.get::<shared::TerrainDesc>(entity))
|
||||
.map(|terrain| {
|
||||
terrain
|
||||
.material_layers
|
||||
.iter()
|
||||
.enumerate()
|
||||
.map(|(index, layer)| {
|
||||
layer
|
||||
.material
|
||||
.as_ref()
|
||||
.map(|material| material.label.clone())
|
||||
.filter(|label| !label.trim().is_empty())
|
||||
.unwrap_or_else(|| format!("Layer {}", index + 1))
|
||||
})
|
||||
.collect::<Vec<_>>()
|
||||
})
|
||||
.unwrap_or_default();
|
||||
|
||||
egui::Area::new(egui::Id::new("scene_view_toolbar"))
|
||||
let toolbar_response = egui::Area::new(egui::Id::new("scene_view_toolbar"))
|
||||
.fixed_pos(scene_rect.left_top() + egui::vec2(6.0, 6.0))
|
||||
.interactable(true)
|
||||
.show(ctx, |ui| {
|
||||
@@ -622,6 +785,224 @@ fn scene_view_overlay_toolbar(world: &mut World, ctx: &egui::Context, scene_rect
|
||||
}
|
||||
}
|
||||
|
||||
let placement_active = world.resource::<PhysicsPlacementState>().active();
|
||||
ui.separator();
|
||||
if placement_active {
|
||||
let phase = world.resource::<PhysicsPlacementState>().phase;
|
||||
ui.label(
|
||||
egui::RichText::new(phase.label())
|
||||
.color(match phase {
|
||||
PhysicsPlacementPhase::Settled => SUCCESS,
|
||||
PhysicsPlacementPhase::TimedOut => WARNING,
|
||||
_ => SELECTION,
|
||||
})
|
||||
.strong()
|
||||
.small(),
|
||||
);
|
||||
if icon_button_small(
|
||||
ui,
|
||||
icons::CHECK,
|
||||
"Commit physics placement (Enter when settled)",
|
||||
)
|
||||
.clicked()
|
||||
{
|
||||
request_physics_placement(world, PhysicsPlacementRequest::Commit);
|
||||
}
|
||||
if icon_button_small(ui, icons::X, "Cancel physics placement (Esc)")
|
||||
.clicked()
|
||||
{
|
||||
request_physics_placement(world, PhysicsPlacementRequest::Cancel);
|
||||
}
|
||||
} else {
|
||||
let selected = selected_entities.iter().collect::<Vec<_>>();
|
||||
let can_start = !selected.is_empty();
|
||||
let clicked = ui
|
||||
.add_enabled(
|
||||
can_start,
|
||||
egui::Button::new(phosphor_icon(icons::HAND_ARROW_DOWN, 16.0)),
|
||||
)
|
||||
.on_hover_text(if can_start {
|
||||
"Release selected props into physics"
|
||||
} else {
|
||||
"Select one or more props to place with physics"
|
||||
})
|
||||
.clicked();
|
||||
if clicked && begin_physics_placement(world, selected).is_ok() {
|
||||
world.resource_mut::<TerrainSculptState>().stop();
|
||||
world.resource_mut::<TerrainPaintState>().stop();
|
||||
world.resource_mut::<BrushToolState>().cancel();
|
||||
world.resource_mut::<ViewportClick>().0 = None;
|
||||
}
|
||||
}
|
||||
|
||||
let sculpt_active = world.resource::<TerrainSculptState>().active;
|
||||
let paint_active = world.resource::<TerrainPaintState>().active;
|
||||
if terrain_selected.is_some() || sculpt_active || paint_active {
|
||||
ui.separator();
|
||||
let stroking = world.resource::<TerrainSculptState>().is_stroking();
|
||||
let sculpt_button_clicked = tool_button_accent(
|
||||
ui,
|
||||
icons::MOUNTAINS,
|
||||
sculpt_active,
|
||||
if sculpt_active {
|
||||
"Close terrain sculpt tool"
|
||||
} else {
|
||||
"Sculpt selected terrain"
|
||||
},
|
||||
)
|
||||
.clicked();
|
||||
if sculpt_button_clicked {
|
||||
world.resource_mut::<ViewportClick>().0 = None;
|
||||
}
|
||||
if sculpt_button_clicked && !stroking {
|
||||
let state = &mut *world.resource_mut::<TerrainSculptState>();
|
||||
if state.active {
|
||||
state.stop();
|
||||
} else if let Some(entity) = terrain_selected {
|
||||
state.start(entity);
|
||||
}
|
||||
let active = state.active;
|
||||
if active {
|
||||
world.resource_mut::<TerrainPaintState>().stop();
|
||||
world.resource_mut::<BrushToolState>().cancel();
|
||||
world
|
||||
.resource_mut::<crate::operators::ActiveOperator>()
|
||||
.status = Some(crate::operators::OperatorStatus {
|
||||
id: "terrain.sculpt".to_string(),
|
||||
label: "Terrain Sculpt".to_string(),
|
||||
phase: crate::operators::OperatorPhase::Preview,
|
||||
hint: "LMB drag sculpts; Esc or RMB cancels".to_string(),
|
||||
warnings: Vec::new(),
|
||||
});
|
||||
}
|
||||
}
|
||||
if sculpt_active {
|
||||
let mut mode = world.resource::<TerrainSculptState>().mode;
|
||||
for candidate in [
|
||||
TerrainSculptMode::Raise,
|
||||
TerrainSculptMode::Lower,
|
||||
TerrainSculptMode::Flatten,
|
||||
TerrainSculptMode::Smooth,
|
||||
TerrainSculptMode::Noise,
|
||||
] {
|
||||
ui.selectable_value(&mut mode, candidate, candidate.label())
|
||||
.on_hover_text(format!("{} terrain", candidate.label()));
|
||||
}
|
||||
let mut radius = world.resource::<TerrainSculptState>().radius;
|
||||
let mut strength = world.resource::<TerrainSculptState>().strength;
|
||||
ui.add(
|
||||
egui::DragValue::new(&mut radius)
|
||||
.range(0.25..=128.0)
|
||||
.speed(0.1)
|
||||
.prefix("R ")
|
||||
.suffix(" m"),
|
||||
)
|
||||
.on_hover_text("Brush radius");
|
||||
ui.add(
|
||||
egui::DragValue::new(&mut strength)
|
||||
.range(0.01..=20.0)
|
||||
.speed(0.05)
|
||||
.prefix("S ")
|
||||
.suffix(" m"),
|
||||
)
|
||||
.on_hover_text("Height strength per dab");
|
||||
let mut state = world.resource_mut::<TerrainSculptState>();
|
||||
state.mode = mode;
|
||||
state.radius = radius;
|
||||
state.strength = strength;
|
||||
state.clamp_settings();
|
||||
}
|
||||
|
||||
let paint_stroking = world.resource::<TerrainPaintState>().is_stroking();
|
||||
let can_paint = terrain_layer_labels.len() >= 2 || paint_active;
|
||||
let paint_button_clicked = ui
|
||||
.add_enabled(
|
||||
can_paint,
|
||||
egui::Button::new(phosphor_icon(icons::PAINT_BRUSH, 16.0))
|
||||
.selected(paint_active),
|
||||
)
|
||||
.on_hover_text(if can_paint {
|
||||
if paint_active {
|
||||
"Close terrain material paint tool"
|
||||
} else {
|
||||
"Paint selected terrain material layers"
|
||||
}
|
||||
} else {
|
||||
"Assign at least two terrain material layers first"
|
||||
})
|
||||
.clicked();
|
||||
if paint_button_clicked {
|
||||
world.resource_mut::<ViewportClick>().0 = None;
|
||||
}
|
||||
if paint_button_clicked && !paint_stroking {
|
||||
let layer_count = terrain_layer_labels.len();
|
||||
let state = &mut *world.resource_mut::<TerrainPaintState>();
|
||||
if state.active {
|
||||
state.stop();
|
||||
} else if let Some(entity) = terrain_selected {
|
||||
state.start(entity, layer_count);
|
||||
}
|
||||
let active = state.active;
|
||||
if active {
|
||||
world.resource_mut::<TerrainSculptState>().stop();
|
||||
world.resource_mut::<BrushToolState>().cancel();
|
||||
world
|
||||
.resource_mut::<crate::operators::ActiveOperator>()
|
||||
.status = Some(crate::operators::OperatorStatus {
|
||||
id: "terrain.paint".into(),
|
||||
label: "Terrain Paint".into(),
|
||||
phase: crate::operators::OperatorPhase::Preview,
|
||||
hint: "LMB drag paints weights; Esc or RMB cancels".into(),
|
||||
warnings: Vec::new(),
|
||||
});
|
||||
}
|
||||
}
|
||||
if paint_active {
|
||||
let mut mode = world.resource::<TerrainPaintState>().mode;
|
||||
ui.selectable_value(&mut mode, TerrainPaintMode::Paint, "Paint")
|
||||
.on_hover_text("Increase the selected layer weight");
|
||||
ui.selectable_value(&mut mode, TerrainPaintMode::Erase, "Erase")
|
||||
.on_hover_text("Reduce the selected layer weight");
|
||||
let mut active_layer =
|
||||
world.resource::<TerrainPaintState>().active_layer;
|
||||
egui::ComboBox::from_id_salt("terrain_paint_layer")
|
||||
.selected_text(
|
||||
terrain_layer_labels
|
||||
.get(active_layer)
|
||||
.cloned()
|
||||
.unwrap_or_else(|| "Layer".into()),
|
||||
)
|
||||
.show_ui(ui, |ui| {
|
||||
for (index, label) in terrain_layer_labels.iter().enumerate() {
|
||||
ui.selectable_value(&mut active_layer, index, label);
|
||||
}
|
||||
});
|
||||
let mut radius = world.resource::<TerrainPaintState>().radius;
|
||||
let mut strength = world.resource::<TerrainPaintState>().strength;
|
||||
ui.add(
|
||||
egui::DragValue::new(&mut radius)
|
||||
.range(0.25..=128.0)
|
||||
.speed(0.1)
|
||||
.prefix("R ")
|
||||
.suffix(" m"),
|
||||
)
|
||||
.on_hover_text("Brush radius");
|
||||
ui.add(
|
||||
egui::DragValue::new(&mut strength)
|
||||
.range(0.01..=1.0)
|
||||
.speed(0.02)
|
||||
.prefix("S "),
|
||||
)
|
||||
.on_hover_text("Weight strength per dab");
|
||||
let mut state = world.resource_mut::<TerrainPaintState>();
|
||||
state.mode = mode;
|
||||
state.active_layer = active_layer;
|
||||
state.radius = radius;
|
||||
state.strength = strength;
|
||||
state.clamp_settings();
|
||||
}
|
||||
}
|
||||
|
||||
let clean_game_view = world.resource::<ViewportDisplayMode>().clean_game_view;
|
||||
if tool_button(
|
||||
ui,
|
||||
@@ -649,6 +1030,13 @@ fn scene_view_overlay_toolbar(world: &mut World, ctx: &egui::Context, scene_rect
|
||||
});
|
||||
});
|
||||
|
||||
let toolbar_clicked = toolbar_response.response.contains_pointer()
|
||||
&& ctx.input(|input| input.pointer.button_clicked(egui::PointerButton::Primary));
|
||||
if toolbar_clicked {
|
||||
world.resource_mut::<ViewportClick>().0 = None;
|
||||
}
|
||||
world.resource_mut::<ViewportUiState>().toolbar_rect = Some(toolbar_response.response.rect);
|
||||
|
||||
if options_open {
|
||||
scene_options_popover(world, ctx, scene_rect, &mut options_open);
|
||||
}
|
||||
@@ -660,6 +1048,66 @@ fn scene_view_overlay_toolbar(world: &mut World, ctx: &egui::Context, scene_rect
|
||||
world.resource_mut::<ViewportUiState>().shortcuts_open = shortcuts_open;
|
||||
}
|
||||
|
||||
fn scene_view_physics_placement_hud(world: &World, ctx: &egui::Context, scene_rect: egui::Rect) {
|
||||
let state = world.resource::<PhysicsPlacementState>();
|
||||
if !state.active() {
|
||||
let Some(error) = state.last_error.as_deref() else {
|
||||
return;
|
||||
};
|
||||
egui::Area::new(egui::Id::new("scene_view_physics_placement_error"))
|
||||
.fixed_pos(scene_rect.left_top() + egui::vec2(8.0, 52.0))
|
||||
.interactable(false)
|
||||
.show(ctx, |ui| {
|
||||
overlay_chip_frame().show(ui, |ui| {
|
||||
ui.label(
|
||||
egui::RichText::new("Physics placement unavailable")
|
||||
.color(ERROR)
|
||||
.strong(),
|
||||
);
|
||||
for line in error.lines().take(4) {
|
||||
ui.label(egui::RichText::new(line).color(TEXT_DIM).small());
|
||||
}
|
||||
});
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
egui::Area::new(egui::Id::new("scene_view_physics_placement_hud"))
|
||||
.fixed_pos(scene_rect.left_top() + egui::vec2(8.0, 52.0))
|
||||
.interactable(false)
|
||||
.show(ctx, |ui| {
|
||||
overlay_chip_frame().show(ui, |ui| {
|
||||
ui.horizontal(|ui| {
|
||||
ui.label(phosphor_icon(icons::HAND_ARROW_DOWN, 16.0).color(SELECTION));
|
||||
ui.label(
|
||||
egui::RichText::new(format!("Physics Placement / {}", state.phase.label()))
|
||||
.color(match state.phase {
|
||||
PhysicsPlacementPhase::Settled => SUCCESS,
|
||||
PhysicsPlacementPhase::TimedOut => WARNING,
|
||||
_ => SELECTION,
|
||||
})
|
||||
.strong(),
|
||||
);
|
||||
ui.label(
|
||||
egui::RichText::new(format!(
|
||||
"{} props / {:.1}s",
|
||||
state.selected_count,
|
||||
state.simulated_seconds()
|
||||
))
|
||||
.color(TEXT_DIM)
|
||||
.monospace()
|
||||
.small(),
|
||||
);
|
||||
});
|
||||
ui.add_space(4.0);
|
||||
ui.horizontal_wrapped(|ui| {
|
||||
key_hint(ui, "Esc", "Cancel");
|
||||
key_hint(ui, "Enter", "Commit when settled");
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn scene_options_popover(
|
||||
world: &mut World,
|
||||
ctx: &egui::Context,
|
||||
|
||||
@@ -4,7 +4,7 @@ use bevy::math::Affine3A;
|
||||
use bevy::prelude::*;
|
||||
use shared::{
|
||||
brush_math::{validate_brush, BrushDiagnosticSeverity},
|
||||
BrushDesc, LevelObject,
|
||||
BrushDesc,
|
||||
};
|
||||
|
||||
use crate::history::apply_brush_csg_with_history;
|
||||
@@ -64,24 +64,27 @@ pub fn selected_brush_count(world: &World) -> usize {
|
||||
.resource::<UiState>()
|
||||
.selected_entities
|
||||
.iter()
|
||||
.filter(|entity| world.get::<BrushDesc>(*entity).is_some())
|
||||
.filter(|entity| {
|
||||
world.get::<BrushDesc>(*entity).is_some()
|
||||
&& crate::ui::selection_ops::is_mutable_level_object(world, *entity)
|
||||
})
|
||||
.count()
|
||||
}
|
||||
|
||||
pub fn intersect_selected_brushes(world: &mut World) {
|
||||
run_bounds_csg(world, BrushCsgOp::Intersect);
|
||||
pub fn intersect_selected_brushes(world: &mut World) -> Result<(), String> {
|
||||
run_bounds_csg(world, BrushCsgOp::Intersect)
|
||||
}
|
||||
|
||||
pub fn merge_selected_brushes(world: &mut World) {
|
||||
run_bounds_csg(world, BrushCsgOp::Merge);
|
||||
pub fn merge_selected_brushes(world: &mut World) -> Result<(), String> {
|
||||
run_bounds_csg(world, BrushCsgOp::Merge)
|
||||
}
|
||||
|
||||
pub fn subtract_selected_brushes(world: &mut World) {
|
||||
run_bounds_csg(world, BrushCsgOp::Subtract);
|
||||
pub fn subtract_selected_brushes(world: &mut World) -> Result<(), String> {
|
||||
run_bounds_csg(world, BrushCsgOp::Subtract)
|
||||
}
|
||||
|
||||
#[derive(Resource, Default, Debug, Clone)]
|
||||
struct BrushCsgPreview {
|
||||
pub(crate) struct BrushCsgPreview {
|
||||
pending: Option<PendingBrushCsg>,
|
||||
}
|
||||
|
||||
@@ -99,18 +102,18 @@ enum BrushCsgOp {
|
||||
Subtract,
|
||||
}
|
||||
|
||||
fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
fn run_bounds_csg(world: &mut World, op: BrushCsgOp) -> Result<(), String> {
|
||||
let selected: Vec<Entity> = world
|
||||
.resource::<UiState>()
|
||||
.selected_entities
|
||||
.iter()
|
||||
.filter(|entity| {
|
||||
world.get::<LevelObject>(*entity).is_some() && world.get::<BrushDesc>(*entity).is_some()
|
||||
world.get::<BrushDesc>(*entity).is_some()
|
||||
&& crate::ui::selection_ops::is_mutable_level_object(world, *entity)
|
||||
})
|
||||
.collect();
|
||||
if selected.len() < 2 {
|
||||
set_status(world, "Select at least two brushes for CSG");
|
||||
return;
|
||||
return csg_failure(world, "Select at least two editable brushes for CSG");
|
||||
}
|
||||
for entity in &selected {
|
||||
let Some(brush) = world.get::<BrushDesc>(*entity) else {
|
||||
@@ -118,20 +121,18 @@ fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
};
|
||||
let validation = validate_brush(brush);
|
||||
if !validation.is_valid() {
|
||||
set_status(
|
||||
return csg_failure(
|
||||
world,
|
||||
format!(
|
||||
"CSG failed: selected brush is invalid: {}",
|
||||
first_brush_error(&validation)
|
||||
),
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
let Some(primary_bounds) = brush_world_bounds(world, selected[0]) else {
|
||||
set_status(world, "Primary brush has no valid bounds");
|
||||
return;
|
||||
return csg_failure(world, "Primary brush has no valid bounds");
|
||||
};
|
||||
|
||||
let result = match op {
|
||||
@@ -147,8 +148,7 @@ fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
continue;
|
||||
};
|
||||
let Some(intersection) = result.intersection(bounds) else {
|
||||
set_status(world, "Brush intersect failed: no overlap");
|
||||
return;
|
||||
return csg_failure(world, "Brush intersect failed: no overlap");
|
||||
};
|
||||
result = intersection;
|
||||
}
|
||||
@@ -156,16 +156,13 @@ fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
}
|
||||
BrushCsgOp::Subtract => {
|
||||
let Some(cutter_bounds) = brush_world_bounds(world, selected[1]) else {
|
||||
set_status(world, "Subtract failed: cutter brush has no valid bounds");
|
||||
return;
|
||||
return csg_failure(world, "Subtract failed: cutter brush has no valid bounds");
|
||||
};
|
||||
let Some(overlap) = primary_bounds.intersection(cutter_bounds) else {
|
||||
set_status(world, "Subtract failed: brushes do not overlap");
|
||||
return;
|
||||
return csg_failure(world, "Subtract failed: brushes do not overlap");
|
||||
};
|
||||
let Some(result) = largest_remaining_slab(primary_bounds, overlap) else {
|
||||
set_status(world, "Subtract failed: result would be empty");
|
||||
return;
|
||||
return csg_failure(world, "Subtract failed: result would be empty");
|
||||
};
|
||||
result
|
||||
}
|
||||
@@ -175,14 +172,13 @@ fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
let new_brush = BrushDesc::cuboid(size);
|
||||
let validation = validate_brush(&new_brush);
|
||||
if !validation.is_valid() {
|
||||
set_status(
|
||||
return csg_failure(
|
||||
world,
|
||||
format!(
|
||||
"CSG failed: result is invalid: {}",
|
||||
first_brush_error(&validation)
|
||||
),
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
world.resource_mut::<BrushCsgPreview>().pending = Some(PendingBrushCsg {
|
||||
@@ -197,6 +193,13 @@ fn run_bounds_csg(world: &mut World, op: BrushCsgOp) {
|
||||
};
|
||||
set_status(world, hint);
|
||||
set_csg_operator_status(world, OperatorPhase::Preview, hint);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn csg_failure(world: &mut World, message: impl Into<String>) -> Result<(), String> {
|
||||
let message = message.into();
|
||||
set_status(world, message.clone());
|
||||
Err(message)
|
||||
}
|
||||
|
||||
fn brush_csg_preview_input(world: &mut World) {
|
||||
@@ -253,6 +256,22 @@ fn commit_csg_preview(world: &mut World, pending: PendingBrushCsg) {
|
||||
);
|
||||
return;
|
||||
}
|
||||
if pending
|
||||
.selected
|
||||
.iter()
|
||||
.any(|entity| !crate::ui::selection_ops::is_mutable_level_object(world, *entity))
|
||||
{
|
||||
set_status(
|
||||
world,
|
||||
"Brush CSG commit blocked: selected content is no longer editable",
|
||||
);
|
||||
set_csg_operator_status(
|
||||
world,
|
||||
OperatorPhase::Blocked,
|
||||
"Commit blocked: selected content is no longer editable",
|
||||
);
|
||||
return;
|
||||
}
|
||||
let new_brush = BrushDesc::cuboid(pending.result.size());
|
||||
let to_delete: Vec<_> = if matches!(pending.op, BrushCsgOp::Merge | BrushCsgOp::Intersect) {
|
||||
pending
|
||||
@@ -265,7 +284,11 @@ fn commit_csg_preview(world: &mut World, pending: PendingBrushCsg) {
|
||||
} else {
|
||||
Vec::new()
|
||||
};
|
||||
apply_bounds_result(world, primary, pending.result, new_brush, &to_delete);
|
||||
if !apply_bounds_result(world, primary, pending.result, new_brush, &to_delete) {
|
||||
set_status(world, "Brush CSG commit made no changes");
|
||||
set_csg_operator_status(world, OperatorPhase::Canceled, "No changes");
|
||||
return;
|
||||
}
|
||||
let hint = match pending.op {
|
||||
BrushCsgOp::Intersect => "Brush intersect committed",
|
||||
BrushCsgOp::Merge => "Brush convex merge committed",
|
||||
@@ -332,14 +355,14 @@ fn apply_bounds_result(
|
||||
bounds: BrushBounds,
|
||||
new_brush: BrushDesc,
|
||||
delete_entities: &[Entity],
|
||||
) {
|
||||
) -> bool {
|
||||
let center = bounds.center();
|
||||
let old_transform = world.get::<Transform>(entity).copied().unwrap_or_default();
|
||||
let mut new_transform = old_transform;
|
||||
new_transform.translation = center;
|
||||
new_transform.rotation = Quat::IDENTITY;
|
||||
new_transform.scale = Vec3::ONE;
|
||||
apply_brush_csg_with_history(world, entity, new_transform, new_brush, delete_entities);
|
||||
apply_brush_csg_with_history(world, entity, new_transform, new_brush, delete_entities)
|
||||
}
|
||||
|
||||
fn brush_world_bounds(world: &World, entity: Entity) -> Option<BrushBounds> {
|
||||
@@ -426,6 +449,7 @@ mod tests {
|
||||
use crate::history::{EditorCommand, EditorHistory};
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use crate::selection::SelectedEntity;
|
||||
use shared::LevelObject;
|
||||
|
||||
fn bounds(min: Vec3, max: Vec3) -> BrushBounds {
|
||||
BrushBounds { min, max }
|
||||
|
||||
@@ -1308,4 +1308,55 @@ mod tests {
|
||||
assert!(state.old_brush.is_none());
|
||||
assert!(!state.changed);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn brush_element_release_uses_production_finalizer_and_round_trips() {
|
||||
let mut app = App::new();
|
||||
app.init_resource::<ActiveOperator>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<SceneIo>()
|
||||
.init_resource::<BrushEditMode>()
|
||||
.init_resource::<BrushElementSelection>()
|
||||
.init_resource::<BrushElementGizmoState>()
|
||||
.add_systems(Update, apply_brush_element_gizmo);
|
||||
let original = BrushDesc::cuboid(Vec3::ONE);
|
||||
let preview = BrushDesc::cuboid(Vec3::new(1.5, 1.0, 1.0));
|
||||
let brush_entity = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, preview.clone(), GlobalTransform::default()))
|
||||
.id();
|
||||
let helper = app
|
||||
.world_mut()
|
||||
.spawn((
|
||||
BrushElementGizmo,
|
||||
Transform::default(),
|
||||
GizmoTarget::default(),
|
||||
))
|
||||
.id();
|
||||
*app.world_mut().resource_mut::<BrushEditMode>() = BrushEditMode::Vertex;
|
||||
*app.world_mut().resource_mut::<BrushElementSelection>() = BrushElementSelection {
|
||||
brush: Some(brush_entity),
|
||||
elements: vec![BrushElementKey::Vertex {
|
||||
face: original.faces[0].id.clone(),
|
||||
index: 0,
|
||||
}],
|
||||
};
|
||||
*app.world_mut().resource_mut::<BrushElementGizmoState>() = BrushElementGizmoState {
|
||||
entity: Some(helper),
|
||||
brush: Some(brush_entity),
|
||||
old_brush: Some(original.clone()),
|
||||
old_gizmo: Some(Transform::default()),
|
||||
last_gizmo: Some(Transform::from_translation(Vec3::X * 0.25)),
|
||||
changed: true,
|
||||
};
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
app.update();
|
||||
|
||||
harness.assert_committed(app.world_mut(), 1, 0);
|
||||
harness.assert_status(app.world(), "brush.edit_mode", OperatorPhase::Committed);
|
||||
assert_undo_redo_round_trip(app.world_mut(), original, preview, |world| {
|
||||
world.get::<BrushDesc>(brush_entity).unwrap().clone()
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,428 @@
|
||||
//! Shared authored/runtime collider diagnostics for editor workflows.
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
use avian3d::prelude::{Collider, RigidBody};
|
||||
use bevy::prelude::*;
|
||||
use shared::{
|
||||
authoring_component_active, AuthoringComponentStates, ColliderDesc, ColliderShapeDesc,
|
||||
InspectorOrder, LevelObject, PhysicsBody, RigidBodyDesc, COMPONENT_COLLIDER_DESC,
|
||||
COMPONENT_PHYSICS_BODY, COMPONENT_RIGID_BODY_DESC,
|
||||
};
|
||||
|
||||
use crate::assets::asset_db::{find_asset_by_id, AssetRegistry};
|
||||
use crate::ui::selection_ops::entity_name;
|
||||
|
||||
/// Collider dimensions beyond this world-space extent are usually accidental in a meter-scale
|
||||
/// project and can severely degrade broad-phase performance.
|
||||
pub const OVERSIZED_COLLIDER_EXTENT: f32 = 1_000.0;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
|
||||
pub enum ColliderDiagnosticSeverity {
|
||||
Info,
|
||||
Warning,
|
||||
Error,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
pub struct ColliderDiagnostic {
|
||||
pub code: &'static str,
|
||||
pub severity: ColliderDiagnosticSeverity,
|
||||
pub message: String,
|
||||
pub repair: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub enum ColliderOverlayStatus {
|
||||
Valid,
|
||||
Trigger,
|
||||
Disabled,
|
||||
Warning,
|
||||
Error,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct ColliderDiagnosticEntry {
|
||||
pub entity: Entity,
|
||||
pub actor_name: String,
|
||||
pub shape_label: &'static str,
|
||||
pub runtime_ready: bool,
|
||||
pub diagnostics: Vec<ColliderDiagnostic>,
|
||||
pub overlay_status: ColliderOverlayStatus,
|
||||
}
|
||||
|
||||
impl ColliderDiagnosticEntry {
|
||||
pub fn highest_severity(&self) -> Option<ColliderDiagnosticSeverity> {
|
||||
self.diagnostics
|
||||
.iter()
|
||||
.map(|diagnostic| diagnostic.severity)
|
||||
.max()
|
||||
}
|
||||
|
||||
pub fn blocking_messages(&self) -> impl Iterator<Item = &str> {
|
||||
self.diagnostics
|
||||
.iter()
|
||||
.filter(|diagnostic| diagnostic.severity == ColliderDiagnosticSeverity::Error)
|
||||
.map(|diagnostic| diagnostic.message.as_str())
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Resource, Debug, Default)]
|
||||
pub struct ColliderDiagnosticsState {
|
||||
pub entries: HashMap<Entity, ColliderDiagnosticEntry>,
|
||||
pub valid_actors: usize,
|
||||
pub disabled_actors: usize,
|
||||
pub warning_actors: usize,
|
||||
pub error_actors: usize,
|
||||
}
|
||||
|
||||
impl ColliderDiagnosticsState {
|
||||
pub fn entry(&self, entity: Entity) -> Option<&ColliderDiagnosticEntry> {
|
||||
self.entries.get(&entity)
|
||||
}
|
||||
}
|
||||
|
||||
pub fn refresh_collider_diagnostics(world: &mut World) {
|
||||
let entities = world
|
||||
.iter_entities()
|
||||
.filter(|entity| entity.contains::<LevelObject>())
|
||||
.map(|entity| entity.id())
|
||||
.collect::<Vec<_>>();
|
||||
let mut state = ColliderDiagnosticsState::default();
|
||||
for entity in entities {
|
||||
let Some(entry) = diagnose_collider(world, entity) else {
|
||||
continue;
|
||||
};
|
||||
match entry.overlay_status {
|
||||
ColliderOverlayStatus::Error => state.error_actors += 1,
|
||||
ColliderOverlayStatus::Warning => state.warning_actors += 1,
|
||||
ColliderOverlayStatus::Disabled => state.disabled_actors += 1,
|
||||
_ => state.valid_actors += 1,
|
||||
}
|
||||
state.entries.insert(entity, entry);
|
||||
}
|
||||
world.insert_resource(state);
|
||||
}
|
||||
|
||||
pub fn diagnose_collider(world: &World, entity: Entity) -> Option<ColliderDiagnosticEntry> {
|
||||
let states = world.get::<AuthoringComponentStates>(entity);
|
||||
let order = world.get::<InspectorOrder>(entity);
|
||||
let rigid_body_active = world.get::<RigidBodyDesc>(entity).is_some()
|
||||
&& authoring_component_active(states, order, COMPONENT_RIGID_BODY_DESC);
|
||||
let legacy_active = world.get::<PhysicsBody>(entity).is_some()
|
||||
&& authoring_component_active(states, order, COMPONENT_PHYSICS_BODY);
|
||||
let collider = world.get::<ColliderDesc>(entity);
|
||||
let collider_active =
|
||||
collider.is_some() && authoring_component_active(states, order, COMPONENT_COLLIDER_DESC);
|
||||
|
||||
if !rigid_body_active && !legacy_active && collider.is_none() {
|
||||
return None;
|
||||
}
|
||||
|
||||
let mut diagnostics = Vec::new();
|
||||
if rigid_body_active && !legacy_active && !collider_active {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.missing",
|
||||
severity: ColliderDiagnosticSeverity::Error,
|
||||
message: "Rigid body has no active Collider component.".into(),
|
||||
repair: "Add or enable a Collider component on this actor.".into(),
|
||||
});
|
||||
}
|
||||
|
||||
let mut shape_label = if legacy_active { "Legacy" } else { "Missing" };
|
||||
let mut enabled = legacy_active;
|
||||
let mut trigger = false;
|
||||
let mut authoring_valid = true;
|
||||
if let Some(collider) = collider {
|
||||
shape_label = collider_shape_label(&collider.shape);
|
||||
enabled = collider_active && collider.enabled;
|
||||
trigger = collider.is_trigger;
|
||||
if !collider_active {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.inactive",
|
||||
severity: ColliderDiagnosticSeverity::Info,
|
||||
message: "Collider component is inactive.".into(),
|
||||
repair: "Enable the component when this actor should participate in collision."
|
||||
.into(),
|
||||
});
|
||||
} else if !collider.enabled {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.disabled",
|
||||
severity: ColliderDiagnosticSeverity::Info,
|
||||
message: "Collider is disabled.".into(),
|
||||
repair: "Enable the collider when collision is required.".into(),
|
||||
});
|
||||
} else {
|
||||
let shape_diagnostics = validate_shape(world, entity, &collider.shape);
|
||||
authoring_valid = shape_diagnostics
|
||||
.iter()
|
||||
.all(|diagnostic| diagnostic.severity != ColliderDiagnosticSeverity::Error);
|
||||
diagnostics.extend(shape_diagnostics);
|
||||
}
|
||||
}
|
||||
|
||||
let runtime_ready = has_runtime_collider(world, entity);
|
||||
if enabled && authoring_valid && !runtime_ready {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.runtime_stale",
|
||||
severity: ColliderDiagnosticSeverity::Warning,
|
||||
message: "Authored collider has not hydrated into a runtime shape.".into(),
|
||||
repair: "Check mesh cooking and asset references, then refresh the scene.".into(),
|
||||
});
|
||||
}
|
||||
|
||||
let highest = diagnostics
|
||||
.iter()
|
||||
.map(|diagnostic| diagnostic.severity)
|
||||
.max();
|
||||
let overlay_status = match highest {
|
||||
Some(ColliderDiagnosticSeverity::Error) => ColliderOverlayStatus::Error,
|
||||
Some(ColliderDiagnosticSeverity::Warning) => ColliderOverlayStatus::Warning,
|
||||
_ if !enabled => ColliderOverlayStatus::Disabled,
|
||||
_ if trigger => ColliderOverlayStatus::Trigger,
|
||||
_ => ColliderOverlayStatus::Valid,
|
||||
};
|
||||
|
||||
Some(ColliderDiagnosticEntry {
|
||||
entity,
|
||||
actor_name: entity_name(world, entity),
|
||||
shape_label,
|
||||
runtime_ready,
|
||||
diagnostics,
|
||||
overlay_status,
|
||||
})
|
||||
}
|
||||
|
||||
pub fn physics_placement_prerequisite_problems(world: &World, entity: Entity) -> Vec<String> {
|
||||
let name = entity_name(world, entity);
|
||||
let states = world.get::<AuthoringComponentStates>(entity);
|
||||
let order = world.get::<InspectorOrder>(entity);
|
||||
let split_body = world.get::<RigidBodyDesc>(entity).is_some()
|
||||
&& authoring_component_active(states, order, COMPONENT_RIGID_BODY_DESC);
|
||||
let legacy = world.get::<PhysicsBody>(entity).is_some()
|
||||
&& authoring_component_active(states, order, COMPONENT_PHYSICS_BODY);
|
||||
let collider = world.get::<ColliderDesc>(entity).filter(|collider| {
|
||||
collider.enabled
|
||||
&& !collider.is_trigger
|
||||
&& authoring_component_active(states, order, COMPONENT_COLLIDER_DESC)
|
||||
});
|
||||
|
||||
let mut problems = Vec::new();
|
||||
if !split_body && !legacy {
|
||||
problems.push(format!("{name}: add and enable a Rigid Body component"));
|
||||
}
|
||||
if collider.is_none() && !legacy {
|
||||
problems.push(format!(
|
||||
"{name}: add and enable a non-trigger Collider component"
|
||||
));
|
||||
}
|
||||
if let Some(entry) = diagnose_collider(world, entity) {
|
||||
problems.extend(
|
||||
entry
|
||||
.diagnostics
|
||||
.iter()
|
||||
.filter(|diagnostic| {
|
||||
diagnostic.severity == ColliderDiagnosticSeverity::Error
|
||||
&& diagnostic.code != "collider.missing"
|
||||
})
|
||||
.map(|diagnostic| format!("{name}: {}", diagnostic.message)),
|
||||
);
|
||||
}
|
||||
if world.get::<RigidBody>(entity).is_none() {
|
||||
problems.push(format!("{name}: rigid body has not hydrated yet"));
|
||||
}
|
||||
if !has_runtime_collider(world, entity) {
|
||||
problems.push(format!(
|
||||
"{name}: collider has not hydrated or finished cooking"
|
||||
));
|
||||
}
|
||||
problems.sort();
|
||||
problems.dedup();
|
||||
problems
|
||||
}
|
||||
|
||||
pub fn has_runtime_collider(world: &World, root: Entity) -> bool {
|
||||
let mut pending = vec![root];
|
||||
while let Some(entity) = pending.pop() {
|
||||
if world.get::<Collider>(entity).is_some() {
|
||||
return true;
|
||||
}
|
||||
if let Some(children) = world.get::<Children>(entity) {
|
||||
pending.extend(children.iter());
|
||||
}
|
||||
}
|
||||
false
|
||||
}
|
||||
|
||||
pub fn collider_shape_label(shape: &ColliderShapeDesc) -> &'static str {
|
||||
match shape {
|
||||
ColliderShapeDesc::Cuboid { .. } => "Box",
|
||||
ColliderShapeDesc::Sphere { .. } => "Sphere",
|
||||
ColliderShapeDesc::Capsule { .. } => "Capsule",
|
||||
ColliderShapeDesc::StaticMesh { .. } => "Static Mesh",
|
||||
}
|
||||
}
|
||||
|
||||
fn validate_shape(
|
||||
world: &World,
|
||||
entity: Entity,
|
||||
shape: &ColliderShapeDesc,
|
||||
) -> Vec<ColliderDiagnostic> {
|
||||
let mut diagnostics = Vec::new();
|
||||
let dimensions = match shape {
|
||||
ColliderShapeDesc::Cuboid {
|
||||
x_length,
|
||||
y_length,
|
||||
z_length,
|
||||
} => Some(Vec3::new(*x_length, *y_length, *z_length)),
|
||||
ColliderShapeDesc::Sphere { radius } => Some(Vec3::splat(*radius * 2.0)),
|
||||
ColliderShapeDesc::Capsule { radius, height } => {
|
||||
Some(Vec3::new(*radius * 2.0, *height, *radius * 2.0))
|
||||
}
|
||||
ColliderShapeDesc::StaticMesh { meshes, .. } => {
|
||||
if meshes.is_empty() {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.mesh_missing",
|
||||
severity: ColliderDiagnosticSeverity::Error,
|
||||
message: "Static mesh collider has no mesh sources.".into(),
|
||||
repair: "Choose a mesh source or use the actor renderer meshes.".into(),
|
||||
});
|
||||
}
|
||||
for mesh in meshes {
|
||||
if !mesh.is_resolved() {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.mesh_invalid_ref",
|
||||
severity: ColliderDiagnosticSeverity::Error,
|
||||
message: format!(
|
||||
"Static mesh source `{}` has no stable asset or sub-asset ID.",
|
||||
mesh.label
|
||||
),
|
||||
repair: "Choose a valid mesh from the asset browser.".into(),
|
||||
});
|
||||
} else if world
|
||||
.get_resource::<AssetRegistry>()
|
||||
.is_some_and(|registry| find_asset_by_id(registry, &mesh.asset_id).is_none())
|
||||
{
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.mesh_stale_ref",
|
||||
severity: ColliderDiagnosticSeverity::Error,
|
||||
message: format!(
|
||||
"Static mesh source `{}` no longer exists in the asset registry.",
|
||||
mesh.label
|
||||
),
|
||||
repair: "Relink the collider to an existing mesh asset.".into(),
|
||||
});
|
||||
}
|
||||
}
|
||||
None
|
||||
}
|
||||
};
|
||||
|
||||
if let Some(dimensions) = dimensions {
|
||||
if !dimensions.is_finite() || dimensions.min_element() <= 0.0 {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.invalid_dimensions",
|
||||
severity: ColliderDiagnosticSeverity::Error,
|
||||
message: "Collider dimensions must be positive finite values.".into(),
|
||||
repair: "Reset the shape or enter valid dimensions.".into(),
|
||||
});
|
||||
} else {
|
||||
let scale = world
|
||||
.get::<GlobalTransform>(entity)
|
||||
.map(|global| global.to_scale_rotation_translation().0.abs())
|
||||
.unwrap_or(Vec3::ONE);
|
||||
let world_extent = (dimensions * scale).max_element();
|
||||
if world_extent > OVERSIZED_COLLIDER_EXTENT {
|
||||
diagnostics.push(ColliderDiagnostic {
|
||||
code: "collider.oversized",
|
||||
severity: ColliderDiagnosticSeverity::Warning,
|
||||
message: format!(
|
||||
"Collider spans {world_extent:.1} m in world space (recommended maximum: {OVERSIZED_COLLIDER_EXTENT:.0} m)."
|
||||
),
|
||||
repair: "Reduce collider dimensions or actor scale; split large collision into smaller actors."
|
||||
.into(),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
diagnostics
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use shared::AuthoringRigidBody;
|
||||
|
||||
#[test]
|
||||
fn reports_missing_invalid_oversized_and_stale_runtime_colliders() {
|
||||
let mut world = World::new();
|
||||
let missing = world
|
||||
.spawn((LevelObject, RigidBodyDesc::default(), Transform::default()))
|
||||
.id();
|
||||
let invalid = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
ColliderDesc {
|
||||
enabled: true,
|
||||
is_trigger: false,
|
||||
shape: ColliderShapeDesc::Sphere { radius: 0.0 },
|
||||
},
|
||||
Transform::default(),
|
||||
))
|
||||
.id();
|
||||
let oversized = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
ColliderDesc::static_cuboid(Vec3::splat(2.0)),
|
||||
Transform::from_scale(Vec3::splat(600.0)),
|
||||
GlobalTransform::from(Transform::from_scale(Vec3::splat(600.0))),
|
||||
))
|
||||
.id();
|
||||
|
||||
let missing = diagnose_collider(&world, missing).unwrap();
|
||||
assert!(missing
|
||||
.diagnostics
|
||||
.iter()
|
||||
.any(|diagnostic| diagnostic.code == "collider.missing"));
|
||||
|
||||
let invalid = diagnose_collider(&world, invalid).unwrap();
|
||||
assert!(invalid
|
||||
.diagnostics
|
||||
.iter()
|
||||
.any(|diagnostic| diagnostic.code == "collider.invalid_dimensions"));
|
||||
|
||||
let oversized = diagnose_collider(&world, oversized).unwrap();
|
||||
assert!(oversized
|
||||
.diagnostics
|
||||
.iter()
|
||||
.any(|diagnostic| diagnostic.code == "collider.oversized"));
|
||||
assert!(oversized
|
||||
.diagnostics
|
||||
.iter()
|
||||
.any(|diagnostic| diagnostic.code == "collider.runtime_stale"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hydrated_trigger_has_trigger_overlay_status() {
|
||||
let mut world = World::new();
|
||||
let entity = world
|
||||
.spawn((
|
||||
LevelObject,
|
||||
RigidBodyDesc {
|
||||
body: AuthoringRigidBody::Static,
|
||||
},
|
||||
ColliderDesc {
|
||||
enabled: true,
|
||||
is_trigger: true,
|
||||
shape: ColliderShapeDesc::Sphere { radius: 1.0 },
|
||||
},
|
||||
Collider::sphere(1.0),
|
||||
Transform::default(),
|
||||
))
|
||||
.id();
|
||||
|
||||
let entry = diagnose_collider(&world, entity).unwrap();
|
||||
assert_eq!(entry.overlay_status, ColliderOverlayStatus::Trigger);
|
||||
assert!(entry.runtime_ready);
|
||||
}
|
||||
}
|
||||
@@ -779,31 +779,17 @@ fn update_material_drop_session(world: &mut World) {
|
||||
.is_some_and(|buttons| buttons.just_pressed(MouseButton::Right));
|
||||
|
||||
if cancel_requested && (selection.is_some() || state.preview.is_some()) {
|
||||
restore_material_drop_preview(world, state.preview.take());
|
||||
cancel_material_drop_session(world, &mut state, true);
|
||||
clear_drag_and_viewport_click(world);
|
||||
state.feedback = None;
|
||||
state.captures_viewport_input = false;
|
||||
state.cancel_consumed = true;
|
||||
set_drop_operator_status(
|
||||
world,
|
||||
OperatorPhase::Canceled,
|
||||
"Surface assignment canceled",
|
||||
);
|
||||
world.insert_resource(state);
|
||||
return;
|
||||
}
|
||||
|
||||
let Some(selection) = selection else {
|
||||
let had_preview = state.preview.is_some();
|
||||
restore_material_drop_preview(world, state.preview.take());
|
||||
state.feedback = None;
|
||||
state.captures_viewport_input = false;
|
||||
if had_preview {
|
||||
set_drop_operator_status(
|
||||
world,
|
||||
OperatorPhase::Canceled,
|
||||
"Surface assignment canceled",
|
||||
);
|
||||
if state.preview.is_some() {
|
||||
cancel_material_drop_session(world, &mut state, false);
|
||||
} else {
|
||||
reset_material_drop_session(&mut state, false);
|
||||
}
|
||||
world.insert_resource(state);
|
||||
return;
|
||||
@@ -877,19 +863,44 @@ fn update_material_drop_session(world: &mut World) {
|
||||
);
|
||||
|
||||
if primary_released {
|
||||
let preview = state.preview.take();
|
||||
if let Some(preview) = preview.as_ref() {
|
||||
preview.snapshot.restore(world);
|
||||
}
|
||||
if let Some(preview) = preview {
|
||||
commit_material_drop_preview(world, preview);
|
||||
}
|
||||
commit_material_drop_session(world, &mut state);
|
||||
clear_drag_and_viewport_click(world);
|
||||
state.captures_viewport_input = false;
|
||||
}
|
||||
world.insert_resource(state);
|
||||
}
|
||||
|
||||
fn cancel_material_drop_session(
|
||||
world: &mut World,
|
||||
state: &mut MaterialDropState,
|
||||
cancel_consumed: bool,
|
||||
) {
|
||||
restore_material_drop_preview(world, state.preview.take());
|
||||
reset_material_drop_session(state, cancel_consumed);
|
||||
set_drop_operator_status(
|
||||
world,
|
||||
OperatorPhase::Canceled,
|
||||
"Surface assignment canceled",
|
||||
);
|
||||
}
|
||||
|
||||
fn commit_material_drop_session(world: &mut World, state: &mut MaterialDropState) -> bool {
|
||||
let Some(preview) = state.preview.take() else {
|
||||
reset_material_drop_session(state, false);
|
||||
return false;
|
||||
};
|
||||
preview.snapshot.restore(world);
|
||||
let committed = commit_material_drop_preview(world, preview);
|
||||
reset_material_drop_session(state, false);
|
||||
committed
|
||||
}
|
||||
|
||||
fn reset_material_drop_session(state: &mut MaterialDropState, cancel_consumed: bool) {
|
||||
state.resolved = None;
|
||||
state.feedback = None;
|
||||
state.captures_viewport_input = false;
|
||||
state.cancel_consumed = cancel_consumed;
|
||||
}
|
||||
|
||||
fn restore_material_drop_preview(world: &mut World, preview: Option<MaterialDropPreview>) {
|
||||
if let Some(preview) = preview {
|
||||
preview.snapshot.restore(world);
|
||||
@@ -1029,7 +1040,8 @@ fn draw_material_drop_target(
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::{apply_command_undo, EditorHistory};
|
||||
use crate::history::EditorHistory;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use shared::{ActorKind, RendererMaterialSet, RendererMaterialSlot, SharedTypesPlugin};
|
||||
|
||||
fn test_app() -> App {
|
||||
@@ -1098,6 +1110,7 @@ mod tests {
|
||||
hit_point: Vec3::ZERO,
|
||||
hit_normal: Vec3::Y,
|
||||
};
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
let preview = begin_material_drop_preview(
|
||||
world,
|
||||
AssetSelection::File("assets/materials/steel.ron".into()),
|
||||
@@ -1123,18 +1136,25 @@ mod tests {
|
||||
assert!(!world.resource::<SceneIo>().dirty);
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 0);
|
||||
|
||||
preview.snapshot.restore(world);
|
||||
assert!(world
|
||||
.get::<StaticMeshRenderer>(entity)
|
||||
.unwrap()
|
||||
.materials
|
||||
.slot(&slot_b)
|
||||
.unwrap()
|
||||
.material
|
||||
.is_none());
|
||||
assert!(commit_material_drop_preview(world, preview));
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 1);
|
||||
assert!(world.resource::<SceneIo>().dirty);
|
||||
let mut state = MaterialDropState {
|
||||
resolved: Some(target),
|
||||
preview: Some(preview),
|
||||
feedback: Some(MaterialDropFeedback {
|
||||
valid: true,
|
||||
action: "Assign material".into(),
|
||||
target: "Crate / B".into(),
|
||||
}),
|
||||
captures_viewport_input: true,
|
||||
cancel_consumed: false,
|
||||
};
|
||||
assert!(commit_material_drop_session(world, &mut state));
|
||||
harness.assert_committed(world, 1, 0);
|
||||
harness.assert_status(world, "assets.assign_surface", OperatorPhase::Committed);
|
||||
assert!(state.preview.is_none());
|
||||
assert!(state.resolved.is_none());
|
||||
assert!(state.feedback.is_none());
|
||||
assert!(!state.captures_viewport_input);
|
||||
assert!(!state.cancel_consumed);
|
||||
assert!(world
|
||||
.get::<StaticMeshRenderer>(entity)
|
||||
.unwrap()
|
||||
@@ -1143,16 +1163,17 @@ mod tests {
|
||||
.unwrap()
|
||||
.material
|
||||
.is_none());
|
||||
|
||||
apply_command_undo(world);
|
||||
assert!(world
|
||||
.get::<StaticMeshRenderer>(entity)
|
||||
.unwrap()
|
||||
.materials
|
||||
.slot(&slot_b)
|
||||
.unwrap()
|
||||
.material
|
||||
.is_none());
|
||||
assert_undo_redo_round_trip(world, None, Some("steel".to_string()), |world| {
|
||||
world
|
||||
.get::<StaticMeshRenderer>(entity)
|
||||
.unwrap()
|
||||
.materials
|
||||
.slot(&slot_b)
|
||||
.unwrap()
|
||||
.material
|
||||
.as_ref()
|
||||
.map(|material| material.0.asset_id.clone())
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -1172,6 +1193,7 @@ mod tests {
|
||||
hit_point: Vec3::ZERO,
|
||||
hit_normal: Vec3::Y,
|
||||
};
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
let preview = begin_material_drop_preview(
|
||||
world,
|
||||
AssetSelection::File("assets/materials/steel.ron".into()),
|
||||
@@ -1196,9 +1218,26 @@ mod tests {
|
||||
.material
|
||||
.is_none());
|
||||
|
||||
preview.snapshot.restore(world);
|
||||
let mut state = MaterialDropState {
|
||||
resolved: Some(target),
|
||||
preview: Some(preview),
|
||||
feedback: Some(MaterialDropFeedback {
|
||||
valid: true,
|
||||
action: "Assign material".into(),
|
||||
target: "Blockout / face".into(),
|
||||
}),
|
||||
captures_viewport_input: true,
|
||||
cancel_consumed: false,
|
||||
};
|
||||
cancel_material_drop_session(world, &mut state, true);
|
||||
harness.assert_canceled(world);
|
||||
harness.assert_status(world, "assets.assign_surface", OperatorPhase::Canceled);
|
||||
assert_eq!(world.get::<BrushDesc>(entity), Some(&brush));
|
||||
assert!(!world.resource::<SceneIo>().dirty);
|
||||
assert!(state.preview.is_none());
|
||||
assert!(state.resolved.is_none());
|
||||
assert!(state.feedback.is_none());
|
||||
assert!(!state.captures_viewport_input);
|
||||
assert!(state.cancel_consumed);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -5,13 +5,17 @@ pub mod brush_csg;
|
||||
pub mod brush_edit;
|
||||
pub mod brush_tool;
|
||||
pub mod camera;
|
||||
pub mod collider_diagnostics;
|
||||
pub mod gizmos;
|
||||
pub mod material_drop;
|
||||
mod panel;
|
||||
pub mod physics_placement;
|
||||
pub mod render_view;
|
||||
pub mod rendering_diagnostics;
|
||||
pub mod selection;
|
||||
pub mod selection_outline;
|
||||
pub mod terrain_paint;
|
||||
pub mod terrain_sculpt;
|
||||
pub mod viewport_mode;
|
||||
pub mod visualizers;
|
||||
|
||||
@@ -24,4 +28,7 @@ pub use brush_edit::{BrushEditMode, BrushEditPlugin, BrushElementSelection};
|
||||
pub use brush_tool::{BrushToolPlugin, BrushToolState};
|
||||
pub use material_drop::{MaterialDropFeedback, MaterialDropPlugin, MaterialDropState};
|
||||
pub use panel::*;
|
||||
pub use physics_placement::{PhysicsPlacementPlugin, PhysicsPlacementState};
|
||||
pub use terrain_paint::{TerrainPaintMode, TerrainPaintPlugin, TerrainPaintState};
|
||||
pub use terrain_sculpt::{TerrainSculptMode, TerrainSculptPlugin, TerrainSculptState};
|
||||
pub use viewport_mode::EditorViewportMode;
|
||||
@@ -0,0 +1,697 @@
|
||||
//! Transactional gravity placement using the editor's hydrated Avian world.
|
||||
|
||||
use std::collections::HashSet;
|
||||
use std::time::Duration;
|
||||
|
||||
use avian3d::prelude::*;
|
||||
use bevy::prelude::*;
|
||||
|
||||
use crate::history::{set_transform_group_with_history, EditorHistory};
|
||||
use crate::operators::{ActiveOperator, OperatorPhase, OperatorStatus};
|
||||
use crate::state::EditorMode;
|
||||
use crate::ui::selection_ops::{entity_name, is_mutable_level_object};
|
||||
use crate::viewport::collider_diagnostics::physics_placement_prerequisite_problems;
|
||||
|
||||
const STEP_HZ: f64 = 120.0;
|
||||
const STEPS_PER_FRAME: usize = 4;
|
||||
const SETTLE_LINEAR_SPEED: f32 = 0.04;
|
||||
const SETTLE_ANGULAR_SPEED: f32 = 0.04;
|
||||
const SETTLE_STEPS: u32 = 30;
|
||||
const MAX_STEPS: u32 = 1_200;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
||||
pub enum PhysicsPlacementPhase {
|
||||
#[default]
|
||||
Inactive,
|
||||
Dropping,
|
||||
Settled,
|
||||
TimedOut,
|
||||
}
|
||||
|
||||
impl PhysicsPlacementPhase {
|
||||
pub fn label(self) -> &'static str {
|
||||
match self {
|
||||
Self::Inactive => "Inactive",
|
||||
Self::Dropping => "Simulating",
|
||||
Self::Settled => "Settled",
|
||||
Self::TimedOut => "Preview stopped",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
||||
pub enum PhysicsPlacementRequest {
|
||||
#[default]
|
||||
None,
|
||||
Commit,
|
||||
Cancel,
|
||||
}
|
||||
|
||||
#[derive(Component, Debug, Clone, Copy, Default)]
|
||||
pub struct PhysicsPlacementPreview;
|
||||
|
||||
#[derive(Resource, Debug, Default)]
|
||||
pub struct PhysicsPlacementState {
|
||||
pub phase: PhysicsPlacementPhase,
|
||||
pub request: PhysicsPlacementRequest,
|
||||
pub last_error: Option<String>,
|
||||
pub selected_count: usize,
|
||||
pub simulated_steps: u32,
|
||||
session: Option<PlacementSession>,
|
||||
}
|
||||
|
||||
impl PhysicsPlacementState {
|
||||
pub fn active(&self) -> bool {
|
||||
self.session.is_some()
|
||||
}
|
||||
|
||||
pub fn simulated_seconds(&self) -> f32 {
|
||||
self.simulated_steps as f32 / STEP_HZ as f32
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct PlacementSession {
|
||||
selected: Vec<BodySnapshot>,
|
||||
frozen: Vec<BodySnapshot>,
|
||||
stable_steps: u32,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct BodySnapshot {
|
||||
entity: Entity,
|
||||
transform: Transform,
|
||||
position: Option<Position>,
|
||||
rotation: Option<Rotation>,
|
||||
rigid_body: RigidBody,
|
||||
linear_velocity: Option<LinearVelocity>,
|
||||
angular_velocity: Option<AngularVelocity>,
|
||||
gravity_scale: Option<GravityScale>,
|
||||
sleeping: bool,
|
||||
sleeping_disabled: bool,
|
||||
rigid_body_disabled: bool,
|
||||
}
|
||||
|
||||
impl BodySnapshot {
|
||||
fn capture(world: &World, entity: Entity) -> Result<Self, String> {
|
||||
Ok(Self {
|
||||
entity,
|
||||
transform: world
|
||||
.get::<Transform>(entity)
|
||||
.copied()
|
||||
.ok_or_else(|| format!("{} has no Transform", entity_name(world, entity)))?,
|
||||
position: world.get::<Position>(entity).copied(),
|
||||
rotation: world.get::<Rotation>(entity).copied(),
|
||||
rigid_body: world.get::<RigidBody>(entity).copied().ok_or_else(|| {
|
||||
format!("{} has no hydrated rigid body", entity_name(world, entity))
|
||||
})?,
|
||||
linear_velocity: world.get::<LinearVelocity>(entity).copied(),
|
||||
angular_velocity: world.get::<AngularVelocity>(entity).copied(),
|
||||
gravity_scale: world.get::<GravityScale>(entity).copied(),
|
||||
sleeping: world.get::<Sleeping>(entity).is_some(),
|
||||
sleeping_disabled: world.get::<SleepingDisabled>(entity).is_some(),
|
||||
rigid_body_disabled: world.get::<RigidBodyDisabled>(entity).is_some(),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
pub struct PhysicsPlacementPlugin;
|
||||
|
||||
impl Plugin for PhysicsPlacementPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.init_resource::<PhysicsPlacementState>()
|
||||
.add_systems(PostStartup, pause_physics_for_editor)
|
||||
.add_systems(PostUpdate, tick_physics_placement)
|
||||
.add_systems(OnExit(EditorMode::Editing), cancel_physics_placement);
|
||||
}
|
||||
}
|
||||
|
||||
fn pause_physics_for_editor(mut physics_time: ResMut<Time<Physics>>) {
|
||||
physics_time.pause();
|
||||
}
|
||||
|
||||
pub fn begin_physics_placement(
|
||||
world: &mut World,
|
||||
selected: impl IntoIterator<Item = Entity>,
|
||||
) -> Result<(), String> {
|
||||
if *world.resource::<State<EditorMode>>().get() != EditorMode::Editing {
|
||||
return placement_error(world, "Physics placement is available only in Edit mode");
|
||||
}
|
||||
if world.resource::<PhysicsPlacementState>().active() {
|
||||
return placement_error(world, "A physics placement preview is already active");
|
||||
}
|
||||
|
||||
let mut unique = HashSet::new();
|
||||
let selected = selected
|
||||
.into_iter()
|
||||
.filter(|entity| unique.insert(*entity))
|
||||
.collect::<Vec<_>>();
|
||||
validate_selection(world, &selected)?;
|
||||
|
||||
let selected_set = selected.iter().copied().collect::<HashSet<_>>();
|
||||
let selected_snapshots = selected
|
||||
.iter()
|
||||
.map(|entity| BodySnapshot::capture(world, *entity))
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
let movable = world
|
||||
.query::<(Entity, &RigidBody)>()
|
||||
.iter(world)
|
||||
.filter_map(|(entity, body)| {
|
||||
(!selected_set.contains(&entity) && *body != RigidBody::Static).then_some(entity)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
let frozen_snapshots = movable
|
||||
.iter()
|
||||
.map(|entity| BodySnapshot::capture(world, *entity))
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
for snapshot in &frozen_snapshots {
|
||||
if let Ok(mut entity) = world.get_entity_mut(snapshot.entity) {
|
||||
entity.insert(RigidBody::Static);
|
||||
}
|
||||
}
|
||||
for snapshot in &selected_snapshots {
|
||||
let global = world
|
||||
.get::<GlobalTransform>(snapshot.entity)
|
||||
.copied()
|
||||
.unwrap_or_else(|| GlobalTransform::from(snapshot.transform));
|
||||
if let Ok(mut entity) = world.get_entity_mut(snapshot.entity) {
|
||||
entity.insert((
|
||||
RigidBody::Dynamic,
|
||||
LinearVelocity::ZERO,
|
||||
AngularVelocity::ZERO,
|
||||
GravityScale(1.0),
|
||||
Position(global.translation()),
|
||||
Rotation(global.rotation()),
|
||||
PhysicsPlacementPreview,
|
||||
));
|
||||
entity.remove::<Sleeping>();
|
||||
entity.remove::<RigidBodyDisabled>();
|
||||
}
|
||||
}
|
||||
|
||||
let selected_count = selected_snapshots.len();
|
||||
let mut state = world.resource_mut::<PhysicsPlacementState>();
|
||||
state.phase = PhysicsPlacementPhase::Dropping;
|
||||
state.request = PhysicsPlacementRequest::None;
|
||||
state.last_error = None;
|
||||
state.selected_count = selected_count;
|
||||
state.simulated_steps = 0;
|
||||
state.session = Some(PlacementSession {
|
||||
selected: selected_snapshots,
|
||||
frozen: frozen_snapshots,
|
||||
stable_steps: 0,
|
||||
});
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorPhase::Preview,
|
||||
format!("Dropping {selected_count} selected prop(s)"),
|
||||
Vec::new(),
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn request_physics_placement(world: &mut World, request: PhysicsPlacementRequest) {
|
||||
if world.resource::<PhysicsPlacementState>().active() {
|
||||
world.resource_mut::<PhysicsPlacementState>().request = request;
|
||||
}
|
||||
}
|
||||
|
||||
pub fn cancel_physics_placement(world: &mut World) {
|
||||
finish_physics_placement(world, false);
|
||||
}
|
||||
|
||||
pub fn commit_physics_placement(world: &mut World) {
|
||||
finish_physics_placement(world, true);
|
||||
}
|
||||
|
||||
fn finish_physics_placement(world: &mut World, commit: bool) {
|
||||
let Some(mut state) = world.remove_resource::<PhysicsPlacementState>() else {
|
||||
return;
|
||||
};
|
||||
let Some(session) = state.session.take() else {
|
||||
world.insert_resource(state);
|
||||
return;
|
||||
};
|
||||
|
||||
let final_transforms = session
|
||||
.selected
|
||||
.iter()
|
||||
.filter_map(|snapshot| {
|
||||
world
|
||||
.get::<Transform>(snapshot.entity)
|
||||
.copied()
|
||||
.map(|transform| (snapshot.entity, transform))
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
for snapshot in &session.frozen {
|
||||
restore_snapshot(world, snapshot, true);
|
||||
}
|
||||
for snapshot in &session.selected {
|
||||
restore_snapshot(world, snapshot, !commit);
|
||||
if let Ok(mut entity) = world.get_entity_mut(snapshot.entity) {
|
||||
entity.remove::<PhysicsPlacementPreview>();
|
||||
}
|
||||
}
|
||||
|
||||
let undo_depth = world.resource::<EditorHistory>().undo_depth();
|
||||
if commit {
|
||||
let changes = session.selected.iter().filter_map(|snapshot| {
|
||||
final_transforms
|
||||
.iter()
|
||||
.find(|(entity, _)| *entity == snapshot.entity)
|
||||
.map(|(_, new)| (snapshot.entity, snapshot.transform, *new))
|
||||
});
|
||||
set_transform_group_with_history(world, changes);
|
||||
}
|
||||
let committed = commit && world.resource::<EditorHistory>().undo_depth() > undo_depth;
|
||||
|
||||
state.phase = PhysicsPlacementPhase::Inactive;
|
||||
state.request = PhysicsPlacementRequest::None;
|
||||
state.selected_count = 0;
|
||||
state.simulated_steps = 0;
|
||||
state.last_error = None;
|
||||
world.insert_resource(state);
|
||||
let (phase, hint) = if committed {
|
||||
(OperatorPhase::Committed, "Physics placement committed")
|
||||
} else if commit {
|
||||
(OperatorPhase::Canceled, "Physics placement made no changes")
|
||||
} else {
|
||||
(OperatorPhase::Canceled, "Physics placement canceled")
|
||||
};
|
||||
set_operator_status(world, phase, hint.to_string(), Vec::new());
|
||||
}
|
||||
|
||||
fn tick_physics_placement(world: &mut World) {
|
||||
let escape = world
|
||||
.get_resource::<ButtonInput<KeyCode>>()
|
||||
.is_some_and(|keys| keys.just_pressed(KeyCode::Escape));
|
||||
let enter = world
|
||||
.get_resource::<ButtonInput<KeyCode>>()
|
||||
.is_some_and(|keys| keys.just_pressed(KeyCode::Enter));
|
||||
let request = world.resource::<PhysicsPlacementState>().request;
|
||||
let settled = matches!(
|
||||
world.resource::<PhysicsPlacementState>().phase,
|
||||
PhysicsPlacementPhase::Settled | PhysicsPlacementPhase::TimedOut
|
||||
);
|
||||
if escape || request == PhysicsPlacementRequest::Cancel {
|
||||
cancel_physics_placement(world);
|
||||
return;
|
||||
}
|
||||
if request == PhysicsPlacementRequest::Commit || (enter && settled) {
|
||||
commit_physics_placement(world);
|
||||
return;
|
||||
}
|
||||
if world.resource::<PhysicsPlacementState>().phase != PhysicsPlacementPhase::Dropping {
|
||||
return;
|
||||
}
|
||||
|
||||
for _ in 0..STEPS_PER_FRAME {
|
||||
world
|
||||
.resource_mut::<Time<Physics>>()
|
||||
.advance_by(Duration::from_secs_f64(1.0 / STEP_HZ));
|
||||
world.run_schedule(FixedPostUpdate);
|
||||
}
|
||||
|
||||
let Some(mut state) = world.remove_resource::<PhysicsPlacementState>() else {
|
||||
return;
|
||||
};
|
||||
state.simulated_steps = state.simulated_steps.saturating_add(STEPS_PER_FRAME as u32);
|
||||
let Some(session) = state.session.as_mut() else {
|
||||
world.insert_resource(state);
|
||||
return;
|
||||
};
|
||||
let at_rest = session.selected.iter().all(|snapshot| {
|
||||
let linear = world
|
||||
.get::<LinearVelocity>(snapshot.entity)
|
||||
.map_or(0.0, |velocity| velocity.length());
|
||||
let angular = world
|
||||
.get::<AngularVelocity>(snapshot.entity)
|
||||
.map_or(0.0, |velocity| velocity.length());
|
||||
(linear <= SETTLE_LINEAR_SPEED && angular <= SETTLE_ANGULAR_SPEED)
|
||||
|| world.get::<Sleeping>(snapshot.entity).is_some()
|
||||
});
|
||||
session.stable_steps = if at_rest {
|
||||
session.stable_steps.saturating_add(STEPS_PER_FRAME as u32)
|
||||
} else {
|
||||
0
|
||||
};
|
||||
|
||||
let mut status = None;
|
||||
if session.stable_steps >= SETTLE_STEPS {
|
||||
state.phase = PhysicsPlacementPhase::Settled;
|
||||
status = Some((
|
||||
OperatorPhase::Preview,
|
||||
"Placement settled; commit or cancel".to_string(),
|
||||
Vec::new(),
|
||||
));
|
||||
} else if state.simulated_steps >= MAX_STEPS {
|
||||
state.phase = PhysicsPlacementPhase::TimedOut;
|
||||
status = Some((
|
||||
OperatorPhase::Preview,
|
||||
"Placement reached its 10 second preview limit".to_string(),
|
||||
vec!["Bodies are still moving; commit the current pose or cancel".to_string()],
|
||||
));
|
||||
}
|
||||
world.insert_resource(state);
|
||||
if let Some((phase, hint, warnings)) = status {
|
||||
set_operator_status(world, phase, hint, warnings);
|
||||
}
|
||||
}
|
||||
|
||||
fn validate_selection(world: &mut World, selected: &[Entity]) -> Result<(), String> {
|
||||
if selected.is_empty() {
|
||||
return placement_error(world, "Select at least one prop to place with physics");
|
||||
}
|
||||
let mut problems = Vec::new();
|
||||
for entity in selected {
|
||||
let name = entity_name(world, *entity);
|
||||
if !is_mutable_level_object(world, *entity) {
|
||||
problems.push(format!(
|
||||
"{name}: selection is locked, linked, or not a level object"
|
||||
));
|
||||
continue;
|
||||
}
|
||||
problems.extend(physics_placement_prerequisite_problems(world, *entity));
|
||||
}
|
||||
if problems.is_empty() {
|
||||
Ok(())
|
||||
} else {
|
||||
placement_error(world, problems.join("\n"))
|
||||
}
|
||||
}
|
||||
|
||||
fn restore_snapshot(world: &mut World, snapshot: &BodySnapshot, restore_pose: bool) {
|
||||
let Ok(mut entity) = world.get_entity_mut(snapshot.entity) else {
|
||||
return;
|
||||
};
|
||||
entity.insert(snapshot.rigid_body);
|
||||
restore_optional(&mut entity, snapshot.linear_velocity);
|
||||
restore_optional(&mut entity, snapshot.angular_velocity);
|
||||
restore_optional(&mut entity, snapshot.gravity_scale);
|
||||
restore_marker::<Sleeping>(&mut entity, snapshot.sleeping);
|
||||
restore_marker::<SleepingDisabled>(&mut entity, snapshot.sleeping_disabled);
|
||||
restore_marker::<RigidBodyDisabled>(&mut entity, snapshot.rigid_body_disabled);
|
||||
if restore_pose {
|
||||
entity.insert(snapshot.transform);
|
||||
restore_optional(&mut entity, snapshot.position);
|
||||
restore_optional(&mut entity, snapshot.rotation);
|
||||
}
|
||||
}
|
||||
|
||||
fn restore_optional<T: Component + Clone>(entity: &mut EntityWorldMut<'_>, value: Option<T>) {
|
||||
if let Some(value) = value {
|
||||
entity.insert(value);
|
||||
} else {
|
||||
entity.remove::<T>();
|
||||
}
|
||||
}
|
||||
|
||||
fn restore_marker<T: Component + Default>(entity: &mut EntityWorldMut<'_>, present: bool) {
|
||||
if present {
|
||||
entity.insert(T::default());
|
||||
} else {
|
||||
entity.remove::<T>();
|
||||
}
|
||||
}
|
||||
|
||||
fn placement_error<T>(world: &mut World, message: impl Into<String>) -> Result<T, String> {
|
||||
let message = message.into();
|
||||
world.resource_mut::<PhysicsPlacementState>().last_error = Some(message.clone());
|
||||
set_operator_status(
|
||||
world,
|
||||
OperatorPhase::Blocked,
|
||||
"Physics placement could not start".to_string(),
|
||||
message.lines().map(str::to_string).collect(),
|
||||
);
|
||||
Err(message)
|
||||
}
|
||||
|
||||
fn set_operator_status(
|
||||
world: &mut World,
|
||||
phase: OperatorPhase,
|
||||
hint: String,
|
||||
warnings: Vec<String>,
|
||||
) {
|
||||
if let Some(mut operator) = world.get_resource_mut::<ActiveOperator>() {
|
||||
operator.status = Some(OperatorStatus {
|
||||
id: "physics.placement".to_string(),
|
||||
label: "Physics Placement".to_string(),
|
||||
phase,
|
||||
hint,
|
||||
warnings,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::EditorHistory;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use crate::scene_io::SceneIo;
|
||||
use bevy::asset::{AssetApp, AssetPlugin};
|
||||
use bevy::state::app::StatesPlugin;
|
||||
use shared::{ColliderDesc, LevelObject, RigidBodyDesc};
|
||||
|
||||
fn app_with_physics() -> App {
|
||||
let mut app = App::new();
|
||||
app.add_plugins((
|
||||
MinimalPlugins,
|
||||
AssetPlugin::default(),
|
||||
StatesPlugin,
|
||||
TransformPlugin,
|
||||
PhysicsPlugins::default(),
|
||||
))
|
||||
.init_asset::<Mesh>()
|
||||
.init_state::<EditorMode>()
|
||||
.init_resource::<PhysicsPlacementState>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<ActiveOperator>()
|
||||
.init_resource::<SceneIo>();
|
||||
app.finish();
|
||||
app.cleanup();
|
||||
app.update();
|
||||
app.world_mut().resource_mut::<Time<Physics>>().pause();
|
||||
app
|
||||
}
|
||||
|
||||
fn spawn_placeable(world: &mut World, name: &str, transform: Transform) -> Entity {
|
||||
world
|
||||
.spawn((
|
||||
Name::new(name.to_string()),
|
||||
LevelObject,
|
||||
RigidBodyDesc::default(),
|
||||
ColliderDesc::default(),
|
||||
RigidBody::Static,
|
||||
Collider::cuboid(1.0, 1.0, 1.0),
|
||||
transform,
|
||||
))
|
||||
.id()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn reports_missing_authoring_prerequisites_without_starting() {
|
||||
let mut app = app_with_physics();
|
||||
let entity = app
|
||||
.world_mut()
|
||||
.spawn((Name::new("No Physics"), LevelObject, Transform::default()))
|
||||
.id();
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
let error = begin_physics_placement(app.world_mut(), [entity]).unwrap_err();
|
||||
|
||||
assert!(error.contains("add and enable a Rigid Body"));
|
||||
assert!(error.contains("add and enable a non-trigger Collider"));
|
||||
assert!(!app.world().resource::<PhysicsPlacementState>().active());
|
||||
harness.assert_blocked(app.world_mut());
|
||||
harness.assert_status(app.world(), "physics.placement", OperatorPhase::Blocked);
|
||||
harness.assert_no_helpers::<PhysicsPlacementPreview>(app.world_mut());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cancel_restores_selected_and_unrelated_motion_state_exactly() {
|
||||
let mut app = app_with_physics();
|
||||
let selected = spawn_placeable(
|
||||
app.world_mut(),
|
||||
"Selected",
|
||||
Transform::from_xyz(1.0, 4.0, 2.0),
|
||||
);
|
||||
app.world_mut().entity_mut(selected).insert((
|
||||
RigidBody::Kinematic,
|
||||
LinearVelocity(Vec3::new(1.0, 2.0, 3.0)),
|
||||
AngularVelocity(Vec3::new(0.1, 0.2, 0.3)),
|
||||
GravityScale(0.25),
|
||||
SleepingDisabled,
|
||||
));
|
||||
let unrelated = app
|
||||
.world_mut()
|
||||
.spawn((
|
||||
RigidBody::Dynamic,
|
||||
Collider::sphere(0.5),
|
||||
LinearVelocity(Vec3::X * 3.0),
|
||||
Transform::from_xyz(8.0, 2.0, 0.0),
|
||||
))
|
||||
.id();
|
||||
app.update();
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
begin_physics_placement(app.world_mut(), [selected]).unwrap();
|
||||
assert_eq!(
|
||||
app.world().get::<RigidBody>(selected),
|
||||
Some(&RigidBody::Dynamic)
|
||||
);
|
||||
assert_eq!(
|
||||
app.world().get::<RigidBody>(unrelated),
|
||||
Some(&RigidBody::Static)
|
||||
);
|
||||
for _ in 0..10 {
|
||||
tick_physics_placement(app.world_mut());
|
||||
}
|
||||
assert!(
|
||||
app.world()
|
||||
.get::<Transform>(selected)
|
||||
.unwrap()
|
||||
.translation
|
||||
.y
|
||||
< 4.0
|
||||
);
|
||||
|
||||
cancel_physics_placement(app.world_mut());
|
||||
|
||||
assert_eq!(
|
||||
app.world().get::<Transform>(selected).unwrap().translation,
|
||||
Vec3::new(1.0, 4.0, 2.0)
|
||||
);
|
||||
assert_eq!(
|
||||
app.world().get::<RigidBody>(selected),
|
||||
Some(&RigidBody::Kinematic)
|
||||
);
|
||||
assert_eq!(
|
||||
app.world().get::<LinearVelocity>(selected),
|
||||
Some(&LinearVelocity(Vec3::new(1.0, 2.0, 3.0)))
|
||||
);
|
||||
assert_eq!(
|
||||
app.world().get::<GravityScale>(selected),
|
||||
Some(&GravityScale(0.25))
|
||||
);
|
||||
assert!(app.world().get::<SleepingDisabled>(selected).is_some());
|
||||
assert_eq!(
|
||||
app.world().get::<RigidBody>(unrelated),
|
||||
Some(&RigidBody::Dynamic)
|
||||
);
|
||||
assert_eq!(
|
||||
app.world().get::<LinearVelocity>(unrelated),
|
||||
Some(&LinearVelocity(Vec3::X * 3.0))
|
||||
);
|
||||
assert_eq!(app.world().resource::<EditorHistory>().undo_depth(), 0);
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "physics.placement", OperatorPhase::Canceled);
|
||||
harness.assert_no_helpers::<PhysicsPlacementPreview>(app.world_mut());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn real_physics_drop_commits_once_and_undo_restores_start_transform() {
|
||||
let mut app = app_with_physics();
|
||||
app.world_mut().spawn((
|
||||
RigidBody::Static,
|
||||
Collider::cuboid(20.0, 0.5, 20.0),
|
||||
Transform::from_xyz(0.0, -0.25, 0.0),
|
||||
));
|
||||
let start = Transform::from_xyz(0.0, 4.0, 0.0);
|
||||
let prop = spawn_placeable(app.world_mut(), "Drop Prop", start);
|
||||
app.update();
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
begin_physics_placement(app.world_mut(), [prop]).unwrap();
|
||||
for _ in 0..400 {
|
||||
tick_physics_placement(app.world_mut());
|
||||
if app.world().resource::<PhysicsPlacementState>().phase
|
||||
== PhysicsPlacementPhase::Settled
|
||||
{
|
||||
break;
|
||||
}
|
||||
}
|
||||
assert_eq!(
|
||||
app.world().resource::<PhysicsPlacementState>().phase,
|
||||
PhysicsPlacementPhase::Settled
|
||||
);
|
||||
let settled = *app.world().get::<Transform>(prop).unwrap();
|
||||
assert!(settled.translation.y < 1.0, "{settled:?}");
|
||||
|
||||
commit_physics_placement(app.world_mut());
|
||||
|
||||
harness.assert_committed(app.world_mut(), 1, 0);
|
||||
harness.assert_status(app.world(), "physics.placement", OperatorPhase::Committed);
|
||||
harness.assert_no_helpers::<PhysicsPlacementPreview>(app.world_mut());
|
||||
assert_eq!(
|
||||
app.world().resource::<EditorHistory>().status,
|
||||
"Undo: Move Selection"
|
||||
);
|
||||
assert_eq!(app.world().get::<RigidBody>(prop), Some(&RigidBody::Static));
|
||||
assert_eq!(*app.world().get::<Transform>(prop).unwrap(), settled);
|
||||
assert_undo_redo_round_trip(app.world_mut(), start, settled, |world| {
|
||||
*world.get::<Transform>(prop).unwrap()
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_op_commit_terminates_without_dirtying_or_history() {
|
||||
let mut app = app_with_physics();
|
||||
let start = Transform::from_xyz(0.0, 4.0, 0.0);
|
||||
let prop = spawn_placeable(app.world_mut(), "Static Prop", start);
|
||||
app.update();
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
begin_physics_placement(app.world_mut(), [prop]).unwrap();
|
||||
commit_physics_placement(app.world_mut());
|
||||
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "physics.placement", OperatorPhase::Canceled);
|
||||
harness.assert_no_helpers::<PhysicsPlacementPreview>(app.world_mut());
|
||||
assert_eq!(*app.world().get::<Transform>(prop).unwrap(), start);
|
||||
assert_eq!(app.world().get::<RigidBody>(prop), Some(&RigidBody::Static));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn multi_select_commit_is_one_transaction_and_cleans_every_preview_helper() {
|
||||
let mut app = app_with_physics();
|
||||
let starts = [
|
||||
Transform::from_xyz(-1.0, 4.0, 0.0),
|
||||
Transform::from_xyz(1.0, 6.0, 0.0),
|
||||
];
|
||||
let first = spawn_placeable(app.world_mut(), "First", starts[0]);
|
||||
let second = spawn_placeable(app.world_mut(), "Second", starts[1]);
|
||||
app.update();
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
begin_physics_placement(app.world_mut(), [first, second, first]).unwrap();
|
||||
assert_eq!(
|
||||
app.world()
|
||||
.resource::<PhysicsPlacementState>()
|
||||
.selected_count,
|
||||
2,
|
||||
"duplicate selections must collapse to one placement snapshot"
|
||||
);
|
||||
let committed = [
|
||||
Transform::from_xyz(-1.0, 0.5, 0.0),
|
||||
Transform::from_xyz(1.0, 0.5, 0.0),
|
||||
];
|
||||
app.world_mut().entity_mut(first).insert(committed[0]);
|
||||
app.world_mut().entity_mut(second).insert(committed[1]);
|
||||
|
||||
commit_physics_placement(app.world_mut());
|
||||
|
||||
harness.assert_committed(app.world_mut(), 1, 0);
|
||||
harness.assert_status(app.world(), "physics.placement", OperatorPhase::Committed);
|
||||
harness.assert_no_helpers::<PhysicsPlacementPreview>(app.world_mut());
|
||||
assert_undo_redo_round_trip(app.world_mut(), starts, committed, |world| {
|
||||
[
|
||||
*world.get::<Transform>(first).unwrap(),
|
||||
*world.get::<Transform>(second).unwrap(),
|
||||
]
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -14,6 +14,7 @@ use crate::ui::helpers::ensure_player_spawn_for_edit;
|
||||
use crate::ui::hierarchy_ops::is_entity_locked;
|
||||
use crate::ui::hierarchy_state::HierarchyPanelState;
|
||||
use crate::ui::UiState;
|
||||
use crate::ui::ViewportUiState;
|
||||
use crate::viewport::actor_icons::ActorIconProxy;
|
||||
use crate::viewport::brush_edit::{BrushEditMode, BrushElementGizmo};
|
||||
use crate::viewport::brush_tool::BrushToolState;
|
||||
@@ -22,7 +23,10 @@ use crate::visualizers::EditorVisualizerProxy;
|
||||
use bevy_egui::egui;
|
||||
|
||||
use crate::viewport::material_drop::{MaterialDropSet, MaterialDropState};
|
||||
use crate::viewport::physics_placement::PhysicsPlacementState;
|
||||
use crate::viewport::scene_view_ray;
|
||||
use crate::viewport::terrain_paint::TerrainPaintState;
|
||||
use crate::viewport::terrain_sculpt::TerrainSculptState;
|
||||
|
||||
#[derive(Resource, Default, Debug, Clone, Copy)]
|
||||
pub struct SelectedEntity(pub Option<Entity>);
|
||||
@@ -49,6 +53,10 @@ struct PickTargetQueries<'w, 's> {
|
||||
parents: Query<'w, 's, &'static ChildOf>,
|
||||
editor_only: Query<'w, 's, (), With<EditorOnly>>,
|
||||
material_drop: Option<Res<'w, MaterialDropState>>,
|
||||
terrain_sculpt: Res<'w, TerrainSculptState>,
|
||||
terrain_paint: Res<'w, TerrainPaintState>,
|
||||
physics_placement: Option<Res<'w, PhysicsPlacementState>>,
|
||||
viewport_ui: Res<'w, ViewportUiState>,
|
||||
}
|
||||
|
||||
impl Plugin for EditorSelectionPlugin {
|
||||
@@ -113,6 +121,27 @@ fn handle_pick_events(
|
||||
gizmo_targets: Query<&GizmoTarget>,
|
||||
hierarchy: Option<Res<HierarchyPanelState>>,
|
||||
) -> Result {
|
||||
if ui_state.viewport_pointer_pos.is_some_and(|pointer| {
|
||||
pick_targets
|
||||
.viewport_ui
|
||||
.toolbar_rect
|
||||
.is_some_and(|rect| rect.contains(pointer))
|
||||
}) {
|
||||
viewport_click.0 = None;
|
||||
for _ in click_events.read() {}
|
||||
return Ok(());
|
||||
}
|
||||
if pick_targets.terrain_sculpt.active
|
||||
|| pick_targets.terrain_paint.active
|
||||
|| pick_targets
|
||||
.physics_placement
|
||||
.as_deref()
|
||||
.is_some_and(PhysicsPlacementState::active)
|
||||
{
|
||||
viewport_click.0 = None;
|
||||
for _ in click_events.read() {}
|
||||
return Ok(());
|
||||
}
|
||||
if pick_targets
|
||||
.material_drop
|
||||
.as_deref()
|
||||
@@ -220,6 +249,10 @@ fn handle_pick_events(
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[expect(
|
||||
clippy::too_many_arguments,
|
||||
reason = "selection cycling reads independent viewport input ownership resources"
|
||||
)]
|
||||
fn cycle_overlapping_viewport_pick(
|
||||
mut ui_state: ResMut<UiState>,
|
||||
mut selected: ResMut<SelectedEntity>,
|
||||
@@ -228,7 +261,12 @@ fn cycle_overlapping_viewport_pick(
|
||||
buttons: Res<ButtonInput<MouseButton>>,
|
||||
display: Res<ViewportDisplayMode>,
|
||||
material_drop: Option<Res<MaterialDropState>>,
|
||||
terrain_sculpt: Res<TerrainSculptState>,
|
||||
terrain_paint: Res<TerrainPaintState>,
|
||||
) -> Result {
|
||||
if terrain_sculpt.active || terrain_paint.active {
|
||||
return Ok(());
|
||||
}
|
||||
if material_drop
|
||||
.as_deref()
|
||||
.is_some_and(MaterialDropState::captures_viewport_input)
|
||||
@@ -415,13 +453,23 @@ fn sync_gizmo_targets(
|
||||
hierarchy: Option<Res<HierarchyPanelState>>,
|
||||
display: Res<ViewportDisplayMode>,
|
||||
brush_mode: Res<BrushEditMode>,
|
||||
terrain_sculpt: Res<TerrainSculptState>,
|
||||
terrain_paint: Res<TerrainPaintState>,
|
||||
physics_placement: Option<Res<PhysicsPlacementState>>,
|
||||
) {
|
||||
ui_state
|
||||
.selected_entities
|
||||
.retain(|entity| transforms.contains(entity) && !editor_only.contains(entity));
|
||||
selected.0 = ui_state.selected_entities.as_slice().first().copied();
|
||||
|
||||
if display.clean_game_view || brush_mode.is_element_mode() {
|
||||
if display.clean_game_view
|
||||
|| brush_mode.is_element_mode()
|
||||
|| terrain_sculpt.active
|
||||
|| terrain_paint.active
|
||||
|| physics_placement
|
||||
.as_deref()
|
||||
.is_some_and(PhysicsPlacementState::active)
|
||||
{
|
||||
for (entity, brush_element_gizmo) in &targets {
|
||||
if brush_element_gizmo.is_none() {
|
||||
commands.entity(entity).remove::<GizmoTarget>();
|
||||
@@ -474,6 +522,8 @@ mod tests {
|
||||
.init_resource::<SelectedEntity>()
|
||||
.init_resource::<ViewportDisplayMode>()
|
||||
.init_resource::<BrushEditMode>()
|
||||
.init_resource::<TerrainSculptState>()
|
||||
.init_resource::<TerrainPaintState>()
|
||||
.add_systems(Update, sync_gizmo_targets);
|
||||
|
||||
app.update();
|
||||
@@ -488,4 +538,50 @@ mod tests {
|
||||
assert!(app.world().get::<GizmoTarget>(first).is_some());
|
||||
assert!(app.world().get::<GizmoTarget>(second).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terrain_sculpt_owns_pointer_without_transform_gizmo() {
|
||||
let mut app = App::new();
|
||||
let terrain = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, Transform::default(), GizmoTarget::default()))
|
||||
.id();
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.selected_entities.select_replace(terrain);
|
||||
let mut sculpt = TerrainSculptState::default();
|
||||
sculpt.start(terrain);
|
||||
app.insert_resource(ui_state)
|
||||
.insert_resource(sculpt)
|
||||
.init_resource::<SelectedEntity>()
|
||||
.init_resource::<ViewportDisplayMode>()
|
||||
.init_resource::<BrushEditMode>()
|
||||
.init_resource::<TerrainPaintState>()
|
||||
.add_systems(Update, sync_gizmo_targets);
|
||||
|
||||
app.update();
|
||||
assert!(app.world().get::<GizmoTarget>(terrain).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terrain_paint_owns_pointer_without_transform_gizmo() {
|
||||
let mut app = App::new();
|
||||
let terrain = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, Transform::default(), GizmoTarget::default()))
|
||||
.id();
|
||||
let mut ui_state = UiState::default_layout();
|
||||
ui_state.selected_entities.select_replace(terrain);
|
||||
let mut paint = TerrainPaintState::default();
|
||||
paint.start(terrain, 2);
|
||||
app.insert_resource(ui_state)
|
||||
.insert_resource(paint)
|
||||
.init_resource::<SelectedEntity>()
|
||||
.init_resource::<ViewportDisplayMode>()
|
||||
.init_resource::<BrushEditMode>()
|
||||
.init_resource::<TerrainSculptState>()
|
||||
.add_systems(Update, sync_gizmo_targets);
|
||||
|
||||
app.update();
|
||||
assert!(app.world().get::<GizmoTarget>(terrain).is_none());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,795 @@
|
||||
//! Modal terrain material-weight painting with exact cancel and grouped history.
|
||||
|
||||
use bevy::prelude::*;
|
||||
use bevy_egui::EguiContexts;
|
||||
use shared::{TerrainDesc, AUTHORING_COMPONENT_TERRAIN, COMPONENT_TERRAIN_DESC};
|
||||
|
||||
use super::terrain_sculpt::{active_scene_ray, smooth_falloff, terrain_ray_hit, TerrainHit};
|
||||
use crate::camera::EditorCamera;
|
||||
use crate::history::{reflected_component_transaction, EditorHistory};
|
||||
use crate::operators::{ActiveOperator, OperatorPhase, OperatorStatus};
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::selection::{SelectedEntity, ViewportClick};
|
||||
use crate::state::scene_tools_active;
|
||||
use crate::ui::UiState;
|
||||
use crate::viewport::ViewportDisplayMode;
|
||||
|
||||
const MIN_RADIUS: f32 = 0.25;
|
||||
const MAX_RADIUS: f32 = 128.0;
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
|
||||
pub enum TerrainPaintMode {
|
||||
#[default]
|
||||
Paint,
|
||||
Erase,
|
||||
}
|
||||
|
||||
impl TerrainPaintMode {
|
||||
pub fn label(self) -> &'static str {
|
||||
match self {
|
||||
Self::Paint => "Paint",
|
||||
Self::Erase => "Erase",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct TerrainPaintStroke {
|
||||
entity: Entity,
|
||||
original: TerrainDesc,
|
||||
last_local: Vec3,
|
||||
}
|
||||
|
||||
#[derive(Resource, Debug, Clone)]
|
||||
pub struct TerrainPaintState {
|
||||
pub active: bool,
|
||||
pub mode: TerrainPaintMode,
|
||||
pub active_layer: usize,
|
||||
pub radius: f32,
|
||||
pub strength: f32,
|
||||
hover: Option<TerrainHit>,
|
||||
stroke: Option<TerrainPaintStroke>,
|
||||
target: Option<Entity>,
|
||||
}
|
||||
|
||||
impl Default for TerrainPaintState {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
active: false,
|
||||
mode: TerrainPaintMode::Paint,
|
||||
active_layer: 1,
|
||||
radius: 4.0,
|
||||
strength: 0.35,
|
||||
hover: None,
|
||||
stroke: None,
|
||||
target: None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl TerrainPaintState {
|
||||
pub fn start(&mut self, target: Entity, layer_count: usize) {
|
||||
self.active = true;
|
||||
self.target = Some(target);
|
||||
self.active_layer = self.active_layer.min(layer_count.saturating_sub(1));
|
||||
}
|
||||
|
||||
pub fn stop(&mut self) {
|
||||
self.active = false;
|
||||
self.hover = None;
|
||||
self.target = None;
|
||||
}
|
||||
|
||||
pub fn is_stroking(&self) -> bool {
|
||||
self.stroke.is_some()
|
||||
}
|
||||
|
||||
pub fn clamp_settings(&mut self) {
|
||||
self.radius = self.radius.clamp(MIN_RADIUS, MAX_RADIUS);
|
||||
self.strength = self.strength.clamp(0.01, 1.0);
|
||||
}
|
||||
}
|
||||
|
||||
pub struct TerrainPaintPlugin;
|
||||
|
||||
impl Plugin for TerrainPaintPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.init_resource::<TerrainPaintState>().add_systems(
|
||||
Update,
|
||||
(terrain_paint_input, draw_terrain_paint_preview)
|
||||
.chain()
|
||||
.run_if(scene_tools_active),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn terrain_paint_input(
|
||||
mut commands: Commands,
|
||||
mut state: ResMut<TerrainPaintState>,
|
||||
mut selected: ResMut<SelectedEntity>,
|
||||
keys: Res<ButtonInput<KeyCode>>,
|
||||
buttons: Res<ButtonInput<MouseButton>>,
|
||||
mut contexts: EguiContexts,
|
||||
ui_state: Res<UiState>,
|
||||
display: Res<ViewportDisplayMode>,
|
||||
cameras: Query<(&Camera, &GlobalTransform), With<EditorCamera>>,
|
||||
mut terrains: Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
mut viewport_click: ResMut<ViewportClick>,
|
||||
mut scene_io: ResMut<SceneIo>,
|
||||
mut active_operator: ResMut<ActiveOperator>,
|
||||
) -> Result {
|
||||
if !state.active {
|
||||
return Ok(());
|
||||
}
|
||||
viewport_click.0 = None;
|
||||
state.clamp_settings();
|
||||
let Some(entity) = state.target.or(selected.0) else {
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Blocked,
|
||||
"Terrain paint stopped: target is unavailable",
|
||||
"Target unavailable",
|
||||
);
|
||||
return Ok(());
|
||||
};
|
||||
if selected.0 != Some(entity) {
|
||||
selected.0 = Some(entity);
|
||||
}
|
||||
if display.clean_game_view {
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Terrain paint stopped for clean game view",
|
||||
"Clean game view enabled; weights restored",
|
||||
);
|
||||
return Ok(());
|
||||
}
|
||||
let ctx = contexts.ctx_mut()?;
|
||||
let cancel_requested =
|
||||
keys.just_pressed(KeyCode::Escape) || buttons.just_pressed(MouseButton::Right);
|
||||
if cancel_requested {
|
||||
if state.is_stroking() {
|
||||
cancel_active_stroke(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
);
|
||||
} else {
|
||||
state.stop();
|
||||
scene_io.status = "Terrain paint tool closed".into();
|
||||
set_status(&mut active_operator, OperatorPhase::Canceled, "Tool closed");
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
let Ok((global, mut terrain)) = terrains.get_mut(entity) else {
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Blocked,
|
||||
"Terrain paint stopped: target no longer exists",
|
||||
"Target no longer exists",
|
||||
);
|
||||
return Ok(());
|
||||
};
|
||||
let layer_count = terrain.material_layers.len();
|
||||
if layer_count == 0 {
|
||||
if let Some(stroke) = state.stroke.take() {
|
||||
*terrain = stroke.original;
|
||||
}
|
||||
state.stop();
|
||||
scene_io.status = "Add a terrain material layer before painting".into();
|
||||
set_status(
|
||||
&mut active_operator,
|
||||
OperatorPhase::Blocked,
|
||||
"Add a material layer before painting",
|
||||
);
|
||||
return Ok(());
|
||||
}
|
||||
state.active_layer = state.active_layer.min(layer_count - 1);
|
||||
state.hover = ui_state
|
||||
.viewport_pointer_pos
|
||||
.and_then(|pointer| active_scene_ray(&cameras, pointer, ui_state.viewport_rect))
|
||||
.and_then(|ray| terrain_ray_hit(entity, &terrain, global, ray));
|
||||
|
||||
if buttons.just_pressed(MouseButton::Left) && !ctx.egui_wants_pointer_input() {
|
||||
if let Some(hit) = state.hover.filter(|hit| hit.entity == entity) {
|
||||
let original = terrain.clone();
|
||||
terrain.ensure_material_weights();
|
||||
apply_weight_dab(
|
||||
&mut terrain,
|
||||
hit.local,
|
||||
state.radius,
|
||||
state.strength,
|
||||
state.active_layer,
|
||||
state.mode,
|
||||
);
|
||||
state.stroke = Some(TerrainPaintStroke {
|
||||
entity,
|
||||
original,
|
||||
last_local: hit.local,
|
||||
});
|
||||
set_status(
|
||||
&mut active_operator,
|
||||
OperatorPhase::Preview,
|
||||
format!(
|
||||
"{} layer {} in progress",
|
||||
state.mode.label(),
|
||||
state.active_layer + 1
|
||||
),
|
||||
);
|
||||
}
|
||||
} else if buttons.pressed(MouseButton::Left) {
|
||||
let radius = state.radius;
|
||||
let strength = state.strength;
|
||||
let layer = state.active_layer;
|
||||
let mode = state.mode;
|
||||
if let (Some(hit), Some(stroke)) = (state.hover, state.stroke.as_mut()) {
|
||||
if hit.entity == stroke.entity {
|
||||
let step = (radius * 0.2).max(terrain.sample_spacing * 0.25);
|
||||
let delta = hit.local - stroke.last_local;
|
||||
let distance = Vec2::new(delta.x, delta.z).length();
|
||||
if distance >= step {
|
||||
let count = (distance / step).floor() as usize;
|
||||
for index in 1..=count {
|
||||
let point = stroke.last_local + delta * (index as f32 / count as f32);
|
||||
apply_weight_dab(&mut terrain, point, radius, strength, layer, mode);
|
||||
}
|
||||
stroke.last_local = hit.local;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if buttons.just_released(MouseButton::Left) {
|
||||
if let Some(stroke) = state.stroke.take() {
|
||||
let final_terrain = terrain.clone();
|
||||
let mode = state.mode;
|
||||
commands.queue(move |world: &mut World| {
|
||||
finish_paint_stroke(world, stroke, final_terrain, mode);
|
||||
});
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn commit_paint_stroke(
|
||||
world: &mut World,
|
||||
stroke: TerrainPaintStroke,
|
||||
final_terrain: TerrainDesc,
|
||||
) -> Result<(), String> {
|
||||
let original = stroke.original;
|
||||
if let Ok(mut actor) = world.get_entity_mut(stroke.entity) {
|
||||
actor.insert(original.clone());
|
||||
}
|
||||
let result = reflected_component_transaction(
|
||||
world,
|
||||
stroke.entity,
|
||||
"Paint Terrain Material",
|
||||
AUTHORING_COMPONENT_TERRAIN,
|
||||
COMPONENT_TERRAIN_DESC,
|
||||
move |world, entity| {
|
||||
world.entity_mut(entity).insert(final_terrain);
|
||||
Ok(())
|
||||
},
|
||||
);
|
||||
if result.is_err() {
|
||||
if let Ok(mut actor) = world.get_entity_mut(stroke.entity) {
|
||||
actor.insert(original);
|
||||
}
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
fn finish_paint_stroke(
|
||||
world: &mut World,
|
||||
stroke: TerrainPaintStroke,
|
||||
final_terrain: TerrainDesc,
|
||||
mode: TerrainPaintMode,
|
||||
) {
|
||||
let undo_depth = world.resource::<EditorHistory>().undo_depth();
|
||||
match commit_paint_stroke(world, stroke, final_terrain) {
|
||||
Ok(()) if world.resource::<EditorHistory>().undo_depth() > undo_depth => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("{} terrain material weights committed", mode.label());
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Committed,
|
||||
format!("{} weights; Ctrl+Z to undo", mode.label()),
|
||||
);
|
||||
}
|
||||
Ok(()) => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("{} terrain stroke made no changes", mode.label());
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Canceled,
|
||||
format!("{} stroke made no changes", mode.label()),
|
||||
);
|
||||
}
|
||||
Err(error) => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("Terrain paint commit failed: {error}");
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Blocked,
|
||||
format!("Commit failed: {error}"),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn cancel_active_stroke(
|
||||
state: &mut TerrainPaintState,
|
||||
terrains: &mut Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
scene_io: &mut SceneIo,
|
||||
active_operator: &mut ActiveOperator,
|
||||
) {
|
||||
cancel_stroke(state, terrains);
|
||||
scene_io.status = "Terrain paint stroke canceled".into();
|
||||
set_status(active_operator, OperatorPhase::Canceled, "Weights restored");
|
||||
}
|
||||
|
||||
fn stop_tool_with_rollback(
|
||||
state: &mut TerrainPaintState,
|
||||
terrains: &mut Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
scene_io: &mut SceneIo,
|
||||
active_operator: &mut ActiveOperator,
|
||||
phase: OperatorPhase,
|
||||
message: &str,
|
||||
hint: &str,
|
||||
) {
|
||||
cancel_stroke(state, terrains);
|
||||
state.stop();
|
||||
scene_io.status = message.to_string();
|
||||
set_status(active_operator, phase, hint);
|
||||
}
|
||||
|
||||
fn cancel_stroke(
|
||||
state: &mut TerrainPaintState,
|
||||
terrains: &mut Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
) {
|
||||
let Some(stroke) = state.stroke.take() else {
|
||||
return;
|
||||
};
|
||||
if let Ok((_, mut terrain)) = terrains.get_mut(stroke.entity) {
|
||||
*terrain = stroke.original;
|
||||
}
|
||||
}
|
||||
|
||||
fn set_status(active: &mut ActiveOperator, phase: OperatorPhase, hint: impl Into<String>) {
|
||||
active.status = Some(OperatorStatus {
|
||||
id: "terrain.paint".into(),
|
||||
label: "Terrain Paint".into(),
|
||||
phase,
|
||||
hint: hint.into(),
|
||||
warnings: Vec::new(),
|
||||
});
|
||||
}
|
||||
|
||||
fn apply_weight_dab(
|
||||
terrain: &mut TerrainDesc,
|
||||
center: Vec3,
|
||||
radius: f32,
|
||||
strength: f32,
|
||||
active_layer: usize,
|
||||
mode: TerrainPaintMode,
|
||||
) {
|
||||
terrain.ensure_material_weights();
|
||||
let layer_count = terrain.material_layers.len().clamp(1, 4);
|
||||
if active_layer >= layer_count {
|
||||
return;
|
||||
}
|
||||
let radius = radius.max(MIN_RADIUS);
|
||||
let half_extent = (terrain.resolution - 1) as f32 * terrain.sample_spacing * 0.5;
|
||||
for z in 0..terrain.resolution {
|
||||
for x in 0..terrain.resolution {
|
||||
let sample = Vec2::new(
|
||||
x as f32 * terrain.sample_spacing - half_extent,
|
||||
z as f32 * terrain.sample_spacing - half_extent,
|
||||
);
|
||||
let distance = sample.distance(Vec2::new(center.x, center.z));
|
||||
if distance > radius {
|
||||
continue;
|
||||
}
|
||||
let amount = strength.clamp(0.0, 1.0) * smooth_falloff(distance / radius);
|
||||
let index = (z * terrain.resolution + x) as usize;
|
||||
terrain.material_weights[index] = adjust_weights(
|
||||
terrain.material_weights[index],
|
||||
active_layer,
|
||||
layer_count,
|
||||
amount,
|
||||
mode,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn adjust_weights(
|
||||
weights: [u8; 4],
|
||||
active_layer: usize,
|
||||
layer_count: usize,
|
||||
amount: f32,
|
||||
mode: TerrainPaintMode,
|
||||
) -> [u8; 4] {
|
||||
let mut values = weights.map(|value| f32::from(value) / 255.0);
|
||||
for value in values.iter_mut().skip(layer_count) {
|
||||
*value = 0.0;
|
||||
}
|
||||
let current = values[active_layer];
|
||||
let target = match mode {
|
||||
TerrainPaintMode::Paint => current + (1.0 - current) * amount,
|
||||
TerrainPaintMode::Erase => current * (1.0 - amount),
|
||||
};
|
||||
let other_sum: f32 = values
|
||||
.iter()
|
||||
.take(layer_count)
|
||||
.enumerate()
|
||||
.filter(|(index, _)| *index != active_layer)
|
||||
.map(|(_, value)| *value)
|
||||
.sum();
|
||||
if other_sum <= f32::EPSILON {
|
||||
if layer_count == 1 {
|
||||
values[active_layer] = 1.0;
|
||||
} else {
|
||||
values.fill(0.0);
|
||||
values[active_layer] = target;
|
||||
let fallback = if active_layer == 0 { 1 } else { 0 };
|
||||
values[fallback] = 1.0 - target;
|
||||
}
|
||||
} else {
|
||||
let scale = (1.0 - target) / other_sum;
|
||||
for (index, value) in values.iter_mut().take(layer_count).enumerate() {
|
||||
if index != active_layer {
|
||||
*value *= scale;
|
||||
}
|
||||
}
|
||||
values[active_layer] = target;
|
||||
}
|
||||
quantize_weights(values, layer_count)
|
||||
}
|
||||
|
||||
fn quantize_weights(values: [f32; 4], layer_count: usize) -> [u8; 4] {
|
||||
let mut result = [0_u8; 4];
|
||||
let mut fractions = [(0_usize, 0.0_f32); 4];
|
||||
let mut assigned = 0_u16;
|
||||
for index in 0..layer_count {
|
||||
let scaled = values[index].clamp(0.0, 1.0) * 255.0;
|
||||
let floor = scaled.floor() as u8;
|
||||
result[index] = floor;
|
||||
assigned += u16::from(floor);
|
||||
fractions[index] = (index, scaled - f32::from(floor));
|
||||
}
|
||||
fractions[..layer_count].sort_by(|a, b| b.1.total_cmp(&a.1));
|
||||
for offset in 0..usize::from(255_u16 - assigned) {
|
||||
result[fractions[offset % layer_count].0] += 1;
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
fn draw_terrain_paint_preview(state: Res<TerrainPaintState>, mut gizmos: Gizmos) {
|
||||
if !state.active {
|
||||
return;
|
||||
}
|
||||
let Some(hit) = state.hover else {
|
||||
return;
|
||||
};
|
||||
let color = match state.mode {
|
||||
TerrainPaintMode::Paint => Color::srgba(0.22, 0.78, 1.0, 0.95),
|
||||
TerrainPaintMode::Erase => Color::srgba(1.0, 0.64, 0.22, 0.95),
|
||||
};
|
||||
let rotation = hit.world_rotation * Quat::from_rotation_x(std::f32::consts::FRAC_PI_2);
|
||||
gizmos
|
||||
.circle(
|
||||
Isometry3d::new(hit.world + Vec3::Y * 0.035, rotation),
|
||||
state.radius,
|
||||
color,
|
||||
)
|
||||
.resolution(48);
|
||||
gizmos.sphere(
|
||||
Isometry3d::from_translation(hit.world + Vec3::Y * 0.04),
|
||||
0.06,
|
||||
color,
|
||||
);
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::EditorHistory;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use shared::{ActorKind, LevelObject};
|
||||
|
||||
#[test]
|
||||
fn paint_and_erase_keep_weights_exactly_normalized() {
|
||||
let painted = adjust_weights([255, 0, 0, 0], 1, 2, 0.5, TerrainPaintMode::Paint);
|
||||
assert_eq!(painted.iter().copied().map(u16::from).sum::<u16>(), 255);
|
||||
assert!(painted[1] > 0);
|
||||
let erased = adjust_weights(painted, 1, 2, 1.0, TerrainPaintMode::Erase);
|
||||
assert_eq!(erased, [255, 0, 0, 0]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn dab_only_changes_samples_inside_footprint() {
|
||||
let mut terrain = TerrainDesc::flat(5);
|
||||
terrain.material_layers = vec![Default::default(), Default::default()];
|
||||
apply_weight_dab(
|
||||
&mut terrain,
|
||||
Vec3::ZERO,
|
||||
1.1,
|
||||
1.0,
|
||||
1,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
assert!(terrain.material_weights[12][1] > 0);
|
||||
assert_eq!(terrain.material_weights[0], [255, 0, 0, 0]);
|
||||
assert!(terrain.validate().is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn many_dabs_commit_as_one_undoable_paint_stroke() {
|
||||
let mut app = App::new();
|
||||
app.register_type::<ActorKind>()
|
||||
.register_type::<TerrainDesc>()
|
||||
.register_type::<shared::TerrainMaterialLayer>()
|
||||
.register_type::<shared::EditorAssetRef>();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<TerrainPaintState>();
|
||||
let mut original = TerrainDesc::flat(9);
|
||||
original.material_layers = vec![Default::default(), Default::default()];
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, original.clone()))
|
||||
.id();
|
||||
let mut final_terrain = original.clone();
|
||||
for x in [-2.0, 0.0, 2.0] {
|
||||
apply_weight_dab(
|
||||
&mut final_terrain,
|
||||
Vec3::new(x, 0.0, 0.0),
|
||||
2.5,
|
||||
0.5,
|
||||
1,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
}
|
||||
world.entity_mut(entity).insert(final_terrain.clone());
|
||||
let stroke = TerrainPaintStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
};
|
||||
{
|
||||
let mut state = world.resource_mut::<TerrainPaintState>();
|
||||
state.start(entity, 2);
|
||||
state.stroke = Some(stroke);
|
||||
}
|
||||
let stroke = world
|
||||
.resource_mut::<TerrainPaintState>()
|
||||
.stroke
|
||||
.take()
|
||||
.unwrap();
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_paint_stroke(
|
||||
world,
|
||||
stroke,
|
||||
final_terrain.clone(),
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
|
||||
harness.assert_committed(world, 1, 0);
|
||||
harness.assert_status(world, "terrain.paint", OperatorPhase::Committed);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&final_terrain));
|
||||
let state = world.resource::<TerrainPaintState>();
|
||||
assert!(state.active);
|
||||
assert_eq!(state.target, Some(entity));
|
||||
assert!(!state.is_stroking());
|
||||
assert_undo_redo_round_trip(world, original, final_terrain, |world| {
|
||||
world.get::<TerrainDesc>(entity).unwrap().clone()
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_op_paint_release_terminates_without_dirtying_or_history() {
|
||||
let mut app = App::new();
|
||||
app.register_type::<ActorKind>()
|
||||
.register_type::<TerrainDesc>()
|
||||
.register_type::<shared::TerrainMaterialLayer>()
|
||||
.register_type::<shared::EditorAssetRef>();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let mut original = TerrainDesc::flat(5);
|
||||
original.material_layers = vec![Default::default(), Default::default()];
|
||||
original.ensure_material_weights();
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, original.clone()))
|
||||
.id();
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_paint_stroke(
|
||||
world,
|
||||
TerrainPaintStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
},
|
||||
original.clone(),
|
||||
TerrainPaintMode::Erase,
|
||||
);
|
||||
|
||||
harness.assert_canceled(world);
|
||||
harness.assert_status(world, "terrain.paint", OperatorPhase::Canceled);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&original));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn commit_failure_restores_preview_and_reports_blocked_without_history() {
|
||||
let mut app = App::new();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let mut original = TerrainDesc::flat(5);
|
||||
original.material_layers = vec![Default::default(), Default::default()];
|
||||
let mut preview = original.clone();
|
||||
apply_weight_dab(
|
||||
&mut preview,
|
||||
Vec3::ZERO,
|
||||
3.0,
|
||||
0.8,
|
||||
1,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, preview.clone()))
|
||||
.id();
|
||||
let mut hierarchy = crate::ui::hierarchy_state::HierarchyPanelState::default();
|
||||
hierarchy.locked.insert(entity);
|
||||
world.insert_resource(hierarchy);
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_paint_stroke(
|
||||
world,
|
||||
TerrainPaintStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
},
|
||||
preview,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
|
||||
harness.assert_blocked(world);
|
||||
harness.assert_status(world, "terrain.paint", OperatorPhase::Blocked);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&original));
|
||||
assert!(world
|
||||
.resource::<SceneIo>()
|
||||
.status
|
||||
.starts_with("Terrain paint commit failed:"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn cancel_restores_implicit_pre_stroke_weights() {
|
||||
fn cancel_once(
|
||||
mut state: ResMut<TerrainPaintState>,
|
||||
mut terrains: Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
mut scene_io: ResMut<SceneIo>,
|
||||
mut active_operator: ResMut<ActiveOperator>,
|
||||
) {
|
||||
cancel_active_stroke(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
);
|
||||
}
|
||||
|
||||
let mut app = App::new();
|
||||
app.init_resource::<ActiveOperator>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<SceneIo>();
|
||||
let mut original = TerrainDesc::flat(5);
|
||||
original.material_layers = vec![Default::default(), Default::default()];
|
||||
let mut preview = original.clone();
|
||||
apply_weight_dab(
|
||||
&mut preview,
|
||||
Vec3::ZERO,
|
||||
3.0,
|
||||
0.8,
|
||||
1,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
let entity = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, GlobalTransform::default(), preview))
|
||||
.id();
|
||||
let mut state = TerrainPaintState::default();
|
||||
state.start(entity, 2);
|
||||
state.stroke = Some(TerrainPaintStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
});
|
||||
app.insert_resource(state).add_systems(Update, cancel_once);
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
app.update();
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "terrain.paint", OperatorPhase::Canceled);
|
||||
assert_eq!(app.world().get::<TerrainDesc>(entity), Some(&original));
|
||||
let state = app.world().resource::<TerrainPaintState>();
|
||||
assert!(state.active);
|
||||
assert_eq!(state.target, Some(entity));
|
||||
assert!(!state.is_stroking());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clean_view_interruption_restores_weights_and_terminates_tool() {
|
||||
fn interrupt_once(
|
||||
mut state: ResMut<TerrainPaintState>,
|
||||
mut terrains: Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
mut scene_io: ResMut<SceneIo>,
|
||||
mut active_operator: ResMut<ActiveOperator>,
|
||||
) {
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Terrain paint stopped for clean game view",
|
||||
"Clean game view enabled; weights restored",
|
||||
);
|
||||
}
|
||||
|
||||
let mut app = App::new();
|
||||
app.init_resource::<ActiveOperator>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<SceneIo>();
|
||||
let mut original = TerrainDesc::flat(5);
|
||||
original.material_layers = vec![Default::default(), Default::default()];
|
||||
let mut preview = original.clone();
|
||||
apply_weight_dab(
|
||||
&mut preview,
|
||||
Vec3::ZERO,
|
||||
3.0,
|
||||
0.8,
|
||||
1,
|
||||
TerrainPaintMode::Paint,
|
||||
);
|
||||
let entity = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, GlobalTransform::default(), preview))
|
||||
.id();
|
||||
let mut state = TerrainPaintState::default();
|
||||
state.start(entity, 2);
|
||||
state.stroke = Some(TerrainPaintStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
});
|
||||
app.insert_resource(state)
|
||||
.add_systems(Update, interrupt_once);
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
app.update();
|
||||
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "terrain.paint", OperatorPhase::Canceled);
|
||||
assert_eq!(app.world().get::<TerrainDesc>(entity), Some(&original));
|
||||
assert!(!app.world().resource::<TerrainPaintState>().active);
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,14 +1,16 @@
|
||||
//! Editor-side scene visualizers for authoring/runtime entities that have no mesh.
|
||||
|
||||
use avian3d::prelude::ColliderConstructor;
|
||||
use std::f32::consts::FRAC_PI_2;
|
||||
|
||||
use avian3d::prelude::{ColliderAabb, ColliderConstructor};
|
||||
use bevy::ecs::system::SystemParam;
|
||||
use bevy::prelude::*;
|
||||
use shared::{
|
||||
AudioListenerDesc, AudioSourceDesc, AuthoringLightKind, ColliderDesc, ColliderShapeDesc,
|
||||
LevelObject, LightDesc, ModelRef, NavigationArea, NavigationBounds, NavigationLink,
|
||||
NavigationObstacle, ObjectiveMarker, PhysicsBody, PlayerSpawn, PostProcessVolumeDesc,
|
||||
PrefabRef, ProjectSun, RaytracingExcluded, SkinnedMeshRenderer, TeamSpawn, TriggerVolume,
|
||||
WeaponSpawn,
|
||||
PrefabRef, ProjectSun, RaytracingExcluded, RigidBodyDesc, SkinnedMeshRenderer, TeamSpawn,
|
||||
TriggerVolume, WeaponSpawn,
|
||||
};
|
||||
use sim::tuning::{EYE_OFFSET_STAND, PLAYER_LENGTH, PLAYER_RADIUS};
|
||||
use sim::{Player, PlayerCamera};
|
||||
@@ -16,6 +18,10 @@ use sim::{Player, PlayerCamera};
|
||||
use crate::infra::EditorOnly;
|
||||
use crate::selection::SelectedEntity;
|
||||
use crate::state::{scene_tools_active, EditorMode, PlayPossession};
|
||||
use crate::viewport::collider_diagnostics::{
|
||||
refresh_collider_diagnostics, ColliderDiagnosticEntry, ColliderDiagnosticsState,
|
||||
ColliderOverlayStatus,
|
||||
};
|
||||
use crate::viewport::{EditorViewportMode, ViewportDisplayMode};
|
||||
|
||||
#[derive(Resource, Debug, Clone)]
|
||||
@@ -102,7 +108,7 @@ struct VisualizerTargetQueries<'w, 's> {
|
||||
Entity,
|
||||
(
|
||||
With<LevelObject>,
|
||||
Or<(With<PhysicsBody>, With<ColliderDesc>)>,
|
||||
Or<(With<PhysicsBody>, With<ColliderDesc>, With<RigidBodyDesc>)>,
|
||||
),
|
||||
>,
|
||||
lights: Query<'w, 's, Entity, (With<LevelObject>, With<LightDesc>)>,
|
||||
@@ -127,7 +133,15 @@ pub struct EditorVisualizersPlugin;
|
||||
impl Plugin for EditorVisualizersPlugin {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.init_resource::<EditorVisualizationSettings>()
|
||||
.init_resource::<ColliderDiagnosticsState>()
|
||||
.add_systems(Startup, init_visualizer_proxy_assets)
|
||||
.add_systems(
|
||||
Update,
|
||||
refresh_collider_diagnostics
|
||||
.before(sync_visualizer_proxies)
|
||||
.before(draw_visualizers)
|
||||
.before(draw_split_collider_visualizers),
|
||||
)
|
||||
.add_systems(Update, sync_visualizer_proxies)
|
||||
.add_systems(
|
||||
Update,
|
||||
@@ -135,6 +149,7 @@ impl Plugin for EditorVisualizersPlugin {
|
||||
draw_visualizers,
|
||||
draw_audio_visualizers,
|
||||
draw_split_collider_visualizers,
|
||||
draw_missing_collider_visualizers,
|
||||
draw_post_process_volume_gizmos,
|
||||
draw_navigation_visualizers,
|
||||
)
|
||||
@@ -145,6 +160,52 @@ impl Plugin for EditorVisualizersPlugin {
|
||||
}
|
||||
}
|
||||
|
||||
fn draw_missing_collider_visualizers(
|
||||
viewport_mode: Res<EditorViewportMode>,
|
||||
settings: Res<EditorVisualizationSettings>,
|
||||
diagnostics: Res<ColliderDiagnosticsState>,
|
||||
selected: Res<SelectedEntity>,
|
||||
mut gizmos: Gizmos,
|
||||
missing: Query<
|
||||
(Entity, &GlobalTransform),
|
||||
(
|
||||
With<LevelObject>,
|
||||
With<RigidBodyDesc>,
|
||||
Without<ColliderDesc>,
|
||||
Without<PhysicsBody>,
|
||||
),
|
||||
>,
|
||||
) {
|
||||
let collider_mode = *viewport_mode == EditorViewportMode::Collider;
|
||||
if !(collider_mode || settings.enabled && settings.show_colliders) {
|
||||
return;
|
||||
}
|
||||
for (entity, global) in &missing {
|
||||
let color = collider_overlay_color(
|
||||
diagnostics.entry(entity),
|
||||
selected.0 == Some(entity),
|
||||
collider_mode,
|
||||
);
|
||||
let center = global.translation();
|
||||
let radius = if selected.0 == Some(entity) {
|
||||
0.48
|
||||
} else {
|
||||
0.34
|
||||
};
|
||||
draw_box(
|
||||
&mut gizmos,
|
||||
center,
|
||||
global.rotation(),
|
||||
Vec3::splat(radius),
|
||||
color,
|
||||
);
|
||||
for axis in [Vec3::X, Vec3::Y, Vec3::Z] {
|
||||
let direction = global.rotation() * axis * radius * 1.35;
|
||||
gizmos.line(center - direction, center + direction, color);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn draw_navigation_visualizers(
|
||||
state: Res<crate::ui::navigation_inspector::NavigationEditorState>,
|
||||
mut gizmos: Gizmos,
|
||||
@@ -556,17 +617,7 @@ fn draw_visualizers(
|
||||
|
||||
if settings.show_colliders || collider_mode {
|
||||
for (entity, body, global) in &colliders {
|
||||
let color = if selected.0 == Some(entity) {
|
||||
if collider_mode {
|
||||
Color::srgba(0.65, 1.0, 0.55, 1.0)
|
||||
} else {
|
||||
Color::srgba(0.55, 1.0, 0.45, 0.95)
|
||||
}
|
||||
} else if collider_mode {
|
||||
Color::srgba(0.35, 1.0, 0.45, 0.9)
|
||||
} else {
|
||||
Color::srgba(0.25, 0.9, 0.35, 0.55)
|
||||
};
|
||||
let color = collider_overlay_color(None, selected.0 == Some(entity), collider_mode);
|
||||
draw_collider(&mut gizmos, global, &body.collider, color);
|
||||
}
|
||||
}
|
||||
@@ -679,11 +730,18 @@ fn draw_visualizers(
|
||||
}
|
||||
}
|
||||
|
||||
#[expect(
|
||||
clippy::too_many_arguments,
|
||||
reason = "collider overlays combine authoring, runtime bounds, selection, and viewport state"
|
||||
)]
|
||||
fn draw_split_collider_visualizers(
|
||||
viewport_mode: Res<EditorViewportMode>,
|
||||
settings: Res<EditorVisualizationSettings>,
|
||||
diagnostics: Res<ColliderDiagnosticsState>,
|
||||
selected: Res<SelectedEntity>,
|
||||
mut gizmos: Gizmos,
|
||||
children: Query<&Children>,
|
||||
runtime_aabbs: Query<&ColliderAabb>,
|
||||
colliders: Query<
|
||||
(Entity, &ColliderDesc, &GlobalTransform),
|
||||
(With<LevelObject>, Without<PhysicsBody>),
|
||||
@@ -697,17 +755,80 @@ fn draw_split_collider_visualizers(
|
||||
return;
|
||||
}
|
||||
for (entity, collider, global) in &colliders {
|
||||
let color = if selected.0 == Some(entity) {
|
||||
Color::srgba(0.65, 1.0, 0.55, 1.0)
|
||||
} else if collider_mode {
|
||||
Color::srgba(0.35, 1.0, 0.45, 0.9)
|
||||
} else {
|
||||
Color::srgba(0.25, 0.9, 0.35, 0.55)
|
||||
};
|
||||
draw_collider_desc(&mut gizmos, global, collider, color);
|
||||
let color = collider_overlay_color(
|
||||
diagnostics.entry(entity),
|
||||
selected.0 == Some(entity),
|
||||
collider_mode,
|
||||
);
|
||||
let drew_runtime_mesh = matches!(collider.shape, ColliderShapeDesc::StaticMesh { .. })
|
||||
&& draw_runtime_collider_bounds(&mut gizmos, entity, &children, &runtime_aabbs, color);
|
||||
if !drew_runtime_mesh {
|
||||
draw_collider_desc(&mut gizmos, global, collider, color);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn collider_overlay_color(
|
||||
entry: Option<&ColliderDiagnosticEntry>,
|
||||
selected: bool,
|
||||
collider_mode: bool,
|
||||
) -> Color {
|
||||
let status = entry
|
||||
.map(|entry| entry.overlay_status)
|
||||
.unwrap_or(ColliderOverlayStatus::Valid);
|
||||
let (rgb, base_alpha): (Vec3, f32) = match status {
|
||||
ColliderOverlayStatus::Valid => (Vec3::new(0.25, 0.92, 0.43), 0.72),
|
||||
ColliderOverlayStatus::Trigger => (Vec3::new(0.18, 0.82, 1.0), 0.78),
|
||||
ColliderOverlayStatus::Disabled => (Vec3::new(0.52, 0.56, 0.62), 0.42),
|
||||
ColliderOverlayStatus::Warning => (Vec3::new(1.0, 0.68, 0.18), 0.9),
|
||||
ColliderOverlayStatus::Error => (Vec3::new(1.0, 0.24, 0.3), 0.96),
|
||||
};
|
||||
let alpha = if selected {
|
||||
1.0
|
||||
} else if collider_mode {
|
||||
base_alpha.max(0.82)
|
||||
} else {
|
||||
base_alpha * 0.72
|
||||
};
|
||||
let rgb = if selected {
|
||||
rgb.lerp(Vec3::ONE, 0.18)
|
||||
} else {
|
||||
rgb
|
||||
};
|
||||
Color::srgba(rgb.x, rgb.y, rgb.z, alpha)
|
||||
}
|
||||
|
||||
fn draw_runtime_collider_bounds(
|
||||
gizmos: &mut Gizmos,
|
||||
root: Entity,
|
||||
children: &Query<&Children>,
|
||||
aabbs: &Query<&ColliderAabb>,
|
||||
color: Color,
|
||||
) -> bool {
|
||||
let mut pending = vec![root];
|
||||
let mut drew = false;
|
||||
while let Some(entity) = pending.pop() {
|
||||
if let Ok(aabb) = aabbs.get(entity) {
|
||||
let min = aabb.min;
|
||||
let max = aabb.max;
|
||||
if min.is_finite() && max.is_finite() && min.cmplt(max).all() {
|
||||
draw_box(
|
||||
gizmos,
|
||||
(min + max) * 0.5,
|
||||
Quat::IDENTITY,
|
||||
(max - min) * 0.5,
|
||||
color,
|
||||
);
|
||||
drew = true;
|
||||
}
|
||||
}
|
||||
if let Ok(entity_children) = children.get(entity) {
|
||||
pending.extend(entity_children.iter());
|
||||
}
|
||||
}
|
||||
drew
|
||||
}
|
||||
|
||||
fn draw_post_process_volume_gizmos(
|
||||
viewport_mode: Res<EditorViewportMode>,
|
||||
settings: Res<EditorVisualizationSettings>,
|
||||
@@ -741,6 +862,8 @@ fn draw_collider(
|
||||
collider: &ColliderConstructor,
|
||||
color: Color,
|
||||
) {
|
||||
let (scale, rotation, translation) = global.to_scale_rotation_translation();
|
||||
let scale = scale.abs();
|
||||
match collider {
|
||||
ColliderConstructor::Cuboid {
|
||||
x_length,
|
||||
@@ -748,27 +871,21 @@ fn draw_collider(
|
||||
z_length,
|
||||
} => draw_box(
|
||||
gizmos,
|
||||
global.translation(),
|
||||
global.rotation(),
|
||||
Vec3::new(*x_length, *y_length, *z_length) * 0.5,
|
||||
translation,
|
||||
rotation,
|
||||
Vec3::new(*x_length, *y_length, *z_length) * scale * 0.5,
|
||||
color,
|
||||
),
|
||||
ColliderConstructor::Sphere { radius } => {
|
||||
gizmos
|
||||
.sphere(
|
||||
Isometry3d::new(global.translation(), global.rotation()),
|
||||
*radius,
|
||||
color,
|
||||
)
|
||||
.resolution(24);
|
||||
draw_ellipsoid(gizmos, translation, rotation, scale * *radius, color);
|
||||
}
|
||||
ColliderConstructor::Capsule { radius, height } => {
|
||||
draw_capsule(
|
||||
gizmos,
|
||||
global.translation(),
|
||||
global.rotation(),
|
||||
*radius,
|
||||
*height,
|
||||
translation,
|
||||
rotation,
|
||||
*radius * scale.x.max(scale.z),
|
||||
*height * scale.y,
|
||||
color,
|
||||
);
|
||||
}
|
||||
@@ -790,9 +907,8 @@ fn draw_collider_desc(
|
||||
collider: &ColliderDesc,
|
||||
color: Color,
|
||||
) {
|
||||
if !collider.enabled {
|
||||
return;
|
||||
}
|
||||
let (scale, rotation, translation) = global.to_scale_rotation_translation();
|
||||
let scale = scale.abs();
|
||||
match &collider.shape {
|
||||
ColliderShapeDesc::Cuboid {
|
||||
x_length,
|
||||
@@ -800,42 +916,59 @@ fn draw_collider_desc(
|
||||
z_length,
|
||||
} => draw_box(
|
||||
gizmos,
|
||||
global.translation(),
|
||||
global.rotation(),
|
||||
Vec3::new(*x_length, *y_length, *z_length) * 0.5,
|
||||
translation,
|
||||
rotation,
|
||||
Vec3::new(*x_length, *y_length, *z_length) * scale * 0.5,
|
||||
color,
|
||||
),
|
||||
ColliderShapeDesc::Sphere { radius } => {
|
||||
gizmos
|
||||
.sphere(
|
||||
Isometry3d::new(global.translation(), global.rotation()),
|
||||
*radius,
|
||||
color,
|
||||
)
|
||||
.resolution(24);
|
||||
draw_ellipsoid(gizmos, translation, rotation, scale * *radius, color);
|
||||
}
|
||||
ColliderShapeDesc::Capsule { radius, height } => {
|
||||
draw_capsule(
|
||||
gizmos,
|
||||
global.translation(),
|
||||
global.rotation(),
|
||||
*radius,
|
||||
*height,
|
||||
translation,
|
||||
rotation,
|
||||
*radius * scale.x.max(scale.z),
|
||||
*height * scale.y,
|
||||
color,
|
||||
);
|
||||
}
|
||||
ColliderShapeDesc::StaticMesh { .. } => {
|
||||
gizmos
|
||||
.sphere(
|
||||
Isometry3d::new(global.translation(), global.rotation()),
|
||||
0.35,
|
||||
color,
|
||||
)
|
||||
.resolution(16);
|
||||
draw_box(gizmos, translation, rotation, Vec3::splat(0.24), color);
|
||||
gizmos.line(
|
||||
translation - rotation * Vec3::splat(0.34),
|
||||
translation + rotation * Vec3::splat(0.34),
|
||||
color,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn draw_ellipsoid(gizmos: &mut Gizmos, center: Vec3, rotation: Quat, radii: Vec3, color: Color) {
|
||||
gizmos
|
||||
.ellipse(
|
||||
Isometry3d::new(center, rotation),
|
||||
Vec2::new(radii.x, radii.z),
|
||||
color,
|
||||
)
|
||||
.resolution(32);
|
||||
gizmos
|
||||
.ellipse(
|
||||
Isometry3d::new(center, rotation * Quat::from_rotation_x(FRAC_PI_2)),
|
||||
Vec2::new(radii.x, radii.y),
|
||||
color,
|
||||
)
|
||||
.resolution(32);
|
||||
gizmos
|
||||
.ellipse(
|
||||
Isometry3d::new(center, rotation * Quat::from_rotation_z(FRAC_PI_2)),
|
||||
Vec2::new(radii.y, radii.z),
|
||||
color,
|
||||
)
|
||||
.resolution(32);
|
||||
}
|
||||
|
||||
fn draw_light(
|
||||
gizmos: &mut Gizmos,
|
||||
global: &GlobalTransform,
|
||||
|
||||
@@ -6,7 +6,7 @@ use bevy::app::PluginGroupBuilder;
|
||||
use bevy::asset::AssetPlugin;
|
||||
use bevy::log::{LogPlugin, DEFAULT_FILTER};
|
||||
use bevy::prelude::*;
|
||||
use bevy::window::{CompositeAlphaMode, PresentMode, WindowMode, WindowPlugin};
|
||||
use bevy::window::{CompositeAlphaMode, ExitCondition, PresentMode, WindowMode, WindowPlugin};
|
||||
|
||||
/// Runtime switch for the HDR camera pass.
|
||||
///
|
||||
@@ -40,6 +40,27 @@ fn find_assets_directory(start: Option<PathBuf>) -> Option<String> {
|
||||
}
|
||||
|
||||
pub fn default_plugins(title: impl Into<String>) -> PluginGroupBuilder {
|
||||
configured_plugins(WindowPlugin {
|
||||
primary_window: Some(primary_window(title)),
|
||||
..default()
|
||||
})
|
||||
}
|
||||
|
||||
/// Default plugins for the editor, whose shutdown coordinator owns window-close handling.
|
||||
pub fn editor_plugins(title: impl Into<String>) -> PluginGroupBuilder {
|
||||
configured_plugins(editor_window_plugin(title))
|
||||
}
|
||||
|
||||
fn editor_window_plugin(title: impl Into<String>) -> WindowPlugin {
|
||||
WindowPlugin {
|
||||
primary_window: Some(primary_window(title)),
|
||||
exit_condition: ExitCondition::DontExit,
|
||||
close_when_requested: false,
|
||||
..default()
|
||||
}
|
||||
}
|
||||
|
||||
fn configured_plugins(window_plugin: WindowPlugin) -> PluginGroupBuilder {
|
||||
DefaultPlugins
|
||||
.set(LogPlugin {
|
||||
// Blacksite intentionally replaces Bevy's `.scn.ron` loader with a
|
||||
@@ -48,10 +69,7 @@ pub fn default_plugins(title: impl Into<String>) -> PluginGroupBuilder {
|
||||
filter: format!("{DEFAULT_FILTER}bevy_asset::server::loaders=error"),
|
||||
..default()
|
||||
})
|
||||
.set(WindowPlugin {
|
||||
primary_window: Some(primary_window(title)),
|
||||
..default()
|
||||
})
|
||||
.set(window_plugin)
|
||||
.set(AssetPlugin {
|
||||
file_path: resolve_assets_directory(),
|
||||
..default()
|
||||
@@ -86,8 +104,8 @@ pub fn hdr_enabled_from_env() -> bool {
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{primary_window, resolve_assets_directory};
|
||||
use bevy::window::CompositeAlphaMode;
|
||||
use super::{editor_window_plugin, primary_window, resolve_assets_directory};
|
||||
use bevy::window::{CompositeAlphaMode, ExitCondition};
|
||||
|
||||
#[test]
|
||||
fn primary_window_is_opaque() {
|
||||
@@ -97,6 +115,14 @@ mod tests {
|
||||
assert_eq!(window.composite_alpha_mode, CompositeAlphaMode::Opaque);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn editor_window_defers_close_and_exit_to_the_editor() {
|
||||
let plugin = editor_window_plugin("test");
|
||||
|
||||
assert!(!plugin.close_when_requested);
|
||||
assert!(matches!(plugin.exit_condition, ExitCondition::DontExit));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn resolve_assets_directory_finds_workspace_assets() {
|
||||
let cwd = std::env::current_dir().expect("cwd");
|
||||
|
||||
@@ -9,6 +9,7 @@ mod migrate;
|
||||
pub mod navigation;
|
||||
mod prefab;
|
||||
mod project_validation;
|
||||
pub mod sample_pack;
|
||||
mod upgrade;
|
||||
|
||||
use std::path::Path;
|
||||
|
||||
@@ -13,7 +13,7 @@ use shared::{
|
||||
AudioSourceDesc, BrushDesc, ColliderDesc, ColliderShapeDesc, EditorAssetRef, MaterialAsset,
|
||||
MaterialDesc, MaterialInstanceAsset, MaterialOverride, ModelRef, PostProcessEffectAsset,
|
||||
PostProcessVolumeDesc, PrefabInstance, PrefabRef, RendererMaterialSet, ShaderSchemaAsset,
|
||||
SkinnedMeshRenderer, StaticMeshRenderer, ANIMATION_MANIFEST_SCHEMA_VERSION,
|
||||
SkinnedMeshRenderer, StaticMeshRenderer, TerrainDesc, ANIMATION_MANIFEST_SCHEMA_VERSION,
|
||||
AUDIO_CLIP_SUB_ASSET_ID, COMPONENT_ANIMATION_CONTROLLER_DESC, COMPONENT_SKINNED_MESH_RENDERER,
|
||||
NAVIGATION_GENERATED_ARTIFACT_DIRECTORY,
|
||||
};
|
||||
@@ -25,6 +25,7 @@ const MATERIAL_DESC: &str = "shared::components::MaterialDesc";
|
||||
const MATERIAL_OVERRIDE: &str = "shared::components::MaterialOverride";
|
||||
const STATIC_MESH_RENDERER: &str = "shared::components::StaticMeshRenderer";
|
||||
const BRUSH_DESC: &str = "shared::components::BrushDesc";
|
||||
const TERRAIN_DESC: &str = "shared::components::TerrainDesc";
|
||||
const COLLIDER_DESC: &str = "shared::components::ColliderDesc";
|
||||
const POST_PROCESS_VOLUME: &str = "shared::components::PostProcessVolumeDesc";
|
||||
const PREFAB_INSTANCE: &str = "shared::components::PrefabInstance";
|
||||
@@ -1905,6 +1906,53 @@ fn collect_component_references(
|
||||
}
|
||||
}
|
||||
}
|
||||
TERRAIN_DESC => match ron::from_str::<TerrainDesc>(&component.ron) {
|
||||
Ok(terrain) => {
|
||||
if let Err(error) = terrain.validate() {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: "terrain.invalid".into(),
|
||||
source_path: source_path.to_string(),
|
||||
owner_actor_id: actor_id.map(str::to_string),
|
||||
reference: None,
|
||||
message: error,
|
||||
repair: "Repair the terrain dimensions, samples, layers, and chunk settings in the Inspector."
|
||||
.into(),
|
||||
});
|
||||
}
|
||||
if let Some(material) = &terrain.base_material {
|
||||
collect_terrain_material_ref(
|
||||
project_root,
|
||||
report,
|
||||
source_path,
|
||||
actor_id,
|
||||
"TerrainDesc.base_material",
|
||||
material,
|
||||
);
|
||||
}
|
||||
for (index, layer) in terrain.material_layers.iter().enumerate() {
|
||||
if let Some(material) = &layer.material {
|
||||
collect_terrain_material_ref(
|
||||
project_root,
|
||||
report,
|
||||
source_path,
|
||||
actor_id,
|
||||
&format!("TerrainDesc.material_layers[{index}].material"),
|
||||
material,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(error) => report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: "terrain.malformed".into(),
|
||||
source_path: source_path.to_string(),
|
||||
owner_actor_id: actor_id.map(str::to_string),
|
||||
reference: None,
|
||||
message: format!("could not parse TerrainDesc: {error}"),
|
||||
repair: "Remove and recreate the Terrain component with the current editor.".into(),
|
||||
}),
|
||||
},
|
||||
COLLIDER_DESC => validate_collider(
|
||||
project_root,
|
||||
report,
|
||||
@@ -2736,6 +2784,64 @@ fn collect_material(
|
||||
}
|
||||
}
|
||||
|
||||
fn collect_terrain_material_ref(
|
||||
project_root: &Path,
|
||||
report: &mut ProjectValidationReport,
|
||||
source_path: &str,
|
||||
actor_id: Option<&str>,
|
||||
property: &str,
|
||||
reference: &EditorAssetRef,
|
||||
) {
|
||||
let Some(path) = reference
|
||||
.source_path
|
||||
.as_deref()
|
||||
.filter(|path| !path.trim().is_empty())
|
||||
else {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: "terrain.material_ref_unresolved".into(),
|
||||
source_path: source_path.to_string(),
|
||||
owner_actor_id: actor_id.map(str::to_string),
|
||||
reference: Some(property.to_string()),
|
||||
message: format!("{property} has no loadable project source path"),
|
||||
repair:
|
||||
"Assign an existing project Material or Material Instance in the Terrain inspector."
|
||||
.into(),
|
||||
});
|
||||
return;
|
||||
};
|
||||
let path_value = Path::new(path);
|
||||
if path_value.is_absolute()
|
||||
|| path_value == Path::new("assets")
|
||||
|| !path_value.starts_with("assets")
|
||||
|| !path_value
|
||||
.components()
|
||||
.all(|component| matches!(component, Component::Normal(_)))
|
||||
{
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: "terrain.material_ref_invalid".into(),
|
||||
source_path: source_path.to_string(),
|
||||
owner_actor_id: actor_id.map(str::to_string),
|
||||
reference: Some(path.to_string()),
|
||||
message: format!(
|
||||
"{property} source path must be a normalized project-relative path below assets/"
|
||||
),
|
||||
repair: "Reassign the terrain layer from a project Material or Material Instance."
|
||||
.into(),
|
||||
});
|
||||
return;
|
||||
}
|
||||
add_reference(
|
||||
project_root,
|
||||
report,
|
||||
source_path,
|
||||
actor_id,
|
||||
"terrain_material",
|
||||
path,
|
||||
);
|
||||
}
|
||||
|
||||
fn collect_asset_ref(
|
||||
project_root: &Path,
|
||||
report: &mut ProjectValidationReport,
|
||||
@@ -3888,6 +3994,132 @@ mod tests {
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
fn write_terrain_scene(root: &Path, terrain: &TerrainDesc) {
|
||||
let terrain = ron::to_string(terrain).unwrap();
|
||||
std::fs::write(
|
||||
root.join("assets/levels/main.scn.ron"),
|
||||
format!(
|
||||
"(schema_version:4,resources:{{}},entities:{{1:(components:{{\"shared::components::ActorId\":(\"terrain-owner\"),\"{TERRAIN_DESC}\":{terrain},}})}})"
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terrain_material_references_are_actor_owned_dependencies() {
|
||||
let root = fixture_root();
|
||||
let mut terrain = TerrainDesc::flat(3);
|
||||
terrain.base_material = Some(
|
||||
EditorAssetRef::new("base-id", "material:instance", "Base")
|
||||
.with_source_path("assets/materials/base.ron"),
|
||||
);
|
||||
terrain.material_layers = vec![shared::TerrainMaterialLayer {
|
||||
material: Some(
|
||||
EditorAssetRef::new("layer-id", "material:source", "Layer")
|
||||
.with_source_path("assets/materials/layer.ron"),
|
||||
),
|
||||
uv_scale: 4.0,
|
||||
}];
|
||||
write_terrain_scene(&root, &terrain);
|
||||
|
||||
let report = validate_project(&root);
|
||||
let dependencies = report
|
||||
.dependencies
|
||||
.iter()
|
||||
.filter(|dependency| dependency.kind == "terrain_material")
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
assert_eq!(dependencies.len(), 2, "{:?}", report.dependencies);
|
||||
assert!(dependencies
|
||||
.iter()
|
||||
.all(|dependency| dependency.owner_actor_id.as_deref() == Some("terrain-owner")));
|
||||
assert_eq!(
|
||||
report
|
||||
.findings
|
||||
.iter()
|
||||
.filter(|finding| finding.code == "asset.missing")
|
||||
.count(),
|
||||
2
|
||||
);
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn terrain_material_references_require_runtime_source_paths() {
|
||||
let root = fixture_root();
|
||||
let mut terrain = TerrainDesc::flat(3);
|
||||
terrain.base_material = Some(
|
||||
EditorAssetRef::new("empty-path-id", "material:source", "Empty")
|
||||
.with_source_path(" "),
|
||||
);
|
||||
terrain.material_layers = vec![
|
||||
shared::TerrainMaterialLayer {
|
||||
material: Some(EditorAssetRef::new(
|
||||
"source-less-id",
|
||||
"material:source",
|
||||
"Source-less",
|
||||
)),
|
||||
uv_scale: 4.0,
|
||||
},
|
||||
shared::TerrainMaterialLayer {
|
||||
material: Some(
|
||||
EditorAssetRef::new("missing-id", "material:source", "Missing")
|
||||
.with_source_path("assets/materials/missing.ron"),
|
||||
),
|
||||
uv_scale: 8.0,
|
||||
},
|
||||
];
|
||||
write_terrain_scene(&root, &terrain);
|
||||
|
||||
let report = validate_project(&root);
|
||||
let unresolved = report
|
||||
.findings
|
||||
.iter()
|
||||
.filter(|finding| finding.code == "terrain.material_ref_unresolved")
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
assert_eq!(unresolved.len(), 2, "{:?}", report.findings);
|
||||
assert!(unresolved
|
||||
.iter()
|
||||
.all(|finding| finding.owner_actor_id.as_deref() == Some("terrain-owner")));
|
||||
assert!(report.findings.iter().any(|finding| {
|
||||
finding.code == "asset.missing"
|
||||
&& finding.owner_actor_id.as_deref() == Some("terrain-owner")
|
||||
&& finding.reference.as_deref() == Some("assets/materials/missing.ron")
|
||||
}));
|
||||
assert!(report.dependencies.iter().any(|dependency| {
|
||||
dependency.kind == "terrain_material"
|
||||
&& dependency.reference == "assets/materials/missing.ron"
|
||||
}));
|
||||
assert!(!report.dependencies.iter().any(|dependency| {
|
||||
dependency.kind == "generated_manifest"
|
||||
&& (dependency.reference.contains("empty-path-id")
|
||||
|| dependency.reference.contains("source-less-id"))
|
||||
}));
|
||||
assert!(!report.is_release_ready());
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn invalid_terrain_descriptor_blocks_project_validation() {
|
||||
let root = fixture_root();
|
||||
let mut terrain = TerrainDesc::flat(3);
|
||||
terrain.heights.pop();
|
||||
write_terrain_scene(&root, &terrain);
|
||||
|
||||
let report = validate_project(&root);
|
||||
let finding = report
|
||||
.findings
|
||||
.iter()
|
||||
.find(|finding| finding.code == "terrain.invalid")
|
||||
.expect("invalid terrain should block release validation");
|
||||
|
||||
assert_eq!(finding.owner_actor_id.as_deref(), Some("terrain-owner"));
|
||||
assert!(finding.message.contains("requires 9 height samples"));
|
||||
assert!(!report.is_release_ready());
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn project_default_level_must_be_in_the_audited_levels_tree() {
|
||||
let root = fixture_root();
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -856,6 +856,30 @@ impl BrushDesc {
|
||||
}
|
||||
|
||||
pub const TERRAIN_SCHEMA_VERSION: u32 = 1;
|
||||
pub const TERRAIN_MATERIAL_LAYER_LIMIT: usize = 4;
|
||||
|
||||
fn default_terrain_layer_uv_scale() -> f32 {
|
||||
8.0
|
||||
}
|
||||
|
||||
/// One shared project material assigned to a terrain blend channel.
|
||||
#[derive(Reflect, Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
#[reflect(Default, Debug, PartialEq, Serialize, Deserialize)]
|
||||
pub struct TerrainMaterialLayer {
|
||||
#[serde(default)]
|
||||
pub material: Option<EditorAssetRef>,
|
||||
#[serde(default = "default_terrain_layer_uv_scale")]
|
||||
pub uv_scale: f32,
|
||||
}
|
||||
|
||||
impl Default for TerrainMaterialLayer {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
material: None,
|
||||
uv_scale: default_terrain_layer_uv_scale(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Persistent height-grid terrain authoring data. Hydration partitions the grid into generated
|
||||
/// render/collider chunks; saved scenes retain only this descriptor.
|
||||
@@ -876,6 +900,13 @@ pub struct TerrainDesc {
|
||||
pub chunk_quads: u32,
|
||||
#[serde(default)]
|
||||
pub base_material: Option<EditorAssetRef>,
|
||||
/// Up to four project Material/Material Instance assignments. Empty retains the legacy
|
||||
/// `base_material` path and an empty weight map means 100% channel zero.
|
||||
#[serde(default)]
|
||||
pub material_layers: Vec<TerrainMaterialLayer>,
|
||||
/// RGBA8 weights per height sample. Channels correspond to `material_layers`.
|
||||
#[serde(default)]
|
||||
pub material_weights: Vec<[u8; TERRAIN_MATERIAL_LAYER_LIMIT]>,
|
||||
#[serde(default = "default_true")]
|
||||
pub generate_colliders: bool,
|
||||
#[serde(default = "default_true")]
|
||||
@@ -894,6 +925,8 @@ impl Default for TerrainDesc {
|
||||
height_scale: default_terrain_height_scale(),
|
||||
chunk_quads: default_terrain_chunk_quads(),
|
||||
base_material: None,
|
||||
material_layers: Vec::new(),
|
||||
material_weights: Vec::new(),
|
||||
generate_colliders: true,
|
||||
cast_shadows: true,
|
||||
receive_shadows: true,
|
||||
@@ -933,6 +966,44 @@ impl TerrainDesc {
|
||||
if self.heights.iter().any(|height| !height.is_finite()) {
|
||||
return Err("terrain height samples must all be finite".into());
|
||||
}
|
||||
if self.material_layers.len() > TERRAIN_MATERIAL_LAYER_LIMIT {
|
||||
return Err(format!(
|
||||
"terrain supports at most {TERRAIN_MATERIAL_LAYER_LIMIT} material layers"
|
||||
));
|
||||
}
|
||||
for (index, layer) in self.material_layers.iter().enumerate() {
|
||||
if !layer.uv_scale.is_finite() || layer.uv_scale <= 0.0 {
|
||||
return Err(format!(
|
||||
"terrain material layer {} UV scale must be finite and positive",
|
||||
index + 1
|
||||
));
|
||||
}
|
||||
}
|
||||
if !self.material_weights.is_empty() {
|
||||
if self.material_weights.len() != expected {
|
||||
return Err(format!(
|
||||
"terrain resolution {} requires {expected} material weights, found {}",
|
||||
self.resolution,
|
||||
self.material_weights.len()
|
||||
));
|
||||
}
|
||||
if self
|
||||
.material_weights
|
||||
.iter()
|
||||
.any(|weights| weights.iter().copied().map(u16::from).sum::<u16>() != 255)
|
||||
{
|
||||
return Err("terrain material weights must sum to 255 at every sample".into());
|
||||
}
|
||||
let active_channels = self.material_layers.len().max(1);
|
||||
if self.material_weights.iter().any(|weights| {
|
||||
weights
|
||||
.iter()
|
||||
.skip(active_channels)
|
||||
.any(|weight| *weight != 0)
|
||||
}) {
|
||||
return Err("terrain material weights use an unassigned layer channel".into());
|
||||
}
|
||||
}
|
||||
if !self.sample_spacing.is_finite() || self.sample_spacing <= 0.0 {
|
||||
return Err("terrain sample spacing must be finite and positive".into());
|
||||
}
|
||||
@@ -947,6 +1018,39 @@ impl TerrainDesc {
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Material channels used by hydration, including the legacy base-material fallback.
|
||||
pub fn effective_material_layers(&self) -> Vec<TerrainMaterialLayer> {
|
||||
if !self.material_layers.is_empty() {
|
||||
return self.material_layers.clone();
|
||||
}
|
||||
self.base_material
|
||||
.clone()
|
||||
.map(|material| TerrainMaterialLayer {
|
||||
material: Some(material),
|
||||
..Default::default()
|
||||
})
|
||||
.into_iter()
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Material weights for one sample, normalized for vertex transport.
|
||||
pub fn normalized_material_weights(&self, sample_index: usize) -> [f32; 4] {
|
||||
let weights = self
|
||||
.material_weights
|
||||
.get(sample_index)
|
||||
.copied()
|
||||
.unwrap_or([255, 0, 0, 0]);
|
||||
weights.map(|weight| f32::from(weight) / 255.0)
|
||||
}
|
||||
|
||||
/// Materializes the implicit channel-zero map before an editor paint operation.
|
||||
pub fn ensure_material_weights(&mut self) {
|
||||
let expected = self.resolution as usize * self.resolution as usize;
|
||||
if self.material_weights.len() != expected {
|
||||
self.material_weights = vec![[255, 0, 0, 0]; expected];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn default_terrain_schema_version() -> u32 {
|
||||
|
||||
@@ -40,16 +40,17 @@ use static_meshes::{
|
||||
};
|
||||
pub use terrain::HydratedTerrainChunk;
|
||||
use terrain::{cleanup_removed_terrain, hydrate_terrain};
|
||||
pub use visibility::initialize_level_object_visibility_hierarchy;
|
||||
use visibility::{
|
||||
ensure_level_object_visibility_hierarchy, init_editor_visibility_on_spawn,
|
||||
sync_editor_visibility, visibility_from_editor,
|
||||
sync_editor_visibility,
|
||||
};
|
||||
|
||||
use crate::{
|
||||
authoring_component_active, AuthoringComponentStates, BrushDesc, ColliderDesc,
|
||||
EditorVisibility, InspectorOrder, LevelObject, MaterialDesc, MaterialOverride, Primitive,
|
||||
StaticMeshRenderer, COMPONENT_BRUSH_DESC, COMPONENT_COLLIDER_DESC, COMPONENT_LIGHT_DESC,
|
||||
COMPONENT_MATERIAL_DESC, COMPONENT_PRIMITIVE, COMPONENT_STATIC_MESH_RENDERER,
|
||||
authoring_component_active, AuthoringComponentStates, BrushDesc, ColliderDesc, InspectorOrder,
|
||||
LevelObject, MaterialDesc, MaterialOverride, Primitive, StaticMeshRenderer,
|
||||
COMPONENT_BRUSH_DESC, COMPONENT_COLLIDER_DESC, COMPONENT_LIGHT_DESC, COMPONENT_MATERIAL_DESC,
|
||||
COMPONENT_PRIMITIVE, COMPONENT_STATIC_MESH_RENDERER,
|
||||
};
|
||||
|
||||
/// Registers hydration systems in deterministic order.
|
||||
@@ -115,6 +116,8 @@ pub fn flush_level_object_hydration(world: &mut World) {
|
||||
world.insert_resource(StaticMeshArtifactCache::default());
|
||||
}
|
||||
|
||||
initialize_level_object_visibility_hierarchy(world);
|
||||
|
||||
let primitives: Vec<(Entity, Primitive)> = world
|
||||
.query_filtered::<(
|
||||
Entity,
|
||||
@@ -250,12 +253,6 @@ pub fn flush_level_object_hydration(world: &mut World) {
|
||||
}
|
||||
}
|
||||
|
||||
let visibility_targets: Vec<(Entity, EditorVisibility)> = world
|
||||
.query_filtered::<(Entity, &EditorVisibility), With<LevelObject>>()
|
||||
.iter(world)
|
||||
.map(|(entity, vis)| (entity, *vis))
|
||||
.collect();
|
||||
|
||||
let rendering = world
|
||||
.get_resource::<settings::ProjectSettings>()
|
||||
.map(|s| s.rendering.clone())
|
||||
@@ -348,25 +345,6 @@ pub fn flush_level_object_hydration(world: &mut World) {
|
||||
}
|
||||
|
||||
state.apply(world);
|
||||
|
||||
for (entity, editor) in visibility_targets {
|
||||
let visibility = visibility_from_editor(editor);
|
||||
if let Some(mut vis) = world.get_mut::<Visibility>(entity) {
|
||||
*vis = visibility;
|
||||
} else if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.insert(visibility);
|
||||
}
|
||||
if world.get::<InheritedVisibility>(entity).is_none() {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.insert(InheritedVisibility::default());
|
||||
}
|
||||
}
|
||||
if world.get::<ViewVisibility>(entity).is_none() {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.insert(ViewVisibility::default());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
|
||||
@@ -8,7 +8,8 @@ use bevy::prelude::*;
|
||||
|
||||
use crate::{
|
||||
authoring_component_active, load_resolved_material_from_path, AuthoringComponentStates,
|
||||
InspectorOrder, LevelObject, RaytracingExcluded, TerrainDesc, COMPONENT_TERRAIN_DESC,
|
||||
HydratedTerrainMaterialBinding, InspectorOrder, LevelObject, RaytracingExcluded, TerrainDesc,
|
||||
COMPONENT_TERRAIN_DESC,
|
||||
};
|
||||
|
||||
use super::materials::material_from_desc;
|
||||
@@ -96,9 +97,10 @@ pub fn spawn_terrain_chunks(
|
||||
return;
|
||||
}
|
||||
|
||||
let material = terrain
|
||||
.base_material
|
||||
.as_ref()
|
||||
let effective_layers = terrain.effective_material_layers();
|
||||
let material = effective_layers
|
||||
.first()
|
||||
.and_then(|layer| layer.material.as_ref())
|
||||
.and_then(|reference| reference.source_path.as_deref())
|
||||
.and_then(|path| match load_resolved_material_from_path(path) {
|
||||
Ok((desc, _)) => Some(material_from_desc(asset_server, &desc)),
|
||||
@@ -135,6 +137,10 @@ pub fn spawn_terrain_chunks(
|
||||
Name::new(format!("Terrain Chunk {chunk_x},{chunk_z}")),
|
||||
Mesh3d(mesh),
|
||||
MeshMaterial3d(material.clone()),
|
||||
HydratedTerrainMaterialBinding {
|
||||
owner,
|
||||
layers: terrain.effective_material_layers(),
|
||||
},
|
||||
Transform::default(),
|
||||
Visibility::Visible,
|
||||
RaytracingExcluded,
|
||||
@@ -188,6 +194,7 @@ pub fn terrain_chunk_mesh(
|
||||
let mut positions = Vec::with_capacity((width * depth) as usize);
|
||||
let mut normals = Vec::with_capacity((width * depth) as usize);
|
||||
let mut uvs = Vec::with_capacity((width * depth) as usize);
|
||||
let mut colors = Vec::with_capacity((width * depth) as usize);
|
||||
let quad_count = (terrain.resolution - 1) as f32;
|
||||
let half_extent = quad_count * terrain.sample_spacing * 0.5;
|
||||
|
||||
@@ -209,6 +216,7 @@ pub fn terrain_chunk_mesh(
|
||||
]);
|
||||
normals.push(normal.to_array());
|
||||
uvs.push([x as f32 / quad_count, z as f32 / quad_count]);
|
||||
colors.push(terrain.normalized_material_weights((z * terrain.resolution + x) as usize));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -230,6 +238,7 @@ pub fn terrain_chunk_mesh(
|
||||
mesh.insert_attribute(Mesh::ATTRIBUTE_POSITION, positions);
|
||||
mesh.insert_attribute(Mesh::ATTRIBUTE_NORMAL, normals);
|
||||
mesh.insert_attribute(Mesh::ATTRIBUTE_UV_0, uvs);
|
||||
mesh.insert_attribute(Mesh::ATTRIBUTE_COLOR, colors);
|
||||
mesh.insert_indices(Indices::U32(indices));
|
||||
if let Err(error) = mesh.generate_tangents() {
|
||||
warn!("Terrain chunk tangent generation failed: {error:?}");
|
||||
@@ -264,12 +273,61 @@ mod tests {
|
||||
let mut terrain = TerrainDesc::flat(5);
|
||||
terrain.heights[12] = 0.75;
|
||||
terrain.sample_spacing = 2.0;
|
||||
terrain.material_layers = vec![
|
||||
crate::TerrainMaterialLayer {
|
||||
material: Some(crate::EditorAssetRef::new(
|
||||
"ground",
|
||||
"material:source",
|
||||
"Ground",
|
||||
)),
|
||||
uv_scale: 6.0,
|
||||
},
|
||||
crate::TerrainMaterialLayer {
|
||||
material: Some(crate::EditorAssetRef::new(
|
||||
"rock",
|
||||
"material:source",
|
||||
"Rock",
|
||||
)),
|
||||
uv_scale: 12.0,
|
||||
},
|
||||
];
|
||||
terrain.ensure_material_weights();
|
||||
terrain.material_weights[12] = [64, 191, 0, 0];
|
||||
let text = ron::to_string(&terrain).unwrap();
|
||||
let restored: TerrainDesc = ron::from_str(&text).unwrap();
|
||||
assert_eq!(restored, terrain);
|
||||
assert!(restored.validate().is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn chunk_mesh_transports_normalized_material_weights_as_vertex_colors() {
|
||||
let mut terrain = TerrainDesc::flat(3);
|
||||
terrain.ensure_material_weights();
|
||||
terrain.material_weights[4] = [64, 191, 0, 0];
|
||||
let mesh = terrain_chunk_mesh(&terrain, 0, 0, 2, 2).unwrap();
|
||||
let Some(bevy::mesh::VertexAttributeValues::Float32x4(colors)) =
|
||||
mesh.attribute(Mesh::ATTRIBUTE_COLOR)
|
||||
else {
|
||||
panic!("terrain chunks should carry RGBA layer weights");
|
||||
};
|
||||
assert_eq!(colors.len(), 9);
|
||||
assert!((colors[4][0] - 64.0 / 255.0).abs() < 0.0001);
|
||||
assert!((colors[4][1] - 191.0 / 255.0).abs() < 0.0001);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn descriptor_rejects_non_normalized_material_weights() {
|
||||
let mut terrain = TerrainDesc::flat(3);
|
||||
terrain.material_weights = vec![[128, 128, 0, 0]; 9];
|
||||
assert!(terrain.validate().unwrap_err().contains("sum to 255"));
|
||||
|
||||
terrain.material_weights = vec![[127, 0, 128, 0]; 9];
|
||||
assert!(terrain
|
||||
.validate()
|
||||
.unwrap_err()
|
||||
.contains("unassigned layer channel"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hydration_generates_runtime_only_chunks_and_cleans_up() {
|
||||
let mut app = App::new();
|
||||
|
||||
@@ -3,6 +3,24 @@
|
||||
use crate::{EditorVisibility, LevelObject};
|
||||
use bevy::prelude::*;
|
||||
|
||||
/// Establishes the runtime visibility hierarchy synchronously for all authored actors.
|
||||
///
|
||||
/// Scene loading can occur between scheduled hydration sets, so callers that materialize a scene
|
||||
/// must run this before generated render children can be attached in the same frame.
|
||||
pub fn initialize_level_object_visibility_hierarchy(world: &mut World) {
|
||||
let targets: Vec<(Entity, EditorVisibility)> = world
|
||||
.query_filtered::<(Entity, Option<&EditorVisibility>), With<LevelObject>>()
|
||||
.iter(world)
|
||||
.map(|(entity, visibility)| (entity, visibility.copied().unwrap_or_default()))
|
||||
.collect();
|
||||
|
||||
for (entity, editor_visibility) in targets {
|
||||
if let Ok(mut entity_mut) = world.get_entity_mut(entity) {
|
||||
entity_mut.insert((editor_visibility, visibility_from_editor(editor_visibility)));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[expect(
|
||||
clippy::type_complexity,
|
||||
reason = "the query mirrors Bevy's three visibility hierarchy components"
|
||||
@@ -81,7 +99,9 @@ pub fn visibility_from_editor(editor: EditorVisibility) -> Visibility {
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::ensure_level_object_visibility_hierarchy;
|
||||
use super::{
|
||||
ensure_level_object_visibility_hierarchy, initialize_level_object_visibility_hierarchy,
|
||||
};
|
||||
use crate::{EditorVisibility, LevelObject};
|
||||
use bevy::prelude::*;
|
||||
|
||||
@@ -102,4 +122,34 @@ mod tests {
|
||||
assert!(world.get::<InheritedVisibility>(entity).is_some());
|
||||
assert!(world.get::<ViewVisibility>(entity).is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn immediate_initializer_establishes_hierarchy_before_scheduled_hydration() {
|
||||
let mut world = World::new();
|
||||
let entity = world
|
||||
.spawn((LevelObject, EditorVisibility { visible: false }))
|
||||
.id();
|
||||
|
||||
initialize_level_object_visibility_hierarchy(&mut world);
|
||||
|
||||
assert_eq!(world.get::<Visibility>(entity), Some(&Visibility::Hidden));
|
||||
assert!(world.get::<InheritedVisibility>(entity).is_some());
|
||||
assert!(world.get::<ViewVisibility>(entity).is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn immediate_initializer_migrates_missing_authored_visibility() {
|
||||
let mut world = World::new();
|
||||
let entity = world.spawn(LevelObject).id();
|
||||
|
||||
initialize_level_object_visibility_hierarchy(&mut world);
|
||||
|
||||
assert_eq!(
|
||||
world.get::<EditorVisibility>(entity),
|
||||
Some(&EditorVisibility::default())
|
||||
);
|
||||
assert_eq!(world.get::<Visibility>(entity), Some(&Visibility::Visible));
|
||||
assert!(world.get::<InheritedVisibility>(entity).is_some());
|
||||
assert!(world.get::<ViewVisibility>(entity).is_some());
|
||||
}
|
||||
}
|
||||
@@ -20,10 +20,10 @@ pub use actor::{infer_actor_kind, validate_actor, ActorValidationError};
|
||||
pub use animation::*;
|
||||
pub use components::*;
|
||||
pub use hydration::{
|
||||
cascade_config_from_rendering, flush_level_object_hydration, material_from_desc,
|
||||
strip_hydrated, strip_hydrated_entity, HydratedModelRoot, HydratedPrefabMember,
|
||||
HydratedPrefabReady, HydratedSkinnedMeshRoot, HydratedTerrainChunk, HydrationPlugin,
|
||||
PrefabHydrationBlocked,
|
||||
cascade_config_from_rendering, flush_level_object_hydration,
|
||||
initialize_level_object_visibility_hierarchy, material_from_desc, strip_hydrated,
|
||||
strip_hydrated_entity, HydratedModelRoot, HydratedPrefabMember, HydratedPrefabReady,
|
||||
HydratedSkinnedMeshRoot, HydratedTerrainChunk, HydrationPlugin, PrefabHydrationBlocked,
|
||||
};
|
||||
pub use material_asset::{
|
||||
load_resolved_material_from_path, MaterialAlphaMode, MaterialAsset, MaterialInstanceAsset,
|
||||
@@ -114,6 +114,7 @@ impl Plugin for SharedTypesPlugin {
|
||||
.register_type::<PrimitiveShape>()
|
||||
.register_type::<BrushDesc>()
|
||||
.register_type::<TerrainDesc>()
|
||||
.register_type::<TerrainMaterialLayer>()
|
||||
.register_type::<BrushKind>()
|
||||
.register_type::<BrushPlaneDesc>()
|
||||
.register_type::<BrushFaceDesc>()
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
use bevy::prelude::*;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::{ComponentInstanceId, EditorAssetRef, MaterialParameter, MaterialTextureBinding};
|
||||
use crate::{
|
||||
ComponentInstanceId, EditorAssetRef, MaterialParameter, MaterialTextureBinding,
|
||||
TerrainMaterialLayer,
|
||||
};
|
||||
|
||||
/// A stable reference to a project material, material instance, or imported material subasset.
|
||||
///
|
||||
@@ -112,6 +115,23 @@ pub struct HydratedRendererMaterialBinding {
|
||||
pub effective_material: Option<MaterialRef>,
|
||||
}
|
||||
|
||||
/// Runtime ownership marker consumed by the project terrain-layer renderer.
|
||||
#[derive(Component, Reflect, Debug, Clone, PartialEq)]
|
||||
#[reflect(Component, Default, Debug, PartialEq)]
|
||||
pub struct HydratedTerrainMaterialBinding {
|
||||
pub owner: Entity,
|
||||
pub layers: Vec<TerrainMaterialLayer>,
|
||||
}
|
||||
|
||||
impl Default for HydratedTerrainMaterialBinding {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
owner: Entity::PLACEHOLDER,
|
||||
layers: Vec::new(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
+19
-1
@@ -54,13 +54,16 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
|
||||
| [0037](adr/0037-collaborative-authored-file-safety.md) | Exact authored-file revisions, observational Git status, and optional ownership providers |
|
||||
| [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 |
|
||||
| [0042](adr/0042-guarded-editor-shutdown-and-document-savepoints.md) | Guarded native editor exit and canonical per-document clean checkpoints |
|
||||
|
||||
## Editor framework
|
||||
|
||||
| Document | Purpose |
|
||||
|----------|---------|
|
||||
| [editor/release-notes.md](editor/release-notes.md) | Editor framework 1.0 baseline |
|
||||
| [editor/evaluations/](editor/evaluations/) | Horizon gate sign-offs (R1–R6) |
|
||||
| [editor/evaluations/](editor/evaluations/) | Acceptance records, screenshots, and Gitea evidence-publishing policy |
|
||||
| [editor/architecture.md](editor/architecture.md) | Viewport / PIE / settings data flow |
|
||||
| [editor/visual-language.md](editor/visual-language.md) | Editor chrome, viewport, selection, gizmo, and visualizer language |
|
||||
| [editor/roadmap.md](editor/roadmap.md) | Phased editor roadmap and status |
|
||||
@@ -81,8 +84,19 @@ 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/collider-authoring.md](editor/collider-authoring.md) | Collider shape authoring, hydration diagnostics, semantic overlays, and placement prerequisites |
|
||||
| [editor/sample-regression-pack.md](editor/sample-regression-pack.md) | Five-area sample catalog, editor workflow, validation gates, and visual QA contract |
|
||||
| [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/collider-diagnostics/](editor/evaluations/collider-diagnostics/) | Live screenshot and acceptance results for collider overlays, diagnostics, shape history, and placement preflight |
|
||||
| [editor/evaluations/navigation-authoring/](editor/evaluations/navigation-authoring/) | Live screenshots and acceptance results for navigation authoring and runtime parity |
|
||||
| [editor/evaluations/operator-invariants/](editor/evaluations/operator-invariants/) | Source acceptance results for production operator lifecycle, rollback, cleanup, and undo/redo invariants |
|
||||
| [editor/evaluations/sample-regression-pack/](editor/evaluations/sample-regression-pack/) | Exact-implementation source and native acceptance evidence for the editor sample regression pack |
|
||||
| [editor/evaluations/guarded-shutdown-savepoints/](editor/evaluations/guarded-shutdown-savepoints/) | Source and native acceptance evidence for guarded editor exit and per-document clean checkpoints |
|
||||
| [editor/evaluations/scoped-ui-actions/](editor/evaluations/scoped-ui-actions/) | Exact-implementation source and native acceptance evidence for actions invoked during scoped egui rendering |
|
||||
| [editor/evaluations/production-readiness/](editor/evaluations/production-readiness/) | Current versioned production gate, evidence matrix, candidate commands, soak protocol, and independent sign-off requirements |
|
||||
|
||||
## Working plans (not canonical long-term)
|
||||
@@ -105,6 +119,10 @@ Detailed milestone and feature plans live in [`.cursor/plans/`](../.cursor/plans
|
||||
| `source_control_collaboration_safety_*.plan.md` | Exact authored-file guards, observational Git status, conflict recovery, and provider contract |
|
||||
| `production_readiness_acceptance_*.plan.md` | Release-candidate evidence matrix, blocker sequence, clean-checkout checks, soak, budgets, and independent sign-off |
|
||||
| `material_library_and_targeted_drop_*.plan.md` | Dedicated Material Library, exact viewport slot/primitive/brush targeting, hover preview, cancel, and grouped history |
|
||||
| `terrain_material_layers_*.plan.md` | Terrain shared-material layers, normalized weights, blended hydration, and modal painting |
|
||||
| `operator_invariants_completion_*.plan.md` | Production operator dispatch, interruption, rollback, cleanup, and undo/redo acceptance |
|
||||
| `editor_sample_regression_pack_*.plan.md` | Five-area sample manifest, editor catalog, deterministic validation, and native regression acceptance |
|
||||
| `guarded_shutdown_savepoints_*.plan.md` | Native close coordination, asynchronous Save All, and canonical history clean points |
|
||||
|
||||
## Crate responsibilities (quick reference)
|
||||
|
||||
|
||||
@@ -34,12 +34,19 @@ assets, mark a scene clean, enter source control, or silently replace authored w
|
||||
or Discard removes that scene's recovery generations. Save Recovery Copy As writes the snapshot
|
||||
to a separate transactional scene file without changing the active scene or recovery lifecycle.
|
||||
- A successful manual save retires recovery generations for that scene.
|
||||
- A successful load or manual save establishes that tab's canonical authored-content checkpoint.
|
||||
Undo and redo compare the current stable authored projection with this checkpoint to derive dirty
|
||||
state. Failed writes, cancelled Save As, and recovery restores do not advance it.
|
||||
- Native editor exit is authorized only after all dirty scene tabs save successfully or the user
|
||||
explicitly discards them. See [ADR 0042](0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
|
||||
## Consequences
|
||||
|
||||
- Interrupted manual writes retain the previous complete destination on filesystems with atomic
|
||||
same-directory rename semantics.
|
||||
- Recovery is machine-local and does not pollute builds or source control.
|
||||
- Undoing exactly to the last loaded or saved authored state clears the dirty marker without
|
||||
weakening recovery after direct edits or failed saves.
|
||||
- Autosave still performs authored serialization and hydration rebuild work. Performance
|
||||
instrumentation and background snapshotting remain follow-up work under the production roadmap.
|
||||
- Unsaved new scenes do not yet have a stable recovery identity; they require a later session-ID
|
||||
|
||||
@@ -20,8 +20,10 @@ untrusted serialized ECS state.
|
||||
- Session schema v1 allowlists metadata only: project root, active scene path, saved dock-layout
|
||||
text, hierarchy expansion paths, non-destructive panel visibility, and finite camera bookmark
|
||||
transforms.
|
||||
- Write the session transactionally. Startup immediately writes `clean_shutdown: false`; normal
|
||||
`AppExit` writes the final document with `clean_shutdown: true`.
|
||||
- Write the session transactionally. Startup immediately writes `clean_shutdown: false`; only an
|
||||
editor-shutdown-coordinator-authorized `AppExit` writes the final document with
|
||||
`clean_shutdown: true`. Direct `AppExit`, forced termination, and process failure retain the
|
||||
abnormal marker. See [ADR 0042](0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
- A clean prior session may restore its active scene and non-destructive UI state automatically.
|
||||
An abnormal prior session starts from the normal safe scene and requires explicit confirmation
|
||||
before opening the prior scene.
|
||||
|
||||
@@ -23,6 +23,14 @@ Both the editor Diagnostics window and the `cargo validate-levels` headless comm
|
||||
entry point. The command supports `--project <path>` and `--json`; the editor can select the live
|
||||
owning actor for an attributed finding. Blocking errors produce a nonzero headless exit status.
|
||||
|
||||
The optional editor regression pack has one conventional manifest at
|
||||
`assets/samples/editor_samples.ron`. Schema v1 contains exactly one Brush, Material, Terrain,
|
||||
Physics Placement, and Rendering sample with stable metadata, project-relative scene paths, and
|
||||
explicit manual checks. `cargo validate-samples` validates that catalog and combines its findings
|
||||
with the authoritative project report. Projects without the manifest remain valid ordinary
|
||||
projects; Blacksite CI invokes the sample command to make the complete pack mandatory for this
|
||||
repository.
|
||||
|
||||
Project validation covers the project manifest and asset roots, registry IDs/sources/dependencies,
|
||||
generated static mesh manifests, material and shader documents, post effects, scene and prefab
|
||||
graphs, authored model/material/texture/brush/collider references, rendering profiles, and
|
||||
@@ -34,6 +42,10 @@ startup entrypoint. Unknown newer scene schemas are rejected rather than down-st
|
||||
requirements are explicit findings; for example, Solari projects record the required forward-path
|
||||
fallback QA when ray tracing is unavailable.
|
||||
|
||||
Terrain descriptors participate in the same actor-owned dependency pass. Their authored dimensions,
|
||||
height and weight grids, chunk settings, base material, and material layers are validated before
|
||||
hydration so a sample or shipping scene cannot hide an invalid or unresolved terrain reference.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Headless and editor validation share result semantics and finding ownership.
|
||||
@@ -42,3 +54,7 @@ fallback QA when ray tracing is unavailable.
|
||||
Gitea #44 acceptance verifies the shared gate against real development output.
|
||||
- Asset formats added later must register their dependencies with this validator and extend the
|
||||
valid, missing, cyclic, and incompatible project-fixture matrix.
|
||||
- The sample manifest is discovery and regression metadata, not a second project-settings schema;
|
||||
editor UI and headless tooling consume the same scene ordering and validation result.
|
||||
- CI must hydrate Git LFS before validation because a pointer file is intentionally treated as
|
||||
missing runtime content.
|
||||
@@ -55,6 +55,8 @@ from its draw or skeleton representation.
|
||||
user decision to reassign or discard.
|
||||
- Legacy primitive/actor `MaterialDesc` paths remain compatibility paths until their consumers move
|
||||
to renderer slots; new mesh-renderer work uses shared references.
|
||||
- Runtime property blocks have no editor promotion workflow yet.
|
||||
- `MaterialPropertyBlocks` currently define the runtime-only schema and persistence exclusion, but
|
||||
renderer application and the editor promote-to-instance transaction are not implemented. Gitea
|
||||
#53 owns that complete workflow; callers must not treat the component as visibly applied yet.
|
||||
- Material graph authoring, nested instances, blended/transmissive materials, and a generalized
|
||||
per-renderer property-block inspector are outside this decision.
|
||||
@@ -0,0 +1,37 @@
|
||||
# ADR 0040: Terrain Material Layers And Weight Transport
|
||||
|
||||
## Status
|
||||
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
|
||||
Terrain needs multiple shared project materials, editable weight painting, deterministic persistence,
|
||||
and raster behavior that remains consistent between the editor and game. Duplicating full material
|
||||
descriptors into scenes would break the shared Material/Material Instance contract. Storing floating
|
||||
point weights would also create avoidable scene churn and normalization drift.
|
||||
|
||||
## Decision
|
||||
|
||||
`TerrainDesc` stores at most four `TerrainMaterialLayer` entries referencing shared assets and one
|
||||
RGBA8 weight tuple per height sample. Every explicit tuple sums to 255; an absent weight array means
|
||||
full channel-zero coverage for backward compatibility. Generated terrain chunks transport normalized
|
||||
weights through `Mesh::ATTRIBUTE_COLOR`.
|
||||
|
||||
`shared` owns persistence, validation, chunk generation, and a runtime-only terrain material binding.
|
||||
`blacksite_surface` owns the terrain-specific `ExtendedMaterial` and blends each resolved layer's
|
||||
albedo, tangent-space normal, metallic, and roughness inputs. Invalid or unavailable references leave
|
||||
the existing visible terrain fallback in place and emit diagnostics. Terrain remains excluded from
|
||||
Solari geometry until a matching ray-tracing evaluator exists, and its opaque material is therefore
|
||||
forced through Bevy's forward raster path even when the project default is deferred.
|
||||
|
||||
Editor paint strokes materialize the implicit default map only when needed. Each pointer stroke is a
|
||||
single reflected `TerrainDesc` transaction; cancel restores the exact original descriptor.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Four channels give fixed shader bindings, compact deterministic scenes, and simple normalization.
|
||||
- Adding more than four simultaneous layers requires a deliberate schema and renderer revision.
|
||||
- Weight resolution follows the height grid; independent high-resolution splat maps remain future work.
|
||||
- Terrain raster rendering gains project-material texture parity while Solari terrain parity remains an
|
||||
explicit later milestone rather than using a semantically different proxy.
|
||||
@@ -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.
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
# ADR 0042: Guarded Editor Shutdown And Document Savepoints
|
||||
|
||||
## Status
|
||||
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
|
||||
Bevy's default native-window policy closes a requested window and exits after the final window is
|
||||
gone. That policy bypasses Blacksite's scene-tab and project-switch confirmations, so a compositor
|
||||
close request could silently discard dirty authored work. Reading `WindowCloseRequested` in another
|
||||
system is insufficient because Bevy's default close system has its own message cursor and still
|
||||
despawns the window.
|
||||
|
||||
Scene dirtiness was also independent of editor history. Every undo or redo marked the active scene
|
||||
dirty, even when undo restored the exact state that had last loaded or saved. Undo depth alone is
|
||||
not a valid savepoint: editor commands contain runtime entity IDs and are intentionally cleared when
|
||||
tabs switch, while saves may establish a clean point in the middle of a timeline.
|
||||
|
||||
## Decision
|
||||
|
||||
- The full editor disables Bevy's automatic close-on-request behavior. The game and Project Browser
|
||||
keep their existing native-window policy.
|
||||
- One editor shutdown coordinator owns native window close, **File > Quit**, project switching, and
|
||||
programmatic editor-exit requests. It coalesces duplicate requests and is the only normal path
|
||||
authorized to emit `AppExit`.
|
||||
- Final authorization runs in a dedicated main schedule after Bevy's `Last` schedule. The guard
|
||||
rechecks dirty scene state after every editor authoring system, then clean-session persistence
|
||||
runs after that finalizer in the same post-`Last` schedule.
|
||||
- A clean editor exits immediately. Dirty scene tabs enter one non-blocking native decision with
|
||||
explicit **Save All**, **Discard**, and **Cancel** actions. Save completion, including an untitled
|
||||
tab's Save As picker, is applied on the main thread. The coordinator exits only after every dirty
|
||||
tab saves or the user explicitly discards; cancel or failure retains the live session.
|
||||
- Clean-session persistence accepts only an exit authorized by the coordinator. Crashes, forced
|
||||
termination, and unguarded `AppExit` retain the abnormal-session marker.
|
||||
- Every scene tab owns a canonical authored-content checkpoint established by a successful load or
|
||||
save. The projection uses stable actor IDs, stable parent actor IDs, sorted component identities,
|
||||
and scene composition; it excludes transient Bevy entity numbers and runtime hydration.
|
||||
- A committed edit marks the active tab dirty. Successful undo or redo compares the current
|
||||
canonical authored projection with that tab's checkpoint. Equality clears the dirty marker;
|
||||
divergence sets it. Failed saves and recovery restores do not advance the checkpoint.
|
||||
- Editor command stacks remain active-document runtime state and are still cleared on tab switches.
|
||||
Checkpoint ownership belongs to the document tab, so dirty truth survives those clears.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Native close can no longer silently discard authored scene tabs, and the editor remains responsive
|
||||
while confirmation or Save As dialogs are open.
|
||||
- A normal exit requires an explicit editor-owned authorization. New code must request shutdown
|
||||
through the coordinator instead of writing `AppExit` directly.
|
||||
- Undoing to the last saved authored state clears title and tab dirty indicators, including after a
|
||||
save at nonzero history depth. Redo or a divergent branch marks the document dirty again.
|
||||
- Reconciliation serializes the authored projection after undo and redo. This is more work than a
|
||||
depth comparison, but it is bounded to explicit history navigation and remains correct across
|
||||
direct non-history repairs, entity respawns, and tab switches.
|
||||
- Operating-system process kill and power loss cannot be confirmed; recovery and abnormal-session
|
||||
handling remain the safety boundary for those cases.
|
||||
+22
-3
@@ -26,12 +26,24 @@ 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 |
|
||||
| [collider-authoring.md](collider-authoring.md) | Collider shape editing, shared health diagnostics, overlays, hydration status, and placement reuse |
|
||||
| [sample-regression-pack.md](sample-regression-pack.md) | Five-area sample manifest, native workflow, visual composition, validation, and maintenance contract |
|
||||
| [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 |
|
||||
| [evaluations/collaborative-file-safety/](evaluations/collaborative-file-safety/) | Live screenshot and verification record for source-control status and guarded external-change recovery |
|
||||
| [evaluations/native-dialog-responsiveness/](evaluations/native-dialog-responsiveness/) | Live native-Wayland screenshot and verification record for non-blocking picker responsiveness |
|
||||
| [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/collider-diagnostics/](evaluations/collider-diagnostics/) | Live screenshot and verification record for semantic collider overlays, health linking, shape switching, and placement reuse |
|
||||
| [evaluations/navigation-authoring/](evaluations/navigation-authoring/) | Live screenshots and verification record for navigation authoring and runtime parity |
|
||||
| [evaluations/operator-invariants/](evaluations/operator-invariants/) | Source acceptance record for production operator lifecycle, rollback, cleanup, and undo/redo invariants |
|
||||
| [evaluations/sample-regression-pack/](evaluations/sample-regression-pack/) | Exact-implementation source and native acceptance evidence for the five-area editor regression pack |
|
||||
| [evaluations/guarded-shutdown-savepoints/](evaluations/guarded-shutdown-savepoints/) | Source and native acceptance evidence for guarded editor exit and per-document clean checkpoints |
|
||||
| [evaluations/scoped-ui-actions/](evaluations/scoped-ui-actions/) | Exact-implementation source and native acceptance evidence for actions invoked during scoped egui rendering |
|
||||
| [evaluations/production-readiness/](evaluations/production-readiness/) | Current #50 release-candidate matrix and required clean-checkout, soak, performance, limitation, and independent-signoff evidence |
|
||||
|
||||
## Subsystems (code → doc)
|
||||
@@ -40,7 +52,9 @@ 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` | Persisted height grid and generated render/collider chunks | terrain.md, ADR 0039 |
|
||||
| `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 |
|
||||
| `viewport/collider_diagnostics.rs` / `viewport/visualizers.rs` / `ui/inspector.rs` | Shared collider health, semantic overlays, and undoable shape authoring | collider-authoring.md |
|
||||
| `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 |
|
||||
@@ -57,6 +71,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| `project/session.rs` | Versioned XDG session document, clean marker, and safe resume | session-recovery.md, ADR 0024 |
|
||||
| `project/diagnostics_bundle.rs` | Privacy-bounded transactional support report export | session-recovery.md, ADR 0024 |
|
||||
| `project/launcher.rs` | Strict project inspection, CLI activation, recent filtering, and sandbox scaffolding | project-launcher.md, ADR 0025 |
|
||||
| `project/samples.rs` / `scene::sample_pack` / `xtask/src/validate_samples.rs` | Cached editor sample catalog, canonical pack contract, and deterministic headless release gate | sample-regression-pack.md, ADR 0028 |
|
||||
| `ext/` | Command palette, BRP, game panel adapters | ADR 0007 |
|
||||
| `ui/mod.rs` | Dock layout, unified viewport, menus | README controls |
|
||||
| `ui/scene_tabs.rs` | Main-toolbar scene tabs and composition controls | multi-scene-composition.md, ADR 0026 |
|
||||
@@ -83,8 +98,8 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
- **Brush authoring** — `ActorKind::Brush + BrushDesc` stores persisted convex blockout faces, validates authored geometry in the inspector and Window → Brush Diagnostics, and hydrates active valid brushes into generated mesh children. See [brushes.md](brushes.md).
|
||||
- **Draw Brush** — `B`, toolbar pencil, or command `brush.draw` enters a floor-polygon draw mode. LMB places snapped points, Backspace removes the last point, Enter locks the outline for height editing, mouse up/down adjusts height, and Enter/LMB creates additive prism brushes through history. Esc/right-click cancels. Simple concave outlines decompose into convex brush parts; self-intersections remain blocked.
|
||||
- **Brush edit modes** — with a brush selected, `1`/`2`/`3`/`4` enter vertex, edge, face, and clip element modes. Element modes show brush handles in the viewport, own LMB picking, support Shift multi-select, show a mode badge, and Esc returns to object mode. Vertex/edge/face selections use the standard `W`/`E`/`R` gizmo at the element pivot and commit undoable `SetBrush` edits. Clip previews a bounds-based half-brush and commits with Enter; command-palette intersect, convex merge, and subtract operations use the same preview/commit lifecycle for conservative cuboid/prism blockout.
|
||||
- **Collider split** — imported mesh collision lives in a separate `ColliderDesc::StaticMesh` plus optional `RigidBodyDesc`; renderer slots own only render visibility, shadows, mesh, and material references.
|
||||
- **Material assets and renderer slots** — Material and direct-base Material Instance documents are shared assets. `StaticMeshRenderer` and `SkinnedMeshRenderer` each own stable material slots with imported source defaults and explicit shared assignments; Clear returns to the source default, while reimported missing slots retain overrides as orphans instead of matching by name. Runtime-only property blocks never mutate or persist into the shared asset. Custom Surface evaluators use the same constrained ABI for raster and Solari-eligible non-deformed geometry; skinned/morph geometry is deliberately excluded from Solari until deformed BLAS updates exist. See [material-system.md](material-system.md), [ADR 0035](../adr/0035-shared-material-assets-and-renderer-slots.md), and [ADR 0036](../adr/0036-surface-abi-and-solari-parity.md).
|
||||
- **Collider split and health** — imported mesh collision lives in a separate `ColliderDesc::StaticMesh` plus optional `RigidBodyDesc`; renderer slots own only render visibility, shadows, mesh, and material references. Inspector, viewport, Diagnostics, and physics placement share one authored/runtime health result; see [collider-authoring.md](collider-authoring.md).
|
||||
- **Material assets and renderer slots** — Material and direct-base Material Instance documents are shared assets. `StaticMeshRenderer` and `SkinnedMeshRenderer` each own stable material slots with imported source defaults and explicit shared assignments; Clear returns to the source default, while reimported missing slots retain overrides as orphans instead of matching by name. The property-block schema is runtime-only and persistence-excluded, while renderer application/promotion remains #53. Custom Surface evaluators use the same constrained ABI for raster and Solari-eligible non-deformed geometry; skinned/morph geometry is deliberately excluded from Solari until #54 adds deformed BLAS updates. See [material-system.md](material-system.md), [ADR 0035](../adr/0035-shared-material-assets-and-renderer-slots.md), and [ADR 0036](../adr/0036-surface-abi-and-solari-parity.md).
|
||||
- **Prefab authoring** — shared `PrefabOverrides` targets generated actors by nested anchor chain plus stable `ActorId`, and applies reflected property/component plus same-layer structural operations in editor and game hydration. The editor supports scoped Revert and transactional **Apply to source** with three-way conflict checks, exact-file undo guards, and recoverable changed/broken/conflict states. `HydratedPrefabMember` keeps generated content out of owner serialization; linked-root saves retain local structure as variants. **Unpack Layer** preserves nested links, while **Convert to Local** recursively removes them. See [prefab-authoring.md](prefab-authoring.md) and [ADR 0027](../adr/0027-stable-prefab-ownership-and-variants.md).
|
||||
- **Visual language** uses a near-black industrial shell, a compact Blacksite identity mark, restrained amber actions/primary selection, cyan secondary selection, semantic status colors, stable grouped controls, and shared elevated viewport chips. Primary/secondary selection roles remain consistent across hierarchy rows, viewport x-ray shells/corner brackets, the selection HUD, and transform interactions. See [visual-language.md](visual-language.md).
|
||||
- **Hierarchy** shows authored objects plus useful runtime context (`Player`, `PlayerCamera`, Project Sun). Ordinary runtime rows remain read-only; generated prefab rows expose override-aware inspection and same-layer remove/reparent actions while rejecting cross-instance/layer and composition-boundary drops. Locks prevent selection, gizmos, drag participation, structural targets, and mutating context actions. Authored reparenting preserves world placement and records parent/local-transform/manual-order changes as one undoable command.
|
||||
@@ -98,6 +113,10 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
components on load and component transactions, and does not prohibit compatible composition such
|
||||
as renderer plus light. Component validation owns requirements and geometry-source conflicts.
|
||||
- **Scene persistence and recovery** use transactional same-directory writes for authored scenes and bounded user-local recovery snapshots for dirty saved scenes. Recovery runs every 120 seconds by default, keeps five generations, never marks the scene clean, and appears as a status/File-menu restore or discard action when newer than the authored file. Restore leaves the original scene dirty until manually saved. See [ADR 0023](../adr/0023-transactional-scene-persistence-and-recovery.md).
|
||||
- **Guarded shutdown and clean savepoints** route native close, **File > Quit**, project switching,
|
||||
and programmatic exit through one non-blocking Save All / Discard / Cancel coordinator. Each tab's
|
||||
dirty marker is reconciled against its canonical last-loaded-or-saved authored projection after
|
||||
undo/redo. See [ADR 0042](../adr/0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
- **Collaborative file safety** records exact content revisions for loaded scenes, prefab source operations, editable materials, and Project Settings, then rechecks them immediately before atomic publication. External changes, create races, read-only files, and optional ownership locks keep the existing bytes intact and open Reload/Compare Metadata/Save As/Cancel recovery. Git status is asynchronous, observational, and absent without noise outside a repository. See [collaborative-file-safety.md](collaborative-file-safety.md) and [ADR 0037](../adr/0037-collaborative-authored-file-safety.md).
|
||||
- **Scene visualizers** expose actor root icons, colliders, lights, player spawns, gameplay markers, volumes, prefab/model anchors, Project Sun, and runtime player/camera markers without changing saved scene data. Spot lights show inner/outer cones and cameras show near/far frusta. Viewport options independently gate visualizer categories and include actor icon and transform-gizmo size sliders.
|
||||
- **Clean game-view overlay** (`G`) hides editor chrome, grid, selection outlines, transform gizmos, actor root icons, visualizers, and selectable proxies without changing camera ownership; `Ctrl+G` toggles grid.
|
||||
|
||||
+32
-11
@@ -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 |
|
||||
@@ -86,11 +87,20 @@ or Cancel. Generated artifacts remain under their subsystem-owned regeneration p
|
||||
[collaborative-file-safety.md](collaborative-file-safety.md) and
|
||||
[ADR 0037](../adr/0037-collaborative-authored-file-safety.md).
|
||||
|
||||
`project/shutdown.rs` owns native close, **File > Quit**, project switching, and programmatic editor
|
||||
exit. The editor launch configuration leaves native close requests open; the coordinator coalesces
|
||||
them, retries the shared native-dialog broker when busy, and authorizes `AppExit` only after clean
|
||||
state, successful Save All, or explicit Discard. Scene I/O owns the asynchronous per-tab save
|
||||
transaction and reports completion back to the coordinator. Final authorization and clean-session
|
||||
persistence run in an editor schedule inserted after Bevy's `Last`, so material drops, brush/gizmo
|
||||
finalizers, and every other authoring system finish before the last dirty-state check. See
|
||||
[ADR 0042](../adr/0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
|
||||
`project/session.rs` owns the independent versioned restart document under the user state
|
||||
directory. It snapshots allowlisted paths, panel visibility, dock/hierarchy metadata, and camera
|
||||
bookmarks, writes a running marker at startup, and records clean `AppExit`. Abnormal sessions do
|
||||
not auto-open the prior scene; the explicit safe-resume prompt is the only path back. See
|
||||
[ADR 0024](../adr/0024-versioned-editor-session-state.md).
|
||||
bookmarks, writes a running marker at startup, and records clean state only for a coordinator-
|
||||
authorized `AppExit`. Abnormal sessions do not auto-open the prior scene; the explicit safe-resume
|
||||
prompt is the only path back. See [ADR 0024](../adr/0024-versioned-editor-session-state.md).
|
||||
|
||||
`project/diagnostics_bundle.rs` exports a separate, transactional support report from an explicit
|
||||
metadata allowlist. It summarizes build/renderer identity, project paths, dirty state, aggregate
|
||||
@@ -181,17 +191,25 @@ 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`.
|
||||
2. `EditorOnly` entities (cameras, helpers) are filtered from hierarchy and save; visualizer proxies can be picked but resolve back to source entities.
|
||||
3. Player placement is stored as `PlayerSpawn`; the runtime `Player` is never serialized.
|
||||
4. `SceneIo` writes native Bevy dynamic scenes under `assets/levels/`, routed through `scene::document::SceneDocument`. The active tab is materialized in the ECS world; inactive tabs retain normalized authored snapshots and independent dirty/recovery state. `SceneComposition` resources reference validated project-relative subscenes by stable IDs, and runtime-only `ComposedSceneMember` ownership prevents child actors from being flattened into the owner save. See [multi-scene-composition.md](multi-scene-composition.md) and ADR 0026.
|
||||
4. `SceneIo` writes native Bevy dynamic scenes under `assets/levels/`, routed through `scene::document::SceneDocument`. The active tab is materialized in the ECS world; inactive tabs retain normalized authored snapshots, canonical clean checkpoints, and independent dirty/recovery state. Undo/redo reconciles stable authored content rather than transient ECS entity IDs. `SceneComposition` resources reference validated project-relative subscenes by stable IDs, and runtime-only `ComposedSceneMember` ownership prevents child actors from being flattened into the owner save. See [multi-scene-composition.md](multi-scene-composition.md), ADR 0026, and [ADR 0042](../adr/0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
5. Hydration systems in `game` spawn meshes, colliders, lights, static mesh renderer parts, and
|
||||
dedicated skinned-model hierarchies at runtime. Level-object roots are initialized with Bevy
|
||||
visibility hierarchy components before generated children are attached, so authoring
|
||||
@@ -236,13 +254,16 @@ On play enter/exit the editor snapshots **player sim state only** (transform, ve
|
||||
|
||||
Structural edits (spawn, delete, transform, rename) go through `EditorHistory` command objects in `history.rs`.
|
||||
User-facing actions route through the operator lifecycle in `operators.rs`: begin, preview,
|
||||
commit, cancel, disabled reason, and status text. The first bridge wraps command-palette and queued
|
||||
editor commands as immediate operators, while existing `EditorHistory` commands remain the undo
|
||||
payload. Asset placement, mesh-subasset placement, texture apply, and material apply actions now
|
||||
use immediate operators from `assets::operators`; texture/material changes across a selection use
|
||||
one `SetMaterialGroup` command. Draw Brush, brush CSG, clip, and element gizmo paths publish the
|
||||
same preview/commit/cancel phases. `operators/test_harness.rs` verifies authored deltas, dirty
|
||||
state, helper cleanup, undo grouping, and undo/redo restoration; see
|
||||
commit, cancel, disabled reason, stable ID, and status text. Registered commands return typed
|
||||
`OperatorAction::Commit` or `OperatorAction::ContinuePreview`, so immediate commands finish while
|
||||
Draw Brush and CSG retain modal Preview ownership; validation failures terminate instead of leaving
|
||||
stale status. Existing `EditorHistory` commands remain the undo payload. Group Selection is one
|
||||
atomic command that remaps its transient group identity on every redo without reparenting unrelated
|
||||
siblings. Lighting reset and Project Sun changes use one grouped light command. Asset placement,
|
||||
assignment, exact material drops, brush tools, terrain strokes, physics placement, and the real
|
||||
transform tracker all publish terminal lifecycle state. `operators/test_harness.rs` verifies semantic
|
||||
projections, dirty-state preservation, stable IDs, helper cleanup, undo grouping, repeated undo/redo,
|
||||
and automatic interruption rollback; see
|
||||
[operator-regression-testing.md](operator-regression-testing.md).
|
||||
|
||||
PIE stop restores player simulation state only; authored `LevelObject` edits made during PIE remain in the scene.
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
# Collider Authoring And Diagnostics
|
||||
|
||||
`ColliderDesc` is the saved collision shape. `RigidBodyDesc` independently controls authored body
|
||||
motion, while Avian `Collider` and `RigidBody` components are hydrated runtime state. Collider
|
||||
health compares both sides of that boundary so editor tools do not treat authored-but-unavailable
|
||||
collision as ready.
|
||||
|
||||
## Inspector Workflow
|
||||
|
||||
The Collider component card reports its shape, health, and hydration state. Box, sphere, capsule,
|
||||
and static mesh shapes can be switched from the Shape menu. Primitive conversions retain the
|
||||
previous shape's useful extents; each completed switch uses `SetCollider` history and is one undo
|
||||
operation. Invalid shapes expose a reset action. Static mesh sources can be selected or replaced
|
||||
with the actor's renderer meshes.
|
||||
|
||||
Dimensions are clamped to positive values in normal inspector editing. Project validation still
|
||||
rejects hand-edited or migrated non-finite/zero dimensions and empty mesh source lists.
|
||||
|
||||
## Viewport Contract
|
||||
|
||||
Collider view hides render meshes and emphasizes authored collision using semantic status colors:
|
||||
|
||||
| Color | State |
|
||||
|-------|-------|
|
||||
| Green | Valid hydrated solid collider |
|
||||
| Cyan | Valid hydrated trigger |
|
||||
| Gray | Disabled or inactive collider |
|
||||
| Amber | Stale hydration or oversized collider |
|
||||
| Red | Missing or invalid collider |
|
||||
|
||||
Box, sphere/ellipsoid, and capsule wireframes include actor world scale. Static mesh collision uses
|
||||
the cooked runtime collider bounds when available. A rigid body with no collider receives a red
|
||||
spatial marker, so missing collision remains discoverable with meshes hidden. The lower-left HUD
|
||||
summarizes scene health and identifies the selected collider's shape and hydration state.
|
||||
|
||||
## Diagnostics
|
||||
|
||||
The shared health service reports:
|
||||
|
||||
- missing/inactive/disabled collider authoring;
|
||||
- non-positive or non-finite primitive dimensions;
|
||||
- empty, unresolved, or registry-stale static mesh references;
|
||||
- valid authoring that has not produced a runtime collider;
|
||||
- primitive colliders exceeding 1,000 meters on any world-space axis.
|
||||
|
||||
The 1,000-meter warning is conservative rather than a save blocker. Large worlds should split
|
||||
collision into spatially bounded actors to keep broad-phase behavior predictable. Diagnostics can
|
||||
select the affected actor; static mesh fields retain their asset-browser locate action.
|
||||
|
||||
Physics Placement consumes the same errors plus its stricter non-trigger and hydrated rigid-body
|
||||
requirements. See [physics-placement.md](physics-placement.md).
|
||||
|
||||
`assets/levels/collider_diagnostics_showcase.scn.ron` contains valid box, scaled sphere, capsule,
|
||||
trigger, disabled, and missing-collider states for visual acceptance. Invalid, oversized, and stale
|
||||
asset cases live in unit fixtures so the committed project remains release-valid.
|
||||
@@ -10,6 +10,10 @@ Living checklist for the production editor program ([ADR 0012](../adr/0012-zero-
|
||||
| Monolithic `hydrate_authoring_entities` | Done | `crates/shared/src/hydration/*` modules |
|
||||
| Optional / inferred `ActorKind` as long-term save path | Done | Schema v2 + migration; save validates |
|
||||
| Hydrated components in committed `.scn.ron` | CI | `scene::validate_scene_authoring_only` + `repo_editor_scene_has_no_hydrated_components` |
|
||||
| Production mutation without commit/cancel/failure/undo invariants | Done | Shared operator harness plus typed history projections cover palette, asset, brush, terrain, physics, grouping, lighting, material-drop, and transform paths; see [evaluation](evaluations/operator-invariants/) |
|
||||
| Representative editor coverage can silently disappear | Done | Versioned five-area manifest, typed scene gate, `validate-samples`, and native protocol; see [sample pack](sample-regression-pack.md) |
|
||||
| Dirty editor exit can bypass an explicit decision, or transient entity IDs define document cleanliness | Done | Guarded shutdown and canonical authored-content checkpoints pass source validation and all seven native workflows at source implementation `4b33f32`, including dirty untitled Save All through Save As. See the [evaluation](evaluations/guarded-shutdown-savepoints/). |
|
||||
| Scoped UI callbacks depend on temporarily unavailable host state or lose direct selection precedence | Done | Explicit selection/tab requests, panel-owned state, captured viewport data, and full-slice reconciliation pass six scoped regressions, independent re-review, and native toolbar/Inspector/diagnostics acceptance at `9e23ae7`; see the [evaluation](evaluations/scoped-ui-actions/). |
|
||||
| Dual FBX thumbnail ad-hoc path (parallel to unified pipeline) | Partial | Phase 5 `assets/thumbnails/` refactor |
|
||||
| `failed_keys` thumbnail cache without retry API | Partial | `asset_thumbnails.rs`; Phase 5 `ThumbnailState` |
|
||||
|
||||
@@ -21,7 +25,7 @@ Living checklist for the production editor program ([ADR 0012](../adr/0012-zero-
|
||||
| P1 | `ActorKind` required; `validate_actor` on save |
|
||||
| P2 | No runtime components in default inspector |
|
||||
| P3 | `HierarchySiblingIndex`; no undefined sibling order |
|
||||
| P6 | `ActorInspectorSection` registry; command palette commands; BRP authoring policy |
|
||||
| P6 | `ActorInspectorSection` registry; typed immediate/modal command dispatch; BRP authoring policy; production mutation invariants |
|
||||
| P7 | ADRs 0009–0012 indexed; CI `shared` + `scene` + `editor` checks |
|
||||
|
||||
## Manual verification (release)
|
||||
@@ -29,3 +33,5 @@ Living checklist for the production editor program ([ADR 0012](../adr/0012-zero-
|
||||
- [ ] R1–R6 rendering/inspector scenarios ([roadmap.md](roadmap.md))
|
||||
- [ ] Save/load roundtrip: hierarchy, lights, materials unchanged
|
||||
- [ ] PIE 60s stop: project lighting profile unchanged unless scene overrides edited
|
||||
- [ ] Rerun the [operator invariant matrix](operator-regression-testing.md) from the nominated release-candidate commit
|
||||
- [ ] Open all five [sample regression pack](sample-regression-pack.md) entries through the native File menu and record exact-candidate results
|
||||
@@ -0,0 +1,15 @@
|
||||
# Editor Evaluation Evidence
|
||||
|
||||
Each subdirectory keeps the canonical, versioned acceptance record for an editor feature. Screenshots
|
||||
remain in the repository beside that record and are intentionally stored through Git LFS.
|
||||
|
||||
## Publishing To Gitea
|
||||
|
||||
Do not embed a repository `/raw/branch/...` or `/raw/commit/...` PNG URL in an issue or pull-request
|
||||
comment. Gitea can serve the LFS pointer document at that URL, which renders as text instead of an
|
||||
image. Upload the PNG to the relevant issue as a native attachment and use the returned
|
||||
`/attachments/<uuid>` URL for the Markdown image. Keep the repository evaluation link next to the
|
||||
attachment so the evidence remains traceable to its committed source.
|
||||
|
||||
Native attachments are presentation copies. The committed evaluation directory remains the source of
|
||||
truth and should retain the original image and verification notes.
|
||||
@@ -0,0 +1,24 @@
|
||||
# Collider Diagnostics Acceptance
|
||||
|
||||
Issue: Gitea #26 (`BS-JD-305`)
|
||||
|
||||
## Evidence
|
||||
|
||||

|
||||
|
||||
The native Wayland editor loaded `assets/levels/collider_diagnostics_showcase.scn.ron` and entered
|
||||
Collider view. The captured frame shows shape overlays with meshes hidden, the scene health HUD,
|
||||
the selectable Diagnostics window, and the selected trigger's hydrated status in the inspector.
|
||||
|
||||
## Live Results
|
||||
|
||||
- Box, scaled sphere/ellipsoid, and capsule overlays matched authored transforms and dimensions.
|
||||
- Green ready, cyan trigger, gray disabled, and red missing states were visually distinct.
|
||||
- The HUD reported `4 ready / 1 disabled / 0 warning / 1 invalid` and followed selection.
|
||||
- The Diagnostics panel linked the missing finding back to its actor.
|
||||
- Switching the valid box to sphere preserved useful extents and produced `Undo: Set Collider`;
|
||||
undo restored the box.
|
||||
- Physics Placement rejected the missing-collider actor with the shared collider-health messages.
|
||||
- Scene switching and editor shutdown completed without a panic or runtime validation error.
|
||||
|
||||
Packaged verification remains deferred by current project instruction.
|
||||
Binary file not shown.
@@ -0,0 +1,72 @@
|
||||
# Guarded Shutdown And Clean Savepoints Evaluation
|
||||
|
||||
**Date:** 2026-07-13
|
||||
|
||||
**Issue:** [Gitea #55](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/55)
|
||||
|
||||
**Branch:** `codex/guarded-shutdown-savepoints`
|
||||
|
||||
**Implementation commit:** `4b33f3235761fd0dd3daf219e5bbbaee884eb626`
|
||||
|
||||
**Release-candidate commit:** Not nominated
|
||||
|
||||
**Implementation validation:** **Pass**
|
||||
|
||||
**Native acceptance:** **Pass**
|
||||
|
||||
This record covers editor-owned shutdown authorization and per-document authored-content clean
|
||||
checkpoints. The permanent architecture contract lives in
|
||||
[ADR 0042](../../../adr/0042-guarded-editor-shutdown-and-document-savepoints.md). The automated
|
||||
results below apply to the exact implementation commit. Native rows exercise the same shutdown
|
||||
implementation after the unrelated toolbar fix disclosed below. Neither replaces the clean-checkout,
|
||||
soak, or independent-signoff requirements for a future release candidate.
|
||||
|
||||
## Automated Verification
|
||||
|
||||
| Command or suite | Result | Evidence |
|
||||
|------------------|--------|----------|
|
||||
| `cargo fmt --all -- --check` | Pass | Formatting check completed without changes. |
|
||||
| `git diff --check` | Pass | No whitespace errors. |
|
||||
| `cargo clippy --workspace --all-targets -- -D warnings` | Pass | Workspace and all targets completed with warnings denied. |
|
||||
| `cargo test --workspace --all-targets --no-fail-fast` | Pass | All workspace targets passed; the editor crate reported 282 passing tests. |
|
||||
| Guarded shutdown regressions | Pass | Native close, menu/programmatic exit, cancel/discard, broker contention, late-authoring mutation, and secondary-window behavior are covered by 13 focused tests. |
|
||||
| Save All regressions | Pass | Named and untitled tab sequencing, cancellation, conflict retention, duplicate destination rejection, and active-tab restoration are covered by six focused tests. |
|
||||
| Project-switch regressions | Pass | Three focused tests cover guarded handoff, cancellation, and browser-spawn failure. |
|
||||
| Packaged acceptance | Deferred | Explicitly deferred by project-owner direction; no packaged result is claimed. |
|
||||
|
||||
## Native Acceptance
|
||||
|
||||
The guarded-shutdown implementation under test is the source commit named above. The native debug
|
||||
editor was rebuilt at `9e23ae731f95dc351ecc744d6ca61f6bc4467317` after the independently scoped
|
||||
[UI action-safety fix](../scoped-ui-actions/) ([Gitea #57](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/57))
|
||||
made the untitled-scene toolbar workflow reachable, then launched as
|
||||
`target/debug/editor --project .`. Each row records an observed workflow rather than inferring
|
||||
behavior from the automated suite.
|
||||
|
||||
| Workflow | Result | Evidence |
|
||||
|----------|--------|----------|
|
||||
| Undo back to the clean checkpoint | Pass | A scene mutation added the dirty marker; undo restored the canonical authored projection and cleared the marker. |
|
||||
| Native window close, then **Cancel** | Pass | The dirty-document decision appeared; Cancel retained the dirty document and kept the editor running. |
|
||||
| **File > Quit**, then **Discard** | Pass | The same guarded decision path ran and the editor process exited with code 0 without saving the dirty draft. |
|
||||
| **File > Switch Project...** guard | Pass | A dirty document was intercepted by the shared shutdown decision before project-browser handoff. |
|
||||
| Dirty named document, **Save All** | Pass | The named scene write completed before authorization and the editor then exited with code 0. |
|
||||
| Clean untitled document close | Pass | No dirty-work decision was needed and the editor exited with code 0. |
|
||||
| Dirty untitled document, **Save All**, then Save As continuation | Pass | **File > New Scene** created an untitled tab; the toolbar Cube action spawned authored content and marked it dirty. Native close followed by **Save All** opened KDE Save As in `assets/levels`; saving as `issue55_shutdown_qa.scn.ron` wrote a 1,986-byte scene and the editor exited with code 0. The QA scene was verified and removed. |
|
||||
|
||||
## Evidence Status
|
||||
|
||||

|
||||
|
||||
- Native modal capture: `/tmp/blacksite-issue55-shutdown-modal-4b33f32.png` (temporary staging;
|
||||
3426x1384 RGB PNG, 1,656,602 bytes).
|
||||
- SHA-256: `2ddb2571325e0d99f5559efd1ba3164845ffba64767833d4e5ad8d2925aedfb5`.
|
||||
- Gitea #55 native attachment: asset 36, uploaded through the issue attachment API.
|
||||
|
||||
The Gitea copy was uploaded as an ordinary issue attachment. No repository PNG or LFS raw URL is
|
||||
claimed by this evaluation.
|
||||
|
||||
## Release Use
|
||||
|
||||
The #55 source and native feature-level acceptance record is complete. A future production candidate
|
||||
must still rerun these workflows from the exact nominated commit; this record does not nominate a
|
||||
candidate or establish production readiness.
|
||||
@@ -65,7 +65,7 @@ Additional captures:
|
||||
| Dedicated static/skinned ownership | Pass | Separate authored/hydrated renderer types; rigged/animated manifests are rejected by static hydration |
|
||||
| Pose lifecycle | Pass | Explicit stable default clip; transform and morph-weight baseline restore on stop, controller removal, preview reset, and PIE exit |
|
||||
| Renderer material slots | Pass | Stable named IDs, imported fallback, explicit assignment, orphan retention, and in-place material patching |
|
||||
| Material assets/instances | Pass | Versioned shared assets, direct-base sparse instances, transient property blocks, Apply/Revert/Create Instance |
|
||||
| Material assets/instances | Pass | Versioned shared assets, direct-base sparse instances, Apply/Revert/Create Instance; property-block runtime application/promotion is isolated in #53 |
|
||||
| Texture parameters | Pass | Project-wide picker includes imported texture subassets; base/schema/stored/instance slots share browse, drop, reject, and clear behavior |
|
||||
| Component lifecycle | Pass | Stable registry IDs, reflected transactions/history, persistence allowlist, independent active state, and compatible composition |
|
||||
| Surface raster/Solari semantics | Pass for eligible geometry | Shared ABI packing, evaluator, textures, normal/emissive/unlit values, and cutout predicate |
|
||||
@@ -92,5 +92,6 @@ Additional captures:
|
||||
Bevy 0.19's maintained Solari path does not expose dynamic post-morph/post-skin vertex buffers and
|
||||
BLAS updates. Skinned and morph-deformed actors therefore remain visible in raster but are omitted
|
||||
from ray tracing with an actionable diagnostic. This is safer than tracing a stale bind-pose ghost;
|
||||
dynamic deformed BLAS support remains future work and the corresponding Gitea acceptance item stays
|
||||
open.
|
||||
dynamic deformed BLAS support is the independently scoped Gitea #54. Runtime property-block
|
||||
application and promotion are independently scoped in #53; this foundation record does not claim
|
||||
either follow-up.
|
||||
@@ -0,0 +1,56 @@
|
||||
# Operator Invariants Evaluation
|
||||
|
||||
Date: 2026-07-12
|
||||
|
||||
Gitea issue:
|
||||
[`#33`](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/33)
|
||||
|
||||
This acceptance record covers the source-level production operator contract. It does not nominate a
|
||||
release candidate or replace the clean-checkout rerun required by production-readiness gate G3.
|
||||
|
||||
## Accepted Coverage
|
||||
|
||||
- Registered commands distinguish immediate completion from modal Preview ownership; validation
|
||||
failures terminate with their stable command ID. Palette execution and cancellation fully dismiss
|
||||
the palette instead of leaving an empty title bar.
|
||||
- Group Selection is one history transaction and preserves unrelated hierarchy rows through repeated
|
||||
undo/redo even though the transient group entity is respawned. Newly spawned and redone group
|
||||
actors own their visibility hierarchy before viewport icon children attach.
|
||||
- Reset Lighting and Project Sun changes are grouped, undoable light transactions.
|
||||
- Asset/sub-asset placement; material/texture/audio/animation assignment; and exact viewport material
|
||||
drops cover commit, block/failure, cancel where applicable, and semantic undo/redo projections.
|
||||
- Draw Brush, CSG, clip, and element-gizmo paths exercise production modal finalizers and helper
|
||||
cleanup.
|
||||
- Terrain sculpt/paint cover multi-dab commit, failure rollback, cancel, clean-view interruption, and
|
||||
resource cleanup.
|
||||
- Physics placement covers prerequisite block, exact cancel, real settle commit, multi-selection
|
||||
grouping, helper cleanup, undo, and redo.
|
||||
- The transform tracker covers continuous multi-target grouping and no-op release termination.
|
||||
|
||||
## Verification
|
||||
|
||||
The publication worktree passed:
|
||||
|
||||
- `cargo test -p editor --lib --no-fail-fast`: 245 passed, 0 failed.
|
||||
- `cargo clippy -p editor --lib --tests -- -D warnings`.
|
||||
- `cargo fmt --all -- --check`.
|
||||
- `cargo test --workspace --all-targets --no-fail-fast`.
|
||||
- `cargo clippy --workspace --all-targets -- -D warnings`.
|
||||
- `cargo validate-levels --project .`: 62 dependencies, 5 expected non-blocking findings, 0 blocking
|
||||
errors.
|
||||
|
||||
The Gitea closure comment records these results with the exact publication commit.
|
||||
|
||||
## Native Editor Follow-up
|
||||
|
||||
A native-editor replay on 2026-07-13 loaded the collider diagnostics scene, exercised Draw Brush
|
||||
Preview/cancel, and grouped two hierarchy actors through undo/redo. The replay exposed two issues
|
||||
that source-only checks did not make visible: command execution left a collapsed palette title bar,
|
||||
and the viewport icon child briefly inherited from a group actor without Bevy visibility hierarchy
|
||||
components. Both paths now have focused regression assertions; a rebuilt replay dismissed the
|
||||
palette completely and emitted no hierarchy warning.
|
||||
|
||||
No screenshot is required for this ticket: the accepted surface is lifecycle, rollback, cleanup, and
|
||||
history behavior exercised through headless production entry points. Live command/status checks add
|
||||
confidence but are not substituted for semantic assertions. Packaged-runtime testing remains
|
||||
deferred by project-owner request.
|
||||
@@ -0,0 +1,29 @@
|
||||
# Physics Placement Evaluation
|
||||
|
||||
Date: 2026-07-12
|
||||
|
||||

|
||||
|
||||
The native Wayland editor is shown with the 2026-07-12 revision of
|
||||
`assets/levels/physics_placement_showcase.scn.ron`. At that revision, 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. The fixture now exposes those stable actor IDs as Placement
|
||||
Cuboid, Placement Sphere, and Placement Capsule; its distinct-shape rerun is tracked by the
|
||||
[sample-pack evaluation](../sample-regression-pack/).
|
||||
|
||||
## Acceptance
|
||||
|
||||
- In the recorded revision, all three props used 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.
@@ -1,8 +1,8 @@
|
||||
# Production-Readiness Acceptance Matrix
|
||||
|
||||
**Matrix version:** 0.2
|
||||
**Matrix version:** 0.5
|
||||
|
||||
**Last audit:** 2026-07-12
|
||||
**Last audit:** 2026-07-13
|
||||
|
||||
**Release-candidate commit:** Not nominated
|
||||
|
||||
@@ -30,21 +30,21 @@ 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. |
|
||||
| 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`, non-blocking native dialogs `#52`, guarded shutdown/savepoints `#55`, and scoped UI action safety `#57` have feature-level source/native acceptance. #55 passed all seven native paths at source implementation `4b33f32`; #57 passed toolbar, Inspector, diagnostics, selection, and guarded-exit paths at exact implementation `9e23ae7`. Candidate-specific end-to-end reruns remain. |
|
||||
| G2 | Brush, material, terrain, physics placement, animation, audio, navigation, PIE, and build/package samples pass | Partial | The [five-area sample pack](../sample-regression-pack/) passed source and native acceptance on exact implementation commit `d52cc2e`, including Brush, Material, Terrain, Physics Placement, and Rendering. No release candidate is nominated, brush acceptance `#37` remains open, and combined animation/audio/navigation/PIE/build evidence is incomplete. Packaged testing is owner-deferred. |
|
||||
| G3 | Undo/redo/cancel invariants and helper cleanup cover every production mutation path | Partial | Source implementation and focused evidence are complete in [operator regression testing](../../operator-regression-testing.md) and the [operator-invariants evaluation](../operator-invariants/); Gitea `#33` closed at `c55f347`. A clean, exact-candidate rerun is still required for `Pass`. |
|
||||
| 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. |
|
||||
| G6 | Headless content validation and CI are green from a clean checkout | Missing | [CI configuration](../../../../.github/workflows/ci.yml) hydrates LFS and includes both project and sample content gates. Local implementation checks have passed, but no clean-checkout candidate run is linked. The current Gitea server does not expose an Actions run endpoint for this repository. |
|
||||
| G7 | First-hour UX and recovery QA are signed off by someone other than the implementer | External | No independent sign-off exists. Gitea `#36` remains open; historical H1-H6 implementation-pass notes do not count. |
|
||||
| G8 | Known limitations have severity/workaround and no P0 blocker remains | Fail | Limitations are distributed across feature docs rather than one candidate ledger. Open P0 work includes `#32`, `#33`, and `#51`; `#50` cannot close while a gate-relevant P0 remains. Roadmap audit `#35`, Material Library `#16`, targeted drops `#18`, collaborative safety `#49`, and dialog responsiveness `#52` are closed. |
|
||||
| G8 | Known limitations have severity/workaround and no P0 blocker remains | Partial | Sample-pack gap `#32`, guarded shutdown/savepoints `#55`, and the follow-on scoped UI action-safety defect `#57` have complete source/native feature acceptance at `d52cc2e`, source implementation `4b33f32`, and `9e23ae7` respectively; no known P0 implementation blocker remains. A consolidated candidate limitations ledger and exact-candidate rerun are still missing. Deterministic imported-asset fingerprints `#56` and property-block application `#53` are P1; dynamic deformed Solari geometry `#54` is a documented P2 limitation with Forward/raster fallback. |
|
||||
|
||||
## Deliverables
|
||||
|
||||
| ID | Deliverable | State | Evidence or next action |
|
||||
|----|-------------|-------|-------------------------|
|
||||
| D1 | Versioned acceptance matrix under `docs/editor/evaluations/` | Pass | This file, version 0.2. |
|
||||
| D2 | Release-candidate representative project and reproducible validation commands | Missing | Expand the committed project/regression pack through `#32`, including terrain and physics-placement samples, then nominate an exact commit. |
|
||||
| D1 | Versioned acceptance matrix under `docs/editor/evaluations/` | Pass | This file, version 0.5. |
|
||||
| D2 | Release-candidate representative project and reproducible validation commands | Partial | The committed [sample regression pack](../sample-regression-pack/), commands, and exact-implementation native evidence exist. Nominate a release candidate and rerun from a clean LFS-hydrated checkout. |
|
||||
| D3 | Signed milestone comment linking evidence, limitations, and exact commit | Missing | Post only after G1-G8 pass; no candidate exists yet. |
|
||||
|
||||
## Workflow Coverage
|
||||
@@ -55,10 +55,13 @@ another commit, a dirty worktree, or an older package do not transfer to the can
|
||||
| Scene save, autosave, recovery | Implemented | Not rerun |
|
||||
| Hierarchy parenting and prefab structure | Implemented | Not rerun |
|
||||
| Multi-scene composition | Implemented | Not rerun |
|
||||
| Five-area editor sample pack | Implemented with manifest, native menu, typed scene gate, and headless validation | Exact-implementation source/native acceptance passed at `d52cc2e`; not rerun as one release candidate |
|
||||
| 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 |
|
||||
| Material catalog and assignment | Renderer/material foundation `#51`, Material Library, and exact targeted drops accepted; optional property-block promotion is `#53` | Not rerun as one candidate |
|
||||
| Rendering volumes and look development | Deterministic visible rendering fixture is in the sample pack | Not rerun as one candidate |
|
||||
| Terrain authoring | `#22`-`#24` source/live acceptance complete; M3 closed | Feature-level live acceptance exists; not rerun as one candidate. Packaged-runtime acceptance owner-deferred. |
|
||||
| Physics placement | `#25` source/live acceptance complete | Feature-level live acceptance exists; not rerun as one candidate. Packaged-runtime acceptance owner-deferred. |
|
||||
| Collider authoring and diagnostics | `#26` source/live acceptance complete | Feature-level live acceptance exists; not rerun as one candidate. Packaged-runtime acceptance owner-deferred. |
|
||||
| Animation | Implemented | Not rerun |
|
||||
| Audio | Implemented | Not rerun |
|
||||
| Navigation | Implemented | Not rerun |
|
||||
@@ -66,6 +69,8 @@ another commit, a dirty worktree, or an older package do not transfer to the can
|
||||
| Build/package/runtime | Implemented foundation | Deferred by owner |
|
||||
| Collaborative file safety | Implemented; `#49` closed with live external-change acceptance | Not rerun as one candidate |
|
||||
| Native file/folder dialogs | Implemented; `#52` closed with live 12-second compositor-responsiveness hold | Not rerun as one candidate |
|
||||
| Guarded shutdown and clean savepoints | Implemented; `#55` source validation and all seven native workflows passed at source implementation `4b33f32` | Feature-level acceptance complete; not rerun as one candidate |
|
||||
| Scoped UI action safety | Implemented; `#57` source validation, six focused regressions, selection precedence, and native toolbar/Inspector/diagnostics workflows passed at `9e23ae7` | Feature-level acceptance complete; not rerun as one candidate |
|
||||
|
||||
## Candidate Validation Commands
|
||||
|
||||
@@ -80,6 +85,7 @@ cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo clippy -p editor -p game --bins --features dev,hot-reload -- -D warnings
|
||||
cargo test --workspace
|
||||
cargo validate-levels --project .
|
||||
cargo validate-samples --project .
|
||||
cargo bake-navigation --project . --check
|
||||
```
|
||||
|
||||
@@ -91,8 +97,9 @@ package hash verification, and packaged-runtime smoke protocol used for the cand
|
||||
The final candidate must run for eight continuous hours against the representative project. The
|
||||
record must sample process RSS, GPU memory, target-directory size, recovery generations, background
|
||||
job counts, and error/warning totals at least every five minutes. Exercise scene switching, save and
|
||||
recovery, asset refresh, material editing, brush/terrain/physics tools, animation/audio/navigation,
|
||||
PIE transitions, and build UI cancellation without replacing the candidate during the run.
|
||||
recovery, asset refresh, all five sample-pack scenes, material editing, brush/terrain/physics tools,
|
||||
animation/audio/navigation, PIE transitions, and build UI cancellation without replacing the
|
||||
candidate during the run.
|
||||
|
||||
A pass requires no unrecoverable editor failure, no lost authored work, no unbounded upward trend in
|
||||
steady-state resource use, bounded recovery/cache behavior, and a triaged explanation for every
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
# Sample Regression Pack Evaluation
|
||||
|
||||
**Date:** 2026-07-13
|
||||
|
||||
**Issue:** [Gitea #32](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/32)
|
||||
|
||||
**Implementation commit:** `d52cc2e3b72c908d192ed9e9f49306c25367599b`
|
||||
|
||||
**Release-candidate commit:** Not nominated
|
||||
|
||||
**Implementation validation:** **Pass**
|
||||
|
||||
**Native visual acceptance:** **Pass**
|
||||
|
||||
This record separates source/fixture verification from release-candidate acceptance. The exact
|
||||
implementation commit above passed the five-area native protocol on a clean tracked worktree. These
|
||||
results do not transfer to a later release-candidate commit.
|
||||
|
||||
## Source Evidence
|
||||
|
||||
| Check | Result | Evidence |
|
||||
|-------|--------|----------|
|
||||
| Manifest contract | Pass | Schema v1 contains one ordered entry for Brush, Material, Terrain, Physics Placement, and Rendering, with stable IDs and nonempty checks. |
|
||||
| Authored scene fixtures | Pass | All five scene paths exist; actors use stable IDs and each scene contains its required authored feature. |
|
||||
| Project validation | Pass | `cargo validate-levels --project .` reported 81 dependencies, five known nonblocking import/platform findings, and zero blocking errors on 2026-07-13. |
|
||||
| Typed no-GPU deserialization | Pass | `cargo test -p editor every_manifest_sample_typed_deserializes_without_a_gpu --lib`: one passed, zero failed, 257 filtered out. |
|
||||
| Sample-pack validation | Pass | `cargo validate-samples --project .`: five ordered samples, 86 dependencies, five known nonblocking findings, zero blocking errors. |
|
||||
| Clean-checkout CI | Pending | The exact candidate must hydrate LFS and pass both content gates. Current Gitea does not expose an Actions run endpoint for this repository. |
|
||||
|
||||
## Native Protocol
|
||||
|
||||
Open every row through **File > Open Sample**, not through a typed filesystem path. Capture native
|
||||
screenshots only after confirming the viewport is nonblank and correctly framed.
|
||||
|
||||
| Sample | Required native interaction and visual result | Result |
|
||||
|--------|-----------------------------------------------|--------|
|
||||
| Brush Blockout | Foundation, material-face tower, and red subtractive marker are distinct; enter brush edit and cancel one edit or clip preview without leaving helpers | Pass - selected one tower face in Brush Clip, observed the magenta preview, then canceled with no history or helper leak. |
|
||||
| Material Lab | Concrete cube, custom sphere, instance block, and emissive panel are visible; perform one exact primitive material drop and undo | Pass - dropped `surface_tint_instance` on `Concrete Reference / Surface`; one history entry was created and Ctrl+Z restored the exact prior material. |
|
||||
| Terrain Authoring | Hill chunks and two material layers render; perform and cancel one sculpt stroke and one paint stroke | Pass - Concrete/Surface Tint rendered visibly under active Solari through the forward raster boundary; both stroke cancels restored data and left history clean. |
|
||||
| Physics Placement | Cuboid, sphere, and capsule settle on the floor; cancel restores all three, then commit/undo behaves as one transaction | Pass - three props settled in 2.3 seconds; cancel restored the airborne transforms, and the second run committed one `Move Selection` entry that Ctrl+Z restored. |
|
||||
| Rendering Lab | Red/cyan/amber anchors and emissive strip render; camera traversal visibly changes vignette, fog, and exposure ownership | Pass - HUD ownership reached Foggy courtyard 73%/2 overrides, Cave mouth 100%/2 overrides, and Vignette demo 68% with the expected visible changes. |
|
||||
|
||||
For each row, inspect the status strip, Diagnostics panel, and process log for missing references,
|
||||
hydration errors, render errors, helper leaks, or operator failures. Attach native images to the Gitea
|
||||
issue as ordinary uploaded attachments rather than embedding repository raw URLs. A committed
|
||||
original may remain beside this record through Git LFS under the shared evaluation policy.
|
||||
|
||||
## Native Environment And Artifacts
|
||||
|
||||
- Arch Linux `7.1.3-arch1-1`, Hyprland `0.55.4`, native Wayland.
|
||||
- NVIDIA GeForce RTX 3080 Ti, driver `610.43.03`.
|
||||
- Bevy `0.19.0`; the viewport reported the effective `Solari` path throughout the pass.
|
||||
- Exact binary: `target/debug/editor --project .`, built from the implementation commit above.
|
||||
- Process log: no warnings or errors across all five menu opens and interactions.
|
||||
- [Gitea issue comment #1057](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/32#issuecomment-1057)
|
||||
embeds full-resolution 3426x1384 PNG uploads, not repository/LFS raw links:
|
||||
`blacksite-brush-d52cc2e.png`
|
||||
(`sha256:3853bb51a70320b95af2cc48a1609251defc22705fb5f27fd3b1ab434f71877f`),
|
||||
`blacksite-terrain-solari-d52cc2e.png`
|
||||
(`sha256:8ee4e5d5c40436a5719fbec34deaef10f5bcb79748b052268781c29468e1ef7b`), and
|
||||
`blacksite-rendering-vignette-d52cc2e.png`
|
||||
(`sha256:67a09743f86439adf98ad2cf9b9d91041f89954aea2b8f29c29bbf10ead8c000`).
|
||||
|
||||
## Release Use
|
||||
|
||||
A future candidate may mark this evaluation fully passed only when the exact nominated commit has:
|
||||
|
||||
1. Passed typed scene deserialization, `validate-levels`, and `validate-samples` from a clean,
|
||||
LFS-hydrated checkout.
|
||||
2. Opened all five entries through the native menu and completed the interactions above.
|
||||
3. Recorded the commit, machine profile, commands, exit codes, logs, and native attachments.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Scoped UI Action Safety Evaluation
|
||||
|
||||
**Date:** 2026-07-13
|
||||
|
||||
**Issue:** [Gitea #57](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/57)
|
||||
|
||||
**Implementation commit:** `9e23ae731f95dc351ecc744d6ca61f6bc4467317`
|
||||
|
||||
**Release-candidate commit:** Not nominated
|
||||
|
||||
**Source validation:** **Pass**
|
||||
|
||||
**Native acceptance:** **Pass**
|
||||
|
||||
This record covers synchronous editor actions invoked while the egui host scopes `UiState` out of
|
||||
the Bevy `World`. The implementation keeps callback-owned state in independently registered
|
||||
resources, passes viewport data into toolbar/navigation actions, routes cross-panel selection and
|
||||
tab requests through explicit APIs, and reconciles the complete selection slice so a direct UI
|
||||
selection takes precedence over a stale deferred request.
|
||||
|
||||
## Automated Verification
|
||||
|
||||
| Command or suite | Result | Evidence |
|
||||
|------------------|--------|----------|
|
||||
| `cargo fmt --all -- --check` | Pass | Formatting check completed without changes. |
|
||||
| `git diff --check` | Pass | No whitespace errors. |
|
||||
| `cargo clippy --workspace --all-targets -- -D warnings` | Pass | Workspace and all targets completed with warnings denied. |
|
||||
| `cargo test --workspace --all-targets --no-fail-fast` | Pass | All workspace targets passed; the editor crate reported 290 of 290 tests passing. |
|
||||
| Scoped-action regressions | Pass | Six focused regressions cover history multi-selection, diagnostics selection, Inspector collapse and asset reveal state, primitive spawn, and navigation spawn while `UiState` is scoped out. |
|
||||
| Selection precedence | Pass | Full-slice reconciliation preserves a direct primary or secondary UI selection over stale single- or multi-selection requests. |
|
||||
| Independent re-review | Pass | The post-fix review found no remaining blockers. |
|
||||
| Packaged acceptance | Deferred | Explicitly deferred by project-owner direction; no packaged result is claimed. |
|
||||
|
||||
## Native Acceptance
|
||||
|
||||
The exact rebuilt debug binary from the implementation commit was launched as
|
||||
`target/debug/editor --project .`.
|
||||
|
||||
| Workflow | Result | Evidence |
|
||||
|----------|--------|----------|
|
||||
| Toolbar authoring actions | Pass | After **File > New Scene**, Cube, Ramp, Sphere, Point Light, and Navigation Bounds all spawned. Selection, transform gizmo, viewport overlay, hierarchy, and Inspector stayed synchronized. |
|
||||
| Inspector state | Pass | Collapsing the Transform component persisted across subsequent UI rendering and selection work. |
|
||||
| Cross-panel diagnostics action | Pass | **Window > Brush Diagnostics > Select** kept the editor live and synchronized the selected actor across hierarchy, viewport, and Inspector. |
|
||||
| Guarded shutdown | Pass | The dirty native-close decision accepted **Discard** and the editor exited with code 0. |
|
||||
|
||||
## Native Evidence
|
||||
|
||||

|
||||
|
||||
- Gitea attachment asset 37: `blacksite-issue57-scoped-ui-actions.png`, 3426x1384 RGB PNG,
|
||||
890,021 bytes.
|
||||
- SHA-256: `4225aca19268e4817148507e95cdad56a5f18734fd69e2fe5702df1dc304142e`.
|
||||
|
||||

|
||||
|
||||
- Gitea attachment asset 38: `blacksite-issue57-diagnostics-select.png`, 3426x1384 RGB PNG,
|
||||
1,418,849 bytes.
|
||||
- SHA-256: `40422be59766a3e61005973c315d0fd6f663dd2d227aa92055fa2aa2e91320c3`.
|
||||
|
||||
Both images were uploaded as ordinary Gitea issue attachments; this record does not use repository
|
||||
raw or LFS pointer URLs.
|
||||
|
||||
## Release Use
|
||||
|
||||
The #57 source and native feature-level acceptance record is complete. A future production candidate
|
||||
must still rerun representative toolbar, Inspector, diagnostics, selection, and guarded-exit paths
|
||||
from the exact nominated commit. This record does not nominate a candidate or establish production
|
||||
readiness.
|
||||
@@ -0,0 +1,36 @@
|
||||
# Terrain Material Layers Acceptance
|
||||
|
||||
## Evidence
|
||||
|
||||

|
||||
|
||||
The native Wayland editor is shown with the deterministic terrain showcase selected, two shared
|
||||
material layers visible in the Inspector, Paint active in the existing horizontal viewport toolbar,
|
||||
and the cyan terrain-following brush footprint over the blended PBR surface.
|
||||
|
||||
## Live Acceptance
|
||||
|
||||
- `Concrete` and `Surface Tint` blend continuously across all four generated chunks.
|
||||
- Layer assignment, clear, reorder, remove, UV tiling, and per-layer sample coverage are visible in
|
||||
the Terrain card without nesting a second panel.
|
||||
- Paint and Erase share the existing horizontal toolbar with layer, radius, and strength controls.
|
||||
- A Paint drag changed layer-two coverage from 13/25 to 16/25 samples and produced exactly one
|
||||
`Undo: Paint Terrain Material` history entry.
|
||||
- Ctrl+Z restored 13/25 samples; Ctrl+Y restored 16/25 samples.
|
||||
- The cyan footprint followed the actual sampled terrain surface and the transform gizmo remained
|
||||
absent while Paint owned viewport input.
|
||||
- Forward PBR and the project `blacksite_surface` terrain extension compiled without GPU pipeline
|
||||
errors. The invalid deferred-only prepass override found during QA was removed from both project
|
||||
material extensions.
|
||||
|
||||
## Automated Coverage
|
||||
|
||||
- Terrain layer/weight RON round-trip and structural validation.
|
||||
- RGBA8 normalization rejection and normalized vertex-color transport.
|
||||
- Paint/Erase normalization and brush-footprint isolation.
|
||||
- Multi-dab single-transaction undo/redo.
|
||||
- Exact restoration of an implicit pre-stroke weight map on cancel.
|
||||
|
||||
Packaged build tests remain intentionally skipped per current project direction. Source workspace
|
||||
format/check/clippy/tests, project validation, navigation bake validation, and diff hygiene are the
|
||||
required gate for this ticket.
|
||||
Binary file not shown.
@@ -0,0 +1,31 @@
|
||||
# Terrain Sculpt Tools Acceptance
|
||||
|
||||
Issue: Gitea `#23`
|
||||
|
||||
Scope: native Wayland debug editor; packaged acceptance remains deferred by project-owner direction.
|
||||
|
||||
## Live Evidence
|
||||
|
||||

|
||||
|
||||
The committed terrain showcase was selected in Forward rendering. Enabling the mountains tool kept
|
||||
the actor selected, removed the transform gizmo, expanded Raise/Lower/Flatten/Smooth/Noise plus
|
||||
radius/strength controls inside the existing horizontal viewport toolbar, and displayed the modal
|
||||
cancel/undo hints. A dragged Raise stroke visibly changed the generated terrain while the footprint
|
||||
tracked the sampled surface. Release produced exactly `Undo: Raise Terrain`; no transform `Move`
|
||||
history entry was created.
|
||||
|
||||
Escape/right-click restoration, deterministic brush math, exact vertical-ray sampling, multi-dab
|
||||
stroke grouping, and sculpt-time gizmo exclusion are covered by focused tests. The live pass also
|
||||
exposed and corrected toolbar click-through into raw mesh picking before this evidence was captured.
|
||||
|
||||
## Source Verification
|
||||
|
||||
- `cargo fmt --all -- --check`
|
||||
- `cargo check -p editor --all-targets`
|
||||
- `cargo clippy -p editor --all-targets -- -D warnings`
|
||||
- six focused terrain-sculpt/input-ownership tests
|
||||
- `git diff --check`
|
||||
|
||||
The canonical fixture remains `assets/levels/terrain_authoring_showcase.scn.ron`; no QA-only scene or
|
||||
project setting is retained.
|
||||
Binary file not shown.
@@ -13,12 +13,17 @@ and [ADR 0036](../adr/0036-surface-abi-and-solari-parity.md).
|
||||
| Material instance | Overrides over one direct base material | Yes, under `assets/materials/` |
|
||||
| Renderer material slot | A stable reference on one static or skinned renderer | Yes, in scenes/prefabs |
|
||||
| Imported source material | Read-only default supplied by model import | Yes, as the slot fallback |
|
||||
| Material property block | Temporary per-renderer/per-slot runtime overrides | No |
|
||||
| Material property block | Reserved runtime-only per-renderer/per-slot override schema; application/promotion tracked by Gitea #53 | No |
|
||||
|
||||
A renderer slot stores a `MaterialRef`, not a copy of the material. The registry UUID and subasset
|
||||
ID identify the target; the cached path is only a loading hint. A material instance may reference a
|
||||
material, but may not reference another instance.
|
||||
|
||||
`MaterialPropertyBlocks` are excluded from authored persistence, but they are not yet consumed by
|
||||
renderer binding. Runtime application and the transactional **Promote to Material Instance**
|
||||
workflow are tracked by Gitea #53. Use an ordinary direct-base Material Instance for reusable
|
||||
variations until that issue closes.
|
||||
|
||||
## Assign materials
|
||||
|
||||
Open **Window > Material Library** for the cross-folder Material/Material Instance catalog. It
|
||||
@@ -88,6 +93,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
|
||||
@@ -125,7 +135,8 @@ The standard material path remains unchanged for materials without a custom eval
|
||||
Skinned meshes and morph-deformed meshes are currently excluded from Solari. This prevents rays
|
||||
from tracing their undeformed source/bind pose while raster shows the animated pose. They remain
|
||||
visible in raster, and Rendering diagnostics report the deformed exclusion. Dynamic deformed
|
||||
vertex/BLAS updates are future work.
|
||||
vertex/BLAS updates are tracked independently by Gitea #54 with animation, ray-hit, fallback,
|
||||
memory, and update-cost acceptance.
|
||||
|
||||
Surface ABI v1 does not support blended transparency, transmission/refraction, custom vertex
|
||||
displacement, or arbitrary pipeline stages.
|
||||
|
||||
@@ -6,6 +6,11 @@ save/discard/cancel prompt when needed. **File > Open Scene...** opens another t
|
||||
discarding the active document. Save and Save As affect the active tab, while project switching
|
||||
offers to save every modified tab.
|
||||
|
||||
Each tab also retains a canonical checkpoint of the last successfully loaded or saved authored
|
||||
projection. History commands remain active-tab runtime state, but undo and redo reconcile against
|
||||
that document checkpoint. Returning exactly to the checkpoint clears only that tab's dirty marker;
|
||||
redo, a divergent edit, failed save, or restored recovery remains dirty.
|
||||
|
||||
## Composition workflow
|
||||
|
||||
The **Composition** menu beside the tabs edits the active scene's persisted `SceneComposition`:
|
||||
|
||||
@@ -16,6 +16,13 @@ loop or editor rendering.
|
||||
- Collaborative Save As performs the same revision and destination checks after selection.
|
||||
- Close or project switch never treats an opened Save As picker as a completed save. When a save
|
||||
remains pending, the transition pauses and can be retried after saving.
|
||||
- Native window close, **File > Quit**, project switch, and programmatic editor exit share the
|
||||
guarded-shutdown coordinator. Dirty scene tabs present exact **Save All**, **Discard**, and
|
||||
**Cancel** actions. Save All remains pending through each untitled tab's Save As result and exits
|
||||
only after every dirty tab is clean; cancellation or failure preserves the live session.
|
||||
- A close request received while another native dialog owns the broker remains queued. The editor
|
||||
rechecks dirty state and retries acquisition after that workflow completes instead of dropping
|
||||
the request or opening a competing dialog.
|
||||
|
||||
## Covered Surfaces
|
||||
|
||||
@@ -24,6 +31,8 @@ subscene selection, collaborative conflict copies, Project Browser folder select
|
||||
confirmations. New workflows must use the broker instead of calling `rfd` from an egui/Bevy system.
|
||||
|
||||
See [ADR 0038](../adr/0038-non-blocking-native-dialog-broker.md).
|
||||
Guarded exit ownership and document savepoints are defined by
|
||||
[ADR 0042](../adr/0042-guarded-editor-shutdown-and-document-savepoints.md).
|
||||
|
||||
Live native-Wayland acceptance is recorded in the
|
||||
[native-dialog responsiveness evaluation](evaluations/native-dialog-responsiveness/).
|
||||
@@ -11,11 +11,13 @@ Every production operator test must cover the paths it exposes:
|
||||
|
||||
| Path | Required proof |
|
||||
|------|----------------|
|
||||
| Commit | Expected authored entity delta, exact undo-group delta, dirty state, committed phase |
|
||||
| Cancel or commit failure | No authored entity delta, no new history, prior dirty state, canceled phase |
|
||||
| Commit | Expected authored projection, exact undo-group delta, dirty state, stable operator ID, committed phase |
|
||||
| Zero-history commit | Authored projection and prior dirty state remain unchanged |
|
||||
| Cancel or commit failure | Exact authored projection restored, no new history, prior dirty state, stable operator ID, terminal canceled/blocked phase |
|
||||
| Blocked start | Commit closure never runs; authored state, history, and dirty state are unchanged |
|
||||
| Preview failure | Cancel finalizer runs, authored state is restored, and helpers are removed |
|
||||
| Preview helpers | No helper component remains after commit or cancel |
|
||||
| Undoable commit | `assert_undo_redo_round_trip` restores both initial and committed projections |
|
||||
| Undoable commit | `assert_undo_redo_round_trip` restores both initial and committed semantic projections |
|
||||
| Continuous edit | The entire interaction creates one history command, not one per frame or target |
|
||||
|
||||
The harness intentionally fails with the invariant name in the assertion message. Tests may add
|
||||
@@ -26,12 +28,12 @@ domain assertions, but should not replace these shared lifecycle checks.
|
||||
1. Build a minimal `World` with `ActiveOperator`, `EditorHistory`, and `SceneIo`. Add tool-specific
|
||||
selection/resources and `SelectedEntity` when history helpers update selection.
|
||||
2. Capture `OperatorInvariantHarness` immediately before starting the operation.
|
||||
3. Run the real operator entry point or the same production commit/cancel function used by its
|
||||
input system.
|
||||
3. Run the real dispatch path or production finalizer used by the input system. Do not duplicate its
|
||||
state transition in the test.
|
||||
4. Call `assert_committed`, `assert_canceled`, or `assert_blocked` with the expected authored and
|
||||
undo deltas.
|
||||
undo deltas, then `assert_status` with the stable operator ID and terminal phase.
|
||||
5. For helpers, call `assert_no_helpers::<ToolHelper>`. For undoable work, project the meaningful
|
||||
state through `assert_undo_redo_round_trip`.
|
||||
state through `assert_undo_redo_round_trip`; use `assert_projection_unchanged` for no-op paths.
|
||||
|
||||
Do not satisfy a lifecycle test by constructing an `EditorCommand` and checking only its label.
|
||||
The test must mutate a world and prove restoration.
|
||||
@@ -40,15 +42,17 @@ The test must mutate a world and prove restoration.
|
||||
|
||||
| Workflow | Coverage |
|
||||
|----------|----------|
|
||||
| Generic `EditorOperator` | Commit cleanup, commit failure rollback, blocked no-op |
|
||||
| Asset placement | Commit, dirty state, single undo, authored spawn round trip |
|
||||
| Sub-asset placement | Missing dependency commit failure leaves no side effects |
|
||||
| Texture/material assignment | Multi-actor grouped undo; missing material failure; empty-selection block |
|
||||
| Draw Brush | Full modal-state cancel; decomposed multi-brush grouped commit and round trip |
|
||||
| Brush CSG | Pending-preview cancel; merge commit/deletion grouped round trip |
|
||||
| Brush clip and element gizmo | Clip grouped geometry round trip; Escape rollback and helper cleanup |
|
||||
| Transform gizmo finalization | Multi-target continuous edit grouped into one undo command |
|
||||
| Generic `EditorOperator` | Commit cleanup, preview/commit failure rollback, blocked no-op, terminal ID/phase |
|
||||
| Palette and registered commands | Typed immediate commit versus modal preview ownership; Enter/click/Escape dismissal cannot be overwritten by stale window state; failed CSG start terminates |
|
||||
| Selection and scene commands | Atomic Group Selection across repeated undo/redo; spawned group actors have an immediate Bevy visibility hierarchy; grouped Reset Lighting and Project Sun history |
|
||||
| Asset workflows | Asset/sub-asset placement; material/texture group assignment; audio/animation assignment and incompatible targets |
|
||||
| Viewport material drop | Exact renderer slot/primitive/brush-face preview, cancel, commit, cleanup, undo, and redo |
|
||||
| Draw Brush and CSG | Modal cancel; decomposed commit; CSG validation/read-only block, cancel, grouped commit, and deleted-brush restoration |
|
||||
| Brush clip and element gizmo | Production finalizers, geometry round trip, Escape rollback, and helper cleanup |
|
||||
| Terrain sculpt and paint | Multi-dab grouped commit, no-op release, commit failure rollback, cancel, clean-view interruption, and resource cleanup |
|
||||
| Physics placement | Prerequisite block, no-op commit, exact cancel, real settle commit, multi-selection grouping, helper cleanup, undo, and redo |
|
||||
| Transform gizmo finalization | Actual tracker finalizer, continuous multi-target grouping, no-op release, and missing-primary survivor rollback |
|
||||
|
||||
Terrain strokes and physics-settle sessions are roadmap tools, not current production operators.
|
||||
Their implementation tickets must add harness fixtures before those tools can pass their own exit
|
||||
gates; Gitea issue BS-JD-502 remains the umbrella until that coverage exists.
|
||||
The shared harness covers formal operators and multi-frame modal paths. Atomic inspector and history
|
||||
mutations that do not own `ActiveOperator` use focused typed history tests with equivalent semantic
|
||||
projection and undo/redo assertions.
|
||||
@@ -0,0 +1,39 @@
|
||||
# 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. It consumes the shared
|
||||
[collider health service](collider-authoring.md), so the viewport, inspector, Diagnostics panel,
|
||||
and placement status agree about missing, invalid, stale, disabled, or trigger collision. 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 Physics Placement entry in the committed
|
||||
[sample regression pack](sample-regression-pack.md). Select **Placement Cuboid**, **Placement
|
||||
Sphere**, and **Placement Capsule** together, start physics placement, and verify that the three
|
||||
distinct collider cases 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).
|
||||
@@ -89,7 +89,10 @@ Shipped examples: `post_fx/vignette.ron`, `post_fx/chromatic_aberration.ron`, `r
|
||||
|
||||
## Example level
|
||||
|
||||
Open `assets/levels/rendering_showcase.scn.ron` for fog, exposure, and vignette volume examples.
|
||||
Open **File > Open Sample > Rendering Lab** for the committed rendering fixture. Its red sphere,
|
||||
cyan cube, amber block, and emissive horizon make the adjacent vignette, fog, and dark-exposure zones
|
||||
visually comparable while the volume actors exercise stable ownership, profile, and fullscreen-effect
|
||||
references. See the [sample regression pack](sample-regression-pack.md) for the native QA protocol.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -57,6 +57,8 @@ 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 |
|
||||
| Collider authoring diagnostics | Done | World-scale shape overlays, semantic health colors, stale/missing/invalid/oversized findings, undoable shape switching, and shared placement preflight |
|
||||
|
||||
## Phase 2b — Advanced rendering
|
||||
|
||||
@@ -122,6 +124,7 @@ Phased work for the in-process editor (`crates/editor`). Status reflects the cur
|
||||
| Thumbnails | Done | Textures via asset load; glTF albedo fast-path; FBX/untextured models via offscreen studio |
|
||||
| Import settings per asset | Done | Scale/collider/LOD in registry + details pane |
|
||||
| Prefab workflow | Done | Shared stable nested property/component/structural overrides, recursive validation, committed variant fixtures, transactional source Apply, conflict recovery, and undoable outer unpack/recursive local conversion passed headless, packaged-runtime, and live editor acceptance in Gitea #43 |
|
||||
| Curated editor regression samples | Done | Versioned five-area manifest, dedicated brush/material labs, strengthened terrain/physics/rendering fixtures, **File > Open Sample**, typed scene coverage, and `validate-samples` release gate in Gitea #32 |
|
||||
|
||||
## Phase 6 — Extensibility
|
||||
|
||||
@@ -132,6 +135,7 @@ Phased work for the in-process editor (`crates/editor`). Status reflects the cur
|
||||
| `ActorInspectorSection` registry | Done | `ext/extensibility.rs` + `game_inspector.rs` |
|
||||
| Command registry | Done | Play, lighting reset, group, focus |
|
||||
| Command palette (Ctrl+P) | Done | Executes registered commands |
|
||||
| Typed operator dispatch and mutation invariants | Done | Immediate commands commit, modal commands retain Preview ownership, and production asset/brush/terrain/physics/history paths pass the shared lifecycle and undo contract ([testing guide](operator-regression-testing.md), [Gitea #33](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/33)) |
|
||||
| `EditorPlugin` trait | Done | `register_editor_plugin`; dogfood panel from `game::editor_ext` |
|
||||
| Undo: `SetActorKind`, add/remove component | Done | `SetActorKind` + `AddComponent` / `RemoveComponent` |
|
||||
| BRP authoring-only policy | Done | [brp.md](brp.md) |
|
||||
@@ -147,7 +151,7 @@ with implementation sequencing in
|
||||
| Milestone | Exit condition | Status |
|
||||
|-----------|----------------|--------|
|
||||
| M6 Reliability, recovery, and project workflow | Transactional save/recovery, stable sessions, project launcher, hardened hierarchy/prefabs, multi-scene composition | Implementation complete; all six scoped issues are closed after prefab #43 passed workspace, headless, packaged-runtime, and live editor acceptance |
|
||||
| M7 Content production and shipping | Build/package profiles, content release gate, animation, audio, navigation, collaborative safety | Active; #44-#48 are complete. #49 implementation and source/headless acceptance are complete, with live visual acceptance pending; final readiness gate #50 remains. Packaged acceptance is deferred until requested by the project owner. |
|
||||
| M7 Content production and shipping | Build/package profiles, content release gate, animation, audio, navigation, collaborative safety | Active; #44-#49 are complete after source, headless, and native acceptance. P0 #55 is complete at source implementation `4b33f32`, and follow-on P0 #57 scoped UI action safety is complete at `9e23ae7` after workspace, focused, independent-review, and native acceptance. No known P0 implementation blocker remains, but #50 is still the final candidate gate and production readiness is not established. Deterministic imported-asset fingerprints #56 are P1 follow-up work. Packaged acceptance is deferred until requested by the project owner. |
|
||||
|
||||
Production readiness is not inferred from feature count. Gitea
|
||||
[`#50`](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/50)
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
# Editor Sample Regression Pack
|
||||
|
||||
The editor sample regression pack is the committed, deterministic first stop for content and native
|
||||
viewport QA. Its source of truth is `assets/samples/editor_samples.ron`; manifest order is also the
|
||||
order shown by **File > Open Sample** and by headless reports.
|
||||
|
||||
## Open And Exercise A Sample
|
||||
|
||||
1. Open **File > Open Sample** and choose the relevant area.
|
||||
2. Confirm the scene opens in a normal scene tab and the viewport contains the expected anchors.
|
||||
3. Perform the checks listed in the manifest and the table below.
|
||||
4. Watch the status strip and Diagnostics panel for missing references, hydration failures, or
|
||||
operator errors.
|
||||
5. Use **Save As** before destructive experimentation. The committed samples are regular project
|
||||
scenes, not disposable or read-only copies.
|
||||
|
||||
An invalid or unavailable manifest leaves an actionable disabled item in the menu. It must not
|
||||
silently fall back to another scene.
|
||||
|
||||
## Pack Contents
|
||||
|
||||
| Area | Scene and visual composition | Representative checks |
|
||||
|------|------------------------------|-----------------------|
|
||||
| Brush | `brush_blockout.scn.ron`: broad concrete foundation, tall additive brush with a contrasting shared-material top face, red rotated subtractive marker | Select object and face targets; enter brush edit; exercise draw/clip/CSG preview and cancel; verify shared face material resolution |
|
||||
| Material | `material_lab.scn.ron`: neutral floor, concrete cube, blue custom-surface sphere, rotated Material Instance block, cyan emissive backdrop | Inspect shared Material/Instance paths; target a primitive with a Material drop; compare standard, custom, and emissive hydration |
|
||||
| Terrain | `terrain_authoring_showcase.scn.ron`: asymmetric 5x5 hill, four deterministic chunks, two painted shared-material layers | Sculpt and paint preview/cancel; inspect normalized weights and layer refs; verify generated selection and collider state |
|
||||
| Physics Placement | `physics_placement_showcase.scn.ron`: cuboid, sphere, and tall capsule above a static floor | Multi-select all three props; settle; cancel and compare exact starting transforms; repeat, commit, undo, and redo as one group |
|
||||
| Rendering | `rendering_showcase.scn.ron`: red sphere, cyan cube, amber block, emissive horizon, and three adjacent vignette/fog/exposure volumes | Move the camera through all zones; inspect active-volume ownership; verify profile/fullscreen-effect refs and visible transitions |
|
||||
|
||||
All authored sample actors have stable `ActorId` values. Generated hydration children are deliberately
|
||||
absent from the committed scene documents.
|
||||
|
||||
## Headless Validation
|
||||
|
||||
Run both gates from the project root with Git LFS content hydrated:
|
||||
|
||||
```bash
|
||||
cargo validate-levels --project .
|
||||
cargo validate-samples --project .
|
||||
```
|
||||
|
||||
`validate-levels` remains the authoritative project dependency/finding report. `validate-samples`
|
||||
adds the pack contract: schema and safe paths, exactly one entry per required area, stable actor IDs,
|
||||
authoring-only scene data, required area components, and nonempty operator checks. Either command
|
||||
must exit nonzero on a blocking finding. Use `--json` when attaching machine-readable evidence.
|
||||
|
||||
## Maintenance Contract
|
||||
|
||||
- Keep exactly the five areas `Brush`, `Material`, `Terrain`, `PhysicsPlacement`, and `Rendering`.
|
||||
- Treat manifest IDs as persistent automation keys; rename labels instead of IDs.
|
||||
- Keep scene paths project-relative, inside `assets/levels/`, and free of symlink or traversal escapes.
|
||||
- When a sample changes, update its manifest summary/checks and this visual-composition table in the
|
||||
same change.
|
||||
- Run the typed no-GPU scene test plus both validation commands before native QA.
|
||||
- Record exact-commit native results under
|
||||
[evaluations/sample-regression-pack/](evaluations/sample-regression-pack/). Implementation checks
|
||||
from a dirty worktree do not satisfy release-candidate acceptance.
|
||||
@@ -13,10 +13,14 @@ or credentials.
|
||||
|
||||
## Restart behavior
|
||||
|
||||
- **Clean shutdown:** the last authored scene and non-destructive UI state are restored.
|
||||
- **Clean shutdown:** after the guarded exit path saves all dirty scene tabs or receives explicit
|
||||
Discard confirmation, the last authored scene and non-destructive UI state are restored.
|
||||
- **Abnormal shutdown:** the editor opens its normal safe scene and displays **Recover Editor
|
||||
Session**. **Resume Last Scene** opens only the previous authored scene. **Continue Safe** keeps
|
||||
the startup scene. Modal tools and dirty preview state are never restored.
|
||||
- Native window close, **File > Quit**, project switching, and programmatic editor exit use one
|
||||
non-blocking Save All / Discard / Cancel workflow. Cancel and failed saves keep the session open.
|
||||
Direct `AppExit`, process kill, and crashes are not recorded as clean shutdowns.
|
||||
- Dirty scene data remains governed by the independent scene recovery workflow in
|
||||
[ADR 0023](../adr/0023-transactional-scene-persistence-and-recovery.md).
|
||||
|
||||
|
||||
Loaded 100 of 103 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user