This commit is contained in:
1 parent
9a67a25a15
commit
1ab3886028
24 files changed
+1836
-311
No files matched your search
@@ -5,7 +5,7 @@ use bevy_egui::EguiContexts;
|
||||
use shared::{TerrainDesc, AUTHORING_COMPONENT_TERRAIN, COMPONENT_TERRAIN_DESC};
|
||||
|
||||
use crate::camera::EditorCamera;
|
||||
use crate::history::reflected_component_transaction;
|
||||
use crate::history::{reflected_component_transaction, EditorHistory};
|
||||
use crate::operators::{ActiveOperator, OperatorPhase, OperatorStatus};
|
||||
use crate::scene_io::SceneIo;
|
||||
use crate::selection::{SelectedEntity, ViewportClick};
|
||||
@@ -143,8 +143,15 @@ fn terrain_sculpt_input(
|
||||
state.clamp_settings();
|
||||
|
||||
let Some(entity) = state.target.or(selected.0) else {
|
||||
cancel_stroke(&mut state, &mut terrains);
|
||||
state.stop();
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Blocked,
|
||||
"Terrain sculpt stopped: target is unavailable",
|
||||
"Target unavailable",
|
||||
);
|
||||
return Ok(());
|
||||
};
|
||||
if selected.0 != Some(entity) {
|
||||
@@ -152,8 +159,15 @@ fn terrain_sculpt_input(
|
||||
}
|
||||
|
||||
if display.clean_game_view {
|
||||
cancel_stroke(&mut state, &mut terrains);
|
||||
state.stop();
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Terrain sculpt stopped for clean game view",
|
||||
"Clean game view enabled; terrain restored",
|
||||
);
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
@@ -163,12 +177,11 @@ fn terrain_sculpt_input(
|
||||
keys.just_pressed(KeyCode::Escape) || buttons.just_pressed(MouseButton::Right);
|
||||
if cancel_requested {
|
||||
if state.is_stroking() {
|
||||
cancel_stroke(&mut state, &mut terrains);
|
||||
scene_io.status = "Terrain sculpt stroke canceled".to_string();
|
||||
set_status(
|
||||
cancel_active_stroke(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Stroke canceled; terrain restored",
|
||||
);
|
||||
} else {
|
||||
state.stop();
|
||||
@@ -179,8 +192,15 @@ fn terrain_sculpt_input(
|
||||
}
|
||||
|
||||
let Ok((global, mut terrain)) = terrains.get_mut(entity) else {
|
||||
state.stroke = None;
|
||||
state.stop();
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Blocked,
|
||||
"Terrain sculpt stopped: target no longer exists",
|
||||
"Target no longer exists",
|
||||
);
|
||||
return Ok(());
|
||||
};
|
||||
|
||||
@@ -253,18 +273,8 @@ fn terrain_sculpt_input(
|
||||
let label = sculpt_history_label(state.mode);
|
||||
let mode_label = state.mode.label();
|
||||
commands.queue(move |world: &mut World| {
|
||||
let result = commit_terrain_stroke(world, stroke, final_terrain, label);
|
||||
if let Err(error) = result {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("Terrain sculpt commit failed: {error}");
|
||||
}
|
||||
finish_terrain_stroke(world, stroke, final_terrain, label, mode_label);
|
||||
});
|
||||
scene_io.status = format!("{mode_label} terrain stroke committed");
|
||||
set_status(
|
||||
&mut active_operator,
|
||||
OperatorPhase::Committed,
|
||||
format!("{mode_label} stroke; Ctrl+Z to undo"),
|
||||
);
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
@@ -276,10 +286,11 @@ fn commit_terrain_stroke(
|
||||
final_terrain: TerrainDesc,
|
||||
label: &'static str,
|
||||
) -> Result<(), String> {
|
||||
let original = stroke.original;
|
||||
if let Ok(mut actor) = world.get_entity_mut(stroke.entity) {
|
||||
actor.insert(stroke.original);
|
||||
actor.insert(original.clone());
|
||||
}
|
||||
reflected_component_transaction(
|
||||
let result = reflected_component_transaction(
|
||||
world,
|
||||
stroke.entity,
|
||||
label,
|
||||
@@ -289,7 +300,82 @@ fn commit_terrain_stroke(
|
||||
world.entity_mut(entity).insert(final_terrain);
|
||||
Ok(())
|
||||
},
|
||||
)
|
||||
);
|
||||
if result.is_err() {
|
||||
if let Ok(mut actor) = world.get_entity_mut(stroke.entity) {
|
||||
actor.insert(original);
|
||||
}
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
fn finish_terrain_stroke(
|
||||
world: &mut World,
|
||||
stroke: TerrainStroke,
|
||||
final_terrain: TerrainDesc,
|
||||
label: &'static str,
|
||||
mode_label: &'static str,
|
||||
) {
|
||||
let undo_depth = world.resource::<EditorHistory>().undo_depth();
|
||||
match commit_terrain_stroke(world, stroke, final_terrain, label) {
|
||||
Ok(()) if world.resource::<EditorHistory>().undo_depth() > undo_depth => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("{mode_label} terrain stroke committed");
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Committed,
|
||||
format!("{mode_label} stroke; Ctrl+Z to undo"),
|
||||
);
|
||||
}
|
||||
Ok(()) => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("{mode_label} terrain stroke made no changes");
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Canceled,
|
||||
format!("{mode_label} stroke made no changes"),
|
||||
);
|
||||
}
|
||||
Err(error) => {
|
||||
world.resource_mut::<SceneIo>().status =
|
||||
format!("Terrain sculpt commit failed: {error}");
|
||||
set_status(
|
||||
&mut world.resource_mut::<ActiveOperator>(),
|
||||
OperatorPhase::Blocked,
|
||||
format!("Commit failed: {error}"),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn cancel_active_stroke(
|
||||
state: &mut TerrainSculptState,
|
||||
terrains: &mut Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
scene_io: &mut SceneIo,
|
||||
active_operator: &mut ActiveOperator,
|
||||
) {
|
||||
cancel_stroke(state, terrains);
|
||||
scene_io.status = "Terrain sculpt stroke canceled".to_string();
|
||||
set_status(
|
||||
active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Stroke canceled; terrain restored",
|
||||
);
|
||||
}
|
||||
|
||||
fn stop_tool_with_rollback(
|
||||
state: &mut TerrainSculptState,
|
||||
terrains: &mut Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
scene_io: &mut SceneIo,
|
||||
active_operator: &mut ActiveOperator,
|
||||
phase: OperatorPhase,
|
||||
message: &str,
|
||||
hint: &str,
|
||||
) {
|
||||
cancel_stroke(state, terrains);
|
||||
state.stop();
|
||||
scene_io.status = message.to_string();
|
||||
set_status(active_operator, phase, hint);
|
||||
}
|
||||
|
||||
fn cancel_stroke(
|
||||
@@ -561,7 +647,8 @@ fn draw_terrain_sculpt_preview(state: Res<TerrainSculptState>, mut gizmos: Gizmo
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::history::{apply_command_redo, apply_command_undo, EditorHistory};
|
||||
use crate::history::EditorHistory;
|
||||
use crate::operators::test_harness::{assert_undo_redo_round_trip, OperatorInvariantHarness};
|
||||
use shared::{ActorKind, LevelObject};
|
||||
|
||||
fn sample(terrain: &TerrainDesc, x: u32, z: u32) -> f32 {
|
||||
@@ -657,8 +744,10 @@ mod tests {
|
||||
app.register_type::<ActorKind>()
|
||||
.register_type::<TerrainDesc>();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
world.init_resource::<TerrainSculptState>();
|
||||
let original = TerrainDesc::flat(9);
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, original.clone()))
|
||||
@@ -676,26 +765,126 @@ mod tests {
|
||||
);
|
||||
}
|
||||
world.entity_mut(entity).insert(final_terrain.clone());
|
||||
commit_terrain_stroke(
|
||||
let stroke = TerrainStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
flatten_height: 0.0,
|
||||
seed: 7,
|
||||
};
|
||||
{
|
||||
let mut state = world.resource_mut::<TerrainSculptState>();
|
||||
state.start(entity);
|
||||
state.stroke = Some(stroke);
|
||||
}
|
||||
let stroke = world
|
||||
.resource_mut::<TerrainSculptState>()
|
||||
.stroke
|
||||
.take()
|
||||
.unwrap();
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_terrain_stroke(
|
||||
world,
|
||||
stroke,
|
||||
final_terrain.clone(),
|
||||
"Raise Terrain",
|
||||
"Raise",
|
||||
);
|
||||
|
||||
harness.assert_committed(world, 1, 0);
|
||||
harness.assert_status(world, "terrain.sculpt", OperatorPhase::Committed);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&final_terrain));
|
||||
let state = world.resource::<TerrainSculptState>();
|
||||
assert!(state.active);
|
||||
assert_eq!(state.target, Some(entity));
|
||||
assert!(!state.is_stroking());
|
||||
assert_undo_redo_round_trip(world, original, final_terrain, |world| {
|
||||
world.get::<TerrainDesc>(entity).unwrap().clone()
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn no_op_stroke_terminates_without_dirtying_or_history() {
|
||||
let mut app = App::new();
|
||||
app.register_type::<ActorKind>()
|
||||
.register_type::<TerrainDesc>();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let original = TerrainDesc::flat(5);
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, original.clone()))
|
||||
.id();
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_terrain_stroke(
|
||||
world,
|
||||
TerrainStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
flatten_height: 0.0,
|
||||
seed: 7,
|
||||
seed: 1,
|
||||
},
|
||||
final_terrain.clone(),
|
||||
"Raise Terrain",
|
||||
)
|
||||
.unwrap();
|
||||
original.clone(),
|
||||
"Smooth Terrain",
|
||||
"Smooth",
|
||||
);
|
||||
|
||||
assert_eq!(world.resource::<EditorHistory>().undo_depth(), 1);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&final_terrain));
|
||||
apply_command_undo(world);
|
||||
harness.assert_canceled(world);
|
||||
harness.assert_status(world, "terrain.sculpt", OperatorPhase::Canceled);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&original));
|
||||
apply_command_redo(world);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&final_terrain));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn commit_failure_restores_preview_and_reports_blocked_without_history() {
|
||||
let mut app = App::new();
|
||||
let world = app.world_mut();
|
||||
world.init_resource::<ActiveOperator>();
|
||||
world.init_resource::<EditorHistory>();
|
||||
world.init_resource::<SceneIo>();
|
||||
let original = TerrainDesc::flat(5);
|
||||
let mut preview = original.clone();
|
||||
apply_dab(
|
||||
&mut preview,
|
||||
Vec3::ZERO,
|
||||
3.0,
|
||||
0.8,
|
||||
TerrainSculptMode::Raise,
|
||||
0.0,
|
||||
11,
|
||||
);
|
||||
let entity = world
|
||||
.spawn((LevelObject, ActorKind::Terrain, preview.clone()))
|
||||
.id();
|
||||
let mut hierarchy = crate::ui::hierarchy_state::HierarchyPanelState::default();
|
||||
hierarchy.locked.insert(entity);
|
||||
world.insert_resource(hierarchy);
|
||||
let harness = OperatorInvariantHarness::capture(world);
|
||||
|
||||
finish_terrain_stroke(
|
||||
world,
|
||||
TerrainStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
flatten_height: 0.0,
|
||||
seed: 11,
|
||||
},
|
||||
preview,
|
||||
"Raise Terrain",
|
||||
"Raise",
|
||||
);
|
||||
|
||||
harness.assert_blocked(world);
|
||||
harness.assert_status(world, "terrain.sculpt", OperatorPhase::Blocked);
|
||||
assert_eq!(world.get::<TerrainDesc>(entity), Some(&original));
|
||||
assert!(world
|
||||
.resource::<SceneIo>()
|
||||
.status
|
||||
.starts_with("Terrain sculpt commit failed:"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -703,11 +892,21 @@ mod tests {
|
||||
fn cancel_once(
|
||||
mut state: ResMut<TerrainSculptState>,
|
||||
mut terrains: Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
mut scene_io: ResMut<SceneIo>,
|
||||
mut active_operator: ResMut<ActiveOperator>,
|
||||
) {
|
||||
cancel_stroke(&mut state, &mut terrains);
|
||||
cancel_active_stroke(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
);
|
||||
}
|
||||
|
||||
let mut app = App::new();
|
||||
app.init_resource::<ActiveOperator>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<SceneIo>();
|
||||
let original = TerrainDesc::flat(5);
|
||||
let mut preview = original.clone();
|
||||
apply_dab(
|
||||
@@ -721,7 +920,7 @@ mod tests {
|
||||
);
|
||||
let entity = app
|
||||
.world_mut()
|
||||
.spawn((GlobalTransform::default(), preview))
|
||||
.spawn((LevelObject, GlobalTransform::default(), preview))
|
||||
.id();
|
||||
let mut state = TerrainSculptState::default();
|
||||
state.start(entity);
|
||||
@@ -733,9 +932,74 @@ mod tests {
|
||||
seed: 11,
|
||||
});
|
||||
app.insert_resource(state).add_systems(Update, cancel_once);
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
app.update();
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "terrain.sculpt", OperatorPhase::Canceled);
|
||||
assert_eq!(app.world().get::<TerrainDesc>(entity), Some(&original));
|
||||
assert!(!app.world().resource::<TerrainSculptState>().is_stroking());
|
||||
let state = app.world().resource::<TerrainSculptState>();
|
||||
assert!(state.active);
|
||||
assert_eq!(state.target, Some(entity));
|
||||
assert!(!state.is_stroking());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clean_view_interruption_restores_stroke_and_terminates_tool() {
|
||||
fn interrupt_once(
|
||||
mut state: ResMut<TerrainSculptState>,
|
||||
mut terrains: Query<(&GlobalTransform, &mut TerrainDesc)>,
|
||||
mut scene_io: ResMut<SceneIo>,
|
||||
mut active_operator: ResMut<ActiveOperator>,
|
||||
) {
|
||||
stop_tool_with_rollback(
|
||||
&mut state,
|
||||
&mut terrains,
|
||||
&mut scene_io,
|
||||
&mut active_operator,
|
||||
OperatorPhase::Canceled,
|
||||
"Terrain sculpt stopped for clean game view",
|
||||
"Clean game view enabled; terrain restored",
|
||||
);
|
||||
}
|
||||
|
||||
let mut app = App::new();
|
||||
app.init_resource::<ActiveOperator>()
|
||||
.init_resource::<EditorHistory>()
|
||||
.init_resource::<SceneIo>();
|
||||
let original = TerrainDesc::flat(5);
|
||||
let mut preview = original.clone();
|
||||
apply_dab(
|
||||
&mut preview,
|
||||
Vec3::ZERO,
|
||||
3.0,
|
||||
0.8,
|
||||
TerrainSculptMode::Raise,
|
||||
0.0,
|
||||
11,
|
||||
);
|
||||
let entity = app
|
||||
.world_mut()
|
||||
.spawn((LevelObject, GlobalTransform::default(), preview))
|
||||
.id();
|
||||
let mut state = TerrainSculptState::default();
|
||||
state.start(entity);
|
||||
state.stroke = Some(TerrainStroke {
|
||||
entity,
|
||||
original: original.clone(),
|
||||
last_local: Vec3::ZERO,
|
||||
flatten_height: 0.0,
|
||||
seed: 11,
|
||||
});
|
||||
app.insert_resource(state)
|
||||
.add_systems(Update, interrupt_once);
|
||||
let harness = OperatorInvariantHarness::capture(app.world_mut());
|
||||
|
||||
app.update();
|
||||
|
||||
harness.assert_canceled(app.world_mut());
|
||||
harness.assert_status(app.world(), "terrain.sculpt", OperatorPhase::Canceled);
|
||||
assert_eq!(app.world().get::<TerrainDesc>(entity), Some(&original));
|
||||
assert!(!app.world().resource::<TerrainSculptState>().active);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user