Files
OpenNest/OpenNest/Forms/CutSimulatorForm.cs
T
ajandClaude Opus 5.5 a9396ba065 feat(simulator): lock the nest to viewing while the cut simulator is open
The simulator reuses Plan Cutting's inspection lock: the canvas pans and
zooms and plates can be stepped through, but selection, part edits,
menus, toolbars, lists and Undo/Redo are disabled until it closes.
Escape or closing the nest closes the simulator first.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-29 00:36:07 -04:00

478 lines
20 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
using System;
using System.Drawing;
using System.Windows.Forms;
using OpenNest.CNC;
using OpenNest.Controls;
using NumericUpDown = OpenNest.Controls.NumericUpDown;
namespace OpenNest.Forms
{
/// <summary>
/// Playback controls for a <see cref="CutSimulationOverlay"/> on a nest's plate view. Follows
/// the current plate and rebuilds the timeline when parts are added, removed or resequenced.
/// While it is open the nest is view-only, as in Plan Cutting: the canvas pans and zooms and
/// plates can be stepped through, but nothing that edits is enabled.
/// </summary>
public sealed class CutSimulatorForm : Form
{
private const int TrackResolution = 1000;
private static readonly double[] Speeds = { 1, 2, 5, 10, 25, 50, 100, 250 };
private readonly EditNestForm nestForm;
private readonly CutSimulationOverlay overlay;
private readonly Button restartButton, playButton, endButton;
private readonly Button previousPartButton, previousContourButton, nextContourButton, nextPartButton;
private readonly ComboBox speedBox;
private readonly TrackBar trackBar;
private readonly Label timeLabel, partLabel, drawingLabel, stateLabel;
private readonly NumericUpDown feedBox, holeFeedBox, rapidBox, pierceBox;
private readonly CheckBox skipEtchBox;
private readonly CutTimeMachineBox machineBox;
private readonly ValidationInspectionScope scope;
private Plate plate;
private bool updatingTrack;
private bool rebuildQueued;
public CutSimulatorForm(EditNestForm nestForm)
{
this.nestForm = nestForm;
overlay = nestForm.PlateView.CutSimulation;
Text = "Cut Simulator";
// Fixed size: the window fits its controls once and never follows the status text.
FormBorderStyle = FormBorderStyle.FixedToolWindow;
MaximizeBox = MinimizeBox = false;
StartPosition = FormStartPosition.Manual;
ShowInTaskbar = false;
KeyPreview = true;
MinimumSize = new Size(420, 0);
AutoScaleMode = AutoScaleMode.Dpi;
AutoSize = true;
AutoSizeMode = AutoSizeMode.GrowAndShrink;
restartButton = TransportButton("⏮", 44, 12f);
playButton = TransportButton("▶", 80, 18f);
endButton = TransportButton("⏭", 44, 12f);
speedBox = new ComboBox { DropDownStyle = ComboBoxStyle.DropDownList, Width = 70, Anchor = AnchorStyles.Left };
foreach (var speed in Speeds)
speedBox.Items.Add($"{speed:g}×");
speedBox.SelectedIndex = Array.IndexOf(Speeds, 5.0);
previousPartButton = JumpButton("◀◀ Part");
previousContourButton = JumpButton("◀ Cutout");
nextContourButton = JumpButton("Cutout ▶");
nextPartButton = JumpButton("Part ▶▶");
var jumps = new FlowLayoutPanel { AutoSize = true, Dock = DockStyle.Fill, WrapContents = false };
jumps.Controls.AddRange(new Control[] { previousPartButton, previousContourButton, nextContourButton, nextPartButton });
var transport = new FlowLayoutPanel { AutoSize = true, Dock = DockStyle.Fill, WrapContents = false };
transport.Controls.AddRange(new Control[]
{
restartButton,
playButton,
endButton,
new Label { Text = "Speed", AutoSize = true, Anchor = AnchorStyles.Left, Margin = new Padding(12, 0, 0, 0) },
speedBox,
});
trackBar = new TrackBar
{
Dock = DockStyle.Fill,
AutoSize = false,
Height = 30,
Maximum = TrackResolution,
TickStyle = TickStyle.None,
LargeChange = TrackResolution / 20,
SmallChange = 1,
};
// One labeled row per value, each spanning the window, so the status never widens
// it. Drawing names get two lines; longer ones trim and show in full on hover.
timeLabel = StatusValue(1);
timeLabel.Font = new Font(Font, FontStyle.Bold);
partLabel = StatusValue(1);
drawingLabel = StatusValue(2);
stateLabel = StatusValue(1);
var status = new TableLayoutPanel { AutoSize = true, Dock = DockStyle.Fill, ColumnCount = 2 };
status.ColumnStyles.Add(new ColumnStyle(SizeType.AutoSize));
status.ColumnStyles.Add(new ColumnStyle(SizeType.Percent, 100));
status.Controls.AddRange(new Control[]
{
StatusCaption("Time"), timeLabel,
StatusCaption("Part"), partLabel,
StatusCaption("Drawing"), drawingLabel,
StatusCaption("Motion"), stateLabel,
});
var units = nestForm.Nest.Units;
var rateSuffix = " " + UnitsHelper.GetShortTimeUnitPair(units);
var saved = SavedCutParameters.Load(units);
feedBox = NewNumber((decimal)saved.Feedrate, 1, 9999, 0, rateSuffix);
holeFeedBox = NewNumber((decimal)(saved.HoleFeedrate ?? saved.Feedrate), 1, 9999, 0, rateSuffix);
rapidBox = NewNumber((decimal)saved.RapidTravelRate, 1, 9999, 0, rateSuffix);
pierceBox = NewNumber((decimal)saved.PierceTime.TotalSeconds, 0, 999, 1, " s");
var rates = new TableLayoutPanel { AutoSize = true, Dock = DockStyle.Fill, ColumnCount = 4 };
rates.Controls.AddRange(new Control[]
{
RateLabel("Outside feed"), feedBox,
RateLabel("Hole feed"), holeFeedBox,
RateLabel("Rapid"), rapidBox,
RateLabel("Pierce"), pierceBox,
});
machineBox = new CutTimeMachineBox();
skipEtchBox = new CheckBox
{
Text = "Skip etch-only contours",
Checked = saved.SkipScribe,
AutoSize = true,
Margin = new Padding(12, 6, 3, 3),
};
var motion = new FlowLayoutPanel { AutoSize = true, Dock = DockStyle.Fill, WrapContents = true };
motion.Controls.AddRange(new Control[] { RateLabel("Acceleration"), machineBox, skipEtchBox });
var layout = new TableLayoutPanel
{
Dock = DockStyle.Fill,
AutoSize = true,
ColumnCount = 1,
Padding = new Padding(6),
};
layout.ColumnStyles.Add(new ColumnStyle(SizeType.Percent, 100));
layout.Controls.Add(transport);
layout.Controls.Add(jumps);
layout.Controls.Add(trackBar);
layout.Controls.Add(status);
layout.Controls.Add(rates);
layout.Controls.Add(motion);
Controls.Add(layout);
restartButton.Click += (_, _) => overlay.Time = TimeSpan.Zero;
endButton.Click += (_, _) =>
{
overlay.Pause();
overlay.Time = overlay.Simulation?.TotalTime ?? TimeSpan.Zero;
};
playButton.Click += (_, _) => TogglePlay();
previousPartButton.Click += (_, _) => Jump(sim => sim.PreviousPart(overlay.Time));
previousContourButton.Click += (_, _) => Jump(sim => sim.PreviousContour(overlay.Time));
nextContourButton.Click += (_, _) => Jump(sim => sim.NextContour(overlay.Time));
nextPartButton.Click += (_, _) => Jump(sim => sim.NextPart(overlay.Time));
speedBox.SelectedIndexChanged += (_, _) => overlay.Speed = Speeds[speedBox.SelectedIndex];
trackBar.Scroll += (_, _) => Seek();
feedBox.ValueChanged += (_, _) => Rebuild();
holeFeedBox.ValueChanged += (_, _) => Rebuild();
skipEtchBox.CheckedChanged += (_, _) => Rebuild();
rapidBox.ValueChanged += (_, _) => Rebuild();
pierceBox.ValueChanged += (_, _) => Rebuild();
machineBox.SelectedIndexChanged += (_, _) => Rebuild();
var tips = new ToolTip();
tips.SetToolTip(restartButton, "Restart");
tips.SetToolTip(playButton, "Play / pause (Space)");
tips.SetToolTip(endButton, "Jump to end");
tips.SetToolTip(previousPartButton, "Back to the start of this part, or the part before (Page Up)");
tips.SetToolTip(previousContourButton, "Back to the start of this cutout or perimeter, or the one before (Ctrl+Left)");
tips.SetToolTip(nextContourButton, "Next cutout or perimeter (Ctrl+Right)");
tips.SetToolTip(nextPartButton, "Next part (Page Down)");
tips.SetToolTip(feedBox, "Feed for outside contours and cut-offs (the CI Fiber post's exterior, L4)");
tips.SetToolTip(holeFeedBox, "Feed for holes and other interior contours (the CI Fiber post's interior, L2)");
tips.SetToolTip(skipEtchBox, "Leave out contours that only etch, as the CI Fiber post does by default");
tips.SetToolTip(machineBox, "Machine whose acceleration limits time the moves (Tools > Machine Configuration)");
tips.SetToolTip(trackBar, "Drag to scrub through the cut (Left/Right step one move)");
overlay.Speed = Speeds[speedBox.SelectedIndex];
overlay.Changed += Overlay_Changed;
nestForm.PlateChanged += NestForm_PlateChanged;
nestForm.FormClosed += NestForm_FormClosed;
AttachPlate(nestForm.PlateView.Plate);
Rebuild();
scope = new ValidationInspectionScope(nestForm, Close, nestForm.PlateNavigation);
nestForm.PlateView.InspectionCloseRequested = Close;
}
private static NumericUpDown NewNumber(decimal value, decimal min, decimal max, int decimals, string suffix) =>
new()
{
Minimum = min,
Maximum = max,
DecimalPlaces = decimals,
Increment = decimals == 0 ? 10 : 0.1m,
Value = System.Math.Clamp(value, min, max),
Suffix = suffix,
Width = 110,
};
private static Button TransportButton(string glyph, int width, float fontSize) =>
new()
{
Text = glyph,
AutoSize = false,
Size = new Size(width, 40),
Font = new Font("Segoe UI Symbol", fontSize),
Anchor = AnchorStyles.Left,
};
private static Button JumpButton(string text) =>
new() { Text = text, AutoSize = true, MinimumSize = new Size(80, 0) };
// Jumps pause so the jumped-to contour stays on screen.
private void Jump(Func<CutSimulation, TimeSpan> target)
{
if (overlay.Simulation is not { } sim || sim.Steps.Count == 0)
return;
overlay.Pause();
overlay.Time = target(sim);
}
private static Label StatusCaption(string text) =>
new() { Text = text, AutoSize = true, ForeColor = SystemColors.GrayText, Margin = new Padding(3, 2, 8, 2) };
// Fixed height so changing text never resizes the window.
private Label StatusValue(int lines) =>
new BufferedLabel
{
AutoSize = false,
AutoEllipsis = true,
Dock = DockStyle.Fill,
Width = 40,
Height = Font.Height * lines + 2,
Margin = new Padding(3, 2, 3, 2),
};
private static Label RateLabel(string text) =>
new() { Text = text, AutoSize = true, Margin = new Padding(3, 7, 0, 0), Anchor = AnchorStyles.Left };
private CutParameters GetCutParameters() =>
new()
{
Feedrate = (double)feedBox.Value,
HoleFeedrate = (double)holeFeedBox.Value,
SkipScribe = skipEtchBox.Checked,
RapidTravelRate = (double)rapidBox.Value,
PierceTime = TimeSpan.FromSeconds((double)pierceBox.Value),
Units = nestForm.Nest.Units,
Motion = machineBox.GetMotion(nestForm.Nest.Units),
};
private void Rebuild()
{
if (plate == null)
{
overlay.Clear();
return;
}
overlay.Load(CutSimulation.Build(plate, GetCutParameters()));
}
private void AttachPlate(Plate value)
{
if (plate != null)
{
plate.PartAdded -= Plate_PartsChanged;
plate.PartRemoved -= Plate_PartsChanged;
plate.PartsReordered -= Plate_PartsChanged;
}
plate = value;
if (plate != null)
{
plate.PartAdded += Plate_PartsChanged;
plate.PartRemoved += Plate_PartsChanged;
plate.PartsReordered += Plate_PartsChanged;
}
}
// A fill adds parts one at a time; rebuild once after the batch.
private void Plate_PartsChanged(object sender, EventArgs e)
{
if (rebuildQueued || !IsHandleCreated)
return;
rebuildQueued = true;
BeginInvoke(() =>
{
rebuildQueued = false;
if (!IsDisposed)
Rebuild();
});
}
private void NestForm_PlateChanged(object sender, EventArgs e)
{
if (nestForm.PlateView.Plate == plate)
return;
AttachPlate(nestForm.PlateView.Plate);
overlay.Pause();
overlay.Clear();
Rebuild();
}
private void NestForm_FormClosed(object sender, FormClosedEventArgs e) => Close();
private void TogglePlay()
{
if (overlay.IsPlaying)
{
overlay.Pause();
return;
}
// Parts may have moved since the timeline was built; moves raise no plate event.
if (overlay.Simulation == null || overlay.Time <= TimeSpan.Zero || overlay.Time >= overlay.Simulation.TotalTime)
Rebuild();
overlay.Play();
}
private void Seek()
{
if (updatingTrack || overlay.Simulation == null)
return;
overlay.Time = overlay.Simulation.TotalTime * ((double)trackBar.Value / TrackResolution);
}
private void StepMove(int direction)
{
var sim = overlay.Simulation;
if (sim == null || sim.Steps.Count == 0)
return;
overlay.Pause();
var index = System.Math.Clamp(sim.IndexAt(overlay.Time), 0, sim.Steps.Count);
var atStart = index < sim.Steps.Count && overlay.Time == sim.Steps[index].StartTime;
var target = direction > 0 ? index + 1 : atStart ? index - 1 : index;
overlay.Time = target <= 0 ? TimeSpan.Zero
: target >= sim.Steps.Count ? sim.TotalTime
: sim.Steps[target].StartTime;
}
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
{
if (ActiveControl is not System.Windows.Forms.NumericUpDown and not ComboBox)
{
switch (keyData)
{
case Keys.Escape:
Close();
return true;
case Keys.Space:
TogglePlay();
return true;
case Keys.Control | Keys.Right:
Jump(sim => sim.NextContour(overlay.Time));
return true;
case Keys.Control | Keys.Left:
Jump(sim => sim.PreviousContour(overlay.Time));
return true;
case Keys.PageDown:
Jump(sim => sim.NextPart(overlay.Time));
return true;
case Keys.PageUp:
Jump(sim => sim.PreviousPart(overlay.Time));
return true;
case Keys.Right:
StepMove(1);
return true;
case Keys.Left:
StepMove(-1);
return true;
case Keys.Home:
overlay.Time = TimeSpan.Zero;
return true;
}
}
return base.ProcessCmdKey(ref msg, keyData);
}
private void Overlay_Changed(object sender, EventArgs e)
{
if (IsDisposed)
return;
var sim = overlay.Simulation;
playButton.Text = overlay.IsPlaying ? "⏸" : "▶";
if (sim == null || sim.Steps.Count == 0)
{
timeLabel.Text = "Nothing to cut";
partLabel.Text = drawingLabel.Text = stateLabel.Text = string.Empty;
SetTrack(0);
return;
}
var time = overlay.Time;
timeLabel.Text = $"{TimingForm.GetTimeMsg(time)} / {TimingForm.GetTimeMsg(sim.TotalTime)}";
SetTrack(sim.TotalTime > TimeSpan.Zero ? (int)System.Math.Round(TrackResolution * (time / sim.TotalTime)) : 0);
var index = sim.IndexAt(time);
if (index >= sim.Steps.Count)
{
partLabel.Text = $"{sim.PartCount} of {sim.PartCount}";
drawingLabel.Text = string.Empty;
stateLabel.Text = "Done";
return;
}
var step = sim.Steps[index];
var drawing = plate != null && step.PartIndex < plate.Parts.Count ? plate.Parts[step.PartIndex].BaseDrawing?.Name : null;
partLabel.Text = $"{step.PartIndex + 1} of {sim.PartCount}";
drawingLabel.Text = drawing ?? string.Empty;
var state = step.Kind switch
{
CutSimulationStepKind.Rapid => "Rapid",
CutSimulationStepKind.Pierce => "Piercing",
CutSimulationStepKind.Scribe => "Scribing",
_ => "Cutting",
};
if (step.Kind != CutSimulationStepKind.Pierce)
state += $" · {FeedText(step.SpeedAt(time - step.StartTime))}";
stateLabel.Text = state;
}
// Speeds are per second; inch feeds read per minute, as Timing uses them.
private string FeedText(double unitsPerSecond)
{
var units = nestForm.Nest.Units;
var rate = units == Units.Millimeters ? unitsPerSecond : unitsPerSecond * 60;
return $"{rate:n0} {UnitsHelper.GetShortTimeUnitPair(units)}";
}
private void SetTrack(int value)
{
updatingTrack = true;
trackBar.Value = System.Math.Clamp(value, trackBar.Minimum, trackBar.Maximum);
updatingTrack = false;
}
protected override void OnFormClosed(FormClosedEventArgs e)
{
SavedCutParameters.Save(GetCutParameters());
machineBox.SaveChoice();
overlay.Changed -= Overlay_Changed;
nestForm.PlateChanged -= NestForm_PlateChanged;
nestForm.FormClosed -= NestForm_FormClosed;
AttachPlate(null);
if (!nestForm.PlateView.IsDisposed)
{
overlay.Clear();
nestForm.PlateView.InspectionCloseRequested = null;
}
base.OnFormClosed(e);
// Unlock after the editor has forgotten this form, then finish a close it held up.
scope.Dispose();
scope.ResumeHostClose();
}
// Playback rewrites the status every frame; a plain label erases before it redraws, so it flashes.
private sealed class BufferedLabel : Label
{
public BufferedLabel()
{
DoubleBuffered = true;
}
}
}
}