Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7e99243a78 | ||
|
|
cbd380a941 | ||
|
|
e1b2f86a49 | ||
|
|
a048233fce | ||
|
|
9e23ae731f | ||
|
|
4b33f32357 |
No files matched your search
@@ -0,0 +1,38 @@
|
||||
# Deterministic Imported-Asset Fingerprints
|
||||
|
||||
**Status:** Complete at `cbd380a9413411667a83f74b66c5a2feda5e1af7`; see
|
||||
[`docs/editor/evaluations/deterministic-asset-fingerprints/`](../../docs/editor/evaluations/deterministic-asset-fingerprints/).
|
||||
|
||||
## Scope
|
||||
|
||||
Implement Gitea #56 so imported-source identity is content-addressed and editor/validator runs do
|
||||
not rewrite project artifacts because checkout timestamps or serialization whitespace changed.
|
||||
|
||||
## Contract
|
||||
|
||||
- Persist one shared fingerprint for imported model, texture, and audio sources: byte length plus a
|
||||
BLAKE3 digest of the exact source bytes.
|
||||
- Do not persist or compare source mtimes as semantic identity. Legacy timestamp fields remain
|
||||
readable but are ignored.
|
||||
- Static-mesh and animation manifests use the same content identity as the asset registry.
|
||||
- Preserve stable registry UUIDs across metadata-only drift and uniquely identifiable source moves.
|
||||
- Before writing a registry or generated manifest, compare the parsed semantic document; preserve
|
||||
the existing bytes when the result is equivalent.
|
||||
- Project validators stay read-only and validate both length and digest, including same-size edits.
|
||||
|
||||
## Implementation
|
||||
|
||||
1. Add the shared fingerprint type and migrate animation/static-mesh contracts.
|
||||
2. Persist fingerprints for model, texture, and audio registry records and generalize move recovery.
|
||||
3. Make registry and manifest publication semantic and byte-preserving.
|
||||
4. Extend static-mesh and registry validation plus focused migration/read-only tests.
|
||||
5. Update ADRs, asset-pipeline docs, CI clean-worktree assertion, and committed generated artifacts.
|
||||
|
||||
## Verification
|
||||
|
||||
- Focused editor and scene tests for mtime-only drift, same-size changes, legacy manifests,
|
||||
byte-preserving equivalent refresh, imported source kinds, and read-only validation.
|
||||
- Formatting, diff check, clippy, and workspace all-target tests.
|
||||
- Native editor startup and asset refresh with before/after Git status and source timestamp drift.
|
||||
- `cargo validate-levels --project .` and `cargo validate-samples --project .`, followed by a clean
|
||||
worktree assertion. Packaged-runtime tests remain deferred by owner direction.
|
||||
@@ -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.
|
||||
@@ -63,6 +63,11 @@ jobs:
|
||||
- name: Validate editor sample pack
|
||||
run: cargo validate-samples
|
||||
|
||||
- name: Assert validation leaves checkout clean
|
||||
run: |
|
||||
git diff --exit-code
|
||||
test -z "$(git ls-files --others --exclude-standard)"
|
||||
|
||||
- name: Clippy launch feature matrix
|
||||
run: cargo clippy -p editor -p game --bins --features dev,hot-reload -- -D warnings
|
||||
|
||||
|
||||
@@ -57,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)
|
||||
|
||||
@@ -136,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 |
|
||||
@@ -165,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, **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 |
|
||||
| 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 |
|
||||
@@ -375,6 +377,7 @@ The `.vscode/` folder is preconfigured:
|
||||
- [ADR 0017: Normalized Static Mesh Assets](docs/adr/0017-normalized-static-mesh-assets.md)
|
||||
- [ADR 0034: Registry-driven Authoring Components](docs/adr/0034-registry-driven-authoring-components.md)
|
||||
- [ADR 0037: Collaborative Authored-File Safety](docs/adr/0037-collaborative-authored-file-safety.md)
|
||||
- [ADR 0043: Content-Addressed Import Fingerprints](docs/adr/0043-content-addressed-import-fingerprints.md)
|
||||
|
||||
## Project Layout
|
||||
|
||||
@@ -410,6 +413,8 @@ crates/
|
||||
- [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
|
||||
@@ -424,6 +429,9 @@ crates/
|
||||
- [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] Deterministic imported-source fingerprints for models, textures, and audio; BLAKE3-backed
|
||||
static/animation manifests; byte-preserving equivalent refresh; and read-only validator checkout
|
||||
assertions ([ADR 0043](docs/adr/0043-content-addressed-import-fingerprints.md), [evaluation](docs/editor/evaluations/deterministic-asset-fingerprints/), [Gitea #56](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/56))
|
||||
- [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
|
||||
- [x] Audio clip catalog/import foundation for Ogg, WAV, MP3, and FLAC with dedicated filtering, file details, and stable runtime-resolvable asset references
|
||||
- [x] Audio source/listener authoring, non-dirty spatial audition, viewport icons/range gizmos, stable buses, PIE/runtime parity, device diagnostics, and shared release validation ([ADR 0030](docs/adr/0030-audio-authoring-and-bus-schema.md); production acceptance completed in [Gitea #47](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/47))
|
||||
|
||||
+526
-494
File diff suppressed because it is too large.
Load diff
@@ -1,5 +1,5 @@
|
||||
(
|
||||
schema_version: 3,
|
||||
schema_version: 4,
|
||||
asset_id: "113f74df-e39c-41d4-9b5b-e48efe541f7f",
|
||||
label: "RobotExpressive",
|
||||
source: (
|
||||
@@ -7,7 +7,7 @@
|
||||
format: "glb",
|
||||
fingerprint: (
|
||||
byte_len: 463988,
|
||||
modified_unix_secs: 1783799272,
|
||||
content_hash: "5869cb813e6a6093eda7af2824a9c13a582750e0443e88ce7c991a1f83415521",
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
(
|
||||
schema_version: 3,
|
||||
schema_version: 4,
|
||||
asset_id: "3f63f359-45eb-4cb2-8970-71921cbd7bd0",
|
||||
label: "robot_expressive",
|
||||
source: (
|
||||
@@ -7,7 +7,7 @@
|
||||
format: "glb",
|
||||
fingerprint: (
|
||||
byte_len: 463988,
|
||||
modified_unix_secs: 1783750957,
|
||||
content_hash: "5869cb813e6a6093eda7af2824a9c13a582750e0443e88ce7c991a1f83415521",
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
(
|
||||
schema_version: 3,
|
||||
schema_version: 4,
|
||||
asset_id: "b98ef565-3500-49e7-9935-f685fa9b2594",
|
||||
label: "painted_wooden_chair_02_2k",
|
||||
source: (
|
||||
@@ -7,7 +7,7 @@
|
||||
format: "fbx",
|
||||
fingerprint: (
|
||||
byte_len: 59964,
|
||||
modified_unix_secs: 1780713434,
|
||||
content_hash: "b12973a62dcb44589e380ea833eade726ae98a86c81084c842ee3801866d6a46",
|
||||
),
|
||||
dependencies: [],
|
||||
),
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
use std::collections::BTreeSet;
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
use std::time::UNIX_EPOCH;
|
||||
|
||||
use serde::Deserialize;
|
||||
use shared::{
|
||||
@@ -14,6 +13,7 @@ use shared::{
|
||||
};
|
||||
|
||||
use crate::asset_db::AssetRecord;
|
||||
use crate::assets::fingerprint::write_pretty_ron_if_changed;
|
||||
|
||||
pub fn animation_manifest_path(asset_id: &str) -> String {
|
||||
format!("{ANIMATION_ARTIFACT_DIR}/{asset_id}.animation.ron")
|
||||
@@ -32,15 +32,9 @@ pub fn refresh_animation_artifact(record: &mut AssetRecord) -> Result<AnimationM
|
||||
record.dependencies.sort();
|
||||
record.dependencies.dedup();
|
||||
|
||||
let text = ron::ser::to_string_pretty(&manifest, ron::ser::PrettyConfig::default())
|
||||
.map_err(|error| format!("could not serialize animation manifest: {error}"))?;
|
||||
if let Some(parent) = Path::new(&path).parent() {
|
||||
fs::create_dir_all(parent)
|
||||
.map_err(|error| format!("could not create {}: {error}", parent.display()))?;
|
||||
}
|
||||
if fs::read_to_string(&path).ok().as_deref() != Some(text.as_str()) {
|
||||
fs::write(&path, text)
|
||||
.map_err(|error| format!("could not write animation manifest {path}: {error}"))?;
|
||||
if write_pretty_ron_if_changed(&path, &manifest)
|
||||
.map_err(|error| format!("could not publish animation manifest {path}: {error}"))?
|
||||
{
|
||||
bevy::log::info!(
|
||||
"Animation manifest refreshed: source={} artifact={} skeletons={} clips={} runtime_supported={}",
|
||||
record.path,
|
||||
@@ -63,7 +57,7 @@ pub fn load_animation_manifest(path: &str) -> Result<AnimationManifest, String>
|
||||
pub fn build_animation_manifest(record: &AssetRecord) -> Result<AnimationManifest, String> {
|
||||
let bytes = fs::read(&record.path)
|
||||
.map_err(|error| format!("could not read {}: {error}", record.path))?;
|
||||
let fingerprint = source_fingerprint(&record.path, &bytes)?;
|
||||
let fingerprint = source_fingerprint(&bytes);
|
||||
let format = source_format(&record.path)?;
|
||||
match format.as_str() {
|
||||
"gltf" | "glb" => build_gltf_manifest(record, format, fingerprint, &bytes),
|
||||
@@ -582,19 +576,8 @@ fn fbx_matrix_bytes(matrix: &ufbx::Matrix) -> Vec<u8> {
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn source_fingerprint(path: &str, bytes: &[u8]) -> Result<AnimationSourceFingerprint, String> {
|
||||
let metadata = fs::metadata(path).map_err(|error| format!("could not stat {path}: {error}"))?;
|
||||
let modified_unix_secs = metadata
|
||||
.modified()
|
||||
.ok()
|
||||
.and_then(|time| time.duration_since(UNIX_EPOCH).ok())
|
||||
.map(|duration| duration.as_secs())
|
||||
.unwrap_or_default();
|
||||
Ok(AnimationSourceFingerprint {
|
||||
byte_len: metadata.len(),
|
||||
modified_unix_secs,
|
||||
content_hash: blake3::hash(bytes).to_hex().to_string(),
|
||||
})
|
||||
fn source_fingerprint(bytes: &[u8]) -> AnimationSourceFingerprint {
|
||||
AnimationSourceFingerprint::from_bytes(bytes)
|
||||
}
|
||||
|
||||
fn source_format(path: &str) -> Result<String, String> {
|
||||
@@ -626,6 +609,7 @@ mod tests {
|
||||
path: path.to_string_lossy().replace('\\', "/"),
|
||||
label: "Animated Hero".into(),
|
||||
kind_tag: "Model".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
}
|
||||
@@ -754,6 +738,30 @@ mod tests {
|
||||
fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_mtime_metadata_does_not_rewrite_equivalent_animation_manifest() {
|
||||
let root =
|
||||
std::env::temp_dir().join(format!("blacksite-animation-legacy-{}", Uuid::new_v4()));
|
||||
let path = write_animated_gltf(&root);
|
||||
let manifest = build_animation_manifest(&fixture_record(&path)).unwrap();
|
||||
let canonical =
|
||||
ron::ser::to_string_pretty(&manifest, ron::ser::PrettyConfig::default()).unwrap();
|
||||
let marker = format!("byte_len: {},", manifest.source.fingerprint.byte_len);
|
||||
let legacy = canonical.replacen(
|
||||
&marker,
|
||||
&format!("{marker}\n modified_unix_secs: 123456,"),
|
||||
1,
|
||||
);
|
||||
assert_ne!(legacy, canonical);
|
||||
let artifact = root.join("legacy.animation.ron");
|
||||
fs::write(&artifact, &legacy).unwrap();
|
||||
|
||||
assert!(!write_pretty_ron_if_changed(&artifact, &manifest).unwrap());
|
||||
assert_eq!(fs::read_to_string(&artifact).unwrap(), legacy);
|
||||
|
||||
fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn explicit_default_clip_is_stable_and_stale_ids_are_diagnostic() {
|
||||
let root =
|
||||
|
||||
@@ -2,9 +2,12 @@
|
||||
|
||||
use bevy::prelude::*;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use shared::AssetSourceFingerprint;
|
||||
use std::collections::{HashMap, HashSet};
|
||||
use uuid::Uuid;
|
||||
|
||||
use crate::assets::fingerprint::{fingerprint_file, write_pretty_ron_if_changed};
|
||||
|
||||
/// Stable asset identity for dependency tracking and prefab references.
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
|
||||
pub struct AssetId(pub Uuid);
|
||||
@@ -93,6 +96,8 @@ pub struct AssetRecord {
|
||||
pub path: String,
|
||||
pub label: String,
|
||||
pub kind_tag: String,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub source_fingerprint: Option<AssetSourceFingerprint>,
|
||||
#[serde(default)]
|
||||
pub import_settings: ImportSettings,
|
||||
#[serde(default)]
|
||||
@@ -122,9 +127,10 @@ fn sync_registry_from_browser(
|
||||
return;
|
||||
}
|
||||
|
||||
let mut existing: HashMap<String, AssetRecord> = registry
|
||||
.records
|
||||
.drain(..)
|
||||
let previous_records = std::mem::take(&mut registry.records);
|
||||
let mut existing: HashMap<String, AssetRecord> = previous_records
|
||||
.iter()
|
||||
.cloned()
|
||||
.map(|record| (record.path.clone(), record))
|
||||
.collect();
|
||||
let current_paths = assets
|
||||
@@ -146,12 +152,30 @@ fn sync_registry_from_browser(
|
||||
seen_paths.insert(path.clone(), ());
|
||||
|
||||
let kind_tag = format!("{:?}", asset.kind);
|
||||
let source_fingerprint = if imported_source_kind(&kind_tag) {
|
||||
match fingerprint_file(&path) {
|
||||
Ok(fingerprint) => Some(fingerprint),
|
||||
Err(error) => {
|
||||
warn!("Imported source fingerprint failed for {path}: {error}");
|
||||
None
|
||||
}
|
||||
}
|
||||
} else {
|
||||
None
|
||||
};
|
||||
let mut record = if let Some(mut prior) = existing.remove(&path).or_else(|| {
|
||||
take_uniquely_moved_model_record(&mut existing, ¤t_paths, &path, &kind_tag)
|
||||
source_fingerprint.as_ref().and_then(|fingerprint| {
|
||||
take_uniquely_moved_import_record(
|
||||
&mut existing,
|
||||
¤t_paths,
|
||||
&kind_tag,
|
||||
fingerprint,
|
||||
)
|
||||
})
|
||||
}) {
|
||||
if prior.path != path {
|
||||
info!(
|
||||
"Asset registry preserved model identity {} across move {} -> {}",
|
||||
"Asset registry preserved imported source identity {} across move {} -> {}",
|
||||
prior.id.as_string(),
|
||||
prior.path,
|
||||
path
|
||||
@@ -159,18 +183,26 @@ fn sync_registry_from_browser(
|
||||
prior.path = path.clone();
|
||||
}
|
||||
prior.label = asset.label.clone();
|
||||
prior.kind_tag = kind_tag;
|
||||
prior.kind_tag = kind_tag.clone();
|
||||
prior
|
||||
} else {
|
||||
AssetRecord {
|
||||
id: AssetId::new(),
|
||||
path: path.clone(),
|
||||
label: asset.label.clone(),
|
||||
kind_tag,
|
||||
kind_tag: kind_tag.clone(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
}
|
||||
};
|
||||
if imported_source_kind(&kind_tag) {
|
||||
if let Some(source_fingerprint) = source_fingerprint {
|
||||
record.source_fingerprint = Some(source_fingerprint);
|
||||
}
|
||||
} else {
|
||||
record.source_fingerprint = None;
|
||||
}
|
||||
if record.kind_tag == "Model" {
|
||||
if let Err(error) = super::refresh_model_artifacts(&mut record) {
|
||||
warn!(
|
||||
@@ -183,7 +215,8 @@ fn sync_registry_from_browser(
|
||||
next_records.push(record);
|
||||
}
|
||||
|
||||
let changed = registry.records != next_records;
|
||||
sort_registry_records(&mut next_records);
|
||||
let changed = previous_records != next_records;
|
||||
registry.records = next_records;
|
||||
if changed {
|
||||
registry.index_dirty = true;
|
||||
@@ -198,26 +231,32 @@ fn sync_registry_from_browser(
|
||||
}
|
||||
}
|
||||
|
||||
fn take_uniquely_moved_model_record(
|
||||
fn imported_source_kind(kind_tag: &str) -> bool {
|
||||
matches!(kind_tag, "Model" | "Texture" | "AudioClip")
|
||||
}
|
||||
|
||||
fn sort_registry_records(records: &mut [AssetRecord]) {
|
||||
records.sort_by(|left, right| left.path.cmp(&right.path));
|
||||
}
|
||||
|
||||
fn take_uniquely_moved_import_record(
|
||||
existing: &mut HashMap<String, AssetRecord>,
|
||||
current_paths: &HashSet<String>,
|
||||
new_path: &str,
|
||||
kind_tag: &str,
|
||||
fingerprint: &AssetSourceFingerprint,
|
||||
) -> Option<AssetRecord> {
|
||||
if kind_tag != "Model" {
|
||||
if !imported_source_kind(kind_tag) {
|
||||
return None;
|
||||
}
|
||||
let bytes = std::fs::read(new_path).ok()?;
|
||||
let content_hash = blake3::hash(&bytes).to_hex().to_string();
|
||||
let candidates = existing
|
||||
.iter()
|
||||
.filter_map(|(old_path, record)| {
|
||||
if current_paths.contains(old_path) || record.kind_tag != "Model" {
|
||||
if current_paths.contains(old_path) || record.kind_tag != kind_tag {
|
||||
return None;
|
||||
}
|
||||
let manifest_path = record.import_settings.animation_manifest_path.as_deref()?;
|
||||
let manifest = super::animation::load_animation_manifest(manifest_path).ok()?;
|
||||
(manifest.source.fingerprint.content_hash == content_hash).then(|| old_path.clone())
|
||||
recorded_source_fingerprint(record)
|
||||
.is_some_and(|prior| prior == *fingerprint)
|
||||
.then(|| old_path.clone())
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
if candidates.len() != 1 {
|
||||
@@ -226,6 +265,15 @@ fn take_uniquely_moved_model_record(
|
||||
existing.remove(&candidates[0])
|
||||
}
|
||||
|
||||
fn recorded_source_fingerprint(record: &AssetRecord) -> Option<AssetSourceFingerprint> {
|
||||
record.source_fingerprint.clone().or_else(|| {
|
||||
let manifest_path = record.import_settings.animation_manifest_path.as_deref()?;
|
||||
super::animation::load_animation_manifest(manifest_path)
|
||||
.ok()
|
||||
.map(|manifest| manifest.source.fingerprint)
|
||||
})
|
||||
}
|
||||
|
||||
pub fn find_asset_by_path(registry: &AssetRegistry, path: &str) -> Option<AssetRecord> {
|
||||
registry
|
||||
.records
|
||||
@@ -262,11 +310,16 @@ pub fn ensure_asset_record(
|
||||
if let Some(record) = find_asset_by_path(registry, &path) {
|
||||
return Ok(record);
|
||||
}
|
||||
let kind_tag = kind_tag.into();
|
||||
let source_fingerprint = imported_source_kind(&kind_tag)
|
||||
.then(|| fingerprint_file(&path).ok())
|
||||
.flatten();
|
||||
let record = AssetRecord {
|
||||
id: AssetId::new(),
|
||||
path,
|
||||
label: label.into(),
|
||||
kind_tag: kind_tag.into(),
|
||||
kind_tag,
|
||||
source_fingerprint,
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
};
|
||||
@@ -292,6 +345,9 @@ pub fn update_import_settings(
|
||||
else {
|
||||
return false;
|
||||
};
|
||||
if record.import_settings == settings {
|
||||
return false;
|
||||
}
|
||||
record.import_settings = settings;
|
||||
registry.index_dirty = true;
|
||||
true
|
||||
@@ -302,13 +358,7 @@ pub fn registry_index_path() -> &'static str {
|
||||
}
|
||||
|
||||
pub fn save_registry(registry: &AssetRegistry) -> Result<(), String> {
|
||||
let path = registry_index_path();
|
||||
if let Some(parent) = std::path::Path::new(path).parent() {
|
||||
std::fs::create_dir_all(parent).map_err(|e| e.to_string())?;
|
||||
}
|
||||
let text = ron::ser::to_string_pretty(®istry.records, ron::ser::PrettyConfig::default())
|
||||
.map_err(|e| e.to_string())?;
|
||||
std::fs::write(path, text).map_err(|e| e.to_string())
|
||||
write_pretty_ron_if_changed(registry_index_path(), ®istry.records).map(|_| ())
|
||||
}
|
||||
|
||||
pub fn load_registry() -> AssetRegistry {
|
||||
@@ -333,6 +383,101 @@ mod tests {
|
||||
ANIMATION_MANIFEST_SCHEMA_VERSION,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn imported_source_policy_covers_model_texture_and_audio_only() {
|
||||
for kind in ["Model", "Texture", "AudioClip"] {
|
||||
assert!(imported_source_kind(kind), "missing imported kind {kind}");
|
||||
}
|
||||
for kind in ["Material", "Level", "Prefab", "PostProcessEffect"] {
|
||||
assert!(
|
||||
!imported_source_kind(kind),
|
||||
"authored kind {kind} was hashed"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn registry_publication_order_is_stable_across_discovery_orders() {
|
||||
let records = [
|
||||
("assets/textures/z.png", "Texture"),
|
||||
("assets/audio/a.ogg", "AudioClip"),
|
||||
("assets/models/m.glb", "Model"),
|
||||
]
|
||||
.into_iter()
|
||||
.map(|(path, kind_tag)| AssetRecord {
|
||||
id: AssetId::new(),
|
||||
path: path.into(),
|
||||
label: path.into(),
|
||||
kind_tag: kind_tag.into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
let mut forward = records.clone();
|
||||
let mut reverse = records.into_iter().rev().collect::<Vec<_>>();
|
||||
|
||||
sort_registry_records(&mut forward);
|
||||
sort_registry_records(&mut reverse);
|
||||
|
||||
assert_eq!(forward, reverse);
|
||||
assert_eq!(
|
||||
forward
|
||||
.iter()
|
||||
.map(|record| record.path.as_str())
|
||||
.collect::<Vec<_>>(),
|
||||
[
|
||||
"assets/audio/a.ogg",
|
||||
"assets/models/m.glb",
|
||||
"assets/textures/z.png",
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn legacy_registry_record_loads_without_forcing_a_new_identity() {
|
||||
let source = r#"(
|
||||
id: ("00000000-0000-0000-0000-000000000000"),
|
||||
path: "assets/textures/legacy.png",
|
||||
label: "Legacy",
|
||||
kind_tag: "Texture",
|
||||
)"#;
|
||||
let record: AssetRecord = ron::from_str(source).unwrap();
|
||||
|
||||
assert_eq!(record.id, AssetId(Uuid::nil()));
|
||||
assert!(record.source_fingerprint.is_none());
|
||||
assert_eq!(record.import_settings, ImportSettings::default());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn content_match_preserves_every_imported_source_kind_across_move() {
|
||||
let fingerprint = AssetSourceFingerprint::from_bytes(b"stable imported bytes");
|
||||
for kind in ["Model", "Texture", "AudioClip"] {
|
||||
let record = AssetRecord {
|
||||
id: AssetId::new(),
|
||||
path: format!("assets/old/{kind}"),
|
||||
label: kind.into(),
|
||||
kind_tag: kind.into(),
|
||||
source_fingerprint: Some(fingerprint.clone()),
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
};
|
||||
let expected_id = record.id.clone();
|
||||
let mut existing = HashMap::from([(record.path.clone(), record)]);
|
||||
|
||||
let moved = take_uniquely_moved_import_record(
|
||||
&mut existing,
|
||||
&HashSet::new(),
|
||||
kind,
|
||||
&fingerprint,
|
||||
)
|
||||
.expect("unique content identity should preserve the record");
|
||||
|
||||
assert_eq!(moved.id, expected_id);
|
||||
assert!(existing.is_empty());
|
||||
}
|
||||
}
|
||||
|
||||
fn moved_model_fixture(bytes: &[u8]) -> (std::path::PathBuf, std::path::PathBuf, AssetRecord) {
|
||||
let key = Uuid::new_v4();
|
||||
let source_path = std::env::temp_dir().join(format!("blacksite-moved-model-{key}.glb"));
|
||||
@@ -351,7 +496,6 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: AnimationSourceFingerprint {
|
||||
byte_len: bytes.len() as u64,
|
||||
modified_unix_secs: 0,
|
||||
content_hash: blake3::hash(bytes).to_hex().to_string(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
@@ -371,6 +515,7 @@ mod tests {
|
||||
path: old_path,
|
||||
label: "Moved Model".into(),
|
||||
kind_tag: "Model".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings {
|
||||
animation_manifest_path: Some(manifest_path.to_string_lossy().into_owned()),
|
||||
..Default::default()
|
||||
@@ -385,12 +530,13 @@ mod tests {
|
||||
let (source_path, manifest_path, record) = moved_model_fixture(b"stable model bytes");
|
||||
let expected_id = record.id.clone();
|
||||
let mut existing = HashMap::from([(record.path.clone(), record)]);
|
||||
let fingerprint = fingerprint_file(&source_path).unwrap();
|
||||
|
||||
let moved = take_uniquely_moved_model_record(
|
||||
let moved = take_uniquely_moved_import_record(
|
||||
&mut existing,
|
||||
&HashSet::new(),
|
||||
&source_path.to_string_lossy(),
|
||||
"Model",
|
||||
&fingerprint,
|
||||
)
|
||||
.expect("unique moved model should retain its registry record");
|
||||
|
||||
@@ -406,13 +552,10 @@ mod tests {
|
||||
let old_path = record.path.clone();
|
||||
let mut existing = HashMap::from([(old_path.clone(), record)]);
|
||||
let current_paths = HashSet::from([old_path]);
|
||||
let fingerprint = fingerprint_file(&source_path).unwrap();
|
||||
|
||||
let moved = take_uniquely_moved_model_record(
|
||||
&mut existing,
|
||||
¤t_paths,
|
||||
&source_path.to_string_lossy(),
|
||||
"Model",
|
||||
);
|
||||
let moved =
|
||||
take_uniquely_moved_import_record(&mut existing, ¤t_paths, "Model", &fingerprint);
|
||||
|
||||
assert!(moved.is_none());
|
||||
assert_eq!(existing.len(), 1);
|
||||
|
||||
@@ -1548,6 +1548,7 @@ mod tests {
|
||||
path: asset.path.clone().unwrap(),
|
||||
label: asset.label.clone(),
|
||||
kind_tag: "AudioClip".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: Default::default(),
|
||||
dependencies: Vec::new(),
|
||||
}],
|
||||
@@ -1630,7 +1631,6 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: shared::AnimationSourceFingerprint {
|
||||
byte_len: 1,
|
||||
modified_unix_secs: 0,
|
||||
content_hash: "fixture".into(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
@@ -1663,6 +1663,7 @@ mod tests {
|
||||
path: "assets/models/robot.glb".into(),
|
||||
label: "Robot".into(),
|
||||
kind_tag: "Model".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: crate::asset_db::ImportSettings {
|
||||
animation_manifest_path: Some(manifest_path.to_string_lossy().into_owned()),
|
||||
default_animation_clip_id: Some(clip_id.clone()),
|
||||
|
||||
@@ -0,0 +1,114 @@
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
|
||||
use serde::de::DeserializeOwned;
|
||||
use serde::Serialize;
|
||||
use shared::AssetSourceFingerprint;
|
||||
|
||||
pub(crate) fn fingerprint_file(path: impl AsRef<Path>) -> Result<AssetSourceFingerprint, String> {
|
||||
let path = path.as_ref();
|
||||
let bytes = fs::read(path)
|
||||
.map_err(|error| format!("could not read imported source {}: {error}", path.display()))?;
|
||||
Ok(AssetSourceFingerprint::from_bytes(&bytes))
|
||||
}
|
||||
|
||||
/// Writes canonical pretty RON only when the parsed document changes semantically.
|
||||
///
|
||||
/// Equivalent existing bytes, including custom formatting and final-newline policy, stay intact.
|
||||
pub(crate) fn write_pretty_ron_if_changed<T>(
|
||||
path: impl AsRef<Path>,
|
||||
value: &T,
|
||||
) -> Result<bool, String>
|
||||
where
|
||||
T: DeserializeOwned + PartialEq + Serialize,
|
||||
{
|
||||
let path = path.as_ref();
|
||||
if fs::read_to_string(path)
|
||||
.ok()
|
||||
.and_then(|text| ron::from_str::<T>(&text).ok())
|
||||
.is_some_and(|existing| existing == *value)
|
||||
{
|
||||
return Ok(false);
|
||||
}
|
||||
|
||||
let text = ron::ser::to_string_pretty(value, ron::ser::PrettyConfig::default())
|
||||
.map_err(|error| format!("could not serialize RON: {error}"))?;
|
||||
if fs::read(path).ok().as_deref() == Some(text.as_bytes()) {
|
||||
return Ok(false);
|
||||
}
|
||||
if let Some(parent) = path.parent() {
|
||||
fs::create_dir_all(parent)
|
||||
.map_err(|error| format!("could not create {}: {error}", parent.display()))?;
|
||||
}
|
||||
fs::write(path, text)
|
||||
.map_err(|error| format!("could not write {}: {error}", path.display()))?;
|
||||
Ok(true)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use serde::Deserialize;
|
||||
use std::fs::{File, FileTimes};
|
||||
use std::time::{Duration, SystemTime};
|
||||
use uuid::Uuid;
|
||||
|
||||
#[derive(Debug, Deserialize, PartialEq, Serialize)]
|
||||
struct Fixture {
|
||||
count: u32,
|
||||
label: String,
|
||||
}
|
||||
|
||||
fn fixture_path(name: &str) -> std::path::PathBuf {
|
||||
std::env::temp_dir().join(format!(
|
||||
"blacksite-fingerprint-{name}-{}.ron",
|
||||
Uuid::new_v4()
|
||||
))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn metadata_only_drift_does_not_change_content_identity() {
|
||||
let path = fixture_path("mtime");
|
||||
fs::write(&path, b"stable source bytes").unwrap();
|
||||
let before = fingerprint_file(&path).unwrap();
|
||||
File::options()
|
||||
.write(true)
|
||||
.open(&path)
|
||||
.unwrap()
|
||||
.set_times(
|
||||
FileTimes::new().set_modified(SystemTime::now() + Duration::from_secs(86_400)),
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
assert_eq!(fingerprint_file(&path).unwrap(), before);
|
||||
fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn same_size_byte_change_updates_content_identity() {
|
||||
let path = fixture_path("same-size");
|
||||
fs::write(&path, b"source-a").unwrap();
|
||||
let before = fingerprint_file(&path).unwrap();
|
||||
fs::write(&path, b"source-b").unwrap();
|
||||
let after = fingerprint_file(&path).unwrap();
|
||||
|
||||
assert_eq!(before.byte_len, after.byte_len);
|
||||
assert_ne!(before.content_hash, after.content_hash);
|
||||
fs::remove_file(path).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn equivalent_ron_preserves_exact_existing_bytes() {
|
||||
let path = fixture_path("semantic");
|
||||
let existing = b"( label: \"stable\", count: 7, )\n\n";
|
||||
fs::write(&path, existing).unwrap();
|
||||
let value = Fixture {
|
||||
count: 7,
|
||||
label: "stable".into(),
|
||||
};
|
||||
|
||||
assert!(!write_pretty_ron_if_changed(&path, &value).unwrap());
|
||||
assert_eq!(fs::read(&path).unwrap(), existing);
|
||||
fs::remove_file(path).unwrap();
|
||||
}
|
||||
}
|
||||
@@ -3,6 +3,7 @@
|
||||
pub mod animation;
|
||||
pub mod asset_db;
|
||||
mod catalog;
|
||||
mod fingerprint;
|
||||
mod import;
|
||||
pub mod materials;
|
||||
pub mod operators;
|
||||
|
||||
@@ -228,7 +228,6 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: AnimationSourceFingerprint {
|
||||
byte_len: 1,
|
||||
modified_unix_secs: 0,
|
||||
content_hash: "fixture".into(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
@@ -265,6 +264,7 @@ mod tests {
|
||||
path: model_path.clone(),
|
||||
label: "Operator Fixture".into(),
|
||||
kind_tag: "Model".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings {
|
||||
animation_manifest_path: Some(path.to_string_lossy().into_owned()),
|
||||
..Default::default()
|
||||
@@ -352,6 +352,7 @@ mod tests {
|
||||
path: path.clone(),
|
||||
label: "Impact".into(),
|
||||
kind_tag: "AudioClip".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: Default::default(),
|
||||
dependencies: Vec::new(),
|
||||
}],
|
||||
@@ -502,6 +503,7 @@ mod tests {
|
||||
path: material_path.clone(),
|
||||
label: "Concrete".into(),
|
||||
kind_tag: "Material".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: Default::default(),
|
||||
dependencies: Vec::new(),
|
||||
}],
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
use std::fs;
|
||||
use std::path::Path;
|
||||
use std::time::UNIX_EPOCH;
|
||||
|
||||
use bevy::gltf::GltfAssetLabel;
|
||||
use bevy::prelude::*;
|
||||
@@ -15,11 +14,13 @@ use crate::asset_db::{
|
||||
AssetRecord, ImportSettings, MaterialImportPolicy, ModelHierarchyMode, ModelPlacementMode,
|
||||
};
|
||||
use shared::{
|
||||
ComponentInstanceId, EditorAssetRef, MaterialRef, RendererMaterialSet, RendererMaterialSlot,
|
||||
StaticMeshRenderer, StaticMeshRendererEntry,
|
||||
AssetSourceFingerprint, ComponentInstanceId, EditorAssetRef, MaterialRef, RendererMaterialSet,
|
||||
RendererMaterialSlot, StaticMeshRenderer, StaticMeshRendererEntry,
|
||||
};
|
||||
|
||||
pub const STATIC_MESH_MANIFEST_SCHEMA: u32 = 3;
|
||||
use crate::assets::fingerprint::{fingerprint_file, write_pretty_ron_if_changed};
|
||||
|
||||
pub const STATIC_MESH_MANIFEST_SCHEMA: u32 = 4;
|
||||
pub const STATIC_MESH_ARTIFACT_DIR: &str = "assets/meshes/generated";
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||
@@ -42,11 +43,7 @@ pub struct StaticMeshSource {
|
||||
pub dependencies: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||
pub struct StaticMeshSourceFingerprint {
|
||||
pub byte_len: u64,
|
||||
pub modified_unix_secs: u64,
|
||||
}
|
||||
pub type StaticMeshSourceFingerprint = AssetSourceFingerprint;
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||
pub struct StaticMeshImportSnapshot {
|
||||
@@ -134,16 +131,9 @@ pub fn refresh_static_mesh_artifact(
|
||||
manifest.source.dependencies.dedup();
|
||||
record.dependencies = manifest.source.dependencies.clone();
|
||||
|
||||
let text = ron::ser::to_string_pretty(&manifest, ron::ser::PrettyConfig::default())
|
||||
.map_err(|err| format!("could not serialize static mesh manifest: {err}"))?;
|
||||
if let Some(parent) = Path::new(&path).parent() {
|
||||
fs::create_dir_all(parent)
|
||||
.map_err(|err| format!("could not create {}: {err}", parent.display()))?;
|
||||
}
|
||||
let should_write = fs::read_to_string(&path).ok().as_deref() != Some(text.as_str());
|
||||
if should_write {
|
||||
fs::write(&path, text)
|
||||
.map_err(|err| format!("could not write static mesh manifest {path}: {err}"))?;
|
||||
if write_pretty_ron_if_changed(&path, &manifest)
|
||||
.map_err(|error| format!("could not publish static mesh manifest {path}: {error}"))?
|
||||
{
|
||||
info!(
|
||||
"Static mesh manifest refreshed: source={} artifact={} parts={}",
|
||||
record.path,
|
||||
@@ -287,7 +277,7 @@ fn part_effective_material_id(part: &StaticMeshPart) -> Option<String> {
|
||||
|
||||
fn build_static_mesh_manifest(record: &AssetRecord) -> Result<StaticMeshManifest, String> {
|
||||
let format = source_format(&record.path)?;
|
||||
let fingerprint = source_fingerprint(&record.path)?;
|
||||
let fingerprint = fingerprint_file(&record.path)?;
|
||||
let import = StaticMeshImportSnapshot {
|
||||
scale: record.import_settings.scale,
|
||||
generate_collider: record.import_settings.generate_collider,
|
||||
@@ -631,20 +621,6 @@ fn source_format(path: &str) -> Result<String, String> {
|
||||
.ok_or_else(|| format!("asset path `{path}` has no extension"))
|
||||
}
|
||||
|
||||
fn source_fingerprint(path: &str) -> Result<StaticMeshSourceFingerprint, String> {
|
||||
let metadata = fs::metadata(path).map_err(|err| format!("could not stat {path}: {err}"))?;
|
||||
let modified_unix_secs = metadata
|
||||
.modified()
|
||||
.ok()
|
||||
.and_then(|time| time.duration_since(UNIX_EPOCH).ok())
|
||||
.map(|duration| duration.as_secs())
|
||||
.unwrap_or_default();
|
||||
Ok(StaticMeshSourceFingerprint {
|
||||
byte_len: metadata.len(),
|
||||
modified_unix_secs,
|
||||
})
|
||||
}
|
||||
|
||||
fn resolve_dependency(source_path: &str, uri: &str) -> String {
|
||||
if uri.starts_with("data:") || uri.contains("://") {
|
||||
return uri.to_string();
|
||||
@@ -672,7 +648,7 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: StaticMeshSourceFingerprint {
|
||||
byte_len: 42,
|
||||
modified_unix_secs: 10,
|
||||
content_hash: "a".repeat(64),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
},
|
||||
@@ -741,6 +717,55 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn schema_v3_manifest_without_hash_migrates_to_content_fingerprint() {
|
||||
let root = std::env::temp_dir().join(format!(
|
||||
"blacksite-static-mesh-legacy-{}",
|
||||
uuid::Uuid::new_v4()
|
||||
));
|
||||
fs::create_dir_all(&root).unwrap();
|
||||
let path = root.join("legacy.static_mesh.ron");
|
||||
let expected = test_manifest();
|
||||
let canonical =
|
||||
ron::ser::to_string_pretty(&expected, ron::ser::PrettyConfig::default()).unwrap();
|
||||
let legacy = canonical
|
||||
.replacen("schema_version: 4", "schema_version: 3", 1)
|
||||
.lines()
|
||||
.filter(|line| !line.contains("content_hash:"))
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n");
|
||||
fs::write(&path, legacy).unwrap();
|
||||
|
||||
assert!(write_pretty_ron_if_changed(&path, &expected).unwrap());
|
||||
assert_eq!(
|
||||
load_static_mesh_manifest(&path.to_string_lossy()).unwrap(),
|
||||
expected
|
||||
);
|
||||
|
||||
fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn equivalent_static_manifest_preserves_existing_formatting_and_newline() {
|
||||
let root = std::env::temp_dir().join(format!(
|
||||
"blacksite-static-mesh-semantic-{}",
|
||||
uuid::Uuid::new_v4()
|
||||
));
|
||||
fs::create_dir_all(&root).unwrap();
|
||||
let path = root.join("stable.static_mesh.ron");
|
||||
let manifest = test_manifest();
|
||||
let exact = format!(
|
||||
"{}\n\n",
|
||||
ron::ser::to_string_pretty(&manifest, ron::ser::PrettyConfig::default()).unwrap()
|
||||
);
|
||||
fs::write(&path, &exact).unwrap();
|
||||
|
||||
assert!(!write_pretty_ron_if_changed(&path, &manifest).unwrap());
|
||||
assert_eq!(fs::read_to_string(&path).unwrap(), exact);
|
||||
|
||||
fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn renderer_from_manifest_can_ignore_source_materials() {
|
||||
let manifest = test_manifest();
|
||||
@@ -785,6 +810,7 @@ mod tests {
|
||||
path,
|
||||
label: "Robot Expressive".into(),
|
||||
kind_tag: "Model".into(),
|
||||
source_fingerprint: None,
|
||||
import_settings: ImportSettings::default(),
|
||||
dependencies: Vec::new(),
|
||||
};
|
||||
|
||||
@@ -78,7 +78,12 @@ impl EditorCommandRegistry {
|
||||
}
|
||||
}
|
||||
|
||||
/// 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;
|
||||
|
||||
@@ -19,7 +19,6 @@ use shared::{
|
||||
|
||||
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,
|
||||
@@ -1631,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) {
|
||||
@@ -1652,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(
|
||||
@@ -2872,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 {
|
||||
@@ -2939,6 +2921,28 @@ mod tests {
|
||||
use super::*;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
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)]
|
||||
|
||||
@@ -30,6 +30,7 @@ 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;
|
||||
@@ -76,6 +77,7 @@ 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;
|
||||
@@ -102,6 +104,7 @@ impl PluginGroup for EditorPluginGroup {
|
||||
.add(ProjectIoPlugin)
|
||||
.add(SampleCatalogPlugin)
|
||||
.add(NativeDialogPlugin)
|
||||
.add(ShutdownPlugin)
|
||||
.add(scene_schema::SceneSchemaPlugin)
|
||||
.add(net_editor::NetEditorPlugin)
|
||||
.add(AssetDbPlugin)
|
||||
@@ -143,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))
|
||||
|
||||
@@ -8,3 +8,4 @@ pub mod project_io;
|
||||
pub mod samples;
|
||||
pub mod session;
|
||||
pub mod settings_ui;
|
||||
pub mod shutdown;
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
+967
-110
File diff suppressed because it is too large.
Load diff
@@ -884,7 +884,6 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: AnimationSourceFingerprint {
|
||||
byte_len: 42,
|
||||
modified_unix_secs: 1,
|
||||
content_hash: "hash".into(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
|
||||
@@ -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,6 @@ 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,
|
||||
};
|
||||
@@ -123,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);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -250,11 +244,7 @@ fn collider_diagnostics_ui(world: &mut World, ui: &mut egui::Ui) {
|
||||
ui.colored_label(color, row.shape_label);
|
||||
ui.label(&row.actor_name);
|
||||
if ui.small_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);
|
||||
}
|
||||
});
|
||||
for diagnostic in &row.diagnostics {
|
||||
@@ -304,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"))
|
||||
@@ -323,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,
|
||||
@@ -397,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]);
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -37,7 +37,6 @@ 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,
|
||||
@@ -51,9 +50,8 @@ use crate::viewport::collider_diagnostics::{
|
||||
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,
|
||||
@@ -135,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)]
|
||||
@@ -276,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>()
|
||||
@@ -326,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>() {
|
||||
let mut panel_state = world.resource_mut::<InspectorPanelState>();
|
||||
if collapsed {
|
||||
ui_state.inspector_collapsed_components.insert(key);
|
||||
panel_state.collapsed_components.insert(key);
|
||||
} else {
|
||||
ui_state.inspector_collapsed_components.remove(&key);
|
||||
}
|
||||
panel_state.collapsed_components.remove(&key);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2362,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) {
|
||||
@@ -4625,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]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4881,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 {
|
||||
@@ -4924,6 +4901,80 @@ fn option_string_ui(ui: &mut egui::Ui, label: &str, value: &mut Option<String>)
|
||||
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() {
|
||||
|
||||
@@ -9,6 +9,7 @@ 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};
|
||||
@@ -39,6 +40,7 @@ pub fn top_menu_bar(
|
||||
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| {
|
||||
@@ -148,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| {
|
||||
@@ -203,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();
|
||||
}
|
||||
}
|
||||
|
||||
+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);
|
||||
}
|
||||
}
|
||||
@@ -1267,7 +1267,6 @@ mod tests {
|
||||
format: "glb".into(),
|
||||
fingerprint: AnimationSourceFingerprint {
|
||||
byte_len: 1,
|
||||
modified_unix_secs: 0,
|
||||
content_hash: "fixture".into(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
|
||||
@@ -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,12 +9,13 @@ use shared::{
|
||||
animation_clip_source_index, animation_clip_sub_asset_id, animation_skeleton_source_index,
|
||||
animation_skeleton_sub_asset_id,
|
||||
brush_math::{validate_brush, BrushDiagnosticSeverity},
|
||||
AnimationControllerDesc, AnimationDiagnosticSeverity, AnimationManifest, AudioListenerDesc,
|
||||
AudioSourceDesc, BrushDesc, ColliderDesc, ColliderShapeDesc, EditorAssetRef, MaterialAsset,
|
||||
MaterialDesc, MaterialInstanceAsset, MaterialOverride, ModelRef, PostProcessEffectAsset,
|
||||
PostProcessVolumeDesc, PrefabInstance, PrefabRef, RendererMaterialSet, ShaderSchemaAsset,
|
||||
SkinnedMeshRenderer, StaticMeshRenderer, TerrainDesc, ANIMATION_MANIFEST_SCHEMA_VERSION,
|
||||
AUDIO_CLIP_SUB_ASSET_ID, COMPONENT_ANIMATION_CONTROLLER_DESC, COMPONENT_SKINNED_MESH_RENDERER,
|
||||
AnimationControllerDesc, AnimationDiagnosticSeverity, AnimationManifest,
|
||||
AssetSourceFingerprint, AudioListenerDesc, AudioSourceDesc, BrushDesc, ColliderDesc,
|
||||
ColliderShapeDesc, EditorAssetRef, MaterialAsset, MaterialDesc, MaterialInstanceAsset,
|
||||
MaterialOverride, ModelRef, PostProcessEffectAsset, PostProcessVolumeDesc, PrefabInstance,
|
||||
PrefabRef, RendererMaterialSet, ShaderSchemaAsset, SkinnedMeshRenderer, StaticMeshRenderer,
|
||||
TerrainDesc, ANIMATION_MANIFEST_SCHEMA_VERSION, AUDIO_CLIP_SUB_ASSET_ID,
|
||||
COMPONENT_ANIMATION_CONTROLLER_DESC, COMPONENT_SKINNED_MESH_RENDERER,
|
||||
NAVIGATION_GENERATED_ARTIFACT_DIRECTORY,
|
||||
};
|
||||
|
||||
@@ -322,6 +323,8 @@ struct RegistryAssetRecord {
|
||||
path: String,
|
||||
kind_tag: String,
|
||||
#[serde(default)]
|
||||
source_fingerprint: Option<AssetSourceFingerprint>,
|
||||
#[serde(default)]
|
||||
import_settings: RegistryImportSettings,
|
||||
#[serde(default)]
|
||||
dependencies: Vec<String>,
|
||||
@@ -482,10 +485,96 @@ fn validate_asset_registry(
|
||||
repair: "Convert the clip to Ogg Vorbis, WAV, MP3, or FLAC and reimport it.".into(),
|
||||
});
|
||||
}
|
||||
if matches!(record.kind_tag.as_str(), "Model" | "Texture" | "AudioClip") {
|
||||
validate_content_fingerprint(
|
||||
project_root,
|
||||
report,
|
||||
"assets/.index/registry.ron",
|
||||
&record.path,
|
||||
record.source_fingerprint.as_ref(),
|
||||
"registry.source_fingerprint_missing",
|
||||
"registry.source_fingerprint_stale",
|
||||
"registered imported source",
|
||||
);
|
||||
}
|
||||
}
|
||||
animation_catalog
|
||||
}
|
||||
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
fn validate_content_fingerprint(
|
||||
project_root: &Path,
|
||||
report: &mut ProjectValidationReport,
|
||||
owner_path: &str,
|
||||
source_path: &str,
|
||||
fingerprint: Option<&AssetSourceFingerprint>,
|
||||
missing_code: &str,
|
||||
stale_code: &str,
|
||||
source_label: &str,
|
||||
) {
|
||||
let Some(fingerprint) = fingerprint.filter(|fingerprint| fingerprint.is_complete()) else {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: missing_code.into(),
|
||||
source_path: owner_path.into(),
|
||||
owner_actor_id: None,
|
||||
reference: Some(source_path.into()),
|
||||
message: format!("{source_label} has no complete BLAKE3 content fingerprint"),
|
||||
repair: "Refresh the asset registry or reimport the source with this editor version."
|
||||
.into(),
|
||||
});
|
||||
return;
|
||||
};
|
||||
let Some(path) = resolve_reference(project_root, source_path) else {
|
||||
return;
|
||||
};
|
||||
let Ok(metadata) = std::fs::metadata(&path) else {
|
||||
return;
|
||||
};
|
||||
if metadata.len() != fingerprint.byte_len {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: stale_code.into(),
|
||||
source_path: owner_path.into(),
|
||||
owner_actor_id: None,
|
||||
reference: Some(source_path.into()),
|
||||
message: format!(
|
||||
"{source_label} size changed from {} to {} bytes",
|
||||
fingerprint.byte_len,
|
||||
metadata.len()
|
||||
),
|
||||
repair: "Refresh or reimport the changed source before validation or packaging.".into(),
|
||||
});
|
||||
return;
|
||||
}
|
||||
match blake3_file_hash(&path) {
|
||||
Ok(content_hash) if content_hash != fingerprint.content_hash => {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: stale_code.into(),
|
||||
source_path: owner_path.into(),
|
||||
owner_actor_id: None,
|
||||
reference: Some(source_path.into()),
|
||||
message: format!(
|
||||
"{source_label} content changed even though its byte length is unchanged"
|
||||
),
|
||||
repair: "Refresh or reimport the changed source before validation or packaging."
|
||||
.into(),
|
||||
});
|
||||
}
|
||||
Ok(_) => {}
|
||||
Err(error) => report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: stale_code.into(),
|
||||
source_path: owner_path.into(),
|
||||
owner_actor_id: None,
|
||||
reference: Some(source_path.into()),
|
||||
message: format!("could not hash {source_label}: {error}"),
|
||||
repair: "Restore readable source content and rerun validation.".into(),
|
||||
}),
|
||||
}
|
||||
}
|
||||
|
||||
fn reference_is_runtime_package_asset(reference: &str) -> bool {
|
||||
let relative = Path::new(reference.split('#').next().unwrap_or(reference));
|
||||
if relative.is_absolute()
|
||||
@@ -709,10 +798,12 @@ struct StaticMeshManifestView {
|
||||
struct StaticMeshSourceView {
|
||||
path: String,
|
||||
#[serde(default)]
|
||||
fingerprint: AssetSourceFingerprint,
|
||||
#[serde(default)]
|
||||
dependencies: Vec<String>,
|
||||
}
|
||||
|
||||
const STATIC_MESH_MANIFEST_SCHEMA_VERSION: u32 = 3;
|
||||
const STATIC_MESH_MANIFEST_SCHEMA_VERSION: u32 = 4;
|
||||
|
||||
fn validate_static_mesh_manifests(project_root: &Path, report: &mut ProjectValidationReport) {
|
||||
for path in ron_files(
|
||||
@@ -754,6 +845,16 @@ fn validate_static_mesh_manifests(project_root: &Path, report: &mut ProjectValid
|
||||
"model",
|
||||
&manifest.source.path,
|
||||
);
|
||||
validate_content_fingerprint(
|
||||
project_root,
|
||||
report,
|
||||
&source,
|
||||
&manifest.source.path,
|
||||
Some(&manifest.source.fingerprint),
|
||||
"static_mesh.manifest_fingerprint_missing",
|
||||
"static_mesh.manifest_stale",
|
||||
"static mesh source",
|
||||
);
|
||||
for dependency in manifest.source.dependencies {
|
||||
add_reference(
|
||||
project_root,
|
||||
@@ -975,12 +1076,7 @@ fn validate_animation_manifest_contract(
|
||||
}
|
||||
|
||||
let fingerprint = &manifest.source.fingerprint;
|
||||
let hash_is_present = fingerprint.content_hash.len() == 64
|
||||
&& fingerprint
|
||||
.content_hash
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_hexdigit());
|
||||
if fingerprint.byte_len == 0 || fingerprint.modified_unix_secs == 0 || !hash_is_present {
|
||||
if fingerprint.byte_len == 0 || !fingerprint.is_complete() {
|
||||
report.findings.push(ProjectValidationFinding {
|
||||
severity: ValidationSeverity::Error,
|
||||
code: "animation.manifest_fingerprint_missing".into(),
|
||||
@@ -3071,7 +3167,7 @@ mod tests {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn static_mesh_manifest_schema_v3_is_current() {
|
||||
fn static_mesh_manifest_schema_v4_is_current() {
|
||||
let root = fixture_root();
|
||||
let source_path = "assets/models/static.glb";
|
||||
std::fs::create_dir_all(root.join("assets/models")).unwrap();
|
||||
@@ -3081,7 +3177,8 @@ mod tests {
|
||||
std::fs::write(
|
||||
artifact_dir.join("static-id.static_mesh.ron"),
|
||||
format!(
|
||||
"(schema_version:{STATIC_MESH_MANIFEST_SCHEMA_VERSION},asset_id:\"static-id\",source:(path:\"{source_path}\",dependencies:[]),warnings:[])"
|
||||
"(schema_version:{STATIC_MESH_MANIFEST_SCHEMA_VERSION},asset_id:\"static-id\",source:(path:\"{source_path}\",fingerprint:(byte_len:5,content_hash:\"{}\"),dependencies:[]),warnings:[])",
|
||||
blake3::hash(b"model").to_hex()
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
@@ -3095,6 +3192,70 @@ mod tests {
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn same_size_static_mesh_source_change_invalidates_content_hash() {
|
||||
let root = fixture_root();
|
||||
let source_path = "assets/models/static.glb";
|
||||
std::fs::create_dir_all(root.join("assets/models")).unwrap();
|
||||
std::fs::write(root.join(source_path), b"model").unwrap();
|
||||
let fingerprint = AssetSourceFingerprint::from_bytes(b"model");
|
||||
let artifact = root.join("assets/meshes/generated/static-id.static_mesh.ron");
|
||||
std::fs::create_dir_all(artifact.parent().unwrap()).unwrap();
|
||||
std::fs::write(
|
||||
&artifact,
|
||||
format!(
|
||||
"(schema_version:{STATIC_MESH_MANIFEST_SCHEMA_VERSION},asset_id:\"static-id\",source:(path:\"{source_path}\",fingerprint:(byte_len:{},content_hash:\"{}\"),dependencies:[]),warnings:[])",
|
||||
fingerprint.byte_len, fingerprint.content_hash
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
std::fs::write(root.join(source_path), b"modem").unwrap();
|
||||
|
||||
let report = validate_project(&root);
|
||||
|
||||
let finding = report
|
||||
.findings
|
||||
.iter()
|
||||
.find(|finding| finding.code == "static_mesh.manifest_stale")
|
||||
.expect("same-size model edit must stale the static mesh manifest");
|
||||
assert!(finding.message.contains("byte length is unchanged"));
|
||||
assert!(finding.repair.contains("Refresh") || finding.repair.contains("reimport"));
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn registry_detects_same_size_changes_for_all_imported_source_kinds() {
|
||||
for (kind, relative) in [
|
||||
("Model", "assets/models/source.glb"),
|
||||
("Texture", "assets/textures/source.png"),
|
||||
("AudioClip", "assets/audio/source.ogg"),
|
||||
] {
|
||||
let root = fixture_root();
|
||||
let path = root.join(relative);
|
||||
std::fs::create_dir_all(path.parent().unwrap()).unwrap();
|
||||
std::fs::write(&path, b"source-a").unwrap();
|
||||
let fingerprint = AssetSourceFingerprint::from_bytes(b"source-a");
|
||||
std::fs::write(
|
||||
root.join("assets/.index/registry.ron"),
|
||||
format!(
|
||||
"[(id:(\"00000000-0000-0000-0000-000000000001\"),path:\"{relative}\",kind_tag:\"{kind}\",source_fingerprint:Some((byte_len:{},content_hash:\"{}\")),dependencies:[])]",
|
||||
fingerprint.byte_len, fingerprint.content_hash
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
std::fs::write(&path, b"source-b").unwrap();
|
||||
|
||||
let report = validate_project(&root);
|
||||
|
||||
assert!(report.findings.iter().any(|finding| {
|
||||
finding.code == "registry.source_fingerprint_stale"
|
||||
&& finding.reference.as_deref() == Some(relative)
|
||||
&& finding.message.contains("byte length is unchanged")
|
||||
}));
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
fn write_manifest(root: &Path, version: u32) {
|
||||
std::fs::write(
|
||||
root.join("assets/project.ron"),
|
||||
@@ -3128,7 +3289,6 @@ mod tests {
|
||||
format: source_format.into(),
|
||||
fingerprint: AnimationSourceFingerprint {
|
||||
byte_len: 5,
|
||||
modified_unix_secs: 1,
|
||||
content_hash: blake3::hash(b"model").to_hex().to_string(),
|
||||
},
|
||||
dependencies: Vec::new(),
|
||||
@@ -3188,10 +3348,12 @@ mod tests {
|
||||
let manifest = animation_manifest_path
|
||||
.map(|path| format!("Some({path:?})"))
|
||||
.unwrap_or_else(|| "None".into());
|
||||
let fingerprint = AssetSourceFingerprint::from_bytes(b"model");
|
||||
std::fs::write(
|
||||
root.join("assets/.index/registry.ron"),
|
||||
format!(
|
||||
"[(id:(\"{ANIMATION_ASSET_ID}\"),path:\"{source_path}\",kind_tag:\"Model\",import_settings:(static_mesh_manifest_path:None,animation_manifest_path:{manifest}),dependencies:[])]"
|
||||
"[(id:(\"{ANIMATION_ASSET_ID}\"),path:\"{source_path}\",kind_tag:\"Model\",source_fingerprint:Some((byte_len:{},content_hash:\"{}\")),import_settings:(static_mesh_manifest_path:None,animation_manifest_path:{manifest}),dependencies:[])]",
|
||||
fingerprint.byte_len, fingerprint.content_hash
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
@@ -3205,10 +3367,12 @@ mod tests {
|
||||
let source = root.join(source_path);
|
||||
std::fs::create_dir_all(source.parent().unwrap()).unwrap();
|
||||
std::fs::write(source, b"model").unwrap();
|
||||
let fingerprint = AssetSourceFingerprint::from_bytes(b"model");
|
||||
std::fs::write(
|
||||
root.join("assets/.index/registry.ron"),
|
||||
format!(
|
||||
"[(id:(\"{ANIMATION_ASSET_ID}\"),path:\"{source_path}\",kind_tag:\"Model\",import_settings:(static_mesh_manifest_path:None,animation_manifest_path:Some(\"{ANIMATION_MANIFEST_PATH}\"),default_animation_clip_id:Some(\"{default_clip_id}\")),dependencies:[])]"
|
||||
"[(id:(\"{ANIMATION_ASSET_ID}\"),path:\"{source_path}\",kind_tag:\"Model\",source_fingerprint:Some((byte_len:{},content_hash:\"{}\")),import_settings:(static_mesh_manifest_path:None,animation_manifest_path:Some(\"{ANIMATION_MANIFEST_PATH}\"),default_animation_clip_id:Some(\"{default_clip_id}\")),dependencies:[])]",
|
||||
fingerprint.byte_len, fingerprint.content_hash
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
@@ -3632,6 +3796,49 @@ mod tests {
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn project_validation_preserves_registry_and_generated_artifact_bytes() {
|
||||
let root = fixture_root();
|
||||
let source_path = "assets/models/hero.glb";
|
||||
let manifest = animation_fixture_manifest(source_path, "glb", "rig-signature", true);
|
||||
write_animation_source_and_registry(&root, source_path, Some(ANIMATION_MANIFEST_PATH));
|
||||
write_animation_manifest(&root, &manifest);
|
||||
write_animation_scene(&root, &animation_fixture_controller(&manifest));
|
||||
|
||||
let static_path = root.join("assets/meshes/generated/model-id.static_mesh.ron");
|
||||
std::fs::create_dir_all(static_path.parent().unwrap()).unwrap();
|
||||
std::fs::write(
|
||||
&static_path,
|
||||
format!(
|
||||
"( schema_version: {STATIC_MESH_MANIFEST_SCHEMA_VERSION}, asset_id: \"model-id\", source: ( path: \"{source_path}\", fingerprint: ( byte_len: {}, content_hash: \"{}\", ), dependencies: [], ), warnings: [], )\n\n",
|
||||
manifest.source.fingerprint.byte_len,
|
||||
manifest.source.fingerprint.content_hash
|
||||
),
|
||||
)
|
||||
.unwrap();
|
||||
let paths = [
|
||||
root.join("assets/.index/registry.ron"),
|
||||
root.join(ANIMATION_MANIFEST_PATH),
|
||||
static_path,
|
||||
];
|
||||
let before = paths
|
||||
.iter()
|
||||
.map(std::fs::read)
|
||||
.collect::<Result<Vec<_>, _>>()
|
||||
.unwrap();
|
||||
|
||||
let _ = validate_project(&root);
|
||||
let _ = validate_project(&root);
|
||||
|
||||
let after = paths
|
||||
.iter()
|
||||
.map(std::fs::read)
|
||||
.collect::<Result<Vec<_>, _>>()
|
||||
.unwrap();
|
||||
assert_eq!(after, before);
|
||||
std::fs::remove_dir_all(root).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_animation_manifest_is_reported_globally_and_on_the_actor_property() {
|
||||
let root = fixture_root();
|
||||
|
||||
@@ -266,13 +266,8 @@ pub struct AnimationManifestSource {
|
||||
pub dependencies: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct AnimationSourceFingerprint {
|
||||
pub byte_len: u64,
|
||||
pub modified_unix_secs: u64,
|
||||
/// BLAKE3 hash of the source file bytes.
|
||||
pub content_hash: String,
|
||||
}
|
||||
/// Backward-compatible name for the shared imported-source fingerprint contract.
|
||||
pub type AnimationSourceFingerprint = crate::AssetSourceFingerprint;
|
||||
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct AnimationSkeletonRecord {
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
/// Stable identity for the exact bytes of an imported project source.
|
||||
///
|
||||
/// Filesystem timestamps are deliberately excluded: Git and LFS do not preserve checkout mtimes,
|
||||
/// so they cannot participate in a portable authored-data contract.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
||||
pub struct AssetSourceFingerprint {
|
||||
pub byte_len: u64,
|
||||
#[serde(default)]
|
||||
pub content_hash: String,
|
||||
}
|
||||
|
||||
impl AssetSourceFingerprint {
|
||||
pub fn from_bytes(bytes: &[u8]) -> Self {
|
||||
Self {
|
||||
byte_len: bytes.len() as u64,
|
||||
content_hash: blake3::hash(bytes).to_hex().to_string(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn is_complete(&self) -> bool {
|
||||
self.content_hash.len() == 64
|
||||
&& self
|
||||
.content_hash
|
||||
.bytes()
|
||||
.all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn exact_bytes_define_source_identity() {
|
||||
let first = AssetSourceFingerprint::from_bytes(b"asset-a");
|
||||
let same = AssetSourceFingerprint::from_bytes(b"asset-a");
|
||||
let same_size_change = AssetSourceFingerprint::from_bytes(b"asset-b");
|
||||
|
||||
assert_eq!(first, same);
|
||||
assert_ne!(first, same_size_change);
|
||||
assert_eq!(first.byte_len, same_size_change.byte_len);
|
||||
assert!(first.is_complete());
|
||||
|
||||
let mut noncanonical = first;
|
||||
noncanonical.content_hash.make_ascii_uppercase();
|
||||
assert!(!noncanonical.is_complete());
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@
|
||||
|
||||
mod actor;
|
||||
mod animation;
|
||||
mod asset_fingerprint;
|
||||
pub mod brush_math;
|
||||
mod components;
|
||||
mod hydration;
|
||||
@@ -18,6 +19,7 @@ mod rendering_profile_asset;
|
||||
|
||||
pub use actor::{infer_actor_kind, validate_actor, ActorValidationError};
|
||||
pub use animation::*;
|
||||
pub use asset_fingerprint::AssetSourceFingerprint;
|
||||
pub use components::*;
|
||||
pub use hydration::{
|
||||
cascade_config_from_rendering, flush_level_object_hydration,
|
||||
|
||||
@@ -56,6 +56,8 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
|
||||
| [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 |
|
||||
| [0043](adr/0043-content-addressed-import-fingerprints.md) | Content-addressed imported-source identity and byte-preserving artifact publication |
|
||||
|
||||
## Editor framework
|
||||
|
||||
@@ -94,6 +96,9 @@ Immutable-style log of significant decisions. Add a new numbered ADR when changi
|
||||
| [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/deterministic-asset-fingerprints/](editor/evaluations/deterministic-asset-fingerprints/) | Source, fresh-checkout, hash-stability, and native acceptance evidence for imported-source fingerprints |
|
||||
| [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)
|
||||
@@ -119,6 +124,7 @@ Detailed milestone and feature plans live in [`.cursor/plans/`](../.cursor/plans
|
||||
| `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)
|
||||
|
||||
|
||||
@@ -13,7 +13,12 @@ retaining explicit, separate paths for skinned geometry and generic full-scene d
|
||||
|
||||
## Decision
|
||||
|
||||
Model imports now generate deterministic project artifacts under `assets/meshes/generated/*.static_mesh.ron`. The artifact records stable part IDs, source path, format, source fingerprint, import settings, mesh/material subasset labels, source node/material metadata, dependency paths, and warnings for metadata that is not played by the static mesh path.
|
||||
Model imports now generate deterministic project artifacts under
|
||||
`assets/meshes/generated/*.static_mesh.ron`. The artifact records stable part IDs, source path,
|
||||
format, the content-addressed source fingerprint owned by
|
||||
[ADR 0043](0043-content-addressed-import-fingerprints.md), import settings, mesh/material subasset
|
||||
labels, source node/material metadata, dependency paths, and warnings for metadata that is not
|
||||
played by the static mesh path.
|
||||
|
||||
The saved scene authoring component is `StaticMeshRenderer`. Its slots reference imported mesh/material assets by `EditorAssetRef` (`asset_id` + `sub_asset_id`) rather than source file paths. Hydration resolves those refs through the generated artifact, spawns runtime child `Mesh3d` parts, and strips/regenerates them like other hydrated ECS. Built-in primitives remain `Primitive`, and explicit full-scene placement remains `ImportedModel + ModelRef`.
|
||||
|
||||
@@ -35,4 +40,6 @@ Hierarchy mode is also stored per asset. `SingleActor` places all mesh parts int
|
||||
- Static mesh actors can expose renderer slots, source labels, shadows, collider policy, and material overrides in the inspector.
|
||||
- Skinned parts are marked in artifact schema v2 and excluded from static renderer construction and
|
||||
hydration. Animation playback uses the dedicated contract in ADRs 0031 and 0033.
|
||||
- Static-mesh schema v4 uses byte length plus BLAKE3 rather than checkout mtime, so a source touch is
|
||||
a no-op while a same-size byte edit is detected.
|
||||
- Generated artifacts are project files but are hidden from the Asset Browser catalog to avoid treating them as levels/prefabs.
|
||||
@@ -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.
|
||||
|
||||
@@ -42,6 +42,12 @@ 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.
|
||||
|
||||
Imported model, texture, and audio registry records, animation manifests, and static-mesh manifests
|
||||
share the content-addressed fingerprint contract in
|
||||
[ADR 0043](0043-content-addressed-import-fingerprints.md). Validation hashes source bytes and catches
|
||||
same-size changes without consulting mtimes. The validation entry point is read-only; CI asserts that
|
||||
running both level and sample validation leaves the checkout unchanged.
|
||||
|
||||
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.
|
||||
@@ -58,3 +64,5 @@ hydration so a sample or shipping scene cannot hide an invalid or unresolved ter
|
||||
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.
|
||||
- Validators report stale or incomplete import fingerprints with repair guidance but never rewrite
|
||||
the registry or generated artifacts.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,57 @@
|
||||
# ADR 0043: Content-Addressed Import Fingerprints
|
||||
|
||||
## Status
|
||||
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
|
||||
Generated model artifacts and the project asset registry must be stable across contributors, CI,
|
||||
Git worktrees, and LFS checkouts. Git does not preserve source-file modification times. Persisting a
|
||||
checkout mtime as source identity therefore caused the editor to rewrite otherwise equivalent
|
||||
animation and static-mesh manifests during startup. Static-mesh manifests also used only byte length
|
||||
and mtime, so a same-size source edit could evade the persisted identity contract.
|
||||
|
||||
Formatting-only publication was a second source of noise. Re-serializing an equivalent RON
|
||||
document could normalize its final newline or layout even when import semantics had not changed.
|
||||
That made clean-checkout release evidence unreliable and obscured intentional asset edits.
|
||||
|
||||
## Decision
|
||||
|
||||
`shared::AssetSourceFingerprint` is the persisted imported-source identity. It contains the exact
|
||||
source byte length and lowercase BLAKE3 digest. Filesystem timestamps are not serialized or compared
|
||||
as semantic identity; an importer may use them only as an in-memory scan hint before confirming
|
||||
content.
|
||||
|
||||
The asset registry stores this fingerprint for every imported model, texture, and audio source.
|
||||
Content identity also drives unique move reconciliation, so metadata-only drift cannot replace a
|
||||
stable registry UUID. Ambiguous copies still receive a new identity.
|
||||
|
||||
Animation and static-mesh manifests use the same fingerprint. Animation schema v3 already contained
|
||||
a content hash, so its schema remains v3 and legacy `modified_unix_secs` fields are accepted as
|
||||
ignored unknown metadata. Static-mesh schema v4 replaces its length-plus-mtime record with length
|
||||
plus BLAKE3. Existing schema-v3 static artifacts are regenerated once; unrelated assets are not
|
||||
reimported.
|
||||
|
||||
Registry and generated-manifest writers parse the existing RON and compare the semantic value before
|
||||
publication. Equivalent documents preserve their exact existing bytes, including layout and final
|
||||
newlines. Changed documents publish canonical pretty RON. Registry records are ordered by normalized
|
||||
project path before comparison, so filesystem enumeration order cannot change their serialized
|
||||
sequence on a fresh checkout.
|
||||
|
||||
Authoritative project validation remains read-only. It validates registry, animation, and
|
||||
static-mesh fingerprints by length and digest, including same-size source edits. CI runs both
|
||||
headless validators and then asserts that tracked and untracked checkout state is unchanged.
|
||||
|
||||
## Consequences
|
||||
|
||||
- A source touch or fresh checkout mtime cannot dirty the project.
|
||||
- Same-size source edits invalidate the affected registry/manifests deterministically.
|
||||
- Model, texture, and audio IDs survive uniquely identifiable moves by content.
|
||||
- Initial migration adds fingerprints to imported registry records and upgrades static manifests to
|
||||
schema v4. Legacy animation files can remain byte-identical indefinitely because their timestamp
|
||||
field is ignored.
|
||||
- Startup hashing reads imported source bytes. Future scan caches may use metadata to avoid work,
|
||||
but they must verify content before persisting a changed identity.
|
||||
- External glTF/FBX dependency paths remain explicit manifest dependencies; extending fingerprints
|
||||
to a dependency graph requires a separate versioned contract.
|
||||
@@ -42,6 +42,9 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| [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/deterministic-asset-fingerprints/](evaluations/deterministic-asset-fingerprints/) | Source, fresh-checkout, hash-stability, and native acceptance evidence for imported-source fingerprints |
|
||||
| [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)
|
||||
@@ -61,6 +64,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
| `ui/navigation_inspector.rs` / `scene::navigation` / `game::navigation` | Navigation authoring, deterministic bake artifacts, viewport preview, and runtime path queries | navigation-authoring.md, ADR 0032 |
|
||||
| `assets/materials.rs` / `ui/material_library.rs` / `viewport/material_drop.rs` / `shared::renderer_material` | Shared material discovery, docked catalog/usage UI, exact reversible surface drops, stable renderer slots, and draw binding | material-system.md, ADR 0035 |
|
||||
| `blacksite_surface` / `game_hot::rendering::solari` / `third_party/bevy_solari` | Surface ABI packing, raster composition, Solari evaluator dispatch, and deformation eligibility | material-system.md, rendering.md, ADR 0036 |
|
||||
| `assets/fingerprint.rs` / `shared::AssetSourceFingerprint` | Content-addressed imported-source identity and byte-preserving registry/manifest publication | ADR 0043, evaluations/deterministic-asset-fingerprints/ |
|
||||
| `assets/` | Catalog, asset DB, static mesh artifacts, `thumbnails/`, `materials.rs`, prefab overrides v2 | this file (below), prefab-authoring.md, ADR 0017, ADR 0027 |
|
||||
| `shared::prefab_overrides` | Versioned stable override schema and editor-independent runtime application | prefab-authoring.md, ADR 0027 |
|
||||
| `project/` | Workspace, settings UI, user prefs, support diagnostics | roadmap Phase 1 |
|
||||
@@ -89,6 +93,7 @@ Docs for the in-process egui editor (`crates/editor/`). Update this index when a
|
||||
- **Unified viewport** uses one render-to-texture target for both the editor fly camera and the possessed player camera so HDR/atmosphere is not broken by sub-viewport cropping.
|
||||
- **PIE:** F8 possess/eject while sim runs; **F6** pauses/resumes simulation in Play; project settings drive shared rendering for the active viewport camera.
|
||||
- **Asset browser** mirrors the on-disk `assets/` directory with project tree, breadcrumb, search/filter/sort, grid/list views, texture/model/material thumbnails, a details pane, and context-aware row/menu actions; narrow docks prioritize content, keep the root panel fixed, switch list view to a compact single-column layout, and hide tree/details panes when they would crowd the content area. The footer stays pinned while only the project tree, asset content, and details panels scroll. **Built-ins** holds spawnable primitives and lights. **Materials** folder scans `assets/materials/*.ron`, renders material thumbnails on a sphere using `MaterialDesc`, and exposes shader-schema-driven parameters/textures in the details editor; **Shaders** holds shader schema RON files. **Audio** accepts Bevy-supported Ogg/Vorbis and Speex (`.ogg`, `.oga`, `.spx`), WAV, MP3, and FLAC clips under `assets/audio/`, with a dedicated filter, waveform icon, format/file details, and stable registry-backed references that retain a runtime source path. glTF/GLB/FBX rows can expand into a shelf of normalized embedded mesh, material, and texture subassets with independent generated thumbnails. Mesh subassets can be selected, dragged into the viewport, or placed from details/context menus; material subassets render source-material spheres; texture subassets can be applied to the selected actor. Model import settings are staged with **Apply** / **Revert**, asset context menus can regenerate thumbnails, material asset details edit shared `MaterialAsset` fields, and file asset deletion moves sources/generated artifacts into `assets/.trash/`. Before thumbnail loading, glTF sources preflight local external buffers/images and show a stable non-retryable failure state when a dependency is missing instead of repeatedly invoking the asset loader.
|
||||
- **Imported-source fingerprints** use exact byte length plus lowercase BLAKE3 for model, texture, and audio registry records and for generated static-mesh/animation manifests. Filesystem timestamps are scan hints only; equivalent refresh preserves the exact committed RON bytes and registry publication order is normalized by project path. See [ADR 0043](../adr/0043-content-addressed-import-fingerprints.md) and the [acceptance record](evaluations/deterministic-asset-fingerprints/).
|
||||
- **Material Library** is a dockable bottom-panel catalog for cross-folder Material and direct-base Material Instance authoring. It provides search, type and scene-usage filters, grid/list thumbnails, dependency health, usage counts, creation, guarded details editing, and first-class drag sources. Viewport drops resolve an exact renderer slot, primitive, or brush face under the pointer, preview transiently, reject incompatible/read-only targets explicitly, restore on target change/cancel, and commit one typed undo step on release.
|
||||
- **Static/skinned renderer split** — model drag/drop uses normalized artifacts under `assets/meshes/generated/`. Unrigged, non-animated sources create `ActorKind::StaticMesh + StaticMeshRenderer`; skin-bound or animated sources create `ActorKind::SkinnedMesh + SkinnedMeshRenderer` and preserve the imported hierarchy. Static slots never contain marked skinned primitives or geometry from animated sources. `SceneInstance` placement keeps `ImportedModel + ModelRef` for generic full-source scenes. See [ADR 0033](../adr/0033-dedicated-skinned-mesh-renderer.md).
|
||||
- **Animation authoring** — glTF/GLB imports generate UUID-keyed rig/clip manifests and expandable skeleton/clip shelves. Clip drag creates a skinned actor or adds one exact-signature-compatible state to a selected skinned actor through typed history. `AnimationControllerDesc` exposes named states, ranges, loop/speed, default/crossfade, and non-dirty runtime-backed preview; project validation resolves the same stable refs and blocks animated/skinned FBX with conversion guidance. Production acceptance completed in Gitea #46. See [animation-authoring.md](animation-authoring.md) and [ADR 0031](../adr/0031-animation-authoring-runtime-contract.md).
|
||||
@@ -111,6 +116,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.
|
||||
|
||||
@@ -68,10 +68,11 @@ serialize into authored scenes.
|
||||
|
||||
`SkinnedMeshRenderer`, skeleton references, and clip references carry the model registry UUID. Generated
|
||||
artifacts are keyed by that UUID; source paths are cached resolution and repair hints. When one
|
||||
model is moved or renamed on disk, catalog refresh reconciles it by its animation-manifest content
|
||||
hash, preserves the UUID, and regenerates both manifests with the new source path. An identical copy
|
||||
is not treated as a move while the original still exists. Ambiguous content matches intentionally
|
||||
receive a new identity rather than silently binding the wrong asset.
|
||||
model is moved or renamed on disk, catalog refresh reconciles it by the registry's shared
|
||||
content-addressed source fingerprint, preserves the UUID, and regenerates both manifests with the
|
||||
new source path. The same registry policy covers textures and audio clips. An identical copy is not
|
||||
treated as a move while the original still exists. Ambiguous content matches intentionally receive
|
||||
a new identity rather than silently binding the wrong asset.
|
||||
|
||||
Scene schema v3 migrates legacy animated actors that paired `ModelRef` with
|
||||
`AnimationControllerDesc` to the dedicated skinned renderer. Generic `ImportedModel + ModelRef`
|
||||
@@ -83,6 +84,12 @@ used as identity. Animation-manifest schema v1 artifacts must be reimported to g
|
||||
signatures; schema v3 adds the explicit default-clip ID. Schema v2 deserializes as Imported rest
|
||||
pose and never receives an inferred default.
|
||||
|
||||
Source identity uses exact byte length plus BLAKE3 and never checkout mtime. Existing animation
|
||||
schema-v3 files may retain a legacy `modified_unix_secs` field in their exact bytes; the current
|
||||
reader ignores it, and an equivalent refresh preserves the whole file unchanged. Static-mesh schema
|
||||
v4 uses the same content fingerprint. See
|
||||
[ADR 0043](../adr/0043-content-addressed-import-fingerprints.md).
|
||||
|
||||
## Validation And Format Boundary
|
||||
|
||||
Interactive diagnostics and `cargo validate-levels` resolve registry UUIDs, generated manifests,
|
||||
|
||||
@@ -87,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
|
||||
@@ -200,7 +209,7 @@ the Edit-to-Play boundary restore the complete runtime snapshot. See
|
||||
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
|
||||
@@ -215,7 +224,11 @@ the Edit-to-Play boundary restore the complete runtime snapshot. See
|
||||
- **Processing:** the asset registry generates normalized model manifests under
|
||||
`assets/meshes/generated/`. The manifests store stable part IDs, glTF/FBX mesh/material subasset
|
||||
labels, whether each part is skin-bound, source metadata, dependencies, and import settings.
|
||||
These artifacts are hidden from the Asset Browser catalog.
|
||||
Model, texture, and audio registry records use byte length plus BLAKE3 source identity; model
|
||||
manifests use the same policy. Semantic RON comparison preserves exact existing bytes for an
|
||||
equivalent refresh, so checkout mtimes and formatting do not dirty project content. See
|
||||
[ADR 0043](../adr/0043-content-addressed-import-fingerprints.md). These artifacts are hidden from
|
||||
the Asset Browser catalog.
|
||||
- **Browser subassets:** model rows can expand into a content shelf backed by the generated
|
||||
manifest. Unrigged mesh subassets place as independent `StaticMeshRenderer` actors. A skinned
|
||||
subasset places its owning source through `SkinnedMeshRenderer`, retaining joints and inverse bind
|
||||
|
||||
@@ -12,6 +12,9 @@ Living checklist for the production editor program ([ADR 0012](../adr/0012-zero-
|
||||
| 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/). |
|
||||
| Checkout metadata or filesystem enumeration can rewrite imported-asset artifacts | Done | Shared content fingerprints, semantic byte-preserving publication, normalized registry order, clean-checkout validators, and live mtime-only drift pass at `cbd380a`; see the [evaluation](evaluations/deterministic-asset-fingerprints/). |
|
||||
| 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` |
|
||||
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
# Deterministic Imported-Asset Fingerprints Evaluation
|
||||
|
||||
**Date:** 2026-07-13
|
||||
|
||||
**Issue:** [Gitea #56](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/56)
|
||||
|
||||
**Content-addressed implementation:** `e1b2f86a495496da83947777d332d00a15a1779d`
|
||||
|
||||
**Stable publication ordering:** `cbd380a9413411667a83f74b66c5a2feda5e1af7`
|
||||
|
||||
**Release-candidate commit:** Not nominated
|
||||
|
||||
**Source validation:** **Pass**
|
||||
|
||||
**Fresh-checkout acceptance:** **Pass**
|
||||
|
||||
**Native acceptance:** **Pass**
|
||||
|
||||
This record covers imported model, texture, and audio source identity plus the animation, static-mesh,
|
||||
and registry documents derived from those sources. The permanent contract is owned by
|
||||
[ADR 0043](../../../adr/0043-content-addressed-import-fingerprints.md).
|
||||
|
||||
## Automated Verification
|
||||
|
||||
| Command or suite | Result | Evidence |
|
||||
|------------------|--------|----------|
|
||||
| `cargo fmt --all -- --check` | Pass | Formatting 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; editor reported 300 passing tests, scene reported 100 passing and one ignored manual-migration test, and shared reported 99 passing tests. |
|
||||
| Fingerprint regressions | Pass | Exact-byte BLAKE3 identity, same-size byte changes, mtime-only drift, legacy timestamp tolerance, stable move recovery, imported-source coverage, semantic RON equality, and read-only validation are covered. |
|
||||
| `cargo validate-levels --project .` | Pass | 81 dependencies, five known nonblocking import/platform findings, zero blocking errors. |
|
||||
| `cargo validate-samples --project .` | Pass | Five samples, 86 dependencies, the same five nonblocking findings, zero blocking errors. |
|
||||
| Packaged acceptance | Deferred | Explicitly deferred by project-owner direction; no packaged result is claimed. |
|
||||
|
||||
## Fresh Checkout
|
||||
|
||||
The first exact-commit run at `e1b2f86` exposed one remaining nondeterministic path: native startup
|
||||
discovered catalog entries in filesystem order and rewrote `assets/.index/registry.ron`. That run
|
||||
failed the clean-checkout gate. Commit `cbd380a` sorts records by normalized project path before
|
||||
semantic comparison and adds a discovery-order regression test.
|
||||
|
||||
A new detached, LFS-hydrated worktree at `cbd380a` then completed native startup, asset scan,
|
||||
`validate-levels`, and `validate-samples` with an empty `git status --short`. Touching
|
||||
`assets/models/RobotExpressive.glb` while the editor was live also left the worktree clean. Its
|
||||
original nanosecond timestamp was restored after the test.
|
||||
|
||||
The following SHA-256 values were identical before startup, after startup, after the mtime-only
|
||||
change, and after both validators:
|
||||
|
||||
| Artifact | SHA-256 |
|
||||
|----------|---------|
|
||||
| `assets/.index/registry.ron` | `5beb11fb708729fb024e2e671596876bcf31b3c3fd2cea51da777db1d343644e` |
|
||||
| `113f74df...static_mesh.ron` | `8d93e4d49c4f1d00ea8c482e8e1981f18d7a71224847c2b9f05f153982c5e80e` |
|
||||
| `3f63f359...static_mesh.ron` | `e47099d59ec4ce9dc977ba6a08ddee36f1d99c0f13d9278998f21cba72571585` |
|
||||
| `b98ef565...static_mesh.ron` | `edc77d61284c1010c8811d40bd7cedebfcbd6a3d88145e54d5c1ef7dc3a0a864` |
|
||||
| `113f74df...animation.ron` | `0e678584aca470b36afd14b75a950d84a87d445438ba9b0a1e3416e863dda92a` |
|
||||
| `3f63f359...animation.ron` | `45d3f9e9dcc64137f40a339c84512b6aba47102f7593aa6a9344891de68c0c07` |
|
||||
| `b98ef565...animation.ron` | `691eb70ff05b2a4d03f51766f4c682a4171f7c76721f453c434f8de6fd936408` |
|
||||
|
||||
## Native Acceptance
|
||||
|
||||
| Workflow | Result | Evidence |
|
||||
|----------|--------|----------|
|
||||
| Main checkout startup | Pass | The exact debug editor at `e1b2f86` loaded the committed scene with populated hierarchy, viewport, Inspector, and Asset Browser, then exited with code 0. |
|
||||
| Imported model browser | Pass | Opening `assets/models` rendered all three model rows and thumbnails; selecting the FBX exposed its registry-backed details without destabilizing the editor. |
|
||||
| Fixed fresh checkout | Pass | The exact `cbd380a` editor launched from the detached worktree, rendered the complete editor frame, preserved every artifact byte, and exited with code 0. |
|
||||
| Metadata-only drift | Pass | A live source `touch` produced no registry or manifest change and no Git diff. |
|
||||
|
||||
## Native Evidence
|
||||
|
||||

|
||||
|
||||
- Gitea attachment asset 39: `blacksite-issue56-fresh-fixed-cbd380a.png`, 3426x1384 sRGB PNG,
|
||||
1,787,700 bytes.
|
||||
- SHA-256: `2748ae3de31ff97933c9793b90475ffd38d54d7e9dd5d65937b699f81c73c9bc`.
|
||||
|
||||

|
||||
|
||||
- Gitea attachment asset 40: `blacksite-issue56-models-e1b2f86.png`, 3426x1384 sRGB PNG,
|
||||
1,940,210 bytes.
|
||||
- SHA-256: `064c0634ebac47b52516412b022247ba8aa6f155014db8f8d3cca86850509da7`.
|
||||
|
||||
Both images are ordinary Gitea issue attachments. This record does not use repository raw or Git LFS
|
||||
pointer URLs.
|
||||
|
||||
## Separate Finding
|
||||
|
||||
Selecting the painted-chair FBX exposed missing external texture dependencies in the committed
|
||||
fixture: `painted_wooden_chair_02_diff_2k.jpg`, `painted_wooden_chair_02_nor_gl_2k.exr`, and
|
||||
`painted_wooden_chair_02_rough_2k.exr`. The asset server reported six load errors because the paths
|
||||
were requested more than once. This is an FBX dependency/import-fixture defect, not a deterministic
|
||||
fingerprint failure, and is tracked separately in
|
||||
[Gitea #58](https://git.spacetrainclubhouse.com/Falling-Metal-Interactive/Blacksite/issues/58).
|
||||
|
||||
## Release Use
|
||||
|
||||
The #56 source, fresh-checkout, and native feature-level acceptance record is complete. A future
|
||||
production candidate must rerun the clean-checkout protocol from the exact nominated commit. This
|
||||
record does not nominate a candidate or establish production readiness.
|
||||
@@ -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.
|
||||
@@ -1,6 +1,6 @@
|
||||
# Production-Readiness Acceptance Matrix
|
||||
|
||||
**Matrix version:** 0.4
|
||||
**Matrix version:** 0.6
|
||||
|
||||
**Last audit:** 2026-07-13
|
||||
|
||||
@@ -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 | Fail | 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, but `#55` records unguarded native dirty shutdown and a missing clean-history savepoint. Candidate-specific end-to-end reruns also remain. |
|
||||
| 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`, scoped UI action safety `#57`, and deterministic asset fingerprints `#56` have feature-level source/native acceptance. #56 additionally passed a fresh LFS checkout, both validators, mtime-only drift, and artifact hash stability at `cbd380a`. 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) 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. |
|
||||
| G6 | Headless content validation and CI are green from a clean checkout | Missing | [CI configuration](../../../../.github/workflows/ci.yml) hydrates LFS, runs both project/sample content gates, and asserts a pristine checkout. The [#56 feature run](../deterministic-asset-fingerprints/) passed native startup and both validators from a fresh LFS-hydrated worktree at `cbd380a`, but no release candidate is nominated and no candidate CI 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 | Sample-pack gap `#32` has exact-implementation source/native evidence at `d52cc2e`, but guarded native shutdown and clean history savepoints remain the open P0 `#55`. A consolidated candidate limitations ledger is also 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. |
|
||||
| G8 | Known limitations have severity/workaround and no P0 blocker remains | Partial | Sample-pack gap `#32`, guarded shutdown/savepoints `#55`, scoped UI action safety `#57`, and deterministic imported-asset fingerprints `#56` have complete feature-level acceptance; no known P0 implementation blocker remains. A consolidated candidate limitations ledger and exact-candidate rerun are still missing. Property-block application `#53` and external FBX dependency handling `#58` 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.4. |
|
||||
| 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. |
|
||||
| D1 | Versioned acceptance matrix under `docs/editor/evaluations/` | Pass | This file, version 0.6. |
|
||||
| D2 | Release-candidate representative project and reproducible validation commands | Partial | The committed [sample regression pack](../sample-regression-pack/), commands, exact-implementation native evidence, and [fresh-checkout fingerprint protocol](../deterministic-asset-fingerprints/) exist. Nominate a release candidate and rerun the complete set 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
|
||||
@@ -69,6 +69,9 @@ 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 |
|
||||
| Imported asset identity and generated artifacts | Implemented; `#56` uses shared BLAKE3 fingerprints, byte-preserving semantic publication, and normalized registry order | Fresh LFS checkout, native startup, mtime-only drift, validators, and artifact hashes passed at `cbd380a`; not rerun as one candidate |
|
||||
|
||||
## Candidate Validation Commands
|
||||
|
||||
|
||||
@@ -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.
|
||||
@@ -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/).
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
## Shipped
|
||||
|
||||
- Stable asset registry (`assets/.index/registry.ron`) with import settings
|
||||
- Stable asset registry (`assets/.index/registry.ron`) with import settings and content-addressed
|
||||
model/texture/audio source fingerprints
|
||||
- Prefab instances (`PrefabInstance`) + save-as-prefab workflow
|
||||
- Unsaved-scene guards on New/Open/Recent
|
||||
- Hierarchy additive select, reparent/unparent undo, multi-entity gizmo delta
|
||||
|
||||
@@ -119,7 +119,7 @@ Phased work for the in-process editor (`crates/editor`). Status reflects the cur
|
||||
|
||||
| Item | Status | Notes |
|
||||
|------|--------|-------|
|
||||
| `asset_db.rs` registry | Done | Stable UUIDs by path; import settings in details |
|
||||
| `asset_db.rs` registry | Done | Stable UUIDs by path/content, deterministic model/texture/audio BLAKE3 fingerprints, normalized publication order, and import settings in details |
|
||||
| Model import formats | Done | glTF/GLB + FBX (binary); `.fbm` sidecar copy on import |
|
||||
| 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 |
|
||||
@@ -151,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-#49 are complete after source, headless, and native acceptance. Final readiness gate #50 remains blocked by open P0 shutdown/savepoint work #55; deterministic imported-asset fingerprints #56 are P1 follow-up work. 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`, follow-on P0 #57 scoped UI action safety is complete at `9e23ae7`, and P1 #56 deterministic imported-asset fingerprints pass workspace, clean-checkout, validator, hash-stability, and native acceptance at `cbd380a`. No known P0 implementation blocker remains, but #50 is still the final candidate gate and production readiness is not established. 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)
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
Reference in new issue
Block a user